formi9 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48e1d649b4afd311e7048298d198f30a8fb65efbef72d9afcd3f9738b8ae76fc
+  data.tar.gz: 84738ae67a055f61bf15f3cbae2a5d349e4f101cec14b74c559c7edfa3983548
+SHA512:
+  metadata.gz: 015fb06e3e00222c337a12fd40ffa9e7aa2b13ab395fff6259ba1a411437d91e52dd299e2649403da9a0ac5299dad7d330668e6bb9f19a4575c903e24e70f4bd
+  data.tar.gz: 2d3cb07e3b2c3fb99194edd3ebdc9b80ecaaba85775a74099e49589b26f50309d4e0e9c8607aac19148e83494288ce11a44c7b77b80a71383399458620d4f13b

data/.gitignore

@@ -0,0 +1,27 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.rspec_status
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.ruby-version
+.yardoc
+.rake_tasks~
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*
+.idea/*
+
+# Vim Swap file
+*.swp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at xiaorong.ruby@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in formi9.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ryan Lv
+
+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,95 @@
+# formi9
+
+A Ruby API wrapper for [formi9.com](https://www.formi9.com/FormI9Api/swagger/ui/index) [![Build Status](https://api.travis-ci.com/helloworld1812/formi9.svg?branch=master)](https://travis-ci.com/github/helloworld1812/formi9)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'formi9'
+```
+
+And then execute:
+
+    $ bundle install
+
+You can use an initializer to configure this gem, please put the following code into `config/initializers/formi9_complicance.rb`
+
+```ruby
+Formi9.configure do |config|
+  config.partner_id = 'Your Partner Id'
+  config.username = 'Your username'
+  config.password = 'Your password'
+  # config.b2b_encryption_key = 'key'
+  # config.b2b_encryption_iv = 'iv'
+end
+```
+
+## Usage
+
+## Create a company
+
+```ruby
+Formi9.create_company_with_mou(options)
+```
+
+
+## Create section 1 for employee
+
+```ruby
+Formi9.create_section1(options)
+```
+the response contains
+
+- resultId
+- auto login link for employee to fill the form section 1
+
+
+## Create section 2 for HR
+
+```ruby
+Formi9.create_section2
+```
+
+### Retrieve the status of form
+
+```ruby
+Formi9.case_status(result_id, auto_login_url: true)
+```
+
+### Download the PDF of formi9
+
+```ruby
+Formi9.download_pdf(result_id, {
+  printSignatures: true,
+  printNotes: true,
+  printEverify: true,
+  printDocs: true,
+  printAudit_trail: true 
+})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/helloworld1812/formi9. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/helloworld1812/formi9/blob/master/CODE_OF_CONDUCT.md).
+
+## Reference
+
+1. formi9.com [API documentation](https://www.formi9.com/FormI9Api/swagger/ui/index)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Formi9 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/helloworld1812/formi9/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "formi9"
+
+# 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
+
+# set rails cache
+require 'rails'
+Rails.cache = ActiveSupport::Cache.lookup_store(:memory_store)
+
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/formi9.gemspec

@@ -0,0 +1,39 @@
+require_relative 'lib/formi9/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "formi9"
+  spec.version       = Formi9::VERSION
+  spec.authors       = ["Ryan Lv"]
+  spec.email         = ["tech@workstream.is"]
+
+  spec.summary       = 'A Ruby API wrapper for formi9.com'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/helloworld1812/formi9'
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/helloworld1812/formi9'
+  spec.metadata["changelog_uri"] = 'https://github.com/helloworld1812/formi9/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "> 2.0.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", ">= 3.9.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'rails', ">= 5.0.0"
+  spec.add_runtime_dependency 'faraday_middleware'
+end

data/lib/faraday/raise_formi9_http_exception.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+
+module FaradayMiddleWare
+  class RaiseFormi9HttpException < Faraday::Middleware
+    def initialize(app)
+      super(app)
+    end
+
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response.status.to_i
+        when 400
+          raise Formi9::BadRequest.new(response)
+        when 401
+          raise Formi9::Unauthorized.new(response)
+        when 404
+          raise Formi9::NotFound.new(response)
+        when 500
+          raise Formi9::InternalServerError.new(response)
+        when 502
+          raise Formi9::BadGateway.new(response)
+        when 503
+          raise Formi9::ServiceUnavailable.new(response)
+        when 504
+          raise Formi9::GatewayTimeout.new(response)
+        end
+      end
+    end
+  end
+end

data/lib/formi9/api.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+require File.expand_path('../oauth', __FILE__)
+
+module Formi9
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Formi9.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Connection
+    include Request
+    include OAuth
+  end
+end

data/lib/formi9/client/b2b.rb

@@ -0,0 +1,43 @@
+require "base64"
+require 'openssl'
+require 'faraday'
+
+module Formi9
+  class Client
+    module B2b
+      
+      # options = {
+      #   b2b_username: 'Ryan Lyu'
+      #   company_id: 'workstreamdemo',
+      #   request_id: 'AUniqueId',
+      #   result_id: 'AUniqueId'
+      # }
+      def b2b_direct_link(options)
+        string = "AlliancePartnerID=#{CGI.escape(partner_id)}"
+        string << "&AlliancePartnerLogin=#{CGI.escape(username)}"
+        string << "&AlliancePartnerPassword=#{CGI.escape(password)}"
+        string << "&AlliancePartnerCompanyID=#{CGI.escape(options[:company_id])}"
+        string << "&Target=DirectLink&B2BUserName=#{CGI.escape(options[:b2b_username])}"
+        string << "&RequestID=#{CGI.escape(options[:request_id])}"
+        string << "&ResultID=#{CGI.escape(options[:result_id])}&"
+
+        data = b2b_encrypt(string)
+
+        "https://www.formi9.com/FormI9Verify/FormI9LoginService.aspx?EPID=#{partner_id}&EDATA=#{data}"
+      end
+
+
+      def b2b_encrypt(string)
+        cipher = b2b_encryption_algorithm.new(b2b_encryption_cipher_mode) 
+        cipher.encrypt
+        cipher.key = b2b_encryption_key
+        cipher.iv = b2b_encryption_iv
+        encrypted_string = cipher.update(string)
+        encrypted_string << cipher.final
+
+        base64_string = Base64.strict_encode64(encrypted_string)
+        escaped_data = CGI.escape(base64_string)
+      end
+    end
+  end
+end

data/lib/formi9/client/companies.rb

@@ -0,0 +1,16 @@
+module Formi9
+  class Client
+    # Defines methods related to companies
+    module Companies
+
+      # Get company settings, if there are no settings saved, anempty response if given.
+      def get_company_info(company_id)
+        get("companies/#{company_id}")
+      end
+
+      def create_company_with_mou(options)
+        post('companies/mou', options)
+      end
+    end
+  end
+end

data/lib/formi9/client/eformi9.rb

@@ -0,0 +1,31 @@
+module Formi9
+  class Client
+    # Defines methods related to formi9
+    module Eformi9
+      def create_section1(options={})
+        post('eformi9/section1', options)
+      end
+
+      def update_section1(options={})
+        post('eformi9/section1/edit', options)
+      end
+
+      def create_section2(options={})
+        post('eformi9/section2', options)
+      end
+
+      def case_status(result_id, options={})
+        get("eformi9/status?request.resultId=#{result_id}&request.generateAutoLoginUrl=#{!!options[:auto_login_url]}")
+      end
+
+      def download_pdf(result_id, options={})
+        options = options.with_indifferent_access
+        params = []
+        [:printSignatures, :printNotes, :printEVerify, :printDocs, :printAuditTrail].each do |key|
+          params << "#{key}=true" if options[:key]
+        end
+        get("eformi9/#{result_id}/pdf?#{params.join('&')}")
+      end
+    end
+  end
+end

data/lib/formi9/client/options.rb

@@ -0,0 +1,26 @@
+module Formi9
+  class Client
+    # Defines methods related to Options
+    module Options
+      # Get company option by option name.
+      def get_company_option(company_id, option_name)
+        get("companies/#{company_id}/options/#{option_name}").body
+      end
+
+      # Create or update a option for a specific company
+      def update_company_option(company_id, option_name, payload={})
+        put("companies/#{company_id}/options/#{option_name}", payload)
+      end
+
+      # Get enabled options of specific company
+      def get_company_active_options(company_id)
+        get("companies/#{company_id}/options/active").body
+      end
+
+      # preset options for a specific company.
+      def create_preset2(company_id, preset_group)
+        post("companies/#{company_id}/options/preset2?presetGroup=#{preset_group}")
+      end
+    end
+  end
+end

data/lib/formi9/client/services.rb

@@ -0,0 +1,16 @@
+module Formi9
+  class Client
+    # Defines methods related to Services
+    module Services
+      # Add a service for a company
+      def create_company_service(company_id, service_name)
+        post("companies/#{company_id}/services/#{service_name}")
+      end
+
+      # Get all services of a company.
+      def get_company_services(company_id)
+        get("companies/#{company_id}/services").body
+      end
+    end
+  end
+end

data/lib/formi9/client.rb

@@ -0,0 +1,12 @@
+module Formi9
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+
+    include Formi9::Client::Companies
+    include Formi9::Client::Eformi9
+    include Formi9::Client::B2b
+    include Formi9::Client::Options
+    include Formi9::Client::Services
+  end
+end

data/lib/formi9/configuration.rb

@@ -0,0 +1,109 @@
+require 'faraday'
+require 'openssl'
+require File.expand_path('../version', __FILE__)
+
+module Formi9
+# Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Formi9::API}
+    VALID_OPTIONS_KEYS = [
+      :partner_id, 
+      :username,
+      :password,
+      :adapter,
+      :connection_options,
+      :host,
+      :endpoint,
+      :format,
+      :proxy,
+      :user_agent,
+      :per_page,
+      :timeout,
+      :ssl_verify,
+      :open_timeout,
+      :b2b_encryption_algorithm,
+      :b2b_encryption_cipher_mode,
+      :b2b_encryption_key,
+      :b2b_encryption_iv,
+    ].freeze
+
+    # By default, don't set an access token
+    DEFAULT_ACCESS_TOKEN = nil
+
+    # By default, return 20 resources per page when there is an pagination.
+    DEFAULT_PER_PAGE = 20
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set connection options.
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # Default timeout time is 20 seconds
+    DEFAULT_TIMEOUT = 20
+
+    # By default, the open timeout is 20 seconds.
+    DEFAULT_OPEN_TIMEOUT = 20
+
+    DEFAULT_SSL_VERIFY = false
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = 'https://www.formi9.com/FormI9Api/partner/v2.0/'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    DEFAULT_B2B_ENCRYPTION_ALGORITHM = OpenSSL::Cipher::AES256
+
+    DEFAULT_B2B_ENCRYPTION_CIPHER_MODE = :CBC
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "formi9.com Ruby Gem #{Formi9::VERSION}".freeze
+
+    # An array of valid request/response formats
+    VALID_FORMATS = [:json].freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter            = DEFAULT_ADAPTER
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.proxy              = DEFAULT_PROXY
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.per_page           = DEFAULT_PER_PAGE
+      self.timeout            = DEFAULT_TIMEOUT
+      self.open_timeout       = DEFAULT_OPEN_TIMEOUT
+      self.ssl_verify         = DEFAULT_SSL_VERIFY
+      self.b2b_encryption_algorithm   = DEFAULT_B2B_ENCRYPTION_ALGORITHM
+      self.b2b_encryption_cipher_mode = DEFAULT_B2B_ENCRYPTION_CIPHER_MODE
+    end
+  end
+end

data/lib/formi9/connection.rb

@@ -0,0 +1,35 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module Formi9
+  module Connection
+
+    private
+
+    def connection
+      options = {
+        headers: {
+          "Accept" => "application/#{format}; charset=utf-8",
+          "User-Agent" => Formi9.user_agent,
+        },
+        proxy: proxy,
+        url: endpoint,
+        ssl: { verify: ssl_verify }
+      }.merge(connection_options)
+
+      Faraday::Connection.new(options) do |conn|
+        conn.authorization :Bearer, access_token
+        # https://github.com/lostisland/faraday/issues/417#issuecomment-223413386
+        conn.options[:timeout] = timeout
+        conn.options[:open_timeout] = open_timeout
+        conn.request :json
+
+        conn.use FaradayMiddleWare::RaiseFormi9HttpException
+        conn.request :retry, max: 3, interval: 0.1, exceptions: [Errno::ECONNREFUSED, Faraday::ConnectionFailed]
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end
+

data/lib/formi9/error.rb

@@ -0,0 +1,55 @@
+module Formi9
+  # Part1 API error
+  # Custom error class for rescuing from all formi9.com errors
+    class Error < StandardError
+      attr_reader :http_method, :url, :errors
+
+      def initialize(response)
+        super
+        @response = response.dup
+        @http_method = response.method.to_s
+        @url = response.url
+      end
+
+      def message
+        <<-HEREDOC
+      URL: #{@response.url}
+      method: #{@response.method}
+      response status: #{@response.status}
+      response body: #{@response.response.body}
+        HEREDOC
+      end
+    end
+
+    # Raised when formi9.com returns the HTTP status code 400
+    class BadRequest < Error; end
+
+    # Raised when formi9.com returns the HTTP status code 401
+    class Unauthorized < Error; end
+
+    # Raised when formi9.com returns the HTTP status code 404
+    class NotFound < Error; end
+
+    # Raised when formi9.com returns the HTTP status code 500
+    class InternalServerError < Error; end
+
+    # Raised when formi9.com returns the HTTP status code 502
+    class BadGateway < Error; end
+
+    # Raised when formi9.com returns the HTTP status code 503
+    class ServiceUnavailable < Error; end
+
+    # Raised when formi9.com returns the HTTP status code 504
+    class GatewayTimeout < Error; end
+
+
+  # Part2 Non-API error
+  # Raised when client fails to provide required parameters.
+  class MissingRequiredArgument < StandardError; end
+
+  # Raised when configuration is missing
+  class MissingRequiredConfigurationt < StandardError; end
+
+  # Invalid username or password
+  class CredentialAreInvalid < StandardError; end
+end

data/lib/formi9/oauth.rb

@@ -0,0 +1,36 @@
+require 'active_support/core_ext/string/conversions'
+
+module Formi9
+  module OAuth
+    def access_token
+      token = Rails.cache.read(access_token_cache_key)
+
+      if token.present?
+        return token
+      else
+        reset_token
+        Rails.cache.read(access_token_cache_key)
+      end
+    end
+
+    def reset_token
+      connection = Faraday.new endpoint, :ssl => {:verify => ssl_verify }
+      response = connection.post('login', {id: partner_id, username: username, password: password} )
+      raise CredentialAreInvalid.new('Credentials are missing or invalid.') if response.status != 200
+      body = JSON.parse(response.body)
+      if Rails.cache.read(access_token_cache_key).nil?
+        Rails.cache.write(access_token_cache_key, body['accessToken'], expires_in: token_cache_duration(body['expirationDateUtc']))
+      end
+    end
+
+    def access_token_cache_key
+      Digest::MD5.hexdigest([partner_id, username, password].join)
+    end
+
+    def token_cache_duration(timestamp)
+      max = 6.days.to_i
+      duration = timestamp.to_datetime.utc - Time.now
+      duration > max ? max : duration
+    end
+  end
+end

data/lib/formi9/request.rb

@@ -0,0 +1,40 @@
+require 'base64'
+
+module Formi9
+  # Defines HTTP request methods
+  module Request
+    # HTTP GET request
+    def get(path, options={})
+      request(:get, path, options)
+    end
+
+    # HTTP POST request
+    def post(path, options={})
+      request(:post, path, options)
+    end
+
+    # HTTP PUT request
+    def put(path, options={})
+      request(:put, path, options)
+    end
+
+    # HTTP DELETE request
+    def delete(path, options={})
+      request(:delete, path, options)
+    end
+    
+    def request(method, path, options)
+      response = connection.send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(URI.encode(path), options)
+        when :post, :put
+          request.path = URI.encode(path)
+          request.body = options
+        end
+      end
+
+      response
+    end
+  end
+end

data/lib/formi9/version.rb

@@ -0,0 +1,3 @@
+module Formi9
+  VERSION = "0.1.7"
+end

data/lib/formi9.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../formi9/error', __FILE__)
+require File.expand_path('../formi9/configuration', __FILE__)
+require File.expand_path('../formi9/api', __FILE__)
+require File.expand_path('../formi9/client', __FILE__)
+
+module Formi9
+  extend Configuration
+
+  # Alias for Formi9::Client.new
+  #
+  # @return [Formi9::Client]
+  def self.client(options={})
+    Formi9::Client.new(options)
+  end
+
+  # Delegate to Formi9::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Formi9::Client
+  def self.respond_to?(method, include_all=false)
+    return client.respond_to?(method, include_all) || super
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: formi9
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Ryan Lv
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.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'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby API wrapper for formi9.com
+email:
+- tech@workstream.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- formi9.gemspec
+- lib/faraday/raise_formi9_http_exception.rb
+- lib/formi9.rb
+- lib/formi9/api.rb
+- lib/formi9/client.rb
+- lib/formi9/client/b2b.rb
+- lib/formi9/client/companies.rb
+- lib/formi9/client/eformi9.rb
+- lib/formi9/client/options.rb
+- lib/formi9/client/services.rb
+- lib/formi9/configuration.rb
+- lib/formi9/connection.rb
+- lib/formi9/error.rb
+- lib/formi9/oauth.rb
+- lib/formi9/request.rb
+- lib/formi9/version.rb
+homepage: https://github.com/helloworld1812/formi9
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/helloworld1812/formi9
+  source_code_uri: https://github.com/helloworld1812/formi9
+  changelog_uri: https://github.com/helloworld1812/formi9/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: A Ruby API wrapper for formi9.com
+test_files: []