optimum 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3534d5d95a086cfb762786c9f275b468c819f490c33d04a1b4d5479eaa2d7600
+  data.tar.gz: aff2d7e31171732f026966d41b6e65466f73ee3c3e5aa9b81e33dfabc5e5cae0
+SHA512:
+  metadata.gz: ff410a48fc4f8fc417ffbddd931603901566cb13bed126e33f2420f178920105f43358c8c640c7dd3f3159f4e66ef1ad0519105f4c9825c8308ecbdf5885e6f0
+  data.tar.gz: 4443d5f791fb50599012110c9aa7d5a4faf4898073838dbf815be8485ecce1c35a799f4c29dc15378ad4aebbd3e389b50e57c632ab976bc947e543a19203b182

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--order random

data/.rubocop.yml

@@ -0,0 +1,31 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5.1
+
+# Don't force top level comments in every class
+Style/Documentation:
+  Enabled: false
+
+# A good line length is 100 chars
+Layout/LineLength:
+  Max: 100
+  AllowURI: true
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 30
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 10

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in optimum.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    optimum (1.0.0)
+      addressable
+      faraday
+      faraday_middleware
+      multi_json
+      rainbow
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    byebug (11.1.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    dotenv (2.7.5)
+    faker (2.10.1)
+      i18n (>= 1.6, < 2)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    method_source (0.9.2)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.37.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.6.1)
+    vcr (5.0.0)
+    webmock (3.8.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  dotenv
+  faker
+  optimum!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rspec
+  simplecov
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,74 @@
+# optimum API wrapper
+
+This is a simple gem to interact with [optimum's](https://www.optimumfinance.co.uk/) Instant Decision API.
+
+The API documentation can be found here: https://optimum-core-staging.herokuapp.com/api/v1/instant-decision/docs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'optimum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install optimum
+
+## Usage
+
+You need to have an introducerId to use the API. Every request will be authenticated with that id in the params.
+
+### Configuration
+
+You can configure Optimum by providing a configuration block, before you do any call:
+
+```ruby
+Optimum.configure do |config|
+  config.introducer_id = YOUR_ID_HERE
+  # config.debug = true # This is false by default, keep in mind it will ve VERY verbose
+end
+```
+
+### Quote
+
+All the available methods are encapsulated in the `Decision` class. The available methods are:
+
+```ruby
+Optimum::Decision.create(PARAMS)
+# => This will return a decision, along with opportunityId, which will be used in subsequent calls.
+
+Optimum::Decision.update(PARAMS)
+```
+
+Every call will return a `Optimum::Response` instance, that you can use to get all the information
+you need:
+
+```ruby
+response = Optimum::Decision.update(PARAMS)
+
+response.status     #=> 200
+response.success?   #=> true
+response.errors     #=> []
+response.data       #=> { ... }
+```
+
+## 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.
+
+Please refer to optimum's documentation on how to test different states (we do have recorded VCR
+responses, but if something changes on their side we need to update). The documentation is here:
+https://optimum-core-staging.herokuapp.com/api/v1/instant-decision/docs
+
+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).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'optimum'
+require 'date'
+
+require 'dotenv'
+Dotenv.load
+
+Optimum.configure do |config|
+  config.introducer_id = ENV['OPTIMUM_INTRODUCER_ID']
+end
+
+send(:include, Optimum)
+
+require 'pry'
+Pry.start

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/optimum.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'optimum/version'
+require 'optimum/path_sanitizer'
+require 'optimum/configuration'
+require 'optimum/connection'
+require 'optimum/decision'
+
+module Optimum
+  module_function
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def connection
+    @connection ||= Connection.new
+  end
+
+  def configure
+    yield(configuration)
+  end
+end

data/lib/optimum/configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Optimum
+  class Configuration
+    attr_accessor :env, :introducer_id
+    attr_writer :debug
+
+    API_DOMAINS = {
+      production: 'https://www.optimum.localhost',
+      development: 'https://optimum-core-staging.herokuapp.com'
+    }.freeze
+
+    def initialize
+      @introducer_id = ''
+      @webhook_signature = ''
+      @env = defined?(Rails) ? Rails.env : :development
+      @debug = false
+    end
+
+    def debug?
+      @debug
+    end
+
+    def api_domain
+      API_DOMAINS[@env.to_sym] || API_DOMAINS[:development]
+    end
+  end
+end

