paypal-ipn 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in paypal.gemspec
+gemspec

data/README.markdown

@@ -6,6 +6,8 @@ Currently paypal supports the following:
 
 * Verifying Paypal IPN's
 * MassPay Requests
+* Permissions Service
+* Authentication Service
 
 ## Configuration
     Paypal.setup do |config|
@@ -101,13 +103,56 @@ Note: Your class must respond to `payment_response` and return the payment respo
 
 Note: Currently Masspay payments only support a single recipient
 
-## Rails
-    `rails g paypal:initializer`
-Generates a stub initializer under config/initializers
+### Permissions Service
+    class Permissions
+      include Paypal::Permissions
+    end
+
+#### Usage
+1. Make a call to `set_paypal_permissions_url` setting the *return_url* to your application's callback url and with your *required_permissions*
+
+2. Redirect the user to that url
+
+3. When Paypal redirects the user back to your application at *return_url* make a call to `get_paypal_permissions` with the token parameter
+
+See below for further details:
+
+##### Private methods
+`set_paypal_permissions_url(return_url, required_permissions = {})`
+Returns a url where the user can sign in to Paypal and authorize the requested permissions. Paypal will then redirect the user to the *return_url*. Specify *required_permissions* by supplying a hash in the following format:
+    {
+      :mass_pay => true,
+      :refund_transaction => true,
+      :get_transaction_details => true
+    }
+First name, Last name and email are always required permissions so you never have to specify these manually.
+
+`get_paypal_permissions(token)`
+Returns a hash of user information and permission details for the given *token* in the following format:
+    {
+      :email => "joe@example.com",
+      :first_name => "Joe",
+      :last_name => "Bloggs",
+      :payer_id => "VK7XZU4BDY79",
+      :permissions => {
+        :mass_pay => true,
+        :refund_transaction => true,
+        :get_transaction_details => true
+      }
+    }
 
 ## Installation
 
-    gem install paypal
+    gem install paypal-ipn
+
+## Rails
+
+Place the following in your Gemfile:
+    `gem 'paypal-ipn', :require => 'paypal'`
+
+To generate a stub initializer under config/initializers run:
+    `rails g paypal:initializer`
+
 
 Copyright (c) 2010 David Wilkie, released under the MIT license
 

data/Rakefile

@@ -1,39 +1,2 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the Paypal plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'spec'
-  t.libs << 'features'
-  t.pattern = 'spec/**/*_spec.rb'
-  t.verbose = true
-end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "paypal-ipn"
-    gemspec.summary = "Another ruby wrapper for Paypal"
-    gemspec.email = "dwilkie@gmail.com"
-    gemspec.homepage = "http://github.com/dwilkie/paypal"
-    gemspec.authors = ["David Wilkie"]
-    gemspec.add_runtime_dependency "httparty", ">=0.6.1"
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end
-
-desc 'Generate documentation for the Paypal plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Paypal'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/paypal.rb

@@ -1,14 +1,20 @@
+require 'httparty'
 require 'paypal/ipn/ipn'
 require 'paypal/ipn/types/masspay'
 require 'paypal/ipn/variables/buyer'
 require 'paypal/ipn/variables/item'
 require 'paypal/masspay'
+require 'paypal/permissions'
+require 'paypal/authentication'
 
 module Paypal
 
   LIVE_NVP_URI = "https://api-3t.paypal.com/nvp"
   SANDBOX_NVP_URI = "https://api-3t.sandbox.paypal.com/nvp"
 
+  LIVE_URI = "https://www.paypal.com"
+  SANDBOX_URI = "https://www.sandbox.paypal.com"
+
   mattr_accessor :environment,
                  :api_username,
                  :api_password,
@@ -20,10 +26,16 @@ module Paypal
     yield self
   end
 
-  def self.nvp_uri
+  def self.nvp_uri(force_https = true)
     environment == "live" ?
       LIVE_NVP_URI :
       SANDBOX_NVP_URI
   end
+
+  def self.uri
+    environment == "live" ?
+      LIVE_URI :
+      SANDBOX_URI
+  end
 end
 

data/lib/paypal/authentication.rb

