pboling-remit 0.0.2.4 → 0.0.8

data/lib/remit/get_pipeline.rb

@@ -0,0 +1,212 @@
+require 'erb'
+
+require 'remit/common'
+
+module Remit
+  module GetPipeline
+    class Pipeline
+      @parameters = []
+      attr_reader :parameters
+      
+      class << self
+        # Create the parameters hash for the subclass.
+        def inherited(subclass) #:nodoc:
+          subclass.instance_variable_set('@parameters', [])
+        end
+        
+        def parameter(name)
+          attr_accessor name
+          @parameters << name
+        end
+        
+        def convert_key(key)
+          key.to_s.gsub(/_(.)/) { $1.upcase }.to_sym
+        end
+        
+        # Returns a hash of all of the parameters for this request, including
+        # those that are inherited.
+        def parameters #:nodoc:
+          (superclass.respond_to?(:parameters) ? superclass.parameters : []) + @parameters
+        end
+      end
+      
+      attr_reader :api
+      
+      parameter :pipeline_name
+      parameter :return_url
+      parameter :caller_key
+      parameter :version
+      parameter :address_name
+      parameter :address_line_1
+      parameter :address_line_2
+      parameter :city
+      parameter :state
+      parameter :zip
+      parameter :country
+      parameter :phone_number
+
+      def initialize(api, options)
+        @api = api
+        
+        options.each do |k,v|
+          self.send("#{k}=", v)
+        end
+      end
+
+      def url
+        uri = URI.parse(@api.pipeline_url)
+        
+        query = {}
+        self.class.parameters.each do |p|
+          val = self.send(p)
+          
+          # Convert Time values to seconds from Epoch
+          val = val.to_i if val.is_a?(Time)
+          
+          query[self.class.convert_key(p.to_s)] = val
+        end
+
+        # Remove any unused optional parameters
+        query.reject! { |key, value| value.nil? || (value.is_a?(String) && value.empty?) }
+
+        uri.query = SignedQuery.new(@api.pipeline_url, @api.secret_key, query).to_s
+        uri.to_s
+      end
+      
+      def method_missing(method, *args)
+        if self.class.parameters.include?(method.to_sym)
+          self.send(method.to_sym)
+        else
+          super
+        end
+      end
+      
+    end
+    
+    class SingleUsePipeline < Pipeline
+      parameter :caller_reference
+      parameter :payment_reason
+      parameter :payment_method
+      parameter :transaction_amount
+      parameter :recipient_token
+      
+      def pipeline_name
+        Remit::PipelineName::SINGLE_USE
+      end
+    end
+    
+    class MultiUsePipeline < Pipeline
+      parameter :caller_reference
+      parameter :payment_reason
+      parameter :recipient_token_list
+      parameter :amount_type
+      parameter :transaction_amount
+      parameter :validity_start
+      parameter :validity_expiry
+      parameter :payment_method
+      parameter :global_amount_limit
+      parameter :usage_limit_type_1
+      parameter :usage_limit_period_1
+      parameter :usage_limit_value_1
+      parameter :usage_limit_type_2
+      parameter :usage_limit_period_2
+      parameter :usage_limit_value_2
+      parameter :is_recipient_cobranding
+      
+      def pipeline_name
+        Remit::PipelineName::MULTI_USE
+      end
+    end
+    
+    class RecipientPipeline < Pipeline
+      parameter :caller_reference
+      parameter :validity_start # Time or seconds from Epoch
+      parameter :validity_expiry # Time or seconds from Epoch
+      parameter :payment_method
+      parameter :recipient_pays_fee
+      parameter :caller_reference_refund
+      parameter :max_variable_fee
+      parameter :max_fixed_fee
+      
+      def pipeline_name
+        Remit::PipelineName::RECIPIENT
+      end
+    end
+
+    class RecurringUsePipeline < Pipeline
+      parameter :caller_reference
+      parameter :payment_reason
+      parameter :recipient_token
+      parameter :transaction_amount
+      parameter :validity_start # Time or seconds from Epoch
+      parameter :validity_expiry # Time or seconds from Epoch
+      parameter :payment_method
+      parameter :recurring_period  
+      
+      def pipeline_name
+        Remit::PipelineName::RECURRING
+      end 
+    end
+    
+    class PostpaidPipeline < Pipeline
+      parameter :caller_reference_sender
+      parameter :caller_reference_settlement
+      parameter :payment_reason
+      parameter :payment_method
+      parameter :validity_start # Time or seconds from Epoch
+      parameter :validity_expiry # Time or seconds from Epoch
+      parameter :credit_limit
+      parameter :global_amount_limit
+      parameter :usage_limit_type1
+      parameter :usage_limit_period1
+      parameter :usage_limit_value1
+      parameter :usage_limit_type2
+      parameter :usage_limit_period2
+      parameter :usage_limit_value2
+      
+      def pipeline_name
+        Remit::PipelineName::SETUP_POSTPAID
+      end
+    end
+    
+    class EditTokenPipeline < Pipeline
+      parameter :caller_reference
+      parameter :payment_method
+      parameter :token_id
+
+      def pipeline_name
+        Remit::PipelineName::EDIT_TOKEN
+      end
+    end
+    
+    def get_single_use_pipeline(options)
+      self.get_pipeline(SingleUsePipeline, options)
+    end
+
+    def get_multi_use_pipeline(options)
+      self.get_pipeline(MultiUsePipeline, {:version => Date.new(2009, 1, 9).to_s}.merge(options))
+    end
+
+    def get_recipient_pipeline(options)
+      self.get_pipeline(RecipientPipeline, {:version => Date.new(2009, 1, 9).to_s}.merge(options))
+    end
+    
+    def get_recurring_use_pipeline(options)
+      self.get_pipeline(RecurringUsePipeline, options)
+    end
+    
+    def get_postpaid_pipeline(options)
+      self.get_pipeline(PostpaidPipeline, options)
+    end
+
+    def get_edit_token_pipeline(options)
+      self.get_pipeline(EditTokenPipeline, options)
+    end
+    
+    def get_pipeline(pipeline_subclass, options)
+      pipeline = pipeline_subclass.new(self, {
+        :caller_key => @access_key
+      }.merge(options))
+    end
+  end
+end

data/lib/remit/ipn_request.rb

@@ -0,0 +1,46 @@
+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)
+      SignedQuery.signature(@secret_key,params)
+    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