credova 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7084ae696e6c5359945ab0f2e256dd30c0684132cda5fe184eebb2746563f3f1
+  data.tar.gz: 2c748b2ab2ce6e593d9ee011261e09c43e0599ff427afcf30e3c03c69e686662
+SHA512:
+  metadata.gz: bcf552f21d1e0ca8b1e9d5d2896b39dd2302894d568bccf0cc4afe3104872286208d1f89ce6ef7b0aa04194e73417aa88b205efa98590a03d6cc57f5d3c17ab1
+  data.tar.gz: 0c12e3b8e95c5ac2a9bb80bfacf01e0735c06a08feacdd1f9f2bc32db8451916fbe63a01513d1de5f5252164e9a470d51db3770fe43b455ec2e0bd2810e905dd

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.17.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2018 Jeffrey Dill
+
+MIT License
+
+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,45 @@
+# Credova
+
+Credova API Ruby library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'credova'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install credova
+
+## Usage
+
+### Documentation
+
+The full documentation is located here: http://www.rubydoc.info/gems/credova
+
+### Sandbox Mode
+
+If you want to use the Credova 'sandbox' API, set the `Credova.sandbox` flag to `true`.
+
+```ruby
+Credova.sandbox = true
+# Any API calls will now use the sandbox API.
+```
+
+**NOTE**: Credova currently issues different API keys for production and sandbox environments,
+which means your production key **will not** work in the sandbox and vice versa.
+
+## Contributing
+
+1. Fork it ( https://github.com/ammoready/credova/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+task :default => :spec
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Generate API docs'
+YARD::Rake::YardocTask.new(:docs) do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+namespace :docs do
+  desc 'Run the docs server'
+  task :server do
+    $stdout.puts `yard server --reload --bind 0.0.0.0`
+  end
+end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "credova"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle install

data/credova.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'credova/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "credova"
+  spec.version       = Credova::VERSION
+  spec.authors       = ["Jeffrey Dill"]
+  spec.email         = ["jeffdill2@gmail.com"]
+  spec.summary       = %q{Credova API Ruby library.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/ammoready/credova"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "simplecov", "~> 0.9"
+  spec.add_development_dependency "webmock", "~> 1.20"
+  spec.add_development_dependency "yard", "~> 0.9.12"
+end

data/lib/credova.rb

@@ -0,0 +1,23 @@
+require 'credova/base'
+require 'credova/version'
+
+require 'credova/api'
+require 'credova/application'
+require 'credova/client'
+require 'credova/error'
+require 'credova/ffl'
+require 'credova/payments'
+require 'credova/response'
+require 'credova/retailer'
+
+module Credova
+
+  class << self
+    attr_accessor :sandbox
+  end
+
+  def self.sandbox?
+    !!@sandbox
+  end
+
+end

data/lib/credova/api.rb

@@ -0,0 +1,80 @@
+require 'net/http'
+
+module Credova
+  module API
+
+    DEVELOPMENT_URL = 'https://staging-lending-api.credova.com'.freeze
+    PRODUCTION_URL = 'https://lending-api.credova.com'.freeze
+    API_VERSION = 'v2'.freeze
+
+    USER_AGENT = "CredovaRubyGem/#{Credova::VERSION}".freeze
+
+    # def self.get_request(*args)
+    #   get_request(*args)
+    # end
+    #
+    # def self.post_request(*args)
+    #   post_request(*args)
+    # end
+
+    # private
+
+    def get_request(endpoint, headers = {})
+      request = Net::HTTP::Get.new(request_url(endpoint))
+
+      process_request(request, {}, headers)
+    end
+
+    def post_request(endpoint, data = {}, headers = {})
+      request = Net::HTTP::Post.new(request_url(endpoint))
+
+      process_request(request, data, headers)
+    end
+
+    private
+
+    def process_request(request, data, headers)
+      set_request_headers(request, headers)
+
+      uri = URI(request.path)
+      request.body = data.is_a?(Hash) ? data.to_json : data
+
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+
+      Credova::Response.new(response)
+    end
+
+    def set_request_headers(request, headers)
+      request['User-Agent'] = USER_AGENT
+
+      headers.each { |header, value| request[header] = value }
+    end
+
+    def auth_header(token)
+      { 'Authorization' => ['Bearer', token].join(' ') }
+    end
+
+    def content_type_header(type)
+      { 'Content-Type' => type }
+    end
+
+    def request_url(endpoint)
+      [
+        (Credova.sandbox? ? DEVELOPMENT_URL : PRODUCTION_URL),
+        API_VERSION,
+        endpoint,
+      ].join('/')
+    end
+
+    def extract_file_extension(ffl_document_url)
+      metadata_raw  = Net::HTTP.get(URI.parse("#{ffl_document_url}/metadata"))
+      metadata_json = JSON.parse(metadata_raw)
+      file_name     = metadata_json['filename']
+
+      file_name[(file_name.rindex('.') + 1)..-1]
+    end
+
+  end
+end

data/lib/credova/application.rb

@@ -0,0 +1,78 @@
+require 'credova/api'
+
+module Credova
+  class Application < Base
+
+    include Credova::API
+
+    MINIMUM_FINANCING_AMOUNT = 300_00.freeze
+    REQUIRED_CREATE_ATTRS = %i( first_name last_name date_of_birth mobile_phone email )
+    REQUIRED_DELIVERY_ATTRS = %i( method address city state zip carrier tracking_number )
+    ENDPOINTS = {
+      check_status_by_public_id:    "applications/%s/status".freeze,
+      check_status_by_phone_number: "applications/phone/%s/status".freeze,
+      create:                       "applications".freeze,
+      set_delivery_information:     "applications/%s/deliveryinformation".freeze,
+      request_return:               "applications/%s/requestreturn".freeze,
+      upload_invoice:               "applications/%s/uploadinvoice".freeze,
+    }
+
+    def initialize(client)
+      @client = client
+    end
+
+    def create(callback_url, options = {})
+      requires!(options, REQUIRED_CREATE_ATTRS)
+
+      endpoint = ENDPOINTS[:create]
+      headers = [
+        *auth_header(@client.access_token),
+        *content_type_header('application/json'),
+      ].to_h
+
+      post_request(endpoint, options, headers)
+    end
+
+    def check_status_by_public_id(public_id)
+      endpoint = ENDPOINTS[:check_status_by_public_id] % public_id
+
+      get_request(endpoint, auth_header(@client.access_token))
+    end
+
+    def check_status_by_phone_number(phone)
+      endpoint = ENDPOINTS[:check_status_by_phone_number] % phone
+
+      get_request(endpoint, auth_header(@client.access_token))
+    end
+
+    def set_delivery_information(public_id, options = {})
+      requires!(options, REQUIRED_DELIVERY_ATTRS)
+
+      endpoint = ENDPOINTS[:set_delivery_information] % public_id
+      headers = [
+        *auth_header(@client.access_token),
+        *content_type_header('application/json'),
+      ].to_h
+
+      post_request(endpoint, options, headers)
+    end
+
+    def request_return(public_id)
+      endpoint = ENDPOINTS[:request_return] % public_id
+
+      post_request(endpoint, {}, auth_header(@client.access_token))
+    end
+
+    def upload_invoice(public_id, invoice_url)
+      endpoint = ENDPOINTS[:upload_invoice] % public_id
+      data     = { form_data: ['file=@', invoice_url, '; type=application/', extract_file_extension(invoice_url)].join }
+      headers  = [
+        *auth_header(@client.access_token),
+        *content_type_header('multipart/form-data'),
+      ].to_h
+
+      post_request(endpoint, data, headers)
+    end
+
+  end
+end

data/lib/credova/base.rb

@@ -0,0 +1,24 @@
+module Credova
+  class Base
+
+    protected
+
+    def requires!(*args)
+      self.class.requires!(*args)
+    end
+
+    def self.requires!(hash, *params)
+      params.each do |param|
+        if param.is_a?(Array)
+          raise ArgumentError.new("Missing required parameter: #{param.first}") unless hash.has_key?(param.first)
+
+          valid_options = param[1..-1]
+          raise ArgumentError.new("Parameter: #{param.first} must be one of: #{valid_options.join(', ')}") unless valid_options.include?(hash[param.first])
+        else
+          raise ArgumentError.new("Missing required parameter: #{param}") unless hash.has_key?(param)
+        end
+      end
+    end
+
+  end
+end

data/lib/credova/client.rb

@@ -0,0 +1,45 @@
+require 'credova/api'
+require 'credova/application'
+require 'credova/ffl'
+require 'credova/retailer'
+
+module Credova
+  class Client < Base
+
+    include Credova::API
+
+    attr_accessor :access_token
+
+    def initialize(options = {})
+      requires!(options, :username, :password)
+      @options = options
+
+      authenticate!
+    end
+
+    def application
+      @application ||= Credova::Application.new(self)
+    end
+
+    def ffl
+      @ffl ||= Credova::FFL.new(self)
+    end
+
+    def retailer
+      @retailer ||= Credova::Retailer.new(self)
+    end
+
+    private
+
+    def authenticate!
+      response = post_request(
+        'token',
+        ['username=', @options[:username], '&password=', @options[:password]].join,
+        content_type_header('application/x-www-form-urlencoded')
+      )
+
+      self.access_token = response.fetch(:jwt)
+    end
+
+  end
+end

data/lib/credova/error.rb

@@ -0,0 +1,11 @@
+module Credova
+  class Error < StandardError
+
+    class NoContent < Credova::Error; end
+    class NotAuthorized < Credova::Error; end
+    class NotFound < Credova::Error; end
+    class RequestError < Credova::Error; end
+    class TimeoutError < Credova::Error; end
+
+  end
+end

data/lib/credova/ffl.rb

@@ -0,0 +1,57 @@
+require 'credova/api'
+
+module Credova
+  class FFL < Base
+
+    include Credova::API
+
+    REQUIRED_CREATE_ATTRS = %i( license_number expiration address_one city state zip )
+    ENDPOINTS = {
+      create:          "federallicense".freeze,
+      upload_document: "federallicense/%s/uploadfile".freeze,
+    }
+
+    def initialize(client)
+      @client = client
+    end
+
+    def create(options = {})
+      requires!(options, REQUIRED_CREATE_ATTRS)
+
+      endpoint = ENDPOINTS[:create]
+      data = format_data_for_create(options)
+      headers  = [
+        *auth_header(@client.access_token),
+        *content_type_header('application/json'),
+      ].to_h
+
+      post_request(endpoint, data, headers)
+    end
+
+    def upload_document(ffl_public_id, ffl_document_url)
+      endpoint = ENDPOINTS[:upload_document] % ffl_public_id
+      data     = { form_data: ['file=@', ffl_document_url, '; type=application/', extract_file_extension(ffl_document_url)].join }
+      headers  = [
+        *auth_header(@client.access_token),
+        *content_type_header('multipart/form-data'),
+      ].to_h
+
+      post_request(endpoint, data, headers)
+    end
+
+    private
+
+    def format_data_for_create(data)
+      {
+        licenseNumber: data[:license_number],
+        expiration:    data[:expiration].strftime('%Y/%m/%d'),
+        address:       data[:address_one],
+        address2:      data[:address_two],
+        city:          data[:city],
+        state:         data[:state],
+        zip:           data[:zip],
+      }
+    end
+
+  end
+end

data/lib/credova/payments.rb

@@ -0,0 +1,33 @@
+require 'credova/api'
+
+module Credova
+  module Payments
+
+    extend Credova::API
+
+    ENDPOINTS = {
+      lowest_payment_option:  "calculator/store/%s/amount/%s/lowestpaymentoption".freeze,
+      lender_payment_options: "calculator/lender/%s/amount/%s".freeze,
+      store_payment_options:  "calculator/store/%s/amount/%s".freeze,
+    }
+
+    def self.lowest_payment_option(store_code, amount_to_finance)
+      endpoint = ENDPOINTS[:lowest_payment_option] % [store_code, amount_to_finance]
+
+      post_request(endpoint)
+    end
+
+    def self.lender_payment_options(lender_code, amount_to_finance)
+      endpoint = ENDPOINTS[:lender_payment_options] % [lender_code, amount_to_finance]
+
+      post_request(endpoint)
+    end
+
+    def self.store_payment_options(store_code, amount_to_finance)
+      endpoint = ENDPOINTS[:store_payment_options] % [store_code, amount_to_finance]
+
+      post_request(endpoint)
+    end
+
+  end
+end

data/lib/credova/response.rb

@@ -0,0 +1,48 @@
+module Credova
+  class Response
+
+    attr_accessor :success
+
+    def initialize(response)
+      @response = response
+
+      case @response
+      when Net::HTTPUnauthorized
+        Credova::Error::NotAuthorized.new(@response.body)
+      when Net::HTTPNotFound
+        Credova::Error::NotFound.new(@response.body)
+      when Net::HTTPNoContent
+        Credova::Error::NoContent.new(@response.body)
+      when Net::HTTPOK, Net::HTTPSuccess
+        self.success = true
+        _data = JSON.parse(@response.body)
+
+        @data = case
+        when _data.is_a?(Hash)
+          _data.deep_symbolize_keys
+        when _data.is_a?(Array)
+          _data.map(&:deep_symbolize_keys)
+        end
+      else
+        raise Credova::Error::RequestError.new(@response.body)
+      end
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    def body
+      @data
+    end
+
+    def fetch(key)
+      @data.fetch(key)
+    end
+
+    def success?
+      !!success
+    end
+
+  end
+end

data/lib/credova/retailer.rb

@@ -0,0 +1,30 @@
+require 'credova/api'
+
+module Credova
+  class Retailer
+
+    include Credova::API
+
+    ENDPOINTS = {
+      lenders: "lenders".freeze,
+      stores:  "stores".freeze,
+    }
+
+    def initialize(client)
+      @client = client
+    end
+
+    def lenders
+      endpoint = ENDPOINTS[:lenders]
+
+      get_request(endpoint, auth_header(@client.access_token))
+    end
+
+    def stores
+      endpoint = ENDPOINTS[:stores]
+
+      get_request(endpoint, auth_header(@client.access_token))
+    end
+
+  end
+end

data/lib/credova/version.rb

@@ -0,0 +1,3 @@
+module Credova
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: credova
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jeffrey Dill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+description: ''
+email:
+- jeffdill2@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- credova.gemspec
+- lib/credova.rb
+- lib/credova/api.rb
+- lib/credova/application.rb
+- lib/credova/base.rb
+- lib/credova/client.rb
+- lib/credova/error.rb
+- lib/credova/ffl.rb
+- lib/credova/payments.rb
+- lib/credova/response.rb
+- lib/credova/retailer.rb
+- lib/credova/version.rb
+homepage: https://github.com/ammoready/credova
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Credova API Ruby library.
+test_files: []