modulr-api 0.0.15 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2461042a33c2ef6c899c9bca84bb7aaa06488fc378bb7bd25edf8bde1d26ebec
-  data.tar.gz: 4735dc4188f8bb2345f552cc6c950ad7e876780f35d2fe4531d6a6a725822b22
+  metadata.gz: 756d629d0ce81b092c226a12364e51addeb7df40d6101fa9a2f195e5da406fac
+  data.tar.gz: ae23bf413271bf36cd6d256f5cfac0edd588377cb17a6fa2c2eb12163b4b5052
 SHA512:
-  metadata.gz: ba8e09076f2fd69a474143b32f67e494cb2c9091d1312332da719eff42cc1ad3f4e806a7476f9b6784496515df8c965a0a4e33508aa8a87516ae0477b4e707a8
-  data.tar.gz: d884bca4495f5b88ee93c1a303382092f9a52cc633fa25aac5c59ce4206210d8c0302f67dd4f1d5556531c54d3cf8e8e41b47954d415c2c579cb87529cc2b12f
+  metadata.gz: 13b76b1d357a1c7175fc8e2740d77f66aec500fc88172bbba17130a1bdc9afd788f82352a1bb5f963512226c687e9ab80121aa413c41dc8bb176845396041b1a
+  data.tar.gz: 21f648f6656e2c933c8fc076b543da98b9e063dd28988d1ca48111ddbe579c5f6eafd913b0bff057e4b607c7d5936109d8464524ee9fc2773ae003c0ae4f11fb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    modulr-api (0.0.15)
+    modulr-api (0.0.17)
       faraday (~> 1.0)
       faraday_middleware (~> 1.0)
 

data/README.md

@@ -56,6 +56,13 @@ client.payments.list(from: DateTime.now - 1, to: DateTime.now)
 client.payments.create(account_id: "A2188C26", currency: "EUR", amount: 0.01, destination: { type: "IBAN", iban: "ES8601280011390100072676", name: "Aitor García Rey" }, reference: "The reference")
 ```
 
+### Transactions
+
+```rb
+# List transactions
+client.transactions.list(account_id: "A2188C26", credit: true)
+```
+
 ### Notifications
 
 ### Supported event types per channel
@@ -89,9 +96,15 @@ Supported via email:
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-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 tag and push the new version:
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, on main branch update the version number in `version.rb`, then:
 
 ```git
