iwoca 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce9c1834255a98ef839610f8ccff91efab04f9942b219470de6c769e7bb52a20
-  data.tar.gz: 37479cab8d5dfefd64be30fd339d7dad18ac8d039b985ffeb3fb7ebe36c3b48b
+  metadata.gz: 198e9be11e22df1a0eeaaf7aeadf91a8d915890c83c034232f6c4f6bdf950d6b
+  data.tar.gz: 36a2b9b54228c00b077e2bb8a4f4be34e3f71b32631ae90a23fbc5a1d88c32a4
 SHA512:
-  metadata.gz: d645e2d9948fe267fcce8e6f706de979b8a17127dd66b9e2acb5f77262b9ba77f7d99556f86bf0b10939ec19a24b61d6728502bca53a63d822c2b008c72fd647
-  data.tar.gz: d7ab10d7dbcc0c792c68e2b03cccae40c9ff6e71d3fa23d3fe556ce886f66c8618e40407eb4e27ab2aabb976787e07f51094936898972521a82376815481d998
+  metadata.gz: 9551708a25561b0ea8355ad4372e6fb65161d9e2b0ad418d48938fab648efe07b26d5191d8b80b99151f206873bef71662c7ad96485dd864629e03ac9f6ae446
+  data.tar.gz: 4683b1b27606c672d0feecc6c1160ec51218b223f57c253f4e4a266544587dba07393f6465752a916b0bf6788d2e24050d4252d7a410d0c55ad952bd96d46cbe

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    iwoca (1.0.1)
+    iwoca (1.1.0)
       addressable
       faraday (~> 2.7)
+      json-schema
       rainbow
 
 GEM
@@ -30,6 +31,8 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
+    json-schema (4.0.0)
+      addressable (>= 2.8)
     method_source (1.0.0)
     parallel (1.22.1)
     parser (3.2.1.0)

data/README.md

@@ -36,28 +36,68 @@ Iwoca.configure do |config|
 end
 ```
 
-### Quote
+### Check authentication
 
-All the available methods are encapsulated in the `Quote` class. The available methods are:
+To check if you're using a good API Key you can invoke the `authentication_check` endpoint by
+running:
 
 ```ruby
-Iwoca.create_customer(CUSTOMER_JSON)
+Iwoca.authentication_check
+# => Authentication check successful: {"version":"v2.1"}
+```
+
+### Customer
+
+First thing you want to do is to create a customer:
+
+```ruby
+customer_json = Iwoca::CustomerGenerator.generate # for test purposes
+response = Iwoca::Customer.create(data: 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)
+customer_id = response.data[:customer_id]
+```
+
+Then you can update it, if you keep track of the customer_id that is returned:
+
+```ruby
+Iwoca::Customer.update(customer_id: customer_id, data: customer_json)
+```
+
+And finally you can get a login link:
+
+```ruby
+Iwoca::Customer.login_link(customer_id: customer_id)
+```
+
+### Application
 
-Iwoca.approval(state_key)
+After the customer is correctly created you can create an application:
 
-Iwoca.login_link(state_key)
+```ruby
+app_json = Iwoca::ApplicationGenerator.generate # for test purposes
+response = Iwoca::Application.create(customer_id: customer_id, data: app_json)
+
+application_id = response.data[:application_id]
+```
+
+This can then be used to check the status of the latest application for a customer:
 
-Iwoca.credit_facility_status(state_key)
+```ruby
+Iwoca::Application.latest(customer_id: customer_id)
+```
+
+Or, equally important, to check the offers:
+
+```ruby
+Iwoca::Application.offers(application_id: application_id)
 ```
 
 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 = Iwoca::Customer.login_link(customer_id: customer_id)
 
 response.status     #=> 200
 response.success?   #=> true
@@ -65,6 +105,19 @@ response.errors     #=> []
 response.data       #=> { login_link: 'http://login_link' }
 ```
 
