instant_quote 1.7.18 → 1.7.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea32f26600ebacbcea2bbb802e81cfdfdbc6f3fd8a63c5114450bd757aa7bcfe
-  data.tar.gz: 3690d3afa1a8bef07787712907ae74e68141ff948191aec6dc15515ef56733eb
+  metadata.gz: d31fe21346d1dcdc18f60859f3bb71f248df1ebe76bc10b1ef8e77717c522210
+  data.tar.gz: 16913cdcbf765609b081cc39a1dacf655dba67faf1e2cd4ffd6a93b8d9c279eb
 SHA512:
-  metadata.gz: a6ae792406151bc13bbd707f7bcc70f1baeb45a3e3c358fed1a528be3b0099e747c976ef056307170e636fcbe0d28e09cef9b0e79480e690c9aed95889fc1672
-  data.tar.gz: 5ed602cde2830a7a84225605a44bd68f6573fddaaf905617130b0da9d931c9a752edfab2880e07e64ba95d6dab6638160cb95679a565c5d6d2469f54d42351e0
+  metadata.gz: 7179adf5e3ca6dd13788e072d9f5abd4c2fd2b8ca5dfc6d38ecb1839d18cbea3d89e0ef47ad30f45166d65ad76583b86f0d881e2ed50ca6f03e6f2d38ca8597d
+  data.tar.gz: f0e046542bf8ee4cc71aabbba509ca270e36dc3a39c9a5f37009c0406f88d17b4fc45e8c3892d0d54da70e8779da58ad3daaaf03e8c2e99e127ecab09e67b5fc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    instant_quote (1.7.18)
+    instant_quote (1.7.20)
       activesupport
       capital_on_tap (~> 1.0.1)
       iwoca (~> 1.1.0)

data/bin/console

@@ -32,5 +32,53 @@ end
 
 send(:include, InstantQuote)
 
+# Configuration needed for the Money gem
+Money.default_currency = :gbp
+I18n.available_locales = [:en]
+I18n.locale = :en
+Money.locale_backend = :i18n
+Money.rounding_mode = BigDecimal::ROUND_HALF_EVEN
+
+def declined_v1_json
+  json = '{
+    "data": {
+      "state_key": "[FILTERED]",
+      "approval_requirements": [
+        { "type": "cc", "status": "required" },
+        { "type": "enhanced_security_check", "status": "pending" }
+      ],
+      "approval_status": { "status": "declined" },
+      "latest_approval_request": { "status": "decision_made" }
+    }
+  }'
+
+  JSON.parse(json)
+end
+
+def approved_v1_json
+  json = '{
+    "data": {
+      "state_key": "[FILTERED]",
+      "approval_status": {
+        "approved": {
+          "duration": 24,
+          "interval": "1m",
+          "max_credit": 21000.0,
+          "min_credit": 1.0,
+          "rate_structures": [
+            { "effective_on_day": 0, "rates": [{ "max_principal": 21000.0, "rate": 0.0515 }] }
+          ],
+          "time_out": "2023-09-24T00:00:00Z",
+          "top_up_allowed": false
+        },
+        "status": "approved"
+      },
+      "latest_approval_request": { "status": "decision_made" }
+    }
+  }'
+
+  JSON.parse(json)
+end
+
 require 'pry'
 Pry.start

data/lib/instant_quote/decision_parsers/iwoca.rb

@@ -98,6 +98,16 @@ module InstantQuote
       # offers - the response of the available offers
       def initialize(data = {})
         @data = super
+
+        # Just in case (v1 has a lot of key 'data' nesting)
+        @data = @data.dig(:data) if @data.key?(:data)
+
+        # It's a v1 JSON response, so we need to translate it to v2 first!
+        if @data.key?(:state_key)
+          puts "Translating v1 JSON to v2..."
+          @data = DecisionParsers::IwocaV2Translator.translate(@data)
+        end
+
         @status = @data[:status] if @data.key?(:status)
         @offers = @data[:offers] if @data.key?(:offers)
       end
@@ -153,7 +163,7 @@ module InstantQuote
       end
 
       def monthly_interest_rate
-        first_offer&.interest_rate
+        first_offer[:interest_rate]
       end
 
       def status

