dbalatero-remit 0.0.2.5

data/lib/remit.rb

@@ -0,0 +1,133 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'openssl'
+require 'net/https'
+require 'uri'
+require 'date'
+require 'base64'
+require 'erb'
+
+require 'rubygems'
+
+gem 'dbalatero-relax', '0.0.7.1'
+require 'relax'
+
+require 'remit/common'
+require 'remit/data_types'
+require 'remit/error_codes'
+require 'remit/ipn_request'
+require 'remit/get_pipeline'
+require 'remit/pipeline_response'
+
+require 'remit/operations/cancel_token'
+require 'remit/operations/discard_results'
+require 'remit/operations/fund_prepaid'
+require 'remit/operations/get_account_activity'
+require 'remit/operations/get_account_balance'
+require 'remit/operations/get_all_credit_instruments'
+require 'remit/operations/get_all_prepaid_instruments'
+require 'remit/operations/get_debt_balance'
+require 'remit/operations/get_outstanding_debt_balance'
+require 'remit/operations/get_payment_instruction'
+require 'remit/operations/get_prepaid_balance'
+require 'remit/operations/get_results'
+require 'remit/operations/get_token_by_caller'
+require 'remit/operations/get_token_usage'
+require 'remit/operations/get_tokens'
+require 'remit/operations/get_total_prepaid_liability'
+require 'remit/operations/get_transaction'
+require 'remit/operations/install_payment_instruction'
+require 'remit/operations/pay'
+require 'remit/operations/refund'
+require 'remit/operations/reserve'
+require 'remit/operations/retry_transaction'
+require 'remit/operations/settle'
+require 'remit/operations/settle_debt'
+require 'remit/operations/subscribe_for_caller_notification'
+require 'remit/operations/unsubscribe_for_caller_notification'
+require 'remit/operations/write_off_debt'
+
+module Remit
+  class API < Relax::Service
+    include CancelToken
+    include DiscardResults
+    include FundPrepaid
+    include GetAccountActivity
+    include GetAccountBalance
+    include GetAllCreditInstruments
+    include GetAllPrepaidInstruments
+    include GetDebtBalance
+    include GetOutstandingDebtBalance
+    include GetPaymentInstruction
+    include GetPipeline
+    include GetPrepaidBalance
+    include GetResults
+    include GetTokenUsage
+    include GetTokens
+    include GetTokenByCaller
+    include GetTotalPrepaidLiability
+    include GetTransaction
+    include InstallPaymentInstruction
+    include Pay
+    include Refund
+    include Reserve
+    include RetryTransaction
+    include Settle
+    include SettleDebt
+    include SubscribeForCallerNotification
+    include UnsubscribeForCallerNotification
+    include WriteOffDebt
+
+    API_ENDPOINT = 'https://fps.amazonaws.com/'.freeze
+    API_SANDBOX_ENDPOINT = 'https://fps.sandbox.amazonaws.com/'.freeze
+    PIPELINE_URL = 'https://authorize.payments.amazon.com/cobranded-ui/actions/start'.freeze
+    PIPELINE_SANDBOX_URL = 'https://authorize.payments-sandbox.amazon.com/cobranded-ui/actions/start'.freeze
+    API_VERSION = Date.new(2007, 1, 8).to_s.freeze
+    SIGNATURE_VERSION = 1.freeze
+
+    attr_reader :access_key
+    attr_reader :secret_key
+    attr_reader :pipeline_url
+
+    def initialize(access_key, secret_key, sandbox=false)
+      @access_key = access_key
+      @secret_key = secret_key
+      @pipeline_url = sandbox ? PIPELINE_SANDBOX_URL : PIPELINE_URL
+
+      super(sandbox ? API_SANDBOX_ENDPOINT : API_ENDPOINT)
+    end
+
+    def new_query(query={})
+      SignedQuery.new(@endpoint, @secret_key, query)
+    end
+    private :new_query
+
+    def default_query
+      new_query({
+        :AWSAccessKeyId => @access_key,
+        :SignatureVersion => SIGNATURE_VERSION,
+        :Version => API_VERSION,
+        :Timestamp => Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+      })
+    end
+    private :default_query
+
+    def query(request)
+      query = super
+      query[:Signature] = sign(query)
+      query
+    end
+    private :query
+
+    def sign(values)
+      keys = values.keys.sort { |a, b| a.to_s.downcase <=> b.to_s.downcase }
+
+      signature = keys.inject('') do |signature, key|
+        signature += key.to_s + values[key].to_s
+      end
+
+      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, @secret_key, signature)).strip
+    end
+    private :sign
+  end
+end

