microbilt 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88ce267b37e49604936cd217768fc20c04abd3cb
+  data.tar.gz: f0ad3812cfc5ffa60b6424c98992de6e0db3b449
+SHA512:
+  metadata.gz: 21f54754661b7ff834109fb1522f6ac77a4b40ffb503fd6ee85355f083d45fc44f873de84a647cf37ffb44dae8375d5479c8f822312deb406278205112debe52
+  data.tar.gz: 0dc52c3f1d23a97cef84baf42740b7d3dfa255106c65a89f2363b40920286f0c2e5732043a3cda61c2a5a6941ff3eb28fb0abaf5fd0f2ace0cea2f6c858206ff

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/spec/reports
+
+.env.test
+.env.development
+.env.production
+
+.byebug_history

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,26 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+if `uname` =~ /Darwin/
+  if !!system("lsof -i:23053", out: '/dev/null')
+    puts "Growl notifications enabled"
+    notification :gntp, app_name: "", activate: 'com.googlecode.iTerm2'
+  else
+    puts "Native macOS notifications enabled"
+    notification :terminal_notifier, app_name: "", activate: 'com.googlecode.iTerm2' if `uname` =~ /Darwin/
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Carl Mercier
+
+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,8 @@
+# Microbilt
+
+A simple library to interact with the Microbilt IBV web service.
+
+## 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 "microbilt"
+
+# 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/lib/microbilt.rb

@@ -0,0 +1,20 @@
+require 'microbilt/version'
+require 'microbilt/customer'
+require 'microbilt/requests'
+
+module Microbilt
+  autoload :Configuration, 'microbilt/configuration'
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/microbilt/configuration.rb

@@ -0,0 +1,40 @@
+module Microbilt
+  class Configuration
+    PROD_SERVER_URL   = 'https://creditserver.microbilt.com'
+    TEST_SERVER_URL   = 'https://sdkstage.microbilt.com'
+
+    CREATE_FORM_URI   = '/WebServices/IBV/Home/CreateForm'
+    GET_DATA_URI      = '/WebServices/IBV/Home/GetData'
+    GET_HTML_DATA_URI = '/WebServices/gethtml/gethtml.aspx'
+    ADD_CUSTOMER_URI  = '/WebServices/IBV/Home/AddCustomer'
+
+    CONTENT_TYPE      = 'application/x-www-form-urlencoded'
+
+    attr_accessor :client_id, :client_password, :format, :server
+
+    def initialize
+      @format = :json
+      @server = :test
+    end
+
+    def to_params
+      validate_credentials!
+
+      {
+        'MemberId' => client_id,
+        'MemberPwd' => client_password
+      }
+    end
+
+    def server_url
+      server == :production ? PROD_SERVER_URL : TEST_SERVER_URL
+    end
+
+    protected
+
+    def validate_credentials!
+      raise ArgumentError.new("Invalid Client ID: #{client_id}") if client_id.to_s.empty?
+      raise ArgumentError.new("Invalid Client Password: #{client_password}") if client_id.to_s.empty?
+    end
+  end
+end

data/lib/microbilt/customer.rb

