tylerhunt-remit 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2008 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

@@ -0,0 +1,38 @@
+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.
+
+
+Example
+-------
+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:
+
+  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
+
+
+Copyright (c) 2007-2008 Tyler Hunt, released under the MIT license

data/lib/remit/cancel_token.rb

@@ -0,0 +1,18 @@
+require 'remit/common'
+
+module Remit
+  module CancelToken
+    class Request < Remit::Request
+      action :CancelToken
+      parameter :token_id
+      parameter :reason_text
+    end
+
+    class Response < Remit::Response
+    end
+
+    def cancel_token(request = Request.new)
+      call(request, Response)
+    end
+  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
+
+    protected
+
+    def convert_key(key)
+      key.to_s.gsub(/(^|_)(.)/) { $2.upcase }.to_sym
+    end
+  end
+
+  class BaseResponse < Relax::Response
+    private
+
+    def node_name(name)
+      name.to_s.gsub(/(^|_)(.)/) { $2.upcase }
+    end
+  end
+
+  class Response < BaseResponse
+    parameter :request_id
+    attr_accessor :status
+    attr_accessor :errors
+
+    def initialize(xml)
+      super
+
+      if is?(:Response) and 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 if not successful?
+      end
+    end
+
+    def successful?
+      @status == ResponseStatus::SUCCESS
+    end
+
+    private
+
+    def node_name(name)
+      name.to_s.gsub(/(^|_)(.)/) { $2.upcase }
+    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_if { |key, value| key == :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('=')
+          query[key] = unescape_value(value)
+        end
+        query
+      end
+    end
+  end
+end

data/lib/remit/data_types.rb

@@ -0,0 +1,107 @@
+require 'rubygems'
+require 'relax'
+
+require 'remit/common'
+
+module Remit
+  class Amount < BaseResponse
+    parameter :currency_code
+    parameter :amount, :type => :float
+  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
+  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
+  
+  module RequestTypes
+    class Amount < Remit::Request
+      parameter :amount
+      parameter :currency_code
+    end
+  end
+end

data/lib/remit/discard_results.rb

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

data/lib/remit/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
+      parameter :caller_token_id
+      parameter :charge_fee_to
+      parameter :funding_amount
+      parameter :meta_data
+      parameter :prepaid_instrument_id
+      parameter :recipient_description
+      parameter :recipient_reference
+      parameter :sender_description
+      parameter :sender_reference
+      parameter :sender_token_id
+      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/get_account_activity.rb

@@ -0,0 +1,60 @@
+require 'remit/common'
+
+module Remit
+  module GetAccountActivity
+    class Request < Remit::Request
+      action :GetAccountActivity
+      parameter :start_date
+      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/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/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/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/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
+    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/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/get_payment_instruction.rb

@@ -0,0 +1,21 @@
+require 'remit/common'
+
+module Remit
+  module GetPaymentInstruction
+    class Request < Remit::Request
+      action :GetPaymentInstruction
+      parameter :token_id
+    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/get_pipeline.rb

@@ -0,0 +1,123 @@
+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
+
+      def initialize(api, pipeline, options)
+        @api = api
+        @pipeline = pipeline
+        
+        options.each do |k,v|
+          self.send("#{k}=", v)
+        end
+      end
+
+      def url
+        uri = URI.parse(@pipeline)
+        
+        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, @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
+    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
+    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
+    end
+    
+    def get_single_use_pipeline(options)
+      self.get_pipeline(SingleUsePipeline, 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, @pipeline, {
+        :caller_key => @access_key
+      }.merge(options))
+    end
+  end
+end

data/lib/remit/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
+    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/get_results.rb

@@ -0,0 +1,26 @@
+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
+        parameter :caller_reference
+        parameter :transaction_status
+      end
+
+      parameter :transaction_results, :type => TransactionResults
+    end
+
+    def get_results(request = Request.new)
+      call(request, Response)
+    end
+  end
+end