data/lib/remit/common.rb

@@ -0,0 +1,88 @@
+require 'base64'
+require 'erb'
+require 'uri'
+
+require 'rubygems'
+require 'relax'
+
+module Remit
+  class Request < Relax::Request
+    def self.action(name)
+      parameter :action, :value => name
+    end
+
+    def convert_key(key)
+      key.to_s.gsub(/(^|_)(.)/) { $2.upcase }.to_sym
+    end
+    protected :convert_key
+  end
+
+  class BaseResponse < Relax::Response
+    def node_name(name, namespace=nil)
+      super(name.to_s.gsub(/(^|_)(.)/) { $2.upcase }, namespace)
+    end
+  end
+
+  class Response < BaseResponse
+    parameter :request_id
+
+    attr_accessor :status
+    attr_accessor :errors
+
+    def initialize(xml)
+      super
+
+      if is?(:Response) && has?(:Errors)
+        @errors = elements(:Errors).collect do |error|
+          Error.new(error)
+        end
+      else
+        @status = text_value(element(:Status))
+        @errors = elements('errors/errors').collect do |error|
+          ServiceError.new(error)
+        end unless successful?
+      end
+    end
+
+    def successful?
+      @status == ResponseStatus::SUCCESS
+    end
+
+    def node_name(name, namespace=nil)
+      super(name.to_s.split('/').collect{ |tag|
+        tag.gsub(/(^|_)(.)/) { $2.upcase }
+      }.join('/'), namespace)
+    end
+  end
+
+  class SignedQuery < Relax::Query
+    def initialize(uri, secret_key, query={})
+      super(query)
+      @uri = URI.parse(uri.to_s)
+      @secret_key = secret_key
+    end
+
+    def sign
+      delete(:awsSignature)
+      store(:awsSignature, Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, @secret_key, "#{@uri.path}?#{to_s(false)}".gsub('%20', '+'))).strip)
+    end
+
+    def to_s(signed=true)
+      sign if signed
+      super()
+    end
+
+    class << self
+      def parse(uri, secret_key, query_string)
+        query = self.new(uri, secret_key)
+
+        query_string.split('&').each do |parameter|
+          key, value = parameter.split('=', 2)
+          query[key] = unescape_value(value)
+        end
+
+        query
+      end
+    end
+  end
+end

data/lib/remit/data_types.rb

