remit2 0.0.7

data/lib/remit2/operations/get_transaction.rb

@@ -0,0 +1,40 @@
+module Remit
+  module GetTransaction
+    class Request < Remit::Request
+      action :GetTransaction
+      parameter :transaction_id, :required => true
+    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/remit2/operations/install_payment_instruction.rb

@@ -0,0 +1,20 @@
+module Remit
+  module InstallPaymentInstruction
+    class Request < Remit::Request
+      action :InstallPaymentInstruction
+      parameter :payment_instruction, :required => true
+      parameter :caller_reference, :required => true
+      parameter :token_friendly_name
+      parameter :token_type, :required => true
+      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/remit2/operations/pay.rb

@@ -0,0 +1,38 @@
+# Updated for API Version 2008-09-17
+module Remit
+  module Pay
+    class Request < Remit::Request
+      action :Pay
+      parameter :caller_description
+      parameter :caller_reference, :required => true
+      parameter :charge_fee_to
+      parameter :descriptor_policy, :type => Remit::RequestTypes::DescriptorPolicy
+      parameter :marketplace_fixed_fee, :type => Remit::RequestTypes::Amount
+      parameter :marketplace_variable_fee
+      parameter :meta_data
+      parameter :recipient_description
+      parameter :recipient_reference
+      parameter :recipient_token_id
+      parameter :sender_description
+      parameter :sender_reference
+      parameter :sender_token_id, :required => true
+      parameter :transaction_amount, :type => Remit::RequestTypes::Amount, :required => true
+      parameter :transaction_date
+      parameter :transaction_timeout_in_mins
+    end
+    
+    class InnerResponse < Remit::BaseResponse
+      parameter :transaction_id
+      parameter :transaction_status
+    end
+    
+    class Response < Remit::Response
+      parameter :inner, :element => "PayResult", :type => InnerResponse
+      inner_parameters :transaction_id, :transaction_status
+    end
+
+    def pay(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit2/operations/refund.rb

@@ -0,0 +1,28 @@
+# Updated for API Version 2008-09-17
+module Remit
+  module Refund
+    class Request < Remit::Request
+      action :Refund
+      parameter :caller_description
+      parameter :caller_reference, :required => true
+      parameter :refund_amount, :type => Remit::RequestTypes::Amount
+      parameter :transaction_id, :required => true
+      parameter :marketplace_refund_policy
+
+      # 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
+      parser :rexml
+      parameter :refund_result, :type => RefundResult
+    end
+
+    def refund(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit2/operations/reserve.rb

@@ -0,0 +1,28 @@
+module Remit
+  module Reserve
+    class Request < Remit::Request
+      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
+      parameter :transaction_date
+      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
+    end
+
+    def reserve(request = Request.new)
+      call(request, Response)
+    end
+  end
+end

data/lib/remit2/operations/retry_transaction.rb

@@ -0,0 +1,16 @@
+module Remit
+  module RetryTransaction
+    class Request < Remit::Request
+      action :RetryTransaction
+      parameter :original_transaction_id, :required => true
+    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/remit2/operations/settle.rb

@@ -0,0 +1,18 @@
+module Remit
+  module Settle
+    class Request < Remit::Request
+      action :Settle
+      parameter :reserve_transaction_id, :required => true
+      parameter :transaction_amount, :type => Remit::RequestTypes::Amount
+      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/remit2/operations/settle_debt.rb

@@ -0,0 +1,28 @@
+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/remit2/operations/write_off_debt.rb

@@ -0,0 +1,26 @@
+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/remit2/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/lib/remit2/request.rb

@@ -0,0 +1,12 @@
+module Remit
+  class Request < Relax::Request
+    def self.action(name)
+      parameter :action, :value => name
+    end
+
+    def convert_key(key)
+      key.to_s.gsub(/(^|_)(.)/) { $2.upcase }.to_sym
+    end
+    protected :convert_key
+  end
+end

data/lib/remit2/response.rb

@@ -0,0 +1,54 @@
+module Remit
+  class BaseResponse < Relax::Response
+    def node_name(name, namespace=nil)
+      super(name.to_s.gsub(/(^|_)(.)/) { $2.upcase }, namespace)
+    end
+  end
+  
+  class ResponseMetadata < BaseResponse
+    parameter :request_id
+  end
+
+  class Response < BaseResponse
+    parameter :response_metadata, :type => ResponseMetadata
+    attr_accessor :errors
+
+    def initialize(xml)
+      super
+      @errors = []
+      
+      if is?(:Response) && has?(:Errors)
+        @errors = elements('Errors/Error').collect do |error|
+          Error.new(error)
+        end
+      end
+    end
+
+    def successful?
+      @errors.empty?
+    end
+    
+    def request_id
+      # If successful it's in the ResponseMetadata, if failure, it's in the base
+      # response. Very irritating.
+      if successful?
+        response_metadata.request_id
+      else
+        elements('RequestId')[0].to_s
+      end
+    end
+
+    def node_name(name, namespace=nil)
+      super(name.to_s.split('/').collect{ |tag|
+        tag.gsub(/(^|_)(.)/) { $2.upcase }
+      }.join('/'), namespace)
+    end
+    
+    # Easily exposes parameters that are buried in the InnerResponse
+    def self.inner_parameters(*fields)
+      fields.each do |inner_field_name|
+        define_method(inner_field_name) { inner.send(inner_field_name) }
+      end
+    end
+  end
+end

data/lib/remit2/signature.rb

@@ -0,0 +1,35 @@
+module Remit
+  module Signature
+    def sign(secret_key, endpoint, http_verb, params)
+      s = string_to_sign(endpoint, http_verb, params)
+      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, secret_key, s)).strip
+    end
+    
+    def string_to_sign(endpoint, http_verb, values)
+      uri = URI::parse(endpoint.to_s)
+
+      path = uri.path
+      path = "/" if (path.nil? || path.empty?)
+      path = urlencode(path).gsub("%2F", "/") 
+
+      host = uri.host.downcase
+      
+      # Explicitly remove the Signature param if found
+      sorted_keys = values.keys.reject{ |k| k.to_s == "Signature" }.sort { |x,y| x.to_s <=> y.to_s }
+      converted = sorted_keys.collect do |k|
+        v = values[k]
+        s = urlencode(k)
+        s << "=#{urlencode(v)}" unless v.nil?
+        s
+      end
+      params = converted.join("&")
+      
+      "#{http_verb}\n#{host}\n#{path}\n#{params}"
+    end
+    
+    # Convert a string into URL encoded form that Amazon accepts
+    def urlencode(plaintext)
+      CGI.escape(plaintext.to_s).gsub("+", "%20").gsub("%7E", "~")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/remit2'
+
+def remit
+  @remit ||= Remit::API.new(ACCESS_KEY, SECRET_KEY, true)
+end
+
+describe 'a successful response', :shared => true do
+  it 'should not have any errors' do
+    @response.errors.should be_empty
+  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