@@ -0,0 +1,67 @@
+module Paypal
+  module Authentication
+    require 'rack'
+    include HTTParty
+    private
+      def authenticate_with_paypal_url(return_url)
+        body = {
+          "METHOD" => "SetAuthFlowParam",
+          "VERSION" => "2.3",
+          "USER" => Paypal.api_username,
+          "PWD" => Paypal.api_password,
+          "SIGNATURE" => Paypal.api_signature,
+          "SERVICENAME1" => "Name",
+          "SERVICEDEFREQ1" => "Required",
+          "SERVICENAME2" => "Email",
+          "SERVICEDEFREQ2" => "Required",
+          "RETURNURL" => return_url,
+          "CANCELURL" => return_url,
+          "LOGOUTURL"=> return_url
+        }
+        request_uri = URI.parse(Paypal.nvp_uri)
+        request_uri.scheme = "https" # force https
+        response = Paypal::Authentication.send_request(body)
+        url = Paypal::Authentication.build_uri_from_set_auth_flow_param_response(response)
+        url ? url : return_url
+      end
+
+      def get_auth_details(token)
+        body = {
+          "METHOD" => "GetAuthDetails",
+          "VERSION" => "2.3",
+          "USER" => Paypal.api_username,
+          "PWD" => Paypal.api_password,
+          "SIGNATURE" => Paypal.api_signature,
+          "TOKEN" => token
+        }
+        Paypal::Authentication.normalize_paypal_response(
+          Paypal::Authentication.send_request(body)
+        )
+      end
+
+      def self.normalize_paypal_response(raw_response)
+        raw_response_hash = Rack::Utils.parse_nested_query(raw_response)
+        {
+          :payer_id => raw_response_hash["PAYERID"],
+          :first_name => raw_response_hash["FIRSTNAME"],
+          :last_name => raw_response_hash["LASTNAME"],
+          :email => raw_response_hash["EMAIL"]
+        } if raw_response_hash["ACK"] == "Success"
+      end
+
+      def self.send_request(body)
+        self.post(Paypal.nvp_uri, :body => body).body
+      end
+
+      def self.build_uri_from_set_auth_flow_param_response(response)
+        if token = Rack::Utils.parse_nested_query(response)["TOKEN"]
+          uri = URI.parse(Paypal.uri)
+          uri.query = Rack::Utils.build_nested_query(
+            "token" => token, "cmd" => "_account-authenticate-login"
+          )
+          uri.to_s
+        end
+      end
+    end
+end
+

data/lib/paypal/permissions.rb

@@ -0,0 +1,126 @@
+module Paypal
+  module Permissions
+    require 'rack'
+    include HTTParty
+    private
+      def set_paypal_permissions_url(return_url, required_permissions = {})
+        required_permissions.merge!(:name => true, :email => true)
+        paypal_required_permissions = {}
+        index = 0
+        required_permissions.each do |k,v|
+          if v
+            paypal_required_permissions["L_REQUIREDACCESSPERMISSIONS#{index}"] = Paypal::Permissions.paypal_permission_name(k)
+            index += 1
+          end
+        end
+        body = {
+          "METHOD" => "SetAccessPermissions",
+          "VERSION" => "2.3",
+          "USER" => Paypal.api_username,
+          "PWD" => Paypal.api_password,
+          "SIGNATURE" => Paypal.api_signature,
+          "RETURNURL" => return_url,
+          "CANCELURL" => return_url,
+          "LOGOUTURL"=> return_url
+        }.merge(paypal_required_permissions)
+        response = Paypal::Permissions.send_request(body)
+        url = Paypal::Permissions.build_uri_from_set_access_permissions_response(response)
+        url ? url : return_url
+      end
+
+      def get_paypal_permissions(token)
+        body = {
+          "METHOD" => "GetAccessPermissionDetails",
+          "VERSION" => "2.3",
+          "USER" => Paypal.api_username,
+          "PWD" => Paypal.api_password,
+          "SIGNATURE" => Paypal.api_signature,
+          "TOKEN" => token
+        }
+        Paypal::Permissions.normalize_paypal_response(
+          Paypal::Permissions.send_request(body)
+        )
+      end
+
+      def self.send_request(body)
+        self.post(Paypal.nvp_uri, :body => body).body
+      end
+
+      def self.paypal_permission_name(key)
+        case key.to_s
+
+        when "express_checkout"
+          "Express_Checkout"
+
+        when "admin_api"
+          "Admin_API"
+
+        when "auth_settle"
+          "Auth_Settle"
+
+        when "transaction_history"
+          "Transaction_History"
+
+        when "do_uatp_authorization"
+          "DoUATPAuthorization"
+
+        when "do_uatp_express_checkout_payment"
+          "DoUATPExpressCheckoutPayment"
+
+        else
+          camelize(key)
+        end
+      end
+
+      def self.build_uri_from_set_access_permissions_response(response)
+        if token = Rack::Utils.parse_nested_query(response)["TOKEN"]
+          uri = URI.parse(Paypal.uri)
+          uri.query = Rack::Utils.build_nested_query(
+            "token" => token, "cmd" => "_access-permission-login"
+          )
+          uri.to_s
+        end
+      end
+
+      def self.normalize_paypal_response(raw_response)
+        raw_response_hash = Rack::Utils.parse_nested_query(raw_response)
+        if raw_response_hash["ACK"] == "Success"
+          normalized_response = {
+            :payer_id => raw_response_hash["PAYERID"],
+            :first_name => raw_response_hash["FIRSTNAME"],
+            :last_name => raw_response_hash["LASTNAME"],
+            :email => raw_response_hash["EMAIL"],
+            :permissions => normalize_permissions(raw_response_hash)
+          }
+        end
+      end
+
+      def self.normalize_permissions(raw_response_hash)
+        normalized_permissions = {}
+        permission_name_key = "L_ACCESSPERMISSIONNAME"
+        permission_status_key = "L_ACCESSPERMISSIONSTATUS"
+        i = 0
+        begin
+          permission = raw_response_hash[permission_name_key + i.to_s]
+          permission_status = raw_response_hash[permission_status_key + i.to_s]
+          normalized_permissions[underscore(permission).to_sym] = (permission_status == "Accepted") if permission && permission_status
+          i += 1
+        end until permission.nil? || permission_status.nil?
+        normalized_permissions
+      end
+
+      def self.camelize(lower_case_and_underscored_word)
+        lower_case_and_underscored_word.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }
+      end
+
+      def self.underscore(camel_cased_word)
+        word = camel_cased_word.to_s.dup
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+        word
+      end
+    end
+end
+

