bloom_remit2 0.1.0

data/lib/bloom_remit2/remittance.rb

@@ -0,0 +1,134 @@
+module BloomRemit2
+  class Remittance
+    class << self
+      # Initiate a new money transfer by providing a recipient_id and remittance hash
+      def execute(sender_id, remittance_hash)
+        remittance = Client.post(path(sender_id))
+      end
+
+      # Cancel a remittance
+      #
+      # Note that this changes the status of the remittance to 'cancelled' and
+      # refunds the partner credits used, but does not delete it from the database.
+      #
+      # @param sender_id [String] id of sender associated with this remittance
+      # @param remittance_id [String] id of remittance
+      def cancel(sender_id, remittance_id)
+        remittance = Client.delete(path_with_id(sender_id, remittance_id))
+      end
+
+      # Show all remittances belonging to the given sender
+      #
+      # @param sender_id [String] id of sender to list remittances for
+      # @return remittances [Array] array with BloomRemit2::Remittance instances
+      def list(sender_id)
+        remittances = Client.get(path(sender_id))
+        remittances['remittance_ids'].map { |id| new(id) }
+      end
+
+      # Show information about a given remittance with their associated recipient
+      #
+      # All information about the given remittance and recipient are returned with this call.
+      # Important fields to note include status and receivable_in_dest_currency.
+      #
+      # @param sender_id [String] id of sender associated with this remittance
+      # @param remittance_id [String] id of remittance
+      # @return remittance [BloomRemit2::Remittance]
+      def retrieve(sender_id, remittance_id)
+        result = Client.get(path_with_id(sender_id, remittance_id)).with_indifferent_access
+        remittance = result['remittance'].with_indifferent_access
+        recipient = result['recipient'].with_indifferent_access
+        new(
+          remittance[:id],
+          remittance[:partner_id],
+          remittance[:orig_currency],
+          remittance[:dest_currency],
+          remittance[:paid_in_orig_currency],
+          remittance[:forex_margin],
+          remittance[:flat_fee_in_orig_currency],
+          remittance[:payout_method],
+          remittance[:status],
+          remittance[:account_name],
+          remittance[:account_number],
+          remittance[:teller_id],
+          remittance[:sender_id],
+          remittance[:client_external_id],
+          recipient: Recipient.new(
+            recipient[:id],
+            recipient[:sender_id],
+            recipient[:first_name],
+            recipient[:last_name],
+            recipient[:email],
+            recipient[:mobile],
+            recipient[:address],
+            nil,
+            nil,
+            recipient[:country],
+            nil
+          )
+        )
+      end
+
+      # TODO: Returns 500 Internal Server Error
+      # Returns the total fees for a given remittance amount and payout method
+      # def calculate_fees(payout_method, origin_amount: nil, origin_currency: nil, destination_amount: nil, destination_currency: nil)
+      #   remittance = Client.post(path_for_calculate, fees_hash)
+      # end
+
+      private
+
+      # TODO: Uncomment when implementing .calculate_fees
+      # def path_for_calculate
+      #   "api/v1/partners/#{BloomRemit2.configuration.api_token}/remittances/calculate"
+      # end
+
+      def path(sender_id)
+        "api/v1/partners/#{BloomRemit2.configuration.api_token}/senders/#{sender_id}/remittances"
+      end
+
+      def path_with_id(sender_id, remittance_id)
+        "#{path(sender_id)}/#{remittance_id}"
+      end
+    end
+
+    attr_reader :id, :partner_id, :orig_currency, :dest_currency, :paid_in_orig_currency, :forex_margin, :flat_fee_in_orig_currency, :payout_method, :status, :account_name, :account_number, :teller_id, :sender_id, :client_external_id, :recipient
+
+    alias :origin_currency :orig_currency
+    alias :destination_currency :dest_currency
+    alias :flat_fee_in_origin_currency :flat_fee_in_orig_currency
+
+    def initialize(
+      id,
+      partner_id=nil,
+      orig_currency=nil,
+      dest_currency=nil,
+      paid_in_orig_currency=nil,
+      forex_margin=nil,
+      flat_fee_in_orig_currency=nil,
+      payout_method=nil,
+      status=nil,
+      account_name=nil,
+      account_number=nil,
+      teller_id=nil,
+      sender_id=nil,
+      client_external_id=nil,
+      recipient: nil
+    )
+      @id = id
+      @partner_id = partner_id
+      @orig_currency = orig_currency 
+      @dest_currency = dest_currency 
+      @paid_in_orig_currency = paid_in_orig_currency 
+      @forex_margin = forex_margin 
+      @flat_fee_in_orig_currency = flat_fee_in_orig_currency
+      @payout_method = payout_method 
+      @status = status
+      @account_name = account_name,
+      @account_number = account_number,
+      @teller_id = teller_id,
+      @sender_id = sender_id
+      @client_external_id = client_external_id
+      @recipient = recipient
+    end
+  end
+end

data/lib/bloom_remit2/sender.rb

