paypal-sdk-rest 0.5.1 → 0.5.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTcyNjBlOTc0YjNiMjNjYWQ0Y2FiNDVjMTcxNGE5MzM2YzM0NDZlNg==
+    OWQ5ZjMxODJmNmY0OTc0MDhlOTU3ZDljYTJlZDQ3NWY5NTMxM2RmMg==
   data.tar.gz: !binary |-
-    MzVlNTRlMmQzMDgzNTU0YmE2YTZjNWM0YmQ3YTBjMjZiZjY5ZWNmMQ==
+    NDdjODVlMjZjYjg4YjY4ZTFkMjJjMzRjNGIxMjU2YWFlMmRhZDJhMQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MWE4MDk0MDY3ODE4Y2U4MTc1ZWJiODQwOWViZTlmNDcwZWVhOGY0OWZmNGJm
-    OGM2ZDQ0M2E2NjVjZTk2ZTIwZDk3ZTZmZTQ4MzY4N2RmZTc0M2YzZDQ3M2M1
-    ZGU1ZjQ4YWZhNTQ2NWI5ZjMwOGNkZDNmNDBkMzEyNGJmMTRhN2Y=
+    MmZkMWJkNDViYTcyYzEzOTIzZDczODJlYjAwMzNkYjU2ZDMxZjUyNjYxOGYz
+    YWQ1NTAyNzM5MjQ5ZTc0MzI2ZmMzYzZkODdiMmZiMjFhNjlmMzhkZTExMTg5
+    NmY5MzE1ZDAwZTViNTk5NjRmZjU3ZTgwOGQwZjMxNzAyNDM4ZTc=
   data.tar.gz: !binary |-
-    ZGZkYzdhOWUwNDI0ZWUyOGNlODY5OTI5ZDZkMzI1NGQzMWQ5MjM1NjA2OTE4
-    ZmVhYjE0MzVjYjQxMmFhZjdmOGY4YzBkYjU5Njg3YTkzZGEwMjIzNDhiZmI4
-    ODE1OWY3YWM1MmI5Zjk5NzBlOGU2MWE0MDg2YTM2NjQ4ZDYzOGM=
+    NmE4ZDNmMWUxOWJkZWViZTI1YTY0MTM3NDA1ZGFkNjUyMjNlMTI4ZDM1ZjM0
+    NTUwYzAyMzM2NDM0NjQ5OTA5YjA1YTJlYzM1NDJmMjg1YmUzOThkYmVlYmQ1
+    Y2U2MGQxYTVlMDUxMThiYTMxYzM3YWIxYzkyYjE3NDk2N2Y3MjM=

data/README.md

@@ -6,65 +6,68 @@ The PayPal REST SDK provides Ruby APIs to create, process and manage payment.
 
 Add this line to your application's Gemfile:
 
-    gem 'paypal-sdk-rest'
-
-    # gem 'paypal-sdk-core', :git => "https://github.com/paypal/sdk-core-ruby.git"
-    # gem 'paypal-sdk-rest', :git => "https://github.com/paypal/rest-api-sdk-ruby.git"
+```ruby
+gem 'paypal-sdk-rest'
+```
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install paypal-sdk-rest
+```sh
+$ gem install paypal-sdk-rest
+```
 
 ## 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
-      client_id: EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM
-      client_secret: EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM
-      mode: sandbox
-      # # with Proxy
-      # http_proxy: http://proxy-ipaddress:3129/
-      # # with CA File
-      # ssl_options:
-      #   ca_file: config/cacert.pem
-      # # Override Endpoint
-      # rest_endpoint: https://api.sandbox.paypal.com
-    test:
-      <<: *default
-    production:
-      <<: *default
-      mode: live
+```yaml
+development: &default
+  mode: sandbox
+  client_id: EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM
+  client_secret: EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM
+  # # with Proxy
+  # http_proxy: http://proxy-ipaddress:3129/
+  # # with CA File
+  # ssl_options:
+  #   ca_file: config/cacert.pem
+  # # Override Endpoint
+  # rest_endpoint: https://api.sandbox.paypal.com
+test:
+  <<: *default
+production:
+  mode: live
+  client_id: CLIENT_ID
+  client_secret: CLIENT_SECRET
+```
 
 
 Load Configurations from specified file:
 
-    PayPal::SDK::Core::Config.load('spec/config/paypal.yml',  ENV['RACK_ENV'] || 'development')
+```ruby
+PayPal::SDK::Core::Config.load('spec/config/paypal.yml',  ENV['RACK_ENV'] || 'development')
+```
 
 Without configuration file:
 
-    PayPal::SDK::REST.set_config(
-      :client_id => "EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM",
-      :client_secret => "EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM",
-      :mode => "sandbox", # "sandbox" or "live"
-      :ssl_options => { } )
-
-Override configuration:
-
-    # Class level
-    Payment.set_config( :client_id => "123" )
-
-    # Object level
-    payment.set_config( :client_id => "123" )
-
+```ruby
+PayPal::SDK.configure(
+  :mode => "sandbox", # "sandbox" or "live"
+  :client_id => "EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM",
+  :client_secret => "EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM",
+  :ssl_options => { } )
+```
 
 ## Create Payment
 
