modulr-api 0.0.5 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da666a42d86736ca6e0931a62e30672d57a7ab332de197e0bc83bf9a8e5bc175
-  data.tar.gz: 3b956f72365027d8990693d8e071d825e7a940f103c00eaacd0db68d4edaf433
+  metadata.gz: 3f5558adb23b165b565033e9a96d4dcf729e489fb0060abe0b56c22a1158135d
+  data.tar.gz: 99460f8fc2f1e2f8404e8e0bfa2cef8f9e9f66ae1dd359a11556b7de8497bcc2
 SHA512:
-  metadata.gz: 37c00f76260c63cd0e2b6035161a61324c65b53497e60c580e46f253982435f9c0825480c3945a5e7ccf86fadc674cee17dae46ccb6dc4d5e9e1d5fd5316c06f
-  data.tar.gz: 3adf0008186b638ddd479c4d0ec281f40393a492238c5eae022594c99f0d8c047ac87ce0c225deeb7db13fff893f0d1c983bf612679f3944c2469f47a6eb96ef
+  metadata.gz: 04735f27f41e13507ef0cd1834f76f5b2e60b656314ee1bb4bbd795cafdef1f2e4d515249f1a17877c42667f8c877d851f55184dc9ee48ac78b39f0191d8cdbb
+  data.tar.gz: 4298076a4b9957f7ecb6dcf67641f5a95f3ff1517a6d946e583bc3ea26a21a3da0fe937a9ac3c12cf29d81c072cdc21aa352a09bc6a8c82bc86939e4716aaa00

data/.rubocop_devengo.yml

@@ -48,6 +48,9 @@ Metrics/BlockLength:
     - "**/*.rake"
     - "spec/**/*.rb"
 
+Metrics/ClassLength:
+  Max: 500
+
 Metrics/MethodLength:
   Max: 50
 
@@ -159,25 +162,25 @@ Style/RedundantSelfAssignment:
 Style/SoleNestedConditional:
   Enabled: true
 
-Style/ArgumentsForwarding:  # (new in 1.1)
+Style/ArgumentsForwarding: # (new in 1.1)
   Enabled: true
 
-Style/DocumentDynamicEvalDefinition:  # (new in 1.1)
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
   Enabled: true
 
-Style/SwapValues:  # (new in 1.1)
+Style/SwapValues: # (new in 1.1)
   Enabled: true
 
-Style/CollectionCompact:  # (new in 1.2)
+Style/CollectionCompact: # (new in 1.2)
   Enabled: true
 
-Style/NegatedIfElseCondition:  # (new in 1.2)
+Style/NegatedIfElseCondition: # (new in 1.2)
   Enabled: true
 
-Style/NilLambda:  # (new in 1.3)
+Style/NilLambda: # (new in 1.3)
   Enabled: true
 
-Style/RedundantArgument:  # (new in 1.4)
+Style/RedundantArgument: # (new in 1.4)
   Enabled: true
 
 Style/FetchEnvVar:
@@ -252,28 +255,28 @@ Lint/UselessMethodDefinition:
 Lint/UselessTimes:
   Enabled: true
 
-Lint/DuplicateRegexpCharacterClassElement:  # (new in 1.1)
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
   Enabled: true
 
-Lint/EmptyBlock:  # (new in 1.1)
+Lint/EmptyBlock: # (new in 1.1)
   Enabled: true
 
-Lint/ToEnumArguments:  # (new in 1.1)
+Lint/ToEnumArguments: # (new in 1.1)
   Enabled: true
 
-Lint/UnmodifiedReduceAccumulator:  # (new in 1.1)
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
   Enabled: true
 
-Lint/NoReturnInBeginEndBlocks:  # (new in 1.2)
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
   Enabled: true
 
-Lint/DuplicateBranch:  # (new in 1.3)
+Lint/DuplicateBranch: # (new in 1.3)
   Enabled: true
 
