bloom_remit_client 0.15.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e3d3eb4e19e4f0df31b5199543356abe637ac2c
-  data.tar.gz: d4ae32bcd68390aeadc409f8d1bf0001f4216e47
+SHA256:
+  metadata.gz: 22bca419858375c58c67060d10b221c404dfb69e5edaa78561106647273d8590
+  data.tar.gz: d8de77bc7e9205a5a4048b5c39f5b6d55d623dc5957685bf60ea4525390f4f03
 SHA512:
-  metadata.gz: 4bb2d94df2377fde8b3316aebfc25807688c9b8b10e809adcf478fb01a2c60e6b063587dd3df12bc07e4d1d3ba466510af12389c796d5c7b672ca5187a954a66
-  data.tar.gz: abc4eb600379b1ea90900c1356a52043d1cb48bd91309b7b4d9c901a715836557cff9f5c7835b7a06aa3cf912f5f87a13bff46fbb98b785037e855df9e93a943
+  metadata.gz: 3a6ca007f405f223d7d9c3f1d7b78166b28525e2de8d30b5bc47e4f179c87312a639737b752f481ab288db867ee2b9af37babf080fbe773617f45915cd0695b1
+  data.tar.gz: 5e28b826243ab762b174d31900a2a7355853259c2ebb71b30c7ae480e267e661c8b1c541a4109062fd4e5599cbfb91044e07783fdb680a3297e9d8107cee69e7

data/.github/workflows/push.yml

@@ -0,0 +1,27 @@
+name: Ruby Gem
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Bundle install
+      run: bundle install
+    - name: Copy spec config
+      run: cp spec/config.yml{.sample,}
+    - name: Run tests
+      run: bundle exec rspec

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.1
+ruby-2.7.2

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.17.1] - 2021-02-03
+### Added
+- Add `create_txn#errors` to easily access errors
+
+## [0.17.0] - 2021-02-01
+### Added
+- `#get_deposit_targets` to list all deposit targets
+
+## [0.16.2] - 2021-01-26
+### Changed
+- `CreateTxnPreviewResponse#errors` change from `Hash` to `Array`
+
+## [0.16.1] - 2021-01-19
+### Changed
+- Allow nil for both `partner_id` and `api_secret
+
+## [0.16.0] - 2021-01-18
+### Changed
+- Removed all API methods (complete overhaul)
+
+### Added
+- `#create_txn` to create transactions
+- `#create_txn_preview` to determine fees, eta, and max amount of a transaction
+
 ## [0.15.0] - 2017-04-26
 ### Changed
 - Production domain is now `www.bloomremit.net`

data/Gemfile

@@ -5,4 +5,5 @@ gemspec
 
 gem "pry"
 gem "pry-byebug"
-gem "virtus-matchers", github: "g5/virtus-matchers"
+
+gem "message_bus_client_worker", github: "bloom-solutions/message_bus_client_worker", branch: "feat-subscribe"

data/README.md

@@ -22,6 +22,67 @@ Or install it yourself as:
 
 See `spec/functional` for examples.
 
