Module: ApRubySdk

Defined in:
lib/ap_ruby_sdk.rb,
lib/ap_ruby_sdk/plan.rb,
lib/ap_ruby_sdk/util.rb,
lib/ap_ruby_sdk/void.rb,
lib/ap_ruby_sdk/period.rb,
lib/ap_ruby_sdk/refund.rb,
lib/ap_ruby_sdk/payment.rb,
lib/ap_ruby_sdk/version.rb,
lib/ap_ruby_sdk/website.rb,
lib/ap_ruby_sdk/customer.rb,
lib/ap_ruby_sdk/base_model.rb,
lib/ap_ruby_sdk/collection.rb,
lib/ap_ruby_sdk/pagination.rb,
lib/ap_ruby_sdk/transaction.rb,
lib/ap_ruby_sdk/api_resource.rb,
lib/ap_ruby_sdk/subscription.rb,
lib/ap_ruby_sdk/redirect_urls.rb,
lib/ap_ruby_sdk/refund_reason.rb,
lib/ap_ruby_sdk/payment_option.rb,
lib/ap_ruby_sdk/errors/ap_error.rb,
lib/ap_ruby_sdk/errors/api_error.rb,
lib/ap_ruby_sdk/preauthorization.rb,
lib/ap_ruby_sdk/phone_verification.rb,
lib/ap_ruby_sdk/api_operations/list.rb,
lib/ap_ruby_sdk/errors/payment_error.rb,
lib/ap_ruby_sdk/api_operations/create.rb,
lib/ap_ruby_sdk/api_operations/retrieve.rb,
lib/ap_ruby_sdk/errors/authentication_error.rb,
lib/ap_ruby_sdk/errors/invalid_parameter_error.rb,
lib/ap_ruby_sdk/api_operations/create_phone_verification.rb

Defined Under Namespace

Modules: ApiOperations, Period, RefundReason, Util Classes: APIError, ApError, ApiResource, AuthenticationError, BaseModel, Collection, Customer, InvalidParameterError, Pagination, Payment, PaymentError, PaymentOption, PhoneVerification, Plan, Preauthorization, RedirectUrls, Refund, Subscription, Transaction, Void, Website

Constant Summary collapse

VERSION = 
'0.1.2'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_base ⇒ Object

Returns the value of attribute api_base.



47
48
49
 
# File 'lib/ap_ruby_sdk.rb', line 47

def api_base
  @api_base
end

.api_public_key ⇒ Object

Returns the value of attribute api_public_key.



47
48
49
 
# File 'lib/ap_ruby_sdk.rb', line 47

def api_public_key
  @api_public_key
end

.api_secret_key ⇒ Object

Returns the value of attribute api_secret_key.



47
48
49
 
# File 'lib/ap_ruby_sdk.rb', line 47

def api_secret_key
  @api_secret_key
end

Class Method Details

.api_url(url = '') ⇒ Object 



95
96
97
 
# File 'lib/ap_ruby_sdk.rb', line 95

def self.api_url(url='')
  @api_base + url
end

.execute_request(opts) ⇒ Object 



114
115
116
 
# File 'lib/ap_ruby_sdk.rb', line 114

def self.execute_request(opts)
  RestClient::Request.execute(opts)
end

.parse(response) ⇒ Object 



118
119
120
121
122
123
124
125
126
 
# File 'lib/ap_ruby_sdk.rb', line 118

def self.parse(response)
  begin
    response = MultiJson.load(response.body)
  rescue MultiJson::DecodeError
    raise_general_error(response.code, response.body)
  end

  Util.symbolize_names(response)
end

.parse_api_error(response_code, response_body) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/ap_ruby_sdk.rb', line 133

def self.parse_api_error(response_code, response_body)
  begin
    error = MultiJson.load(response_body)
    error = Util.symbolize_names(error)

    raise ApError.new if error[:Type].nil? # if there is no type

  rescue MultiJson::DecodeError, ApError
    raise_general_error(response_code, response_body)
  end

  case error[:Type]
    when 'payment_error'
      raise PaymentError.new(error[:Message], response_code, error[:Code])
    when 'api_error'
      raise APIError.new(error[:Message], response_code, error[:Code])
    when 'invalid_parameter_error'
      raise InvalidParameterError.new(error[:Message], response_code, error[:Code], error[:Param])
    else
      raise APIError.new(error[:Message], response_code, error[:Code]);
  end
end

.raise_general_error(response_code, response_body) ⇒ Object

Raises:



128
129
130
131
 
# File 'lib/ap_ruby_sdk.rb', line 128

def self.raise_general_error(response_code, response_body)
  raise APIError.new("Invalid response object from API: #{response_body.inspect} " +
                         "(HTTP response code was #{response_code})", response_code)
end

.request(method, url, api_secret_key, api_public_key, params = {}, headers = {}) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/ap_ruby_sdk.rb', line 50

def self.request(method, url, api_secret_key, api_public_key, params={}, headers={})
  unless api_secret_key ||= @api_secret_key
    raise AuthenticationError.new('No Secret API key provided.')
  end

  unless api_public_key ||= @api_public_key
    raise AuthenticationError.new('No Public API key provided.')
  end

  url = api_url(url)

  if method.to_s.downcase.to_sym == :get
    # Make params into GET params
    url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
    payload = nil
  elsif method.to_s.downcase.to_sym == :delete
    # Make params into expected DELETE params
  elsif method.to_s.downcase.to_sym == :put
    # Make params into expected PUT params
  else
    # Make params into POST params
    payload = MultiJson.dump(params, mode: :compat)
  end

  request_opts = {
      :headers => request_headers(api_secret_key).update(headers),
      :open_timeout => 30,
      :timeout => 80,
      :method => method,
      :payload => payload,
      :url => url
  }
  begin
    response = execute_request(request_opts)
  rescue RestClient::ExceptionWithResponse => e
    if e.http_code and e.http_body
      parse_api_error(e.http_code, e.http_body)
    else
      raise APIError.new(message + "\n\n(Network error: #{e.message})")
    end
  end

  parse(response)
end

.request_headers(api_secret_key) ⇒ Object 



106
107
108
109
110
111
112
 
# File 'lib/ap_ruby_sdk.rb', line 106

def self.request_headers(api_secret_key)
  {
      :user_agent => "AlternativePayments Ruby SDK v#{ApRubySdk::VERSION}",
      :authorization => "Basic #{Base64.strict_encode64(api_secret_key)}",
      :content_type => :json
  }
end

.uri_encode(params) ⇒ Object 



101
102
103
104
 
# File 'lib/ap_ruby_sdk.rb', line 101

def self.uri_encode(params)
  Util.flatten_params(params).
      map { |k, v| "#{k}=#{Util.url_encode(v)}" }.join('&')
end