wepay-rails 0.1.116 → 0.2.0

data/README.rdoc

@@ -15,76 +15,30 @@ Your migration:
 
     add_column :my_model, :wepay_auth_code, :string
 
-Now, tell wepay_rails where it should store/retrieve the auth code.
-
-You will need a wepay.yml file added to your config directory. Please copy one from the lib/examples folder of the
-wepay-rails gem and modify it to your needs. In a future release, the copy will happen via a generator. For now, please
-manually copy it over.
-
-Snippet of wepay.yml showing the auth_code_location directive:
+You need to also create a new model called WepayCheckoutRecord. It will be updated by wepay's IPN system as changes to the checkout change - such as the status.
+Wepay-rails handles those IPN notifications for you. You can write observers watching the WepayCheckoutRecord model if you need to have
+something specific occur when the checkout changes.
 
-    production:
-      auth_code_location: MyModel.wepay_auth_code
+To create your WepayCheckoutRecord model and migration:
 
-Your model:
+    script/rails g wepay_rails:install
 
-    class MyModel < ActiveRecord::Base
-        wepayable
-    end
+This will create 3 files for you, a migration file for a table to hold the checkout results, the model and a wepay.yml.example file. Next run:
 
-Now you will have some convenience methods added to your model, such as save_<your column name> (eg. save_wepay_auth_code)
+    rake db:migrate
 
-You need to also create a new model called WepayCheckoutRecord. It will be updated by wepay's IPN system as changes to the checkout change - such as the status.
-Wepay-rails handles those IPN notifications for you. You can write observers watching the WepayCheckoutRecord model if you need to have
-something specific occur when the checkout changes. In future versions, I'll include a generator - but for now, here's the migration to use:
-
-    class CreateWepayCheckoutRecords < ActiveRecord::Migration
-        def self.up
-
-            create_table :wepay_checkout_records do |t|
-                t.integer :checkout_id
-                t.integer :account_id
-                t.string :auth_code
-                t.string :state
-                t.string :short_description
-                t.text :long_description
-                t.string :currency
-                t.decimal :amount
-                t.decimal :app_fee
-                t.string :fee_payer
-                t.decimal :gross
-                t.decimal :fee
-                t.string :reference_id
-                t.text :redirect_uri
-                t.text :callback_uri
-                t.text :checkout_uri
-                t.string :payer_email
-                t.string :payer_name
-                t.text :cancel_reason
-                t.text :refund_reason
-                t.boolean :auto_capture
-                t.boolean :require_shipping
-                t.text :shipping_address
-                t.decimal :tax
-
-                t.timestamps
-            end
-
-            add_index :wepay_checkout_records, :checkout_id
-        end
+Modify config/wepay.yml.example to your needs. You will need to set the model and column where you are storing your wepay auth code:
 
-        def self.down
-            drop_table :wepay_checkout_records
-        end
-    end
+Snippet of wepay.yml showing the auth_code_location directive:
 
+    production:
+      auth_code_location: MyModel.wepay_auth_code
 
-You will have to set up a few new controllers to handle callbacks and redirects from wepay back to your app.
+You will have to set up a few new controllers in your rails app to handle callbacks and redirects from wepay.
 I created one called finalize_controller and I use it for a landing page when the customer is finished paying
-their order. The other controller I created is a checkout_controller - this controller glues all of the auth
-stuff together - it checks if the user has an auth code and access token so it can do the checkout for you. I am
-going to look into ways to have wepay-rails do most of the heavy lifting - look for this to change in future versions.
-For now, here's how to handle it...
+their order. The other controller I created is a checkout_controller - I send my customers to it when they click checkout
+in the cart. Your app is surely differnt than mine. Do what makes sense to you.
+For now, here's what I am doing in my rails app to handle it...
 
   app
     |_ controllers
@@ -102,7 +56,7 @@ you can create an IpnController in your rails app.
         end
     end
 
-wepay.yml will also need these directives. See the section on wepay.yml
+wepay.yml will also need these directives. See the wepay.yml.example file in config.
 
 When you include WepayRails::Payments, you get the controller actions you need. For instance, initialize_wepay_access_token(auth_code)
 which completes the Oauth2 handshake with Wepay and get's the access token for future comunications with Wepay.
