ianlevesque-remit 0.0.6

data/lib/remit/operations/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, :required => true
+      parameter :caller_token_id, :required => true
+      parameter :charge_fee_to, :required => true
+      parameter :credit_instrument_id, :required => true
+      parameter :meta_data
+      parameter :recipient_description
+      parameter :recipient_reference
+      parameter :sender_description
+      parameter :sender_reference
+      parameter :sender_token_id, :required => true
+      parameter :settlement_amount, :type => Remit::RequestTypes::Amount, :required => true
+      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/operations/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, :required => true
+      parameter :web_service_api_url, :required => true
+    end
+
+    class Response < Remit::Response
+    end
+
+    def subscribe_for_caller_notification(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/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, :required => true
+    end
+
+    class Response < Remit::Response
+    end
+
+    def unsubscribe_for_caller_notification(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit/operations/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, :required => true
+      parameter :credit_instrument_id, :required => true
+      parameter :adjustment_amount, :required => true
+      parameter :transaction_date
+      parameter :sender_reference
+      parameter :caller_reference, :required => true
+      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/pipeline_response.rb

@@ -0,0 +1,53 @@
+module Remit
+  class PipelineResponse
+    def initialize(uri, secret_key)
+      @uri        = URI.parse(uri)
+      @secret_key = secret_key
+    end
+
+    # Returns +true+ if the response is correctly signed (awsSignature).
+    #
+    #--
+    # The unescape_value method is used here because the awsSignature value
+    # pulled from the request is filtered through the same method.
+    #++
+    def valid?
+      return false unless given_signature
+      Relax::Query.unescape_value(correct_signature) == given_signature
+    end
+
+    # Returns +true+ if the response returns a successful state.
+    def successful?
+      [
+        Remit::PipelineStatusCode::SUCCESS_ABT,
+        Remit::PipelineStatusCode::SUCCESS_ACH,
+        Remit::PipelineStatusCode::SUCCESS_CC,
+        Remit::PipelineStatusCode::SUCCESS_NO_CHANGE,
+        Remit::PipelineStatusCode::SUCCESS_RECIPIENT_TOKEN_INSTALLED
+      ].include?(request_query[:status])
+    end
+
+    def method_missing(method, *args) #:nodoc:
+      if request_query.has_key?(method.to_sym)
+        request_query[method.to_sym]
+      else
+        super
+      end
+    end
+
+    def request_query(reload = false)
+      @query ||= Remit::SignedQuery.parse(@uri, @secret_key, @uri.query || '')
+    end
+    private :request_query
+
+    def given_signature
+      request_query[:awsSignature]
+    end
+    private :given_signature
+
+    def correct_signature
+      Remit::SignedQuery.new(@uri.path, @secret_key, request_query).sign
+    end
+    private :correct_signature
+  end
+end

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 'relax', '0.0.7'
+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/spec/integrations/get_account_activity_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/integrations_helper'
+
+describe 'a GetAccountActivity call' do
+  it_should_behave_like 'a successful response'
+
+  before(:all) do
+    request = Remit::GetAccountActivity::Request.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/integrations/get_tokens_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/integrations_helper'
+
+describe 'a GetTokens call' do
+  it_should_behave_like 'a successful response'
+
+  before(:all) do
+    @response = remit.get_tokens
+  end
+
+  it 'should have a collection of tokens' do
+    @response.should have_at_least(1).tokens
+  end
+
+  it 'should have a token with all of its values set' do
+    token = @response.tokens.first
+    token.token_id.should_not be_empty
+    token.friendly_name.should_not be_empty
+    token.status.should_not be_empty
+    token.date_installed.should_not be_nil
+    token.caller_installed.should_not be_empty
+    token.caller_reference.should_not be_empty
+    token.token_type.should_not be_empty
+    token.old_token_id.should_not be_empty
+    token.payment_reason.should_not be_empty
+  end
+
+  it 'should have a token with a token ID' do
+    @response.tokens.first.token_id.should_not be_empty
+  end
+
+  it 'should have a token with a valid token status' do
+    @response.tokens.first.status.should match(/^(IN)?ACTIVE$/i)
+  end
+
+  it 'should have a token with a valid installation date' do
+    @response.tokens.first.date_installed.should be_a_kind_of(Time)
+  end
+end

data/spec/integrations/integrations_helper.rb

@@ -0,0 +1,8 @@
+ACCESS_KEY = ENV['AWS_ACCESS_KEY'] || ENV['AMAZON_ACCESS_KEY_ID']
+SECRET_KEY = ENV['AWS_SECRET_KEY'] || ENV['AMAZON_SECRET_ACCESS_KEY']
+
+unless ACCESS_KEY and SECRET_KEY
+  raise RuntimeError, "You must set your AWS_ACCESS_KEY and AWS_SECRET_KEY environment variables to run integration tests"
+end
+
+require File.dirname(__FILE__) + '/../spec_helper'

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/remit'
+
+def remit
+  @remit ||= Remit::API.new(ACCESS_KEY, SECRET_KEY, true)
+end
+
+describe 'a successful response', :shared => true do
+  it 'should return success' do
+    @response.status.should == 'Success'
+  end
+
+  it 'should not have any errors' do
+    @response.errors.should be_nil
+  end
+
+  it 'should have a request ID' do
+    @response.request_id.should_not be_nil
+  end
+end
+
+describe 'a failed response', :shared => true do
+  it "is not successful" do
+    @response.should_not be_successful
+  end
+
+  it "has a request id" do
+    @response.request_id.should_not be_empty
+  end
+
+  it "has errors" do
+    @response.errors.should_not be_empty
+  end
+end

data/spec/units/get_pipeline_spec.rb

@@ -0,0 +1,165 @@
+require File.dirname(__FILE__) + '/units_helper'
+
+describe 'A pipeline', :shared => true do
+  before do
+    @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 = 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
+
+  it 'should have the right name' do
+    @pipeline.pipeline_name.should == Remit::PipelineName::SINGLE_USE
+  end
+end
+
+describe 'A multi-use pipeline' do
+  it_should_behave_like 'A pipeline'
+
+  before do
+    @pipeline_options.merge!({
+      :transaction_amount => 10,
+      :caller_reference => 'N2PCBEIA5864E27EL7C86PJL1FGUGPBL61QTJJM5GQK265SPEN8ZKIJPMQARDVJK',
+      :recipient_token_list => 'N5PCME5A5Q6FE2QEB7CD64JLGFTUGXBE61HTCJMGGAK2R5IPEQ8EKIVP3QAVD7JP'
+    })
+
+    @pipeline = remit.get_multi_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
+
+  it 'should have the right name' do
+    @pipeline.pipeline_name.should == Remit::PipelineName::MULTI_USE
+  end
+end
+
+describe 'A recipient pipeline' do
+  it_should_behave_like 'A pipeline'
+
+  before do
+    @validity_start   = Time.now + (3600 * 24) # 1 day from now
+    @validity_expiry  = Time.now + (2600 * 24 * 180) # ~6 months from now
+
+    @pipeline_options.merge!({
+      :validity_start => @validity_start,
+      :validity_expiry  => @validity_expiry,
+      :caller_reference => 'N2PCBEIA5864E27EL7C86PJL1FGUGPBL61QTJJM5GQK265SPEN8ZKIJPMQARDVJK',
+      :max_variable_fee => '0.25',
+      :recipient_pays_fee => true
+    })
+
+    @pipeline = remit.get_recipient_pipeline(@pipeline_options)
+  end
+
+  it 'should have the recipient pay marketplace fees' do
+    @pipeline.url.should match(/recipientPaysFee=true/)
+  end
+
+  it 'should have the right name' do
+    @pipeline.pipeline_name.should == Remit::PipelineName::RECIPIENT
+  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!({
+      :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
+
+  it 'should have the right name' do
+    @pipeline.pipeline_name.should == Remit::PipelineName::RECURRING
+  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!({
+      :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
+
+  it 'should have the right name' do
+    @pipeline.pipeline_name.should == Remit::PipelineName::SETUP_POSTPAID
+  end
+end

data/spec/units/get_results_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/units_helper'
+
+describe "the GetResults API" do
+  describe "a successful response" do
+    it_should_behave_like 'a successful response'
+
+    before do
+      doc = <<-XML
+        <?xml version=\"1.0\"?>
+        <ns3:GetResultsResponse xmlns:ns3=\"http://fps.amazonaws.com/doc/2007-01-08/\">
+          <TransactionResults>
+            <TransactionId>abc123</TransactionId>
+            <Operation>Pay</Operation>
+            <CallerReference>1827</CallerReference>
+            <Status>Success</Status>
+          </TransactionResults>
+          <NumberPending>1</NumberPending>
+          <Status>Success</Status>
+          <RequestId>f89727ba-9ff6-4ca8-87a3-0fd6c9de6b95:0</RequestId>
+        </ns3:GetResultsResponse>
+      XML
+
+      @response = Remit::GetResults::Response.new(doc)
+    end
+
+    it "has one result" do
+      @response.number_pending.should == 1
+      @response.transaction_results.size == "1"
+    end
+
+    describe "the result" do
+      before do
+        @result = @response.transaction_results.first
+      end
+
+      it "references a previous transaction" do
+        @result.transaction_id.should == "abc123"
+      end
+
+      it "references a pay transaction" do
+        @result.operation_type.should == 'Pay'
+      end
+
+      it "reports the transaction's new status" do
+        @result.transaction_status.should == 'Success'
+      end
+    end
+  end
+end

data/spec/units/ipn_request_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/units_helper'
+
+describe 'an IPN request' do
+  before(:each) do
+    @request_params = {
+      "action"            => "notice",
+      "buyerName"         => "Fps Buyer",
+      "callerReference"   => "4-8-1-3.5",
+      "controller"        => "amazon_fps/ipn",
+      "operation"         => "PAY",
+      "paymentMethod"     => "CC",
+      "recipientEmail"    => "recipient@email.url",
+      "recipientName"     => "Fps Business",
+      "signature"         => "DA7ZbuQaBDt2/+Mty9XweJyqI1E=",
+      "status"            => "SUCCESS",
+      "transactionAmount" => "USD 3.50",
+      "transactionDate"   => "1224687134",
+      "transactionId"     => "13KIGL9RC25853BGPPOS2VSKBKF2JERR3HO"
+    }
+    @request = Remit::IpnRequest.new(@request_params, 'THISISMYTESTKEY')
+  end
+
+  it 'should be a valid request' do
+    @request.should be_valid
+  end
+
+  it 'should pass through access to given parameters' do
+    @request.status.should == 'SUCCESS'
+    @request.operation.should == 'PAY'
+    @request.transactionId.should == '13KIGL9RC25853BGPPOS2VSKBKF2JERR3HO'
+  end
+end