+### Webhooks
+
+Newest iwoca version has a nice way to manage the webhooks, so we can change and check the status of
+webhooks at any point.
+
+```ruby
+Iwoca::Webhooks.configuration # what's the webook url and the secret token
+Iwoca::Webhooks.update(config: {}) # update webhook configuration
+Iwoca::Webhooks.event_types # list the webhook event types
+Iwoca::Webhooks.subscribe(event_types: []) # subscribe to an event
+Iwoca::Webhooks.subscriptions # list subscriptions
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run
@@ -78,9 +131,9 @@ https://developer.iwoca.co.uk/lending-api-v1/testing-your-integration/core-test-
 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
+### Webhooks
 
-Iwoca webhook will target this address:
+To test webhooks you may find it easier to use a test endpoint like:
 https://dev-finpointdev.pagekite.me/fast_lender_webhooks/iwoca_event
 
 How to install:
@@ -95,10 +148,5 @@ How to run:
 
 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).
+- u: hello@finpoint.co.uk
+- p: fckx7989

data/bin/console

@@ -15,8 +15,17 @@ end
 
 # Useful if we need to do some tests
 require 'iwoca/customer_generator'
+require 'iwoca/application_generator'
 
 send(:include, Iwoca)
 
+def generate_customer
+  CustomerGenerator.generate
+end
+
+def generate_app
+  ApplicationGenerator.generate
+end
+
 require 'pry'
 Pry.start

data/iwoca.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'addressable'
   spec.add_dependency 'faraday', '~> 2.7'
   spec.add_dependency 'rainbow'
+  spec.add_dependency 'json-schema'
 end

data/lib/iwoca/application.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Iwoca
+  class Application
+    # This needs to be used after the customer has been created. It returns an application_id that
+    # can be used to identify the application in all future requests.
+    # The params argument needs to have the following structure:
+    # {
+    #   data: {
+    #     requests: [
+    #       {
+    #         amount: 15000,
+    #         duration: {
+    #           amount: 12,
+    #           unit: "months"
+    #         },
+    #         product_type: "flexi_loan", # check the schema JSON for more options
+    #         purpose: "equipment_purchase", # check the schema JSON for more options
+    #         urgency: "asap"
+    #       }
+    #     ]
+    #   }
+    # }
+    def self.create(customer_id:, data: {})
+      requests = (data.dig(:data, :requests) || []).first.to_json
+
+      # # Add the introducer so we can get a login link later
+      # data[:data][:introducer] = {
+      #   entity_to_contact: 'customer',
+      #   introducer_id: customer_id
+      # }
+
+      JSON::Validator.validate!('lib/iwoca/schemas/requested_product.json', requests)
+
+      Iwoca.connection.post("customers/#{customer_id}/applications/", data)
+    end
+
+    # Sending across the customer_id in the URL - you will receive back an object with the latest
+    # application information that we have.
+    #
+    # This will include a status field that can be one of the following options:
+    # open, deferred, declined, offered, conditional_offer, customer_to_link_open_banking,
+    # action_required, awaiting_underwriter, in_underwriting, expired, funded, offer_revoked,
+    # talking_to_customer.
+    #
+    # Check more info in the docs:
+    # https://iwoca.stoplight.io/docs/lapi-uk/branches/2.1.0/84660933e0b17-get-user-latest-application
+    def self.latest(customer_id:)
+      Iwoca.connection.get("customers/#{customer_id}/applications/latest/")
+    end
+
+    # Use this endpoint after creating an application to generate offers that your customer is
+    # eligible for.
+    # Offers are associated with the Application, so are retrieved using the customer's current
+    # application_id that you would have received in the previous request.
+    def self.offers(application_id:)
+      Iwoca.connection.get("applications/#{application_id}/offers/")
+    end
+  end
+end

data/lib/iwoca/application_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal
+
+module Iwoca
+  class ApplicationGenerator
+    def self.generate(params: {})
+      new(params:).generate
+    end
+
+    def initialize(params: {})
+      @params = params
+    end
+
+    def generate
+      {
+        data: {
+          last_12_months_turnover: { amount: 700000, valid_from: '2019-08-24T14:15:22Z' },
+          requests: [
+            {
+              amount: 15000,
+              product_type: 'flexi_loan',
+              duration: { amount: 12, unit: "months" },
+              purpose: 'equipment_purchase',
+              urgency: 'asap'
+            }
+          ]
+        }
+      }
+    end
+  end
+end

data/lib/iwoca/connection.rb

@@ -8,7 +8,12 @@ require 'iwoca/response'
 
 module Iwoca
   class Connection
-    BASE_PATH = '/api/lending/v1'
+    BASE_PATH = '/api/lending/v2.1'
+    BASE_NOTIFICATIONS_PATH = '/api/notifications/v1'
+
+    def initialize(type = 'base')
+      @base_path = type == 'notifications' ? BASE_NOTIFICATIONS_PATH : BASE_PATH
+    end
 
     def get(path, params = {})
       log "GET #{path} with #{params}"
@@ -49,14 +54,14 @@ module Iwoca
     end
 
     def base_url
-      Addressable::URI.join(Iwoca.configuration.api_domain, BASE_PATH).to_s
+      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['Authorization'] = "Bearer #{token}" unless token.to_s.empty?
         conn.headers['Content-Type'] = 'application/json'
         conn.headers['User-Agent'] = "ruby-iwoca-#{VERSION}"
         conn.response :json, parser_options: { symbolize_names: true }

data/lib/iwoca/customer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Iwoca
+  class Customer
+    # 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
+    # customer_id used to identify the customer in all future requests.
+    #
+    # Successful request will return a 201 status code and a JSON response containing a customer_id:
+    # Example: { data: { customer_id: "fd48781e-3ad3-4a94-b4a6-60fafeebab0b" } }
+    def self.create(data: {})
+      # Validate the schema first, to avoid making a request with invalid data.
+      JSON::Validator.validate!('lib/iwoca/schemas/customer_payload.json', data.to_json)
+
+      Iwoca.connection.post('customers/', data)
+    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_id:, data: {})
+      Iwoca.connection.put("customers/#{customer_id}/", data)
+    end
+
+    # Get a login link for a customer from a given customer_id
+    def self.login_link(customer_id:)
+      Iwoca.connection.get("customers/#{customer_id}/login_link/")
+    end
+  end
+end

data/lib/iwoca/customer_generator.rb

@@ -3,7 +3,9 @@
 require 'faker'
 
 module Iwoca
-  # This class can be used to generate fake customers for test purposes
+  # This class can be used to generate fake customers for test purposes.
+  # It is based on the minimum data requirements described here:
+  # https://iwoca.stoplight.io/docs/lapi-uk/branches/2.1.0/2c44db4bf20fb-meeting-minimum-data-requirements
   class CustomerGenerator
     attr_accessor :id, :first_name, :last_name, :email, :phone, :address, :date_of_birth, :city
     attr_accessor :postcode
@@ -13,7 +15,7 @@ module Iwoca
       first_name: Faker::Name.first_name,
       last_name: Faker::Name.last_name,
       email: Faker::Internet.email,
-      phone: Faker::PhoneNumber.phone_number,
+      phone: Faker::PhoneNumber.cell_phone_in_e164,
       address: Faker::Address.street_address,
       date_of_birth: Faker::Date.birthday(min_age: 23, max_age: 65),
       city: Faker::Address.city,
@@ -21,7 +23,7 @@ module Iwoca
     }.freeze
 
     def self.generate(params = {})
-      new(params).generate
+      new(DEFAULTS.merge(params)).generate
     end
 
     def initialize(params = {})
@@ -35,59 +37,50 @@ module Iwoca
     def generate
       {
         data: {
-          application: {
-            company: company_information,
-            people: [user_information],
-            requested_products: {
-              credit_facility: {
-                approval: {
-                  amount: 123_123,
-                  duration: 12,
-                  detailed_purpose: 'business loan'
-                }
-              }
-            }
-          }
+          company: company_information,
+          people: [user_information]
         }
       }
     end
 
     def company_information
       {
+        company_number: '09525857',
         last_12_months_turnover: {
-          amount: 0.0
+          amount: 70_000,
+          valid_from: "2019-08-24T14:15:22Z"
         },
         registered_company_name: 'HOKO LTD',
-        industry: 'B | Mining and Quarrying',
-        company_number: '09525857',
-        type: 'limited_liability_company',
         trading_from_date: '2015-05-22',
+        type: 'limited_liability_company',
+        industry: 'B | Mining and Quarrying',
+        vat_status: {
+          is_vat_registered: true,
+          registered_over_3_months: true,
+        },
         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
       {
+        date_of_birth: date_of_birth,
+        emails: emails,
         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,
+        roles: %w[applicant shareholder guarantor director],
         residential_addresses: residential_addresses,
         privacy_policy: {
           agreed: true,
-          datetime: DateTime.now
+          valid_from: DateTime.now - 1
         }
       }
     end
@@ -95,7 +88,6 @@ module Iwoca
     def phones
       [
         {
-          uid: SecureRandom.uuid,
           number: phone,
           type: 'primary'
         }
@@ -105,8 +97,11 @@ module Iwoca
     def emails
       [
         {
-          uid: SecureRandom.uuid,
           email: email,
+          marketing_opt_in: {
+            agreed: true,
+            valid_from: DateTime.now
+          },
           type: 'primary'
         }
       ]
@@ -115,14 +110,12 @@ module Iwoca
     def residential_addresses
       [
         {
-          uid: SecureRandom.uuid,
-          town: city,
+          country: 'GB',
+          residential_status: 'owner_no_mortgage',
           street_line_1: address,
           street_line_2: '',
-          country: 'GB',
-          postcode: postcode,
-          house_number: '10',
-          residential_status: 'owner_no_mortgage'
+          town: city,
+          postcode: postcode
         }
       ]
     end