greenhouse_api 0.1.12 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 830ea391f1b8d83fb74fa520488aa0e8992b6be8766db0279ab2ed12ecb8d186
-  data.tar.gz: 7d858fc9cbcf1ee073f1e7dbe1c57f9fe9599b539f3cac259054c550ddd57a35
+  metadata.gz: dcac2674a597136d59e32eea777b9b7ea622bcbccde40f051ad202eb51bc1171
+  data.tar.gz: 579ba5e1a02c968a23835547235281fa1c45e5ccc1ee2ae072fa8d8653d60138
 SHA512:
-  metadata.gz: 490a9d4d9bdb550a1151d4b4e704f698868c93d3f2c2629eaa0ba22eca8f65e873d35cb3ac7ac83b7cf8ce3b83bef3f78c60fc9380982ebf421b48f40642acf3
-  data.tar.gz: b47bd1b90c371069f5512ca9e60573b4bf322bda04b5c7c8d1228e9a792b69b97db99ee54324946f3d3be8de27281e9454f5867abd94b6f522b014a3a0602ce6
+  metadata.gz: 2b689c40434ff819aed78a8a79938f0cd264cd0de2fbefdc6be105325add4f313cf11195b594ad6ce45e50bd24658de502db29971f37795859bc1ea569695776
+  data.tar.gz: 1a7158a04d7826095ff9d5258b41b78ee49908b40ce65653a095c7e7e0999f6419b80adbc6450d82b47ddcdb90efac8be60c84ce7196701149d9c9a1a68a2aa8

data/lib/greenhouse_api.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 require "greenhouse_api/version"

data/lib/greenhouse_api/base_client.rb

@@ -0,0 +1,125 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday'
+require 'base64'
+require 'json'
+require 'sorbet-runtime'
+
+module GreenhouseApi
+  class Response
+    attr_reader :headers, :body, :status
+
+    def initialize(headers:, body:, status:)
+      @headers = headers
+      @body = body
+      @status = status
+    end
+  end
+
+  class BaseClient
+    extend T::Sig
+
+    MAX_PER_PAGE = 500
+    API_URL = 'https://harvest.greenhouse.io'
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def headers
+      credential = Base64.strict_encode64(@api_key + ':')
+
+      {
+        'Authorization' => 'Basic ' + credential,
+      }
+    end
+
+    def request(http_method:, headers:, endpoint:, params: {}, body: {}, api_version: 'v1')
+      response = Faraday.public_send(http_method) do |request|
+        request.headers = headers
+        request.path = "#{API_URL}/#{api_version}/#{endpoint}"
+        request.params = params
+        request.body = body
+      end
+
+      Response.new(
+        body: response.body && !response.body.empty? ? JSON.parse(response.body) : '',
+        headers: response.headers,
+        status: response.status
+      )
+    end
+
+    def compose_response(response)
+      if [200, 201].include?(response&.status)
+        Response.new(
+          body: response.body,
+          headers: response.headers,
+          status: response.status
+        )
+      else
+        response
+      end
+    end
+
+    def get_one(resource, id)
+      response = request(
+        http_method: :get,
+        headers: headers,
+        endpoint: "#{resource}/#{id}"
+      )
+      compose_response(response)
+    end
+
+    def list_many(resource, params = {})
+      limit = params.delete(:limit)
+      page = params[:page] || 1
+      data = []
+      response = nil
+
+      loop do
+        per_page = if params[:per_page]
+          params[:per_page]
+        else
+          limit ? [limit - data.length, MAX_PER_PAGE].min : MAX_PER_PAGE
+        end
+
+        response = request(
+          http_method: :get,
+          headers: headers,
+          endpoint: resource,
+          params: params.merge(page: page, per_page: per_page)
+        )
+        break if response.status != 200
+
+        data.concat(response.body)
+
+        if last_page?(response) || data_limit_reached?(data, limit) || params[:page]
+          break
+        else
+          page += 1
+        end
+      end
+
+      if response.status == 200
+        Response.new(
+          body: data,
+          headers: response.headers,
+          status: response.status
+        )
+      else
+        response
+      end
+    end
+
+    private
+
+    def last_page?(response)
+      !response.headers['link'].to_s.include?('rel="next"')
+    end
+
+    def data_limit_reached?(data, limit)
+      limit && data.length >= limit
+    end
+  end
+end

