fountain 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2daa741ce144d022348233a66319f12b9051345
-  data.tar.gz: 47adbc3dca6bff4b821fd3aaa0c1de20e309f8f9
+  metadata.gz: b38b462449586bea1c3a1ce67e116b9c439c8e52
+  data.tar.gz: c83cd25cf68b8099f8ec7b11cb0b2eed89f0f326
 SHA512:
-  metadata.gz: a9f3497193a066efca8db1e1eaeb9314e86abeeda82440dd121b4c06ed68831ff3aaacc5a4f705e50e461f453a6cabded34e807756854cefa0502c600acc829e
-  data.tar.gz: 8a672762206813f509994c127c8027c333c72253a5ad97c4ae909abca7f32a5b0a5e45c6e10fcb94994f5161dcb7ccd22251c77306d4b17face0e1a30ceabd61
+  metadata.gz: 55ff9dfeabf1fab057d055b2ae17d6cb5040d6f1a36f4827436d8d108b26996366e58117a5e834b36c2fc7e32d8547fb6abd5c37475c240658648d301e9ebb3e
+  data.tar.gz: 8bacdea06f7863d57114c3281133ca991a4a5e3cf26172813a137318406f8d337ba053e7bed54df8c492c6d208fedb72ae0abb6480e979335d4c2f35b6e9e33f

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fountain'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/fountain.gemspec

@@ -9,12 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = %w[abrom]
   spec.email         = %w[a.bromwich@gmail.com]
 
-  spec.summary       = 'Fountain REST API v2 for Ruby'
-  spec.description   = 'Fountain REST API v2 for Ruby'
+  spec.summary       = 'Fountain REST API v2 wrapper for Ruby'
+  spec.description   = 'Fountain REST API v2 wrapper for Ruby'
   spec.homepage      = 'https://github.com/Studiosity/fountain-ruby'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|docs)/}) }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 

data/lib/fountain.rb

@@ -1 +1,26 @@
-require 'rocket_chat/gem_version'
+require 'fountain/gem_version'
+
+require 'json'
+
+require 'fountain/configuration'
+require 'fountain/util'
+
+module Fountain
+  class Error < StandardError; end
+  class HTTPError < Error; end
+  class NotFoundError < HTTPError; end
+  class AuthenticationError < HTTPError; end
+  class InvalidMethodError < HTTPError; end
+  class JsonParseError < Error; end
+  class MissingApiKeyError < Error; end
+  class StatusError < Error; end
+end
+
+require 'fountain/applicant'
+require 'fountain/background_check'
+require 'fountain/document_signature'
+require 'fountain/funnel'
+require 'fountain/stage'
+
+require 'fountain/api/request_helper'
+require 'fountain/api/applicants'

data/lib/fountain/api/applicants.rb

@@ -0,0 +1,57 @@
+module Fountain
+  module Api
+    #
+    # Fountain Applicant API
+    #
+    class Applicants
+      include RequestHelper
+
+      #
+      # List applicants
+      # @param [Hash] filter_options A hash of options to send to Fountain.
+      #                 funnel_id - Unique identifier of the position/funnel
+      #                 stage_id - Unique identifier of the stage
+      #                 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 = {})
+        response = request_json(
+          '/v2/applicants',
+          body: Util.slice_hash(
+            filter_options,
+            :funnel_id, :stage_id, :stage, :labels, :cursor
+          )
+        )
+        response['applicants'].map { |hash| Fountain::Applicant.new hash }
+      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
+      #                 email
+      #                 phone_number
+      #                 data - must be passed in a data object/array
+      #                 secure_data - See 'Secure Fields' section of
+      #                               https://developer.fountain.com/docs/update-applicant-info
+      #                 rejection_reason
+      #                 on_hold_reason
+      # @return [Fountain::Applicant]
+      #
+      def update(applicant_id, update_options = {})
+        response = request_json(
+          "/v2/applicants/#{applicant_id}",
+          method: :put,
+          body: Util.slice_hash(
+            update_options,
+            :name, :email, :phone_number, :data, :secure_data,
+            :rejection_reason, :on_hold_reason
+          )
+        )
+        Fountain::Applicant.new response
+      end
+    end
+  end
+end

data/lib/fountain/api/request_helper.rb