data/lib/optimum/connection.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'rainbow'
+require 'addressable'
+
+require 'optimum/response'
+
+module Optimum
+  class Connection
+    BASE_PATH = '/api/v1/instant-decision'
+
+    def get(path, params = {})
+      log "GET #{path} with #{params}"
+
+      http_response = adapter.get(PathSanitizer.sanitize(path)) do |req|
+        req.body = params.to_json
+      end
+
+      log "Response: #{http_response.body}"
+
+      Response.new(http_response)
+    end
+
+    def post(path, params = {})
+      log "POST #{path} with #{params}"
+
+      http_response = adapter.post(PathSanitizer.sanitize(path), params.to_json)
+
+      log "Response: #{http_response.body}"
+
+      Response.new(http_response)
+    end
+
+    def put(path, params = {})
+      log "PUT #{path} with #{params}"
+
+      http_response = adapter.put(PathSanitizer.sanitize(path), params.to_json)
+
+      log "Response: #{http_response.body}"
+
+      Response.new(http_response)
+    end
+
+    private
+
+    def log(text)
+      return unless Optimum.configuration.debug?
+
+      puts Rainbow("[Optimum] #{text}").magenta.bright
+    end
+
+    def base_url
+      Addressable::URI.join(Optimum.configuration.api_domain, BASE_PATH).to_s
+    end
+
+    def adapter
+      Faraday.new(url: base_url) do |conn|
+        conn.headers['Content-Type'] = 'application/json'
+        conn.headers['User-Agent'] = "ruby-optimum-#{VERSION}"
+        conn.response :json, parser_options: { symbolize_names: true }, content_type: /\bjson$/
+        conn.response :logger if Optimum.configuration.debug?
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/optimum/customer_generator.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'faker'
+
+module Optimum
+  # This class can be used to generate fake customers for test purposes
+  class CustomerGenerator
+    attr_accessor :id, :first_name, :last_name, :email, :phone, :address, :date_of_birth, :city
+    attr_accessor :postcode
+
+    DEFAULTS = {
+      id: SecureRandom.hex(4),
+      first_name: Faker::Name.first_name,
+      last_name: Faker::Name.last_name,
+      email: Faker::Internet.email,
+      phone: Faker::PhoneNumber.phone_number,
+      address: Faker::Address.street_address,
+      date_of_birth: Faker::Date.birthday(min_age: 23, max_age: 65),
+      city: Faker::Address.city,
+      postcode: Faker::Address.postcode
+    }.freeze
+
+    def self.generate(params = {})
+      new(params).generate
+    end
+
+    def initialize(params = {})
+      Faker::Config.locale = 'en-GB'
+
+      DEFAULTS.each do |key, default_value|
+        send("#{key}=", params[key] || default_value)
+      end
+    end
+
+    def generate
+      {
+        data: {
+          application: {
+            company: company_information,
+            people: [user_information],
+            requested_products: {
+              credit_facility: {
+                approval: {
+                  amount: 123_123,
+                  duration: 12,
+                  detailed_purpose: 'business loan'
+                }
+              }
+            }
+          }
+        }
+      }
+    end
+
+    def company_information
+      {
+        last_12_months_turnover: {
+          amount: 0.0
+        },
+        registered_company_name: 'HOKO LTD',
+        industry: 'B | Mining and Quarrying',
+        company_number: '09525857',
+        type: 'limited_liability_company',
+        trading_from_date: '2015-05-22',
+        registered_address: {
+          postcode: 'W1T 3NF',
+          street_line_1: 'Berners House',
+          street_line_2: '47-48 Berners Street',
+          town: 'London',
+          country: 'GB'
+        },
+        vat_status: {
+          is_vat_registered: true
+        }
+      }
+    end
+
+    def user_information
+      {
+        uid: SecureRandom.uuid,
+        first_name: first_name,
+        last_name: last_name,
+        date_of_birth: date_of_birth,
+        roles: %w[applicant shareholder guarantor director],
+        phones: phones,
+        emails: emails,
+        residential_addresses: residential_addresses,
+        privacy_policy: {
+          agreed: true,
+          datetime: DateTime.now
+        }
+      }
+    end
+
+    def phones
+      [
+        {
+          uid: SecureRandom.uuid,
+          number: phone,
+          type: 'primary'
+        }
+      ]
+    end
+
+    def emails
+      [
+        {
+          uid: SecureRandom.uuid,
+          email: email,
+          type: 'primary'
+        }
+      ]
+    end
+
+    def residential_addresses
+      [
+        {
+          uid: SecureRandom.uuid,
+          town: city,
+          street_line_1: address,
+          street_line_2: '',
+          country: 'GB',
+          postcode: postcode,
+          house_number: '10',
+          residential_status: 'owner_no_mortgage'
+        }
+      ]
+    end
+  end
+end