killbill-paypal-express 4.1.4 → 4.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fb4b33361ba8a20052ea37ef62c5108a0ee7395
-  data.tar.gz: 2b398f445e49529f890d60365c7389a6c943b81a
+  metadata.gz: 8dc36b7724efd4b473e338fcceee7e3ea0d5bbaa
+  data.tar.gz: e7bbff378a81f45c74e1d289d9d573ec6d9e87f2
 SHA512:
-  metadata.gz: c1ec6393cfb317f04f0ecde7e1bcbd0df40a2274345aafea0b67a2a9aafcd045658838e1debc7e09f4cd817dd3d9944892ea03a737aafe00c2aea3e28e9d3ca9
-  data.tar.gz: 83d24ce07bf944636c4b991fe4e8bc59632907c3c82a6d58c2bc8a50fea771fe65412cfffccab77bf119359edb0dbc741fb54265c876516f613973fff374f989
+  metadata.gz: 2a9e587a52da1a8d0a752fb47934649f9be28f7a532a9a1ecc9925c90f0a85e006547ce345d058ec250c4a055c092bae3428521ef3aa38b038baf3eac2797b56
+  data.tar.gz: 641a6f9b88cbee002bd99c4b9b5872b789395ef4a86e1a464ab3d904268d3d1ba1806e461c012790ce12bf5ab50022638a78ee842d623cadc0cd2803b7c16fd0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    killbill-paypal-express (4.1.4)
+    killbill-paypal-express (4.1.5)
       actionpack (~> 4.1.0)
       actionview (~> 4.1.0)
       activemerchant (~> 1.53.0)

data/NEWS

@@ -1,3 +1,6 @@
+4.1.5
+    Add more options to the build_form_descriptor call
+
 4.1.4
     Cancel expired payments
     Always store the PayPal Payer Id

data/README.md

@@ -217,5 +217,46 @@ Plugin properties
 | zip                          | Billing address zip code                                          |
 | state                        | Billing address state                                             |
 | country                      | Billing address country                                           |