+To subscribe to transaction updates, configure the following (in an initializer if you're using Rails):
+
+```ruby
+MessageBusClientWorker.configure do |c|
+  c.subscriptions = {
+    "https://bloomremit.net" => {
+      headers: {
+        # TOKEN here is a Base64.strict_encode64 string composed of
+        # your PARTNER_ID and API_SECRET joined by a colon character
+        "Authorization" => "Basic #{TOKEN}"
+      },
+      channels: {
+        "/v2/txns" => { processor: "ProcessBloomRemitTxnUpdate" },
+      }
+    },
+  }
+
+  # Consider changing MessageBusClientWorker to incrementally add subscriptions
+  # and not overwrite like above. Warn if a host is already defined.
+  # If we do this, then we can add a helper method to this gem, that adds the sub:
+  # BloomRemitClient.configure do |c|
+  #   c.partner_id = ENV["BLOOM_REMIT_PARTNER_ID"]
+  #   c.api_secret = ENV["BLOOM_REMIT_API_SECRET"]
+  #   c.on_txn_update = "ProcessBloomRemitTxnUpdate" # setting this will trigger the MBCW subscription
+  # end
+  c.subscribe(
+    "https://bloomremit.net" => {
+      headers: { "Authorization" => "Basic #{TOKEN}" },
+      channels: {
+        "/v2/txns" => { processor: "ProcessBloomRemitTxnUpdate" },
+      }
+    },
+  )
+end
+```
+
+```ruby
+BloomRemitClient.configure do |c|
+  c.partner_id = ENV["BLOOM_REMIT_PARTNER_ID"]
+  c.api_secret = ENV["BLOOM_REMIT_API_SECRET"]
+  c.on_txn_update = "ProcessBloomRemitTxnUpdate"
+end
+
+BloomRemitClient.configure_message_bus_client_worker!
+```
+
+Make sure `MessageBusClientWorker` (the gem used underneath this gem) is enqueued at an interval, so your app will continually fetch updates. See [Staying subscribed](https://github.com/bloom-solutions/message_bus_client_worker#staying-subscribed) in MessageBusClientWorker. Note that you will need to have Sidekiq for `MessageBusClientWorker` to function.
+
+Somewhere in your app, define `ProcessBloomRemitTxnUpdates` to update your own database:
+
+```ruby
+class ProcessBloomRemitTxnUpdates
+  def self.call(remote_txn)
+    # remote_txn passed to you is an instance of BloomRemitClient::Txn model
+    if withdrawal = Withdrawal.find_by(id: remote_txn.client_external_id)
+      withdrawal.update(status: remote_txn.status)
+    end
+  end
+end
+```
+
 ## Factories
 
 To make testing easier, you may `require 'bloom_remit_client/factories'` in your app.

data/bloom_remit_client.gemspec

@@ -26,17 +26,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activemodel"
   spec.add_dependency "activesupport"
-  spec.add_dependency "httparty"
-  spec.add_dependency "addressable"
+  spec.add_dependency "api_client_base"
+  spec.add_dependency "typhoeus"
+  spec.add_dependency "message_bus_client_worker"
 
-  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency 'faker'
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "dotenv"
-  spec.add_development_dependency "shoulda-matchers"
+  spec.add_development_dependency "virtus-matchers"
 end

data/lib/bloom_remit_client.rb

@@ -1,66 +1,59 @@
 # frozen_string_literal: true
-require 'virtus'
-require 'httparty'
-require 'active_model'
+require "api_client_base"
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/object/try'
+require "message_bus_client_worker"
 require 'bloom_remit_client/coercers/indifferent_hash'
-require 'bloom_remit_client/coercers/path'
-require 'bloom_remit_client/concerns/has_base_authentification'
 require "bloom_remit_client/version"
 require "bloom_remit_client/client"
-require "bloom_remit_client/models/biller"
-require "bloom_remit_client/models/deposit_strategy"
-require "bloom_remit_client/models/user"
-require "bloom_remit_client/models/payment"
-require "bloom_remit_client/models/remittance"
-require "bloom_remit_client/models/credit"
-require "bloom_remit_client/models/recipient"
+require "bloom_remit_client/models/txn"
+require "bloom_remit_client/models/txn_preview"
+require "bloom_remit_client/models/deposit_target"
 require "bloom_remit_client/requests"
-require "bloom_remit_client/requests/url_builder"
-require "bloom_remit_client/requests/requests_sender"
-require "bloom_remit_client/requests/base"
-require "bloom_remit_client/requests/credit/list"
-require "bloom_remit_client/requests/credit/history"
-require "bloom_remit_client/requests/rate/show"
-require "bloom_remit_client/requests/billers/list"
-require "bloom_remit_client/requests/deposit_strategies/list"
-require "bloom_remit_client/requests/senders/create"
-require "bloom_remit_client/requests/payments/create"
-require "bloom_remit_client/requests/remittances/create"
-require "bloom_remit_client/requests/recipients/create"
-require "bloom_remit_client/requests/recipients/list"
-require "bloom_remit_client/requests/remittances/calculate"
-require "bloom_remit_client/requests/txns/create"
-require "bloom_remit_client/responses/base"
-require "bloom_remit_client/responses/billers/list"
-require "bloom_remit_client/responses/deposit_strategies/list"
-require "bloom_remit_client/responses/senders/create"
-require "bloom_remit_client/responses/payments/create"
-require "bloom_remit_client/responses/remittances/create"
-require "bloom_remit_client/responses/recipients/create"
-require "bloom_remit_client/responses/recipients/list"
-require "bloom_remit_client/responses/remittances/calculate"
-require "bloom_remit_client/responses/txns/create"
+require "bloom_remit_client/requests/base_request"
+require "bloom_remit_client/requests/create_txn_request"
+require "bloom_remit_client/requests/create_txn_preview_request"
+require "bloom_remit_client/requests/get_deposit_targets_request"
+require "bloom_remit_client/responses/base_response"
+require "bloom_remit_client/responses/create_txn_response"
+require "bloom_remit_client/responses/create_txn_preview_response"
+require "bloom_remit_client/responses/get_deposit_targets_response"
 
 module BloomRemitClient
-  PRODUCTION = 'www.bloomremit.net'
-  STAGING = 'staging.bloomremit.net'
 
-  class << self
-    attr_accessor :host
-    attr_accessor :sandbox
+  PRODUCTION = 'https://www.bloomremit.net'
+  STAGING = 'https://staging.bloomremit.net'
 
-    def new(args={})
-      client_args = {}
-      client_args[:host] = self.host if self.host.present?
-      client_args[:sandbox] = self.sandbox if self.sandbox.present?
-      client_args.merge!(args)
+  include APIClientBase::Base.module
 
-      client = Client.new(client_args)
-      raise ArgumentError, client.errors.full_messages if client.invalid?
-      client
+  TXN_UPDATES_CHANNEL = "/v2/txns".freeze
+
+  with_configuration do
+    has :host, classes: String, default: STAGING
+    has :partner_id, classes: [String, NilClass]
+    has :api_secret, classes: [String, NilClass]
+    has :on_txn_update, classes: [String, NilClass]
+  end
+
+  def self.configure_message_bus_client_worker!
+    if configuration.on_txn_update.blank?
+      fail "`on_txn_update` must be defined"
     end
 
+    token = [
+      configuration.partner_id,
+      configuration.api_secret,
+    ].join(":")
+    token = Base64.strict_encode64(token)
+
+    MessageBusClientWorker.subscribe(configuration.host, {
+      headers: {
+        "HTTP_AUTHORIZATION" => "Basic #{token}"
+      },
+      channels: {
+        TXN_UPDATES_CHANNEL => { processor: configuration.on_txn_update },
+      }
+    })
   end
+
 end

data/lib/bloom_remit_client/client.rb

@@ -1,144 +1,18 @@
 # frozen_string_literal: true
 module BloomRemitClient
   class Client
-    include Virtus.model
-    include ActiveModel::Validations
+    include APIClientBase::Client.module(default_opts: :default_opts)
 
-    attribute :api_token, String
+    attribute :partner_id, String
     attribute :api_secret, String
-    attribute :agent_id, String
     attribute :host, String, lazy: true, default: :default_host
-    attribute :sandbox, Boolean, default: true
 
-    validates :host, presence: true
-    validates :sandbox, inclusion: { in: [true, false] }
+    api_action :create_txn
+    api_action :create_txn_preview
+    api_action :get_deposit_targets
 
-    # GET
-    # /api/v1/partners/:api_token/credits
-    # Parameters: none
-    def credits(params = {})
-      request_params = params.merge(access_params)
-      request = Requests::Credit::List.new(request_params)
-      request.call!
-    end
-
-    # GET
-    # /api/v1/partners/:api_token/credits/history
-    # Parameters: none
-    def credits_history(params = {})
-      request_params = params.merge(access_params)
-      request = Requests::Credit::History.new(request_params)
-      request.call!
-    end
-
-    # GET
-    # /api/v1/rates
-    # Parameters:
-    #   partner_id:
-    #     String, required
-    #     API token
-    #   api_secret:
-    #     String, required
-    #   currency:
-    #     One of: [USDPHP, USDUSD, USDKRW, USDAUD, USDCAD, USDJPY, USDNZD, USDSGD, USDHKD,
-    #              USDCNY, USDEUR, USDVND, USDSAR, USDTWD, USDQAR, USDKWD, USDAED, USDGBP,
-    #              USDMYR, USDINR, USDIDR, USDBTC],
-    #     optional
-    def rates(params = {})
-      request_params = params.merge(access_params)
-      request = Requests::Rate::Show.new(request_params)
-      request.call!
-    end
-
-    def billers(params={})
-      request_params = params.merge(access_params)
-      request = Requests::Billers::List.new(request_params)
-      raw_response = request.call!
-      Responses::Billers::List.new(raw_response: raw_response)
-    end
-
-    def create_sender(sender_params={})
-      params = {sender: sender_params}
-      request_params = params.merge(default_params).merge(access_params)
-      request = Requests::Senders::Create.new(request_params)
-      raw_response = request.call!
-      Responses::Senders::Create.new(raw_response: raw_response)
-    end
-
-    def create_payment(payment_params={})
-      params = {payment: payment_params}.
-        merge(sender_id: payment_params[:sender_id])
-      request_params = params.merge(default_params).merge(access_params)
-      request = Requests::Payments::Create.new(request_params)
-      raw_response = request.call!
-      Responses::Payments::Create.new(raw_response: raw_response)
-    end
-
-    def create_recipient(recipient_params={})
-      params = {recipient: recipient_params}.
-        merge(sender_id: recipient_params[:sender_id])
-      request_params = params.merge(default_params).merge(access_params)
-      request = Requests::Recipients::Create.new(request_params)
-      raw_response = request.call!
-      Responses::Recipients::Create.new(raw_response: raw_response)
-    end
-
-    def recipient_list(recipient_params={})
-      request_params = recipient_params.merge(access_params)
-      request = Requests::Recipients::List.new(request_params)
-      raw_response = request.call!
-      Responses::Recipients::List.new(raw_response: raw_response)
-    end
-
-    def create_remittance(remittance_params={})
-      params = {remittance: remittance_params}.
-        merge(sender_id: remittance_params[:sender_id]).
-        merge(recipient_id: remittance_params[:recipient_id])
-      request_params = params.merge(default_params).merge(access_params)
-      request = Requests::Remittances::Create.new(request_params)
-      raw_response = request.call!
-      Responses::Remittances::Create.new(raw_response: raw_response)
-    end
-
-    def calculate_remittance(calculate_params={})
-      params = access_params.merge(calculate_params)
-      request = Requests::Remittances::Calculate.new(params)
-      raw_response = request.call!
-      Responses::Remittances::Calculate.new(raw_response: raw_response)
-    end
-
-    def deposit_strategies_list
-      request_params = access_params
-      request = Requests::DepositStrategies::List.new(request_params)
-      raw_response = request.call!
-      Responses::DepositStrategies::List.new(raw_response: raw_response)
-    end
-
-    def create_txn(txn_params={})
-      params = {txn: txn_params}.merge(
-        sender_id: txn_params[:sender_id],
-        recipient_id: txn_params[:recipient_id],
-      )
-      request_params = params.merge(default_params).merge(access_params)
-      request = Requests::Txns::Create.new(request_params)
-      raw_response = request.call!
-      Responses::Txns::Create.new(raw_response: raw_response)
-    end
-
-    private
-
-    # Should overwrite any other `:api_token`, `:api_secret`
-    def access_params
-      @access_params ||= attributes.slice(:host, :api_token, :api_secret)
-    end
-
-    def default_params
-      @default_params ||= attributes.slice(:agent_id)
-    end
-
-    def default_host
-      return BloomRemitClient::STAGING if self.sandbox.nil? || self.sandbox
-      BloomRemitClient::PRODUCTION
+    def default_opts
+      { host: host, partner_id: partner_id, api_secret: api_secret }
     end
 
   end

data/lib/bloom_remit_client/models/deposit_target.rb

@@ -0,0 +1,23 @@
+module BloomRemitClient
+  class DepositTarget
+
+    include Virtus.model
+
+    attribute :slug, String
+    attribute :name, String
+    attribute :active, Boolean
+    attribute :wait_time, String
+    attribute :support_line, String
+    attribute :sameday_cutoff, Integer
+    attribute :maximum, BigDecimal
+    attribute :availability, Array
+    attribute :availability_daynames, String
+    attribute :currencies, Array
+    attribute :required_fields, Array
+    attribute :type, String
+    attribute :iso_code, String
+    attribute :data, Hash
+    attribute :country, String
+
+  end
+end