paypal-sdk-merchant 1.98.1 → 1.98.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTliNTI4N2JkM2U2NDNlMjcyYmY4NDYzZDYxNWU3OGMxMGEyZGQ5Yg==
+    ZGU2MGE1N2M1OGQ2OTNjY2YzZjljNDRmNjVjMGI3NzViNWY0NTFmOQ==
   data.tar.gz: !binary |-
-    MmMwZWE2MTQxNzk1OGQ0YmNhY2Y4YTJjMjg5NGRlZjZmNjc0NjI5Zg==
+    YmZjODIyN2FjNmJmZWJiOGZkYjQ1MWMyNTIwOWI0ZWNlZGE3Njc1Mw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MzBmYTc2ZTQ4NjgxNzI2NDAxOWJiY2Y2Mjk4MWMzZTVkMjU5ZjRkZmZiZjI1
-    YzA4ZmIxNDZjMzRiYWFiMDcyZThiMmIyMmQwZjZkN2M3ZDFiNGUzOGU5OWY1
-    M2Q5MWI1ZjAwOTkyODAyZDRkOTU5OGU0YWRjNzA0ZjZhNGIxZDA=
+    ZGY5NzlmYzE0NGUwYTM3YzBlZGNkMzU0NjlmNWUzMmFjYzhlZDk5OTI2YWQ3
+    MTU0M2Q3NGJiMTEwZGU1MThiYjgwYThkNjExNTQyZTc5MWM1YTRhNDRmZDRl
+    NjVhODQ0YTk2YTc1NWNhN2ZkZjQ1OGZhNTAxZmMyNmFlYmM5MTU=
   data.tar.gz: !binary |-
-    MzQyZDAxNGIwMzBkYWEyZDU4ZWY2MTU3OTM0NTA3NmMwYTI5YWYyOTIwNjFi
-    MGE1ZjM3YWUxNDdlNmVmMTRlYjhjNjFmZGY2OWY5YTM5YjM3MmJkNzI3ZDVi
-    ZDkwMjcwMTg5NGM4MjY0MzkzZjU2OTZiMjAyNDk2NjQ5ZWE1MmU=
+    MDUzMTQzYzcwNWE0ZDU4Yjk0OWY0YTg2ZDY3YzQ4M2FmYzQ3MDUxYWY1ZjQ4
+    YTcyY2FkOTgwOTQ1OTMzZGNlNmU0YmRkNmY4YzM4ODk3NWIxYzFlMTY2YzY2
+    MTg2OWQ1MjcxNzQ5MTY4OTUwNzNmMzM4ODU3ZGNjZWMwYjUxOTQ=

data/Gemfile

@@ -8,7 +8,7 @@ if File.exist? File.expand_path('../samples/merchant_samples.gemspec', __FILE__)
   gem 'merchant_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,59 @@ The PayPal Merchant SDK provides Ruby APIs for processing payments, recurring pa
 
 Add this line to your application's Gemfile:
 
-    gem 'paypal-sdk-merchant'
+```ruby
+gem 'paypal-sdk-merchant'
+```
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install paypal-sdk-merchant
+```sh
+$ gem install paypal-sdk-merchant
+```
 
 ## 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/
-    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/
+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::Merchant::API.new
-
-Override configuration while creating a object:
-
-    api = PayPal::SDK::Merchant::API.new(:development)
-    api = PayPal::SDK::Merchant::API.new(:development, :app_id => "XYZ")
-    api = PayPal::SDK::Merchant::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
-    transaction_search_request = api.build_transaction_search()
-
-    # To build a request object with default data
-    transaction_search_request = api.build_transaction_search( :StartDate => "2012-11-11T11:30:00+00:00", :EndDate => "2012-11-11T11:31:00+00:00" )
-
-The Build method can be access with camelcase or underscore:
-
-    api = api.build_transaction_search()
-    # (or)
-    api = api.BuildTransactionSearch()
-
-## Assign value to members
-
-Members can be access with camelcase or underscore format.
-
-    transaction_search_request.StartDate = "2012-11-11T11:30:00+00:00"
-    # With underscore
-    transaction_search_request.start_date = "2012-11-11T11:30:00+00:00"
-
-To Get members list for the given object( For Reference ):
-
-    transaction_search_request.members
-
-## Make API Request
-
-Make api call with request object:
-
-    transaction_search_response = api.transaction_search(transaction_search_request)
-
-Make api call with hash:
-
-    transaction_search_response = api.transaction_search( :StartDate => "2012-11-11T11:30:00+00:00", :EndDate => "2012-11-11T11:31:00+00:00" )
-
-## Access values from response object
-
-To get response status:
-
-    transaction_search_response.ack
-
+```ruby
+PayPal::SDK::Core::Config.load('config/paypal.yml',  ENV['RACK_ENV'] || 'development')
+```
 
 ## Example
 
