ianlevesque-remit 0.0.6

data/lib/remit/ipn_request.rb

@@ -0,0 +1,49 @@
+require 'base64'
+require 'openssl/digest'
+
+module Remit
+  # Encapsulates the logic for IPN request validation and attribute retrieval.
+  #
+  # Note: if your responses from Amazon are not validating, please pass the
+  # :version parameter to your original CBUI request.
+  class IpnRequest
+    # Signature key name used by AmazonFPS IPNs
+    SIGNATURE_KEY = 'signature'
+
+    # +params+ should be your controllers request parameters.
+    def initialize(params, secret_key)
+      raise ArgumentError, "Expected the request params hash, received: #{params.inspect}" unless params.kind_of?(Hash)
+      @params             = strip_keys_from(params, 'action', 'controller')
+      @supplied_signature = @params.delete(SIGNATURE_KEY)
+      @secret_key         = secret_key
+    end
+
+    def valid?
+      return false unless @supplied_signature
+      generate_signature_for(@params) == @supplied_signature
+    end
+
+    def method_missing(method, *args) #:nodoc:
+      if @params.has_key?(method.to_s)
+        @params[method.to_s]
+      else
+        super(method, *args)
+      end
+    end
+
+    def generate_signature_for(params)
+      query   = params.sort_by { |k,v| k.downcase }
+      digest  = OpenSSL::Digest::Digest.new('sha1')
+      hmac    = OpenSSL::HMAC.digest(digest, @secret_key, query.to_s)
+      encoded = Base64.encode64(hmac).chomp
+    end
+    private :generate_signature_for
+
+    def strip_keys_from(params, *ignore_keys)
+      parsed = params.dup
+      ignore_keys.each { |key| parsed.delete(key) }
+      parsed
+    end
+    private :strip_keys_from
+  end
+end

data/lib/remit/operations/cancel_token.rb

