Class: WepayRails::Payments::Gateway

Inherits:
Object
  • Object
show all
Includes:
HTTParty
Defined in:
lib/wepay-rails.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Gateway

Pass in the wepay access token that we got after the oauth handshake and use it for ongoing comunique with Wepay. This also relies heavily on there being a wepay.yml file in your rails config directory - it must look like this:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/wepay-rails.rb', line 66

def initialize(*args)
  @wepay_access_token = args.first

  @wepay_config = Configuration.settings
  #yml = Rails.root.join('config', 'wepay.yml').to_s
  #@config = YAML.load_file(yml)[Rails.env].symbolize_keys

  @scope = @wepay_config.delete(:scope)

  # Build the base uri
  # Default if there isn't a setting for version and/or api uri
  version = @wepay_config[:wepay_api_version].present? ? @wepay_config[:wepay_api_version] : "v2"
  api_uri = @wepay_config[:wepay_api_uri].present? ? @wepay_config[:wepay_api_uri] : "https://wepayapi.com"

  @base_uri = "#{api_uri}/#{version}"
end

Instance Attribute Details

#scope ⇒ Object

Returns the value of attribute scope.



58
59
60
 
# File 'lib/wepay-rails.rb', line 58

def scope
  @scope
end

#wepay_access_token ⇒ Object

Returns the value of attribute wepay_access_token.



58
59
60
 
# File 'lib/wepay-rails.rb', line 58

def wepay_access_token
  @wepay_access_token
end

#wepay_auth_code ⇒ Object

Returns the value of attribute wepay_auth_code.



58
59
60
 
# File 'lib/wepay-rails.rb', line 58

def wepay_auth_code
  @wepay_auth_code
end

Instance Method Details

#access_token(auth_code) ⇒ Object

Raises:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/wepay-rails.rb', line 83

def access_token(auth_code)
  at_log = File.open('/tmp/access-token.log','a')
  at_log.puts "Auth code passed in was #{auth_code}"
  @wepay_auth_code = auth_code
  query = {
    :client_id => @wepay_config[:client_id],
    :client_secret => @wepay_config[:client_secret],
    :redirect_uri => @wepay_config[:redirect_uri],
    :code => auth_code
  }
  response = self.class.get("#{@base_uri}/oauth2/token", :query => query)
  json = JSON.parse(response.body)

  if json.has_key?("error")
    if json.has_key?("error_description")
      raise WepayRails::Exceptions::ExpiredTokenError.new("You will need to get a new authorization code") if json["error_description"] == "the code has expired"
      raise WepayRails::Exceptions::AccessTokenError.new(json["error_description"])
    end
  end

  raise WepayRails::Exceptions::AccessTokenError.new("A problem occurred trying to get the access token: #{json.inspect}") unless json.has_key?("access_token")

  @wepay_access_token = json["access_token"]
end

#auth_code_url(wepayable_object) ⇒ Object

Get the auth code url that will be used to fetch the auth code for the customer arguments are the redirect_uri and an array of permissions that your application needs ex. [‘manage_accounts’,‘collect_payments’,‘view_balance’,‘view_user’]



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/wepay-rails.rb', line 111

def auth_code_url(wepayable_object)
  acu_log = File.open('/tmp/auth-code-url.log','a')
  acu_log.puts "Inside auth_code_url"
  acu_log.puts "Settings are #{WepayRails::Configuration.settings.inspect}"
  acu_log.puts "Scope is #{WepayRails::Configuration.settings[:scope].inspect}"
  params = @wepay_config.merge(:scope => WepayRails::Configuration.settings[:scope].join(','))

  # Initially set a reference ID to the column created for the wepayable
  # so that when the redirect back from wepay happens, we can reference
  # the original wepayable, and then save the new auth code into the reference ID's
  # place
  ref_id = Digest::SHA1.hexdigest("#{Time.now.to_i+rand(4)}")

  wepayable_object.update_attribute(wepayable_object.wepayable_column.to_sym, ref_id)

  params[:authorize_redirect_uri] += (params[:authorize_redirect_uri] =~ /\?/ ? "&" : "?") + "refID=#{ref_id}"
  params[:authorize_redirect_uri] = CGI::escape(params[:authorize_redirect_uri])

  query = params.map do |k, v|
    "#{k.to_s}=#{v}"
  end.join('&')

  return "#{@base_uri}/oauth2/authorize?#{query}"
rescue => e
  acu_log.puts "Exception in auth_code_url: #{e.message}"
end

#lookup_checkout(*args) ⇒ Object 



215
216
217
218
219
220
221
 
# File 'lib/wepay-rails.rb', line 215

