fountain 0.0.9 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bf198332a6ca56e05d48ce30225fdf951b026e34
-  data.tar.gz: 629943449a033d8add4f2b2fc96391d6baa4c796
+SHA256:
+  metadata.gz: 5d78d33209aa2c3222155ea3643333a0df696466b1589d503adcaa28ded7aeea
+  data.tar.gz: 4a6ff22d217ee2cae43e6093fa218c450ea673924a71ffcec4bb2b9bd73ebc2b
 SHA512:
-  metadata.gz: 1a50953c3662441f109eb03a3041beeb690434a1e2ea855ee5c7314a63c2858d0f1003ac7b31815825b5b9c136daadc6ab06bfb738f275256dccfab70df525cc
-  data.tar.gz: 7758d4a5042ac0c043e99fef643975ce57b5c4db2b26fbabdab5e5ccd7ace15b1375ddd0517a584553644d4c14ffd9969efced6fa57261777731c4d8c5999336
+  metadata.gz: 957fe69e2f9b464fe77bf245f4778e931d071febb8178e476de852c0beb606d2adf49aac0a7c2d1b6c8b926125fa3873f0d66f7119033994137437be0c366fee
+  data.tar.gz: e227563179603e1f2e571f22369616bdd3915e58cb8362f195101e53c63325002933d1cb3419eedd12cc476c1d449f639d9b8f235862509182754c5249c0e683

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 *.gem
+coverage/

data/.rubocop.yml

@@ -1,11 +1,25 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Max: 120
+
 Metrics/BlockLength:
   Exclude:
     - "**/*_spec.rb"
 
-Metrics/LineLength:
-  Max: 120
-
 Metrics/MethodLength:
   Max: 15
   Exclude:
     - "**/*_spec.rb"
+
+RSpec/ExampleLength:
+  Max: 15
+
+RSpec/MultipleExpectations:
+  Max: 5

data/.travis.yml

@@ -5,11 +5,10 @@ env:
 language: ruby
 
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
   - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
 
 before_install:
   - gem update bundler
@@ -24,7 +23,7 @@ before_script:
   - ./cc-test-reporter before-build
 
 script:
-  - rubocop
+  - bundle exec rubocop
   - bundle exec rake
 
 after_script:

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+## Unreleased
+- None
+
+## [0.0.12](releases/tag/v0.0.12) - 2020-03-01
+### Fixed
+- Address CVE-2020-8130 - `rake` OS command injection vulnerability
+
+## [0.0.11](releases/tag/v0.0.11) - 2018-06-02
+### Fixed
+- Update applicants and notes APIs to check correct return status for create actions
+
+## [0.0.10](releases/tag/v0.0.10) - 2018-03-24
+### Added
+- Funnel management API support
+
+## [0.0.9](releases/tag/v0.0.9) - 2018-03-24
+### Added
+- Session/slot management API support
+
+## [0.0.8](releases/tag/v0.0.8) - 2018-03-24
+### Added
+- Note management API support 
+### Fixed
+- Replace deprecated URI.encode with CGI.escape
+
+## [0.0.7](releases/tag/v0.0.7) - 2018-03-24
+### Added
+- Label management API support 
+
+## [0.0.6](releases/tag/v0.0.6) - 2018-03-22
+### Added
+- Create applicant support
+- Delete applicant support
+- Get applicant support
+- get_secure_documents applicant support
+- Secure document type
+- Advance applicant support
+- Interview sessions for applicant support
+- Transition history for applicant support
+
+## [0.0.5](releases/tag/v0.0.5) - 2018-03-20
+### Fixed
+- Applicants inspect method
+
+## [0.0.4](releases/tag/v0.0.4) - 2018-03-20
+### Added
+- Applicants inspect method
+
+## [0.0.3](releases/tag/v0.0.3) - 2018-03-20
+### Added
+- Applicants wrapper to contain pagination cursors
+
+## [0.0.2](releases/tag/v0.0.2) - 2018-03-19
+### Added
+- Support for applicant list and update

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fountain.gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'fountain'

data/fountain.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -13,15 +15,17 @@ Gem::Specification.new do |spec|
   spec.description   = 'Fountain REST API v2 wrapper for Ruby'
   spec.homepage      = 'https://github.com/Studiosity/fountain-ruby'
   spec.license       = 'MIT'
+  spec.required_ruby_version = ['>= 2.5.0', '< 3.1.0']
 
   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']
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.53'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.5'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'webmock', '~> 2.3'
 end

data/lib/fountain/api/applicants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   module Api
     #
