tylerhunt-remit 0.0.1

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

@@ -0,0 +1,18 @@
+require 'remit/common'
+
+module Remit
+  module GetTokenUsage
+    class Request < Remit::Request
+      action :GetTokenUsage
+      parameter :token_id
+    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/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/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

data/lib/remit/get_transaction.rb

@@ -0,0 +1,42 @@
+require 'remit/common'
+
+module Remit
+  module GetTransaction
+    class Request < Remit::Request
+      action :GetTransaction
+      parameter :transaction_id
+    end
+
+    class Response < Remit::Response
+      class TransactionDetail < Remit::BaseResponse
+        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_message
+        parameter :fees, :type => Amount
+        parameter :meta_data
+        parameter :operation
+        parameter :payment_method
+        parameter :recipient_name
+        parameter :recipient_token_id
+        parameter :related_transactions
+        parameter :sender_name
+        parameter :sender_token_id
+        parameter :status
+        parameter :status_history
+        parameter :transaction_amount, :type => Amount
+        parameter :transaction_id
+        parameter :transaction_parts
+      end
+
+      parameter :transaction, :type => TransactionDetail
+    end
+
+    def get_transaction(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/install_payment_instruction.rb

@@ -0,0 +1,22 @@
+require 'remit/common'
+
+module Remit
+  module InstallPaymentInstruction
+    class Request < Remit::Request
+      action :InstallPaymentInstruction
+      parameter :payment_instruction
+      parameter :caller_reference
+      parameter :token_friendly_name
+      parameter :token_type
+      parameter :payment_reason
+    end
+
+    class Response < Remit::Response
+      parameter :token_id
+    end
+
+    def install_payment_instruction(request)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/pay.rb

@@ -0,0 +1,34 @@
+require 'remit/common'
+
+module Remit
+  module Pay
+    class Request < Remit::Request
+      action :Pay
+      parameter :caller_description
+      parameter :caller_reference
+      parameter :caller_token_id
+      parameter :charge_fee_to
+      parameter :meta_data
+      parameter :recipient_description
+      parameter :recipient_reference
+      parameter :recipient_token_id
+      parameter :sender_description
+      parameter :sender_reference
+      parameter :sender_token_id
+      parameter :transaction_amount, :type => Remit::RequestTypes::Amount
+      parameter :transaction_date
+    end
+
+    class Response < Remit::Response
+      # FIXME: Due to an issue with Hpricot, Relax-0.0.4, and namespaces, the
+      # transaction_response parameter is not parsed correctly and will always
+      # be nil (http://groups.google.com/group/remit/t/1e0af072200d1bb3).
+      # The suggested course of action is to operate on the raw XML.
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def pay(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/refund.rb

@@ -0,0 +1,38 @@
+require 'remit/common'
+
+module Remit
+  module Refund
+    class Request < Remit::Request
+      action :Refund
+      parameter :caller_description
+      parameter :caller_reference
+      parameter :caller_token_id
+      parameter :charge_fee_to
+      parameter :meta_data
+      parameter :refund_amount, :type => Remit::RequestTypes::Amount
+      parameter :refund_recipient_description
+      parameter :refund_recipient_reference
+      parameter :refund_sender_description
+      parameter :refund_sender_reference
+      parameter :refund_sender_token_id
+      parameter :transaction_date
+      parameter :transaction_id
+      
+      
+      # The RefundAmount parameter has multiple components.  It is specified on the query string like
+      # so: RefundAmount.Amount=XXX&RefundAmount.CurrencyCode=YYY
+      def convert_complex_key(key, parameter)
+        "#{convert_key(key).to_s}.#{convert_key(parameter).to_s}"
+      end
+      
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def refund(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/reserve.rb

@@ -0,0 +1,30 @@
+require 'remit/common'
+
+module Remit
+  module Reserve
+    class Request < Remit::Request
+      action :Reserve
+      parameter :recipient_token_id
+      parameter :sender_token_id
+      parameter :caller_token_id
+      parameter :sender_reference
+      parameter :recipient_reference
+      parameter :caller_reference
+      parameter :transaction_date
+      parameter :transaction_amount
+      parameter :charge_fee_to
+      parameter :sender_description
+      parameter :recipient_description
+      parameter :caller_description
+      parameter :meta_data
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def reserve(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/retry_transaction.rb

@@ -0,0 +1,18 @@
+require 'remit/common'
+
+module Remit
+  module RetryTransaction
+    class Request < Remit::Request
+      action :RetryTransaction
+      parameter :original_transaction_id
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def retry_transaction(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/settle.rb

@@ -0,0 +1,20 @@
+require 'remit/common'
+
+module Remit
+  module Settle
+    class Request < Remit::Request
+      action :Settle
+      parameter :settlement_amount
+      parameter :transaction_id
+      parameter :transaction_date
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def settle(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/settle_debt.rb

@@ -0,0 +1,30 @@
+require 'remit/common'
+
+module Remit
+  module SettleDebt
+    class Request < Remit::Request
+      action :SettleDebt
+      parameter :caller_description
+      parameter :caller_reference
+      parameter :caller_token_id
+      parameter :charge_fee_to
+      parameter :credit_instrument_id
+      parameter :meta_data
+      parameter :recipient_description
+      parameter :recipient_reference
+      parameter :sender_description
+      parameter :sender_reference
+      parameter :sender_token_id
+      parameter :settlement_amount
+      parameter :transaction_date
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def settle_debt(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/subscribe_for_caller_notification.rb

@@ -0,0 +1,18 @@
+require 'remit/common'
+
+module Remit
+  module SubscribeForCallerNotification
+    class Request < Remit::Request
+      action :SubscribeForCallerNotification
+      parameter :notification_operation_name
+      parameter :web_service_api_url
+    end
+
+    class Response < Remit::Response
+    end
+
+    def subscribe_for_caller_notification(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/unsubscribe_for_caller_notification.rb

@@ -0,0 +1,17 @@
+require 'remit/common'
+
+module Remit
+  module UnsubscribeForCallerNotification
+    class Request < Remit::Request
+      action :UnSubscribeForCallerNotification
+      parameter :notification_operation_name
+    end
+
+    class Response < Remit::Response
+    end
+
+    def unsubscribe_for_caller_notification(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/write_off_debt.rb

@@ -0,0 +1,28 @@
+require 'remit/common'
+
+module Remit
+  module WriteOffDebt
+    class Request < Remit::Request
+      action :WriteOffDebt
+      parameter :caller_token_id
+      parameter :credit_instrument_id
+      parameter :adjustment_amount
+      parameter :transaction_date
+      parameter :sender_reference
+      parameter :caller_reference
+      parameter :recipient_reference
+      parameter :sender_description
+      parameter :recipient_description
+      parameter :caller_description
+      parameter :meta_data
+    end
+
+    class Response < Remit::Response
+      parameter :transaction_response, :type => TransactionResponse
+    end
+
+    def write_off_debt(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit.rb

@@ -0,0 +1,123 @@
+$:.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'
+require 'relax'
+
+require 'remit/common'
+require 'remit/data_types'
+
+require 'remit/cancel_token'
+require 'remit/discard_results'
+require 'remit/fund_prepaid'
+require 'remit/get_account_activity'
+require 'remit/get_account_balance'
+require 'remit/get_all_credit_instruments'
+require 'remit/get_all_prepaid_instruments'
+require 'remit/get_debt_balance'
+require 'remit/get_outstanding_debt_balance'
+require 'remit/get_payment_instruction'
+require 'remit/get_pipeline'
+require 'remit/get_prepaid_balance'
+require 'remit/get_results'
+require 'remit/get_token_usage'
+require 'remit/get_tokens'
+require 'remit/get_token_by_caller'
+require 'remit/get_total_prepaid_liability'
+require 'remit/get_transaction'
+require 'remit/install_payment_instruction'
+require 'remit/pay'
+require 'remit/refund'
+require 'remit/reserve'
+require 'remit/retry_transaction'
+require 'remit/settle'
+require 'remit/settle_debt'
+require 'remit/subscribe_for_caller_notification'
+require 'remit/unsubscribe_for_caller_notification'
+require 'remit/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/'
+    API_SANDBOX = 'https://fps.sandbox.amazonaws.com/'
+    PIPELINE_ENDPOINT = 'https://authorize.payments.amazon.com/cobranded-ui/actions/start'
+    PIPELINE_SANDBOX = 'https://authorize.payments-sandbox.amazon.com/cobranded-ui/actions/start'
+    API_VERSION = Date.new(2007, 1, 8).to_s
+    SIGNATURE_VERSION = 1
+
+    attr_reader :pipeline
+    attr_reader :access_key
+    attr_reader :secret_key
+
+    def initialize(access_key, secret_key, sandbox = false)
+      super((not sandbox) ? API_ENDPOINT : API_SANDBOX)
+      @pipeline = ((not sandbox) ? PIPELINE_ENDPOINT : PIPELINE_SANDBOX)
+      @access_key = access_key
+      @secret_key = secret_key
+    end
+
+    private
+
+    def new_query(query = {})
+      SignedQuery.new(@endpoint, @secret_key, query)
+    end
+
+    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
+
+    def query(request)
+      query = super
+      query[:Signature] = sign(query)
+      query
+    end
+
+    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
+  end
+end

data/spec/get_account_activity_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'a GetAccountActivity call' do
+  it_should_behave_like 'a successful request'
+
+  before(:all) do
+    request = Remit::API::GetAccountActivityRequest.new
+    request.start_date = Date.today - 7
+    @response = @remit.get_account_activity(request)
+  end
+
+  it 'should have a collection of transactions' do
+    @response.should have_at_least(1).transactions
+  end
+
+  it 'should have a transaction with all of its values set' do
+    transaction = @response.transactions.first
+    transaction.caller_name.should_not be_empty
+    transaction.caller_token_id.should_not be_empty
+    transaction.caller_transaction_date.should_not be_nil
+    transaction.date_completed.should_not be_nil
+    transaction.date_received.should_not be_nil
+    transaction.error_code.should be_empty
+    transaction.error_detail.should be_nil
+    transaction.error_message.should be_nil
+    transaction.fees.should_not be_nil
+    transaction.operation.should_not be_empty
+    transaction.recipient_name.should_not be_empty
+    transaction.sender_name.should_not be_empty
+    transaction.sender_token_id.should_not be_empty
+    transaction.status.should_not be_empty
+    transaction.transaction_amount.should_not be_nil
+    transaction.transaction_id.should_not be_empty
+    transaction.transaction_parts.should_not be_empty
+  end
+end

data/spec/get_pipeline_spec.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'A pipeline', :shared => true do
+  before do
+    @remit = Remit::API.new(ACCESS_KEY, SECRET_KEY, true)
+
+    @pipeline_options = {
+      :return_URL => 'http://example.com/'
+    }
+  end
+
+  it 'should sign its URL' do
+    uri = URI.parse(@pipeline.url)
+    pipeline = Remit::SignedQuery.parse(uri, @remit.secret_key, uri.query)
+    query = Relax::Query.parse(uri)
+
+    pipeline[:awsSignature].should == query[:awsSignature]
+  end
+end
+
+describe 'A single-use pipeline' do
+  it_should_behave_like 'A pipeline'
+
+  before do
+    @pipeline_options.merge!({
+      :transaction_amount => 10,
+      :caller_reference => 'N2PCBEIA5864E27EL7C86PJL1FGUGPBL61QTJJM5GQK265SPEN8ZKIJPMQARDVJK',
+      :recipient_token => 'N5PCME5A5Q6FE2QEB7CD64JLGFTUGXBE61HTCJMGGAK2R5IPEQ8EKIVP3QAVD7JP',
+      :pipeline_name => Remit::PipelineName::SINGLE_USE
+    })
+
+    @pipeline = @remit.get_single_use_pipeline(@pipeline_options)
+  end
+
+  it 'should ignore unused parameters' do
+    uri = URI.parse(@pipeline.url)
+    query = Relax::Query.parse(uri)
+    
+    query[:paymentReason].should be_nil
+  end
+end
+
+describe 'A recurring-use pipeline' do
+  it_should_behave_like 'A pipeline'
+
+  before do
+    @validity_start = Time.now + (3600 * 24)  # 1 day from now
+    @validity_expiry = Time.now + (3600 * 24 * 180) # ~6 months from now
+    @recurring_period = '1 Month'
+    
+    @pipeline_options.merge!({
+      :pipeline_name => Remit::PipelineName::RECURRING,
+      :validity_start => @validity_start,
+      :validity_expiry => @validity_expiry,
+      :recurring_period => @recurring_period,
+      :transaction_amount => 10,
+      :caller_reference => 'N2PCBEIA5864E27EL7C86PJL1FGUGPBL61QTJJM5GQK265SPEN8ZKIJPMQARDVJK',
+      :recipient_token => 'N5PCME5A5Q6FE2QEB7CD64JLGFTUGXBE61HTCJMGGAK2R5IPEQ8EKIVP3QAVD7JP'
+    })
+    
+    @pipeline = @remit.get_recurring_use_pipeline(@pipeline_options)
+  end
+
+  it 'should convert times to seconds from epoch' do
+    uri = URI.parse(@pipeline.url)
+    query = Relax::Query.parse(uri)
+    
+    @validity_start.to_i.to_s.should == query[:validityStart]
+    @validity_expiry.to_i.to_s.should == query[:validityExpiry]
+  end
+  
+  it 'should allow time in seconds' do
+    options = @pipeline_options.merge({
+      :validity_start => @validity_start.to_i,
+      :validity_expiry => @validity_expiry.to_i
+    })
+    @pipeline = @remit.get_recurring_use_pipeline(options)
+    
+    uri = URI.parse(@pipeline.url)
+    query = Relax::Query.parse(uri)
+    
+    @validity_start.to_i.to_s.should == query[:validityStart]
+    @validity_expiry.to_i.to_s.should == query[:validityExpiry]
+  end
+end
+
+describe 'A postpaid pipeline' do
+  it_should_behave_like 'A pipeline'
+  
+  before do
+    @credit_limit = 100
+    @global_amount_limit = 100
+    
+    @pipeline_options.merge!({
+      :pipeline_name => Remit::PipelineName::SETUP_POSTPAID,
+      :credit_limit => @credit_limit,
+      :global_amount_limit => @global_amount_limit
+    })
+    
+    @pipeline = @remit.get_postpaid_pipeline(@pipeline_options)
+  end
+  
+  it 'should create a PostpaidPipeline' do
+    @pipeline.class.should == Remit::GetPipeline::PostpaidPipeline
+  end
+end