paypal_permissions 0.0.3 → 0.0.3.1

data/README.md

@@ -0,0 +1,37 @@
+# PayPal Permissions
+
+## Assumptions
+
+You have the ActiveMerchant gem installed.
+
+## Caveats
+
+Earlier this morning, this README file contained the following content:
+
+> Nothing to see here yet. A work in progress.
+
+This code is currently released only to facilitate my very own testing. But apparently, PayPal directed at least one Ruby developer here, so I'm trying to catch up with demand. :)
+
+Bear in mind that the resource generator creates a number of fields in the database migration that are undoubtedly superfluous in some cases, and perhaps inadequate in others. If you're looking for a full audit trail by way of database entries for every permissions interaction, you may have to rely on your logs, not on the database. Even so, the generated schema should get the job done.
+
+## Install
+
+`rails generate paypal_permissions:install`
+
+Running the install generator will:
+
+- update your config/environments/{development,test,production}.rb files. You must edit these files with your PayPal credentials.
+- create a currently useless config/initializers/paypal_permissions.rb initializer.
+- create a currently useless config/locales/paypal_permissions.en.yml local file.
+
+
+## Optionally generate resources
+
+`rails generate paypal_permissions <new or existing resource name>`
+
+This generator will:
+
+- create a migration which updates the table for an existing model or creates a new table along with a new model. ActiveRecord is the only supported orm.
+- create a controller.
+- insert routes into config/routes.rb
+

data/lib/active_merchant/billing/gateways/paypal_permissions.rb

@@ -48,6 +48,23 @@ module ActiveMerchant #:nodoc:
         test? ? URLS[:test][:request_permissions] : URLS[:live][:request_permissions]
       end
 
+      public
+      def get_access_token(request_token, request_token_verifier)
+        query_string = build_get_access_token_query_string request_token, request_token_verifier
+        nvp_response = ssl_get "#{get_access_token_url}?#{query_string}", @options[:get_access_token_headers]
+        if nvp_response =~ /error\(\d+\)/
+          puts "request: #{get_access_token_url}?#{query_string}\n"
+          puts "nvp_response: #{nvp_response}\n"
+        end
+        response = parse_get_access_token_nvp(nvp_response)
+      end
+
+      public
+      def redirect_user_to_paypal_url token
+        template = test? ? URLS[:test][:redirect_user_to_paypal] : URLS[:live][:redirect_user_to_paypal]
+        template % token
+      end
+
       public
       def get_access_token_url
         test? ? URLS[:test][:get_access_token] : URLS[:live][:get_access_token]