@@ -48,6 +50,7 @@ module Fountain
         response = request_json(
           '/v2/applicants',
           method: :post,
+          expected_response: [Net::HTTPCreated, Net::HTTPOK],
           body: {
             name: name, email: email, phone_number: phone_number
           }.merge(filtered_params)

data/lib/fountain/api/available_slots.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   module Api
     #

data/lib/fountain/api/funnels.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Fountain
+  module Api
+    #
+    # Fountain Funnel Management API
+    #
+    class Funnels
+      extend RequestHelper
+
+      #
+      # List all Funnels
+      # @param [Hash] list_options A hash of options when listing funnels
+      # @return [Fountain::Funnels]
+      def self.list(list_options = {})
+        page_query = list_options[:page] ? "?page=#{list_options[:page]}" : ''
+        response = request_json("/v2/funnels#{page_query}")
+        Fountain::Funnels.new response
+      end
+
+      #
+      # Update Funnel
+      # @param [String] funnel_id ID of the Fountain funnel
+      # @param [Hash] update_options A hash of options when updating a funnel
+      #                 custom_id
+      # @return [Fountain::Funnel]
+      def self.update(funnel_id, update_options = {})
+        response = request_json(
+          "/v2/funnels/#{funnel_id}",
+          method: :put,
+          body: Util.slice_hash(update_options, :custom_id)
+        )
+        Fountain::Funnel.new response
+      end
+
+      #
+      # List all Funnel stages
+      # @param [String] funnel_id ID of the Fountain funnel
+      # @return [[Fountain::Stage]]
+      def self.list_stages(funnel_id)
+        response = request_json("/v2/funnels/#{funnel_id}/stages")
+        response['stages'].map { |hash| Fountain::Stage.new hash }
+      end
+    end
+  end
+end

data/lib/fountain/api/labels.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'cgi'
 

data/lib/fountain/api/notes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   module Api
     #
@@ -24,6 +26,7 @@ module Fountain
         response = request_json(
           "/v2/applicants/#{applicant_id}/notes",
           method: :post,
+          expected_response: [Net::HTTPCreated, Net::HTTPOK],
           body: { content: content }
         )
         Fountain::Note.new response

data/lib/fountain/api/request_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'openssl'
 require 'net/http'
@@ -38,7 +40,7 @@ module Fountain
       def check_response(response, expected_response = nil)
         expected_response ||= Net::HTTPOK
         case response
-        when expected_response then nil
+        when *[expected_response].flatten 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}"
@@ -93,7 +95,7 @@ module Fountain
       end
 
       def create_get_request(path, headers, body)
-        path += '?' + body.map { |k, v| "#{k}=#{v}" }.join('&') if body
+        path += "?#{body.map { |k, v| "#{k}=#{v}" }.join('&')}" if body
         Net::HTTP::Get.new(path, headers)
       end
 
@@ -101,6 +103,7 @@ module Fountain
         headers = options[:headers]
         headers ||= {}
         raise Fountain::MissingApiKeyError if Fountain.api_token.nil?
+
         headers['X-ACCESS-TOKEN'] = Fountain.api_token
         headers
       end

data/lib/fountain/applicant.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Applicant
@@ -56,12 +58,14 @@ module Fountain
     # 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
 

data/lib/fountain/applicants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Applicant collection

data/lib/fountain/background_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Background Check

data/lib/fountain/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Fountain configuration
 #

data/lib/fountain/document_signature.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Document Signature

data/lib/fountain/field.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Fountain
+  #
+  # Fountain Field
+  #
+  class Field
+    # Raw field data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw field data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Question
+    def question
+      raw_data['question']
+    end
+
+    # Type
+    def type
+      raw_data['type']
+    end
+
+    # Key
+    def key
+      raw_data['key']
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @type="%<type>s" @question="%<title>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        type: type,
+        question: question
+      )
+    end
+  end
+end

data/lib/fountain/funnel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Funnel
@@ -28,6 +30,57 @@ module Fountain
       raw_data['custom_id']
     end
 
+    # Address
+    def address
+      raw_data['address']
+    end
+
+    # Time zone
+    def time_zone
+      raw_data['time_zone']
+    end
+
+    # Description
+    def description
+      raw_data['description']
+    end
+
+    # Requirements
+    def requirements
+      raw_data['requirements']
+    end
+
+    # Fields
+    def fields
+      return [] unless raw_data['fields'].is_a? Array
+
+      raw_data['fields'].map { |hash| Field.new hash }
+    end
+
+    # Stages
+    def stages
+      return [] unless raw_data['stages'].is_a? Array
+
+      raw_data['stages'].map { |hash| Stage.new hash }
+    end
+
+    # Private
+    def private?
+      raw_data['is_private']
+    end
+
+    # Active
+    def active?
+      raw_data['active']
+    end
+
+    # Location
+    def location
+      return unless raw_data['location'].is_a? Hash
+
+      Location.new raw_data['location']
+    end
+
     def inspect
       format(
         '#<%<class_name>s:0x%<object_id>p @id="%<id>s" @title="%<title>s">',

data/lib/fountain/funnels.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Fountain
+  #
+  # Fountain Funnel collection
+  #
+  class Funnels
+    extend Forwardable
+
+    # Collection current page
+    attr_reader :current_page
+
+    # Collection last page
+    attr_reader :last_page
+
+    # Funnel collection
+    attr_reader :funnels
+
+    def_delegators :funnels, :each, :map, :count, :size, :[]
+
+    #
+    # @param [Hash] data Raw funnel data
+    #
+    def initialize(data)
+      raw_data = Util.stringify_hash_keys data
+      pagination = raw_data['pagination']
+      if pagination.is_a? Hash
+        @current_page = pagination['current']
+        @last_page = pagination['last']
+      end
+      @funnels = raw_data['funnels'].map { |attr| Funnel.new attr }
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @count="%<count>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        count: count
+      )
+    end
+  end
+end

