fountain 0.0.11 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 210b37df4117b80bcc00d37ac66c619c4227fbdb
-  data.tar.gz: 475ccfc2c690b58b360a5cbd02fc8d8e4432149d
+SHA256:
+  metadata.gz: d776c086bfff984cadcc66f4ea7898dc434dbeb239be346d88e50b2e9b969d79
+  data.tar.gz: f38a2ff38e7f0805519013ac3d4808200451b449e3874eb101f3658c40b6f077
 SHA512:
-  metadata.gz: 10134e36f75790ff739e2a1508be084ff103db70b237916e8a7d8c8cf974d25c3271c5793669bcd4ef0624a8d659c0dc2f22ddcbb16184df93cb77f1d7e406ef
-  data.tar.gz: 3144aac5bf2f21223ebbd4ca81e8ac458f690e7cd43094cc9f15a118cf169b502dfb58b365ad98d849cba3af3c796d4907539d234294206b23738fbbda920dfa
+  metadata.gz: e82ba7e512bfa3892c54d127f4de4e02b0beb9388bc1c43b305d07d99798f57f5c4527dd8c2a80171482730b0914d79780c2b09c32527c5752ec4df0bc53017f
+  data.tar.gz: ad10b59cf556f5224e4d641cece6ea3404394d4468281cd492292b5ff6c59951f1856dc7c4e042ba42065e38d07203d699510090a546bfd60c9dcb5902f07a9a

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Test Fountain Ruby gem
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Lint code - Rubocop
+        run: bundle exec rubocop
+
+      - name: Run tests
+        run: bundle exec rspec
+
+      - name: Test & publish code coverage
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: ced551cb55b574bb553181cb1c7abae8452a4f7f6e92df83633984a03693e284

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/CHANGELOG.md

@@ -0,0 +1,67 @@
+# Changelog
+
+## Unreleased
+- None
+
+## [0.0.14](releases/tag/v0.0.14) - 2022-06-12
+### Fixed
+- [#5] Add get funnel and get stage to API ([@noahkconley][])
+
+## [0.0.13](releases/tag/v0.0.13) - 2021-09-24
+### Fixed
+- [#3] Update applicants and notes APIs to use *new* expected return statuses from create actions
+
+## [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
+
+[@noahkconley]: https://github.com/noahkconley

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,18 @@ 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.2.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.metadata['rubygems_mfa_required'] = 'true'
 
-  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 'simplecov', '~> 0.16'
+  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', '< 0.18'
   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,7 +50,7 @@ module Fountain
         response = request_json(
           '/v2/applicants',
           method: :post,
-          expected_response: Net::HTTPCreated,
+          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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   module Api
     #
@@ -16,6 +18,15 @@ module Fountain
         Fountain::Funnels.new response
       end
 
+      #
+      # Get Funnel Info
+      # @param [String] funnel_id ID of the Fountain funnel
+      # @return [Fountain::Funnel]
+      def self.get(funnel_id)
+        response = request_json("/v2/funnels/#{funnel_id}")
+        Fountain::Funnel.new response
+      end
+
       #
       # Update Funnel
       # @param [String] funnel_id ID of the Fountain funnel

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,7 +26,7 @@ module Fountain
         response = request_json(
           "/v2/applicants/#{applicant_id}/notes",
           method: :post,
-          expected_response: Net::HTTPCreated,
+          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/api/stages.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Fountain
+  module Api
+    #
+    # Fountain Stage Management API
+    #
+    class Stages
+      extend RequestHelper
+
+      #
+      # Get Stage Info
+      # @param [String] stage_id ID of the Fountain stage
+      # @return [Fountain::Stage]
+      def self.get(stage_id)
+        response = request_json("/v2/stages/#{stage_id}")
+        Fountain::Stage.new response
+      end
+    end
+  end
+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

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

data/lib/fountain/funnel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fountain
   #
   # Fountain Funnel
@@ -51,12 +53,14 @@ module Fountain
     # 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
 
@@ -73,6 +77,7 @@ module Fountain
     # Location
     def location
       return unless raw_data['location'].is_a? Hash
+
       Location.new raw_data['location']
     end
 

data/lib/fountain/funnels.rb

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

data/lib/fountain/gem_version.rb

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

data/lib/fountain/label.rb

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

data/lib/fountain/location.rb

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

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

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

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
 
@@ -39,3 +48,4 @@ require 'fountain/api/available_slots'
 require 'fountain/api/funnels'
 require 'fountain/api/labels'
 require 'fountain/api/notes'
+require 'fountain/api/stages'

metadata

@@ -1,71 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: fountain
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.14
 platform: ruby
 authors:
 - abrom
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-02 00:00:00.000000000 Z
+date: 2022-06-12 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
@@ -73,6 +93,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -80,6 +103,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -102,9 +128,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -118,6 +145,7 @@ files:
 - lib/fountain/api/labels.rb
 - lib/fountain/api/notes.rb
 - lib/fountain/api/request_helper.rb
+- lib/fountain/api/stages.rb
 - lib/fountain/applicant.rb
 - lib/fountain/applicants.rb
 - lib/fountain/background_check.rb
@@ -140,8 +168,9 @@ files:
 homepage: https://github.com/Studiosity/fountain-ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,16 +178,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Fountain REST API v2 wrapper for Ruby
 test_files: []

data/.travis.yml

@@ -1,31 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=ced551cb55b574bb553181cb1c7abae8452a4f7f6e92df83633984a03693e284
-
-language: ruby
-
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-
-before_install:
-  - gem update bundler
-
-install:
-  - bundle install --jobs=3 --retry=3
-  - gem install rubocop
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script:
-  - rubocop
-  - bundle exec rake
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT