wepay-rails 2.0.0 → 2.1.0

data/README.rdoc

@@ -2,14 +2,21 @@
 
 Wepay-Rails allows your rails app to accept payments with Wepay (http://www.wepay.com).
 
+= Features
+
+* Built in IPN that listens to push notifications from wepay and updates saved checkout records for you
+* Allows you to fetch your access token easily through a web interface
+* Built in API tools to allow you to make all wepay-api calls easily
+* Built in ability to send your customers to wepay to make payments and handles their trip back for you
+* Saves the current state of every checkout
+* Configurable
+
+= Installation
+
 To install it, add this to your Gemfile
 
     gem 'wepay-rails'
 
-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.
-
 To create your WepayCheckoutRecord model and migration:
 
     script/rails g wepay_rails:install
@@ -18,6 +25,11 @@ This will create 3 files for you, a migration file for a table to hold the check
 
     rake db:migrate
 
+WepayCheckoutRecord 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. Also, since a model is created for you, you can also track changes to it's state
+through state machine or paper trail or some other gem of your liking. Hook up WepayCheckoutRecord how you like.
+
 Modify config/wepay.yml.example to your needs and copy it to config/wepay.yml.
 
 Assuming that you have:
@@ -36,11 +48,12 @@ To fetch your access_token, open a browser and go to:
 Login at the prompt or register. You will be sent back to your app and you should have gotten an access_token. Copy it to your wepay.yml
 file and restart 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
+= Example
+
+I created a controller 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 - 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...
+in the cart. Your app is surely different than mine. Do what makes sense to you.
+For now, here's a small example...
 
   app
     |_ controllers
@@ -48,18 +61,15 @@ For now, here's what I am doing in my rails app to handle it...
                         |_ checkout_controller.rb
                         |_ finalize_controller.rb
 
-You will need to set the location of these files in your wepay.yml file. The directives are:
+Tell wepay-rails where to send the customer after they come back from wepay with a complete payment. Open wepay.yml:
 
-    after_authorize_redirect_uri: "http://www.example.com/purchase/checkout"
     after_checkout_redirect_uri: "http://www.example.com/purchase/finalize"
 
-Finally, your checkout controller (or some controller that will interact with the Wepay API) - notice it includes WepayRails::Payments:
+Create a controller that will send the user to wepay - notice it includes WepayRails::Payments:
 
     class Purchase::CheckoutController < ApplicationController
         include WepayRails::Payments
 
-        before_filter :authenticate_user! # I am using devise - this line depends on your authentication scheme
-
         def index
             cart = current_user.cart # EXAMPLE - get my shopping cart
 
@@ -74,14 +84,16 @@ Finally, your checkout controller (or some controller that will interact with th
         end
     end
 
-The controller I use for finalizing the checkout - AKA - the controller the user is sent back to after his/her trip to
-wepay to checkout.
+Finally, the controller I use for finalizing the checkout - AKA - the controller the user is sent back to after his/her trip back from
+wepay. A checkout_id is passed in through params so you can access the WepayCheckoutRecord, make a call to
+wepay to get the checkout info - whatever you want to do (See the wiki for more info on API calls):
 
     class Purchase::FinalizeController < ApplicationController
       def index
+        # Fetch the WepayCheckoutRecord that was stored for the checkout
         wcr  = WepayCheckoutRecord.find_by_checkout_id(params[:checkout_id])
 
-        # Set the association of the wepay checkout record to my cart - then, on to order.
+        # Example: Set the association of the wepay checkout record to my cart - then, on to order.
         cart = current_account.cart
         cart.wepay_checkout_record = wcr
         cart.save!

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

data/app/controllers/wepay/authorize_controller.rb

@@ -1,4 +1,3 @@
-require 'digest/sha2'
 class Wepay::AuthorizeController < Wepay::ApplicationController
 
   def index
@@ -8,7 +7,12 @@ class Wepay::AuthorizeController < Wepay::ApplicationController
       access_token = wepay_gateway.get_access_token(params[:code], redirect_uri)
       render :text => "Copy this access token, #{access_token} to the access_token directive in your wepay.yml"
     else
-      redirect_to wepay_gateway.auth_code_url redirect_uri
+      # For security purposes, stop people from hitting this page and resetting the access_token.
+      if wepay_gateway.configuration[:access_token].present?
+        render :text => "You have already specified an access token in wepay.yml. If you wish to change it, please delete the current one and try again."
+      else
+        redirect_to wepay_gateway.auth_code_url redirect_uri
+      end
     end
   end
 
@@ -16,4 +20,4 @@ class Wepay::AuthorizeController < Wepay::ApplicationController
   def redirect_uri
     "#{WepayRails::Configuration.settings[:root_callback_uri]}/wepay/authorize"
   end
-end
+end

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

@@ -4,9 +4,7 @@ production:
   account_id: <your account id from wepay>
   access_token: <your access token that you recieved when you went to http://your.domain.com/wepay/authorize>
   root_callback_uri: "http://www.example.com"
-  after_authorize_redirect_uri: "http://www.example.com/purchase/checkout"
   after_checkout_redirect_uri: "http://www.example.com/purchase/finalize"
-  registration_confirmation_uri: "http://www.example.com/purchase/cart?msg=Please confirm your wepay account."
   scope: [refund_payments,collect_payments,view_balance,view_user]
   wepay_api_uri: "https://api.wepay.com/v2"
   fee_payer: Payee

data/lib/helpers/controller_helpers.rb

@@ -40,6 +40,11 @@ module WepayRails
       def init_checkout_and_send_user_to_wepay(params, access_token=nil)
         wepay_gateway = WepayRails::Payments::Gateway.new(access_token)
         response      = wepay_gateway.perform_checkout(params)
+
+        if response['checkout_uri'].blank?
+          raise WepayRails::Exceptions::WepayCheckoutError.new("An error occurred: #{response.inspect}")
+        end
+
         params.merge!({
             :access_token => wepay_gateway.access_token,
             :checkout_id  => response['checkout_id']

data/lib/wepay-rails.rb

@@ -1,6 +1,5 @@
 require 'active_record'
 require 'helpers/controller_helpers'
-require 'api/account_methods'
 require 'api/checkout_methods'
 module WepayRails
   class Configuration
@@ -29,6 +28,7 @@ module WepayRails
     class ExpiredTokenError < StandardError; end
     class InitializeCheckoutError < StandardError; end
     class AuthorizationError < StandardError; end
+    class WepayCheckoutError < StandardError; end
   end
 
   module Payments
@@ -98,13 +98,16 @@ module WepayRails
         {'Authorization' => "Bearer: #{@access_token}"}
       end
 
+      def configuration
+        @wepay_config
+      end
+
       def call_api(api_path, params={})
         response = self.class.post("#{@base_uri}#{api_path}", {:headers => wepay_auth_header}.merge!({:body => params}))
         JSON.parse(response.body)
       end
 
       include WepayRails::Api::CheckoutMethods
-      include WepayRails::Api::AccountMethods
     end
 
     include WepayRails::Exceptions

data/wepay-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "wepay-rails"
-  s.version = "2.0.0"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Medeiros"]
-  s.date = "2011-11-27"
+  s.date = "2011-11-28"
   s.description = "Rails gem that interfaces with the WePay API"
   s.email = "adammede@gmail.com"
   s.extra_rdoc_files = [
@@ -37,7 +37,6 @@ Gem::Specification.new do |s|
     "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",
     "test/helper.rb",
     "test/test_wepay-rails.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wepay-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-27 00:00:00.000000000Z
+date: 2011-11-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &9095360 !ruby/object:Gem::Requirement
+  requirement: &24514020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *9095360
+  version_requirements: *24514020
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &9093080 !ruby/object:Gem::Requirement
+  requirement: &24512520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9093080
+  version_requirements: *24512520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &9091480 !ruby/object:Gem::Requirement
+  requirement: &24510740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *9091480
+  version_requirements: *24510740
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &9090080 !ruby/object:Gem::Requirement
+  requirement: &24486880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *9090080
+  version_requirements: *24486880
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &9088680 !ruby/object:Gem::Requirement
+  requirement: &24484080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9088680
+  version_requirements: *24484080
 description: Rails gem that interfaces with the WePay API
 email: adammede@gmail.com
 executables: []
@@ -94,7 +94,6 @@ files:
 - 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
 - test/helper.rb
 - test/test_wepay-rails.rb
@@ -114,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -431317544786585156
+      hash: 2056025376124091245
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/helpers/model_helpers.rb

@@ -1,6 +0,0 @@
-module WepayRails
-  module Helpers
-    module ModelHelpers
-    end
-  end
-end