iwoca 1.0.0

data/lib/iwoca/customer_generator.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'faker'
+
+module Iwoca
+  # 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

data/lib/iwoca/path_sanitizer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Iwoca
+  class PathSanitizer
+    # Removes any leading '/' and guarantees an ending '/'
+    def self.sanitize(path)
+      parts = path.split('/').reject(&:empty?)
+      new_path = parts.join('/')
+
+      [new_path, '/'].join
+    end
+  end
+end

data/lib/iwoca/quote.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Iwoca
+  class Quote
+    # The POST request should be used to create an iwoca account for the customer. It's always the
+    # first endpoint and method you should call when submitting a new customer. It returns a
+    # state_key used to identify the customer in all future requests. Almost all fields in the
+    # State are optional since you can submit a partial application initially, then add or update
+    # data over time (through the PUT method). Your iwoca contact will be able to give you details
+    # on which fields are recommended to help us make a lending decision.
+    def self.create_customer(params)
+      Iwoca.connection.post('state/', params)
+    end
+
+    # The PUT request should be used to add or update data for a customer. Note that the entire
+    # State should be submitted each time you use this endpoint, even if you are just updating a
+    # few fields.
+    def self.update_customer(state_key, params)
+      Iwoca.connection.put("state/#{state_key}/", params)
+    end
+
+    # This method should be used when a decision needs to be made for a customer. It doesn't expect
+    # any payload, all needed information should have been provided in the state of the customer.
+    def self.approval(state_key)
+      Iwoca.connection.post("approval_request/#{state_key}/")
+    end
+
+    # The GET request will return a one-time login link that the user can follow to get into
+    # their iwoca account (on iwoca.co.uk) without entering a password.
+    # You can generate multiple login links which will be active simultaneously. However, all
+    # links will expire when the user next logs into their iwoca account (either by following one
+    # of the links or by entering their username and password).
+    def self.login_link(state_key)
+      Iwoca.connection.get("login_link/#{state_key}/")
+    end
+
+    # The data returned contains information like approval status, loan status, repayments,
+    # cashflows, ...
+    def self.credit_facility_status(state_key)
+      Iwoca.connection.get("credit_facility_status/#{state_key}")
+    end
+  end
+end

data/lib/iwoca/response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Iwoca
+  class Response
+    extend Forwardable
+
+    def_delegators :@http_response, :body, :status, :success?
+
+    def initialize(http_response)
+      @http_response = http_response
+    end
+
+    def errors
+      @http_response.body&.dig(:errors) || []
+    end
+
+    def data
+      @http_response.body&.dig(:data) || {}
+    end
+  end
+end

data/lib/iwoca/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Iwoca
+  VERSION = '1.0.0'
+end

data/vcr_cassettes/approval_invalid.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stage.iwoca-dev.co.uk/api/lending/v1/approval_request/00000000-df68-421a-8108-f7cec4902c00/
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      Authorization:
+      - Token <TOKEN>
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ruby-iwoca-0.1.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Date:
+      - Fri, 24 Jan 2020 14:29:12 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '91'
+      Connection:
+      - keep-alive
+      Server:
+      - nginx/1.15.12
+      X-State-Key:
+      - 00000000-df68-421a-8108-f7cec4902c00
+      Expires:
+      - Fri, 24 Jan 2020 14:29:12 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store, must-revalidate
+      X-Partner:
+      - finpoint-dev
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - SAMEORIGIN
+      Vary:
+      - Cookie
+      Set-Cookie:
+      - isLoggedIn=True; Path=/
+      - sessionid_access=18ae56d0-de8c-4506-8571-397982b2faca; expires=Sat, 23-Jan-2021
+        14:29:12 GMT; HttpOnly; Max-Age=31536000; Path=/
+      - uid=rBEABF4q/zgZzAAlAwYyAg==; expires=Thu, 31-Dec-37 23:55:55 GMT; domain=.iwoca-dev.co.uk;
+        path=/
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+    body:
+      encoding: UTF-8
+      string: '{"errors": [{"code": "NotFound", "detail": "No \"state key\" found
+        matching that query."}]}'
+    http_version: 
+  recorded_at: Fri, 24 Jan 2020 14:29:12 GMT
+recorded_with: VCR 5.0.0

data/vcr_cassettes/approval_valid.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stage.iwoca-dev.co.uk/api/lending/v1/approval_request/1acd6198-df68-421a-8108-f7cec4902c00/
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      Authorization:
+      - Token <TOKEN>
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ruby-iwoca-0.1.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Fri, 24 Jan 2020 14:29:12 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '0'
+      Connection:
+      - keep-alive
+      Server:
+      - nginx/1.15.12
+      X-State-Key:
+      - 1acd6198-df68-421a-8108-f7cec4902c00
+      Expires:
+      - Fri, 24 Jan 2020 14:29:12 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store, must-revalidate
+      - public, max-age=0, must-revalidate
+      X-Partner:
+      - finpoint-dev
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - SAMEORIGIN
+      Vary:
+      - Cookie
+      Set-Cookie:
+      - isLoggedIn=True; Path=/
+      - sessionid_access=9983ffac-63a0-4299-b144-eb6a09d2811d; expires=Sat, 23-Jan-2021
+        14:29:12 GMT; HttpOnly; Max-Age=31536000; Path=/
+      - uid=rBEABF4q/zgZzAAlAwYxAg==; expires=Thu, 31-Dec-37 23:55:55 GMT; domain=.iwoca-dev.co.uk;
+        path=/
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 24 Jan 2020 14:29:12 GMT
+recorded_with: VCR 5.0.0

