cirro-ruby-client 2.5.11 → 2.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ce81e7b0822c3a040876d798246e58e6e3c1d4d53ae65a00d8f8c31a1b93376
-  data.tar.gz: 2a6ba790c9021d73593c657de850874ee30483b9defbe909be87b4cd5af44d1a
+  metadata.gz: 54ec8bba00d06538a146b978a969bc666870301ee49524fdfe565008fd49f059
+  data.tar.gz: ac3f9401adc1dfac45deda3a8532e6762d784f3933169f2cdd10857746f3ffa6
 SHA512:
-  metadata.gz: 9e7c815ff399fce832806acd5e5e02af6f55c74de231390cbdf7f24cacc17eadf0c2608888e6e6a299c2eed96a3bb3c46ba0ad3a791509bb91bf732464e4194a
-  data.tar.gz: 63ed1f73437dad7695725311b279c06b3dc57209d9a2211cfc305eafcacd7103ed110a933c7b3b524a5976b8eb55db24c6a256825a3c7c55adaccb76b2861e81
+  metadata.gz: 91bfb50504e0002561613a0a4b1cb87512011f12e2bd8c482ee6989d30d0bf970cc2dc87e0216ef830ffc9aec29feb55ec097801da389ce34aa81586ded6c4a8
+  data.tar.gz: 77ded5629a2fdcf12a47fa474a98ee681fe5e2c81ba25b8a33a9d86ed74c65a67ededa44d1a98efc601896d5bfd1abae82797b3a5012a8fe061a3e49a2ac4096

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cirro-ruby-client (2.5.11)
+    cirro-ruby-client (2.5.12)
       activesupport
       faraday (< 1.2.0)
       faraday_middleware
@@ -44,7 +44,7 @@ GEM
       rack (>= 0.2)
     jwt (2.7.0)
     method_source (1.0.0)
-    minitest (5.17.0)
+    minitest (5.18.0)
     multipart-post (2.3.0)
     parallel (1.19.2)
     parser (2.7.2.0)
@@ -53,7 +53,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
-    rack (3.0.4.1)
+    rack (3.0.7)
     rainbow (3.0.0)
     rake (12.3.3)
     regexp_parser (1.8.1)

data/README.md

@@ -1,6 +1,6 @@
-# CirroIO::Client
+# CirroIOV2::Client
 
