remit 0.0.6 → 2.0.1

data/lib/remit/operations/refund.rb

@@ -6,28 +6,37 @@ module Remit
       action :Refund
       parameter :caller_description
       parameter :caller_reference, :required => true
-      parameter :caller_token_id, :required => true
-      parameter :charge_fee_to, :required => true
-      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, :required => true
-      parameter :transaction_date
       parameter :transaction_id, :required => true
+      #MarketplaceRefundPolicy is available in these APIs:
+      # Amazon FPS Advanced Quick Start
+      # Amazon FPS Marketplace Quick Start
+      # Amazon FPS Aggregated Payments Quick Start
+      # i.e. Not Basic Quick Start
+      #Amazon Docs now correctly list it as an Enumerated DataType
+      parameter :marketplace_refund_policy
+      parameter :timestamp
+# TODO: Check these parameters in Latest FPS API
+#      parameter :refund_recipient_description
+#      parameter :refund_recipient_reference
+#      parameter :refund_sender_description
+#      parameter :refund_sender_reference
+#      parameter :refund_sender_token_id
+#      parameter :transaction_date
 
       # 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}"
+        "#{convert_key(key)}.#{convert_key(parameter)}"
       end
     end
 
     class Response < Remit::Response
       parser :rexml
-      parameter :transaction_response, :namespace => 'ns3', :type => TransactionResponse
+#Namespace changed with new API:
+#      parameter :transaction_response, :namespace => 'ns3', :type => TransactionResponse
+      parameter :refund_result, :type => Remit::TransactionResponse
+      parameter :response_metadata, :type => ResponseMetadata
     end
 
     def refund(request = Request.new)

data/lib/remit/operations/reserve.rb

@@ -6,7 +6,6 @@ module Remit
       action :Reserve
       parameter :recipient_token_id, :required => true
       parameter :sender_token_id, :required => true
-      parameter :caller_token_id, :required => true
       parameter :sender_reference
       parameter :recipient_reference
       parameter :caller_reference, :required => true
@@ -14,13 +13,12 @@ module Remit
       parameter :transaction_amount, :type => Remit::RequestTypes::Amount, :required => true
       parameter :charge_fee_to, :required => true
       parameter :sender_description
-      parameter :recipient_description
       parameter :caller_description
-      parameter :meta_data
     end
 
     class Response < Remit::Response
-      parameter :transaction_response, :type => TransactionResponse
+      parameter :reserve_result, :type => Remit::TransactionResponse
+      parameter :response_metadata, :type=>ResponseMetadata
     end
 
     def reserve(request = Request.new)

data/lib/remit/operations/settle.rb

@@ -10,7 +10,8 @@ module Remit
     end
 
     class Response < Remit::Response
-      parameter :transaction_response, :type => TransactionResponse
+      parameter :settle_result, :type => Remit::TransactionResponse
+      parameter :response_metadata, :type=>ResponseMetadata
     end
 
     def settle(request = Request.new)

data/lib/remit/operations/settle_debt.rb

@@ -6,11 +6,8 @@ module Remit
       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
@@ -20,7 +17,8 @@ module Remit
     end
 
     class Response < Remit::Response
-      parameter :transaction_response, :type => TransactionResponse
+      parameter :settle_debt_result, :type => Remit::TransactionResponse
+      parameter :response_metadata, :type=>ResponseMetadata
     end
 
     def settle_debt(request = Request.new)

data/lib/remit/operations/subscribe_for_caller_notification.rb

@@ -1,5 +1,7 @@
 require 'remit/common'
 
+# This action seems to have been deprecated
+
 module Remit
   module SubscribeForCallerNotification
     class Request < Remit::Request

data/lib/remit/operations/unsubscribe_for_caller_notification.rb

@@ -1,5 +1,7 @@
 require 'remit/common'
 
+# This action seems to have been deprecated
+
 module Remit
   module UnsubscribeForCallerNotification
     class Request < Remit::Request

data/lib/remit/operations/write_off_debt.rb

@@ -4,7 +4,6 @@ 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
@@ -12,13 +11,12 @@ module Remit
       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
+      parameter :write_off_debt_result, :type => Remit::TransactionResponse
+      parameter :response_metadata, :type=>ResponseMetadata
     end
 
     def write_off_debt(request = Request.new)

data/lib/remit/pipeline_response.rb

@@ -1,53 +1,20 @@
 module Remit
-  class PipelineResponse
-    def initialize(params, uri, access_key, secret_key)
-      @params = strip_keys_from(params, 'action', 'controller', 'id')
-      @uri = URI.parse(uri)
-      @url_end_point = @uri.scheme + '://' + @uri.host + @uri.path
-      @access_key = access_key
-      @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?
-      utils = Amazon::FPS::SignatureUtilsForOutbound.new(@access_key, @secret_key);
-      utils.validate_request(:parameters => @params, :url_end_point => @url_end_point, :http_method => "GET")
-    end
 
