youlend 1.0.0

data/lib/youlend/lead_generator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'faker'
+
+module Youlend
+  class LeadGenerator
+    def self.generate
+      new.generate
+    end
+
+    def initialize
+      Faker::Config.locale = 'en-GB'
+
+      generate
+    end
+
+    # Mandatory fields:
+    # * CompanyName
+    # * CompanyType (ltd, plc, llp, dac, soleTrader, aps, as, ks, ivs and is)
+    # * MonthsTrading
+    # * CountryISOCode (GBR, DNK and IRE)
+    # * KeyContactName
+    # * ThirdPartyLeadId
+    # * RegisteredAddress
+    # * ContactPhoneNumber
+    # * MonthlyCardRevenue (must be greater than or equal to '1000')
+    # * ContactEmailAddress
+    # * LoanCurrencyISOCode (ISO 4217 currency code. Valid codes are GBP, EUR and DKK)
+    # * ThirdPartyCustomerId
+    def generate
+      {
+        companyName: 'HOKO LTD',
+        companyType: 'ltd',
+        monthsTrading: rand(3..10),
+        countryISOCode: 'GBR',
+        keyContactName: Faker::Name.name,
+        thirdPartyLeadId: SecureRandom.uuid,
+        registeredAddress: address,
+        contactPhoneNumber: Faker::PhoneNumber.phone_number,
+        monthlyCardRevenue: 10_000,
+        contactEmailAddress: Faker::Internet.email,
+        loanCurrencyISOCode: 'GBP',
+        thirdPartyCustomerId: SecureRandom.uuid,
+        companyNumber: '09525857',                # optional
+        notificationURL: Faker::Internet.url,     # optional
+        thirdPartyMerchantId: SecureRandom.uuid   # optional
+      }
+    end
+
+    private
+
+    def address
+      {
+        line1: Faker::Address.street_address,
+        line2: Faker::Address.secondary_address,
+        city: 'London',
+        region: 'London',
+        areaCode: Faker::Address.zip_code,
+        country: 'UK'
+      }
+    end
+  end
+end

data/lib/youlend/merchant_generator.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'faker'
+
+module Youlend
+  class MerchantGenerator
+    def self.generate
+      new.generate
+    end
+
+    def initialize
+      Faker::Config.locale = 'en-GB'
+
+      generate
+    end
+
+    # Mandatory fields:
+    # * CompanyName
+    # * CompanyType (ltd, plc, llp, dac, partnership, soleTrader, aps, as, ks, ivs and is)
+    # * CompanyNumber
+    # * FinancialData
+    # * CountryISOCode (GBR, DNK and IRE)
+    # * LoanCurrencyISOCode (ISO 4217 currency code. Valid codes are GBP, EUR and DKK)
+    # * ThirdPartyMerchantId
+    def generate
+      {
+        companyName: 'HOKO LTD',
+        companyType: 'ltd',
+        companyNumber: '09525857',
+        financialData: financial_data,
+        countryISOCode: 'GBR',
+        loanCurrencyISOCode: 'GBP',
+        thirdPartyMerchantId: SecureRandom.uuid,
+        significantPersons: [significant_person],     # optional
+        contactEmailAddress: 'oterosantos@gmail.com'  # optional
+      }
+    end
+
+    private
+
+    def financial_data
+      {
+        monthlyCardRevenue: 0,
+        monthlyValueOfPurchaseTransactions: 0,
+        monthlyRevenueFromInvoices: 0,
+        paymentData: payment_data
+      }
+    end
+
+    def payment_data
+      (1..12).to_a.map do |month|
+        formatted_month = format('%02<month>d', month: month)
+
+        {
+          paymentDate: "#{Date.today.year - 1}-#{formatted_month}-01",
+          amount: 5000,
+          currencyISOCode: 'GBP'
+        }
+      end
+    end
+
+    def significant_person
+      {
+        firstName: Faker::Name.first_name,
+        surname: Faker::Name.last_name,
+        address: address,
+        dateOfBirth: Date.parse('1980-01-01').to_s
+      }
+    end
+
+    def address
+      {
+        line1: Faker::Address.street_address,
+        line2: Faker::Address.secondary_address,
+        city: 'London',
+        region: 'London',
+        areaCode: Faker::Address.zip_code,
+        country: 'UK'
+      }
+    end
+  end
+end