data/lib/paypal/version.rb

@@ -0,0 +1,3 @@
+module Paypal
+  VERSION = "0.0.2"
+end

data/paypal-ipn.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "paypal/version"
+
+Gem::Specification.new do |s|
+  s.name        = "paypal-ipn"
+  s.version     = Paypal::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["David Wilkie"]
+  s.email       = ["dwilkie@gmail.com"]
+  s.homepage    = "https://github.com/dwilkie/paypal"
+  s.summary     = %q{More than just IPNs}
+  s.description = %q{A ruby library for handling paypal api's including IPNs}
+  s.add_runtime_dependency("httparty")
+
+  s.rubyforge_project = "paypal"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - David Wilkie
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 +07:00
+date: 2010-11-16 00:00:00 +07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,41 +27,44 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 6
-        - 1
-        version: 0.6.1
+        version: "0"
   type: :runtime
   version_requirements: *id001
-description: 
-email: dwilkie@gmail.com
+description: A ruby library for handling paypal api's including IPNs
+email: 
+- dwilkie@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.markdown
+extra_rdoc_files: []
+
 files: 
+- .gitignore
+- Gemfile
 - MIT-LICENSE
 - README.markdown
 - Rakefile
-- VERSION
 - lib/generators/paypal/initializer/USAGE
 - lib/generators/paypal/initializer/initializer_generator.rb
 - lib/generators/paypal/initializer/templates/paypal.rb
 - lib/paypal.rb
+- lib/paypal/authentication.rb
 - lib/paypal/ipn/ipn.rb
 - lib/paypal/ipn/types/masspay.rb
 - lib/paypal/ipn/variables/buyer.rb
 - lib/paypal/ipn/variables/item.rb
 - lib/paypal/masspay.rb
-- paypal.gemspec
+- lib/paypal/permissions.rb
+- lib/paypal/version.rb
+- paypal-ipn.gemspec
 has_rdoc: true
-homepage: http://github.com/dwilkie/paypal
+homepage: https://github.com/dwilkie/paypal
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -82,10 +85,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: paypal
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Another ruby wrapper for Paypal
+summary: More than just IPNs
 test_files: []
 

data/VERSION

@@ -1 +0,0 @@
-0.0.1

data/paypal.gemspec

@@ -1,52 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{paypal}
-  s.version = "0.0.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["David Wilkie"]
-  s.date = %q{2010-09-24}
-  s.email = %q{dwilkie@gmail.com}
-  s.extra_rdoc_files = [
-    "README.markdown"
-  ]
-  s.files = [
-    "MIT-LICENSE",
-     "README.markdown",
-     "Rakefile",
-     "VERSION",
-     "lib/generators/paypal/initializer/USAGE",
-     "lib/generators/paypal/initializer/initializer_generator.rb",
-     "lib/generators/paypal/initializer/templates/paypal.rb",
-     "lib/paypal.rb",
-     "lib/paypal/ipn/ipn.rb",
-     "lib/paypal/ipn/types/masspay.rb",
-     "lib/paypal/ipn/variables/buyer.rb",
-     "lib/paypal/ipn/variables/item.rb",
-     "lib/paypal/masspay.rb",
-     "paypal.gemspec"
-  ]
-  s.homepage = %q{http://github.com/dwilkie/paypal}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Another ruby wrapper for Paypal}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
-    else
-      s.add_dependency(%q<httparty>, [">= 0.6.1"])
-    end
-  else
-    s.add_dependency(%q<httparty>, [">= 0.6.1"])
-  end
-end
-