paypal-permissions 0.1.1 → 0.1.2

data/README.md

@@ -9,7 +9,7 @@ Please visit PayPal's [Permissions Service API developer forums](https://www.x.c
 ### Step 1: Direct the user to the "Grant Permissions" on PayPal
 
 ~~~~~ ruby
-paypal = PaypalPermissions::Paypal.new( userid, password, signature, application_id, :production )
+paypal = PayPal::Permissions::Paypal.new( userid, password, signature, application_id, :production )
 request_data = paypal.request_permissions(
   [:express_checkout, :direct_payment, :auth_capture, :refund, :transaction_details],
   'http://localhost/callback_url'
@@ -22,7 +22,7 @@ redirect_to request_data[:permissions_url]
 ### Step 2: Lookup result to get the final permission token
 
 ~~~~~ ruby
-paypal = PaypalPermissions::Paypal.new( userid, password, signature, application_id, :production )
+paypal = PayPal::Permissions::Paypal.new( userid, password, signature, application_id, :production )
 token_data = paypal.get_access_token( params['token'], params['verifier'] )
 
 # Save token_data[:token] and token_data[:token_secret]

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/paypal/permissions.rb

@@ -0,0 +1,9 @@
+require 'paypal/permissions/version'
+require 'paypal/permissions/fault_message'
+require 'paypal/permissions/oauth'
+require 'paypal/permissions/paypal'
+
+# configuration
+module Paypal::Permissions
+
+end

data/lib/{paypal-permissions → paypal/permissions}/fault_message.rb

@@ -1,12 +1,12 @@
-module PaypalPermissions
+module Paypal::Permissions
   # Base error class
   class Error < Exception; end
 
   # PayPal returned a 500 Internal Server Error. Retry?
-  class InternalServerError < PaypalPermissions::Error; end
+  class InternalServerError < ::Paypal::Permissions::Error; end
 
   # PayPal returned an unexpected error message
-  class UnknownResponse < PaypalPermissions::Error
+  class UnknownResponse < ::Paypal::Permissions::Error
     attr_accessor :response_code
 
     def initialize(response_code, message)
@@ -39,7 +39,7 @@ module PaypalPermissions
       @correlation_id = options['correlationId']
       @build          = options['build']
       @errors         = collect_errors(options)
-      
+
       @message = @ack
     end
 
@@ -47,9 +47,9 @@ module PaypalPermissions
     def collect_errors(options={})
       errors = []
       error_number = 0
-      
+
       while options["error(#{error_number}).errorId"]
-        errors << PaypalPermissions::FaultMessage::ErrorInformation.new(options, error_number)
+        errors << ::Paypal::Permissions::FaultMessage::ErrorInformation.new(options, error_number)
         error_number = error_number + 1
       end
       errors

data/lib/paypal/permissions/oauth.rb

@@ -0,0 +1,42 @@
+require 'base64'
+require 'openssl'
+require 'uri'
+
+module Paypal::Permissions
+  module Oauth
+
+    # Note: OAuth does not encode '.', but PayPal does.
+    OAUTH_RESERVED_CHARACTERS = /[^a-zA-Z0-9\_]/
+    OAUTH_SIGNATURE_METHOD    = 'HMAC-SHA1'
+
+    # Create the X-PP-AUTHORIZATION header
+    def generate_signature(token, token_secret, http_method, endpoint)
+      raise "Invalid HTTP Method. Valid values: GET, POST, DELETE, UPDATE." unless ['GET','POST','DELETE','UPDATE'].include? http_method
+
+      timestamp = Time.now.to_i.to_s
+      signature_key = "#{@password}&#{oauth_escape(token_secret)}"
+
+      oauth_params = {
+        'oauth_consumer_key'      => @userid,
+        'oauth_signature_method'  => OAUTH_SIGNATURE_METHOD,
+        'oauth_timestamp'         => timestamp,
+        'oauth_token'             => token,
+        'oauth_version'           => '1.0',
+      }
+
+      input_string = "#{http_method}&#{oauth_escape(endpoint)}&"
+      input_string += oauth_params.map{ |k,v| "#{k}=#{v}" }.join('&')
+
+      # HMAC SHA1
+      digest_key = ::Digest::SHA1.digest(signature_key)
+      sha1_hash  = ::OpenSSL::Digest::Digest.new('sha1')
+      signature  = ::OpenSSL::HMAC.hexdigest(sha1_hash, digest_key, input_string)
+
+      "timestamp=#{timestamp},token=#{token},signature=#{signature}"
+    end
+
+    def oauth_escape(value)
+      URI::escape(value.to_s, OAUTH_RESERVED_CHARACTERS)
+    end
+  end
+end

data/lib/{paypal-permissions → paypal/permissions}/paypal.rb

@@ -3,7 +3,7 @@ require 'net/https'
 require 'uri'
 require 'cgi'
 
-module PaypalPermissions
+module Paypal::Permissions
   class Paypal
     include Oauth
 
@@ -61,7 +61,7 @@ module PaypalPermissions
       permissions_scopes.each_with_index { |ps,index| request_data["scope(#{index})"] = PERMISSIONS[ps] }
       data = call(url, request_data)
 
-      raise PaypalPermissions::FaultMessage.new(data) unless data['token']
+      raise ::Paypal::Permissions::FaultMessage.new(data) unless data['token']
 
       # Redirect URL:
       # https://www.paypal.com/cgi-bin/webscr?cmd=_grant-permission&request_token= + token
@@ -77,7 +77,7 @@ module PaypalPermissions
       url = create_url('GetAccessToken')
       data = call(url, { 'token' => token, 'verifier' => verifier })
 
-      raise PaypalPermissions::FaultMessage.new(data) unless (data['token'] && data['tokenSecret'])
+      raise ::Paypal::Permissions::FaultMessage.new(data) unless (data['token'] && data['tokenSecret'])
 
       {
         token:        data['token'],
@@ -92,7 +92,7 @@ module PaypalPermissions
       data = call(url, { 'token' => token })
 
       paypal_scopes = parse_scopes(data)
-      raise PaypalPermissions::FaultMessage.new(data) if paypal_scopes.empty?
+      raise ::Paypal::Permissions::FaultMessage.new(data) if paypal_scopes.empty?
 
       { scopes: paypal_scopes }
     end
@@ -135,12 +135,12 @@ module PaypalPermissions
         case code.to_i
         when 200
           data = get_hash(response.body)
-          raise PaypalPermissions::FaultMessage.new(data) if data['responseEnvelope.ack'] == 'Failure'
+          raise ::Paypal::Permissions::FaultMessage.new(data) if data['responseEnvelope.ack'] == 'Failure'
           return data
         when 500
-          raise PaypalPermissions::InternalServerError.new(response.body)
+          raise ::Paypal::Permissions::InternalServerError.new(response.body)
         else
-          raise PaypalPermissions::UnknownResponse.new(code.to_i, response.body)
+          raise ::Paypal::Permissions::UnknownResponse.new(code.to_i, response.body)
         end
       end
     end

data/lib/paypal/permissions/version.rb

@@ -0,0 +1,5 @@
+module Paypal; end
+
+module Paypal::Permissions #:nodoc
+  VERSION = "0.1.2"
+end

data/paypal-permissions.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{paypal-permissions}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Isaac Hall"]
+  s.date = %q{2011-07-30}
+  s.description = %q{Ruby implementation of the PayPal Permissions API.}
+  s.email = %q{isaac@isaachall.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "lib/paypal-permissions/fault_message.rb",
+    "lib/paypal-permissions/paypal.rb",
+    "lib/paypal-permissions/version.rb",
+    "lib/paypal-permissions.rb",
+    "spec/paypal_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/vcr/cancel_permission.yml",
+    "spec/vcr/cancel_permission_invalid.yml",
+    "spec/vcr/get_access_token_valid.yml",
+    "spec/vcr/lookup_permissions_multiple.yml",
+    "spec/vcr/request_permissions_multiple.yml",
+    "spec/vcr/request_permissions_single.yml"
+  ]
+  s.homepage = %q{http://github.com/isaachall/paypal-permissions}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Ruby implementation of the PayPal Permissions API.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httpclient>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rspec>, ["> 2.0.0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+    else
+      s.add_dependency(%q<httpclient>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rspec>, ["> 2.0.0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httpclient>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rspec>, ["> 2.0.0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+  end
+end
+

data/spec/oauth_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module Paypal::Permissions
+  describe Oauth do
+    before(:each) do
+      @api_key      = 'user.test.com'
+      @secret       = '1234567890'
+      @token        = '1234567890123456789012345678901234567890'
+      @token_secret = '1234567890'
+      @http_method  = 'POST'
+      @endpoint     = 'https://api.paypal.com/nvp'
+    end
+
+    it "should calculate a X-PP-AUTHORIZATION signature" do
+      Time.stub!(:now).and_return '1311832612'
+      sig = @paypal.generate_signature(@token, @token_secret, @http_method, @endpoint)
+      sig.should == 'timestamp=1311832612,token=1234567890123456789012345678901234567890,signature=d6da5d66e0f33ca7415b420cedf6b7286f05cba3'
+    end
+  end
+end

data/spec/paypal_spec.rb

@@ -1,29 +1,29 @@
 require 'spec_helper'
 
-module PaypalPermissions
+module Paypal::Permissions
   describe Paypal do
     it "should request permissions with multiple scopes" do
       VCR.use_cassette("request_permissions_multiple") do
         permission_data = @paypal.request_permissions(
-          [:express_checkout, :direct_payment, :auth_capture, :refund, :transaction_details], 
+          [:express_checkout, :direct_payment, :auth_capture, :refund, :transaction_details],
           'http://localhost/')
 
         permission_data[:token].should == 'AAAAAAATmjdbA3ADelJ6'
         permission_data[:permissions_url].should == 'https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_grant-permission&request_token=' + permission_data[:token]
       end
     end
-    
+
     it "should request permissions with a single scopes" do
       VCR.use_cassette("request_permissions_single") do
         permission_data = @paypal.request_permissions(
-          [:express_checkout], 
+          [:express_checkout],
           'http://localhost/')
-          
+
         permission_data[:token].should == 'AAAAAAATmnP2wcRCp7Mc'
         permission_data[:permissions_url].should == 'https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_grant-permission&request_token=' + permission_data[:token]
       end
     end
-    
+
     it "should get an access token" do
       VCR.use_cassette("get_access_token_valid") do
         access_data = @paypal.get_access_token('AAAAAAATmjdbA3ADelJ6','KVTI4zbTe.QW07vOqPpqYg')
@@ -55,7 +55,7 @@ module PaypalPermissions
           VCR.use_cassette("cancel_permission_invalid") do
             @paypal.cancel_permissions('M-RTGNyaZP5OMNIUxkH29I53eFvQhTJk3UfByH4pWfjSQHlj5csUVA')
           end
-        }.should raise_error(PaypalPermissions::FaultMessage)
+        }.should raise_error(::Paypal::Permissions::FaultMessage)
       end
     end
   end

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ require 'vcr'
 Bundler.setup
 
 $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
-require 'paypal-permissions'
+require 'paypal/permissions'
 
 module SpecHelper
   # add helper methods here
@@ -19,7 +19,7 @@ RSpec.configure do |config|
 
   config.before(:all) do
     credentials = YAML.load(File.read(File.join(File.dirname(__FILE__), 'sandbox_credentials.yml')))
-    @paypal = PaypalPermissions::Paypal.new(
+    @paypal = Paypal::Permissions::Paypal.new(
       credentials['userid'], credentials['password'],credentials['signature'],credentials['application_id'],credentials['mode']
     )
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paypal-permissions
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-30 00:00:00.000000000Z
+date: 2012-06-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &70277951499040 !ruby/object:Gem::Requirement
+  requirement: &70223949740140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70277951499040
+  version_requirements: *70223949740140
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70277951498140 !ruby/object:Gem::Requirement
+  requirement: &70223949739440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,21 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70277951498140
+  version_requirements: *70223949739440
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: &70223949738780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70223949738780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70277951497300 !ruby/object:Gem::Requirement
+  requirement: &70223949738260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -43,10 +54,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *70277951497300
+  version_requirements: *70223949738260
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70277951496300 !ruby/object:Gem::Requirement
+  requirement: &70223949737500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277951496300
+  version_requirements: *70223949737500
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70277951495480 !ruby/object:Gem::Requirement
+  requirement: &70223949736780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277951495480
+  version_requirements: *70223949736780
 description: Ruby implementation of the PayPal Permissions API.
 email: isaac@isaachall.com
 executables: []
@@ -80,10 +91,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/paypal-permissions/fault_message.rb
-- lib/paypal-permissions/paypal.rb
-- lib/paypal-permissions/version.rb
-- lib/paypal-permissions.rb
+- VERSION
+- lib/paypal/permissions.rb
+- lib/paypal/permissions/fault_message.rb
+- lib/paypal/permissions/oauth.rb
+- lib/paypal/permissions/paypal.rb
+- lib/paypal/permissions/version.rb
+- paypal-permissions.gemspec
+- spec/oauth_spec.rb
 - spec/paypal_spec.rb
 - spec/spec_helper.rb
 - spec/vcr/cancel_permission.yml
@@ -105,6 +120,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -952150860121832261
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -118,4 +136,3 @@ signing_key:
 specification_version: 3
 summary: Ruby implementation of the PayPal Permissions API.
 test_files: []
-has_rdoc: 

data/lib/paypal-permissions.rb

@@ -1,9 +0,0 @@
-require 'paypal-permissions/version'
-require 'paypal-permissions/fault_message'
-require 'paypal-permissions/oauth'
-require 'paypal-permissions/paypal'
-
-# configuration
-module PaypalPermissions
-  
-end

data/lib/paypal-permissions/version.rb

@@ -1,3 +0,0 @@
-module PaypalPermissions #:nodoc
-  VERSION = "0.1.1"
-end