-| max_amount                   | Maximum amount parameter (optional) for SetExpressCheckout call   |
-| auth_mode                    | If true, [Authorization Payment Action](https://developer.paypal.com/docs/classic/express-checkout/integration-guide/ECRelatedAPIOps/) is adopted. Otherwise, Sale Payment Action is used.|
+
+Below is a list of optional parameters for build_form_descriptor call. More details can be found on PayPal [manual](https://developer.paypal.com/docs/classic/api/merchant/SetExpressCheckout_API_Operation_SOAP/)
+
+| Key                          | Description                                                       |
+| ---------------------------: | ----------------------------------------------------------------- |
+| max_amount                   | Maximum amount parameter                                          |
+| auth_mode                    | If true, [Authorization Payment Action](https://developer.paypal.com/docs/classic/express-checkout/integration-guide/ECRelatedAPIOps/) is adopted. Otherwise, Sale Payment Action is used.|
+| no_shipping                  | Whether or not to show shipping address on PayPal checkout page   |
+| req_billing_address           | Is 1 or 0. The value 1 indicates that you require that the buyer’s billing address on file with PayPal be returned. Setting this element will return `BILLTONAME`, `STREET`, `STREET2`, `CITY`, `STATE`, `ZIP`, and `COUNTRYCODE`. |
+| address_override             | Determines whether or not the PayPal pages should display the shipping address set by you in this SetExpressCheckout request, not the shipping address on file with PayPal for this buyer.|
+| locale                       | Locale of pages displayed by PayPal during Express Checkout. It is either a two-letter country code or five-character locale code supported by PayPal. |
+| brand_name                   | A label that overrides the business name in the PayPal account on the PayPal hosted checkout pages.|
+| page_style                   | Name of the Custom Payment Page Style for payment pages associated with this button or link. It corresponds to the HTML variable page_style for customizing payment pages. |
+| logo_image                   | A URL to your logo image. Use a valid graphics format, such as .gif, .jpg, or .png. Limit the image to 190 pixels wide by 60 pixels high. |
+| header_image                 | URL for the image you want to appear at the top left of the payment page. The image has a maximum size of 750 pixels wide by 90 pixels high. |
+| header_border_color          | Sets the border color around the header of the payment page. The border is a 2-pixel perimeter around the header space, which is 750 pixels wide by 90 pixels high. By default, the color is black. |
+| header_background_color      | Sets the background color for the header of the payment page. By default, the color is white. |
+| background_color             | Sets the background color for the payment page. By default, the color is white.|
+| allow_guest_checkout         | If set to true, then the SolutionType is Sole and buyer does not need to create a PayPal account to check out. |
+| landing_page                 | Type of PayPal page to display. It is one of the following values: Billing for Non-PayPal account and Login — PayPal account login. |
+| email                        | Email address of the buyer as entered during checkout. PayPal uses this value to pre-fill the PayPal membership sign-up portion on the PayPal pages. |
+| allow_note                   | Enables the buyer to enter a note to the merchant on the PayPal page during checkout.|
+| callback_url                 | URL to which the callback request from PayPal is sent. It must start with HTTPS for production integration. |
+| callback_timeout             | An override for you to request more or less time to be able to process the callback request and respond. |
+| allow_buyer_optin            | Enables the buyer to provide their email address on the PayPal pages to be notified of promotions or special events. |
+| shipping_address             | Address to which the order is shipped. This parameter must be a JSON Hash with keys of `name`, `address1`, `address2`, `state`, `city`, `country`, `phone`, `zip` and `phone`. |
+| address                      | Address to which the order is shipped if shipping_address is not set. This parameter must be a JSON Hash with keys of `name`, `address1`, `address2`, `state`, `city`, `country`, `phone`, `zip` and `phone`. |
+| total_type                   | Type declaration for the label to be displayed in MiniCart for UX. It is one of the following values: Total or EstimatedTotal. |
+| funding_sources              | This parameter must be in a JSON hash format with a key being `source`. This element could be used to specify the preferred funding option for a guest user. However, the `landing_page` element must also be set to `Billing`. Otherwise, it is ignored.|
+| shipping_options             | This parameter must be in a JSON hash format with keys of `default`, `amount`, and `name`. This corresponds to the `ShippingOptionsType` in the SetupExpressCheckout call. |
+| subtotal                     | Sum of cost of all items in this order. For digital goods, this field is required. |
+| shipping                     | Total shipping costs for this order.                               |
+| handling                     | Total handling costs for this order.                               |
+| tax                          | Sum of tax for all items in this order.                            |
+| insurance_total              | Total shipping insurance costs for this order. The value must be a non-negative currency amount or null if you offer insurance options. |
+| shipping_discount            | Shipping discount for this order, specified as a negative number.  |
+| insurance_option_offered     | Indicates whether insurance is available as an option the buyer can choose on the PayPal Review page. |
+| description                  | Description of items the buyer is purchasing.                      |
+| custom                       | A free-form field for your own use.                                |
+| order_id                     | Your own invoice or tracking number.                               |
+| invoice_id                   | Your own invoice or tracking number. This will be overridden by order_id. |
+| notify_url                   | Your URL for receiving Instant Payment Notification (IPN) about this transaction. If you do not specify this value in the request, the notification URL from your Merchant Profile is used, if one exists.|
+| items                        | This parameter must be a JSON Array that contains a list of Hashes with keys of `name`, `number`, `quantity`, `amount`, `description`, `url` and `category`. |

data/VERSION

@@ -1 +1 @@
-4.1.4
+4.1.5

data/lib/paypal_express/api.rb

@@ -318,11 +318,7 @@ module Killbill #:nodoc:
         options[:cancel_return_url] = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_hash, :cancel_return_url)
         options[:payment_processor_account_id] = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_hash, :payment_processor_account_id)
 
-        max_amount_value = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_hash, :max_amount)
-        if max_amount_value
-          max_amount_in_cents = to_cents((max_amount_value || '0').to_f, currency)
-          options[:max_amount] = max_amount_in_cents
-        end
+        add_optional_parameters options, properties_hash, currency
 
         amount_in_cents = amount.nil? ? nil : to_cents(amount, currency)
         response = @private_api.initiate_express_checkout(kb_account_id,
@@ -449,6 +445,105 @@ module Killbill #:nodoc:
       def cancel_pending_transaction(transaction_plugin_info)
         @response_model.cancel_pending_payment transaction_plugin_info
       end
+
+      def add_optional_parameters(options, properties_hash, currency)
+        [:max_amount,
+         :req_billing_address,
+         :no_shipping,
+         :address_override,
+         :locale,
+         :brand_name,
+         :page_style,
+         :logo_image,
+         :header_image,
+         :header_border_color,
+         :header_background_color,
+         :background_color,
+         :allow_guest_checkout,
+         :landing_page,
+         :email,
+         :allow_note,
+         :callback_url,
+         :callback_timeout,
+         :allow_buyer_optin,
+         :callback_version,
+         :address,
+         :shipping_address,
+         :total_type,
+         :funding_sources,
+         :shipping_options,
+         # Below are options for payment details
+         :subtotal,
+         :shipping,
+         :handling,
+         :tax,
+         :insurance_total,
+         :shipping_discount,
+         :insurance_option_offered,
+         :description,
+         :custom,
+         :order_id,
+         :invoice_id,
+         :notify_url,
+         :items].each do |sym|
+           option_val = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_hash, sym)
+           options[sym] = option_val unless option_val.nil?
+        end
+
+        # Special consideration for amount related options
+        [:max_amount,
+         :subtotal,
+         :shipping,
+         :handling,
+         :tax,
+         :insurance_total,
+         :shipping_discount].each do |sym|
+          if options[sym]
+            options[sym] = to_cents((options[sym] || '0').to_f, currency)
+          end
+        end
+
+        # Parse JSON based options including funding_source, items, shipping_options, address and shipping_address
+        [:funding_sources, :shipping_options, :items, :shipping_address, :address].each do |sym|
+          begin
+            options[sym] = JSON.parse options[sym] unless options[sym].nil?
+          rescue => e
+            logger.warn("Unexpected exception while parsing JSON option #{sym}: #{e.message}\n#{e.backtrace.join("\n")}")
+            options[sym] = nil
+          end
+        end
+
+        # Filter the options that has second level options including funding_source, items, shipping_options, address and shipping_address
+        [:shipping_address, :address].each do |key|
+          options[key] = filter_hash_options options[key], [:name, :address1, :address2, :city, :state, :country, :phone, :zip] unless options[key].nil?
+        end
+        options[:funding_sources] = filter_hash_options options[:funding_sources], [:source] unless options[:funding_sources].nil?
+        options[:shipping_options] = filter_array_options options[:shipping_options], [:default, :amount, :name], [:amount], currency unless options[:shipping_options].nil?
+        options[:items] = filter_array_options options[:items], [:name, :number, :quantity, :amount, :description, :url, :category], [:amount], currency unless options[:items].nil?
+      end
+
+      def filter_array_options(option, allowed_keys, amount_keys = [], currency = nil)
+        return nil if option.nil? || !option.is_a?(Array)
+        sub_options = []
+        option.each do |item|
+          next unless item.is_a?(Hash)
+          sub_hash = filter_hash_options item, allowed_keys, amount_keys, currency
+          sub_options << sub_hash unless sub_hash.nil?
+        end
+        sub_options.empty? ? nil : sub_options
+      end
+
+      def filter_hash_options(option, allowed_keys, amount_keys = [], currency = nil)
+        return nil if option.nil? || !option.is_a?(Hash)
+        # Because option is parsed from JSON, we need to convert to symbol keys to be used in ::Killbill::Plugin::ActiveMerchant::Utils.normalized
+        option.symbolize_keys!
+        sub_hash = {}
+        allowed_keys.each do |key|
+          sub_hash[key] = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(option, key)
+          sub_hash[key] = to_cents((sub_hash[key] || '0').to_f, currency) if amount_keys.include?(key) && !sub_hash[key].nil?
+        end
+        sub_hash.empty? ? nil : sub_hash
+      end
     end
   end
 end

