Class: Boomerang

Inherits:
Object
  • Object
show all
Defined in:
lib/boomerang.rb,
lib/boomerang/errors.rb,
lib/boomerang/api_call.rb,
lib/boomerang/response.rb,
lib/boomerang/signature.rb,
lib/boomerang/utilities.rb

Defined Under Namespace

Modules: Errors, Utilities Classes: APICall, Response, Signature

Constant Summary collapse

VERSION = 
"0.0.2"
ENDPOINTS = 
{ cbui:         "https://authorize.payments.amazon.com/" +
              "cobranded-ui/actions/start",
cbui_sandbox: "https://authorize.payments-sandbox.amazon.com/" +
              "cobranded-ui/actions/start",
fps:          "https://fps.amazonaws.com",
fps_sandbox:  "https://fps.sandbox.amazonaws.com" }
PIPELINES = 
%w[ SingleUse     MultiUse Recurring Recipient SetupPrepaid
SetupPostpaid EditToken ]

Instance Method Summary collapse

Constructor Details

#initialize(access_key_id, secret_access_key, use_sandbox) ⇒ Boomerang

Returns a new instance of Boomerang.



24
25
26
27
28
 
# File 'lib/boomerang.rb', line 24

def initialize(access_key_id, secret_access_key, use_sandbox)
  @access_key_id     = access_key_id
  @secret_access_key = secret_access_key
  @use_sandbox       = use_sandbox
end

Instance Method Details

#cbui_form(pipeline, parameters) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/boomerang.rb', line 35

def cbui_form(pipeline, parameters)
  submit_tag = parameters.delete(:submit_tag) || %Q{<input type="submit">}
  pipeline   = Utilities.CamelCase(pipeline)
  parameters = Utilities.camelCase(parameters).merge(
    "version"      => "2009-01-09",
    "pipelineName" => pipeline
  )
  fail ArgumentError, "parameters must be a Hash" unless parameters.is_a? Hash
  unless PIPELINES.include? pipeline
    choices = "#{PIPELINES[0..-2].join(', ')}, or #{PIPELINES[-1]}"
    fail ArgumentError, "pipline must be one of #{choices}"
  end
  unless parameters["returnUrl"]
    fail ArgumentError, "returnUrl is a required parameter"
  end
  required_fields = case pipeline
                    when "Recipient"
                      %w[callerReference recipientPaysFee]
                    when "Recurring"
                      %w[callerReference recurringPeriod transactionAmount]
                    end
  required_fields.each do |required_field|
    unless parameters[required_field]
      fail ArgumentError, "#{required_field} is a required parameter"
    end
  end
  
  url        = ENDPOINTS[use_sandbox? ? :cbui_sandbox : :cbui]
  signature  = Signature.new("GET", url, parameters)
  signature.sign(@access_key_id, @secret_access_key)
  
  form = %Q{<form action="#{url}" method="GET">}
  signature.signed_fields.each do |name, value|
    form << %Q{<input type="hidden" } +
            %Q{name="#{ERB::Util.h name}" value="#{ERB::Util.h value}">}
  end
  form << %Q{#{submit_tag}</form>}
end

#get_transaction_status(transaction_id) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/boomerang.rb', line 101

def get_transaction_status(transaction_id)
  call = APICall.new( ENDPOINTS[use_sandbox? ? :fps_sandbox : :fps],
                      :get_transaction_status,
                      transaction_id: transaction_id )
  call.sign(@access_key_id, @secret_access_key)

  Response.new(call.response)
          .parse( "/xmlns:GetTransactionStatusResponse/",
                  "GetTransactionStatusResult/TransactionId",
                  "GetTransactionStatusResult/TransactionStatus",
                  "GetTransactionStatusResult/CallerReference",
                  "GetTransactionStatusResult/StatusCode",
                  "GetTransactionStatusResult/StatusMessage",
                  "ResponseMetadata/RequestId" )
end

#pay(parameters) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/boomerang.rb', line 74

def pay(parameters)
  %w[marketplace_fixed_fee transaction_amount].each do |amount|
    if dollars = parameters.delete(amount.to_sym)
      parameters["#{amount}.currency_code"] = "USD"
      parameters["#{amount}.value"]         = dollars
    end
  end
  parameters = Utilities.CamelCase(parameters)
  %w[ CallerReference SenderTokenId TransactionAmount.CurrencyCode
      TransactionAmount.Value ].each do |required_field|
    unless parameters[required_field]
      fail ArgumentError, "#{required_field} is a required parameter"
    end
  end
  
  call = APICall.new( ENDPOINTS[use_sandbox? ? :fps_sandbox : :fps],
                      :pay,
                      parameters )
  call.sign(@access_key_id, @secret_access_key)

  Response.new(call.response)
          .parse( "/xmlns:PayResponse/",
                  "PayResult/TransactionId",
                  "PayResult/TransactionStatus",
                  "ResponseMetadata/RequestId" )
end

#use_sandbox? ⇒ Boolean Also known as: using_sandbox?

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/boomerang.rb', line 30

def use_sandbox?
  @use_sandbox
end

#verify_signature?(url, parameters) ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/boomerang.rb', line 117

def verify_signature?(url, parameters)
  parameters = parameters.is_a?(Hash) ? Utilities.build_query(parameters) :
                                        parameters.to_s

  call = APICall.new( ENDPOINTS[use_sandbox? ? :fps_sandbox : :fps],
                      :verify_signature,
                      url_end_point:   url,
                      http_parameters: parameters )

  parsed = Response.new(call.response)
                   .parse( "/xmlns:VerifySignatureResponse/",
                           "VerifySignatureResult/VerificationStatus",
                           "ResponseMetadata/RequestId" )
  parsed[:verification_status] == "Success"
end