iwoca 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc06c9b15b3cf293d246f1cce76c9dada20bb1b0b5185fa3375e6b12a1e096fc
+  data.tar.gz: e5de537071c70452a658693a671f8335fb983e8a908a27433f935b9ec5306242
+SHA512:
+  metadata.gz: dc29294dd0453a1785c521e276fafc7de7fc91f8d53a7fe43bbe776f576094a8f0fa283f232938a7f986dcc404e598d6c98ebae2e57180a1eebab0adf3665643
+  data.tar.gz: a77cf2fb8cd03df9977d62831f9ce1766fd6d3d9342aba8343873a20911f1a27cae2772643742df0f14abee09d8a03f88e0818ba7cfa4d63de4d98455a04e3d2

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.3

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 iwoca.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    iwoca (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 (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.14.0)
+      faraday (>= 0.7.4, < 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.14.1)
+    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
+  iwoca!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rspec
+  simplecov
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,104 @@
+# iwoca API wrapper
+
+This is a simple gem to interact with [iwoca's](https://www.iwoca.co.uk/) API.
+
+The API documentation can be found here: https://developer.iwoca.co.uk/introduction/introduction
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iwoca'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iwoca
+
+## Usage
+
+You need to have an api key to use the API. Every request will be authenticated with that key in the header.
+
+### Configuration
+
+You can configure Iwoca by providing a configuration block, before you do any call:
+
+```ruby
+Iwoca.configure do |config|
+  config.api_key = YOUR_API_KEY_HERE
+  config.webhook_signature = YOUR_WEBHOOK_SIGNATURE
+  # 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 `Quote` class. The available methods are:
+
+```ruby
+Iwoca.create_customer(CUSTOMER_JSON)
+# => This will return a state_key, if the JSON is valid. You need this key to call other methods.
+
+Iwoca.update_customer(state_key, CUSTOMER_JSON)
+
+Iwoca.approval(state_key)
+
+Iwoca.login_link(state_key)
+
+Iwoca.credit_facility_status(state_key)
+```
+
+Every call will return a `Iwoca::Response` instance, that you can use to get all the information
+you need:
+
+```ruby
+response = Iwoca.login_link(state_key)
+
+response.status     #=> 200
+response.success?   #=> true
+response.errors     #=> []
+response.data       #=> { login_link: 'http://login_link' }
+```
+
+## 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 iwoca'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://developer.iwoca.co.uk/lending-api-v1/testing-your-integration/core-test-data.
+
+In `spec/data` we have the stored customer data that will return a 'approved' state. Use this to
+generate valid state keys and follow their instructions to generate the other states.
+
+### Webhook
+
+Iwoca webhook will target this address:
+https://dev-finpointdev.pagekite.me/fast_lender_webhooks/iwoca_event
+
+How to install:
+
+    $ curl -O https://pagekite.net/pk/pagekite.py
+    $ chmod +x pagekite.py
+    $ sudo mv -f pagekite.py /usr/local/bin (replace with the name of your directory)
+
+How to run:
+
+    ./pagekite.py 3000 dev-finpointdev.pagekite.me
+
+pagekite.net details:
+
+* u: hello@finpoint.co.uk
+* p: fckx7989
+
+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,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'iwoca'
+require 'date'
+
+require 'dotenv'
+Dotenv.load
+
+Iwoca.configure do |config|
+  config.api_key = ENV['IWOCA_API_KEY']
+  config.webhook_signature = ENV['IWOCA_WEBHOOK_SIGNATURE']
+end
+
+# Useful if we need to do some tests
+require 'iwoca/customer_generator'
+
+send(:include, Iwoca)
+
+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/iwoca.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'iwoca/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'iwoca'
+  spec.version       = Iwoca::VERSION
+  spec.authors       = ['rikas']
+  spec.email         = ['oterosantos@gmail.com']
+
+  spec.summary       = 'Iwoca API wrapper'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://www.iwoca.com'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  # 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(__dir__)) 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_dependency 'addressable'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'multi_json'
+  spec.add_dependency 'rainbow'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

data/lib/iwoca.rb

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

data/lib/iwoca/configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Iwoca
+  class Configuration
+    attr_accessor :api_key, :webhook_signature, :env
+    attr_writer :debug
+
+    API_DOMAINS = {
+      production: 'https://www.iwoca.co.uk',
+      development: 'https://stage.iwoca-dev.co.uk'
+    }.freeze
+
+    def initialize
+      @api_key = ''
+      @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/iwoca/connection.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'rainbow'
+require 'addressable'
+
+require 'iwoca/response'
+
+module Iwoca
+  class Connection
+    BASE_PATH = '/api/lending/v1'
+
+    def get(path, params = {})
+      log "GET #{path} with #{params}"
+
+      http_response = adapter.get(PathSanitizer.sanitize(path), params)
+
+      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 Iwoca.configuration.debug?
+
+      puts Rainbow("[Iwoca] #{text}").magenta.bright
+    end
+
+    def base_url
+      Addressable::URI.join(Iwoca.configuration.api_domain, BASE_PATH).to_s
+    end
+
+    def adapter
+      token = Iwoca.configuration.api_key
+
+      Faraday.new(url: base_url) do |conn|
+        conn.headers['Authorization'] = "Token #{token}" unless token.to_s.empty?
+        conn.headers['Content-Type'] = 'application/json'
+        conn.headers['User-Agent'] = "ruby-iwoca-#{VERSION}"
+        conn.use FaradayMiddleware::ParseJson
+        conn.response :json, parser_options: { symbolize_names: true }
+        conn.response :logger if Iwoca.configuration.debug?
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end