fountain-papi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bbdbeb5c23aba4ccce04ea6388164db25f1605791c71f418a93614207a34f76
+  data.tar.gz: 64a18f729b985d07af85d1a5119a936634b8d8c83c48ad06d7306e4c43c7030a
+SHA512:
+  metadata.gz: 943343fa0f4af9bd5b6c6e47acaf6db42da74ebf2effe2af1de0b456bca7248a549f974d0f21cfb3a68c04499759bdc633ec25c7c3abd7a49e66a38679441af5
+  data.tar.gz: eb7d9959c8b1aa616aaccd6c9aff8d4ae0923bffafa470c1d109b1f142457d8bae1aabbb7113b08709adbcc6fc89dddfcfc168477272232e3e92673b5a7b69d3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-06-01
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fountain-papi.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    fountain-papi (0.1.0)
+      dry-struct (~> 1.4)
+      httparty (~> 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    dry-configurable (0.15.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.1)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
+      ice_nine (~> 0.11)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    ice_nine (0.11.2)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  fountain-papi!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  webmock
+
+BUNDLED WITH
+   2.3.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Joey Cody
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Fountain PAPI Ruby Client
+
+[Fountain Partners API (PAPI)](https://partners.fountain.com/) ruby client. Helps get started quickly interfacing with PAPI. Today, the library allows for creating partner statuses for an applicant.
+
+In the future, this library is intended be at feature-parity with PAPI operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fountain-papi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fountain-papi
+
+## Configuration
+
+Create an initializer in `config/initializers/fountain_papi.rb` with your Partner ID and API Key:
+
+```ruby
+Fountain::Papi.configure do |config|
+  config.api_key = "db516773-4615-4bfa-bce8-94fe9bb951b2" # YOUR API KEY HERE
+  config.partner_id = "3870fc40-d0f7-449e-8152-2a741ef3b301" # YOUR PARTNER ID HERE
+
+  # Additional options:
+  # config.sandbox = true
+  # config.version = 1
+end
+```
+
+If you do not have either of those keys, please reach out to your Fountain partner representative. 
+
+When you're ready to update your partner to production, set `config.sandbox = false` in the above configuration.
+
+## Usage
+
+Today the Ruby client supports [creating Applicant statuses](https://partners.fountain.com/reference/post_v1-partners-id-applicants-applicant-id-status).
+
+```ruby
+result = Fountain::Papi.create_status(
+  applicant_id: "231ea206-4d6e-4d7c-80d0-81dff956a197",
+  status: "in_progress",
+)
+
+# => #<Fountain::Papi::Applicant::Status status="in_progress" applicant_id="231ea206-4d6e-4d7c-80d0-81dff956a197" account_option=nil link_title=nil title=nil url=nil category=nil color="green" display_status="[Partner Name] In Progress" display_title="[Partner Name] In Progress" external_id="b87ab326-ee84-40aa-a28e-9d520cfeaca8" show_redo=false status_type=nil>
+
+result.status
+# => "in_progress"
+
+result.applicant_id
+# => "231ea206-4d6e-4d7c-80d0-81dff956a197"
+
+result.display_status
+# => "[Partner Name] In Progress"
+
+result.url
+# => nil
+```
+
+options for `status` param are:
+ - `incomplete`
+ - `in_progress`
+ - `pending_action`
+ - `completed`
+ - `error`
+
+### Additional options when creating an applicant status:
+
+```ruby
+Fountain::Papi.create_status(
+  applicant_id: "231ea206-4d6e-4d7c-80d0-81dff956a197",
+  status: "completed",
+  account_option: "report_type_1",
+  category: "string",
+  link_title: "Our report results",
+  status_type: "foobar",
+  title: "Great Title",
+  url: "http://fountain.com/our_link",
+)
+
+# => #<Fountain::Papi::Applicant::Status status="completed" applicant_id="231ea206-4d6e-4d7c-80d0-81dff956a197" account_option=nil link_title="Fountain.com" title="Our new title" url="https://www.fountain.com/our_link" category=nil color="green" display_status="[Partner Name] Completed" display_title="[Partner Name] Great Title" external_id="b87ab326-ee84-40aa-a28e-9d520cfeaca8" show_redo=false status_type=nil>
+```
+
+##### `title`
+
+Title that will show on the applicant's profile on Fountain. Useful for labeling the applicant with quick details (i.e. "Score: 85%") that are viewed on the Applicant Table.
+
+##### `category`
+
+TODO:
+
+##### `link_title`
+
+(presumably) The title that is shown for the URL link.
+
+##### `url`
+
+URL that can be clicked on from the applicant's status label. Useful for viewing additional details -- i.e. a report, partner website, etc -- that might be useful to the recruiter using Fountain.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [onboardiq/fountain-papi](https://github.com/onboardiq/fountain-papi).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/fountain/papi/applicant/create_status.rb

@@ -0,0 +1,36 @@
+module Fountain
+  module Papi
+    def self.create_status(params)
+      Applicant::CreateStatus.new(params).call
+    end
+
+    module Applicant
+      class CreateStatus
+        attr_reader :status
+
+        def initialize(params)
+          @status = Fountain::Papi::Applicant::Status.new(params)
+        end
+
+        def call
+          response = Client.post(
+            "#{Fountain::Papi.config.base_uri}/applicants/#{status.applicant_id}/status",
+            body: { applicant: { partner_status: status } }.to_json,
+            headers: Fountain::Papi.config.headers
+          )
+
+          raise Fountain::Papi::Error.new(response) unless response.success?
+
+          created_status(response)
+        end
+
+        def created_status(response)
+          result_status = response["partner_status"].
+            merge(applicant_id: status.applicant_id)
+
+          Fountain::Papi::Applicant::Status.new(result_status)
+        end
+      end
+    end
+  end
+end

data/lib/fountain/papi/applicant/status.rb

@@ -0,0 +1,29 @@
+module Fountain
+  module Papi
+    module Applicant
+      class Status < Dry::Struct
+        transform_keys(&:to_sym)
+
+        Statuses = Types::String.enum("incomplete", "in_progress", "pending_action", "completed", "error")
+
+        attribute :status, Statuses
+        attribute :applicant_id, Types::UUID
+
+        # optional request attributes:
+        attribute? :account_option, Types::Coercible::String.optional
+        attribute? :link_title, Types::Strict::String.optional
+        attribute? :title, Types::Strict::String
+        attribute? :url, Types::Strict::String.optional
+
+        # response attributes:
+        attribute? :category, Types::Strict::String.optional
+        attribute? :color, Types::Strict::String
+        attribute? :display_status, Types::Strict::String
+        attribute? :display_title, Types::Strict::String
+        attribute? :external_id, Types::UUID
+        attribute? :show_redo, Types::Params::Bool.optional
+        attribute? :status_type, Types::Strict::String.optional
+      end
+    end
+  end
+end

data/lib/fountain/papi/client.rb

@@ -0,0 +1,9 @@
+module Fountain
+  module Papi
+    class Client
+      include HTTParty
+
+      format :json
+    end
+  end
+end

data/lib/fountain/papi/config.rb

@@ -0,0 +1,42 @@
+module Fountain
+  module Papi
+    class Config
+      attr_accessor :api_key
+      attr_accessor :partner_id
+      attr_accessor :sandbox
+      attr_accessor :version
+      attr_accessor :base_domain
+
+      def initialize
+        @api_key = nil    # Partner API Key
+        @partner_id = nil # Parter Identifier
+        @sandbox = true   # Default to sandbox
+        @version = 1      # API version
+        @base_domain = "https://partners-sandbox.fountain.com" # Default to sandbox base domain
+      end
+
+      def base_uri
+        "#{base_domain}/v#{version}/partners/#{partner_id}"
+      end
+
+      def headers
+        {
+          "Content-Type" => "application/json",
+          "X-ACCESS-TOKEN" => api_key
+        }
+      end
+    end
+
+    def self.config
+      @config ||= Config.new
+    end
+
+    def self.config=(configuration)
+      @config = configuration
+    end
+
+    def self.configure
+      yield config
+    end
+  end
+end

data/lib/fountain/papi/types.rb

@@ -0,0 +1,10 @@
+module Fountain
+  module Papi
+    module Types
+      include Dry.Types()
+
+      UUID = Strict::String.
+        constrained(format: /^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i)
+    end
+  end
+end

data/lib/fountain/papi/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Fountain
+  module Papi
+    VERSION = "0.1.0"
+  end
+end

data/lib/fountain/papi.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "httparty"
+
+require_relative "papi/config"
+require_relative "papi/types"
+require_relative "papi/version"
+require_relative "papi/client"
+require_relative "papi/applicant/create_status"
+require_relative "papi/applicant/status"
+
+module Fountain
+  module Papi
+    class Error < StandardError; end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: fountain-papi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joey Cody
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Fountain''s Partner API for integrations. See more details: https://partners.fountain.com'
+email:
+- joeydcody@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/fountain/papi.rb
+- lib/fountain/papi/applicant/create_status.rb
+- lib/fountain/papi/applicant/status.rb
+- lib/fountain/papi/client.rb
+- lib/fountain/papi/config.rb
+- lib/fountain/papi/types.rb
+- lib/fountain/papi/version.rb
+homepage: https://github.com/onboardiq/fountain-papi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/onboardiq/fountain-papi
+  source_code_uri: https://github.com/onboardiq/fountain-papi
+  changelog_uri: https://github.com/onboardiq/fountain-papi/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Ruby client for interfacing with Fountain Partners API.
+test_files: []