@@ -62,11 +79,13 @@ module ActiveMerchant #:nodoc:
       URLS = {
         :test => {
           :request_permissions => 'https://svcs.sandbox.paypal.com/Permissions/RequestPermissions',
+          :redirect_user_to_paypal => 'https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_grant-permission&request_token=%s',
           :get_access_token => 'https://svcs.sandbox.paypal.com/Permissions/GetAccessToken',
           :get_permissions => 'https://svcs.sandbox.paypal.com/Permissions/GetPermissions',
         },
         :live => {
           :request_permissions => 'https://svcs.paypal.com/Permissions/RequestPermissions',
+          :redirect_user_to_paypal => 'https://www.paypal.com/cgi-bin/webscr?cmd=_grant-permission&request_token=%s',
           :get_access_token => 'https://svcs.paypal.com/Permissions/GetAccessToken',
           :get_permissions => 'https://svcs.sandbox.paypal.com/Permissions/GetPermissions',
         }
@@ -90,11 +109,18 @@ module ActiveMerchant #:nodoc:
         scopes.collect{ |s| "scope=#{URI.encode(s.to_s.strip.upcase)}" }.join("&")
       end
 
+      private
+      def build_get_access_token_query_string(request_token, verifier)
+        "requestEnvelope.errorLanguage=en_US&token=#{request_token}&verifier=#{verifier}"
+      end
+
+=begin
       private
       def setup_request_permission
         callback
         scope
       end
+=end
 
       private
       def parse_request_permissions_nvp(nvp)
@@ -168,6 +194,80 @@ module ActiveMerchant #:nodoc:
         response
       end
 
+      private
+      def parse_get_access_token_nvp(nvp)
+        response = {
+          :errors => [
+          ],
+        }
+        pairs = nvp.split "&"
+        pairs.each do |pair|
+          n,v = pair.split "="
+          n = CGI.unescape n
+          v = CGI.unescape v
+          case n
+          when "responseEnvelope.timestamp"
+            response[:timestamp] = v
+          when "responseEnvelope.ack"
+            response[:ack] = v
+=begin
+# Client should implement these with logging...
+            case v
+            when "Success"
+            when "Failure"
+            when "Warning"
+            when "SuccessWithWarning"
+            when "FailureWithWarning"
+            end
+=end
+          when "responseEnvelope.correlationId"
+            response[:correlation_id] = v
+          when "responseEnvelope.build"
+            # do nothing
+          when "token"
+            response[:token] = v
+          when "tokenSecret"
+            response[:tokenSecret] = v
+          when /^error\((?<error_idx>\d+)\)/
+            error_idx = error_idx.to_i
+            if response[:errors].length <= error_idx
+              response[:errors] << { :parameters => [] }
+              raise if response[:errors].length <= error_idx
+            end
+            case n
+            when /^error\(\d+\)\.errorId$/
+              response[:errors][error_idx][:error_id] = v
+=begin
+# Client should implement these with logging. PayPal doesn't distinguish
+# between errors which can be corrected by the user and errors which need
+# to be corrected by a developer or merchant, say, in configuration.
+#             case v
+#             when "520002"
+#             when
+=end            
+            when /^error\(\d+\)\.domain$/
+              response[:errors][error_idx][:domain] = v
+            when /^error\(\d+\)\.subdomain$/
+              response[:errors][error_idx][:subdomain] = v
+            when /^error\(\d+\)\.severity$/
+              response[:errors][error_idx][:severity] = v
+            when /^error\(\d+\)\.category$/
+              response[:errors][error_idx][:category] = v
+            when /^error\(\d+\)\.message$/
+              response[:errors][error_idx][:message] = v
+            when /^error\(\d+\)\.parameter\((?<parameter_idx>\d+)\)$/
+              parameter_idx = parameter_idx.to_i
+              if response[:errors][error_idx][:parameters].length <= parameter_idx
+                response[:errors][error_idx][:parameters] << {}
+                raise if response[:errors][error_idx][:parameters].length <= parameter_idx
+              end
+              response[:errors][error_idx][:parameters][parameter_idx] = v
+            end
+          end
+        end
+        response
+      end
+
       private
       def authentication_header url
         timestamp = Time.now.to_i
@@ -189,7 +289,7 @@ module ActiveMerchant #:nodoc:
         })
         sorted_params = Hash[params.sort]
         sorted_query_string = sorted_params.to_query
-        data = [ "POST", url, sorted_query_string ].join("&")  # ? "https://api.sandbox.paypal.com/nvp"
+        data = [ "POST", url, sorted_query_string ].join("&")  # ? "https://api-3t.sandbox.paypal.com/nvp"
         digest = OpenSSL::Digest::Digest.new('sha1')
         OpenSSL::HMAC.digest(digest, key, data)
         enc = Base64.encode64('Send reinforcements')  # encode per RFC 2045 (not 4648

data/lib/generators/active_record/paypal_permissions_generator.rb

@@ -17,32 +17,57 @@ module ActiveRecord
         end
       end
 
-      def generate_model
-        invoke "active_record:model", [name], :migration => false unless model_exists? && behavior == :invoke
+      def generate_paypal_permissions_model
+        invoke "active_record:model", [ name ], :migration => false unless model_exists? && behavior == :invoke
       end
 
       def inject_paypal_permissions_content
         inject_into_class(model_path, class_name, model_contents + <<ACCESSIBLE_FIELDS) if model_exists?
