greenhouse_api 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1fab948b4333edf3ab3a128c3e71f6ab4f2bab1f95bdd17520ff9831e1219ce
-  data.tar.gz: ae1f68bb1eaf7ac0df2b89611c1ef35ebcf37180a61ee96e9cb5f2c840b9cb6d
+  metadata.gz: 9ff456467fd8aef10884057caf6e3b2d7dc2ea9976b64ffa2b2062b255e9b560
+  data.tar.gz: 78db6ff1cf53e4dc3d836ad7b40f466ed96c34d5fd5b2f7bc10ee811e119c3eb
 SHA512:
-  metadata.gz: a72fec148d23ccac414a5a3e9b4f0dfd035e3b0b08b6224c3b8c3aa6fda34e58b1bb6629ac22490ca45876b7a4986c2d640dcc0c72cd5328813ccbabddf5dc34
-  data.tar.gz: 7cd234779df2fc0a49ee8879538d705c5bf5085bcca90b165dc6e755730b5721fcdb38193af8bdc072f69ed410894e623b06a6b4f008ff6adcd4539472b475af
+  metadata.gz: '0834e93de4a38950e2d2a958690fce1429e86a96d3ca3d74150c1822c0efa23e143b281e242d56ea26cd4d7250e77a0ad2bcd226f944d860746b9db8e5b322ca'
+  data.tar.gz: 65808f8f66a3aadbee453d51bc57a713159e9611772f20f28d9074dcad8fc6b34e436604942dc0aff46016461c4f7415458cfcf347723c7f6fa85048405e1988

data/lib/greenhouse_api/base_client.rb

@@ -0,0 +1,116 @@
+# 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 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,125 +1,59 @@
 # 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 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 = 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)
+    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) || params[:page]
-          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,4 +1,4 @@
 # typed: strict
 module GreenhouseApi
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: greenhouse_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Florence Lau
 - Tanner Johnson
 - Quan Nguyen
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -104,13 +104,17 @@ 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: []
 metadata:
   homepage_uri: https://github.com/gusto/greenhouse_api
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -125,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: API client for working with Greenhouse Harvest API
 test_files: []