@@ -0,0 +1,181 @@
+require 'rubygems'
+require 'relax'
+
+require 'remit/common'
+
+module Remit
+  class Amount < BaseResponse
+    parameter :currency_code
+    parameter :amount, :type => :float
+  end
+
+  class TemporaryDeclinePolicy < BaseResponse
+    parameter :temporary_decline_policy_type
+    parameter :implicit_retry_timeout_in_mins
+  end
+
+  class DescriptorPolicy < BaseResponse
+    parameter :soft_descriptor_type
+    parameter :CS_number_of
+  end
+
+  class ChargeFeeTo
+    CALLER = 'Caller'
+    RECIPIENT = 'Recipient'
+  end
+
+  class Error < BaseResponse
+    parameter :code
+    parameter :message
+  end
+
+  class InstrumentStatus
+    ALL = 'ALL'
+    ACTIVE = 'Active'
+    INACTIVE = 'Inactive'
+  end
+
+  class PaymentMethods
+    BALANCE_TRANSFER = 'abt'
+    BANK_ACCOUNT = 'ach'
+    CREDIT_CARD = 'credit card'
+    PREPAID = 'prepaid'
+    DEBT = 'Debt'
+  end
+
+  class ServiceError < BaseResponse
+    parameter :error_type
+    parameter :is_retriable
+    parameter :error_code
+    parameter :reason_text
+
+    class ErrorType
+      SYSTEM = 'System'
+      BUSINESS = 'Business'
+    end
+  end
+
+  class ResponseStatus
+    SUCCESS = 'Success'
+    FAILURE = 'Failure'
+  end
+
+  class Token < BaseResponse
+    parameter :token_id
+    parameter :friendly_name
+    parameter :status
+    parameter :date_installed, :type => :time
+    parameter :caller_installed
+    parameter :caller_reference
+    parameter :token_type
+    parameter :old_token_id
+    parameter :payment_reason
+
+    class TokenStatus
+      ACTIVE = 'Active'
+      INACTIVE = 'Inactive'
+    end
+  end
+
+  class TokenUsageLimit < BaseResponse
+    parameter :count
+    parameter :limit
+    parameter :last_reset_amount
+    parameter :last_reset_count
+    parameter :last_reset_time_stamp
+  end
+
+  class TransactionResponse < BaseResponse
+    parameter :transaction_id
+    parameter :status
+    parameter :status_detail
+    parameter :new_sender_token_usage, :type => TokenUsageLimit
+
+    %w(reserved success failure initiated reinitiated temporary_decline).each do |status_name|
+      define_method("#{status_name}?") do
+        self.status == Remit::TransactionStatus.const_get(status_name.sub('_', '').upcase)
+      end
+    end
+  end
+
+  class TransactionStatus
+    RESERVED          = 'Reserved'
+    SUCCESS           = 'Success'
+    FAILURE           = 'Failure'
+    INITIATED         = 'Initiated'
+    REINITIATED       = 'Reinitiated'
+    TEMPORARYDECLINE  = 'TemporaryDecline'
+  end
+
+  class TokenType
+    SINGLE_USE = 'SingleUse'
+    MULTI_USE = 'MultiUse'
+    RECURRING = 'Recurring'
+    UNRESTRICTED = 'Unrestricted'
+  end
+
+  class PipelineName
+    SINGLE_USE = 'SingleUse'
+    MULTI_USE = 'MultiUse'
+    RECURRING = 'Recurring'
+    RECIPIENT = 'Recipient'
+    SETUP_PREPAID = 'SetupPrepaid'
+    SETUP_POSTPAID = 'SetupPostpaid'
+  end
+
+  class PipelineStatusCode
+    CALLER_EXCEPTION  = 'CE'  # problem with your code
+    SYSTEM_ERROR      = 'SE'  # system error, try again
+    SUCCESS_ABT       = 'SA'  # successful payment with Amazon balance
+    SUCCESS_ACH       = 'SB'  # successful payment with bank transfer
+    SUCCESS_CC        = 'SC'  # successful payment with credit card
+    ABORTED           = 'A'   # user aborted payment
+    PAYMENT_METHOD_MISMATCH     = 'PE'  # user does not have payment method requested
+    PAYMENT_METHOD_UNSUPPORTED  = 'NP'  # account doesn't support requested payment method
+    INVALID_CALLER    = 'NM'  # you are not a valid 3rd party caller to the transaction
+    SUCCESS_RECIPIENT_TOKEN_INSTALLED = 'SR'
+  end
+
+  module RequestTypes
+    class Amount < Remit::Request
+      parameter :amount
+      parameter :currency_code
+    end
+
+    class TemporaryDeclinePolicy < Remit::Request
+      parameter :temporary_decline_policy_type
+      parameter :implicit_retry_timeout_in_mins
+    end
+
+    class DescriptorPolicy < Remit::Request
+      parameter :soft_descriptor_type
+      parameter :CS_number_of
+    end
+    
+    #Amazon Docs list MarketplaceRefundPolicy as a ComplexDataType, but it is not.
+    #It really should be listed under Enumerated DataTypes
+    #MarketplaceTxnOnly      Caller refunds his fee to the recipient.             String
+    #MasterAndMarketplaceTxn Caller and Amazon FPS refund their fees to the       String
+    #                        sender, and the recipient refunds his amount
+    #MasterTxnOnly           Caller does not refund his fee. Amazon FPS           String
+    #                        refunds its fee and the recipient refunds his amount
+    #                        plus the caller's fee to the sender.
+    class MarketplaceRefundPolicy < Remit::Request
+      POLICY = {
+        :marketplace_txn_only => 'MarketplaceTxnOnly',
+        :master_and_marketplace_txn => 'MasterAndMarketplaceTxn',
+        :master_txn_only => 'MasterTxnOnly'
+      }
+    end
+
+  end
+
+  class Operation
+    PAY             = "Pay"
+    REFUND          = "Refund"
+    SETTLE          = "Settle"
+    SETTLE_DEBT     = "SettleDebt"
+    WRITE_OFF_DEBT  = "WriteOffDebt"
+    FUND_PREPAID    = "FundPrepaid"
+  end
+end

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