fountain 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c5e9a3a1b38cd8a1110f5898e134cc9df352309
-  data.tar.gz: 0a946cb763f2a69b7c8a63285e783270906719b9
+  metadata.gz: b3f653218c512db55d5962968cd24d27ddd397d9
+  data.tar.gz: 4de91be1284cec1b666cff24fa6f125faf00f272
 SHA512:
-  metadata.gz: 7f81069700b642aeb4ccdf5b867e5583bda22b60602d436f6f41b60fde84f55e877454e64e11bb41f4720f43538f5368ea777c4163a2631f8b0ecaaa370584fd
-  data.tar.gz: 54c83583d1f8004b5752cae292b0b0c85e83325c790ffbcceeb8f2feda6f46d0978a5266a4809319d4ba69144602009002e1a3e1269a012c2ac69b0135611c46
+  metadata.gz: 134cd04804537aa3e18752ff099491bd99e92391eef01b95c10d9b02856ea7d514eca255cf412ddb9e611dcfd496b1d75513e502610f43cd023ddfa192cf1192
+  data.tar.gz: f3b60a48988a06d3727e5e292b7a690e1d9430f52c6c8c93d777c2c84d688fc4e2a3a911fc086fa2a1cbfe9c561cec31d9cf6f39e0fa83174e168272d63c8ea2

data/lib/fountain.rb

@@ -19,9 +19,12 @@ end
 require 'fountain/applicant'
 require 'fountain/applicants'
 require 'fountain/background_check'
+require 'fountain/booked_slot'
 require 'fountain/document_signature'
 require 'fountain/funnel'
+require 'fountain/secure_document'
 require 'fountain/stage'
+require 'fountain/transition'
 
 require 'fountain/api/request_helper'
 require 'fountain/api/applicants'

data/lib/fountain/api/applicants.rb

@@ -4,7 +4,7 @@ module Fountain
     # Fountain Applicant API
     #
     class Applicants
-      include RequestHelper
+      extend RequestHelper
 
       #
       # List applicants
@@ -14,8 +14,8 @@ module Fountain
       #                 stage - Filter applicants by stage type
       #                 labels - MUST be URL-encoded
       #                 cursor - Cursor parameter for cursor-based pagination