@@ -0,0 +1,104 @@
+module Microbilt
+  class Customer
+
+    attr_accessor :first_name, :last_name, :sin, :date_of_birth, :address1, :address2,
+                  :city, :state, :zip_code, :country, :home_phone, :mobile_phone,
+                  :work_phone, :email, :bank_transit, :bank_account, :direct_deposit_amount,
+                  :account_type, :direct_deposit_pay_cycle, :completion_email
+
+    VALID_ACCOUNT_TYPES = { checking: 100, savings: 101, cd: 102, money_market: 103,
+                            credit_card: 200, line_of_credit: 201,
+                            taxable_investment: 300, tax_deferred_investment: 301,
+                            mortgage: 400, loan: 401,
+                            annuity: 500, whole_life: 501,
+                            rewards: 600, email: 650, biller: 675,
+                            term_insurance: 701, asset: 908, liability: 955, other: 999
+                          }
+
+    def initialize(options = nil)
+      options.keys.each do |k|
+        self.send("#{k}=", options[k])
+      end if options
+    end
+
+    def to_params
+      {
+        'Customer.FirstName' => first_name,
+        'Customer.LastName' => last_name,
+        'Customer.SSN' => sin,
+        'Customer.DOB' => formatted_date(date_of_birth),
+        'Customer.Address' => formatted_address,
+        'Customer.City' => city,
+        'Customer.State' => state,
+        'Customer.ZIP' => zip_code,
+        'Customer.Country' => formatted_country,
+        'Customer.Phone' => home_phone,
+        'Customer.WorkPhone' => work_phone,
+        'Customer.CellPhone' => mobile_phone,
+        'Customer.Email' => email,
+        'Customer.ABAnumber' => bank_transit,
+        'Customer.AccountNumber' => bank_account,
+        'Customer.DirectDepositAmount' => direct_deposit_amount,
+        'Customer.DirectDepositPayCycle' => formatted_direct_deposit_pay_cycle,
+        'Customer.CompletionEmail' => completion_email,
+        'Customer.AccountType' => formatted_account_type
+      }
+    end
+
+    private
+
+    def formatted_date(d)
+      d.strftime('%m%d%Y')
+    end
+
+    def formatted_address
+      address = address1
+      address += "\n" + address2 unless address2.to_s.empty?
+      address
+    end
+
+    def microbilt_address(loan_application)
+      address = loan_application.address1
+      address += "\n" + loan_application.address2 if loan_application.address2.present?
+      address
+    end
+
+    def formatted_country
+      case country.upcase
+      when 'CA'
+        'CAN'
+      when 'US'
+        'USA'
+      else
+        raise ArgumentError.new "Unknown country '#{country}'"
+      end
+    end
+
+    def formatted_direct_deposit_pay_cycle
+      case direct_deposit_pay_cycle.to_s
+      when 'weekly'
+        'Every week'
+      when 'biweekly'
+        'Every other week'
+      when 'twicemonthly'
+        'Two times a month'
+      when 'monthly'
+        'Once a month'
+      else
+        direct_deposit_pay_cycle.to_s
+      end
+    end
+
+    def formatted_account_type
+      account_type_code = VALID_ACCOUNT_TYPES[account_type]
+
+      if !account_type_code.nil?
+        account_type_code
+      elsif !account_type.nil?
+        raise ArgumentError.new "Invalid account type: #{account_type}"
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/microbilt/requests.rb

@@ -0,0 +1,8 @@
+module Microbilt
+  module Requests
+  end
+end
+
+require 'microbilt/requests/helpers'
+require 'microbilt/requests/create_form'
+

data/lib/microbilt/requests/create_form.rb

