micah-remit 0.0.5

data/lib/remit/error_codes.rb

@@ -0,0 +1,118 @@
+# Scraped and categorized from http://docs.amazonwebservices.com/AmazonFPS/\
+# 2007-01-08/FPSDeveloperGuide/index.html?ErrorCodesTable.html. You can use
+# these categories to specify default error handling in your application such
+# as asking users to retry or sending an exception email.
+module Remit::ErrorCodes
+  class << self
+    def sender_error?(code)
+      SENDER.include? code.to_sym
+    end
+
+    def recipient_error?(code)
+      RECIPIENT.include? code.to_sym
+    end
+
+    def caller_error?(code)
+      CALLER.include?(code.to_sym)
+    end
+
+    def amazon_error?(code)
+      AMAZON.include? code.to_sym
+    end
+
+    def api_error?(code)
+      API.include? code.to_sym
+    end
+
+    def unknown_error?(code)
+      UNKNOWN.include? code.to_sym
+    end
+  end
+
+  SENDER = [
+    :InactiveAccount_Sender, # The sender's account is in suspended or closed state.
+    :InactiveInstrument, # The payment instrument used for this transaction is no longer active.
+    :InstrumentExpired, # The prepaid or the postpaid instrument has expired.
+    :InstrumentNotActive, # The prepaid or postpaid instrument used in the transaction is not active.
+    :InvalidAccountState_Sender, # Sender account cannot participate in the transaction.
+    :InvalidInstrumentForAccountType, # The sender account can use only credit cards
+    :InvalidInstrumentState, # The prepaid or credit instrument should be active
+    :InvalidTokenId_Sender, # The send token specified is either invalid or canceled or the token is not active.
+    :PaymentInstrumentNotCC, # The payment method specified in the transaction is not a credit card. You can only use a credit card for this transaction.
+    :PaymentInstrumentMissing, # There needs to be a payment instrument defined in the token which defines the payment method.
+    :TokenNotActive_Sender, # The sender token is canceled.
+    :UnverifiedAccount_Sender, # The sender's account must have a verified U.S. credit card or a verified U.S bank account before this transaction can be initiated
+    :UnverifiedBankAccount, # A verified bank account should be used for this transaction
+    :UnverifiedEmailAddress_Sender, # The sender account must have a verified e-mail address for this payment
+  ]
+
+  RECIPIENT = [
+    :InactiveAccount_Recipient, # The recipient's account is in suspended or closed state.
+    :InvalidAccountState_Recipient, # Recipient account cannot participate in the transaction
+    :InvalidRecipientRoleForAccountType, # The recipient account is not allowed to receive payments
+    :InvalidRecipientForCCTransaction, # This account cannot receive credit card payments.
+    :InvalidTokenId_Recipient, # The recipient token specified is either invalid or canceled.
+    :TokenNotActive_Recipient, # The recipient token is canceled.
+    :UnverifiedAccount_Recipient, # The recipient's account must have a verified bank account or a credit card before this transaction can be initiated.
+    :UnverifiedEmailAddress_Recipient, # The recipient account must have a verified e-mail address for receiving payments.
+  ]
+
+  CALLER = [
+    :InactiveAccount_Caller, # The caller's account is in suspended or closed state.
+    :InvalidAccountState_Caller, # The caller account cannot participate in the transaction
+    :InvalidTokenId_Caller, # The caller token specified is either invalid or canceled or the specified token is not active.
+    :TokenNotActive_Caller, # The caller token is canceled.
+    :UnverifiedEmailAddress_Caller, # The caller account must have a verified e-mail address
+  ]
+
+  AMAZON = [
+    :InternalError # A retriable error that happens due to some transient problem in the system.
+  ]
+
+  # bad syntax or logic
+  API = [
+    :AmountOutOfRange, # The transaction amount is more than the allowed range.
+    :BadRule, # One of the GK constructs is not well defined
+    :CannotSpecifyUsageForSingleUseToken, # Token usages cannot be specified for a single use token.
+    :ConcurrentModification, # A retriable error can happen due to concurrent modification of data by two processes.
+    :DuplicateRequest, # A different request associated with this caller reference already exists.
+    :IncompatibleTokens, # The transaction could not be completed because the tokens have incompatible payment instructions.
+    :InstrumentAccessDenied, # The external calling application is not the recipient for this postpaid or prepaid instrument. The caller should be the liability holder
+    :InvalidCallerReference, # The CallerReferece does not have a token associated with it.
+    :InvalidDateRange, # The end date specified is before the start date or the start date is in the future.
+    :InvalidEvent, # The event specified was not subscribed using the SubscribeForCallerNotification operation.
+    :InvalidParams, # One or more parameters in the request is invalid.
+    :InvalidPaymentInstrument, # The payment method used in the transaction is invalid.
+    :InvalidPaymentMethod, # Payment method specified in the GK construct is invalid.
+    :InvalidSenderRoleForAccountType, # This token cannot be used for this operation.
+    :InvalidTokenId, # The token that you are trying to cancel was not installed by you.
+    :InvalidTokenType, # Invalid operation performed on the token. Example, getting the token usage information on a single use token.
+    :InvalidTransactionId, # The specified transaction could not be found or the caller did not execute the transaction or this is not a Pay or Reserve call.
+    :InvalidTransactionState, # The transaction is not completed or it has been temporarily failed.
+    :InvalidUsageDuration, # The duration cannot be less than one hour.
+    :InvalidUsageLimitCount, # The usage count is null or empty.
+    :InvalidUsageStartTime, # The start time specified for the token is not valid.
+    :InvalidUsageType, # The usage type specified is invalid.
+    :OriginalTransactionIncomplete, # The original transaction is still in progress.
+    :OriginalTransactionFailed, # The original transaction has failed
+    :PaymentMethodNotDefined, # Payment method is not defined in the transaction.
+    :RefundAmountExceeded, # The refund amount is more than the refundable amount.
+    :SameTokenIdUsedMultipleTimes, # This token is already used in earlier transactions.
+    :SenderNotOriginalRecipient, # The sender in the refund transaction is not the recipient of the original transaction.
+    :SettleAmountGreaterThanReserveAmount, # The amount being settled is greater than the reserved amount.
+    :TransactionDenied, # This transaction is not allowed.
+    :TransactionExpired, # Returned when the Caller attempts to explicitly retry a transaction that is temporarily declined and is in queue for implicit retry.
+    :TransactionFullyRefundedAlready, # The complete refund for this transaction is already completed
+    :TransactionTypeNotRefundable, # You cannot refund this transaction.
+    :TokenAccessDenied, # Permission is denied to cancel the token.
+    :TokenUsageError, # The token usage limit is exceeded.
+    :UsageNotDefined, # For a multi-use token or a recurring token the usage limits are not specified in the GateKeeper text.
+  ]
+
+  # these errors don't specify who is at fault
+  UNKNOWN = [
+    :InvalidAccountState, # The account is either suspended or closed. Payment instructions cannot be installed on this account.
+    :InsufficientBalance, # The sender, caller, or recipient's account balance has insufficient funds to complete the transaction.
+    :AccountLimitsExceeded, # The spending or the receiving limit on the account is exceeded
+  ]
+end