-This gem provides access to the [Cirro REST API](https://staging.cirro.io/api-docs/v1#cirro-api-documentation).
+This gem provides access to the [Cirro REST API v2](https://cirroapiv2.docs.apiary.io).
 
 [![CircleCI](https://circleci.com/gh/test-IO/cirro-ruby-client/tree/master.svg?style=svg&circle-token=a77e4eac5646768d681283763d2a29a55a221d7c)](https://circleci.com/gh/test-IO/cirro-ruby-client/tree/master)
 
@@ -20,59 +20,6 @@ Or install it yourself as:
 
     $ gem install cirro-ruby-client
 
-
-## Configuration
-
-  You need to create an initializer file in config/initializers.
-
-  ```ruby
-  CirroIO::Client.configure do |c|
-    c.app_id 'WULnc6Y0rlaTBCSiHAb0kGWKFuIxPWBXJysyZeG3Rtw'
-    c.private_key_path './storage/cirro.pem'
-    c.site 'https://api.staging.cirro.io'
-  end
-  ```
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then wait for circle CI to complete, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## 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
-```
-
-#### Creating Payouts for workers
-
-```ruby
-app_worker = CirroIO::Client::AppWorker.load(id: 1234)
-
-CirroIO::Client::Payout.create(
-  app_worker: app_worker,
-  amount: 100, # € 1.00
-  title: "Bonus for something",
-  description: "Description of the bonus.",
-  cost_center_key: "PROJECT-CODE",
-  billing_date: DateTime.now
-)
-```
-
-# CirroIOV2::Client
-
 ## Configuration
 
   ```ruby
@@ -99,26 +46,26 @@ user.worker
 # => { billable: false, document: {...} }
 ```
 
-### Get notification preferences for a user
-
+### Create or update a worker document for a user
+Will automatically create a worker account if not existing
 ```ruby
-preference = client.User.get_notification_preference(1)
-# => NotificationPreference object
+user = client.User.worker(1, document: { foo: :bar })
+# => User object
 
-preference.id
-# => '1'
+user.worker.document
+# => { foo: :bar }
+```
 
-preference.locale
-# => 'de'
+### Get notification preference of a user
 
-preference.topics
-# => Array of NotificationTopicPreference objects
+```ruby
+client.User.notification_preference(1)
+# => NotificationPreference object
 ```
-
-### Update notification preferences for a user
+### Create or Update notification preferences for a user
 
 ```ruby
-client.User.update_notification_preference({
+client.User.notification_preferences(1, {
   locale: 'de',
   topics: [
     { id: '1', preferences: { email: 'immediately' } },
@@ -165,11 +112,12 @@ client.Gig.create(
   url: "http://heathcote.co/zina.gibson",
   start_at: 1652285764,
   end_at: 1653412329,
-  total_seats: 2,
+  seats_min: 2,
+  seats_max: 2,
   invitation_mode: "auto",
   filter_query: {
-  status: "active",
-  segment: "my_favorite_testers"
+    status: "active",
+    segment: "my_favorite_testers"
   },
   tasks: [
     { title: "Ah, Wilderness!", base_price: 300 }
@@ -186,9 +134,59 @@ client.Gig.create(
 # => Gig object
 ```
 
+### Update a gig
+When your gig is already started, you can not update start_at anymore
+```ruby
+gig_id = 1
+client.Gig.update(gig_id,
+  title: "Favourite programming language?",
+  description: "Description of gig ...",
+  url: "http://heathcote.co/zina.gibson",
+  start_at: 1652285764,
+  end_at: 1653412329,
+  seats_min: 2,
+  seats_max: 2,
+  invitation_mode: "auto",
+  filter_query: {
+    status: "active",
+    segment: "my_favorite_testers"
+  },
+  notification_payload: {
+    project_title: "Corporate Tax",
+    task_title: "Add dataset",
+    task_type: "Review"
+  },
+  epam_options: {
+    extra_mile: true
+  }
+)
+# => Gig object
+```
+
+### Archive a gig
+
+```ruby
+gig_id = 1
+
+# archive now
+client.Gig.archive(gig_id)
+
+# archive later
+client.Gig.archive(gig_id, archive_at: 1.day.from_now)
+```
+
+### Delete a gig
+
+```ruby
+gig_id = 1
+
+client.Gig.delete(gig_id)
+```
+
 ### Manually invite user to a gig
 
 ##### Invite single user
+
 ```ruby
 gig_id = 1
 app_user_id = 1
@@ -198,6 +196,7 @@ client.Gig.invite(gig_id, { user_id: app_user_id })
 ```
 
 ##### Invite multiple users and overwrite no_reward
+
 ```ruby
 gig_id = 1
 users = [{ id: 1, no_reward: true }, { id: 2, no_reward: true }]
@@ -206,6 +205,26 @@ client.Gig.invite(gig_id, { users: users })
 # => GigInvitationList object
 ```
 
+### GigTask
+#### Add a new gig task to gig
+
+```ruby
+gig_id = 1
+
+client.Gig.tasks(gig_id, { title: "Critical Bug", base_price: 100 })
+# => GigTask object
+```
+
+#### Update a gig task
+
+```ruby
+gig_id = 1
+gig_task_id = 1
+
+client.Gig.update_task(gig_id, gig_task_id, { base_price: 100 })
+# => GigTask object
+```
+
 ## GigInvitation
 ### Get list of gig invitations
 
@@ -243,8 +262,143 @@ list.data
 
 ```ruby
 client.GigInvitation.accept(1)
+
+# overwrite no_reward
+client.GigInvitation.accept(1, no_reward: true)
+
+```
+
+### Reject a gig invitation
+
+```ruby
+client.GigInvitation.reject(1)
+```
+
+### Expire a gig invitation
+
+```ruby
+client.GigInvitation.expire(1)
+```
+
+### Reset an accepted or expired gig invitation
+
+```ruby
+client.GigInvitation.reset(1)
+
+# prevent reset notification
+client.GigInvitation.reset(1, silent: true)
 ```
 
+## GigTimeActivity
+### List all gig time activities
+
+```ruby
+list = client.GigTimeActivity.list
+# => ListObject
+
+list.has_more?
+# => true
+
+list.data
+# => Array of GigTimeActivity objects
+
+# filters
+client.GigTimeActivity.list(gig_id: 1, user_id: 1)
+
+# pagination
+client.GigTimeActivity.list(limit: 100, after: 100)
+```
+
+### Create a gig time activity
+You can't create gig time activity if the given user is not in your space or for the given user the gig invitation is set to no_reward
+
+```ruby
+client.GigTimeActivity.create(
+  gig_id: 1,
+  user_id: 1,
+  date: "2023-04-10",
+  description: "Time Report for Space XYZ",
+  duration_in_ms: 1.hour.in_seconds * 1000 # make sure not to report > 8h per day
+)
+```
+
+## GigResult
+### List all gig results
+
+```ruby
+list = client.GigResult.list
+# => ListObject
+
+list.has_more?
+# => true
+
+list.data
+# => Array of GigResult objects
+
+# filters
+client.GigResult.list(gig_id: 1, user_id: 1)
+
+# pagination
+client.GigResult.list(limit: 100, after: 100)
+```
+
+### Create a gig result
+You can't create gig result if the given user is not in your space or for the given user the gig invitation is set to no_reward
+
+```ruby
+client.GigResult.create(
+  gig_task_id: 1,
+  user_id: 1,
+  title: "Work for task1",
+  escription: "Good work for task1",
+  quantity: 2,
+  multiplier: 1.2,
+  delivery_date: "2023-04-10",
+  cost_center_key: "EPMTIO"
+)
+```
+
+## BonusPayout
+### List all payouts
+
+```ruby
+list = client.Payout.list
+# => ListObject
+
+list.has_more?
+# => true
+
+list.data
+# => Array of Payout objects
+
+# filters
+client.Payout.list(reference_id: 1, reference_type: 'Gig', user_id: 1)
+
+# pagination
+client.Payout.list(limit: 100, after: 100)
+```
+
+### Create a bonus payout
+
+```ruby
+client.Payout.create(
+  user_id: 1,
+  title: "Bonus Payment",
+  description: "Good work!",
+  amount: 1000,
+  billing_date: "2023-04-10",
+  cost_center_key: "EPMTIO"
+)
+```
+
+### Delete a bonus payout
+Only allowed for unbilled ones
+
+```ruby
+client.Payout.delete(1)
+```
+
+# Notifications
 ## Notification Locale
 ### Create a notification locale
 
@@ -293,6 +447,21 @@ client.NotificationConfiguration.list(limit: 100, after: 100) # pagination
 ```
 
 ## Notification Layout
+### List all notification layouts
+
+```ruby
+list = client.NotificationLayout.list
+# => ListObject
+
+list.has_more?
+# => true
+
+list.data
+# => Array of NotificationLayout objects
+
+client.NotificationLayout.list(limit: 100, after: 100) # pagination
+```
+
 ### Create a notification layout
 
 ```ruby
@@ -380,6 +549,30 @@ client.NotificationTopic.create(
 )
 ```
 
+### Find a notification topic
+
+```ruby
+client.NotificationTopic.find(1)
+# => NotificationTopic object
+```
+
+### Update a notification topic
+
+```ruby
+client.NotificationTopic.update(1, { name: "NewTopicName", preferences: { email: "daily" } })
+# => NotificationTopic object
+```
+
+### Delete a notification topic
+
+```ruby
+topic = client.NotificationTopic.delete(1)
+# => NotificationTopicDelete object
+
+topic.deleted
+# => true
+```
+
 ## Notification (Topic) Template
 ### List all
 
@@ -416,8 +609,9 @@ client.NotificationTemplate.update(
 ### Delete a notification template
 
 ```ruby
-client.NotificationTemplate.delete('1')
+client.NotificationTemplate.delete(1)
 ```
+
 ## Notifcation Topic Preference
 ### List all
 
@@ -456,3 +650,56 @@ client.NotificationBroadcast.create(
   notification_topic_id: 1
 )
 ```
+
+# CirroIO::Client (DEPRECATED)
+
+## Configuration
+
+  You need to create an initializer file in config/initializers.
+
+  ```ruby
+  CirroIO::Client.configure do |c|
+    c.app_id 'WULnc6Y0rlaTBCSiHAb0kGWKFuIxPWBXJysyZeG3Rtw'
+    c.private_key_path './storage/cirro.pem'
+    c.site 'https://api.staging.cirro.io'
+  end
+  ```
+
+
+
+## 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
+```
+
+#### Creating Payouts for workers
+
+```ruby
+app_worker = CirroIO::Client::AppWorker.load(id: 1234)
+
+CirroIO::Client::Payout.create(
+  app_worker: app_worker,
+  amount: 100, # € 1.00
+  title: "Bonus for something",
+  description: "Description of the bonus.",
+  cost_center_key: "PROJECT-CODE",
+  billing_date: DateTime.now
+)
+```
+
+# Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then wait for circle CI to complete, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+# License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/cirro_io/client/version.rb

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

data/lib/cirro_io_v2/resources/notification_topic.rb

@@ -24,6 +24,11 @@ module CirroIOV2
         response = client.request_client.request(:post, resource_root, body: params)
         Responses::NotificationTopicResponse.new(response.body)
       end
+
+      def delete(id)
+        response = client.request_client.request(:delete, "#{resource_root}/#{id}")
+        Responses::NotificationTopicDeleteResponse.new(response.body)
+      end
     end
   end
 end

data/lib/cirro_io_v2/resources/payout.rb

@@ -10,6 +10,11 @@ module CirroIOV2
         response = client.request_client.request(:post, resource_root, body: params)
         Responses::PayoutResponse.new(response.body)
       end
+
+      def delete(id)
+        response = client.request_client.request(:delete, "#{resource_root}/#{id}")
+        Responses::PayoutDeleteResponse.new(response.body)
+      end
     end
   end
 end

data/lib/cirro_io_v2/resources/user.rb

@@ -11,6 +11,11 @@ module CirroIOV2
         CirroIOV2::Responses::UserResponse.new(response.body)
       end
 
+      def notification_preference(id)
+        response = client.request_client.request(:get, "#{resource_root}/#{id}/notification_preference")
+        CirroIOV2::Responses::UserNotificationPreferenceResponse.new(response.body)
+      end
+
       def notification_preferences(id, params)
         response = client.request_client.request(:post, "#{resource_root}/#{id}/notification_preferences", body: params)
         CirroIOV2::Responses::UserNotificationPreferenceResponse.new(response.body)

data/lib/cirro_io_v2/responses/responses.rb

@@ -15,6 +15,14 @@ module CirroIOV2
       :NotificationTemplateListResponse,
     ].freeze
 
+    DELETE_RESPONSES = [
+      :GigDeleteResponse,
+      :PayoutDeleteResponse,
+      :NotificationTemplateDeleteResponse,
+      :NotificationLayoutTemplateDeleteResponse,
+      :NotificationTopicDeleteResponse,
+    ].freeze
+
     UserResponse = Struct.new(:id, :object, :first_name, :last_name, :time_zone, :birthday, :country_code, :epam, :worker, :anonymous_email) do
       include Base
     end
@@ -48,15 +56,11 @@ module CirroIOV2
       include Base
     end
 
-    GigDeleteResponse = Struct.new(:id, :object, :deleted) do
-      include Base
-    end
-
     GigTaskResponse = Struct.new(:id, :object, :title, :base_price) do
       include Base
     end
 
-    GigInvitationResponse = Struct.new(:id, :object, :status, :gig_id, :user_id, :no_reward) do
+    GigInvitationResponse = Struct.new(:id, :object, :status, :gig_id, :user_id, :no_reward, :epam_bench_status) do
       include Base
     end
 
@@ -114,10 +118,6 @@ module CirroIOV2
       include Base
     end
 
-    NotificationLayoutTemplateDeleteResponse = Struct.new(:id, :object, :deleted) do
-      include Base
-    end
-
     NotificationTopicResponse = Struct.new(:id, :object, :name, :notification_layout_id, :preferences, :templates) do
       self::NESTED_RESPONSES = { templates: :NotificationTemplateListResponse }.freeze
       include Base
@@ -127,10 +127,6 @@ module CirroIOV2
       include Base
     end
 
-    NotificationTemplateDeleteResponse = Struct.new(:id, :object, :deleted) do
-      include Base
-    end
-
     NotificationBroadcastResponse = Struct.new(:id, :object, :payload, :recipients, :notification_topic_id) do
       include Base
     end
@@ -139,12 +135,17 @@ module CirroIOV2
       include Base
     end
 
-    # cover the list responses
+    # cover the list and delete responses
     def self.const_missing(name)
       return const_get(name) if const_defined? name
-      return unless LIST_RESPONSES.include? name
 
-      klass = Class.new(Struct.new(:object, :url, :has_more, :data)) { include Base }
+      struct = nil
+      struct = Struct.new(:object, :url, :has_more, :data) if LIST_RESPONSES.include?(name)
+      struct = Struct.new(:id, :object, :deleted) if DELETE_RESPONSES.include?(name)
+
+      return unless struct.present?
+
+      klass = Class.new(struct) { include Base }
       const_set(name, klass)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cirro-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.5.11
+  version: 2.5.12
 platform: ruby
 authors:
 - Cirro Dev Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-27 00:00:00.000000000 Z
+date: 2023-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport