creative-paypal-express 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2623304761cdf500c82acefe85e8e626bbd306bb
-  data.tar.gz: ba7be3ba0b865c979e3ad4de9272c670b7a6f1b4
+  metadata.gz: e3a1313ca1047f68a9801c63c2c0eae9aaf4bc9d
+  data.tar.gz: 4d9aeedc4d2692e2301079d42c7b3a8db94834ea
 SHA512:
-  metadata.gz: b964a4a4906cb4ccfbd0a794e8a07e5995d2634709eda97692ba073fdbc3ef1f6b94bf4ade0a7d5f300b85d469d26397de4c5aebb4e9c7720f15cb8905f9471d
-  data.tar.gz: f0ce0d81a873f140d567ad79743cdeb7d0d115f97d14028ca75212e9b8dd6b5301013b2ab96bdd3e0a930a6482f3e87331ca4bdc1479c1209bc929f7794c966b
+  metadata.gz: e942250f8683e6f2d07e8d1c140679fce166365c64082df09e120717b81608a1db38f0d0745ac75768d2276b46141a87a80b90bd7297aefef7a120737b335e0c
+  data.tar.gz: b3ebea5d48de225090e9ad354836b91f0bc65f12f55cd90f7ce0659e63f394becc6609af79cf8445f52016ef384b6087d0359a0c80bc96a9f2e366117a8b7106

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+## v1.2.0
+__Added:__
+- Ability to amend a created paypal subscription (its amount)
+
+```rb
+Paypal::Express::Request.new(params).amend!("profile_id", {amount: 19.95, note: "will show up in email and profile logs"})
+```
+
+## v1.1.0 news (not in wiki)
+### Paypal::Payment::Recurring
+The helper object can be instantiated by using the :raw key.  
+
+```rb
+params = {
+  # optional initial payment parameters
+  :INITAMT => "9.00",
+  :FAILEDINITAMTACTION => "CancelOnFailure", # or "ContinueOnFailure"
+
+  # optional trial parameters
+  :TRIALBILLINGPERIOD => "Day",
+  :TRIALBILLINGFREQUENCY => "7",
+  :TRIALAMT => "0.00",
+  :TRIALCURRENCYCODE => "EUR",
+  :TRIALTOTALBILLINGCYCLES => "1",
+
+  # mandatory regular recurring profile parameters
+  :DESC => "Funny Movie Clips Subscription",
+  :PROFILESTARTDATE => "2017-01-25T15:00:00Z",
+  :BILLINGPERIOD => "Day", # "Month", "Year"
+  :BILLINGFREQUENCY => "30",
+  :AMT => "9.00", # two-decimals for cents, whole number for whole currency, like a Euro or Dollar
+  :CURRENCYCODE => "EUR",
+
+  # termination
+  :TOTALBILLINGCYCLES => "0", # optional field, '0' value makes profile last forever
+  :MAXFAILEDPAYMENTS => "3",
+  :AUTOBILLAMT => "AddToNextBilling",
+
+  # Digital goods fields
+  :L_PAYMENTREQUEST_0_ITEMCATEGORY0 => "Digital",
+  :L_PAYMENTREQUEST_0_NAME0 => "Cat Clip Collection",
+  :L_PAYMENTREQUEST_0_AMT0 => "9.00",
+  :L_PAYMENTREQUEST_0_QTY0 => "1",
+}
+
+recurring_profile = Paypal::Payment::Recurring.new(raw: params)
+```

data/README.md

@@ -7,11 +7,9 @@ Express Checkout for Digital Goods is also supported.
 ## Installation
 
 ```rb
-gem "creative-paypal-express", "~> 1.0.0"
+gem "creative-paypal-express", "~> 1.2.0"
 ```
 
-  gem install paypal-express
-
 ## Usage
 
 See Wiki on Github
@@ -21,46 +19,6 @@ Play with Sample Rails App
 https://github.com/nov/paypal-express-sample
 https://paypal-express-sample.heroku.com
 
-## v1.1.0 news (not in wiki)
-### Paypal::Payment::Recurring
-The helper object can be instantiated by using the :raw key.  
-
-```rb
-params = {
-  # optional initial payment parameters
-  :INITAMT => "9.00",
-  :FAILEDINITAMTACTION => "CancelOnFailure", # or "ContinueOnFailure"
-
-  # optional trial parameters
-  :TRIALBILLINGPERIOD => "Day",
-  :TRIALBILLINGFREQUENCY => "7",
-  :TRIALAMT => "0.00",
-  :TRIALCURRENCYCODE => "EUR",
-  :TRIALTOTALBILLINGCYCLES => "1",
-
-  # mandatory regular recurring profile parameters
-  :DESC => "Funny Movie Clips Subscription",
-  :PROFILESTARTDATE => "2017-01-25T15:00:00Z",
-  :BILLINGPERIOD => "Day", # "Month", "Year"
-  :BILLINGFREQUENCY => "30",
-  :AMT => "9.00", # two-decimals for cents, whole number for whole currency, like a Euro or Dollar
-  :CURRENCYCODE => "EUR",
-
-  # termination
-  :TOTALBILLINGCYCLES => "0", # optional field, '0' value makes profile last forever
-  :MAXFAILEDPAYMENTS => "3",
-  :AUTOBILLAMT => "AddToNextBilling",
-
-  # Digital goods fields
-  :L_PAYMENTREQUEST_0_ITEMCATEGORY0 => "Digital",
-  :L_PAYMENTREQUEST_0_NAME0 => "Cat Clip Collection",
-  :L_PAYMENTREQUEST_0_AMT0 => "9.00",
-  :L_PAYMENTREQUEST_0_QTY0 => "1",
-}
-
-recurring_profile = Paypal::Payment::Recurring.new(raw: params)
-```
-
 ## Note on Patches/Pull Requests
 
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/paypal/express/request.rb