data/lib/remit/get_pipeline.rb

@@ -0,0 +1,189 @@
+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
+    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
+    
+    def get_single_use_pipeline(options)
+      self.get_pipeline(SingleUsePipeline, options)
+    end
+
+    def get_multi_use_pipeline(options)
+      self.get_pipeline(MultiUsePipeline, options)
+    end
+
+    def get_recipient_pipeline(options)
+      self.get_pipeline(RecipientPipeline, 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_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,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_subscription_and_refund.rb

@@ -0,0 +1,23 @@
+require 'remit/common'
+
+# Note: This is a special FPS action used by Amazon SimplePay
+# See more here: http://docs.amazonwebservices.com/AmazonSimplePay/latest/ASPAdvancedUserGuide/
+module Remit
+  module CancelSubscriptionAndRefund
+    class Request < Remit::Request
+      action :CancelSubscriptionAndRefund
+      parameter :caller_reference, :required => true
+      parameter :cancel_reason
+      parameter :refund_amount, :type => Remit::RequestTypes::Amount
+      parameter :subscription_id, :required => true
+    end
+
+    class Response < Remit::Response
+      parameter :refund_transaction_id
+    end
+    
+    def cancel_subscription_and_refund(request = Request.new)
+      call(request, Response)
+    end
+  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