-  attr_accessible :ack, :correlation_id, :request_token, :verifier, :envelope_timestamp, :errors, :raw_response
+  attr_accessible :request_permissions_ack, :request_permissions_correlation_id, :request_permissions_request_token,
+                  :request_permissions_verifier, :request_permissions_envelope_timestamp,
+                  :request_permissions_errors, :request_permissions_raw_response,
+                  :request_permissions_callback_ack, :request_permissions_callback_correlation_id, :request_permissions_callback_request_token,
+                  :request_permissions_callback_verifier, :request_permissions_callback_envelope_timestamp,
+                  :request_permissions_callback_errors, :request_permissions_callback_raw_response,
+                  :get_access_token_ack, :get_access_token_correlation_id, :get_access_token_access_token,
+                  :get_access_token_verifier, :get_access_token_envelope_timestamp,
+                  :get_access_token_errors, :get_access_token_raw_response
 ACCESSIBLE_FIELDS
       end
 
       def migration_data
 <<MIGRATION_FIELDS
-      # Paypal Permissions response fields
-      t.string :ack
-      t.string :correlation_id
-      t.string :request_token
-      t.string :verifier
-      t.datetime :envelope_timestamp
-      t.text :errors
-      t.text :raw_response
+      # RequestPermissions response fields
+      t.string :request_permissions_ack
+      t.string :request_permissions_correlation_id
+      t.string :request_permissions_request_token
+      t.datetime :request_permissions_envelope_timestamp
+      t.text :request_permissions_errors
+      t.text :request_permissions_raw_response
+
+      # RequestPermissions callback fields
+      t.string :request_permissions_callback_ack
+      t.string :request_permissions_callback_correlation_id
+      t.string :request_permissions_callback_verifier
+      t.datetime :request_permissions_callback_envelope_timestamp
+      t.text :request_permissions_callback_errors
+      t.text :request_permissions_callback_raw_response
+      
+      # GetAccessToken response fields
+      t.string :get_access_token_ack
+      t.string :get_access_token_correlation_id
+      t.string :get_access_token_access_token
+      t.string :get_access_token_verifier
+      t.datetime :get_access_token_envelope_timestamp
+      t.text :get_access_token_errors
+      t.text :get_access_token_raw_response
 MIGRATION_FIELDS
       end
 
       def indexes
 <<INDEXES
-    add_index :#{table_name}, :request_token
+    add_index :#{table_name}, :request_permissions_request_token
+    add_index :#{table_name}, :get_access_token_access_token
 INDEXES
       end
     end

data/lib/generators/paypal_permissions/install_generator.rb

@@ -3,7 +3,7 @@ module PaypalPermissions
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)
 
-      desc "Creates a PaypalPermissions initializer and copies locale files to your application."
+      desc "Creates a PaypalPermissions initializer."
       class_option :orm
 
       def update_configuration
@@ -11,10 +11,10 @@ module PaypalPermissions
 #{Rails.application.class.name.split('::').first}::Application.configure do
   config.after_initialize do
     permissions_options = {
-      :login => "TODO: your PayPal sandbox caller login",
-      :password => "TODO: your PayPal sandbox caller login",
-      :signature => "TODO: your PayPal sandbox caller login",
-      :app_id => "APP-80W284485P519543T",  # This is the app_id for all PayPal Permissions Service sandbox test apps
+      :login => 'TODO: your PayPal sandbox caller login',
+      :password => 'TODO: your PayPal sandbox caller password',
+      :signature => 'TODO: your PayPal sandbox caller signature',
+      :app_id => 'APP-80W284485P519543T',  # This is the app_id for all PayPal Permissions Service sandbox test apps
     }
     ::PAYPAL_PERMISSIONS_GATEWAY = ActiveMerchant::Billing::PaypalPermissionsGateway.new(permissions_options)
   end