data/lib/instant_quote/decision_parsers/iwoca_v1.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module InstantQuote
+  module DecisionParsers
+    # Example responses:
+    #
+    # {
+    #   "data": {
+    #     "state_key": "[FILTERED]",
+    #     "approval_requirements": [
+    #       { "type": "enhanced_security_check", "status": "pending" }
+    #     ],
+    #     "approval_status": { "status": "declined" },
+    #     "latest_approval_request": { "status": "decision_made" }
+    #   }
+    # }
+    #
+    # {
+    #   "data": {
+    #     "state_key": "[FILTERED]",
+    #     "approval_requirements": [
+    #       { "type": "cc", "status": "required" },
+    #       { "type": "enhanced_security_check", "status": "pending" }
+    #     ],
+    #     "approval_status": { "status": "declined" },
+    #     "latest_approval_request": { "status": "decision_made" }
+    #   }
+    # }
+    #
+    # {
+    #   "data": {
+    #     "state_key": "[FILTERED]",
+    #     "approval_status": {
+    #       "approved": {
+    #         "duration": 24,
+    #         "interval": "1m",
+    #         "max_credit": 21000.0,
+    #         "min_credit": 1.0,
+    #         "rate_structures": [
+    #           { "effective_on_day": 0, "rates": [{ "max_principal": 21000.0, "rate": 0.0515 }] }
+    #         ],
+    #         "time_out": "2023-09-24T00:00:00Z",
+    #         "top_up_allowed": false
+    #       },
+    #       "status": "approved"
+    #     },
+    #     "latest_approval_request": { "status": "decision_made" }
+    #   }
+    # }
+    class IwocaV1 < DecisionParser
+      STATUSES = {
+        pending: 'pending',
+        approved: 'approved',
+        declined: 'declined',
+        no_decision: 'no_decision_possible',
+        not_defined: 'not_defined'
+      }.freeze
+
+      LOAN_STATES = {
+        ongoing: 'ongoing',
+        ended: 'ended',
+        topup: 'topup',
+        pending: 'pending',
+        overdue: 'overdue',
+        duetoday: 'duetoday'
+      }.freeze
+
+      # iwoca sends an extra "data" key, that is removed here, to avoid having to do data[:data]
+      # because  it's silly :)
+      def initialize(data = {})
+        @data = super
+        @data = @data[:data] if @data.key?(:data)
+      end
+
+      def pending?
+        status == STATUSES[:not_defined]
+      end
+
+      def approved?
+        status == STATUSES[:approved]
+      end
+
+      def declined?
+        status == STATUSES[:declined]
+      end
+
+      def manual_review?
+        status == STATUSES[:pending]
+      end
+
+      def no_decision_possible?
+        status == STATUSES[:no_decision]
+      end
+
+      def loan_started?
+        data[:loan_status] == LOAN_STATES[:ongoing]
+      end
+
+      def amount
+        amount_approved = status_hash.dig(:approved, :max_credit) || 0
+
+        Money.new(amount_approved * 100).format
+      end
+
+      # Only used by the new iwoca2 translator
+      def amount_unformatted
+        status_hash.dig(:approved, :max_credit) || 0
+      end
+
+      def credit_duration
+        status_hash.dig(:approved, :duration)
+      end
+
+      def credit_interval
+        status_hash.dig(:approved, :interval)
+      end
+
+      def monthly_interest_rate
+        rates = status_hash.dig(:approved, :rate_structures)
+
+        return 0 unless rates&.any?
+
+        rate_info = rates.first[:rates]&.first
+
+        return 0 unless rate_info
+
+        rate_info[:rate]
+      end
+
+      def status
+        status_hash[:status] || STATUSES[:not_defined]
+      end
+
+      private
+
+      def status_hash
+        data[:approval_status] || data[:latest_approval_request] || {}
+      end
+    end
+  end
+end

data/lib/instant_quote/decision_parsers/iwoca_v2_translator.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'instant_quote/decision_parsers/iwoca'
+
+# This class is used to translate iwoca's v1 decision format to v2. In the app we might have some
+# decisions stored with the v1 format that need translation but the webhook at the moment is also
+# using the old format (with state_key instead of customer_id).
+module InstantQuote
+  module DecisionParsers
+    class IwocaV2Translator
+      def initialize(v1_json)
+        @decision = InstantQuote::DecisionParsers::IwocaV1.new(v1_json)
+      end
+
+      def self.translate(decision)
+        new(decision).translate
+      end
+
+      # Translates the v1 JSON into v2 format.
+      def translate
+        {
+          status: {
+            status: translate_status(@decision.status),
+            requests: [
+              {
+                suggested_product: {
+                  amount: @decision.amount_unformatted,
+                  duration: {
+                    unit: translate_interval(@decision.credit_interval),
+                    amount: @decision.credit_duration
+                  },
+                }
+              }
+            ]
+          },
+          offers: [
+            {
+              interest_rate: @decision.monthly_interest_rate
+            }
+          ],
+        }
+      end
+
+      private
+
+      def translate_status(v1_status)
+        case v1_status
+        when 'approved'
+          'funded'
+        else
+          v1_status
+        end
+      end
+
+      def translate_interval(v1_interval)
+        case v1_interval
+        when '1m'
+          'months'
+        when '1w'
+          'weeks'
+        when '1d'
+          'days'
+        else
+          'months'
+        end
+      end
+    end
+  end
+end

data/lib/instant_quote/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InstantQuote
-  VERSION = '1.7.18'
+  VERSION = '1.7.20'
 end

data/lib/instant_quote/webhooks/iwoca.rb

@@ -42,6 +42,24 @@ module InstantQuote
         request.headers[SIGNATURE_HEADER]
       end
 
+      # The list of possible event types is:
+      # approval_status_changed
+      # customer_funded
+      # application_offered
+      # application_declined
+      # application_deferred
+      # cashflow_added
+      # mca_context_changed
+      # bank_account_setup
+      # application_status_changed
+      # application_attributed
+      # indicative_offer_created
+      # shopify_payment_resolve
+      # shopify_payment_reject
+      # shopify_refund_resolve
+      #
+      # More info:
+      # https://iwoca.stoplight.io/docs/lapi-notifications/b59ca8c181611-get-available-webhook-event-types
       def iwoca_event_type
         # Allowed Values: approval_status_changed, instruct_payments, customer_funded
         request.headers[EVENT_TYPE_HEADER]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instant_quote
 version: !ruby/object:Gem::Version
-  version: 1.7.18
+  version: 1.7.20
 platform: ruby
 authors:
 - rikas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-24 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -158,6 +158,8 @@ files:
 - lib/instant_quote/decision_parsers/iwoca_flexi24.rb
 - lib/instant_quote/decision_parsers/iwoca_recovery_loans.rb
 - lib/instant_quote/decision_parsers/iwoca_revenue_based_loans.rb
+- lib/instant_quote/decision_parsers/iwoca_v1.rb
+- lib/instant_quote/decision_parsers/iwoca_v2_translator.rb
 - lib/instant_quote/decision_parsers/optimum.rb
 - lib/instant_quote/decision_parsers/youlend.rb
 - lib/instant_quote/version.rb