@@ -142,24 +91,36 @@ require 'paypal-sdk-merchant'
 @do_direct_payment_response = @api.do_direct_payment(@do_direct_payment)
 
 # Access Response
-@do_direct_payment_response.Ack
-@do_direct_payment_response.TransactionID
+if @do_direct_payment_response.success?
+  @do_direct_payment_response.TransactionID
+else
+  @do_direct_payment_response.Errors
+end
+
 ```
 
+For more samples [paypal-sdk-samples.herokuapp.com/merchant/](https://paypal-sdk-samples.herokuapp.com/merchant/)
+
 ## Samples
 
 Add following line in rails `Gemfile`:
 
-    gem 'paypal-sdk-merchant'
-    gem 'merchant_samples', :git => "https://github.com/paypal/merchant-sdk-ruby.git", :group => :development
+```ruby
+gem 'paypal-sdk-merchant'
+gem 'merchant_samples', :git => "https://github.com/paypal/merchant-sdk-ruby.git", :group => :development
+```
 
 Configure routes(`config/routes.rb`):
 
-    mount MerchantSamples::Engine => "/samples" if Rails.env.development?
+```ruby
+mount MerchantSamples::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/merchant.rb

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

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

@@ -5,6 +5,7 @@ module PayPal
     module Merchant
       class API < Core::API::Merchant
         include Services
+        include Urls
 
         def initialize(environment = nil, options = {})
           super("", environment, options)
@@ -14,6 +15,11 @@ module PayPal
         def default_http_header
           super.merge(MERCHANT_HTTP_HEADER)
         end
+
+        # Validate IPN message
+        def ipn_valid?(raw_post_data)
+          Core::API::IPN.valid?(raw_post_data, config)
+        end
       end
     end
   end

data/lib/paypal-sdk/merchant/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.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
 
@@ -634,6 +650,7 @@ module PayPal::SDK
         def self.load_members
           # This value represents the date and time (GMT) when the response was generated by a service provider (as a result of processing of a request). 
           object_of :Timestamp, DateTime, :namespace => :ebl
+          include ResponseStatus
           # Application level acknowledgement code. 
           object_of :Ack, AckCodeType, :namespace => :ebl
           # CorrelationID may be used optionally with an application level acknowledgement. 

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

@@ -0,0 +1,20 @@
+module PayPal
+  module SDK
+    module Merchant
+      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 express_checkout_url(token)
+          token = token.Token if token.respond_to?(:Token)
+          redirect_url( :cmd => "_express-checkout", :token => token.to_s )
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module PayPal
   module SDK
     module Merchant
-      VERSION = "1.98.1"
+      VERSION = "1.98.2"
     end
   end
 end

data/spec/merchant_samples_spec.rb

@@ -16,10 +16,20 @@ describe "Merchant" do
 
       # Make API call & get response
       @transaction_search_response = @api.transaction_search(@transaction_search)
-      @transaction_search_response.Ack.should eql "Success"
+      @transaction_search_response.should be_success
+      @transaction_search_response.should_not be_failure
+
+      @transaction_search_response = @api.transaction_search({})
+      @transaction_search_response.should be_failure
+      @transaction_search_response.should_not be_success
 
       @transaction_search_response = @api_with_cert.transaction_search(@transaction_search)
-      @transaction_search_response.Ack.should eql "Success"
+      @transaction_search_response.should be_success
+      @transaction_search_response.should_not be_failure
+
+      @transaction_search_response = @api_with_cert.transaction_search({})
+      @transaction_search_response.should be_failure
+      @transaction_search_response.should_not be_success
     end
 
     it "get balance" do