-Lint/EmptyClass:  # (new in 1.3)
+Lint/EmptyClass: # (new in 1.3)
   Enabled: true
 
-Lint/UnexpectedBlockArity:  # (new in 1.5)
+Lint/UnexpectedBlockArity: # (new in 1.5)
   Enabled: true
 
 RSpec/AggregateExamples:

data/Gemfile.lock

@@ -1,16 +1,21 @@
 PATH
   remote: .
   specs:
-    modulr-api (0.0.5)
+    modulr-api (0.0.11)
       faraday (~> 1.0)
       faraday_middleware (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.5.0)
-    faraday (1.10.0)
+    faraday (1.10.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -35,13 +40,46 @@ GEM
     faraday-retry (1.0.3)
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.0.1)
     json (2.6.2)
-    multipart-post (2.2.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    multipart-post (2.3.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.0)
     rainbow (3.1.1)
     rake (12.3.3)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -78,8 +116,14 @@ GEM
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
+    shellany (0.0.1)
     test-prof (1.0.9)
+    thor (1.2.1)
     unicode-display_width (2.2.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   arm64-darwin-20
@@ -87,6 +131,8 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  guard (~> 2.0)
+  guard-rspec (~> 4.0)
   modulr-api!
   rake (~> 12.0)
   rspec (~> 3.0)
@@ -95,6 +141,7 @@ DEPENDENCIES
   rubocop-rake (~> 0.1)
   rubocop-rspec (~> 2.0)
   test-prof (~> 1.0)
+  webmock (~> 2.1)
 
 BUNDLED WITH
-   2.3.3
+   2.3.15

data/Guardfile

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -1,15 +1,13 @@
-# Modulr
+# Modulr FINAC API Ruby client
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/modulr`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby client for Modulr (cf. <https://modulr.readme.io/docs>)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'modulr-api'
+gem "modulr-api"
 ```
 
 And then execute:
@@ -26,22 +24,115 @@ gem install modulr-api
 
 ## Usage
 
-TODO: Write usage instructions here
+Run `bin/console` for an interactive prompt to experiment with the code.
+
+### Customers
+
+```rb
+# Find a customer
+client.customers.find(id: "C2188C26")
+```
+
+### Accounts
+
+```rb
+# Find an account
+client.accounts.find(id: "A2188C26")
+
+# Create an account
+client.accounts.create(customer_id: "C2188C26", currency: "EUR", product_code: "YOUR_PRODUCT_CODE", external_reference: "My new account")
+```
+
+### Payments
+
+```rb
+# Find a payment
+client.payments.find(id: "P210FFT5AW")
+
+# List payments
+client.payments.list(from: DateTime.now - 1, to: DateTime.now)
+
+# Create a payment
+client.payments.create(account_id: "A2188C26", currency: "EUR", amount: 0.01, destination: { type: "IBAN", iban: "ES8601280011390100072676", name: "Aitor García Rey" }, reference: "The reference")
+```
+
+### Notifications
+
+### Supported event types per channel
+
+Not all notifications can be sent to any channel. Check the following list for a quick view and the [original](https://modulr.readme.io/docs/notifications-1) reference for an up-to-date list
+
+Supported via webhook:
+
+- ACCOUNT_SWITCH_UPDATE
+- DDMANDATE
+- DD_FAILED_CLAIM
+- DD_FUNDS_RETURNED
+- DD_INCOMING_DEBIT
+- DD_COLLECTION_STATUS
+- PAYIN
+- PAYOUT
+- UPCOMING_CREDIT
+- UPCOMING_COLLECTION_CREDIT
+- UPCOMING_COLLECTION_DEBIT
+- PAYMENT_COMPLIANCE_STATUS
+- PAYMENT_FILE_UPLOAD
 
-## Development
+Supported via email:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- ACCOUNT_STATEMENT
+- PENDING_PAYMENTS
+- BALANCE
+- CUSTVSTAT
+
+## Release
+
+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:
+
+```git
+git tag vx.x.x main
+git push origin vx.x.x
+```
+
+The tagging will trigger the GitHub action defined in `release.yml`, pushing the gem to [rubygems.org](https://rubygems.org).
+
+## Tooling for manual API testing
+
+We have a tooling system based on HTTP request files which allow developers to run pre-format Modulr API requests easily. These HTTP request files are stored inside `doc/modulr_requests` directory. Find the service you want to run and run the specific HTTP file to execute the request locally.
+
+We run these requests locally from our favorite IDEs, in our case, we use ([IntelliJ](https://www.jetbrains.com/es-es/idea/) or [VS Code](https://code.visualstudio.com/)). [IntelliJ](https://www.jetbrains.com/es-es/idea/) has a native feature that allows you to run these requests easily but if you are using [VS Code](https://code.visualstudio.com/) you will need to install the following extension [httpYac](https://marketplace.visualstudio.com/items?itemName=anweber.vscode-httpyac).
+
+To configure the HTTP files system create a new `modulr-ruby/doc/modulr_requests/http-client.private.env.json` from `modulr-ruby/doc/modulr_requests/http-client.env.json` file.
+Configure all variables by environment and you are ready to use your HTTP files.
+
+## Testing
+
+Any change should be tested. Builds with failures would not be allowed to merge.
+To run your test suite locally using Rspec:
+
+```rb
+bundle exec rspec
+```
+
+To prepare your environment to listen for your local code changes use Guard instead:
+
+```rb
+bundle exec guard
+```
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To test services, we have a spec system that uses the [Webmock](https://github.com/bblimke/webmock) library to stub requests and checks them against service response HTTP format files.
+These HTTP files are stored in the `spec/fixtures` directory.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/devengo/modulr-ruby>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/devengo/modulr-ruby/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/devengoapp/modulr-ruby>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/devengoapp/modulr-ruby/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Modulr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/devengo/modulr-ruby/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Modulr project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/devengoapp/modulr-ruby/blob/main/CODE_OF_CONDUCT.md).

data/doc/modulr_requests/accounts/close.http

@@ -0,0 +1,4 @@
+### Accounts close
+POST {{base_url}}/accounts/{{account_id}}/close
+Content-Type: application/json
+Authorization: {{api_key}}

data/doc/modulr_requests/accounts/create.http

@@ -0,0 +1,21 @@
+### Create Account -- (201) Created
+POST {{base_url}}/customers/{{customer_id}}/accounts
+Content-Type: application/json
+Authorization: {{api_key}}
+
+{
+  "externalReference": "my_reference -1-",
+  "currency": "EUR",
+  "productCode": "O1200001"
+}
+
+### Create Account -- (400) Bad Request
+POST {{base_url}}/customers/{{customer_id}}/accounts
+Content-Type: application/json
+Authorization: {{api_key}}
+
+{
+  "externalReference": "my_reference -1-",
+  "currency": "EUR",
+  "productCode": null
+}

data/doc/modulr_requests/http-client.env.json

@@ -0,0 +1,8 @@
+{
+  "sandbox": {
+    "base_url": "https://api-sandbox.modulrfinance.com/api-sandbox-token",
+    "account_id": "account_id",
+    "api_key": "api_key",
+    "customer_id": "customer_id"
+  }
+}

data/doc/modulr_requests/transactions/history.http

@@ -0,0 +1,4 @@
+### Transactions History
+GET {{base_url}}/accounts/{{account_id}}/transactions
+Content-Type: application/json
+Authorization: {{api_key}}

data/lib/modulr/api/accounts_service.rb

@@ -3,11 +3,27 @@
 module Modulr
   module API
     class AccountsService < Service
-      def info(account_id:)
-        response = client.get("/accounts/#{account_id}")
-        puts response.body
+      def find(id:)
+        response = client.get("/accounts/#{id}")
         Resources::Accounts::Account.new(response, response.body)
       end
+
+      def create(customer_id:, currency:, product_code:, **opts)
+        payload = {
+          currency: currency,
+          productCode: product_code,
+        }
+        payload[:externalReference] = opts[:external_reference] if opts[:external_reference]
+
+        response = client.post("/customers/#{customer_id}/accounts", payload)
+        Resources::Accounts::Account.new(response, response.body)
+      end
+
+      def close(account_id:)
+        client.post("/accounts/#{account_id}/close")
+
+        nil
+      end
     end
   end
 end

data/lib/modulr/api/customers_service.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Modulr
+  module API
+    class CustomersService < Service
+      def find(id:)
+        response = client.get("/customers/#{id}")
+        Resources::Customers::Customer.new(response, response.body)
+      end
+    end
+  end
+end

data/lib/modulr/api/notifications_service.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Modulr
+  module API
+    class NotificationsService < Service
+      def find(id:, **opts)
+        response = client.get("#{base_notification_url(opts)}/notifications/#{id}")
+        Resources::Notifications::Notification.new(response, response.body)
+      end
+
+      def list(**opts)
+        response = client.get("#{base_notification_url(opts)}/notifications")
+        Resources::Notifications::Collection.new(response, response.body)
+      end
+
+      def create(type:, channel:, destinations:, config:, **opts)
+        payload = {
+          type: type,
+          channel: channel,
+          destinations: destinations,
+          config: config,
+        }
+        response = client.post("#{base_notification_url(opts)}/notifications", payload)
+        Resources::Notifications::Notification.new(response, response.body)
+      end
+
+      protected def base_notification_url(opts)
+        opts[:partner_id] ? "/partners/#{opts[:partner_id]}" : "/customers/#{opts[:customer_id]}"
+      end
+    end
+  end
+end

data/lib/modulr/api/payments_service.rb

@@ -3,30 +3,55 @@
 module Modulr
   module API
     class PaymentsService < Service
-      def create( # rubocop:disable Metrics/ParameterLists
-        account_id:,
-        currency:,
-        amount:,
-        destination:,
-        reference:,
-        options: {}
-      )
-        data = {
+      def find(id:)
+        response = client.get("/payments", { id: id })
+        payment_attributes = response.body[:content]&.first
+        raise NotFoundError, "Payment #{id} not found" unless payment_attributes
+
+        Resources::Payments::Payment.new(response, 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])
+      end
+
+      # rubocop:disable Metrics/ParameterLists
+      def create(account_id:, destination:, reference:, currency:, amount:, **opts)
+        payload = {
           sourceAccountId: account_id,
+          destination: destination,
+          reference: reference,
           currency: currency,
           amount: amount,
-          reference: reference,
-          destination: {
-            type: destination[:type],
-            iban: destination[:iban],
-            name: destination[:name],
-          },
         }
-        data[:externalReference] = options[:external_reference] if options[:external_reference]
 
-        response = client.post("/payments", data, options)
+        payload[:externalReference] = opts[:external_reference] if opts[:external_reference]
+        payload[:endToEndReference] = opts[:e2e_reference] if opts[:e2e_reference]
+
+        response = client.post("/payments", payload)
         Resources::Payments::Payment.new(response, response.body)
       end
+      # rubocop:enable Metrics/ParameterLists
+
+      # rubocop:disable Metrics/AbcSize
+      private def build_query_params(opts)
+        same_name_params = [:type, :status]
+        date_params = { to: :toCreatedDate, from: :fromCreatedDate, updated_since: :modifiedSince }
+        mapped_params = {
+          external_reference: :externalReference,
+          has_external_reference: :hasExternalReference,
+          account_id: :sourceAccountId,
+        }
+        {}.tap do |params|
+          same_name_params.each { |param| params[param] = opts[param] if opts[param] }
+          date_params.each { |original, mapped| params[mapped] = format_datetime(opts[original]) if opts[original] }
+          mapped_params.each { |original, mapped| params[mapped] = opts[original] if opts[original] }
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/modulr/api/service.rb

@@ -8,6 +8,10 @@ module Modulr
       def initialize(client)
         @client = client
       end
+
+      def format_datetime(datetime)
+        datetime.strftime("%Y-%m-%dT%l:%M:%S%z")
+      end
     end
   end
 end

data/lib/modulr/api/services.rb

@@ -3,6 +3,7 @@
 require_relative "service"
 require_relative "accounts_service"
 require_relative "payments_service"
+require_relative "transactions_service"
 
 module Modulr
   module API
@@ -11,9 +12,21 @@ module Modulr
         @services[:accounts] ||= API::AccountsService.new(self)
       end
 
+      def customers
+        @services[:customers] ||= API::CustomersService.new(self)
+      end
+
       def payments
         @services[:payments] ||= API::PaymentsService.new(self)
       end
+
+      def notifications
+        @services[:notifications] ||= API::NotificationsService.new(self)
+      end
+
+      def transactions
+        @services[:transactions] ||= API::TransactionsService.new(self)
+      end
     end
   end
 end

data/lib/modulr/api/transactions_service.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Modulr
+  module API
+    class TransactionsService < Service
+      def history(account_id:)
+        response = client.get("/accounts/#{account_id}/transactions")
+        Resources::Transactions::Transactions.new(response, response.body[:content])
+      end
+    end
+  end
+end

data/lib/modulr/client.rb

@@ -60,7 +60,9 @@ module Modulr
       uri = "#{base_url}#{path}"
 
       begin
-        connection.run_request(method, uri, request_options[:body], request_options[:headers])
+        connection.run_request(method, uri, request_options[:body], request_options[:headers]) do |request|
+          request.params.update(options) if options
+        end
       rescue StandardError => e
         handle_request_error(e)
       end
@@ -91,28 +93,22 @@ module Modulr
     end
 
     def handle_request_error(error)
+      response = error.response
       case error
       when Faraday::ClientError
-        if error.response
-          handle_error_response(error)
+        case response[:status]
+        when 403
+          raise ForbiddenError, response
+        when 404
+          raise NotFoundError, response
         else
-          handle_network_error(error)
+          raise RequestError, response
         end
       else
-        raise error
+        raise Error, response
       end
     end
 
-    def handle_error_response(error)
-      puts "Client Error: #{error.response}"
-      raise error
-    end
-
-    def handle_network_error(error)
-      puts "Network error: #{error.response}"
-      raise error
-    end
-
     def default_origin
       "Modulr/#{Modulr::VERSION} Ruby Client (Faraday/#{Faraday::VERSION})"
     end

data/lib/modulr/error.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Modulr
+  class Error < StandardError
+  end
+
+  class RequestError < Error
+    attr_reader :response, :errors
+
+    def initialize(response)
+      @response = response
+      @errors = extract_errors
+      super(message_from(response))
+    end
+
+    private def extract_errors
+      return unless json?
+
+      response[:body]
+    end
+
+    private def message_from(response)
+      return response if response.is_a?(String)
+
+      if errors
+        errors.map { |error| "#{error[:field]} #{error[:code]} #{error[:message]}" }.join(", ")
+      else
+        "#{response[:status]} #{response[:body]}"
+      end
+    end
+
+    private def json?
+      return unless response.is_a?(Hash)
+
+      content_type = response[:headers]["content-type"]
+      content_type&.start_with?("application/json")
+    end
+  end
+
+  class NotFoundError < RequestError
+  end
+
+  class ForbiddenError < RequestError
+  end
+end

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

@@ -12,11 +12,11 @@ module Modulr
           closed: "CLOSED",
           client_blocked: "CLIENT_BLOCKED",
         }.freeze
-        map :id, :id
-        map :balance, :balance
+        map :id
+        map :balance
+        map :currency
+        map :status
         map :availableBalance, :available_balance
-        map :currency, :currency
-        map :status, :status
         map :customerId, :customer_id
         map :customerName, :customer_name
         map :externalReference, :external_reference

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

@@ -4,12 +4,12 @@ module Modulr
   module Resources
     module Accounts
       class Identifier < Base
-        map :type, :type
+        map :type
+        map :iban
+        map :bic
+        map :currency
         map :accountNumber, :account_number
         map :sortCode, :sort_code
-        map :iban, :sort_code
-        map :bic, :sort_code
-        map :currency, :sort_code
         map :countrySpecificDetails, :country_details
         map :providerExtraInfo, :provider_extra_info
       end

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

@@ -3,7 +3,7 @@
 module Modulr
   module Resources
     module Accounts
-      class Identifiers < Collection
+      class Identifiers < BaseCollection
         def initialize(response, attributes_collection)
           super(response, Identifier, attributes_collection)
         end

data/lib/modulr/resources/base.rb

@@ -13,8 +13,9 @@ module Modulr
         end
       end
 
-      def self.map(original_attribute, mapped_attributes)
+      def self.map(original_attribute, mapped_attributes = nil)
         class_eval { attr_writer original_attribute.to_sym }
+        mapped_attributes ||= original_attribute
         mapped_attributes = [mapped_attributes].flatten
         mapped_attributes.each do |mapped_attribute|
           define_method(mapped_attribute) { instance_variable_get("@#{original_attribute}") }
@@ -24,6 +25,17 @@ module Modulr
   end
 end
 
-require_relative "collection"
+require_relative "base_collection"
 require_relative "accounts/account"
+require_relative "accounts/identifier"
+require_relative "accounts/identifiers"
+require_relative "customers/customer"
+require_relative "notifications/notification"
+require_relative "notifications/config"
+require_relative "notifications/collection"
 require_relative "payments/payment"
+require_relative "payments/details"
+require_relative "payments/destination"
+require_relative "payments/collection"
+require_relative "transactions/transaction"
+require_relative "transactions/collection"

data/lib/modulr/resources/{collection.rb → base_collection.rb}

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

data/lib/modulr/resources/customers/customer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Customers
+      class Customer < Base
+        map :id
+        map :name
+        map :type
+        map :status
+        map :verificationStatus, :verification_status
+        map :companyRegNumber, :taxid
+        map :expectedMonthlySpend, :expected_monthly_spend
+        map :partnerId, :partner_id
+        map :industryCode, :industry_code
+        map :tcsVersion, :tcs_version
+        map :externalReference, :external_reference
+        map :createdDate, :created_at
+        map :holdPaymentsForFunds, :hold_payments_for_funds
+        map :cardConstraintsBid, :card_constraints_bid
+        map :needAddressVerification, :need_address_verification
+        map :accessGroupsVisible, :access_groups_visible
+        map :legalEntity, :legal_entity
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Notifications
+      class Collection < BaseCollection
+        def initialize(response, attributes_collection)
+          super(response, Notification, attributes_collection)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Notifications
+      class Config < Base
+        map :retry
+        map :secret
+        map :hmacAlgorithm, :hmac_algorithm
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Notifications
+      class Notification < Base
+        attr_reader :config
+
+        map :id
+        map :type
+        map :channel
+        map :status
+        map :destinations
+
+        def initialize(response, attributes = {})
+          super(response, attributes)
+          @config = Config.new(response, attributes[:config])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Payments
+      class Collection < BaseCollection
+        def initialize(response, attributes_collection)
+          super(response, Payment, attributes_collection)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Payments
+      class Destination < Base
+        map :type
+        map :iban
+        map :name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# 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

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

@@ -4,9 +4,19 @@ module Modulr
   module Resources
     module Payments
       class Payment < Base
+        attr_reader :details
+
         map :id, [:id, :payment_reference_id]
-        map :status, :status
+        map :status
+        map :reference
         map :externalReference, :external_reference
+        map :createdDate, :created_at
+        map :approvalStatus, :approval_status
+
+        def initialize(response, attributes = {})
+          super(response, attributes)
+          @details = Details.new(response, attributes[:details])
+        end
       end
     end
   end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Transactions
+      class Transactions < BaseCollection
+        def initialize(response, attributes_collection)
+          super(response, Transaction, attributes_collection)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Transactions
+      class Transaction < Base
+        attr_reader :balance, :available_balance
+
+        map :id
+        map :amount
+        map :currency
+        map :description
+        map :credit
+        map :type
+        map :transactionDate, :created_at
+        map :postedDate, :posted_date
+        map :sourceId, :source_id
+        map :sourceExternalReference, :external_reference
+        map :additionalInfo, :additional_info
+
+        def initialize(response, attributes = {})
+          super(response, attributes)
+
+          @balance = attributes[:account][:balance]
+          @available_balance = attributes[:account][:availableBalance]
+        end
+      end
+    end
+  end
+end

data/lib/modulr/version.rb

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

data/lib/modulr.rb

@@ -3,8 +3,15 @@
 require_relative "modulr/version"
 
 require_relative "modulr/auth/signature"
-require_relative "modulr/client"
 
-module Modulr
-  class Error < StandardError; end
-end
+require_relative "modulr/api/service"
+require_relative "modulr/api/services"
+require_relative "modulr/api/accounts_service"
+require_relative "modulr/api/customers_service"
+require_relative "modulr/api/payments_service"
+require_relative "modulr/api/notifications_service"
+
+require_relative "modulr/resources/base"
+
+require_relative "modulr/error"
+require_relative "modulr/client"

data/modulr.gemspec

@@ -27,12 +27,14 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  # spec.bindir = "exe"
+  spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday", "~> 1.0"
   spec.add_dependency "faraday_middleware", "~> 1.0"
+  spec.add_development_dependency "guard", "~> 2.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.0"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "~> 1.0"
@@ -40,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-rake", "~> 0.1"
   spec.add_development_dependency "rubocop-rspec", "~> 2.0"
   spec.add_development_dependency "test-prof", "~> 1.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulr-api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.11
 platform: ruby
 authors:
 - Aitor García Rey
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Ruby client for Modulr Finance API.
 email:
 - aitor@devengo.com
@@ -150,24 +192,42 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- doc/modulr_requests/accounts/close.http
+- doc/modulr_requests/accounts/create.http
+- doc/modulr_requests/http-client.env.json
+- doc/modulr_requests/transactions/history.http
 - lib/modulr.rb
 - lib/modulr/api/accounts_service.rb
+- lib/modulr/api/customers_service.rb
+- lib/modulr/api/notifications_service.rb
 - lib/modulr/api/payments_service.rb
 - lib/modulr/api/service.rb
 - lib/modulr/api/services.rb
+- lib/modulr/api/transactions_service.rb
 - lib/modulr/auth/signature.rb
 - lib/modulr/client.rb
+- lib/modulr/error.rb
 - lib/modulr/resources/accounts/account.rb
 - lib/modulr/resources/accounts/identifier.rb
 - lib/modulr/resources/accounts/identifiers.rb
 - lib/modulr/resources/base.rb
-- lib/modulr/resources/collection.rb
+- lib/modulr/resources/base_collection.rb
+- lib/modulr/resources/customers/customer.rb
+- lib/modulr/resources/notifications/collection.rb
+- lib/modulr/resources/notifications/config.rb
+- lib/modulr/resources/notifications/notification.rb
+- lib/modulr/resources/payments/collection.rb
+- lib/modulr/resources/payments/destination.rb
+- lib/modulr/resources/payments/details.rb
 - lib/modulr/resources/payments/payment.rb
+- lib/modulr/resources/transactions/collection.rb
+- lib/modulr/resources/transactions/transaction.rb
 - lib/modulr/version.rb
 - modulr.gemspec
 - sig/modulr.rbs
@@ -194,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby client for Modulr Finance API.