ianlevesque-remit 0.0.6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2009 Tyler Hunt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,91 @@
+Remit
+=====
+
+This API provides access to the Amazon Flexible Payment Service (FPS). After
+trying to get the SOAP version of the API written, I began working on this REST
+version to provide a cohesive means of access to all of the functionality of
+the FPS without having to get dirty dealing with SOAP requests.
+
+I hope you enjoy using it as much as I've enjoyed writing it. I'm interested to
+hear what sort of uses you find for it. If you find any bugs, let me know (or
+better yet, submit a patch).
+
+
+Sandbox
+-------
+
+Amazon provides a testing environment for the FPS called a sandbox. You may
+(and should) use the sandbox while testing your application. It can be enabled
+by passing a value of true to the last argument of the API constructor.
+
+
+Getting Started
+---------------
+
+The following example shows how to load up the API, initialize the service, and
+make a simple call to get the tokens stored on the account:
+
+    gem 'remit'
+    require 'remit'
+
+    ACCESS_KEY = '<your AWS access key>'
+    SECRET_KEY = '<your AWS secret key>'
+
+    # connect using the API's sandbox mode
+    remit = Remit::API.new(ACCESS_KEY, SECRET_KEY, true)
+
+    response = remit.get_tokens
+    puts response.tokens.first.token_id
+
+
+Using with Rails
+----------------
+
+To use Remit in a Rails application, you must first specify a dependency on the
+Remit gem in your config/environment.rb file:
+
+    config.gem 'remit', :version => '~> 0.0.1'
+
+Then you should create an initializer to configure your Amazon keys. Create the
+file config/initializers/remit.rb with the following contents:
+
+    config_file = File.join(Rails.root, 'config', 'amazon_fps.yml')
+    config = YAML.load_file(config_file)[RAILS_ENV].symbolize_keys
+
+    FPS_ACCESS_KEY = config[:access_key]
+    FPS_SECRET_KEY = config[:secret_key]
+
+Then create the YAML file config/amazon_fps.yml:
+
+    development: &sandbox
+      access_key: <your sandbox access key>
+      secret_key: <your sandbox secret key>
+
+    test:
+      <<: *sandbox
+    
+    production:
+      access_key: <your access key>
+      secret_key: <your secret key>
+
+To instantiate and use the Remit API in your application, you could define a
+method in your ApplicationController like this:
+
+    def remit
+      @remit ||= begin
+        sandbox = !Rails.env.production?
+        Remit::API.new(FPS_ACCESS_KEY, FPS_SECRET_KEY, sandbox)
+      end
+    end
+
+
+Sites Using Remit
+-----------------
+
+The following production sites are currently using Remit:
+
+  * http://www.storenvy.com/
+  * http://www.obsidianportal.com/
+
+
+Copyright (c) 2007-2009 Tyler Hunt, released under the MIT license

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,166 @@
+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'
+    EDIT_TOKEN = 'EditToken'
+  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'
+    SUCCESS_NO_CHANGE = 'SU'  # the existing token was not changed
+  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
+  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

data/lib/remit/get_pipeline.rb

@@ -0,0 +1,195 @@
+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
+
+      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.class == Time
+          
+          query[self.class.convert_key(p.to_s)] = val
+        end
+
+        # Remove any unused optional parameters
+        query.reject! { |key, value| value.nil? }
+
+        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
+    
+    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, 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_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