def lookup_checkout(*args)
  checkout_id = args.first
  parms = args.last if args.last.is_a?(Hash)

  response = self.class.get("#{@base_uri}/checkout", {:headers => wepay_auth_header}.merge!(:query => {:checkout_id => checkout_id}))
  JSON.parse(response.body)
end

#perform_checkout(parms) ⇒ Object

Many of the settings you pass in here are already factored in from the wepay.yml file and only need to be overridden if you insist on doing so when this method is called. The following list of key values are pulled in for you from your wepay.yml file:

Note: @wepay_config is your wepay.yml as a Hash :callback_uri => @wepay_config, :redirect_uri => @wepay_config, :fee_payer => @wepay_config, :type => @wepay_config, :charge_tax => @wepay_config ? 1 : 0, :app_fee => @wepay_config, :auto_capture => @wepay_config ? 1 : 0, :require_shipping => @wepay_config ? 1 : 0, :shipping_fee => @wepay_config, :charge_tax => @wepay_config, :account_id => wepay_user # wepay-rails goes and gets this for you, but you can override it if you want to.

params hash key values possibilities are: Parameter: Required: Description: :account_id Yes The unique ID of the account you want to create a checkout for. :short_description Yes A short description of what is being paid for. :long_description No A long description of what is being paid for. :type Yes The the checkout type (one of the following: GOODS, SERVICE, DONATION, or PERSONAL) :reference_id No The unique reference id of the checkout (set by the application in /checkout/create :amount Yes The amount that the payer will pay. :app_fee No The amount that the application will receive in fees. :fee_payer No Who will pay the fees (WePay’s fees and any app fees). Set to “Payer” to charge fees to the person paying (Payer will pay amount + fees, payee will receive amount). Set to “Payee” to charge fees to the person receiving money (Payer will pay amount, Payee will receive amount - fees). Defaults to “Payer”. :redirect_uri No The uri the payer will be redirected to after paying. :callback_uri No The uri that will receive any Instant Payment Notifications sent. Needs to be a full uri (ex www.wepay.com ) :auto_capture No A boolean value (0 or 1). Default is 1. If set to 0 then the payment will not automatically be released to the account and will be held by WePay in payment state ‘reserved’. To release funds to the account you must call /checkout/capture :require_shipping No A boolean value (0 or 1). If set to 1 then the payer will be asked to enter a shipping address when they pay. After payment you can retrieve this shipping address by calling /checkout :shipping_fee No The amount that you want to charge for shipping. :charge_tax No A boolean value (0 or 1). If set to 1 and the account has a relevant tax entry (see /account/set_tax), then tax will be charged.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/wepay-rails.rb', line 197

def perform_checkout(parms)
  defaults = {
      :callback_uri     => @wepay_config[:ipn_callback_uri],
      :redirect_uri     => @wepay_config[:checkout_redirect_uri],
      :fee_payer        => @wepay_config[:fee_payer],
      :type             => @wepay_config[:checkout_type],
      :charge_tax       => @wepay_config[:charge_tax] ? 1 : 0,
      :app_fee          => @wepay_config[:app_fee],
      :auto_capture     => @wepay_config[:auto_capture] ? 1 : 0,
      :require_shipping => @wepay_config[:require_shipping] ? 1 : 0,
      :shipping_fee     => @wepay_config[:shipping_fee],
      :account_id       => @wepay_config[:account_id]
  }.merge(parms)

  response = self.class.get("#{@base_uri}/checkout/create", {:headers => wepay_auth_header}.merge!(:query => defaults))
  JSON.parse(response.body)
end

#token_url ⇒ Object 



138
139
140
141
142
143
144
 
# File 'lib/wepay-rails.rb', line 138

def token_url
  query = @wepay_config.map do |k, v|
    "#{k.to_s}=#{v}"
  end.join('&')

  "#{@base_uri}/oauth2/authorize?#{query}"
end

#wepay_auth_header ⇒ Object 



146
147
148
 
# File 'lib/wepay-rails.rb', line 146

def wepay_auth_header
  {'Authorization' => "Bearer: #{@wepay_access_token}"}
end

#wepay_user ⇒ Object

Make a call to wepay to get the user info. This will only make one call per request. Any subsequent calls to wepay_user will return the data retrieved from the first call.



153
154
155
156
157
158
159
160
 
# File 'lib/wepay-rails.rb', line 153

def wepay_user
  user_api = lambda {|headers|
    response = self.class.get("#{@base_uri}/user", {:headers => headers})
    JSON.parse(response.body)
  }

  @wepay_user ||= user_api.call(wepay_auth_header)
end