controller_helpers.rb in wepay-rails-0.1.44

- old
+ new

@@ -1,14 +1,20 @@
 module WepayRails
   module Helpers
     module ControllerHelpers
 
-      def redirect_to_wepay_for_auth(scope=gateway.scope)
-        redirect_to gateway.auth_code_url(scope)
+      def redirect_to_wepay_for_auth(scope=wepay_gateway.scope)
+        redirect_to wepay_gateway.auth_code_url(scope)
       end
 
+      # @deprecated Use wepay_gateway instead of gateway
       def gateway
+        warn "[DEPRECATION] Use wepay_gateway instead of gateway"
+        wepay_gateway
+      end
+
+      def wepay_gateway
         @gateway ||= WepayRails::Payments::Gateway.new(wepay_access_token)
       end
 
       # From https://stage.wepay.com/developer/tutorial/authorization
       # Request
@@ -19,14 +25,14 @@
       # &code=[the code you got in step one]
       #
       # Response
       # {"user_id":"123456","access_token":"1337h4x0rzabcd12345","token_type":"BEARER"} Example
       def initialize_wepay_access_token(auth_code)
-        session[unique_wepay_access_token_key] = gateway.access_token(auth_code)
+        session[unique_wepay_access_token_key] = wepay_gateway.access_token(auth_code)
         return
       rescue WepayRails::Exceptions::ExpiredTokenError => e
-        redirect_to_wepay_for_auth(gateway.scope) and return
+        redirect_to_wepay_for_auth(wepay_gateway.scope) and return
       end
 
       # Since we are saving the access token in the session,
       # ensure key uniqueness. Might be a good idea to have this
       # be a setting in the wepay.yml file.
@@ -40,9 +46,51 @@
         session[unique_wepay_access_token_key]
       end
 
       def wepay_access_token_exists?
         @access_token_exists ||= wepay_access_token.present?
+      end
+
+      # 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: @config is your wepay.yml as a Hash
+      # :callback_uri     => @config[:ipn_callback_uri],
+      # :redirect_uri     => @config[:checkout_redirect_uri],
+      # :fee_payer        => @config[:fee_payer],
+      # :type             => @config[:checkout_type],
+      # :charge_tax       => @config[:charge_tax] ? 1 : 0,
+      # :app_fee          => @config[:app_fee],
+      # :auto_capture     => @config[:auto_capture] ? 1 : 0,
+      # :require_shipping => @config[:require_shipping] ? 1 : 0,
+      # :shipping_fee     => @config[:shipping_fee],
+      # :charge_tax       => @config[:charge_tax],
+      # :account_id       => wepay_user['account_id'] # 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 https://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.
+      def init_checkout_and_send_user_to_wepay(params)
+        create_checkout = wepay_gateway.perform_checkout(params)
+        response = JSON.parse(create_checkout.body)
+        raise WepayRails::Exceptions::InitializeCheckoutError.new("A problem occurred while trying to checkout. Wepay didn't send us back a checkout uri") unless response && response.has_key?('checkout_uri')
+        redirect_to response['checkout_uri'] and return
       end
     end
   end
 end
\ No newline at end of file