@@ -73,9 +76,9 @@ require 'paypal-sdk-rest'
 include PayPal::SDK::REST
 
 PayPal::SDK::REST.set_config(
+  :mode => "sandbox", # "sandbox" or "live"
   :client_id => "EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM",
-  :client_secret => "EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM",
-  :mode => "sandbox" )
+  :client_secret => "EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM")
 
 # Build Payment object
 @payment = Payment.new({
@@ -98,12 +101,19 @@ PayPal::SDK::REST.set_config(
           :postal_code => "43210",
           :country_code => "US" }}}]},
   :transactions => [{
+    :item_list => {
+      :items => [{
+        :name => "item",
+        :sku => "item",
+        :price => "1",
+        :currency => "USD",
+        :quantity => 1 }]},
     :amount => {
       :total => "1.00",
       :currency => "USD" },
     :description => "This is the payment transaction description." }]})
 
-# Make API call & get response
+# Create Payment and return the status(true or false)
 if @payment.create
   @payment.id     # Payment Id
 else
@@ -111,20 +121,21 @@ else
 end
 ```
 
-## Get Payment
+## Get Payment details
 
 ```ruby
 # Fetch Payment
 payment = Payment.find("PAY-57363176S1057143SKE2HO3A")
 
-# Get List of REST
+# Get List of Payments
 payment_history = Payment.all( :count => 10 )
-
 payment_history.payments
 ```
 
 ## Execute Payment
 
+Only for [Payment](https://github.com/paypal/rest-api-sdk-ruby/blob/master/samples/payment/create_with_paypal.rb) with `payment_method` as `"paypal"`
+
 ```ruby
 payment = Payment.find("PAY-57363176S1057143SKE2HO3A")
 
@@ -133,4 +144,36 @@ if payment.execute( :payer_id => "DUFRQ8GWYMJXC" )
 else
   payment.error # Error Hash
 end
+
+## OpenID Connect
+
+```ruby
+# Update client_id, client_secret and redirect_uri
+PayPal::SDK.configure({
+  :openid_client_id     => "client_id",
+  :openid_client_secret => "client_secret",
+  :openid_redirect_uri  => "http://google.com"
+})
+include PayPal::SDK::OpenIDConnect
+
+# Generate authorize URL to Get Authorize code
+puts Tokeninfo.authorize_url( :scope => "openid profile" )
+
+# Create tokeninfo by using Authorize Code from redirect_uri
+tokeninfo = Tokeninfo.create("Replace with Authorize Code received on redirect_uri")
+
+# Refresh tokeninfo object
+tokeninfo.refresh
+
+# Create tokeninfo by using refresh token
+tokeninfo = Tokeninfo.refresh("Replace with refresh_token")
+
+# Get Userinfo
+userinfo = tokeninfo.userinfo
+
+# Get Userinfo by using access token
+userinfo = Userinfo.get("Replace with access_token")
+
+# Get logout url
+put tokeninfo.logout_url
 ```

data/Rakefile

@@ -2,7 +2,7 @@ require "bundler/gem_tasks"
 
 desc "Run tests"
 task :rspec do
-  cmd = "bundle exec rspec"
+  cmd = "bundle exec rspec -f d"
   system(cmd) || raise("#{cmd} failed")
 end
 

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

@@ -12,7 +12,7 @@ module PayPal
 
         class << self
           def user_agent
-            @user_agent ||= "PayPalSDK/rest-sdk-ruby #{VERSION} (paypal-sdk-core #{PayPal::SDK::Core::VERSION}; ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}-#{RUBY_PLATFORM})"
+            @user_agent ||= "PayPalSDK/rest-sdk-ruby #{VERSION} (#{sdk_library_details})"
           end
         end
 

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

@@ -1,7 +1,7 @@
 module PayPal
   module SDK
     module REST
-      VERSION = "0.5.1"
+      VERSION = "0.5.2"
     end
   end
 end

data/spec/payments_examples_spec.rb

@@ -25,6 +25,10 @@ describe "Payments" do
           "description" =>  "This is the payment transaction description." } ] }
 
 
+  it "Validate user-agent" do
+    PayPal::SDK::REST::API.user_agent.should match "PayPalSDK/rest-sdk-ruby"
+  end
+
   describe "Examples" do
     describe "REST" do
       it "Modifiy global configuration" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypal-sdk-rest
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - PayPal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2013-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paypal-sdk-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,6 @@ files:
 - spec/config/paypal.yml
 - spec/config/cert_key.pem
 - lib/paypal-sdk-rest.rb
-- lib/paypal.rb
 - lib/paypal-sdk/rest.rb
 - lib/paypal-sdk/rest/error_hash.rb
 - lib/paypal-sdk/rest/get_api.rb
@@ -87,7 +86,7 @@ rubyforge_project:
 rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
-summary: PayPal Adaptive REST SDK
+summary: The PayPal REST SDK provides Ruby APIs to create, process and manage payment.
 test_files:
 - spec/log/http.log
 - spec/payments_examples_spec.rb

data/lib/paypal.rb

@@ -1,5 +0,0 @@
-require 'paypal-sdk-rest'
-
-module PayPal
-  include SDK::REST
-end