@@ -25,10 +25,10 @@ end
 #{Rails.application.class.name.split('::').first}::Application.configure do
   config.after_initialize do
     permissions_options = {
-      :login => "TODO: your PayPal live caller login",
-      :password => "TODO: your PayPal live caller login",
-      :signature => "TODO: your PayPal live caller login",
-      :app_id => "TODO: your PayPal live app id",
+      :login => 'TODO: your PayPal live caller login',
+      :password => 'TODO: your PayPal live caller password',
+      :signature => 'TODO: your PayPal live caller signature',
+      :app_id => 'TODO: your PayPal live app id',
     }
     ::PAYPAL_PERMISSIONS_GATEWAY = ActiveMerchant::Billing::PaypalPermissionsGateway.new(permissions_options)
   end

data/lib/generators/paypal_permissions/orm_helpers.rb

@@ -3,7 +3,7 @@ module PaypalPermissions
     module OrmHelpers
       def model_contents
 <<-CONTENT
-  validates :ack, :presence => true
+  # validates :request_permissions_ack, :presence => true
 CONTENT
       end
 
@@ -12,7 +12,7 @@ CONTENT
       end
       
       def migration_exists?(table_name)
-        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_add_devise_to_#{table_name}.rb$/).first
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_add_paypal_permissions_to_#{table_name}.rb$/).first
       end
       
       def migration_path

data/lib/generators/paypal_permissions/paypal_permissions_generator.rb

@@ -1,17 +1,23 @@
 module PaypalPermissions
   module Generators
     class PaypalPermissionsGenerator < Rails::Generators::NamedBase
-      namespace "paypal_permissions"
       source_root File.expand_path("../templates", __FILE__)
 
       desc "Generates a paypal_permissions resource with NAME along with a database migration."
 
       hook_for :orm
 
+      def generate_controller
+        generate "controller", plural_name if behavior == :invoke
+      end
+
       class_option :routes, :desc => "Generate routes", :type => :boolean, :default => true
 
       def insert_paypal_permissions_routes
-        route "resources :#{plural_name}" if options.routes?
+        if options.routes?
+          route "match '#{plural_name}/request_permissions_callback' => '#{plural_name}#request_permissions_callback', :via => [ :post ], :as => :#{plural_name}_request_permissions_callback_url"
+          route "resources :#{plural_name}"
+        end
       end
     end
   end

data/lib/paypal_permissions/version.rb

@@ -1,3 +1,3 @@
 module PaypalPermissions
-  VERSION = "0.0.3"
+  VERSION = "0.0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paypal_permissions
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-12 00:00:00.000000000Z
+date: 2012-03-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152913480 !ruby/object:Gem::Requirement
+  requirement: &2160369400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152913480
+  version_requirements: *2160369400
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2152911220 !ruby/object:Gem::Requirement
+  requirement: &2160368560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.11'
   type: :development
   prerelease: false
-  version_requirements: *2152911220
+  version_requirements: *2160368560
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &2152909500 !ruby/object:Gem::Requirement
+  requirement: &2160367380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152909500
+  version_requirements: *2160367380
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152907220 !ruby/object:Gem::Requirement
+  requirement: &2160366740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152907220
+  version_requirements: *2160366740
 - !ruby/object:Gem::Dependency
   name: activemerchant
-  requirement: &2152905020 !ruby/object:Gem::Requirement
+  requirement: &2160366180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152905020
+  version_requirements: *2160366180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152902880 !ruby/object:Gem::Requirement
+  requirement: &2160365220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.6'
   type: :runtime
   prerelease: false
-  version_requirements: *2152902880
+  version_requirements: *2160365220
 - !ruby/object:Gem::Dependency
   name: ammeter
-  requirement: &2152901040 !ruby/object:Gem::Requirement
+  requirement: &2160364660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152901040
+  version_requirements: *2160364660
 description: ! '"A gem to support PayPal Permissions API for Rails applications using
   ActiveMerchant."'
 email:
@@ -98,7 +98,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README
+- README.md
 - Rakefile
 - config/locales/en.yml
 - lib/active_merchant.rb
@@ -134,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1695586140316032045
+      hash: -1249773084249501105
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1695586140316032045
+      hash: -1249773084249501105
 requirements: []
 rubyforge_project: paypal_permissions
 rubygems_version: 1.8.10

data/README

@@ -1 +0,0 @@
-Nothing to see here yet. A work in progress.