-      # @return [Array] of Fountain::Applicant
-      def list(filter_options = {})
+      # @return [Fountain::Applicants]
+      def self.list(filter_options = {})
         response = request_json(
           '/v2/applicants',
           body: Util.slice_hash(
@@ -27,7 +27,58 @@ module Fountain
       end
 
       #
-      # Update applicant info
+      # Create an Applicant
+      # @param [String] name Full name of the applicant
+      # @param [String] email Email address of the applicant
+      # @param [String] phone_number Phone number (does not have to be USA)
+      # @param [Hash] create_options A hash of optional parameters
+      #                 data - must be passed in a data object/array
+      #                 secure_data - See 'Secure Fields' section of
+      #                               https://developer.fountain.com/docs/post-apiv2applicants
+      #                 funnel_id - Create applicant under a certain opening (funnel)
+      #                 stage_id - Create applicant under a certain stage
+      #                 skip_automated_actions - `true` if you want to skip automated
+      #                                          actions when advancing the applicant
+      # @return [Fountain::Applicant]
+      def self.create(name, email, phone_number, create_options = {})
+        filtered_params = Util.slice_hash(
+          create_options,
+          :data, :secure_data, :funnel_id, :stage_id, :skip_automated_actions
+        )
+        response = request_json(
+          '/v2/applicants',
+          method: :post,
+          body: {
+            name: name, email: email, phone_number: phone_number
+          }.merge(filtered_params)
+        )
+        Fountain::Applicant.new response
+      end
+
+      #
+      # Delete an Applicant
+      # @param [String] applicant_id ID of the Fountain applicant
+      # @return [Boolean]
+      def self.delete(applicant_id)
+        response = request(
+          "/v2/applicants/#{applicant_id}",
+          method: :delete
+        )
+        check_response response
+        true
+      end
+
+      #
+      # Get Applicant Info
+      # @param [String] applicant_id ID of the Fountain applicant
+      # @return [Fountain::Applicant]
+      def self.get(applicant_id)
+        response = request_json("/v2/applicants/#{applicant_id}")
+        Fountain::Applicant.new response
+      end
+
+      #
+      # Update Applicant Info
       # @param [String] applicant_id ID of the Fountain applicant
       # @param [Hash] update_options A hash of options to update applicant
       #                 name
@@ -40,7 +91,7 @@ module Fountain
       #                 on_hold_reason
       # @return [Fountain::Applicant]
       #
-      def update(applicant_id, update_options = {})
+      def self.update(applicant_id, update_options = {})
         response = request_json(
           "/v2/applicants/#{applicant_id}",
           method: :put,
@@ -52,6 +103,54 @@ module Fountain
         )
         Fountain::Applicant.new response
       end
+
+      #
+      # Get Applicant Documents
+      # @param [String] applicant_id ID of the Fountain applicant
+      # @return [[Fountain::SecureDocument]]
+      def self.get_secure_documents(applicant_id)
+        response = request_json("/v2/applicants/#{applicant_id}/secure_documents")
+        response['secure_documents'].map { |hash| Fountain::SecureDocument.new hash }
+      end
+
+      #
+      # Advance an Applicant
+      # @param [String] applicant_id ID of the Fountain applicant
+      # @param [Hash] advance_options A hash of options to advance applicant
+      #                 skip_automated_actions - `true` if you want to skip automated
+      #                                          actions when advancing the applicant
+      #                 stage_id - Destination stage's ID. If not provided, the applicant
+      #                              will advance to the next stage by default.
+      def self.advance_applicant(applicant_id, advance_options = {})
+        response = request(
+          "/v2/applicants/#{applicant_id}/advance",
+          method: :put,
+          body: Util.slice_hash(
+            advance_options,
+            :skip_automated_actions, :stage_id
+          )
+        )
+        check_response response, Net::HTTPNoContent
+        true
+      end
+
+      #
+      # Get Interview Sessions
+      # @param [String] applicant_id ID of the Fountain applicant
+      # @return [[Fountain::BookedSlot]]
+      def self.get_interview_sessions(applicant_id)
+        response = request_json("/v2/applicants/#{applicant_id}/booked_slots")
+        response['booked_slots'].map { |hash| Fountain::BookedSlot.new hash }
+      end
+
+      #
+      # Get Transition History
+      # @param [String] applicant_id ID of the Fountain applicant
+      # @return [[Fountain::Transition]]
+      def self.get_transition_history(applicant_id)
+        response = request_json("/v2/applicants/#{applicant_id}/transitions")
+        response['transitions'].map { |hash| Fountain::Transition.new hash }
+      end
     end
   end
 end

data/lib/fountain/api/request_helper.rb

@@ -17,15 +17,16 @@ module Fountain
       }.freeze
 
       def request_json(path, options = {})
+        expected_response = options.delete :expected_response
         response = request path, options
-        check_response response
+        check_response response, expected_response
         parse_response response.body
       end
 
       def request(path, options = {})
         options = DEFAULT_REQUEST_OPTIONS.merge(options)
 
-        raise Fountain::InvalidMethodError unless %i[get post put].include? options[:method]
+        raise Fountain::InvalidMethodError unless %i[get post put delete].include? options[:method]
 
         http = create_http(options)
         req = create_request(path, options)
@@ -34,9 +35,10 @@ module Fountain
 
       private
 
-      def check_response(response)
+      def check_response(response, expected_response = nil)
+        expected_response ||= Net::HTTPOK
         case response
-        when Net::HTTPOK then nil
+        when expected_response then nil
         when Net::HTTPUnauthorized then raise Fountain::AuthenticationError
         when Net::HTTPNotFound then raise Fountain::NotFoundError
         else raise HTTPError, "Invalid http response code: #{response.code}"
@@ -66,12 +68,11 @@ module Fountain
         headers = get_headers(options)
         body = options[:body]
 
-        if options[:method] == :post
-          create_post_request path, headers, body
-        elsif options[:method] == :put
-          create_put_request path, headers, body
-        else
-          create_get_request path, headers, body
+        case options[:method]
+        when :post then create_post_request path, headers, body
+        when :put then create_put_request path, headers, body
+        when :delete then create_delete_request path, headers
+        else create_get_request path, headers, body
         end
       end
 
@@ -87,6 +88,10 @@ module Fountain
         req
       end
 
+      def create_delete_request(path, headers)
+        Net::HTTP::Delete.new(path, headers)
+      end
+
       def create_get_request(path, headers, body)
         path += '?' + body.map { |k, v| "#{k}=#{v}" }.join('&') if body
         Net::HTTP::Get.new(path, headers)

data/lib/fountain/booked_slot.rb

@@ -0,0 +1,60 @@
+module Fountain
+  #
+  # Fountain Booked Slot
+  #
+  class BookedSlot
+    # Raw booked slot data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw booked slot data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Booked slot ID
+    def id
+      raw_data['id']
+    end
+
+    # Start time
+    def start_time
+      Time.parse raw_data['start_time']
+    end
+
+    # End time
+    def end_time
+      Time.parse raw_data['end_time']
+    end
+
+    # Location
+    def location
+      raw_data['location']
+    end
+
+    # Recruiter
+    def recruiter
+      raw_data['recruiter']
+    end
+
+    # Instructions
+    def instructions
+      raw_data['instructions']
+    end
+
+    # Showed up
+    def showed_up
+      raw_data['showed_up'] == 'true'
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @id="%<id>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        id: id
+      )
+    end
+  end
+end