@@ -113,40 +67,28 @@ Finally, your checkout controller (or some controller that will interact with th
         before_filter :authenticate_account! # I am using devise - this line depends on your authentication scheme
 
         # PLEASE READ
-        # Notes: (By the way, I am looking into putting most of this heavy lifting into the actual wepay-rails gem
-        # it's self - stay tuned for that)
         # I am saving the wepay_auth_code in my Profile model. Somewhere in my rails app, I have a method called
-        # current_profile which I use to return the Profile object of my user - this is why I can use current_profile.wepay_auth_code
-        # please dress this up to work for your application.
+        # current_profile which I use to return the Profile object of my user. I pass that object through the
+        # init_checkout_and_send_user_to_wepay method along with my checkout parameters.
 
-        # Please pay attention to the flow here though (Note, I am going to find a way to move most of this pain to wepay-rails - stay tuned):
-        # Step 1: check and see if we have saved a wepay_auth_code for the customer. If not, redirect them to wepay to get one
-        # Step 2: check to see if we have a wepay access token to use for Oauth Communications. If not, go get one
-        # Step 3: now do a checkout using the method init_checkout_and_send_user_to_wepay. When they are done paying you, they will be redirected
+        # After the customer is sent to wepay, when they are done paying you, they will be redirected
         # back to your application - you will set the location they will be redirected back to using the redirect_uri directive
         # either here - or in wepay.yml. Using it here overrides wepay.yml.
 
         def index
-            if current_profile.wepay_auth_code.present? # Code used to get the Oauth Access Token
-                if wepay_access_token_exists? # Temporary Oauth Access token from wepay
-
-                    cart = current_account.cart # EXAMPLE - get my shopping cart
-                    tx_id = cart.transaction_id # EXAMPLE - I use a column in my cart to have a way to look up the cart upon the user's return from wepay
-
-                    checkout_params = {
-                        :amount => cart.grand_total,
-                        :short_description => cart.short_description,
-                        :long_description => cart.long_description,
-                        :redirect_uri => purchase_finalize_index_url(:txID => tx_id) # Wepay redirects the user back to this url after purchase
-                    }
-
-                    init_checkout_and_send_user_to_wepay(checkout_params) # Send the customer to wepay to finish payment
-                else
-                    initialize_wepay_access_token(current_profile.wepay_auth_code) # No access token - so go get one
-                end
-            else
-                redirect_to_wepay_for_auth(current_profile) # Customer doesn't have an auth code yet from Wepay - so go get one
-            end
+
+            cart = current_account.cart # EXAMPLE - get my shopping cart
+            tx_id = cart.transaction_id # EXAMPLE - I use a column in my cart to have a way to look up the cart upon the user's return from wepay
+
+            checkout_params = {
+                :amount => cart.grand_total,
+                :short_description => cart.short_description,
+                :long_description => cart.long_description,
+                :redirect_uri => purchase_finalize_index_url(:txID => tx_id) # Wepay redirects the user back to this url after purchase
+            }
+
+            # Finally, send the user off to wepay so you can get paid! - CASH MONEY
+            init_checkout_and_send_user_to_wepay(checkout_params, current_profile)
         end
     end
 
@@ -170,68 +112,9 @@ Example Routes for these:
         resources :finalize, :only => [:index]
     end
 
-First, we check to see if we have saved the auth code for the user, if so, we next need to see if we have an Oauth2 access token.
-If not, we can initialize the access token. If it is there, go ahead and make an api call - the example above initiates a checkout.
 
-Configuration is done through config/wepay.yml:
-    production:
-      client_id: <your client_id from wepay>
-      client_secret: <your client_secret from wepay>
-      auth_code_location: MyModel.wepay_auth_code
-      redirect_uri: "http://www.example.com/wepay/authorize"
-      after_authorize_redirect_uri: "http://www.example.com/purchase/checkout"
-      scope: ['refund_payments','collect_payments','view_balance','view_user']
-      #wepay_api_uri: "https://api.wepay.com"
-      wepay_api_uri: "https://stage.wepay.com"
-      wepay_api_version: "v2"
-      ipn_callback_uri: "http://www.example.com/wepay/ipn"
-      checkout_redirect_uri: "http://www.example.com/purchase/finalize"
-      fee_payer: Payee
-      checkout_type: GOODS
-      charge_tax: false
-      app_fee: 0
-      auto_capture: true
-      require_shipping: false
-      shipping_fee: 0
-      charge_tax: false
-    development:
-      client_id: <your client_id from wepay>
-      client_secret: <your client_secret from wepay>
-      auth_code_location: MyModel.wepay_auth_code
-      redirect_uri: "http://dev.example.com/wepay/authorize"
-      after_authorize_redirect_uri: "http://dev.example.com/purchase/checkout"
-      scope: ['refund_payments','collect_payments','view_balance','view_user']
-      wepay_api_uri: "https://stage.wepay.com"
-      wepay_api_version: "v2"
-      ipn_callback_uri: "http://dev.example.com/wepay/ipn"
-      checkout_redirect_uri: "http://dev.example.com/purchase/finalize"
-      fee_payer: Payee
-      checkout_type: GOODS
-      charge_tax: false
-      app_fee: 0
-      require_shipping: false
-      shipping_fee: 0
-      charge_tax: false
-      auto_capture: true
-    test:
-      client_id: <your client_id from wepay>
-      client_secret: <your client_secret from wepay>
-      auth_code_location: MyModel.wepay_auth_code
-      redirect_uri: "http://test.example.com/wepay/authorize"
-      after_authorize_redirect_uri: "http://test.example.com/purchase/checkout"
-      scope: ['refund_payments','collect_payments','view_balance','view_user']
-      wepay_api_uri: "https://stage.wepay.com"
-      wepay_api_version: "v2"
-      ipn_callback_uri: "http://test.example.com/wepay/ipn"
-      checkout_redirect_uri: "http://test.example.com/purchase/finalize"
-      fee_payer: Payee
-      checkout_type: GOODS
-      charge_tax: false
-      app_fee: 0
-      auto_capture: true
-      charge_tax: false
-      require_shipping: false
-      shipping_fee: 0
+== Special Thanks to additional contributers of Wepay-Rails
+* lucisferre (Chris Nicola) https://github.com/lucisferre
 
 
 == Contributing to wepay-rails

data/VERSION

@@ -1 +1 @@
-0.1.116
+0.2.0

data/lib/generators/wepay_rails/install/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/migration'
+
+module WepayRails
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "add a migration for the Wepay Rails - WepayCheckoutRecord Model - Used to capture your transactions from Wepay"
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "create_wepay_checkout_records.rb", "db/migrate/create_wepay_checkout_records.rb"
+        copy_file "wepay_checkout_record.rb", "lib/models/wepay_checkout_record.rb"
+        copy_file "wepay.yml", "config/wepay.yml.example"
+      end
+    end
+  end
+end

data/lib/generators/wepay_rails/install/templates/create_wepay_checkout_records.rb

@@ -0,0 +1,39 @@
+class CreateWepayCheckoutRecords < ActiveRecord::Migration
+    def self.up
+
+        create_table :wepay_checkout_records do |t|
+            t.integer :checkout_id
+            t.integer :account_id
+            t.string :auth_code
+            t.string :state
+            t.string :short_description
+            t.text :long_description
+            t.string :currency
+            t.decimal :amount
+            t.decimal :app_fee
+            t.string :fee_payer
+            t.decimal :gross
+            t.decimal :fee
+            t.string :reference_id
+            t.text :redirect_uri
+            t.text :callback_uri
+            t.text :checkout_uri
+            t.string :payer_email
+            t.string :payer_name
+            t.text :cancel_reason
+            t.text :refund_reason
+            t.boolean :auto_capture
+            t.boolean :require_shipping
+            t.text :shipping_address
+            t.decimal :tax
+
+            t.timestamps
+        end
+
+        add_index :wepay_checkout_records, :checkout_id
+    end
+
+    def self.down
+        drop_table :wepay_checkout_records
+    end
+end

data/lib/generators/wepay_rails/install/templates/wepay.yml

@@ -0,0 +1,23 @@
+production:
+  client_id: <your client id from wepay>
+  client_secret: <your client secret from wepay>
+  account_id: <your account id from wepay>
+  auth_code_location: MyModel.wepay_auth_code #model and column where you store the auth code for each of your customers eg. Profile.wepay_auth_code
+  redirect_uri: "http://www.example.com/wepay/authorize" # where to send the user on their trip back from wepay for payment
+  after_authorize_redirect_uri: "http://www.example.com/purchase/checkout" # after the user gets an auth token from wepay, where should they come?
+  scope: [refund_payments,collect_payments,view_balance,view_user]
+  wepay_api_uri: "https://api.wepay.com" # Use https://stage.wepay.com for development
+  wepay_api_version: "v2"
+  ipn_callback_uri: "http://www.example.com/wepay/ipn" # Future requests from wepay to you should go where?
+  fee_payer: Payee
+  checkout_type: GOODS
+  charge_tax: false
+  app_fee: 0
+  auto_capture: true
+  require_shipping: false
+  shipping_fee: 0
+  charge_tax: false
+  wepay_checkout_model: WepayCheckoutRecord # This is where the transactions for the checkouts will be stored
+development:
+
+test:

data/lib/generators/wepay_rails/install/templates/wepay_checkout_record.rb

@@ -0,0 +1,2 @@
+class WepayCheckoutRecord < ActiveRecord::Base
+end

data/lib/helpers/controller_helpers.rb

@@ -35,7 +35,20 @@ module WepayRails
       # Response
       # {"user_id":"123456","access_token":"1337h4x0rzabcd12345","token_type":"BEARER"} Example
       def initialize_wepay_access_token(wepayable_object)
-        session[unique_wepay_access_token_key] = wepay_gateway.access_token(wepayable_object)
+        return if wepay_access_token_exists?
+        begin
+          # check to see if they have an auth code
+          # If not, send them to wepay to get one
+          wepayable_column = WepayRails::Configuration.wepayable_column
+          raise unless wepayable_object.send(wepayable_column.to_sym).present?
+
+          # It's possible that we raise an exception here - probably the auth code
+          # was too old and they need an updated one. Send them to wepay to
+          # get a new one if a raise happens while we run the following line of code.
+          session[unique_wepay_access_token_key] = wepay_gateway.access_token(wepayable_object)
+        rescue
+          redirect_to_wepay_for_auth(wepayable_object)
+        end
         return
       end
 
@@ -95,7 +108,8 @@ module WepayRails
       # :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)
+      def init_checkout_and_send_user_to_wepay(params, wepayable_object=nil)
+        initialize_wepay_access_token(wepayable_object) if wepayable_object.present?
         response = wepay_gateway.perform_checkout(params)
         checkout = WepayCheckoutRecord.create(params.merge({ checkout_id: response['checkout_id'] }))
         raise WepayRails::Exceptions::InitializeCheckoutError.new("A problem occurred while trying to checkout. Wepay didn't send us back a checkout uri. Response was: #{response.inspect}, Params were: #{params}, Token was: #{wepay_access_token}") unless response && response.has_key?('checkout_uri')

data/wepay-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "wepay-rails"
-  s.version = "0.1.116"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Medeiros"]
-  s.date = "2011-11-15"
+  s.date = "2011-11-25"
   s.description = "Rails gem that interfaces with the WePay API"
   s.email = "adammede@gmail.com"
   s.extra_rdoc_files = [
@@ -31,6 +31,10 @@ Gem::Specification.new do |s|
     "app/controllers/wepay/ipn_controller.rb",
     "config/routes.rb",
     "lib/examples/wepay.yml",
+    "lib/generators/wepay_rails/install/install_generator.rb",
+    "lib/generators/wepay_rails/install/templates/create_wepay_checkout_records.rb",
+    "lib/generators/wepay_rails/install/templates/wepay.yml",
+    "lib/generators/wepay_rails/install/templates/wepay_checkout_record.rb",
     "lib/helpers/controller_helpers.rb",
     "lib/helpers/model_helpers.rb",
     "lib/wepay-rails.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wepay-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.116
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-15 00:00:00.000000000Z
+date: 2011-11-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &15515820 !ruby/object:Gem::Requirement
+  requirement: &24572180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15515820
+  version_requirements: *24572180
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &15514680 !ruby/object:Gem::Requirement
+  requirement: &24569700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15514680
+  version_requirements: *24569700
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &15513480 !ruby/object:Gem::Requirement
+  requirement: &24537240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *15513480
+  version_requirements: *24537240
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &15512360 !ruby/object:Gem::Requirement
+  requirement: &24534500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *15512360
+  version_requirements: *24534500
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &15507620 !ruby/object:Gem::Requirement
+  requirement: &24531780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15507620
+  version_requirements: *24531780
 description: Rails gem that interfaces with the WePay API
 email: adammede@gmail.com
 executables: []
@@ -88,6 +88,10 @@ files:
 - app/controllers/wepay/ipn_controller.rb
 - config/routes.rb
 - lib/examples/wepay.yml
+- lib/generators/wepay_rails/install/install_generator.rb
+- lib/generators/wepay_rails/install/templates/create_wepay_checkout_records.rb
+- lib/generators/wepay_rails/install/templates/wepay.yml
+- lib/generators/wepay_rails/install/templates/wepay_checkout_record.rb
 - lib/helpers/controller_helpers.rb
 - lib/helpers/model_helpers.rb
 - lib/wepay-rails.rb
@@ -109,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3634481726847388061
+      hash: -326143609003264246
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: