paypal-sdk-permissions 1.96.2 → 1.96.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDBlOGRlNmEyZmJkNTU3MTRkMDVhZWZlOGQ4Mjg3MjMyZjFhOWRhOQ==
+  data.tar.gz: !binary |-
+    NzdkMjMzMGZhOTY0NGFiNjk0MjI2ZjQ5MmUwYzVkNGM2ODNlN2Y2Nw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjQwZjBlOTE4NWI4YWU2Y2NiNDQ1NTJiMmI0ZTlkYmM3NWZjMTA4ZDk4Zjk5
+    YTc5YzYxNDYzOTg0YzY2MzI4YWNlMDYyNTRlZTE3NjA1ODRiNmE5ZDE4MDE1
+    MDk0YzMzNjU1YjA5NTI2ZDJiNzg5N2UyMTg1ZDViMzgxOTY1ZTg=
+  data.tar.gz: !binary |-
+    MGMxYWY3Y2I5Zjc0ODQ1NzgzNzgyODVjNmI5MjFkNDcyYzM0NjZlZmE3ODRk
+    MWNhN2I0MWRjMGIyZmRjOWE1NTFmYTA3ZWNiYWVhMWI3NTQ0Mzk2MDIxODcz
+    M2FlMzIyZDk3MDM3NmE4NmQ3MWZjZTNiZjU5Mzg2NTk3NTY2YjI=

data/Gemfile