data/vcr_cassettes/create_customer_invalid.yml

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stage.iwoca-dev.co.uk/api/lending/v1/state/
+    body:
+      encoding: UTF-8
+      string: '{"data":{"application":{"company":{"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}},"people":[{"uid":"5923c880-9253-4504-84f2-5fcd4f1b3955","first_name":"Gemma","last_name":"Pfannerstill","date_of_birth":"1956-12-14","roles":["applicant","shareholder","guarantor","director"],"phones":[{"uid":"4e9233ca-7026-47c7-9979-39abeae7db9f","number":"+236
+        056 3766 7778","type":"primary"}],"emails":[{"uid":"e7970175-08d3-4a68-9c03-b3175b0de37b","email":"reynaldo@larsonnolan.info","type":"primary"}],"residential_addresses":[{"uid":"8119834a-f89e-4efc-98cf-2498593fa524","town":"West
+        Dominiqueville","street_line_1":"51900 Tom Manor","street_line_2":"","country":"GB","postcode":"WG4
+        3LE","house_number":"10","residential_status":"owner_no_mortgage"}],"privacy_policy":{"agreed":true,"datetime":"2020-01-23T18:57:16+00:00"}}],"requested_products":{"credit_facility":{"approval":{"amount":123123,"duration":12,"detailed_purpose":"business
+        loan"}}}}},"email":""}'
+    headers:
+      Authorization:
+      - Token <TOKEN>
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ruby-iwoca-0.1.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Date:
+      - Thu, 23 Jan 2020 18:57:18 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '128'
+      Connection:
+      - keep-alive
+      Server:
+      - nginx/1.15.12
+      X-State-Key:
+      - ''
+      Expires:
+      - Thu, 23 Jan 2020 18:57:18 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store, must-revalidate
+      X-Partner:
+      - finpoint-dev
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - SAMEORIGIN
+      Vary:
+      - Cookie
+      Set-Cookie:
+      - isLoggedIn=True; Path=/
+      - sessionid_access=03ccce87-8b7b-4847-9967-a2a84b79bd73; expires=Fri, 22-Jan-2021
+        18:57:18 GMT; HttpOnly; Max-Age=31536000; Path=/
+      - uid=rBEABV4p7I6R4QAhAw2MAg==; expires=Thu, 31-Dec-37 23:55:55 GMT; domain=.iwoca-dev.co.uk;
+        path=/
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+    body:
+      encoding: UTF-8
+      string: '{"errors": [{"source": {"pointer": ""}, "detail": "There are properties
+        not defined by the schema", "code": "ValidationError"}]}'
+    http_version: 
+  recorded_at: Thu, 23 Jan 2020 18:57:18 GMT
+recorded_with: VCR 5.0.0

data/vcr_cassettes/create_customer_no_auth.yml

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://stage.iwoca-dev.co.uk/api/lending/v1/state/
+    body:
+      encoding: UTF-8
+      string: '{"data":{"application":{"company":{"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}},"people":[{"uid":"8cf91c8d-7dad-4028-9871-739de9723943","first_name":"Jeremiah","last_name":"DuBuque","date_of_birth":"1982-03-04","roles":["applicant","shareholder","guarantor","director"],"phones":[{"uid":"1ade87a2-8845-4f1d-9441-29adda5f7cb7","number":"+423
+        01929 32251","type":"primary"}],"emails":[{"uid":"46cc012c-c034-46a8-9bff-10ae92d8a2a2","email":"judith.abernathy@becker.io","type":"primary"}],"residential_addresses":[{"uid":"20304bd8-1425-4c15-87b5-332f2ad1bd97","town":"Port
+        Suzanne","street_line_1":"4581 Kurt Manors","street_line_2":"","country":"GB","postcode":"ZF2
+        0XR","house_number":"10","residential_status":"owner_no_mortgage"}],"privacy_policy":{"agreed":true,"datetime":"2020-01-23T18:16:33+00:00"}}],"requested_products":{"credit_facility":{"approval":{"amount":123123,"duration":12,"detailed_purpose":"business
+        loan"}}}}}}'
+    headers:
+      Authorization:
+      - Token NOT VALID
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ruby-iwoca-0.1.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Date:
+      - Thu, 23 Jan 2020 18:16:33 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '106'
+      Connection:
+      - keep-alive
+      Server:
+      - nginx/1.15.12
+      X-State-Key:
+      - ''
+      Expires:
+      - Thu, 23 Jan 2020 18:16:33 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store, must-revalidate
+      X-Partner:
+      - None
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - SAMEORIGIN
+      Vary:
+      - Cookie
+      Set-Cookie:
+      - isLoggedIn=False; Path=/
+      - sessionid_access=2be3e052-e602-4739-8b59-587c4e6da88c; expires=Fri, 22-Jan-2021
+        18:16:33 GMT; HttpOnly; Max-Age=31536000; Path=/
+      - uid=rBEABV4p4wGR4QAhAwwiAg==; expires=Thu, 31-Dec-37 23:55:55 GMT; domain=.iwoca-dev.co.uk;
+        path=/
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+    body:
+      encoding: UTF-8
+      string: '{"errors": [{"code": "PermissionDenied", "detail": "You do not have
+        permission to perform this action."}]}'
+    http_version: 
+  recorded_at: Thu, 23 Jan 2020 18:16:33 GMT
+recorded_with: VCR 5.0.0