@@ -0,0 +1,113 @@
+require 'uri'
+require 'openssl'
+require 'net/http'
+
+module Fountain
+  module Api
+    #
+    # Fountain API HTTP request helper
+    #
+    module RequestHelper
+      DEFAULT_REQUEST_OPTIONS = {
+        method: :get,
+        body: nil,
+        headers: nil,
+        ssl_verify_mode: OpenSSL::SSL::VERIFY_PEER,
+        ssl_ca_file: nil
+      }.freeze
+
+      def request_json(path, options = {})
+        response = request path, options
+        check_response 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]
+
+        http = create_http(options)
+        req = create_request(path, options)
+        http.start { http.request(req) }
+      end
+
+      private
+
+      def check_response(response)
+        case response
+        when Net::HTTPOK 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}"
+        end
+      end
+
+      def parse_response(response)
+        JSON.parse(response)
+      rescue JSON::ParserError
+        raise Fountain::JsonParseError, "Fountain response parse error: #{response}"
+      end
+
+      def create_http(options)
+        server = URI.parse Fountain.host_path
+        http = Net::HTTP.new(server.host, server.port)
+
+        if server.scheme == 'https'
+          http.use_ssl = true
+          http.verify_mode = options[:ssl_verify_mode]
+          http.ca_file = options[:ssl_ca_file] if options[:ssl_ca_file]
+        end
+
+        http
+      end
+
+      def create_request(path, options)
+        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
+        end
+      end
+
+      def create_post_request(path, headers, body)
+        req = Net::HTTP::Post.new(path, headers)
+        add_body(req, body) if body
+        req
+      end
+
+      def create_put_request(path, headers, body)
+        req = Net::HTTP::Put.new(path, headers)
+        add_body(req, body) if body
+        req
+      end
+
+      def create_get_request(path, headers, body)
+        path += '?' + body.map { |k, v| "#{k}=#{v}" }.join('&') if body
+        Net::HTTP::Get.new(path, headers)
+      end
+
+      def get_headers(options)
+        headers = options[:headers]
+        headers ||= {}
+        raise Fountain::MissingApiKeyError if Fountain.api_token.nil?
+        headers['X-ACCESS-TOKEN'] = Fountain.api_token
+        headers
+      end
+
+      def add_body(request, body)
+        if body.is_a? Hash
+          request.body = body.to_json
+          request.content_type = 'application/json'
+        else
+          request.body = body.to_s
+        end
+      end
+    end
+  end
+end

data/lib/fountain/applicant.rb

@@ -0,0 +1,79 @@
+module Fountain
+  #
+  # Fountain Applicant
+  #
+  class Applicant
+    # Raw applicant data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw applicant data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Applicant ID
+    def id
+      raw_data['id']
+    end
+
+    # Created at
+    def created_at
+      Time.parse raw_data['created_at']
+    end
+
+    # Email
+    def email
+      raw_data['email']
+    end
+
+    # Name
+    def name
+      raw_data['name']
+    end
+
+    # Phone number
+    def phone_number
+      raw_data['phone_number']
+    end
+
+    # data
+    def data
+      raw_data['data']
+    end
+
+    # Funnel
+    def funnel
+      Funnel.new raw_data['funnel']
+    end
+
+    # Stage
+    def stage
+      Stage.new raw_data['stage']
+    end
+
+    # Background checks
+    def background_checks
+      return [] unless raw_data['background_checks'].is_a? Array
+      raw_data['background_checks'].map { |check| BackgroundCheck.new check }
+    end
+
+    # Document signatures
+    def document_signatures
+      return [] unless raw_data['document_signatures'].is_a? Array
+      raw_data['document_signatures'].map { |signature| DocumentSignature.new signature }
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @id="%<id>s" @name="%<name>s" @email="%<email>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        id: id,
+        name: name,
+        email: email
+      )
+    end
+  end
+end

data/lib/fountain/background_check.rb

@@ -0,0 +1,51 @@
+module Fountain
+  #
+  # Fountain Background Check
+  #
+  class BackgroundCheck
+    # Raw background check data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw background check data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Title
+    def title
+      raw_data['title']
+    end
+
+    # Status
+    def status
+      raw_data['status']
+    end
+
+    # Vendor
+    def vendor
+      raw_data['vendor']
+    end
+
+    # Candidate ID
+    def candidate_id
+      raw_data['candidate_id']
+    end
+
+    # Report ID
+    def report_id
+      raw_data['report_id']
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @title="%<title>s" @status="%<status>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        title: title,
+        status: status
+      )
+    end
+  end
+end