@@ -8,7 +8,7 @@ if File.exist? File.expand_path('../samples/permissions_samples.gemspec', __FILE
   gem 'permissions_samples', :path => 'samples', :require => false
   group :test do
     gem 'rspec-rails', :require => false
-    gem 'capybara', :require => false
+    gem 'capybara', '~> 2.0.3', :require => false
   end
 end
 

data/README.md

@@ -6,110 +6,61 @@ The PayPal Permission SDK provides Ruby APIs for developers to request and obtai
 
 Add this line to your application's Gemfile:
 
-    gem 'paypal-sdk-permissions'
+```ruby
+gem 'paypal-sdk-permissions'
+```
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install paypal-sdk-permissions
+```sh
+$ gem install paypal-sdk-permissions
+```
 
 ## Configuration
 
 For Rails application:
 
-    rails g paypal:sdk:install
+```sh
+rails g paypal:sdk:install
+```
 
 For other ruby application, create a configuration file(`config/paypal.yml`):
 
-    development: &default
-      username: jb-us-seller_api1.paypal.com
-      password: WX4WTU3S8MY44S7F
-      signature: AFcWxV21C7fd0v3bYYYRCpSSRl31A7yDhhsPUU2XhtMoZXsWHFxu-RWy
-      app_id: APP-80W284485P519543T
-      http_timeout: 30
-      mode: sandbox
-      # # with certificate
-      # cert_path: "config/cert_key.pem"
-      # # with token authentication
-      # token: ESTy2hio5WJQo1iixkH29I53RJxaS0Gvno1A6.YQXZgktxbY4I2Tdg
-      # token_secret: ZKPhUYuwJwYsfWdzorozWO2U9pI
-      # # with Proxy
-      # http_proxy: http://proxy-ipaddress:3129/
-      # # with device ip address
-      # device_ipaddress: "127.0.0.1"
-    test:
-      <<: *default
-    production:
-      <<: *default
-      mode: live
+```yaml
+development: &default
+  username: jb-us-seller_api1.paypal.com
+  password: WX4WTU3S8MY44S7F
+  signature: AFcWxV21C7fd0v3bYYYRCpSSRl31A7yDhhsPUU2XhtMoZXsWHFxu-RWy
+  app_id: APP-80W284485P519543T
+  http_timeout: 30
+  mode: sandbox
+  # # with certificate
+  # cert_path: "config/cert_key.pem"
+  # # with token authentication
+  # token: ESTy2hio5WJQo1iixkH29I53RJxaS0Gvno1A6.YQXZgktxbY4I2Tdg
+  # token_secret: ZKPhUYuwJwYsfWdzorozWO2U9pI
+  # # with Proxy
+  # http_proxy: http://proxy-ipaddress:3129/
+  # # with device ip address
+  # device_ipaddress: "127.0.0.1"
+test:
+  <<: *default
+production:
+  <<: *default
+  mode: live
+```
 
 Load Configurations from specified file:
 
-    PayPal::SDK::Core::Config.load('config/paypal.yml',  ENV['RACK_ENV'] || 'development')
-
-## Create API object
-
-Create API object:
-
-    api = PayPal::SDK::Permissions::API.new
-
-Override configuration while creating a object:
-
-    api = PayPal::SDK::Permissions::API.new(:development)
-    api = PayPal::SDK::Permissions::API.new(:development, :app_id => "XYZ")
-    api = PayPal::SDK::Permissions::API.new(:app_id => "XYZ")    # Take default environment.
-
-Change configuration:
-
-    api.set_config :testing
-    api.set_config :testing, app_id => "XYZ"
-
-
-## Build Request Object
-
-To make api request, we need to build a request object.
-
-    # To build a empty request object for get verified status
-    request_permissions = api.build_request_permissions()
-
-    # To build a request object with default data
-    request_permissions = api.build_request_permissions( :callback => "http://localhost:3000/permissions/get_access_token" )
-
-The Build method can be access with camelcase or underscore:
-
-    api = api.build_request_permissions()
-    # (or)
-    api = api.BuildRequestPermissions()
-
-## Assign value to members
-
-Members can be access with camelcase or underscore format.
-
-    request_permissions.scope = ["TRANSACTION_SEARCH","ACCOUNT_BALANCE","BILLING_AGREEMENT"]
-
-To Get members list for the given object( For Reference ):
-
-    request_permission.members
-
-## Make API Request
-
-Make api call with request object:
-
-    request_permissions_response = api.request_permissions(request_permissions)
-
-Make api call with hash:
-
-    request_permissions_response = api.request_permissions( :scope => ["TRANSACTION_SEARCH"], :callback => "http://localhost:3000/permissions/get_access_token" )
-
-
-## Access values from response object
-
-To get response status:
-
-    request_permissions_response.responseEnvelope.ack
+```ruby
+PayPal::SDK::Core::Config.load('config/paypal.yml',  ENV['RACK_ENV'] || 'development')
+```
 
 ## Example
 
@@ -131,23 +82,35 @@ require 'paypal-sdk-permissions'
 @request_permissions_response = @api.request_permissions(@request_permissions)
 
 # Access Response
-@request_permissions_response.responseEnvelope
-@request_permissions_response.token
+if @request_permissions_response.success?
+  @request_permissions_response.token
+  @api.grant_permission_url(@request_permissions_response) # Redirect url to grant permissions
+else
+  @request_permissions_response.error
+end
 ```
 
-## Samples
+For more samples [https://paypal-sdk-samples.herokuapp.com/permissions/](https://paypal-sdk-samples.herokuapp.com/permissions/)
+
+## Samples App
 
 Add following line in rails `Gemfile`:
 
-    gem 'paypal-sdk-permissions'
-    gem 'permissions_samples', :git => "https://github.com/paypal/permissions-sdk-ruby.git", :group => :development
+```ruby
+gem 'paypal-sdk-permissions'
+gem 'permissions_samples', :git => "https://github.com/paypal/permissions-sdk-ruby.git", :group => :development
+```
 
 Configure routes(`config/routes.rb`):
 
-    mount PermissionsSamples::Engine => "/samples" if Rails.env.development?
+```ruby
+mount PermissionsSamples::Engine => "/samples" if Rails.env.development?
+```
 
 To get default paypal configuration execute:
 
-    rails g paypal:sdk:install
+```sh
+rails g paypal:sdk:install
+```
 
 Run `rails server` and check the samples.

data/lib/paypal-sdk/permissions.rb

@@ -6,6 +6,7 @@ module PayPal
       autoload :VERSION,   "paypal-sdk/permissions/version"
       autoload :Services,  "paypal-sdk/permissions/services"
       autoload :DataTypes, "paypal-sdk/permissions/data_types"
+      autoload :Urls,      "paypal-sdk/permissions/urls"
       autoload :API,       "paypal-sdk/permissions/api"
 
       def self.new(*args)

data/lib/paypal-sdk/permissions/api.rb

@@ -5,6 +5,7 @@ module PayPal
     module Permissions
       class API < Core::API::Platform
         include Services
+        include Urls
 
         def initialize(environment = nil, options = {})
           super(SERVICE_NAME, environment, options)

data/lib/paypal-sdk/permissions/data_types.rb

@@ -14,6 +14,22 @@ module PayPal::SDK
         end
       end
 
+      module ResponseStatus
+        Status = { :success => ["Success", "SuccessWithWarning"],
+                   :warning => ["Warning", "SuccessWithWarning", "FailureWithWarning"],
+                   :failure => ["Failure", "FailureWithWarning"] }
+
+        def response_status
+          self.responseEnvelope && self.responseEnvelope.ack
+        end
+
+        Status.keys.each do |status|
+          define_method("#{status}?") do
+            Status[status].include?(self.response_status)
+          end
+        end
+      end
+
       class EnumType < Core::API::DataTypes::Enum
       end
 
@@ -66,6 +82,7 @@ module PayPal::SDK
 
       class FaultMessage < DataType
         def self.load_members
+          include ResponseStatus
           object_of :responseEnvelope, ResponseEnvelope, :required => true
           array_of :error, ErrorData
         end
@@ -115,6 +132,7 @@ module PayPal::SDK
       # Returns the temporary request token 
       class RequestPermissionsResponse < DataType
         def self.load_members
+          include ResponseStatus
           object_of :responseEnvelope, ResponseEnvelope, :required => true
           # Temporary token that identifies the request for permissions. This token cannot be used to access resources on the account. It can only be used to instruct the user to authorize the permissions. 
           object_of :token, String
@@ -142,6 +160,7 @@ module PayPal::SDK
       # Permanent access token and token secret that can be used to make requests for protected resources owned by another account. 
       class GetAccessTokenResponse < DataType
         def self.load_members
+          include ResponseStatus
           object_of :responseEnvelope, ResponseEnvelope, :required => true
           # Identifier for the permissions approved for this relationship. 
           array_of :scope, String
@@ -169,6 +188,7 @@ module PayPal::SDK
       # The list of permissions associated with the token. 
       class GetPermissionsResponse < DataType
         def self.load_members
+          include ResponseStatus
           object_of :responseEnvelope, ResponseEnvelope, :required => true
           # Identifier for the permissions approved for this relationship. 
           array_of :scope, String
@@ -190,6 +210,7 @@ module PayPal::SDK
 
       class CancelPermissionsResponse < DataType
         def self.load_members
+          include ResponseStatus
           object_of :responseEnvelope, ResponseEnvelope, :required => true
           array_of :error, ErrorData
         end
@@ -247,6 +268,7 @@ module PayPal::SDK
 
       class GetBasicPersonalDataResponse < DataType
         def self.load_members
+          include ResponseStatus
           object_of :responseEnvelope, ResponseEnvelope, :required => true
           object_of :response, PersonalDataList
           array_of :error, ErrorData
@@ -257,6 +279,7 @@ module PayPal::SDK
 
       class GetAdvancedPersonalDataResponse < DataType
         def self.load_members
+          include ResponseStatus
           object_of :responseEnvelope, ResponseEnvelope, :required => true
           object_of :response, PersonalDataList
           array_of :error, ErrorData

data/lib/paypal-sdk/permissions/urls.rb

@@ -0,0 +1,22 @@
+module PayPal
+  module SDK
+    module Permissions
+      module Urls
+        REDIRECT_ENDPOINTS = {
+          :live => "https://www.paypal.com/webscr",
+          :sandbox => "https://www.sandbox.paypal.com/webscr" }
+
+        def redirect_url(params = {})
+          "#{REDIRECT_ENDPOINTS[api_mode]}?#{encode_www_form(params)}"
+        end
+
+        def grant_permission_url(token)
+          token = token.token if token.respond_to?(:token)
+          redirect_url(:cmd => "_grant-permission", :request_token => token.to_s)
+        end
+        alias_method :request_permissions_url, :grant_permission_url
+
+      end
+    end
+  end
+end

data/lib/paypal-sdk/permissions/version.rb

@@ -1,7 +1,7 @@
 module PayPal
   module SDK
     module Permissions
-      VERSION = "1.96.2"
+      VERSION = "1.96.3"
     end
   end
 end

data/spec/permissions_spec.rb

@@ -15,13 +15,4 @@ describe "Permissions" do
     end
   end
 
-  describe "DataTypes" do
-    PayPal::SDK::Permissions::DataTypes.constants.each do |const_name|
-      it "create object for #{const_name}" do
-        klass = PayPal::SDK::Permissions::DataTypes.const_get(const_name)
-        klass.new.should be_a klass
-      end
-    end
-  end
-
 end

metadata

@@ -1,48 +1,39 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: paypal-sdk-permissions
-version: !ruby/object:Gem::Version 
-  hash: 403
-  prerelease: 
-  segments: 
-  - 1
-  - 96
-  - 2
-  version: 1.96.2
+version: !ruby/object:Gem::Version
+  version: 1.96.3
 platform: ruby
-authors: 
+authors:
 - PayPal
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: paypal-sdk-core
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 0
-        - 2
-        - 0
-        version: 0.2.0
+      - !ruby/object:Gem::Version
+        version: 0.2.3
   type: :runtime
-  version_requirements: *id001
-description: The PayPal Permission SDK provides Ruby APIs for developers to request and obtain permissions from merchants and consumers, to execute APIs on behalf of them. The permissions include variety of operations from processing payments to accessing account transaction history
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+description: The PayPal Permission SDK provides Ruby APIs for developers to request
+  and obtain permissions from merchants and consumers, to execute APIs on behalf of
+  them. The permissions include variety of operations from processing payments to
+  accessing account transaction history
+email:
 - DL-PP-Platform-Ruby-SDK@ebay.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - spec/permissions_spec.rb
 - spec/spec_helper.rb
 - spec/config/paypal.yml
@@ -50,46 +41,37 @@ files:
 - lib/paypal-sdk-permissions.rb
 - lib/paypal-sdk/permissions.rb
 - lib/paypal-sdk/permissions/services.rb
+- lib/paypal-sdk/permissions/urls.rb
 - lib/paypal-sdk/permissions/api.rb
 - lib/paypal-sdk/permissions/version.rb
 - lib/paypal-sdk/permissions/data_types.rb
 - Rakefile
 - README.md
 - Gemfile
-homepage: https://www.x.com/
+homepage: https://developer.paypal.com
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: PayPal Permissions SDK
-test_files: 
+test_files:
 - spec/permissions_spec.rb
 - spec/spec_helper.rb
 - spec/config/paypal.yml