iwoca 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc06c9b15b3cf293d246f1cce76c9dada20bb1b0b5185fa3375e6b12a1e096fc
-  data.tar.gz: e5de537071c70452a658693a671f8335fb983e8a908a27433f935b9ec5306242
+  metadata.gz: 198e9be11e22df1a0eeaaf7aeadf91a8d915890c83c034232f6c4f6bdf950d6b
+  data.tar.gz: 36a2b9b54228c00b077e2bb8a4f4be34e3f71b32631ae90a23fbc5a1d88c32a4
 SHA512:
-  metadata.gz: dc29294dd0453a1785c521e276fafc7de7fc91f8d53a7fe43bbe776f576094a8f0fa283f232938a7f986dcc404e598d6c98ebae2e57180a1eebab0adf3665643
-  data.tar.gz: a77cf2fb8cd03df9977d62831f9ce1766fd6d3d9342aba8343873a20911f1a27cae2772643742df0f14abee09d8a03f88e0818ba7cfa4d63de4d98455a04e3d2
+  metadata.gz: 9551708a25561b0ea8355ad4372e6fb65161d9e2b0ad418d48938fab648efe07b26d5191d8b80b99151f206873bef71662c7ad96485dd864629e03ac9f6ae446
+  data.tar.gz: 4683b1b27606c672d0feecc6c1160ec51218b223f57c253f4e4a266544587dba07393f6465752a916b0bf6788d2e24050d4252d7a410d0c55ad952bd96d46cbe

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+3.1.2

data/Gemfile

@@ -4,3 +4,15 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in iwoca.gemspec
 gemspec
+
+# Development dependencies
+gem 'dotenv'
+gem 'faker'
+gem 'pry-byebug'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-rspec'
+gem 'simplecov'
+gem 'vcr'
+gem 'webmock'

data/Gemfile.lock

@@ -1,86 +1,95 @@
 PATH
   remote: .
   specs:
-    iwoca (1.0.0)
+    iwoca (1.1.0)
       addressable
-      faraday
-      faraday_middleware
-      multi_json
+      faraday (~> 2.7)
+      json-schema
       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)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dotenv (2.8.1)
+    faker (3.1.1)
+      i18n (>= 1.8.11, < 2)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
       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)
+    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)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
       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)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
       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)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.47.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.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)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.12.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
       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)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
@@ -88,13 +97,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
   dotenv
   faker
   iwoca!
   pry-byebug
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake
+  rspec
   rubocop
   rubocop-rspec
   simplecov
@@ -102,4 +110,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.0.2
+   2.4.7

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

@@ -27,20 +27,7 @@ Gem::Specification.new do |spec|
   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 'faraday', '~> 2.7'
   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'
+  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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'faraday'
-require 'faraday_middleware'
 require 'rainbow'
 require 'addressable'
 
@@ -9,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}"
@@ -50,17 +54,16 @@ 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.use FaradayMiddleware::ParseJson
         conn.response :json, parser_options: { symbolize_names: true }
         conn.response :logger if Iwoca.configuration.debug?
         conn.adapter Faraday.default_adapter

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