-    # Returns +true+ if the response returns a successful state.
+  class PipelineResponse < InboundRequest
+    # signature key name
+    SIGNATURE_KEY = 'awsSignature'
+    
     def successful?
       [
+        Remit::PipelineStatusCode::SUCCESS_UNCHANGED,
         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
+      ].include?(@hash_params['status']) #:status])
+      # BJM: 'status' not :status
 
-    def strip_keys_from(params, *ignore_keys)
-      parsed = params.dup
-      ignore_keys.each { |key| parsed.delete(key) }
-      parsed
     end
-    private :strip_keys_from
-
   end
+
 end

data/lib/remit/signature_utils_for_outbound.rb

@@ -0,0 +1,74 @@
+require 'base64'
+require 'cgi'
+#require 'openssl'
+#require 'net/http'
+#require 'net/https'
+
+#Lifted From Amazon FPSRuby Code example and then refactored for remit
+module Remit
+  module SignatureUtilsForOutbound
+    # Convert a string into URL encoded form.
+    def urlencode(plaintext)
+      CGI.escape(plaintext.to_s).gsub("+", "%20").gsub("%7E", "~")
+    end
+
+#    def get_http_data(url)
+#      #2. fetch certificate if not found in cache
+#      uri = URI.parse(url)
+#      http_session = Net::HTTP.new(uri.host, uri.port)
+#      http_session.use_ssl = true
+#      http_session.ca_file = 'ca-bundle.crt'
+#      http_session.verify_mode = OpenSSL::SSL::VERIFY_PEER
+#      http_session.verify_depth = 5
+#
+#      res = http_session.start {|http_session|
+#        req = Net::HTTP::Get.new(url, {"User-Agent" => USER_AGENT_STRING})
+#        http_session.request(req)
+#      }
+#
+#      return res.body
+#    end
+#
+#    def starts_with(string, prefix)
+#      prefix = prefix.to_s
+#      string[0, prefix.length] == prefix
+#    end
+
+    def get_http_params(params)
+       params.map do |(k, v)|
+          urlencode(k) + "=" + urlencode(v)
+       end.join("&")
+    end
+
+    SIGNATURE_KEYNAME = "signature"
+    SIGNATURE_METHOD_KEYNAME = "signatureMethod"
+    SIGNATURE_VERSION_KEYNAME = "signatureVersion"
+    CERTIFICATE_URL_KEYNAME = "certificateUrl"
+    SIGNATURE_VERSION_2 = "2"
+
+    #Will raise an error if there are obvious problems with the request (indicating it was forged or corrupted)
+    def check_parameters(params)
+#      begin
+        raise ":parameters must be enumerable" unless params.kind_of? Enumerable
+
+        signature = params[SIGNATURE_KEYNAME];
+        raise "'signature' is missing from the parameters." if (signature.nil?)
+
+        signature_version = params[SIGNATURE_VERSION_KEYNAME];
+        raise "'signatureVersion' is missing from the parameters." if (signature_version.nil?)
+        raise "'signatureVersion' present in parameters is invalid. Valid values are: 2" if (signature_version != SIGNATURE_VERSION_2)
+
+        signature_method = params[SIGNATURE_METHOD_KEYNAME]
+        raise "'signatureMethod' is missing from the parameters." if (signature_method.nil?)
+
+        certificate_url = params[CERTIFICATE_URL_KEYNAME]
+        raise "'certificate_url' is missing from the parameters." if (certificate_url.nil?)
+        return true
+#      rescue
+#        puts "There was a problem with parameters being invalid or missing."
+#        return false
+#      end
+    end
+
+  end
+end

data/lib/remit/verify_signature.rb

@@ -0,0 +1,21 @@
+module Remit
+  module VerifySignature
+    class Request < Remit::Request
+      action :VerifySignature
+      parameter :url_end_point, :required => true
+      parameter :http_parameters, :required => true
+      parameter :version, :required => true
+    end
+
+    class Response < Remit::Response
+      class VerifySignatureResult < BaseResponse
+        parameter :verification_status
+      end
+      parameter :verify_signature_result, :type => VerifySignatureResult
+    end
+
+    def verify_signature(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/spec/integrations/get_account_activity_spec.rb

@@ -9,28 +9,34 @@ describe 'a GetAccountActivity call' do
     @response = remit.get_account_activity(request)
   end
 
+  it "has results" do
+    @response.get_account_activity_result.should_not be_nil
+  end
+
   it 'should have a collection of transactions' do
-    @response.should have_at_least(1).transactions
+    @response.get_account_activity_result.transactions.class.should == Array
   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_empty
-    transaction.error_message.should be_empty
-    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
+    transaction = @response.get_account_activity_result.transactions.first
+    #Depending on the data in the sandbox used there may or may not actually be data here:
+    if transaction
+      transaction.caller_name.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 eql("")
+      #transaction.error_detail.should eql("")
+      #transaction.error_message.should eql("")
+      transaction.fees.should_not be_nil
+      transaction.fps_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_nil #some transactions have '' here.
+      transaction.status_code.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
 end

data/spec/integrations/get_tokens_spec.rb

@@ -5,33 +5,35 @@ describe 'a GetTokens call' do
 
   before(:all) do
     @response = remit.get_tokens
+    
   end
 
   it 'should have a collection of tokens' do
-    @response.should have_at_least(1).tokens
+    @response.get_tokens_result.should have_at_least(1).tokens
   end
 
   it 'should have a token with all of its values set' do
-    token = @response.tokens.first
+    token = @response.get_tokens_result.tokens.first
     token.token_id.should_not be_empty
     token.friendly_name.should_not be_empty
-    token.status.should_not be_empty
+    token.token_status.should_not be_empty
     token.date_installed.should_not be_nil
-    token.caller_installed.should_not be_empty
+    #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 be_empty
   end
 
   it 'should have a token with a token ID' do
-    @response.tokens.first.token_id.should_not be_empty
+    @response.get_tokens_result.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)
+    @response.get_tokens_result.tokens.first.token_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)
+    @response.get_tokens_result.tokens.first.date_installed.should be_a_kind_of(Time)
   end
 end

