bloom_remit2 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bloom_remit2"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bloom_remit2.gemspec

@@ -0,0 +1,39 @@
+require_relative 'lib/bloom_remit2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bloom_remit2"
+  spec.version       = BloomRemit2::VERSION
+  spec.authors       = ["Xavi Ablaza"]
+  spec.email         = ["xlablaza@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for BloomRemit's API}
+  spec.homepage      = "https://github.com/makisu/bloom_remit2"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/makisu/bloom_remit2"
+  spec.metadata["changelog_uri"] = "https://github.com/makisu/bloom_remit2/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'gem_config'
+  spec.add_dependency 'httparty'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "prettier"
+end

data/lib/bloom_remit2.rb

@@ -0,0 +1,19 @@
+require 'gem_config'
+require 'bloom_remit2/version'
+require 'bloom_remit2/client'
+require 'bloom_remit2/partner'
+require 'bloom_remit2/agent'
+require 'bloom_remit2/credit'
+require 'bloom_remit2/rate'
+require 'bloom_remit2/sender'
+require 'bloom_remit2/recipient'
+require 'bloom_remit2/remittance'
+
+module BloomRemit2
+  include GemConfig::Base
+
+  with_configuration do
+    has :api_token, classes: String
+    has :api_secret_key, classes: String
+  end
+end

data/lib/bloom_remit2/agent.rb

@@ -0,0 +1,84 @@
+module BloomRemit2
+  class Agent
+    class << self
+      # Show a list of agents belonging to this partner
+      def list
+        agents = Client.get(path)
+        agents.map do |agent|
+          agent = agent.with_indifferent_access
+          new(
+            agent[:id],
+            agent[:name],
+            agent[:deleted_at]
+          )
+        end
+      end
+
+      # Show an agent belonging to this partner
+      # @param id [String] agent uuid to retrieve details for
+      def retrieve(id)
+        agent = Client.get("#{path}/#{id}").with_indifferent_access
+        new(
+          agent[:id],
+          agent[:name]
+        )
+      end
+
+      # Create a new agent under this partner
+      # @param name [String] agent name
+      def create(name)
+        agent = Client.post(path, { agent: { name: name }}).with_indifferent_access
+        new(
+          agent[:id],
+          agent[:name]
+        )
+      end
+
+      # TODO: Doesn't work at the moment
+      # Update the attributes of an agent belonging to this partner
+      # @param agent_id [String] agent uuid to update details for
+      # @param name [String]
+      # def update(agent_id, name:)
+      #   result = Client.put(path, { agent: { name: name }})
+      #   agent = JSON.parse(result).with_indifferent_access
+      #   new(
+      #     agent[:id],
+      #     agent[:name]
+      #   ) 
+      # end
+
+      # Delete an agent belonging to this partner
+      # @param agent_id [String] agent uuid to delete
+      def delete(agent_id)
+        message = Client.delete("#{path}/#{agent_id}").with_indifferent_access
+        if message[:success] == "We've successfully deleted that agent."
+          new(
+            agent_id,
+            nil,
+            deleted: true
+          )
+        end
+      end
+
+      private
+
+      def path
+        "api/v1/partners/#{BloomRemit2.configuration.api_token}/agents"
+      end
+    end
+
+    attr_reader :id, :name, :deleted_at, :deleted
+
+    def initialize(
+      id,
+      name,
+      deleted_at=nil,
+      deleted: false
+    )
+      @id = id
+      @name = name
+      @deleted_at = deleted_at
+      @deleted = deleted
+    end
+  end
+end

data/lib/bloom_remit2/client.rb

@@ -0,0 +1,59 @@
+require 'httparty'
+
+module BloomRemit2
+  class Client
+    class << self
+      def get(path, headers = default_get_headers, query: {})
+        HTTParty.get(url(path), { query: query, headers: headers })
+      end
+
+      def post(path, body = {}, headers = default_post_headers)
+        HTTParty.post(url(path), { body: body.to_json, headers: headers })
+      end
+
+      def put(path, body = [], headers = default_put_headers)
+        HTTParty.put(url(path), { body: URI.encode_www_form(body), headers: headers })
+      end
+
+      def delete(path, headers = default_get_headers)
+        HTTParty.delete(url(path), { headers: headers })
+      end
+
+      private
+
+      def base_url
+        'https://www.bloomremit.net'
+      end
+
+      def url(path)
+        "#{base_url}/#{path}"
+      end
+
+      def api_secret_key
+        BloomRemit2.configuration.api_secret_key
+      end
+
+      def default_get_headers
+        {
+          'x-api-secret' => api_secret_key,
+          'cache-control' => 'no-cache'
+        }
+      end
+
+      def default_put_headers
+        {
+          'x-api-secret' => api_secret_key,
+          'content-type' => 'application/x-www-form-urlencoded'
+        }
+      end
+
+      def default_post_headers
+        default_get_headers.merge!(
+          {
+            'content-type' => 'application/json'
+          }
+        )
+      end
+    end
+  end
+end

data/lib/bloom_remit2/credit.rb

@@ -0,0 +1,69 @@
+module BloomRemit2
+  class Credit
+    class << self
+      # Show a list of credit transactions
+      #
+      # Grabs a list of the most recent 100 credit transactions associated with this vendor account.
+      # Transactions that add to your credit will have the boolean 'consumed' set to 'false',
+      # and transactions that use up your credit (i.e., to pay for remittances) will have it set to 'true'.
+      def history
+        credits = Client.get("#{path}/history")
+        credits.map do |credit|
+          new(
+            credit['amount_in_php'],
+            credit['balance'],
+            credit['consumed'],
+            credit['created_at'],
+            credit['id'],
+            credit['item_id'],
+            credit['item_type'],
+            credit['rate'],
+            credit['source_amount'],
+            credit['source_currency'],
+            credit['target_amount'],
+            credit['target_currency'],
+            credit['updated_at']
+          )
+        end
+      end
+
+      private
+
+      def path
+        "api/v1/partners/#{BloomRemit2.configuration.api_token}/credits"
+      end
+    end
+
+    attr_reader :amount_in_php, :balance, :consumed, :created_at, :id, :item_id, :item_type, :rate, :source_amount, :source_currency, :target_amount, :target_currency, :updated_at
+
+    def initialize(
+      amount_in_php,
+      balance,
+      consumed,
+      created_at,
+      id,
+      item_id,
+      item_type,
+      rate,
+      source_amount,
+      source_currency,
+      target_amount,
+      target_currency,
+      updated_at
+    )
+      @amount_in_php = amount_in_php
+      @balance = balance
+      @consumed = consumed
+      @created_at = created_at
+      @id = id
+      @item_id = item_id
+      @item_type = item_type
+      @rate = rate
+      @source_amount = source_amount
+      @source_currency = source_currency
+      @target_amount = target_amount
+      @target_currency = target_currency
+      @updated_at = updated_at
+    end
+  end
+end

data/lib/bloom_remit2/partner.rb

@@ -0,0 +1,80 @@
+module BloomRemit2
+  class Partner
+    class << self
+      def retrieve
+        response = Client.get(path).with_indifferent_access
+        new(
+          response[:id],
+          response[:name],
+          response[:slug],
+          response[:domain],
+          response[:active],
+          response[:orig_currency],
+          response[:dest_currency],
+          response[:min_amount_in_orig_currency],
+          response[:max_amount_in_orig_currency],
+          response[:website],
+          response[:zip_code],
+          response[:country],
+          response[:phone],
+          response[:email],
+          response[:flat_fee_in_orig_currency],
+          response[:forex_margin],
+          response[:agent_ids],
+          response[:credit_in_php],
+          response[:credit_in_vnd]
+        )
+      end
+
+      private
+
+      def path
+        "api/v1/partners/#{BloomRemit2.configuration.api_token}"
+      end
+    end
+
+    attr_reader :id, :name, :slug, :domain, :active, :orig_currency, :dest_currency, :min_amount_in_orig_currency, :max_amount_in_orig_currency, :website, :zip_code, :country, :phone, :email, :flat_fee_in_orig_currency, :forex_margin, :agent_ids, :credit_in_php, :credit_in_vnd
+
+    def initialize(
+      id,
+      name,
+      slug,
+      domain,
+      active,
+      orig_currency,
+      dest_currency,
+      min_amount_in_orig_currency,
+      max_amount_in_orig_currency,
+      website,
+      zip_code,
+      country,
+      phone,
+      email,
+      flat_fee_in_orig_currency,
+      forex_margin,
+      agent_ids,
+      credit_in_php,
+      credit_in_vnd
+    )
+      @id = id
+      @name = name
+      @slug = slug
+      @domain = domain
+      @active = active
+      @orig_currency = orig_currency
+      @dest_currency = dest_currency
+      @min_amount_in_orig_currency = min_amount_in_orig_currency
+      @max_amount_in_orig_currency = max_amount_in_orig_currency
+      @website = website
+      @zip_code = zip_code
+      @country = country
+      @phone = phone
+      @email = email
+      @flat_fee_in_orig_currency = flat_fee_in_orig_currency
+      @forex_margin = forex_margin
+      @agent_ids = agent_ids
+      @credit_in_php = credit_in_php
+      @credit_in_vnd = credit_in_vnd
+    end
+  end
+end

data/lib/bloom_remit2/rate.rb

@@ -0,0 +1,31 @@
+module BloomRemit2
+  class Rate
+    class << self
+      # Returns a real-time hash of currency exchange rates that update every minute
+      #
+      # Supported currencies include: AED, AUD, BCH, BTC, CAD, CNY, DASH, ETH, EUR, GBP, HKD,
+      # IDR, INR, JPY, KRW, LINK, LTC, MYR, NPR, PHP, SGD, THB, USD, USDT, VND, XLM, XRP, ZAR.
+      # By default, all rates provided are relative to USD.
+      #
+      # @return currency_exchange_rates [Hash] where key is 6-letter currency pair and value is price
+      def list
+        rates = Client.get(path)
+        JSON.parse(rates.body)
+      end
+
+      # Retrieves one currency exchange rate
+      # @param currency_pair [String] 6-letter currency pair (e.g. 'USDBTC')
+      # @return rate [BloomRemit2::Rate]
+      def retrieve(currency_pair)
+        price = Client.get("#{path}&currency=#{currency_pair}").body
+        { currency_pair => price.to_f }
+      end
+
+      private
+
+      def path
+        "api/v1/rates?partner_id=#{BloomRemit2.configuration.api_token}"
+      end
+    end
+  end
+end

data/lib/bloom_remit2/recipient.rb

@@ -0,0 +1,94 @@
+module BloomRemit2
+  class Recipient
+    class << self
+      def create(sender_id, recipient_hash)
+        recipient = Client.post(path(sender_id), recipient_hash)
+        initialize_from_hash(recipient['recipient'])
+      end
+
+      def list(sender_id)
+        recipients = Client.get(path(sender_id))
+        recipients.map { |recipient| initialize_from_hash(recipient) }
+      end
+
+      def retrieve(sender_id, recipient_id)
+        recipient = Client.get("#{path(sender_id)}/#{recipient_id}")
+        initialize_from_hash(recipient['recipient'], recipient['remittance_ids'])
+      end
+
+      def update(sender_id, recipient_id, recipient_hash)
+        body = []
+        recipient_hash.each do |k, v|
+          body << ["recipient[#{k.to_s.downcase}]", v]
+        end
+        recipient = Client.put("#{path(sender_id)}/#{recipient_id}", body)
+        initialize_from_hash(recipient['recipient'])
+      end
+
+      def delete(sender_id, recipient_id)
+        message = Client.delete("#{path(sender_id)}/#{recipient_id}").with_indifferent_access
+        if message[:success] == "We've successfully deleted that recipient."
+          new(
+            recipient_id,
+            sender_id,
+            deleted: true
+          )
+        end
+      end
+
+      private
+
+      def path(sender_id)
+        "api/v1/partners/#{BloomRemit2.configuration.api_token}/senders/#{sender_id}/recipients"
+      end
+
+      def initialize_from_hash(recipient, remittance_ids=nil)
+        recipient = recipient.with_indifferent_access
+        new(
+          recipient[:id],
+          recipient[:sender_id],
+          recipient[:first_name],
+          recipient[:last_name],
+          recipient[:email],
+          recipient[:mobile],
+          recipient[:address],
+          recipient[:city],
+          recipient[:state],
+          recipient[:country],
+          remittance_ids
+        )
+      end
+    end
+
+    attr_reader :id, :sender_id, :first_name, :last_name, :email, :mobile, :address, :city, :province, :country, :remittance_ids, :deleted
+    alias :state :province
+
+    def initialize(
+      id,
+      sender_id,
+      first_name=nil,
+      last_name=nil,
+      email=nil,
+      mobile=nil,
+      address=nil,
+      city=nil,
+      province=nil,
+      country=nil,
+      remittance_ids=nil,
+      deleted: false
+    )
+      @id = id
+      @sender_id = sender_id
+      @first_name = first_name
+      @last_name = last_name
+      @email = email
+      @mobile = mobile
+      @address = address
+      @city = city
+      @province = province
+      @country = country
+      @remittance_ids = remittance_ids
+      @deleted = deleted
+    end
+  end
+end