modulr-api 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da666a42d86736ca6e0931a62e30672d57a7ab332de197e0bc83bf9a8e5bc175
-  data.tar.gz: 3b956f72365027d8990693d8e071d825e7a940f103c00eaacd0db68d4edaf433
+  metadata.gz: aab231f807a74a8bcbfa325435643cc639e6a5dc546f756dff2c8632044c5f83
+  data.tar.gz: dca07503d073c6d48f7556b5ede035cf1c596ac535774fe33409d9fbd3c61f86
 SHA512:
-  metadata.gz: 37c00f76260c63cd0e2b6035161a61324c65b53497e60c580e46f253982435f9c0825480c3945a5e7ccf86fadc674cee17dae46ccb6dc4d5e9e1d5fd5316c06f
-  data.tar.gz: 3adf0008186b638ddd479c4d0ec281f40393a492238c5eae022594c99f0d8c047ac87ce0c225deeb7db13fff893f0d1c983bf612679f3944c2469f47a6eb96ef
+  metadata.gz: 8cdaa03c41360d271822cfe63117e8559341686902a76861fec81eb8de8349558450f5a14e8f08d77842eb62cd1002697310ef761acde375bc8529eea689d9ef
+  data.tar.gz: 4797ea33e24b82ea71273b795e3e6e579c58fb203407d25d255e2e72ec41f3b9bcfd39885fc1bd3d080b7ee692a2d6ffb20ee4746adab4543c5b4794f8c66b23

data/Gemfile.lock

@@ -1,16 +1,21 @@
 PATH
   remote: .
   specs:
-    modulr-api (0.0.5)
+    modulr-api (0.0.6)
       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.2)
       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)
+    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.2.3)
+    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,15 @@
-# 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.
+Ruby client for Modulr (cf. <https://modulr.readme.io/docs>)
 
-TODO: Delete this and the text above, and describe your gem
+Run `bin/console` for an interactive prompt to experiment with the code.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'modulr-api'
+gem "modulr-api"
 ```
 
 And then execute:
@@ -24,24 +24,54 @@ Or install it yourself as:
 gem install modulr-api
 ```
 
-## Usage
+## Release
 
-TODO: Write usage instructions here
+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.
 
-## Development
+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:
 
-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.
+```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
+
+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:
+
+```ruby
+bundle exec rspec
+```
+
+To prepare your environment to listen for your local code changes use Guard instead:
+
+```ruby
+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,9 +3,24 @@
 module Modulr
   module API
     class AccountsService < Service
+      def create(customer_id:, currency:, product_code:, options: {})
+        data = {
+          currency: currency,
+          productCode: product_code,
+        }
+        data[:externalReference] = options[:external_reference] if options[:external_reference]
+        response = client.post("/customers/#{customer_id}/accounts", data, options)
+        Resources::Accounts::Account.new(response, response.body)
+      end
+
+      def close(account_id:)
+        client.post("/accounts/#{account_id}/close")
+
+        nil
+      end
+
       def info(account_id:)
         response = client.get("/accounts/#{account_id}")
-        puts response.body
         Resources::Accounts::Account.new(response, response.body)
       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
@@ -14,6 +15,10 @@ module Modulr
       def payments
         @services[:payments] ||= API::PaymentsService.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/resources/accounts/identifier.rb

@@ -7,9 +7,9 @@ module Modulr
         map :type, :type
         map :accountNumber, :account_number
         map :sortCode, :sort_code
-        map :iban, :sort_code
-        map :bic, :sort_code
-        map :currency, :sort_code
+        map :iban, :iban
+        map :bic, :bic
+        map :currency, :currency
         map :countrySpecificDetails, :country_details
         map :providerExtraInfo, :provider_extra_info
       end

data/lib/modulr/resources/base.rb

@@ -26,4 +26,8 @@ end
 
 require_relative "collection"
 require_relative "accounts/account"
+require_relative "accounts/identifier"
+require_relative "accounts/identifiers"
 require_relative "payments/payment"
+require_relative "transactions/transactions"
+require_relative "transactions/transaction"

data/lib/modulr/resources/collection.rb

@@ -9,7 +9,7 @@ module Modulr
       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/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, :id
+        map :amount, :amount
+        map :currency, :currency
+        map :description, :description
+        map :transactionDate, :created_at
+        map :postedDate, :date
+        map :credit, :credit
+        map :type, :type
+        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/resources/transactions/transactions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Modulr
+  module Resources
+    module Transactions
+      class Transactions < Collection
+        def initialize(response, attributes_collection)
+          super(response, Transaction, attributes_collection)
+        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.6"
 end

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.6
 platform: ruby
 authors:
 - Aitor García Rey
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2022-08-26 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,16 +192,22 @@ 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/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/resources/accounts/account.rb
@@ -168,6 +216,8 @@ files:
 - lib/modulr/resources/base.rb
 - lib/modulr/resources/collection.rb
 - lib/modulr/resources/payments/payment.rb
+- lib/modulr/resources/transactions/transaction.rb
+- lib/modulr/resources/transactions/transactions.rb
 - lib/modulr/version.rb
 - modulr.gemspec
 - sig/modulr.rbs