data/pom.xml

@@ -26,7 +26,7 @@
     <groupId>org.kill-bill.billing.plugin.ruby</groupId>
     <artifactId>paypal-express-plugin</artifactId>
     <packaging>pom</packaging>
-    <version>4.1.4</version>
+    <version>4.1.5</version>
     <name>paypal-express-plugin</name>
     <url>http://github.com/killbill/killbill-paypal-express-plugin</url>
     <description>Plugin for accessing Paypal Express Checkout as a payment gateway</description>

data/spec/paypal_express/base_plugin_spec.rb

@@ -41,4 +41,93 @@ describe Killbill::PaypalExpress::PaymentPlugin do
     notification    = ''
     gw_notification = @plugin.process_notification notification, properties, context
   end
+
+  it 'should correctly add and filter optional parameters' do
+    # Basic option test
+    options = { :amount => 9900,
+                :some_property => true}
+    amount = 99.99
+    amount_in_cents = 9999
+    property_hash = { :noShipping => true,
+                      :max_amount => amount
+                    }
+    @plugin.send(:add_optional_parameters, options, property_hash, 'USD')
+    expected_options = { :amount => 9900,
+                         :some_property => true,
+                         :no_shipping => true,
+                         :max_amount => amount_in_cents
+                       }
+    options.should == expected_options
+
+    # Test with correct option format and unwanted property, e.g., fakeKey and unlimited
+    options = { :amount => 9900,
+                :some_property => true}
+    amount = 99.99
+    amount_in_cents = 9999
+    property_hash = { :noShipping => true,
+                      :max_amount => amount,
+                      :subtotal => amount,
+                      :shipping => amount,
+                      :handling => amount,
+                      :tax => amount,
+                      :fakeKey => 'unlimited',
+                      :insuranceTotal => amount,
+                      :shipping_discount => amount,
+                      :shipping_options => [{:default => false, :name => 'jack', :amount => amount, :unlimited => true}].to_json,
+                      :items => [{:name => 'john', :number => 111, :quantity => 12, :amount => amount, :description => 'jacket', :url => 'test', :category => 'unknown', :unlimited => true}].to_json,
+                      :shipping_address => {:name => 'john', :address1 => '111', :address2 => '12', :city => 'palo alto', :state => 'ca', :country => 'jacket', :phone => 'test', :zip => 'unknown', :family => 'unknown'}.to_json,
+                      :address => {:name => 'john', :address1 => '111', :address2 => '12', :city => 'palo alto', :state => 'ca', :country => 'jacket', :phone => 'test', :zip => 'unknown', :family => 'unknown'}.to_json,
+                      :funding_sources => {:source => 'unknown'}.to_json
+                   }
+    @plugin.send(:add_optional_parameters, options, property_hash, 'USD')
+    expected_options = { :amount => 9900,
+                         :some_property => true,
+                         :no_shipping => true,
+                         :max_amount => amount_in_cents,
+                         :subtotal => amount_in_cents,
+                         :shipping => amount_in_cents,
+                         :handling => amount_in_cents,
+                         :tax => amount_in_cents,
+                         :insurance_total => amount_in_cents,
+                         :shipping_discount => amount_in_cents,
+                         :shipping_options => [{:default => false, :name => 'jack', :amount => amount_in_cents}],
+                         :items => [{:name => 'john', :number => 111, :quantity => 12, :amount => amount_in_cents, :description => 'jacket', :url => 'test', :category => 'unknown'}],
+                         :shipping_address => {:name => 'john', :address1 => '111', :address2 => '12', :state => 'ca', :city => 'palo alto', :country => 'jacket', :phone => 'test', :zip => 'unknown'},
+                         :address => {:name => 'john', :address1 => '111', :address2 => '12', :state => 'ca', :city => 'palo alto', :country => 'jacket', :phone => 'test', :zip => 'unknown'},
+                         :funding_sources => {:source => 'unknown'}
+                      }
+    options.should == expected_options
+
+    # Test with incorrect option format and invalid json format
+    options = {}
+    property_hash = { :no_shipping => true,
+                      :max_amount => amount,
+                      :subtotal => amount,
+                      :shipping => amount,
+                      :handling => amount,
+                      :tax => amount,
+                      :fakeKey => 'unlimited',
+                      :insurance_total => amount,
+                      :shipping_discount => amount,
+                      :shipping_options => "{\"default\":\"false\", [name]:\"jack\", \"amount\":12}",
+                      :items => {:name => 'john', :number => 111, :quantity => 12, :amount => amount, :description => 'jacket', :url => 'test', :category => 'unknown', :unlimited => true}.to_json,
+                      :shipping_address => [{:name => 'john', :address1 => '111', :address2 => '12', :city => 'amount', :country => 'jacket', :phone => 'test', :zip => 'unknown'}].to_json,
+                      :address => [{:name => 'john', :address1 => '111', :address2 => '12', :city => 'amount', :country => 'jacket', :phone => 'test', :zip => 'unknown'}].to_json
+                    }
+    @plugin.send(:add_optional_parameters, options, property_hash, 'USD')
+    expected_options = { :no_shipping => true,
+                         :max_amount => amount_in_cents,
+                         :subtotal => amount_in_cents,
+                         :shipping => amount_in_cents,
+                         :handling => amount_in_cents,
+                         :tax => amount_in_cents,
+                         :insurance_total => amount_in_cents,
+                         :shipping_discount => amount_in_cents,
+                         :items => nil,
+                         :shipping_options => nil,
+                         :shipping_address => nil,
+                         :address => nil
+                       }
+    options.should == expected_options
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-paypal-express
 version: !ruby/object:Gem::Version
-  version: 4.1.4
+  version: 4.1.5
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: killbill