data/lib/fountain/gem_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
-  VERSION = '0.0.9'.freeze
+  VERSION = '0.0.13'
 end

data/lib/fountain/label.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Label

data/lib/fountain/location.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Fountain
+  #
+  # Fountain Location
+  #
+  class Location
+    # Raw location data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw location data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Location ID
+    def id
+      raw_data['id']
+    end
+
+    # Name
+    def name
+      raw_data['name']
+    end
+  end
+end

data/lib/fountain/note.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Note
@@ -36,6 +38,7 @@ module Fountain
     # User
     def user
       return unless raw_data['user'].is_a? Hash
+
       User.new raw_data['user']
     end
 

data/lib/fountain/secure_document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Secure Document

data/lib/fountain/slot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Slot
@@ -44,8 +46,8 @@ module Fountain
     end
 
     # Showed up
-    def showed_up
-      raw_data['showed_up'] == 'true'
+    def showed_up?
+      raw_data['showed_up'].to_s == 'true'
     end
 
     def inspect

data/lib/fountain/slots.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Slot collection

data/lib/fountain/stage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Stage
@@ -23,6 +25,11 @@ module Fountain
       raw_data['title']
     end
 
+    # Type
+    def type
+      raw_data['type']
+    end
+
     def inspect
       format(
         '#<%<class_name>s:0x%<object_id>p @id="%<id>s" @title="%<title>s">',

data/lib/fountain/transition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Transition

data/lib/fountain/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain User

data/lib/fountain/util.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain generic utility functions
   #
   module Util
+    module_function
+
     #
     # Stringify symbolized hash keys
     # @param [Hash] hash A string/symbol keyed hash
@@ -20,7 +24,6 @@ module Fountain
       end
       new_hash
     end
-    module_function :stringify_hash_keys
 
     #
     # Slice keys from hash
@@ -37,6 +40,5 @@ module Fountain
       end
       new_hash
     end
-    module_function :slice_hash
   end
 end

data/lib/fountain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fountain/gem_version'
 
 require 'json'
@@ -7,12 +9,19 @@ 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
 
@@ -20,8 +29,11 @@ require 'fountain/applicant'
 require 'fountain/applicants'
 require 'fountain/background_check'
 require 'fountain/document_signature'
+require 'fountain/field'
 require 'fountain/funnel'
+require 'fountain/funnels'
 require 'fountain/label'
+require 'fountain/location'
 require 'fountain/note'
 require 'fountain/secure_document'
 require 'fountain/slot'
@@ -33,5 +45,6 @@ require 'fountain/user'
 require 'fountain/api/request_helper'
 require 'fountain/api/applicants'
 require 'fountain/api/available_slots'
+require 'fountain/api/funnels'
 require 'fountain/api/labels'
 require 'fountain/api/notes'

metadata

@@ -1,71 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: fountain
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.13
 platform: ruby
 authors:
 - abrom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-24 00:00:00.000000000 Z
+date: 2021-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +125,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -114,6 +135,7 @@ files:
 - lib/fountain.rb
 - lib/fountain/api/applicants.rb
 - lib/fountain/api/available_slots.rb
+- lib/fountain/api/funnels.rb
 - lib/fountain/api/labels.rb
 - lib/fountain/api/notes.rb
 - lib/fountain/api/request_helper.rb
@@ -122,9 +144,12 @@ files:
 - lib/fountain/background_check.rb
 - lib/fountain/configuration.rb
 - lib/fountain/document_signature.rb
+- lib/fountain/field.rb
 - lib/fountain/funnel.rb
+- lib/fountain/funnels.rb
 - lib/fountain/gem_version.rb
 - lib/fountain/label.rb
+- lib/fountain/location.rb
 - lib/fountain/note.rb
 - lib/fountain/secure_document.rb
 - lib/fountain/slot.rb
@@ -145,15 +170,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Fountain REST API v2 wrapper for Ruby