giact_verification 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f260ef742040e97d6e4cf6b5276e08b6c2b71aaa99023b87c2b03e538bf3ab5d
+  data.tar.gz: 9b49d4cf89ae5b72afb603cb2c8a7e7c8f8955aea95b40a7aae7bb9bd97919e1
+SHA512:
+  metadata.gz: 4ac0ae48e5a1ad002dad65b1c002893b9225222e0260d7b9c709ac99b9b34f6b7c7c9f354c67610b62eb7e1edb1833d6c617364f4cc19f13dc87cfb21cc3d763
+  data.tar.gz: 8b65fe3b44dc10411013f7337a924a1b7bf4d7207bf40b185422bc5332b0ae254ade1eab29002b83683fefb691deb025931094723b0ed8c5ac14426c56b39629

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

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 georgewambold@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in giact_verification.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 George Wambold
+
+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,143 @@
+# GiactVerification
+[![Build Status](https://travis-ci.org/georgewambold/giact_verification.svg?branch=master)](https://travis-ci.org/georgewambold/giact_verification)
+
+**WARNING** This gem only works for **Version 5.8.x** of GIACT's API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'giact_verification'
+```
+
+Or install it yourself as:
+
+    $ gem install giact_verification
+
+## Configuration
+To set up your API keys, use the configuration helper like this:
+
+```ruby
+GiactVerification.configure do |config|
+  config.api_username = 'foo'
+  config.api_password = 'bar'
+  config.giact_endpoint = :production
+end
+```
+`giact_endpoint` options are `:production`, `:sandbox` and `:stubbed`. 
+- `:production` Will send requests to their production endpoint
+- `:sandbox` Will send requests to their sandbox endpoint
+- `:stubbed` Will stub requests locally (no network request) and return [one of a series of set responses](#stubbed_responses) based on the last name passed.
+
+## gAuthenticate
+`GiactVerification::Authenticate` takes two arguements: a [valid customer](#valid_customer) and a [valid check](#valid_check).
+
+```ruby
+GiactVerification::Authenticate.call(
+  customer: {
+    first_name: "Kent"
+    last_name: "Beck"
+    address_line1: "123 Test Dr."
+    city: "Abbotsford"
+    state: "MA"
+    zip_code: "54321"
+    phone_number: "4127982231"
+    tax_id: 9876543210
+    date_of_birth: Date.parse('Mar 6 1961')
+  },
+  check: {
+    routing_number: 123456789
+    account_number: 00012300089
+  }
+)
+```
+
+`GiactVerification::Authenticate.call()` will return a `GiactVerification::Response` object which has the following API:
+
+```ruby
+response = GiactVerification::Authenticate.call(customer: some_customer, check: some_check)
+
+response.raw_request
+#=> The XML string sent to GIACT
+
+response.raw_response
+#=> The XML string returned from GIACT
+
+response.success?
+#=> A boolean value indicating if the request was successful
+# `true` indicates GIACT returned valid XML 
+# `false` indicates there was some kind of error. You can then check the raw_response for details.
+
+response.parsed_response
+#=> Hash of the data GIACT returned with keys: 
+# If the response was successful the hash will be populated like this:
+ {
+  item_reference_id: String,
+  created_date: DateTime,
+  verification_response: String,
+  account_response_code: String,
+  bank_name: String,
+  account_added_date: DateTime,
+  account_last_updated_date: DateTime,
+  account_closed_date: DateTime,
+  funds_confirmation_result: String,
+  customer_response_code: String
+ }
+# If the response fails, the hash will be blank.
+```
+## <a name="valid_customer">Valid Customer Attributes</a>
+The following are valid customer fields. Please note that the required fields noted below only represent the bare minimum. Some GIACT services will require additional fields.
+
+* **name_prefix:** 1-4 characters
+* **first_name:** 2-40 characters *REQUIRED*
+* **middle_name:** 1-40 characters
+* **last_name:** 2-40 characters *REQUIRED*
+* **name_suffix:** 1-4 characters
+* **address_line1:** 2-40 characters *REQUIRED*
+* **address_line2:** 1-40 characters
+* **city:** 2-25 characters *REQUIRED*
+* **state:** 2 characters, valid US state or Candian province *REQUIRED*
+* **zip_code:** 5 or 7 or 10 characters, valid US or Canadian postal code *REQUIRED*
+* **country:** Either 'US' or 'CA', defaults to 'US'
+* **phone_number:** 10 numeric characters, can't start with 0, no dashes
+* **tax_id:** Social security number or business ein *REQUIRED*
+* **date_of_birth:** Date, DateTime or an object that responds to :strftime *REQUIRED*
+* **drivers_license_number:** 1-28 numeric characters
+* **drivers_license_state:** 2 characters, valid US state or Candian province
+* **email_address:** 1-100 characters
+* **current_ip_address:** 1-15 characters
+* **mobile_consent_record_id:** Numeric, unspecified length
+* **alternative_id_type:** Must be one of the following: 'UsaMilitaryId', 'UsaStateId', 'PassportUsa', 'PassportForeign', 'UsaResidentAlienId', 'StudentId', 'TribalId', 'DlCanada', 'DlMexico', or 'OtherForeignId'
+* **alternative_id_issuer:** 1-50 characters
+* **alternative_id_number:** 1-50 numeric characters
+* **domain:** 1-100 characters
+
+## <a name="valid_check">Valid Check Attributes</a>
+The following are valid check fields:
+
+* **routing_number:** 9 numeric characters *REQUIRED*
+* **account_number:** 4-17 numeric characters *REQUIRED*
+* **check_number:** numeric, unspecified length
+* **check_amount:** float or float-like string (eg. '100.01')
+* **account_type:** one of the following: 'Checking', 'Savings' or 'Other'
+
+## <a name="stubbed_responses">Stubbed Responses</a>
+Using `config.giact_endpoint = :stubbed` will return a set response based on the last name passed in. These responses were built to be used in acceptance/integration tests. The built in responses were copied from the sandbox API and are as follows:
+1. `last_name: GiactError`    Will respond with an errored response (mimicking an error on GIACT's server)
+2. `last_name: GiactDeclined` Will respond with a declined response
+3. ANY OTHER LAST NAME        Will return a passed response
+
+The response is stubbed at a HTTP level, you'll still need to pass valid customer and check parameters to pass local validation.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/georgewambold/giact_verification. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "giact_verification"
+
+# 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(__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/giact_verification.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'giact_verification/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "giact_verification"
+  spec.version       = GiactVerification::VERSION
+  spec.authors       = ["George Wambold"]
+  spec.email         = ["georgewambold@gmail.com"]
+
+  spec.summary       = "A wrapper for GIACT's Verification Services that cleans up their SOAP API"
+  spec.homepage      = "https://github.com/georgewambold/giact_verification"
+  spec.license       = "MIT"
+
+#  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+#  # to allow pushing to a single host or delete this section to allow pushing to any host.
+#  if spec.respond_to?(:metadata)
+#    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+#  else
+#    raise "RubyGems 2.0 or newer is required to protect against " \
+#      "public gem pushes."
+#  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_runtime_dependency "dry-validation", "~> 0.11.1"
+  spec.add_runtime_dependency "nori", "~> 2.6.0"
+  spec.add_runtime_dependency "nokogiri", "~> 1.8.2"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3.0"
+  spec.add_development_dependency "webmock", "~> 3.3.0"
+  spec.add_development_dependency "rspec", "~> 3.7.0"
+  spec.add_development_dependency "pry", "~> 0.11.3"
+  spec.add_development_dependency "sinatra", "~> 2.0.0"
+end

data/lib/giact_verification.rb

@@ -0,0 +1,67 @@
+module GiactVerification
+
+  def self.configuration
+    @configuration ||= GiactVerification::Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  # This is class level method delegation -- Really unpleasant.
+  class << self
+    require 'forwardable'
+    extend ::Forwardable
+
+
+    def_delegators :configuration,
+      :servicing_country?,
+      :servicing?,
+      :accepts_id_type?,
+      :valid_account_type?,
+      :giact_endpoint
+  end
+
+  def self.ready_for_request?
+    if configuration.invalid?
+      raise ConfigurationError
+    else
+      true
+    end
+  end
+
+  def self.root
+    File.dirname __dir__
+  end
+
+  def self.config_directory
+    File.join(root, 'lib', 'giact_verification', 'etc')
+  end
+
+  def self.inquiry_template_directory
+    File.join(root, 'lib', 'giact_verification', 'templates', 'inquiry.xml.erb')
+  end
+end
+
+require "giact_verification/authenticate"
+require "giact_verification/configuration"
+require "giact_verification/decorators/decorate_hash"
+require "giact_verification/decorators/giact_soap_decorator"
+require "giact_verification/extract_inquiry_result"
+require "giact_verification/errors"
+require "giact_verification/inquiry_template_renderer"
+require "giact_verification/models/check"
+require "giact_verification/models/customer"
+require "giact_verification/models/giact_xml"
+require "giact_verification/requests/request_coordinator"
+require "giact_verification/requests/requester_factory"
+require "giact_verification/requests/production_requester"
+require "giact_verification/requests/sandbox_requester"
+require "giact_verification/requests/stubbed_requester"
+require "giact_verification/response"
+require "giact_verification/response_parser"
+require "giact_verification/version"
+require "giact_verification/validators/customer_validator"
+require "giact_verification/validators/check_validator"
+require "giact_verification/validators/giact_xml_validator"
+require "giact_verification/xml_to_hash"

data/lib/giact_verification/authenticate.rb

@@ -0,0 +1,44 @@
+module GiactVerification
+  class Authenticate
+
+    def self.call(args)
+      new(args).call
+    end
+
+    def initialize(args)
+      GiactVerification.ready_for_request?
+
+      @customer = GiactVerification::Customer.new(attributes: args.fetch(:customer, {}))
+      @check    = GiactVerification::Check.new(attributes: args.fetch(:check, {}))
+    end
+
+    def call
+      if customer.invalid? || check.invalid?
+        raise GiactVerification::ArgumentError, param_errors
+      end
+
+      RequestCoordinator.call(body: request_body)
+    end
+
+    private
+    attr_reader :customer, :check
+
+    def request_body
+      @request_body ||= GiactVerification::InquiryTemplateRenderer.call(substitutions: substitutions)
+    end
+
+    def substitutions
+      {
+        g_authenticate_enabled: true,
+        check: check.decorate_for_xml,
+        customer: customer.decorate_for_xml,
+      }
+    end
+
+    def param_errors
+      (customer.errors.merge(check.errors)).map do |k,v|
+        "#{k}: #{v}\n"
+      end.join('')
+    end
+  end
+end