data/lib/fountain/configuration.rb

@@ -0,0 +1,19 @@
+#
+# Fountain configuration
+#
+module Fountain
+  class << self
+    # The path of the Fountain host
+    attr_accessor :host_path
+
+    # API token for Fountain
+    attr_accessor :api_token
+
+    def configure
+      yield self if block_given?
+    end
+  end
+
+  # Set default values for options
+  @host_path = 'https://api.fountain.com'
+end

data/lib/fountain/document_signature.rb

@@ -0,0 +1,40 @@
+module Fountain
+  #
+  # Fountain Document Signature
+  #
+  class DocumentSignature
+    # Raw document signature data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw document signature data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Signature ID
+    def signature_id
+      raw_data['signature_id']
+    end
+
+    # Vendor
+    def vendor
+      raw_data['vendor']
+    end
+
+    # Status
+    def status
+      raw_data['status']
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @signature_id="%<signature_id>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        signature_id: signature_id
+      )
+    end
+  end
+end

data/lib/fountain/funnel.rb

@@ -0,0 +1,41 @@
+module Fountain
+  #
+  # Fountain Funnel
+  #
+  class Funnel
+    # Raw funnel data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw funnel data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Funnel ID
+    def id
+      raw_data['id']
+    end
+
+    # Title
+    def title
+      raw_data['title']
+    end
+
+    # Custom ID
+    def custom_id
+      raw_data['custom_id']
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @id="%<id>s" @title="%<title>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        id: id,
+        title: title
+      )
+    end
+  end
+end

data/lib/fountain/gem_version.rb

@@ -1,3 +1,3 @@
 module Fountain
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

data/lib/fountain/stage.rb

@@ -0,0 +1,36 @@
+module Fountain
+  #
+  # Fountain Stage
+  #
+  class Stage
+    # Raw stage data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw stage data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Stage ID
+    def id
+      raw_data['id']
+    end
+
+    # Title
+    def title
+      raw_data['title']
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @id="%<id>s" @title="%<title>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        id: id,
+        title: title
+      )
+    end
+  end
+end

data/lib/fountain/util.rb

@@ -0,0 +1,42 @@
+module Fountain
+  #
+  # Fountain generic utility functions
+  #
+  module Util
+    #
+    # Stringify symbolized hash keys
+    # @param [Hash] hash A string/symbol keyed hash
+    # @return Stringified hash
+    #
+    def stringify_hash_keys(hash)
+      new_hash = {}
+      hash.each do |key, value|
+        new_hash[key.to_s] =
+          if value.is_a? Hash
+            stringify_hash_keys value
+          else
+            value
+          end
+      end
+      new_hash
+    end
+    module_function :stringify_hash_keys
+
+    #
+    # Slice keys from hash
+    # @param [Hash] hash A hash to slice key/value pairs from
+    # @param [Array] *keys The keys to be sliced
+    # @return Hash filtered by keys
+    #
+    def slice_hash(hash, *keys)
+      return {} if keys.length.zero?
+
+      new_hash = {}
+      hash.each do |key, value|
+        new_hash[key] = value if keys.include? key
+      end
+      new_hash
+    end
+    module_function :slice_hash
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fountain
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - abrom
@@ -94,10 +94,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description: Fountain REST API v2 for Ruby
+description: Fountain REST API v2 wrapper for Ruby
 email:
 - a.bromwich@gmail.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -108,9 +109,19 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
 - fountain.gemspec
 - lib/fountain.rb
+- lib/fountain/api/applicants.rb
+- lib/fountain/api/request_helper.rb
+- lib/fountain/applicant.rb
+- lib/fountain/background_check.rb
+- lib/fountain/configuration.rb
+- lib/fountain/document_signature.rb
+- lib/fountain/funnel.rb
 - lib/fountain/gem_version.rb
+- lib/fountain/stage.rb
+- lib/fountain/util.rb
 homepage: https://github.com/Studiosity/fountain-ruby
 licenses:
 - MIT
@@ -134,5 +145,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Fountain REST API v2 for Ruby
+summary: Fountain REST API v2 wrapper for Ruby
 test_files: []