@@ -30,7 +40,7 @@ describe "Merchant" do
       # Make API call & get response
       @get_balance_response = @api.get_balance(@get_balance)
 
-      @get_balance_response.Ack.should eql "Success"
+      @get_balance_response.should be_success
     end
 
     it "get pal detail" do
@@ -40,7 +50,7 @@ describe "Merchant" do
       # Make API call & get response
       @get_pal_details_response = @api.get_pal_details(@get_pal_details)
 
-      @get_pal_details_response.Ack.should eql "Success"
+      @get_pal_details_response.should be_success
     end
 
     it "Set auth flow param" do
@@ -53,7 +63,7 @@ describe "Merchant" do
       # Make API call & get response
       @set_auth_flow_param_response = @api.set_auth_flow_param(@set_auth_flow_param)
 
-      @set_auth_flow_param_response.Ack.should eql "Success"
+      @set_auth_flow_param_response.should be_success
     end
 
 
@@ -83,11 +93,11 @@ describe "Merchant" do
 
       # Make API call & get response
       @do_direct_payment_response = @api.do_direct_payment(@do_direct_payment)
-      @do_direct_payment_response.Ack.should eql "Success"
+      @do_direct_payment_response.should be_success
 
       # Make API call & get response
       @do_direct_payment_response = @api_with_cert.do_direct_payment(@do_direct_payment)
-      @do_direct_payment_response.Ack.should eql "Success"
+      @do_direct_payment_response.should be_success
     end
 
     it "Mass pay" do
@@ -102,7 +112,12 @@ describe "Merchant" do
 
       # Make API call & get response
       @mass_pay_response = @api.mass_pay(@mass_pay)
-      @mass_pay_response.Ack.should eql "Success"
+      @mass_pay_response.should be_success
     end
+
+    it "Validate ipn message" do
+      @api.ipn_valid?("Invalid").should be_false
+    end
+
   end
 end

data/spec/merchant_spec.rb

@@ -7,9 +7,9 @@ describe "Merchant" do
   end
 
   describe "Services" do
-    Actions  = PayPal::SDK::Merchant::Services.instance_methods.select{|s| s =~ /^[A-Z]/ and s !~ /^Build/ } -
-      [ :CompleteRecoup, "CompleteRecoup", :GetIncentiveEvaluation, "GetIncentiveEvaluation" ]
-    Actions.each do |service_method|
+    actions = PayPal::SDK::Merchant::Services.instance_methods.select{|s| s =~ /^[A-Z]/ and s !~ /^Build/ } -
+      [ :GetIncentiveEvaluation, "GetIncentiveEvaluation" ]
+    actions.each do |service_method|
       it "make empty request to #{service_method}" do
         response = @client.send(service_method, {})
         response.ack.should_not be_nil
@@ -17,13 +17,4 @@ describe "Merchant" do
     end
   end
 
-  describe "DataTypes" do
-    PayPal::SDK::Merchant::DataTypes.constants.each do |const_name|
-      it "create object for #{const_name}" do
-        klass = PayPal::SDK::Merchant::DataTypes.const_get(const_name)
-        klass.new.should be_a klass
-      end
-    end
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypal-sdk-merchant
 version: !ruby/object:Gem::Version
-  version: 1.98.1
+  version: 1.98.2
 platform: ruby
 authors:
 - PayPal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 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
 description: The PayPal Merchant SDK provides Ruby APIs for processing payments, recurring
   payments, subscriptions and transactions using PayPal's Merchant APIs, which include
   Express Checkout, Recurring Payments, Direct Payment and Transactional APIs.
@@ -40,6 +40,7 @@ files:
 - spec/merchant_spec.rb
 - lib/paypal-sdk-merchant.rb
 - lib/paypal-sdk/merchant/services.rb
+- lib/paypal-sdk/merchant/urls.rb
 - lib/paypal-sdk/merchant/data_types_with_bugfix.rb
 - lib/paypal-sdk/merchant/api.rb
 - lib/paypal-sdk/merchant/version.rb