data/lib/greenhouse_api/client.rb

@@ -1,120 +1,63 @@
+# typed: false
 # frozen_string_literal: true
 
-require 'faraday'
-require 'base64'
-require 'json'
+require_relative 'base_client'
+require_relative 'resources/candidates'
+require_relative 'resources/offers'
+require_relative 'resources/users'
 
 module GreenhouseApi
-  class Response
-    attr_reader :headers, :body, :status
-
-    def initialize(headers:, body:, status:)
-      @headers = headers
-      @body = body
-      @status = status
-    end
-  end
-
   class Client
-    MAX_PER_PAGE = 500
-    API_URL = 'https://harvest.greenhouse.io/v1'
-
     def initialize(api_key)
       @api_key = api_key
     end
 
+    def get_one(resource, id)
+      base_client.get_one(resource, id)
+    end
+
+    def list_many(resource, params = {})
+      base_client.list_many(resource, params)
+    end
+    
     def list_candidates(params = {})
-      list_many('candidates', params)
+      candidates_client.list_all(params)
     end
 
     def get_current_offer_for_application(application_id)
-      response = request(
-        http_method: :get,
-        headers: headers,
-        endpoint: "applications/#{application_id}/offers/current_offer",
-        params: {}
-      )
-
-      if response.status == 200
-        Response.new(
-          body: response.body,
-          headers: response.headers,
-          status: response.status
-        )
-      else
-        response
-      end
+      offers_client.get_current_offer_for_application(application_id)
     end
 
-    def list_many(resource, params = {})
-      limit = params.delete(:limit)
-      page = 1
-      data = []
-      response = nil
-
-      loop do
-        per_page = limit ? [limit - data.length, MAX_PER_PAGE].min : MAX_PER_PAGE
-
-        response = request(
-          http_method: :get,
-          headers: headers,
-          endpoint: resource,
-          params: params.merge(page: page, per_page: per_page)
-        )
-        break if response.status != 200
-
-        data.concat(response.body)
+    def create_user(first_name:, last_name:, email:, on_behalf_of_id:, **additional_args)
+      users_client.create_user(first_name: first_name, last_name: last_name, email: email, on_behalf_of_id: on_behalf_of_id, **additional_args)
+    end
 
-        if last_page?(response) || data_limit_reached?(data, limit)
-          break
-        else
-          page += 1
-        end
-      end
+    def disable_user(user, on_behalf_of_id)
+      users_client.disable_user(user, on_behalf_of_id)
+    end
 
-      if response.status == 200
-        Response.new(
-          body: data,
-          headers: response.headers,
-          status: response.status
-        )
-      else
-        response
-      end
+    def enable_user(user, on_behalf_of_id)
+      users_client.enable_user(user, on_behalf_of_id)
     end
 
     private
 
-    def last_page?(response)
-      !response.headers['link'].to_s.include?('rel="next"')
-    end
+    attr_accessor :api_key
 
-    def data_limit_reached?(data, limit)
-      limit && data.length >= limit
+    def candidates_client
+      @candidates_client ||= Resources::Candidates.new(api_key)
     end
 
-    def headers
-      credential = Base64.strict_encode64(@api_key + ':')
-
-      {
-        'Authorization' => 'Basic ' + credential,
-      }
+    def offers_client
+      @offers_client ||= Resources::Offers.new(api_key)
     end
 