data/lib/youlend/path_sanitizer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Youlend
+  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/youlend/quote.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Following the API description here: https://staging.youlendapi.com/prequalification/index.html
+module Youlend
+  class Quote
+    def self.pre_qualification(params)
+      response = Youlend.connection.post('/prequalification/Requests', :prequalification, params)
+
+      # If we got back a response but all the funded amounts are 0.0 it means that the load was
+      # actually rejected! We'll replace the response body with an error message instead and change
+      # the success code.
+      if loan_accepted?(response.body)
+        response
+      else
+        response.http_response.env.status = 422
+        response.http_response.env.body = { error: 'Rejected', error_description: 'Loan was rejected' }
+        response
+      end
+    end
+
+    def self.loan_accepted?(data)
+      return false unless data[:loanOptions]
+      options = data[:loanOptions]
+
+      funded_amounts = options.map { |option| option[:fundedAmount] }
+
+      funded_amounts.any?(&:positive?)
+    end
+  end
+end

data/lib/youlend/response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Youlend
+  class Response
+    extend Forwardable
+
+    attr_reader :http_response
+    def_delegators :@http_response, :headers, :body, :status, :success?
+
+    def initialize(http_response)
+      @http_response = http_response
+    end
+
+    def unauthorized?
+      status == 401
+    end
+
+    def token_expired?
+      auth_header = @http_response.headers['www-authenticate']
+
+      return false unless auth_header
+
+      auth_header.match?(/.*token is expired.*/)
+    end
+  end
+end

data/lib/youlend/version.rb

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

data/vcr_cassettes/auth_incorrect.yml

@@ -0,0 +1,84 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://youlend-stag.eu.auth0.com/oauth/token
+    body:
+      encoding: UTF-8
+      string: '{"grant_type":"client_credentials","client_id":"test","client_secret":null,"audience":"/prequalification"}'
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ruby-youlend-1.0.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Date:
+      - Tue, 02 Feb 2021 13:30:34 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '60'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cf_bm=b86d644328e734a89744d6ab0c5ab572c0111eb1-1612272634-1800-AcGEpbRAnosUxswpSXM+JAqOBtuUgVfOzH1IugvEMHcHIsTDjoQ1XXEiXASfhswbTP1gXQLtpq79QNhCRMd3i88=;
+        path=/; expires=Tue, 02-Feb-21 14:00:34 GMT; domain=.eu.auth0.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfduid=db76a7c8db86f5fd148669281a4fd0fca1612272634; expires=Thu, 04-Mar-21
+        13:30:34 GMT; path=/; domain=.eu.auth0.com; HttpOnly; SameSite=Lax; Secure
+      - did=s%3Av0%3Ad446bdc0-655a-11eb-9745-d92175d2cd95.IicDICUYKjaHmwetynHVcGPlmOwmulS%2BU6pKfHrGcvE;
+        Max-Age=31557600; Path=/; Expires=Wed, 02 Feb 2022 19:30:34 GMT; HttpOnly;
+        Secure; SameSite=None
+      - did_compat=s%3Av0%3Ad446bdc0-655a-11eb-9745-d92175d2cd95.IicDICUYKjaHmwetynHVcGPlmOwmulS%2BU6pKfHrGcvE;
+        Max-Age=31557600; Path=/; Expires=Wed, 02 Feb 2022 19:30:34 GMT; HttpOnly;
+        Secure
+      Cf-Ray:
+      - 61b4447ece99da6a-LIS
+      Cache-Control:
+      - private, no-store, no-cache, must-revalidate, post-check=0, pre-check=0, no-transform
+      Strict-Transport-Security:
+      - max-age=31536000
+      Cf-Cache-Status:
+      - DYNAMIC
+      Cf-Request-Id:
+      - '080489233a0000da6ab2a8b000000001'
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Ot-Baggage-Auth0-Request-Id:
+      - 61b4447ece99da6a
+      Ot-Tracer-Sampled:
+      - 'true'
+      Ot-Tracer-Spanid:
+      - 7ca1b23302f70745
+      Ot-Tracer-Traceid:
+      - 4774272523010f8a
+      X-Auth0-Requestid:
+      - 9105d826c668167fdfd4
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '30'
+      X-Ratelimit-Remaining:
+      - '29'
+      X-Ratelimit-Reset:
+      - '1612272635'
+      Vary:
+      - Accept-Encoding
+      Server:
+      - cloudflare
+      Alt-Svc:
+      - h3-27=":443"; ma=86400, h3-28=":443"; ma=86400, h3-29=":443"; ma=86400
+    body:
+      encoding: UTF-8
+      string: '{"error":"access_denied","error_description":"Unauthorized"}'
+    http_version:
+  recorded_at: Tue, 02 Feb 2021 13:30:34 GMT
+recorded_with: VCR 5.0.0

