Merge pull request #13 from test-IO/feature/add_bulk_create_with_to_gig_invitations

[#EPMTIOOPS-3103] Add bulk create of gig invitations to the gem

Author: thebluber

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cirro-ruby-client (1.3.0)
+    cirro-ruby-client (1.4.0)
       faraday (< 1.2.0)
       faraday_middleware
       json_api_client (>= 1.10.0)

README.md

@@ -43,3 +43,15 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Usage
+
+#### Bulk create gig invitations
+
+```ruby
+gig = CirroIO::Client::Gig.load(id: 1)
+filter = CirroIO::Client::WorkerFilter.new(filter_query: '{ "app_worker_id": { "$in": [1,2,3] } }')
+invitation = CirroIO::Client::GigInvitation.new(gig: gig)
+
+invitation.bulk_create_with(filter, auto_accept: true) # by default auto_accept is false
+```

lib/cirro_io/client.rb

@@ -5,6 +5,7 @@
 require 'cirro_io/client/response_debugging_middleware'
 require 'cirro_io/client/jwt_authentication'
 require 'cirro_io/client/base'
+require 'cirro_io/client/bulk_action_helper'
 require 'cirro_io/client/gig_invitation'
 require 'cirro_io/client/app_user'
 require 'cirro_io/client/app_worker'

lib/cirro_io/client/bulk_action_helper.rb

@@ -0,0 +1,9 @@
+module CirroIO
+  module Client
+    module BulkActionHelper
+      def format_to_dashed_keys(params)
+        params.deep_transform_keys { |key| key.to_s.gsub('_', '-') }
+      end
+    end
+  end
+end

lib/cirro_io/client/gig.rb

@@ -1,6 +1,8 @@
 module CirroIO
   module Client
     class Gig < Base
+      include CirroIO::Client::BulkActionHelper
+
       has_one :worker_filter
       has_many :gig_tasks
       has_many :gig_results
@@ -34,12 +36,6 @@ def bulk_archive_with(gig_results, gig_time_activities)
         self.class.parser.parse(self.class, response).first
       end
       # rubocop:enable Metrics/AbcSize
-
-      private
-
-      def format_to_dashed_keys(params)
-        params.deep_transform_keys { |key| key.to_s.gsub('_', '-') }
-      end
     end
   end
 end

lib/cirro_io/client/gig_invitation.rb

@@ -1,6 +1,17 @@
 module CirroIO
   module Client
     class GigInvitation < Base
+      include CirroIO::Client::BulkActionHelper
+
+      has_one :gig
+
+      def bulk_create_with(worker_filter, auto_accept: false)
+        payload = { data: { attributes: attributes.merge(worker_filter: worker_filter.attributes, auto_accept: auto_accept) } }
+
+        response = self.class.custom_post("bulk/gigs/#{gig.id}/gig_invitations", format_to_dashed_keys(payload))
+
+        self.class.parser.parse(self.class, response)
+      end
     end
   end
 end

lib/cirro_io/client/version.rb

@@ -1,7 +1,7 @@
 # rubocop:disable Style/MutableConstant
 module CirroIO
   module Client
-    VERSION = '1.3.0'
+    VERSION = '1.4.0'
   end
 end
 # rubocop:enable Style/MutableConstant

spec/cirro_io/client/gig_invitation_spec.rb

@@ -0,0 +1,37 @@
+RSpec.describe CirroIO::Client::GigInvitation do
+  describe 'bulk_create_with' do
+    before do
+      configure_api_client
+    end
+
+    let(:gig) { CirroIO::Client::Gig.load(id: 1) }
+    let(:gig_invitation) { described_class.new(gig: gig) }
+
+    let(:worker_filter) { CirroIO::Client::WorkerFilter.new(filter_query: '{}') }
+
+    it 'bulk create a gig with gig tasks and filter query' do
+      request_url = "#{test_site}/v1/bulk/gigs/#{gig.id}/gig_invitations"
+      stub_request(:post, request_url).to_return(body: File.read('./spec/fixtures/gig_invitations.json'),
+                                                 headers: { 'Content-Type' => 'application/json' })
+
+      created_invs = gig_invitation.bulk_create_with(worker_filter)
+
+      expect(created_invs.count).to eq(2)
+
+      request_body = {
+        data: {
+          attributes: {
+            type: 'gig-invitations',
+            'worker-filter': {
+              type: 'worker-filters',
+              'filter-query': '{}',
+            },
+            'auto-accept': false,
+          },
+        },
+      }
+
+      expect(a_request(:post, request_url).with(body: request_body.to_json)).to have_been_made
+    end
+  end
+end

spec/fixtures/gig_invitations.json

@@ -0,0 +1,6 @@
+{
+  "data": [
+    { "id": "26", "type": "gig-invitations", "attributes": { "status": "accepted", "gig-id": 1, "app-worker-id": 2 } },
+    { "id": "27", "type": "gig-invitations", "attributes": { "status": "accepted", "gig-id": 1, "app-worker-id": 3 } }
+  ]
+}