smartrecruiters 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b39ecc3ecdd78c5fa8ee62cac3fbb6b03bc35f8bd19c352f3203150c85bc86
-  data.tar.gz: 0b55de968dc1c5f1142578505e59b13ebe39edd014703fcb964340a949aa75e1
+  metadata.gz: 30883b1307e170148c8183e487414ec7cee6bf1072a6c9ad3bac5132f97e647b
+  data.tar.gz: 6d0bd970d76244e299beea567b59e7ee6177d33a7562f6a3e2a65bdd955e2035
 SHA512:
-  metadata.gz: e794c63737ea81c0510440cc435b3df51a7b12cba1cf4e980a27b79435140c009b686d0901cf90175c5cdd17fe4560cf7da5dfca5bb035785ba677b321373527
-  data.tar.gz: 995acdd377323cff566c4cc11aed188ba0f67240bdc8da5c2261626f2e27707a28497efca2c344b28d09596564a6468ed962a00dd4435a0059a8ea786649c76b
+  metadata.gz: 4dbca1f2930a6dc92ebb19be2aa3f6b9e028ad1280683bed78f77b6446db653ec803cfe6411dd4e3e20185d5c69aa423ffb24cde9a08f722e5711daa0ad5b4e8
+  data.tar.gz: 69439dcf5fa3791ca0f93fcc69d58ea889cb284f5f9c691fe18c7d6c9ba9cc56f5167cc859dffce01dbdc0076239a8f0ef56984a27edf4f08a4cf7f8bae8325a

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.2.0](https://www.github.com/davejcameron/smartrecruiters/compare/v0.1.0...v0.2.0) (2021-10-13)
+
+
+### Features
+
+* Add access groups routes ([#7](https://www.github.com/davejcameron/smartrecruiters/issues/7)) ([81d6a34](https://www.github.com/davejcameron/smartrecruiters/commit/81d6a34e4466309f493f65aeeab6173d610b8dfb))
+* add reports apis ([#5](https://www.github.com/davejcameron/smartrecruiters/issues/5)) ([343814b](https://www.github.com/davejcameron/smartrecruiters/commit/343814b8d1fd0d14c062030b958d67b307204c69))
+* Add timeout and retry ([2d0d8f2](https://www.github.com/davejcameron/smartrecruiters/commit/2d0d8f23c57d522ea657e32b06b3da40a1822930))
+* Add webhooks routes ([#6](https://www.github.com/davejcameron/smartrecruiters/issues/6)) ([b37bcda](https://www.github.com/davejcameron/smartrecruiters/commit/b37bcda13d43f96bf6ac4fac285dd87200b3a877))
+
 ## 0.1.0 (2021-10-09)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartrecruiters (0.1.0)
+    smartrecruiters (0.2.0)
       faraday (~> 1.8)
       faraday_middleware (~> 1.1)
 

data/README.md

@@ -37,7 +37,9 @@ client = SmartRecruiters::Client.new(api_key: ENV["SMARTRECRUITERS_API_KEY"], en
 ### Access Groups
 
 ```ruby
-client.access_groups
+client.access_groups.list
+client.access_groups.assign_users(group_id: "id", user_ids: ["user_id"])
+client.access_groups.remove_user(group_id: "id", user_id: "id")
 ```
 
 ### Candidates
@@ -93,6 +95,10 @@ client.offers.retrieve_offers(candidate_id: "id", job_id: "id")
 ```ruby
 client.reports.list
 client.reports.retrieve(report_id: "id")
+client.reports.retrieve_files(report_id: "id")
+client.reports.generate_report(report_id: "id")
+client.reports.retrieve_recent_file(report_id: "id")
+client.reports.retrieve_recent_file_data(report_id: "id")
 ```
 
 ### Reviews
@@ -123,6 +129,19 @@ client.users.activation_email(user_id: "id")
 client.users.deactivate(user_id: "id")
 ```
 
+### Webhooks
+
+```ruby
+client.webhooks.list
+client.webhooks.create({})
+client.webhooks.retrieve(webhook_id: "id")
+client.webhooks.delete(webhook_id: "id")
+client.webhooks.activate(webhook_id: "id")
+client.webhooks.callbacks_log(webhook_id: "id")
+client.webhooks.generate_secret(webhook_id: "id")
+client.webhooks.retrieve_secret(webhook_id: "id")
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/smartrecruiters/client.rb

@@ -2,9 +2,13 @@
 
 require 'faraday'
 require 'faraday_middleware'
+require 'json'
 
 module SmartRecruiters
   class Client
+    SMART_RECRUITERS_TIMEOUT = 128
+    SMART_RECRUITERS_RETRIES = 3
+
     SMART_RECRUITERS_BASE_PATHS = {
       'production' => 'https://api.smartrecruiters.com',
       'sandbox' => 'https://api.sandbox.smartrecruiters.com'
@@ -12,11 +16,16 @@ module SmartRecruiters
 
     attr_reader :api_key, :adapter
 
-    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil, environment: 'production')
+    def initialize(
+      api_key:,
+      adapter: Faraday.default_adapter,
+      stubs: nil,
+      environment: 'production'
+    )
       @api_key = api_key
-      @adapter = adapter
       @environment = environment
 
+      @adapter = adapter
       @stubs = stubs
     end
 
@@ -52,16 +61,31 @@ module SmartRecruiters
       UsersResource.new(self)
     end
 
+    def webhooks
+      WebhooksResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new do |conn|
         conn.url_prefix = SMART_RECRUITERS_BASE_PATHS[@environment]
         conn.headers['X-SmartToken'] = api_key
         conn.request :json
+        conn.request :retry, retry_options
 
         conn.response :json, content_type: 'application/json'
 
+        conn.options.timeout = SMART_RECRUITERS_TIMEOUT
         conn.adapter adapter, @stubs
       end
     end
+
+    private
+
+    def retry_options
+      {
+        max: SMART_RECRUITERS_RETRIES,
+        retry_statuses: [429]
+      }
+    end
   end
 end

data/lib/smartrecruiters/collection.rb

@@ -6,13 +6,21 @@ module SmartRecruiters
 
     def self.from_response(response, type:)
       body = response.body
-      new(
-        content: body['content'].map { |attrs| type.new(attrs) },
-        limit: body['limit'],
-        offset: body['offset'],
-        next_page_id: body['nextPageId'],
-        total_found: body['totalFound']
-      )
+
+      if body.is_a?(Array)
+        new(
+          content: body.map { |attrs| type.new(attrs) },
+          limit: nil, offset: nil, next_page_id: nil, total_found: nil
+        )
+      else
+        new(
+          content: body['content'].map { |attrs| type.new(attrs) },
+          limit: body['limit'],
+          offset: body['offset'],
+          next_page_id: body['nextPageId'],
+          total_found: body['totalFound']
+        )
+      end
     end
 
     def initialize(content:, limit:, offset:, next_page_id:, total_found:)

data/lib/smartrecruiters/objects/callbacks_log.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SmartRecruiters
+  class CallbacksLog < Object
+  end
+end

data/lib/smartrecruiters/objects/webhook.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SmartRecruiters
+  class Webhook < Object
+  end
+end

data/lib/smartrecruiters/resources/access_groups.rb

@@ -2,8 +2,18 @@
 
 module SmartRecruiters
   class AccessGroupsResource < Resource
+    ACCESS_GROUP_API = 'user-api/v201804/access-groups'
+
     def list
-      Collection.from_response get_request('user-api/v201804/access-groups'), type: AccessGroup
+      Collection.from_response get_request(ACCESS_GROUP_API.to_s), type: AccessGroup
+    end
+
+    def assign_users(group_id:, user_ids:)
+      Collection.from_response post_request("#{ACCESS_GROUP_API}/#{group_id}/users", body: user_ids), type: User
+    end
+
+    def remove_user(group_id:, user_id:)
+      delete_request("#{ACCESS_GROUP_API}/#{group_id}/users/#{user_id}")
     end
   end
 end

data/lib/smartrecruiters/resources/reports.rb

@@ -11,5 +11,22 @@ module SmartRecruiters
     def retrieve(report_id:)
       Report.new get_request("#{REPORT_API}/reports/#{report_id}").body
     end
+
+    def retrieve_files(report_id:)
+      Object.new get_request("#{REPORT_API}/reports/#{report_id}/files").body
+    end
+
+    def generate_report(report_id:)
+      Report.new post_request("#{REPORT_API}/reports/#{report_id}").body
+    end
+
+    def retrieve_recent_file(report_id:)
+      Report.new get_request("#{REPORT_API}/reports/#{report_id}/files/recent").body
+    end
+
+    def retrieve_recent_file_data(report_id:)
+      response = get_request("#{REPORT_API}/reports/#{report_id}/files/recent/data").body
+      Object.new JSON.parse(response)
+    end
   end
 end

data/lib/smartrecruiters/resources/webhooks.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SmartRecruiters
+  class WebhooksResource < Resource
+    WEBHOOK_API = 'webhooks-api/v201907'
+
+    def list(**params)
+      response = get_request("#{WEBHOOK_API}/subscriptions", params: params)
+      Collection.from_response(response, type: Webhook)
+    end
+
+    def create(**attributes)
+      Webhook.new post_request("#{WEBHOOK_API}/subscriptions", body: attributes).body
+    end
+
+    def retrieve(webhook_id:)
+      Webhook.new get_request("#{WEBHOOK_API}/subscriptions/#{webhook_id}").body
+    end
+
+    def delete(webhook_id:)
+      delete_request("#{WEBHOOK_API}/subscriptions/#{webhook_id}")
+    end
+
+    def activate(webhook_id:, **attributes)
+      put_request("#{WEBHOOK_API}/subscriptions/#{webhook_id}/activation", body: attributes)
+    end
+
+    def callbacks_log(webhook_id:, **params)
+      response = get_request("#{WEBHOOK_API}/subscriptions/#{webhook_id}/callbacks-log", params: params)
+      Collection.from_response(response, type: CallbacksLog)
+    end
+
+    def generate_secret(webhook_id:, **attributes)
+      Object.new post_request("#{WEBHOOK_API}/subscriptions/#{webhook_id}/secret-key", body: attributes).body
+    end
+
+    def retrieve_secret(webhook_id:)
+      Object.new get_request("#{WEBHOOK_API}/subscriptions/#{webhook_id}/secret-key").body
+    end
+  end
+end

data/lib/smartrecruiters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmartRecruiters
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/smartrecruiters.rb

@@ -11,15 +11,16 @@ module SmartRecruiters
 
   autoload :AccessGroup, 'smartrecruiters/objects/access_group'
   autoload :Attachment, 'smartrecruiters/objects/attachment'
+  autoload :CallbacksLog, 'smartrecruiters/objects/callbacks_log'
   autoload :Candidate, 'smartrecruiters/objects/candidate'
   autoload :Interview, 'smartrecruiters/objects/interview'
-
   autoload :Job, 'smartrecruiters/objects/job'
   autoload :Offer, 'smartrecruiters/objects/offer'
   autoload :User, 'smartrecruiters/objects/user'
   autoload :Report, 'smartrecruiters/objects/report'
   autoload :Review, 'smartrecruiters/objects/review'
   autoload :SystemRole, 'smartrecruiters/objects/system_role'
+  autoload :Webhook, 'smartrecruiters/objects/webhook'
 
   autoload :AccessGroupsResource, 'smartrecruiters/resources/access_groups'
   autoload :CandidatesResource, 'smartrecruiters/resources/candidates'
@@ -31,4 +32,5 @@ module SmartRecruiters
   autoload :ReportsResource, 'smartrecruiters/resources/reports'
   autoload :ReviewsResource, 'smartrecruiters/resources/reviews'
   autoload :SystemRolesResource, 'smartrecruiters/resources/system_roles'
+  autoload :WebhooksResource, 'smartrecruiters/resources/webhooks'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartrecruiters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Cameron
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-09 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,6 +107,7 @@ files:
 - lib/smartrecruiters/object.rb
 - lib/smartrecruiters/objects/access_group.rb
 - lib/smartrecruiters/objects/attachment.rb
+- lib/smartrecruiters/objects/callbacks_log.rb
 - lib/smartrecruiters/objects/candidate.rb
 - lib/smartrecruiters/objects/interview.rb
 - lib/smartrecruiters/objects/job.rb
@@ -115,6 +116,7 @@ files:
 - lib/smartrecruiters/objects/review.rb
 - lib/smartrecruiters/objects/system_role.rb
 - lib/smartrecruiters/objects/user.rb
+- lib/smartrecruiters/objects/webhook.rb
 - lib/smartrecruiters/resource.rb
 - lib/smartrecruiters/resources/access_groups.rb
 - lib/smartrecruiters/resources/candidates.rb
@@ -126,6 +128,7 @@ files:
 - lib/smartrecruiters/resources/reviews.rb
 - lib/smartrecruiters/resources/system_roles.rb
 - lib/smartrecruiters/resources/users.rb
+- lib/smartrecruiters/resources/webhooks.rb
 - lib/smartrecruiters/version.rb
 - smartrecruiters.gemspec
 homepage: https://github.com/davejcameron/smartrecruiters