data/vcr_cassettes/auth_onboarding_correct.yml

@@ -0,0 +1,86 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://youlend-stag.eu.auth0.com/oauth/token
+    body:
+      encoding: UTF-8
+      string: '{"grant_type":"client_credentials","client_id":"<CLIENT_ID>","client_secret":"<CLIENT_SECRET>","audience":"https://staging.youlendapi.com/onboarding"}'
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ruby-youlend-1.0.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 02 Feb 2021 13:24:57 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cf_bm=e6a4378af86d22825e034680d08e42422cad86a0-1612272297-1800-AcsFVk6Zv0PJF3XHlWZ8G77qJ8cvjPf6Aku6MvwFjMinViAvIKbeV3urOJ3KxhRsxRt1g/woJ0OywLZhWe4Smkw=;
+        path=/; expires=Tue, 02-Feb-21 13:54:57 GMT; domain=.eu.auth0.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfduid=d0401db464e44077ae99de37e2a271a0f1612272296; expires=Thu, 04-Mar-21
+        13:24:56 GMT; path=/; domain=.eu.auth0.com; HttpOnly; SameSite=Lax; Secure
+      - did=s%3Av0%3A0af87850-655a-11eb-98e7-893d431ee561.a4UtjYsy2su3wNuzKHvF5c6FwubT%2Bdtr3hwRaI1cK%2F4;
+        Max-Age=31557600; Path=/; Expires=Wed, 02 Feb 2022 19:24:57 GMT; HttpOnly;
+        Secure; SameSite=None
+      - did_compat=s%3Av0%3A0af87850-655a-11eb-98e7-893d431ee561.a4UtjYsy2su3wNuzKHvF5c6FwubT%2Bdtr3hwRaI1cK%2F4;
+        Max-Age=31557600; Path=/; Expires=Wed, 02 Feb 2022 19:24:57 GMT; HttpOnly;
+        Secure
+      Cf-Ray:
+      - 61b43c400c3d5d43-LIS
+      Cache-Control:
+      - no-store
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      Cf-Cache-Status:
+      - DYNAMIC
+      Cf-Request-Id:
+      - '080483fc0a00005d43a9a02000000001'
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Ot-Baggage-Auth0-Request-Id:
+      - 61b43c400c3d5d43
+      Ot-Tracer-Sampled:
+      - 'true'
+      Ot-Tracer-Spanid:
+      - 1176407e7e758d00
+      Ot-Tracer-Traceid:
+      - 3f5af5df1055e780
+      Pragma:
+      - no-cache
+      X-Auth0-Requestid:
+      - 770c64fa80205df8e5b4
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '30'
+      X-Ratelimit-Remaining:
+      - '29'
+      X-Ratelimit-Reset:
+      - '1612272298'
+      Server:
+      - cloudflare
+      Alt-Svc:
+      - h3-27=":443"; ma=86400, h3-28=":443"; ma=86400, h3-29=":443"; ma=86400
+    body:
+      encoding: ASCII-8BIT
+      string: '{"access_token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik0wUXdOMEl5TnpRMVJrRXhNa1pGTlVWRU5UQTJRalV6UWtRMVJUY3dORE0xUVVVM05rTkVRZyJ9.eyJodHRwOi8veW91bGVuZC5jb20vY2xhaW1zL2xlbmRpbmdQYXJ0bmVySWQiOiJkOGJmZTcwMy1lODBlLTRlMzUtYmFhYS1mZDk2MWU3ZGZlZTkiLCJpc3MiOiJodHRwczovL3lvdWxlbmQtc3RhZy5ldS5hdXRoMC5jb20vIiwic3ViIjoidXpLVEcyQ0NBZkFZQ0pGU0I3N3ZXRlVOelVOOHZxdlhAY2xpZW50cyIsImF1ZCI6Imh0dHBzOi8vc3RhZ2luZy55b3VsZW5kYXBpLmNvbS9vbmJvYXJkaW5nIiwiaWF0IjoxNjEyMjcyMjk3LCJleHAiOjE2MTIzNTg2OTcsImF6cCI6InV6S1RHMkNDQWZBWUNKRlNCNzd2V0ZVTnpVTjh2cXZYIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIn0.lcYAhbXgtTnOBE528d5mPu7CD_FUefSnRwIK9u1rdg-CcRCflLmesALTJjS-VbE0kotT_PAU9n2CuLAbsK3XbORkg8doxKZG_1mNeSxuqCYrcd-nOPtxnKUXuRrCIZoogzmt9gt350skue_6YSKVjqeqeGetzyOdoitiJEms2rkuzMqkfNlTqouXKjYKHFIG6tUg4oBUlrvjwDvAXaLmZIyxpSkihrqCG2_5cvzrmtZmffwJvFtPVYKyufgtZm66NIPiitw_NfTtcU1ZggPBgJyjjGJKL6XD--mJqoaGEzWUncyJEOuONmqm_m_H0LuCfb5OQMLkDbQuqo_fwsixfA","expires_in":86400,"token_type":"Bearer"}'
+    http_version:
+  recorded_at: Tue, 02 Feb 2021 13:24:57 GMT
+recorded_with: VCR 5.0.0