-    def request(http_method:, headers:, endpoint:, params:, body: {})
-      response = Faraday.public_send(http_method) do |request|
-        request.headers = headers
-        request.path = "#{API_URL}/#{endpoint}"
-        request.params = params
-        request.body = body
-      end
+    def users_client
+      @users_client ||= Resources::Users.new(api_key)
+    end
 
-      Response.new(
-        body: response.body && !response.body.empty? ? JSON.parse(response.body) : '',
-        headers: response.headers,
-        status: response.status
-      )
+    def base_client
+      @base_client ||= BaseClient.new(api_key)
     end
   end
 end
-

data/lib/greenhouse_api/resources/candidates.rb

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+
+module GreenhouseApi
+  module Resources
+    class Candidates < BaseClient
+      extend T::Sig
+
+      sig { params(params: T.nilable(T::Hash[String, T.any(Integer, String)])).returns(Response) }
+      def list_all(params = {})
+        list_many('candidates', params)
+      end
+    end
+  end
+end

data/lib/greenhouse_api/resources/offers.rb

@@ -0,0 +1,22 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+
+module GreenhouseApi
+  module Resources
+    class Offers < BaseClient
+      extend T::Sig
+
+      sig { params(application_id: String).returns(Response) }
+      def get_current_offer_for_application(application_id)
+        response = request(
+          http_method: :get,
+          headers: headers,
+          endpoint: "applications/#{application_id}/offers/current_offer",
+        )
+        compose_response(response)
+      end
+    end
+  end
+end

data/lib/greenhouse_api/resources/users.rb

@@ -0,0 +1,52 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+
+module GreenhouseApi
+  module Resources
+    class Users < BaseClient
+      extend T::Sig
+
+      ON_BEHALF_OF = 'On-Behalf-Of'
+
+      sig { params(first_name: String, last_name: String, email: String, on_behalf_of_id: String, additional_args: T.any(T::Boolean, String)).returns(Response) }
+      def create_user(first_name:, last_name:, email:, on_behalf_of_id:, **additional_args)
+        body = { first_name: first_name, last_name: last_name, email: email }.merge(additional_args).to_json
+        response = request(
+          http_method: :post,
+          headers: headers.merge(ON_BEHALF_OF => on_behalf_of_id),
+          endpoint: "users",
+          body: body
+        )
+        compose_response(response)
+      end
+
+      sig { params(user: T::Hash[String, T.any(Integer, String)], on_behalf_of_id: String).returns(Response) }
+      def disable_user(user, on_behalf_of_id)
+        body = { user: user }.to_json
+        response = request(
+          http_method: :patch,
+          headers: headers.merge(ON_BEHALF_OF => on_behalf_of_id),
+          endpoint: "users/disable",
+          body: body,
+          api_version: 'v2'
+        )
+        compose_response(response)
+      end
+
+      sig { params(user: T::Hash[String, T.any(Integer, String)], on_behalf_of_id: String).returns(Response) }
+      def enable_user(user, on_behalf_of_id)
+        body = { user: user }.to_json
+        response = request(
+          http_method: :patch,
+          headers: headers.merge(ON_BEHALF_OF => on_behalf_of_id),
+          endpoint: "users/enable",
+          body: body,
+          api_version: 'v2'
+        )
+        compose_response(response)
+      end
+    end
+  end
+end

data/lib/greenhouse_api/version.rb

@@ -1,3 +1,4 @@
+# typed: strict
 module GreenhouseApi
-  VERSION = "0.1.12"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: greenhouse_api
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.3.2
 platform: ruby
 authors:
 - Florence Lau
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -26,6 +26,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -40,6 +54,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -76,7 +104,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/greenhouse_api.rb
+- lib/greenhouse_api/base_client.rb
 - lib/greenhouse_api/client.rb
+- lib/greenhouse_api/resources/candidates.rb
+- lib/greenhouse_api/resources/offers.rb
+- lib/greenhouse_api/resources/users.rb
 - lib/greenhouse_api/version.rb
 homepage: https://github.com/gusto/greenhouse_api
 licenses: []