+bundle exec rake install
+git add .
+git commit -m 'Update version file and gemfile'
+git push
 git tag vx.x.x main
 git push origin vx.x.x
 ```

data/lib/modulr/api/accounts_service.rb

@@ -5,7 +5,7 @@ module Modulr
     class AccountsService < Service
       def find(id:)
         response = client.get("/accounts/#{id}")
-        Resources::Accounts::Account.new(response, response.body)
+        Resources::Accounts::Account.new(response.env[:raw_body], response.body)
       end
 
       def create(customer_id:, currency:, product_code:, **opts)
@@ -16,7 +16,7 @@ module Modulr
         payload[:externalReference] = opts[:external_reference] if opts[:external_reference]
 
         response = client.post("/customers/#{customer_id}/accounts", payload)
-        Resources::Accounts::Account.new(response, response.body)
+        Resources::Accounts::Account.new(response.env[:raw_body], response.body)
       end
 
       def close(account_id:)

data/lib/modulr/api/customers_service.rb

@@ -5,7 +5,7 @@ module Modulr
     class CustomersService < Service
       def find(id:)
         response = client.get("/customers/#{id}")
-        Resources::Customers::Customer.new(response, response.body)
+        Resources::Customers::Customer.new(response.env[:raw_body], response.body)
       end
     end
   end

data/lib/modulr/api/notifications_service.rb

@@ -5,12 +5,12 @@ module Modulr
     class NotificationsService < Service
       def find(id:, **opts)
         response = client.get("#{base_notification_url(opts)}/notifications/#{id}")
-        Resources::Notifications::Notification.new(response, response.body)
+        Resources::Notifications::Notification.new(response.env[:raw_body], response.body)
       end
 
       def list(**opts)
         response = client.get("#{base_notification_url(opts)}/notifications")
-        Resources::Notifications::Collection.new(response, response.body)
+        Resources::Notifications::Collection.new(response.env[:raw_body], response.body)
       end
 
       def create(type:, channel:, destinations:, config:, **opts)
@@ -21,7 +21,17 @@ module Modulr
           config: config,
         }
         response = client.post("#{base_notification_url(opts)}/notifications", payload)
-        Resources::Notifications::Notification.new(response, response.body)
+        Resources::Notifications::Notification.new(response.env[:raw_body], response.body)
+      end
+
+      def update(id:, status:, destinations:, config:, **opts)
+        payload = {
+          status: status,
+          destinations: destinations,
+          config: config,
+        }
+        response = client.put("#{base_notification_url(opts)}/notifications/#{id}", payload)
+        Resources::Notifications::Notification.new(response.env[:raw_body], response.body)
       end
 
       protected def base_notification_url(opts)

data/lib/modulr/api/payments_service.rb

@@ -8,14 +8,14 @@ module Modulr
         payment_attributes = response.body[:content]&.first
         raise NotFoundError, "Payment #{id} not found" unless payment_attributes
 
-        Resources::Payments::Payment.new(response, payment_attributes)
+        Resources::Payments::Payment.new(response.env[:raw_body], payment_attributes)
       end
 
       def list(**opts)
         return find(id: opts[:id]) if opts[:id]
 
         response = client.get("/payments", build_query_params(opts))
-        Resources::Payments::Collection.new(response, response.body[:content])
+        Resources::Payments::Collection.new(response.env[:raw_body], response.body[:content])
       end
 
       # rubocop:disable Metrics/ParameterLists
@@ -32,7 +32,7 @@ module Modulr
         payload[:endToEndReference] = opts[:e2e_reference] if opts[:e2e_reference]
 
         response = client.post("/payments", payload)
-        Resources::Payments::Payment.new(response, response.body)
+        Resources::Payments::Payment.new(response.env[:raw_body], response.body)
       end
       # rubocop:enable Metrics/ParameterLists
 

data/lib/modulr/api/transactions_service.rb

@@ -5,7 +5,7 @@ module Modulr
     class TransactionsService < Service
       def list(account_id:, **opts)
         response = client.get("/accounts/#{account_id}/transactions", build_query_params(opts))
-        Resources::Transactions::Transactions.new(response, response.body[:content])
+        Resources::Transactions::Transactions.new(response.env[:raw_body], response.body[:content])
       end
 
       private def build_query_params(opts) # rubocop:disable Metrics/AbcSize

data/lib/modulr/auth/signature.rb

@@ -30,7 +30,7 @@ module Modulr
           apisecret.dup.force_encoding("UTF-8"),
           signature_string.dup.force_encoding("UTF-8")
         )
-        b64 = Base64.encode64(digest)
+        b64 = Base64.strict_encode64(digest)
         url_safe_code = ERB::Util.url_encode(b64.strip)
 
         new(apikey: apikey, nonce: nonce, signature: url_safe_code, timestamp: timestamp)

data/lib/modulr/client.rb

@@ -51,6 +51,10 @@ module Modulr
       execute :post, path, data, options
     end
 
+    def put(path, data = nil, options = {})
+      execute :put, path, data, options
+    end
+
     def execute(method, path, data = nil, options = {})
       request(method, path, data, options)
     end

data/lib/modulr/resources/accounts/account.rb

@@ -23,9 +23,9 @@ module Modulr
         map :createdDate, :created_at
         map :directDebit, :direct_debit
 
-        def initialize(response, attributes = {})
-          super(response, attributes)
-          @identifiers = Accounts::Identifiers.new(response, attributes[:identifiers])
+        def initialize(raw_response, attributes = {})
+          super(raw_response, attributes)
+          @identifiers = Accounts::Identifiers.new(nil, attributes[:identifiers])
         end
       end
     end

data/lib/modulr/resources/accounts/identifiers.rb

@@ -4,8 +4,8 @@ module Modulr
   module Resources
     module Accounts
       class Identifiers < BaseCollection
-        def initialize(response, attributes_collection)
-          super(response, Identifier, attributes_collection)
+        def initialize(raw_response, attributes_collection)
+          super(raw_response, Identifier, attributes_collection)
         end
       end
     end

data/lib/modulr/resources/base.rb

@@ -3,10 +3,11 @@
 module Modulr
   module Resources
     class Base
-      attr_reader :response
+      attr_reader :raw_response
+
+      def initialize(raw_response, attributes = {})
+        @raw_response = raw_response
 
-      def initialize(response, attributes = {})
-        @response = response
         attributes.each do |key, value|
           m = "#{key}=".to_sym
           send(m, value) if respond_to?(m)
@@ -34,7 +35,9 @@ require_relative "notifications/notification"
 require_relative "notifications/config"
 require_relative "notifications/collection"
 require_relative "payments/payment"
-require_relative "payments/details"
+require_relative "payments/counterparty"
+require_relative "payments/details/incoming/general"
+require_relative "payments/details/outgoing/general"
 require_relative "payments/destination"
 require_relative "payments/collection"
 require_relative "transactions/transaction"

data/lib/modulr/resources/base_collection.rb

@@ -3,13 +3,14 @@
 module Modulr
   module Resources
     class BaseCollection
+      attr_reader :raw_response
+
       include Enumerable
-      attr_reader :response
 
-      def initialize(response, item_klass, attributes_collection = [])
-        @response = response
+      def initialize(raw_response, item_klass, attributes_collection = [])
+        @raw_response = raw_response
         @attributes_collection = attributes_collection
-        @items = attributes_collection.map { |attributes_item| item_klass.new(response, attributes_item) }
+        @items = attributes_collection.map { |attributes_item| item_klass.new(nil, attributes_item) }
       end
 
       def each(&block)

data/lib/modulr/resources/notifications/collection.rb

@@ -4,8 +4,8 @@ module Modulr
   module Resources
     module Notifications
       class Collection < BaseCollection
-        def initialize(response, attributes_collection)
-          super(response, Notification, attributes_collection)
+        def initialize(raw_response, attributes_collection)
+          super(raw_response, Notification, attributes_collection)
         end
       end
     end

data/lib/modulr/resources/notifications/notification.rb

@@ -12,9 +12,9 @@ module Modulr
         map :status
         map :destinations
 
-        def initialize(response, attributes = {})
-          super(response, attributes)
-          @config = Config.new(response, attributes[:config])
+        def initialize(raw_response, attributes = {})
+          super(raw_response, attributes)
+          @config = Config.new(nil, attributes[:config])
         end
       end
     end

data/lib/modulr/resources/payments/collection.rb

@@ -4,8 +4,8 @@ module Modulr
   module Resources
     module Payments
       class Collection < BaseCollection
-        def initialize(response, attributes_collection)
-          super(response, Payment, attributes_collection)
+        def initialize(raw_response, attributes_collection)
+          super(raw_response, Payment, attributes_collection)
         end
       end
     end

data/lib/modulr/resources/payments/counterparty.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Payments
+      class Counterparty < Base
+        attr_reader :identifier
+
+        map :name
+        map :address
+
+        def initialize(raw_response, attributes = {})
+          super(raw_response, attributes)
+          @identifier = Accounts::Identifier.new(nil, attributes[:identifier])
+        end
+      end
+    end
+  end
+end

data/lib/modulr/resources/payments/details/incoming/general.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Payments
+      module Details
+        module Incoming
+          class General < Base
+            attr_reader :payer, :payee
+
+            map :created, :created_at
+            map :posted, :posted_at
+            map :retryCount, :retry_count
+            map :reprocess
+            map :sourceService, :source_service
+            map :providerCode, :provider_code
+            map :ledgerBankCode, :ledger_bank_code
+            map :clearingRequired, :clearing_required
+            map :requestReference, :request_reference
+            map :accountNumber, :account_number
+            map :type
+            map :amount
+            map :currency
+            map :description
+            map :originalReference, :original_reference
+            map :schemeId, :scheme_id
+            map :schemeType, :scheme_type
+            map :details, :raw_details
+
+            def initialize(raw_response, attributes = {})
+              super(raw_response, attributes)
+              @payer = Counterparty.new(nil, attributes[:payer])
+              @payee = Counterparty.new(nil, attributes[:payee])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/modulr/resources/payments/details/outgoing/general.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Payments
+      module Details
+        module Outgoing
+          class General < Base
+            attr_reader :destination
+
+            map :sourceAccountId, :source_account_id
+            map :currency
+            map :amount
+            map :reference
+
+            def initialize(raw_response, attributes = {})
+              super(raw_response, attributes)
+              @destination = Destination.new(nil, attributes[:destination])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/modulr/resources/payments/payment.rb

@@ -13,9 +13,18 @@ module Modulr
         map :createdDate, :created_at
         map :approvalStatus, :approval_status
 
-        def initialize(response, attributes = {})
-          super(response, attributes)
-          @details = Details.new(response, attributes[:details])
+        def initialize(raw_response, attributes = {})
+          super(raw_response, attributes)
+          @details = parse_details(attributes[:details])
+        end
+
+        private def parse_details(details)
+          case details[:type]
+          when "PI_SEPA_INST", "PI_FAST"
+            Details::Incoming::General.new(nil, details)
+          else
+            Details::Outgoing::General.new(nil, details)
+          end
         end
       end
     end

data/lib/modulr/resources/transactions/collection.rb

@@ -4,8 +4,8 @@ module Modulr
   module Resources
     module Transactions
       class Transactions < BaseCollection
-        def initialize(response, attributes_collection)
-          super(response, Transaction, attributes_collection)
+        def initialize(raw_response, attributes_collection)
+          super(raw_response, Transaction, attributes_collection)
         end
       end
     end

data/lib/modulr/resources/transactions/transaction.rb

@@ -18,8 +18,8 @@ module Modulr
         map :sourceExternalReference, :external_reference
         map :additionalInfo, :additional_info
 
-        def initialize(response, attributes = {})
-          super(response, attributes)
+        def initialize(raw_response, attributes = {})
+          super(raw_response, attributes)
 
           @balance = attributes[:account][:balance]
           @available_balance = attributes[:account][:availableBalance]

data/lib/modulr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Modulr
-  VERSION = "0.0.15"
+  VERSION = "0.0.17"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulr-api
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.17
 platform: ruby
 authors:
 - Aitor García Rey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-10 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -223,8 +223,10 @@ files:
 - lib/modulr/resources/notifications/config.rb
 - lib/modulr/resources/notifications/notification.rb
 - lib/modulr/resources/payments/collection.rb
+- lib/modulr/resources/payments/counterparty.rb
 - lib/modulr/resources/payments/destination.rb
-- lib/modulr/resources/payments/details.rb
+- lib/modulr/resources/payments/details/incoming/general.rb
+- lib/modulr/resources/payments/details/outgoing/general.rb
 - lib/modulr/resources/payments/payment.rb
 - lib/modulr/resources/transactions/collection.rb
 - lib/modulr/resources/transactions/transaction.rb

data/lib/modulr/resources/payments/details.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Modulr
-  module Resources
-    module Payments
-      class Details < Base
-        attr_reader :destination
-
-        map :sourceAccountId, :source_account_id
-        map :currency
-        map :amount
-        map :reference
-
-        def initialize(response, attributes = {})
-          super(response, attributes)
-          @destination = Destination.new(response, attributes[:destination])
-        end
-      end
-    end
-  end
-end