data/lib/fountain/gem_version.rb

@@ -1,3 +1,3 @@
 module Fountain
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 end

data/lib/fountain/secure_document.rb

@@ -0,0 +1,61 @@
+module Fountain
+  #
+  # Fountain Secure Document
+  #
+  class SecureDocument
+    # Raw document data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw secure document data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Secure document ID
+    def id
+      raw_data['id']
+    end
+
+    # Name
+    def name
+      raw_data['name']
+    end
+
+    # FriendlyName
+    def friendly_name
+      raw_data['friendly_name']
+    end
+
+    # Filename
+    def filename
+      raw_data['filename']
+    end
+
+    # Public URL
+    def public_url
+      raw_data['public_url']
+    end
+
+    # Size
+    def size
+      raw_data['size']
+    end
+
+    # Stage
+    def stage
+      Stage.new raw_data['stage']
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @id="%<id>s" @name="%<name>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        id: id,
+        name: name
+      )
+    end
+  end
+end

data/lib/fountain/transition.rb

@@ -0,0 +1,35 @@
+module Fountain
+  #
+  # Fountain Transition
+  #
+  class Transition
+    # Raw transition data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw transition data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Stage title
+    def stage_title
+      raw_data['stage_title']
+    end
+
+    # Created at
+    def created_at
+      Time.parse raw_data['created_at']
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @stage_title="%<title>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        title: stage_title
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fountain
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - abrom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,11 +117,14 @@ files:
 - lib/fountain/applicant.rb
 - lib/fountain/applicants.rb
 - lib/fountain/background_check.rb
+- lib/fountain/booked_slot.rb
 - lib/fountain/configuration.rb
 - lib/fountain/document_signature.rb
 - lib/fountain/funnel.rb
 - lib/fountain/gem_version.rb
+- lib/fountain/secure_document.rb
 - lib/fountain/stage.rb
+- lib/fountain/transition.rb
 - lib/fountain/util.rb
 homepage: https://github.com/Studiosity/fountain-ruby
 licenses: