tylerhunt-remit 0.0.1 → 0.0.4

data/lib/remit/{settle_debt.rb → operations/settle_debt.rb}

@@ -5,17 +5,17 @@ module Remit
     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 :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
-      parameter :settlement_amount
+      parameter :sender_token_id, :required => true
+      parameter :settlement_amount, :type => Remit::RequestTypes::Amount, :required => true
       parameter :transaction_date
     end
 

data/lib/remit/{subscribe_for_caller_notification.rb → operations/subscribe_for_caller_notification.rb}

@@ -4,8 +4,8 @@ module Remit
   module SubscribeForCallerNotification
     class Request < Remit::Request
       action :SubscribeForCallerNotification
-      parameter :notification_operation_name
-      parameter :web_service_api_url
+      parameter :notification_operation_name, :required => true
+      parameter :web_service_api_url, :required => true
     end
 
     class Response < Remit::Response

data/lib/remit/{unsubscribe_for_caller_notification.rb → operations/unsubscribe_for_caller_notification.rb}

@@ -4,7 +4,7 @@ module Remit
   module UnsubscribeForCallerNotification
     class Request < Remit::Request
       action :UnSubscribeForCallerNotification
-      parameter :notification_operation_name
+      parameter :notification_operation_name, :required => true
     end
 
     class Response < Remit::Response

data/lib/remit/{write_off_debt.rb → operations/write_off_debt.rb}

@@ -4,12 +4,12 @@ module Remit
   module WriteOffDebt
     class Request < Remit::Request
       action :WriteOffDebt
-      parameter :caller_token_id
-      parameter :credit_instrument_id
-      parameter :adjustment_amount
+      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
+      parameter :caller_reference, :required => true
       parameter :recipient_reference
       parameter :sender_description
       parameter :recipient_description

data/lib/remit/pipeline_response.rb

@@ -0,0 +1,52 @@
+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_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/spec/{get_account_activity_spec.rb → integrations/get_account_activity_spec.rb}

@@ -1,12 +1,12 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/integrations_helper'
 
 describe 'a GetAccountActivity call' do
-  it_should_behave_like 'a successful request'
+  it_should_behave_like 'a successful response'
 
   before(:all) do
-    request = Remit::API::GetAccountActivityRequest.new
+    request = Remit::GetAccountActivity::Request.new
     request.start_date = Date.today - 7
-    @response = @remit.get_account_activity(request)
+    @response = remit.get_account_activity(request)
   end
 
   it 'should have a collection of transactions' do

data/spec/{get_tokens_spec.rb → integrations/get_tokens_spec.rb}

@@ -1,10 +1,10 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/integrations_helper'
 
 describe 'a GetTokens call' do
-  it_should_behave_like 'a successful request'
+  it_should_behave_like 'a successful response'
 
   before(:all) do
-    @response = @remit.get_tokens
+    @response = remit.get_tokens
   end
 
   it 'should have a collection of tokens' do

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

@@ -1,19 +1,15 @@
+require 'rubygems'
 require 'spec'
 
 require File.dirname(__FILE__) + '/../lib/remit'
 
-fail unless ENV.include?('AWS_ACCESS_KEY') and ENV.include?('AWS_SECRET_KEY')
-
-ACCESS_KEY = ENV['AWS_ACCESS_KEY'] unless defined?(ACCESS_KEY)
-SECRET_KEY = ENV['AWS_SECRET_KEY'] unless defined?(SECRET_KEY)
-
-describe 'a successful request', :shared => true do
-  before(:all) do
-    @remit = Remit::API.new(ACCESS_KEY, SECRET_KEY, true)
-  end
+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 eql('Success')
+    @response.status.should == 'Success'
   end
 
   it 'should not have any errors' do
@@ -24,3 +20,17 @@ describe 'a successful request', :shared => true 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/{get_pipeline_spec.rb → units/get_pipeline_spec.rb}

@@ -1,17 +1,15 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/units_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/'
+      :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)
+    pipeline = Remit::SignedQuery.parse(uri, remit.secret_key, uri.query)
     query = Relax::Query.parse(uri)
 
     pipeline[:awsSignature].should == query[:awsSignature]
@@ -25,19 +23,74 @@ describe 'A single-use pipeline' do
     @pipeline_options.merge!({
       :transaction_amount => 10,
       :caller_reference => 'N2PCBEIA5864E27EL7C86PJL1FGUGPBL61QTJJM5GQK265SPEN8ZKIJPMQARDVJK',
-      :recipient_token => 'N5PCME5A5Q6FE2QEB7CD64JLGFTUGXBE61HTCJMGGAK2R5IPEQ8EKIVP3QAVD7JP',
-      :pipeline_name => Remit::PipelineName::SINGLE_USE
+      :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_single_use_pipeline(@pipeline_options)
+    @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
@@ -47,9 +100,8 @@ describe 'A recurring-use pipeline' 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,
@@ -57,50 +109,57 @@ describe 'A recurring-use pipeline' do
       :caller_reference => 'N2PCBEIA5864E27EL7C86PJL1FGUGPBL61QTJJM5GQK265SPEN8ZKIJPMQARDVJK',
       :recipient_token => 'N5PCME5A5Q6FE2QEB7CD64JLGFTUGXBE61HTCJMGGAK2R5IPEQ8EKIVP3QAVD7JP'
     })
-    
-    @pipeline = @remit.get_recurring_use_pipeline(@pipeline_options)
+
+    @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)
-    
+    @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!({
-      :pipeline_name => Remit::PipelineName::SETUP_POSTPAID,
       :credit_limit => @credit_limit,
       :global_amount_limit => @global_amount_limit
     })
-    
-    @pipeline = @remit.get_postpaid_pipeline(@pipeline_options)
+
+    @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