@@ -127,6 +127,19 @@ module Paypal
         renew!(profile_id, :Reactivate, options)
       end
 
+      # Expects optional :note option and mandatory :amount option
+      def amend!(profile_id, options={})
+        # Developed according to https://developer.paypal.com/docs/classic/express-checkout/integration-guide/ECRecurringPayments/#modifying-a-recurring-payments-profile
+        # and https://developer.paypal.com/docs/classic/api/merchant/UpdateRecurringPaymentsProfile_API_Operation_NVP/
+        params = {
+          :PROFILEID => profile_id,
+          :NOTE => options[:note],
+          :AMT => options[:amount].presence || (raise ArgumentError.new(":amount option missing!")), # Paypal accepts 19.95 type decimals
+        }
+
+        response = request(:UpdateRecurringPaymentsProfile, params)
+        return Response.new(response)
+      end
 
       # Reference Transaction Specific
 

data/spec/fake_response/UpdateRecurringPaymentsProfile/success.txt

@@ -0,0 +1 @@
+PROFILEID=I%2dK1VFLRN3VVG0&TIMESTAMP=2017%2d02%2d20T07%3a20%3a44Z&CORRELATIONID=86bde487ccba6&ACK=Success&VERSION=66%2e0&BUILD=1704252

data/spec/paypal/express/request_spec.rb

@@ -1,5 +1,4 @@
-require 'spec_helper.rb'
-
+# rspec spec/paypal/express/request_spec.rb
 describe Paypal::Express::Request do
   class Paypal::Express::Request
     attr_accessor :_sent_params_, :_method_
@@ -489,6 +488,27 @@ describe Paypal::Express::Request do
     end
   end
 
+  describe "#amend!(profile_id, options={})" do
+    it "should raise ArgumentError if :amount not passed" do
+      expect{instance.amend!('profile_id')}.to raise_error(ArgumentError, ":amount option missing!")
+    end
+
+    it "should call UpdateRecurringPaymentsProfile" do
+      expect{instance.amend!('profile_id', {note: "test changes", amount: 19.95})}.
+        to request_to(nvp_endpoint, :post)
+
+      expect(instance._method_).to eq :UpdateRecurringPaymentsProfile
+      expect(instance._sent_params_).to eq({:PROFILEID => 'profile_id', :NOTE => "test changes", :AMT => 19.95})
+    end
+
+    it 'should return Paypal::Express::Response' do
+      fake_response 'UpdateRecurringPaymentsProfile/success'
+      response = instance.amend!('profile_id', {note: "test changes", amount: 19.95})
+
+      expect(response.class).to eq Paypal::Express::Response
+    end
+  end
+
   describe '#agree!' do
     it 'should return Paypal::Express::Response' do
       fake_response 'CreateBillingAgreement/success'

data/spec/spec_helper.rb

@@ -50,6 +50,7 @@ def expected_recurring_profile_parameters(options={})
     # :TOTALBILLINGCYCLES => "0", # optional field, '0' value makes profile last forever
     # :MAXFAILEDPAYMENTS => "3",
     # :AUTOBILLAMT => "AddToNextBilling",
+    # :AUTOBILLOUTAMT => "AddToNextBilling",
     #
     # # Digital goods fields
     # :L_PAYMENTREQUEST_0_ITEMCATEGORY0 => "Digital",
@@ -94,10 +95,7 @@ def auxilary_profile_parameters(options={})
     :TOTALBILLINGCYCLES => "0", # optional field, '0' value makes profile last forever
     :MAXFAILEDPAYMENTS => "3",
     :AUTOBILLAMT => "AddToNextBilling",
+    :AUTOBILLOUTAMT => "AddToNextBilling",
 
-    :L_PAYMENTREQUEST_0_ITEMCATEGORY0 => "Digital",
-    :L_PAYMENTREQUEST_0_NAME0 => "Cat Clip Collection",
-    :L_PAYMENTREQUEST_0_AMT0 => "9.00",
-    :L_PAYMENTREQUEST_0_QTY0 => "1",
   }.merge(options)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: creative-paypal-express
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - nov matake
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-25 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,6 +136,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -196,6 +197,7 @@ files:
 - spec/fake_response/RefundTransaction/full.txt
 - spec/fake_response/SetExpressCheckout/failure.txt
 - spec/fake_response/SetExpressCheckout/success.txt
+- spec/fake_response/UpdateRecurringPaymentsProfile/success.txt
 - spec/helpers/fake_response_helper.rb
 - spec/paypal/exception/api_error_spec.rb
 - spec/paypal/exception/http_error_spec.rb
@@ -270,6 +272,7 @@ test_files:
 - spec/fake_response/RefundTransaction/full.txt
 - spec/fake_response/SetExpressCheckout/failure.txt
 - spec/fake_response/SetExpressCheckout/success.txt
+- spec/fake_response/UpdateRecurringPaymentsProfile/success.txt
 - spec/helpers/fake_response_helper.rb
 - spec/paypal/exception/api_error_spec.rb
 - spec/paypal/exception/http_error_spec.rb