@@ -0,0 +1,118 @@
+module Microbilt
+  module Requests
+    class CreateForm
+      include Microbilt::Requests::Helpers
+
+      attr_accessor :callback_url, :final_url
+      attr_reader   :contact_by, :do_not_request_phones, :callback_type
+
+      def initialize(options = nil)
+        options.keys.each do |k|
+          self.send("#{k}=", options[k])
+        end if options
+
+        do_not_request_phones = false if do_not_request_phones.nil?
+      end
+
+      def to_params
+        {
+          'CallbackUrl' => callback_url,
+          'CallbackType' => callback_type.to_s,
+          'FinalURL' => final_url,
+          'ContactBy' => contact_by.to_s.upcase,
+          'DoNotRequestPhones' => do_not_request_phones.to_s
+        }
+      end
+
+      def call(customer)
+        response = http_connection.post do |req|
+          req.url Microbilt::Configuration::CREATE_FORM_URI
+          req.headers['Content-Type'] = Microbilt::Configuration::CONTENT_TYPE
+          req.params = all_params(customer)
+        end
+
+        handle_response(response)
+      end
+
+      private
+
+      def handle_response(response)
+        output = output_template(response)
+
+        if output[:status] == :ok
+          token = parse_token(response.body)
+          output[:token] = token
+          output[:add_customer_form_url] = add_customer_url(token)
+          output[:get_data_url] = get_data_url(token)
+          output[:get_html_data_url] = get_html_data_url(token)
+        end
+
+        output
+      end
+
+      def output_template(response)
+        status = response.status.to_i
+
+        if status.between?(200, 299)
+          status = :ok
+        elsif status.between?(300, 399)
+          status = :redirect
+        elsif status.between?(400, 599)
+          status = :error
+        end
+
+        {
+          success: status == :ok,
+          status: status,
+          http_response: {
+            status: response.status,
+            body: response.body
+          }
+        }
+      end
+
+      def parse_token(response_body)
+        response_body.match(/{(.*)}/)[1]
+      end
+
+      def add_customer_url(token)
+        "#{Microbilt.configuration.server_url}#{Microbilt::Configuration::ADD_CUSTOMER_URI}?reference=#{token}"
+      end
+
+      def get_data_url(token)
+        "#{Microbilt.configuration.server_url}#{Microbilt::Configuration::GET_DATA_URI}?reference=#{token}"
+      end
+
+      def get_html_data_url(token)
+        "#{Microbilt.configuration.server_url}#{Microbilt::Configuration::GET_HTML_DATA_URI}?guid=#{token}"
+      end
+
+      def all_params(customer)
+        to_params.merge(Microbilt.configuration.to_params).merge(customer.to_params)
+      end
+
+      # Setters
+      def contact_by=(value)
+        raise ArgumentError.new("Invalid value: #{value}") unless
+           %i(sms email both neither).include?(value.to_sym)
+
+        @contact_by = value.to_sym
+      end
+
+      def do_not_request_phones=(value)
+        raise ArgumentError.new("Invalid value: #{value}") unless
+          value.is_a?(TrueClass) || value.is_a?(Falseclass)
+
+        @do_not_request_phones = value
+      end
+
+      def callback_type=(value)
+        raise ArgumentError.new("Invalid value: #{value}") unless
+          %i(json xml).include?(value.to_sym)
+
+        @callback_type = value.to_sym
+      end
+
+    end
+  end
+end

data/lib/microbilt/requests/helpers.rb

@@ -0,0 +1,11 @@
+require 'faraday'
+
+module Microbilt
+  module Requests
+    module Helpers
+      def http_connection
+        Faraday.new(url: Microbilt.configuration.server_url)
+      end
+    end
+  end
+end

data/lib/microbilt/version.rb

@@ -0,0 +1,3 @@
+module Microbilt
+  VERSION = "0.2.0"
+end

data/microbilt.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'microbilt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "microbilt"
+  spec.version       = Microbilt::VERSION
+  spec.authors       = ["Carl Mercier"]
+  spec.email         = ["foss@carlmercier.com"]
+
+  spec.summary       = %q{Simple library to interface with Microbilt's IBV API}
+  spec.description   = %q{Simple library to interface with Microbilt's IBV API}
+  spec.homepage      = "http://www.github.com/cmer/microbilt"
+  spec.license       = "MIT"
+
+  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_dependency "faraday", "~> 0.12.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.13"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7.3"
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "dotenv"
+
+  if RUBY_PLATFORM =~ /darwin/
+    spec.add_development_dependency 'ruby_gntp', "~> 0.3.4"
+    spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6.1'
+  end
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: microbilt
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Carl Mercier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: faker
+  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: factory_girl
+  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: dotenv
+  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: ruby_gntp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+description: Simple library to interface with Microbilt's IBV API
+email:
+- foss@carlmercier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/microbilt.rb
+- lib/microbilt/configuration.rb
+- lib/microbilt/customer.rb
+- lib/microbilt/requests.rb
+- lib/microbilt/requests/create_form.rb
+- lib/microbilt/requests/helpers.rb
+- lib/microbilt/version.rb
+- microbilt.gemspec
+homepage: http://www.github.com/cmer/microbilt
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Simple library to interface with Microbilt's IBV API
+test_files: []