@@ -0,0 +1,18 @@
+require 'remit/common'
+
+module Remit
+  module CancelToken
+    class Request < Remit::Request
+      action :CancelToken
+      parameter :token_id, :required => true
+      parameter :reason_text
+    end
+
+    class Response < Remit::Response
+    end
+
+    def cancel_token(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/discard_results.rb

@@ -0,0 +1,18 @@
+require 'remit/common'
+
+module Remit
+  module DiscardResults
+    class Request < Remit::Request
+      action :DiscardResults
+      parameter :transaction_ids, :required => true
+    end
+
+    class Response < Remit::Response
+      parameter :discard_errors
+    end
+
+    def discard_results(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/fund_prepaid.rb

@@ -0,0 +1,31 @@
+require 'remit/common'
+
+module Remit
+  module FundPrepaid
+    class Request < Remit::Request
+      action :FundPrepaid
+      parameter :transaction_ids
+      parameter :caller_description
+      parameter :caller_reference, :required => true
+      parameter :caller_token_id, :required => true
+      parameter :charge_fee_to, :required => true
+      parameter :funding_amount, :type => Remit::RequestTypes::Amount, :required => true
+      parameter :meta_data
+      parameter :prepaid_instrument_id, :required => true
+      parameter :recipient_description
+      parameter :recipient_reference
+      parameter :sender_description
+      parameter :sender_reference
+      parameter :sender_token_id, :required => true
+      parameter :transaction_date
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def fund_prepaid(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_account_activity.rb

@@ -0,0 +1,60 @@
+require 'remit/common'
+
+module Remit
+  module GetAccountActivity
+    class Request < Remit::Request
+      action :GetAccountActivity
+      parameter :start_date, :required => true
+      parameter :end_date
+      parameter :max_batch_size
+      parameter :sort_order_by_date
+      parameter :response_group
+      parameter :operation
+      parameter :payment_method
+      parameter :role
+      parameter :status
+    end
+
+    class Response < Remit::Response
+      class Transaction < Remit::BaseResponse
+        class TransactionPart < Remit::BaseResponse
+          parameter :account_id
+          parameter :role
+          parameter :name
+          parameter :reference
+          parameter :description
+          parameter :fee_paid, :type => Amount
+        end
+
+        parameter :caller_name
+        parameter :caller_token_id
+        parameter :caller_transaction_date, :type => :time
+        parameter :date_completed, :type => :time
+        parameter :date_received, :type => :time
+        parameter :error_code
+        parameter :error_detail
+        parameter :error_message
+        parameter :fees, :type => Amount
+        parameter :meta_data
+        parameter :operation
+        parameter :original_transaction_id
+        parameter :payment_method
+        parameter :recipient_name
+        parameter :sender_name
+        parameter :sender_token_id
+        parameter :status
+        parameter :transaction_amount, :type => Amount
+        parameter :transaction_id
+        parameter :transaction_parts, :collection => TransactionPart
+      end
+
+      parameter :response_batch_size
+      parameter :transactions, :collection => Transaction
+      parameter :start_time_for_next_transaction, :type => :time
+    end
+
+    def get_account_activity(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_account_balance.rb

@@ -0,0 +1,29 @@
+require 'remit/common'
+
+module Remit
+  module GetAccountBalance
+    class Request < Remit::Request
+      action :GetAccountBalance
+    end
+
+    class Response < Remit::Response
+      class AccountBalance < Remit::BaseResponse
+        class AvailableBalances < Remit::BaseResponse
+          parameter :disburse_balance, :type => Amount
+          parameter :refund_balance, :type => Amount
+        end
+
+        parameter :total_balance, :type => Amount
+        parameter :pending_in_balance, :type => Amount
+        parameter :pending_out_balance, :type => Amount
+        parameter :available_balances, :type => AvailableBalances
+      end
+
+      parameter :account_balance, :type => AccountBalance
+    end
+
+    def get_account_balance(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_all_credit_instruments.rb

@@ -0,0 +1,18 @@
+require 'remit/common'
+
+module Remit
+  module GetAllCreditInstruments
+    class Request < Remit::Request
+      action :GetAllCreditInstruments
+      parameter :instrument_status
+    end
+
+    class Response < Remit::Response
+      parameter :credit_instrument_ids
+    end
+
+    def get_all_credit_instruments(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_all_prepaid_instruments.rb

@@ -0,0 +1,18 @@
+require 'remit/common'
+
+module Remit
+  module GetAllPrepaidInstruments
+    class Request < Remit::Request
+      action :GetAllPrepaidInstruments
+      parameter :instrument_status
+    end
+
+    class Response < Remit::Response
+      parameter :prepaid_instrument_ids
+    end
+
+    def get_all_prepaid_instruments(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_debt_balance.rb

@@ -0,0 +1,23 @@
+require 'remit/common'
+
+module Remit
+  module GetDebtBalance
+    class Request < Remit::Request
+      action :GetDebtBalance
+      parameter :credit_instrument_id, :required => true
+    end
+
+    class Response < Remit::Response
+      class DebtBalance < Remit::BaseResponse
+        parameter :available_balance, :type => Amount
+        parameter :pending_out_balance, :type => Amount
+      end
+
+      parameter :debt_balance, :type => DebtBalance
+    end
+
+    def get_debt_balance(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_outstanding_debt_balance.rb

@@ -0,0 +1,22 @@
+require 'remit/common'
+
+module Remit
+  module GetOutstandingDebtBalance
+    class Request < Remit::Request
+      action :GetOutStandingDebtBalance
+    end
+
+    class Response < Remit::Response
+      class OutstandingDebtBalance < Remit::BaseResponse
+        parameter :outstanding_balance, :type => Amount
+        parameter :pending_out_balance, :type => Amount
+      end
+
+      parameter :outstanding_debt, :type => OutstandingDebtBalance
+    end
+
+    def get_outstanding_debt_balance(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_payment_instruction.rb

@@ -0,0 +1,21 @@
+require 'remit/common'
+
+module Remit
+  module GetPaymentInstruction
+    class Request < Remit::Request
+      action :GetPaymentInstruction
+      parameter :token_id, :required => true
+    end
+
+    class Response < Remit::Response
+      parameter :token, :type => Token
+      parameter :payment_instruction
+      parameter :account_id
+      parameter :token_friendly_name
+    end
+
+    def get_payment_instruction(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_prepaid_balance.rb

@@ -0,0 +1,23 @@
+require 'remit/common'
+
+module Remit
+  module GetPrepaidBalance
+    class Request < Remit::Request
+      action :GetPrepaidBalance
+      parameter :prepaid_instrument_id, :required => true
+    end
+
+    class Response < Remit::Response
+      class PrepaidBalance < Remit::BaseResponse
+        parameter :available_balance, :type => Amount
+        parameter :pending_in_balance, :type => Amount
+      end
+
+      parameter :prepaid_balance, :type => PrepaidBalance
+    end
+
+    def get_prepaid_balance(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_results.rb

@@ -0,0 +1,27 @@
+require 'remit/common'
+
+module Remit
+  module GetResults
+    class Request < Remit::Request
+      action :GetResults
+      parameter :operation
+      parameter :max_results_count
+    end
+
+    class Response < Remit::Response
+      class TransactionResults < Remit::BaseResponse
+        parameter :transaction_id
+        parameter :operation_type, :element => :operation
+        parameter :caller_reference
+        parameter :transaction_status, :element => :status
+      end
+
+      parameter :transaction_results, :collection => TransactionResults
+      parameter :number_pending, :type => :integer
+    end
+
+    def get_results(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_token_by_caller.rb

@@ -0,0 +1,19 @@
+require 'remit/common'
+
+module Remit
+  module GetTokenByCaller
+    class Request < Remit::Request
+      action :GetTokenByCaller
+      parameter :caller_reference
+      parameter :token_id
+    end
+
+    class Response < Remit::Response
+      parameter :token, :type => Token
+    end
+
+    def get_token_by_caller(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_token_usage.rb

@@ -0,0 +1,18 @@
+require 'remit/common'
+
+module Remit
+  module GetTokenUsage
+    class Request < Remit::Request
+      action :GetTokenUsage
+      parameter :token_id, :required => true
+    end
+
+    class Response < Remit::Response
+      parameter :token_usage_limits, :type => TokenUsageLimit
+    end
+
+    def get_token_usage(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_tokens.rb

@@ -0,0 +1,20 @@
+require 'remit/common'
+
+module Remit
+  module GetTokens
+    class Request < Remit::Request
+      action :GetTokens
+      parameter :caller_reference
+      parameter :token_friendly_name
+      parameter :token_status
+    end
+
+    class Response < Remit::Response
+      parameter :tokens, :collection => Token
+    end
+
+    def get_tokens(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_total_prepaid_liability.rb

@@ -0,0 +1,22 @@
+require 'remit/common'
+
+module Remit
+  module GetTotalPrepaidLiability
+    class Request < Remit::Request
+      action :GetTotalPrepaidLiability
+    end
+
+    class Response < Remit::Response
+      class OutstandingPrepaidLiability < Remit::BaseResponse
+        parameter :outstanding_balance, :type => Amount
+        parameter :panding_in_balance, :type => Amount
+      end
+
+      parameter :outstanding_prepaid_liability, :type => OutstandingPrepaidLiability
+    end
+
+    def get_total_prepaid_liability(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/get_transaction.rb

@@ -0,0 +1,42 @@
+require 'remit/common'
+
+module Remit
+  module GetTransaction
+    class Request < Remit::Request
+      action :GetTransaction
+      parameter :transaction_id, :required => true
+    end
+
+    class Response < Remit::Response
+      class TransactionDetail < Remit::BaseResponse
+        parameter :caller_name
+        parameter :caller_token_id
+        parameter :caller_transaction_date, :type => :time
+        parameter :date_completed, :type => :time
+        parameter :date_received, :type => :time
+        parameter :error_code
+        parameter :error_message
+        parameter :fees, :type => Amount
+        parameter :meta_data
+        parameter :operation
+        parameter :payment_method
+        parameter :recipient_name
+        parameter :recipient_token_id
+        parameter :related_transactions
+        parameter :sender_name
+        parameter :sender_token_id
+        parameter :status
+        parameter :status_history
+        parameter :transaction_amount, :type => Amount
+        parameter :transaction_id
+        parameter :transaction_parts
+      end
+
+      parameter :transaction, :type => TransactionDetail
+    end
+
+    def get_transaction(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/install_payment_instruction.rb

@@ -0,0 +1,22 @@
+require 'remit/common'
+
+module Remit
+  module InstallPaymentInstruction
+    class Request < Remit::Request
+      action :InstallPaymentInstruction
+      parameter :payment_instruction, :required => true
+      parameter :caller_reference, :required => true
+      parameter :token_friendly_name
+      parameter :token_type, :required => true
+      parameter :payment_reason
+    end
+
+    class Response < Remit::Response
+      parameter :token_id
+    end
+
+    def install_payment_instruction(request)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/pay.rb

@@ -0,0 +1,35 @@
+require 'remit/common'
+
+module Remit
+  module Pay
+    class Request < Remit::Request
+      action :Pay
+      parameter :caller_description
+      parameter :caller_reference, :required => true
+      parameter :caller_token_id, :required => true
+      parameter :charge_fee_to, :required => true
+      parameter :descriptor_policy, :type => Remit::RequestTypes::DescriptorPolicy
+      parameter :marketplace_fixed_fee, :type => Remit::RequestTypes::Amount
+      parameter :marketplace_variable_fee
+      parameter :meta_data
+      parameter :recipient_description
+      parameter :recipient_reference
+      parameter :recipient_token_id, :required => true
+      parameter :sender_description
+      parameter :sender_reference
+      parameter :sender_token_id, :required => true
+      parameter :temporary_decline_policy, :type => Remit::RequestTypes::TemporaryDeclinePolicy
+      parameter :transaction_amount, :type => Remit::RequestTypes::Amount, :required => true
+      parameter :transaction_date
+    end
+
+    class Response < Remit::Response
+      parser :rexml
+      parameter :transaction_response, :namespace => 'ns3', :type => TransactionResponse
+    end
+
+    def pay(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/refund.rb

@@ -0,0 +1,36 @@
+require 'remit/common'
+
+module Remit
+  module Refund
+    class Request < Remit::Request
+      action :Refund
+      parameter :caller_description
+      parameter :caller_reference, :required => true
+      parameter :caller_token_id, :required => true
+      parameter :charge_fee_to, :required => true
+      parameter :meta_data
+      parameter :refund_amount, :type => Remit::RequestTypes::Amount
+      parameter :refund_recipient_description
+      parameter :refund_recipient_reference
+      parameter :refund_sender_description
+      parameter :refund_sender_reference
+      parameter :refund_sender_token_id, :required => true
+      parameter :transaction_date
+      parameter :transaction_id, :required => true
+
+      # The RefundAmount parameter has multiple components.  It is specified on the query string like
+      # so: RefundAmount.Amount=XXX&RefundAmount.CurrencyCode=YYY
+      def convert_complex_key(key, parameter)
+        "#{convert_key(key).to_s}.#{convert_key(parameter).to_s}"
+      end
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def refund(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/reserve.rb

@@ -0,0 +1,30 @@
+require 'remit/common'
+
+module Remit
+  module Reserve
+    class Request < Remit::Request
+      action :Reserve
+      parameter :recipient_token_id, :required => true
+      parameter :sender_token_id, :required => true
+      parameter :caller_token_id, :required => true
+      parameter :sender_reference
+      parameter :recipient_reference
+      parameter :caller_reference, :required => true
+      parameter :transaction_date
+      parameter :transaction_amount, :type => Remit::RequestTypes::Amount, :required => true
+      parameter :charge_fee_to, :required => true
+      parameter :sender_description
+      parameter :recipient_description
+      parameter :caller_description
+      parameter :meta_data
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def reserve(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/retry_transaction.rb

@@ -0,0 +1,18 @@
+require 'remit/common'
+
+module Remit
+  module RetryTransaction
+    class Request < Remit::Request
+      action :RetryTransaction
+      parameter :original_transaction_id, :required => true
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def retry_transaction(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/settle.rb

@@ -0,0 +1,20 @@
+require 'remit/common'
+
+module Remit
+  module Settle
+    class Request < Remit::Request
+      action :Settle
+      parameter :reserve_transaction_id, :required => true
+      parameter :transaction_amount, :type => Remit::RequestTypes::Amount
+      parameter :transaction_date
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def settle(request = Request.new)
+      call(request, Response)
+    end
+  end
+end