@@ -0,0 +1,168 @@
+module BloomRemit2
+  class Sender
+    class << self
+      # Show a list of senders belonging to this partner
+      # @return senders [Array] list of senders created by this partner, sorted by newest first
+      def list
+        senders = Client.get(path)
+        senders.map { |sender| initialize_from_hash(sender) }
+      end
+
+      # Show a sender belonging to this partner
+      # @return sender [BloomRemit2::Sender] sender belonging to this partner
+      def retrieve(id)
+        sender = Client.get("#{path}/#{id}")
+        initialize_from_hash(sender['user'])
+      end
+
+      # Show a sender belonging to this partner by supplying their email address
+      # @param email [String]
+      # @return sender [BloomRemit2::Sender] sender belonging to this partner
+      def find_by_email(email)
+        sender = Client.get("#{path}/find_by_email", query: { email: email })
+        initialize_from_hash(sender['user'])
+      end
+
+      # TODO: Broken because mobile is being shown as scientific notation
+      # Show a sender belonging to this partner by supplying their email address
+      # @param mobile [String]
+      # @return sender [BloomRemit2::Sender] sender belonging to this partner
+      # def find_by_mobile(mobile)
+      #   sender = Client.get("#{path}/find_by_mobile", query: { email: email })
+      #   initialize_from_hash(sender['user'])
+      # end
+
+      # Create a new sender under this partner
+      def create(sender_hash)
+        sender = Client.post(path, sender_hash)
+        initialize_from_hash(sender['sender'])
+      end
+
+      # Update the attributes of a sender belonging to this partner
+      # TODO: Doesn't support identification or proof of address
+      # @param sender_id [String] id of the sender to update
+      # @param sender_hash [Hash] attributes to update sender
+      def update(sender_id, sender_hash)
+        body = []
+        sender_hash.each do |k, v|
+          body << ["user[#{k.to_s.downcase}]", v]
+        end
+        sender = Client.put("#{path}/#{sender_id}", body)
+        initialize_from_hash(sender['user'])
+      end
+
+      # Delete a sender belonging to this partner
+      # @param sender_id [String] id of sender to delete
+      def delete(sender_id)
+        message = Client.delete("#{path}/#{sender_id}").with_indifferent_access
+        if message[:success] == "We've successfully deleted that user."
+          new(
+            sender_id,
+            deleted: true
+          )
+        end
+      end
+
+      private
+
+      def path
+        "api/v1/partners/#{BloomRemit2.configuration.api_token}/senders"
+      end
+
+      def initialize_from_hash(sender)
+        sender = sender.with_indifferent_access
+        new(
+          sender[:id],
+          sender[:email],
+          sender[:first_name],
+          sender[:last_name],
+          sender[:passport_number],
+          sender[:passport_expiry_date],
+          sender[:tin],
+          sender[:mobile],
+          sender[:address],
+          sender[:city],
+          sender[:state],
+          sender[:zip_code],
+          sender[:country],
+          sender[:birthdate],
+          sender[:photo_uid],
+          sender[:photo_name],
+          sender[:id_photo_uid],
+          sender[:id_photo_name],
+          sender[:identification_type],
+          sender[:identification_number],
+          sender[:identification_details],
+          sender[:deleted_at],
+          sender[:dragonpay_userid],
+          sender[:sending_level],
+          sender[:occupation],
+          sender[:created_at],
+          sender[:updated_at]
+        )
+      end
+    end
+
+    attr_reader :id, :email, :first_name, :last_name, :passport_number, :passport_expiry_date, :tin, :mobile, :photo_uid, :photo_name, :id_photo_uid, :id_photo_name, :identification_type, :identification_number, :identification_details, :address, :city, :state, :zip_code, :country, :birthdate, :deleted_at, :dragonpay_userid, :sending_level, :created_at, :updated_at, :deleted
+
+    def initialize(
+      id,
+      email=nil,
+      first_name=nil,
+      last_name=nil,
+      passport_number=nil,
+      passport_expiry_date=nil,
+      tin=nil,
+      mobile=nil,
+      address=nil,
+      city=nil,
+      state=nil,
+      zip_code=nil,
+      country=nil,
+      birthdate=nil,
+      photo_uid=nil,
+      photo_name=nil,
+      id_photo_uid=nil,
+      id_photo_name=nil,
+      identification_type=nil,
+      identification_number=nil,
+      identification_details=nil,
+      deleted_at=nil,
+      dragonpay_userid=nil,
+      sending_level=nil,
+      occupation=nil,
+      created_at=nil,
+      updated_at=nil,
+      deleted: false
+    )
+      @id = id
+      @email = email
+      @first_name = first_name
+      @last_name = last_name
+      @passport_number = passport_number
+      @passport_expiry_date = passport_expiry_date
+      @tin = tin
+      @mobile = mobile
+      @address = address
+      @city = city
+      @state = state
+      @zip_code = zip_code
+      @country = country
+      @birthdate = birthdate
+      @photo_uid = photo_uid
+      @photo_name = photo_name
+      @id_photo_uid = id_photo_uid
+      @id_photo_name = id_photo_name
+      @identification_type = identification_type
+      @identification_number = identification_number
+      @identification_details = identification_details
+      @deleted_at = deleted_at
+      @dragonpay_userid = dragonpay_userid
+      @sending_level = sending_level
+      @occupation = occupation
+      @created_at = created_at
+      @updated_at = updated_at
+      @deleted = deleted
+    end
+  end
+end

data/lib/bloom_remit2/version.rb

@@ -0,0 +1,3 @@
+module BloomRemit2
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: bloom_remit2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Xavi Ablaza
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prettier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- xlablaza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/workflows/gempush.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bloom_remit2.gemspec
+- lib/bloom_remit2.rb
+- lib/bloom_remit2/agent.rb
+- lib/bloom_remit2/client.rb
+- lib/bloom_remit2/credit.rb
+- lib/bloom_remit2/partner.rb
+- lib/bloom_remit2/rate.rb
+- lib/bloom_remit2/recipient.rb
+- lib/bloom_remit2/remittance.rb
+- lib/bloom_remit2/sender.rb
+- lib/bloom_remit2/version.rb
+homepage: https://github.com/makisu/bloom_remit2
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/makisu/bloom_remit2
+  source_code_uri: https://github.com/makisu/bloom_remit2
+  changelog_uri: https://github.com/makisu/bloom_remit2/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for BloomRemit's API
+test_files: []