data/vcr_cassettes/auth_prequalification_correct.yml

@@ -0,0 +1,86 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://youlend-stag.eu.auth0.com/oauth/token
+    body:
+      encoding: UTF-8
+      string: '{"grant_type":"client_credentials","client_id":"<CLIENT_ID>","client_secret":"<CLIENT_SECRET>","audience":"https://staging.youlendapi.com/prequalification"}'
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ruby-youlend-1.0.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 02 Feb 2021 13:24:56 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cf_bm=1f04630e67aebd3e63c5ae209b26c60da4cebc96-1612272296-1800-AdPv0nCo/T4gCqXZONdqjcajKW+5GA8gigo3PBVPwP9olp1ZX6yXJmJJHCDL3+Upyon3Vtg+uwZV+xYQR6VCteA=;
+        path=/; expires=Tue, 02-Feb-21 13:54:56 GMT; domain=.eu.auth0.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfduid=d0091f13a90105b0ec98405f0a18a34981612272296; expires=Thu, 04-Mar-21
+        13:24:56 GMT; path=/; domain=.eu.auth0.com; HttpOnly; SameSite=Lax; Secure
+      - did=s%3Av0%3A0ac50c40-655a-11eb-809c-3d9d54edece8.Msqyby98z4gqYXI9LxAWrR2xCemhgYWy8FphAoEUNlA;
+        Max-Age=31557600; Path=/; Expires=Wed, 02 Feb 2022 19:24:56 GMT; HttpOnly;
+        Secure; SameSite=None
+      - did_compat=s%3Av0%3A0ac50c40-655a-11eb-809c-3d9d54edece8.Msqyby98z4gqYXI9LxAWrR2xCemhgYWy8FphAoEUNlA;
+        Max-Age=31557600; Path=/; Expires=Wed, 02 Feb 2022 19:24:56 GMT; HttpOnly;
+        Secure
+      Cf-Ray:
+      - 61b43c3d3ec0da6e-LIS
+      Cache-Control:
+      - no-store
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      Cf-Cache-Status:
+      - DYNAMIC
+      Cf-Request-Id:
+      - '080483fa430000da6eb7b8a000000001'
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Ot-Baggage-Auth0-Request-Id:
+      - 61b43c3d3ec0da6e
+      Ot-Tracer-Sampled:
+      - 'true'
+      Ot-Tracer-Spanid:
+      - 625d9fdc0482fd38
+      Ot-Tracer-Traceid:
+      - 70edb07403066d5e
+      Pragma:
+      - no-cache
+      X-Auth0-Requestid:
+      - 48a985195b00b3397482
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '30'
+      X-Ratelimit-Remaining:
+      - '29'
+      X-Ratelimit-Reset:
+      - '1612272297'
+      Server:
+      - cloudflare
+      Alt-Svc:
+      - h3-27=":443"; ma=86400, h3-28=":443"; ma=86400, h3-29=":443"; ma=86400
+    body:
+      encoding: ASCII-8BIT
+      string: '{"access_token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik0wUXdOMEl5TnpRMVJrRXhNa1pGTlVWRU5UQTJRalV6UWtRMVJUY3dORE0xUVVVM05rTkVRZyJ9.eyJodHRwOi8veW91bGVuZC5jb20vY2xhaW1zL2xlbmRpbmdQYXJ0bmVySWQiOiJkOGJmZTcwMy1lODBlLTRlMzUtYmFhYS1mZDk2MWU3ZGZlZTkiLCJpc3MiOiJodHRwczovL3lvdWxlbmQtc3RhZy5ldS5hdXRoMC5jb20vIiwic3ViIjoidXpLVEcyQ0NBZkFZQ0pGU0I3N3ZXRlVOelVOOHZxdlhAY2xpZW50cyIsImF1ZCI6Imh0dHBzOi8vc3RhZ2luZy55b3VsZW5kYXBpLmNvbS9wcmVxdWFsaWZpY2F0aW9uIiwiaWF0IjoxNjEyMjcyMjk2LCJleHAiOjE2MTIzNTg2OTYsImF6cCI6InV6S1RHMkNDQWZBWUNKRlNCNzd2V0ZVTnpVTjh2cXZYIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIn0.ZSyjtXprsNihqIaCfB5JXjwPhBEi41VDyiWmZMu4XIBNrojuqYXnEljwFQIVEM9IiXrDMFx-b9RqLu1CyNtNKqexbIylQ6_jALCyENCeapXZ-MrHTPCPBs8NdnISeRNah-uvT0bMnOVUzpXW6D99aCoGp2LyLAPwqG-kbI05xpKuX_dtMn43To-67-0VCZijJBOT6fip5uJf7m1VTgHc7_Wc4B8gTYl0WUwtZokBqcviD0AzkQxShsdMI1vDZdXPvya475d1F-nfHg0XT4YJKoaJ8tvdClmBcUA4vJrHb1kN6mW7eGpcL-71fzwffJnZViras3FyY7_QOxUNn7FotA","expires_in":86400,"token_type":"Bearer"}'
+    http_version:
+  recorded_at: Tue, 02 Feb 2021 13:24:56 GMT
+recorded_with: VCR 5.0.0