data/spec/integrations/integrations_helper.rb

@@ -5,4 +5,11 @@ 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
 
+#def remit_api
+#  @remit ||= Remit::API.new(ACCESS_KEY, SECRET_KEY, true)
+#end
+
+#puts "Access key = #{ACCESS_KEY}"
+#puts "Secret key = #{SECRET_KEY}"
+
 require File.dirname(__FILE__) + '/../spec_helper'

data/spec/integrations/ipn_request_spec.rb

@@ -1,32 +1,40 @@
 require File.dirname(__FILE__) + '/integrations_helper'
 
-describe 'an IPN request' do
+describe 'an IPN request with a bad signature' do
+# This needs to be updated to match the new Verify methods
+# The signature does not match the one calculated for these req params by amazon.  Need to get a fresh example.
+# So it is currently a test that a bad signature will be verified as BAD
   before(:each) do
-    @request_params = {
-      "expiry"            => "10/2013",
-      "tokenID"           => "Q5IG5ETFCEBU8KBLTI4JHINQVL6VAJVHICBRR49AKLPIEZH1KB1S8C7VHAJJMLJ3",
-      "status"            => "SC",
-      "callerReference"   => "1253247023946cMcrTRrjtLjNrZGNKchWfDtUEIGuJfiOBAAJYPjbytBV",
+    @bad_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",
+      "signatureVersion"  => Remit::API::SIGNATURE_VERSION.to_s,
       "signatureMethod"   => "RSA-SHA1",
-      "signatureVersion"  => "2",
-      "certificateUrl"    => "https://fps.amazonaws.com/certs/090909/PKICert.pem",
-      "controller"        => "amazon_fps", # controller and action get deleted
-      "action"            => "index",
-      "signature"         => "H4NTAsp3YwAEiyQ86j5B53lksv2hwwEaEFxtdWFpy9xX764AZy/Dm0RLEykUUyPVLgqCOlMopay5" \
-                           + "Qxr/VDwhdYAzgQzA8VCV8x9Mn0caKsJT2HCU6tSLNa6bLwzg/ildCm2lHDho1Xt2yaBHMt+/Cn4q" \
-                           + "I5B+6PDrb8csuAWxW/mbUhk7AzazZMfQciJNjS5k+INlcvOOtQqoA/gVeBLsXK5jNsTh09cNa7pb" \
-                           + "gAvey+0DEjYnIRX+beJV6EMCPZxnXDGo0fA1PENLWXIHtAoIJAfLYEkVbT2lva2tZ0KBBWENnSjf" \
-                           + "26lMZVokypIo4huoGaZMp1IVkImFi3qC6ipCrw=="
+      "certificateUrl"    => "https://fps.sandbox.amazonaws.com/certs/090909/PKICert.pem",
+      Remit::IpnRequest::SIGNATURE_KEY => "This-is-a-bad-sig",
+      "status"            => "SUCCESS",
+      "transactionAmount" => "USD 3.50",
+      "transactionDate"   => "1224687134",
+      "transactionId"     => "13KIGL9RC25853BGPPOS2VSKBKF2JERR3HO"
     }
-    @request = Remit::IpnRequest.new(@request_params, 'http://www.mysite.com/call_pay.jsp', ACCESS_KEY, SECRET_KEY)
+
+    @request = Remit::IpnRequest.new('http://example.com/ipn/processor', @bad_request_params, remit)
   end
 
-  it 'should be a valid request' do
-    @request.should be_valid
+  it 'should not be a valid request' do
+    @request.should_not be_valid
   end
 
   it 'should pass through access to given parameters' do
-    @request.status.should == 'SC'
-    @request.callerReference.should == '1253247023946cMcrTRrjtLjNrZGNKchWfDtUEIGuJfiOBAAJYPjbytBV'
+    @request.status.should == 'SUCCESS'
+    @request.operation.should == 'PAY'
+    @request.transactionId.should == '13KIGL9RC25853BGPPOS2VSKBKF2JERR3HO'
   end
 end
+