killbill-braintree_blue 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4992954dab3fce38eee200d6e172d6868b3cc7ad
-  data.tar.gz: 5cbf36e206397bdabbc2f42d8aab29a5455bdc7e
+  metadata.gz: f67df308d6753a2d7dbe3b4835d61afeb8a90bd5
+  data.tar.gz: 32e19fb2d8eb1f89f92e8d05dad9f8540716e67a
 SHA512:
-  metadata.gz: f446e080f6e1696604c89d04675d7b2e954a6d7ba9e797b5628c114f0b187d0eab6f42ae262936be9278cd67560e9bf24d7e43688664c8417bb8b27110c1390b
-  data.tar.gz: ded54d6b77e13bec7409f1ffc68a22a2aab3e58985bd719da0643b2a85437dd831bc122edc9e52c2ec27e27a2627c5e7403fc3e61d1ee91cddd08d54e53bd0d1
+  metadata.gz: ca5546f90c37178613b3b8a9dd0284980f38e3025160532ac04258266d2c3f3e5d9c2f62a2549af39b35925816c1a8591d95e4564306afe5b110dce03d45be8f
+  data.tar.gz: 57b16ad999435a2e71c71de1feda3f315613db5387843817130b5b6cd754dbf3cfcdd5049b5e35c036694732c960acbb3a5137bf7698be6d1d734e8ff41dfa3b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    killbill-braintree_blue (0.2.0)
+    killbill-braintree_blue (0.2.1)
       actionpack (~> 4.1.0)
       actionview (~> 4.1.0)
       activemerchant (~> 1.55.0)
@@ -20,13 +20,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (4.1.14)
-      actionview (= 4.1.14)
-      activesupport (= 4.1.14)
+    actionpack (4.1.15)
+      actionview (= 4.1.15)
+      activesupport (= 4.1.15)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    actionview (4.1.14)
-      activesupport (= 4.1.14)
+    actionview (4.1.15)
+      activesupport (= 4.1.15)
       builder (~> 3.1)
       erubis (~> 2.7.0)
     active_utils (3.0.0)
@@ -37,17 +37,17 @@ GEM
       builder (>= 2.1.2, < 4.0.0)
       i18n (>= 0.6.9)
       nokogiri (~> 1.4)
-    activemodel (4.1.14)
-      activesupport (= 4.1.14)
+    activemodel (4.1.15)
+      activesupport (= 4.1.15)
       builder (~> 3.1)
-    activerecord (4.1.14)
-      activemodel (= 4.1.14)
-      activesupport (= 4.1.14)
+    activerecord (4.1.15)
+      activemodel (= 4.1.15)
+      activesupport (= 4.1.15)
       arel (~> 5.0.0)
     activerecord-bogacs (0.4.1)
-    activerecord-jdbc-adapter (1.3.19)
+    activerecord-jdbc-adapter (1.3.20)
       activerecord (>= 2.2)
-    activesupport (4.1.14)
+    activesupport (4.1.15)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -68,7 +68,7 @@ GEM
     diff-lcs (1.1.3)
     equalizer (0.0.11)
     erubis (2.7.0)
-    ethon (0.8.0)
+    ethon (0.8.1)
       ffi (>= 1.3.0)
     ffi (1.9.10-java)
     i18n (0.7.0)
@@ -81,21 +81,21 @@ GEM
       ruby-maven (~> 3.3, >= 3.3.3)
     jdbc-mariadb (1.2.3)
     jdbc-sqlite3 (3.8.11.2)
-    jruby-openssl (0.9.12-java)
+    jruby-openssl (0.9.16-java)
     json (1.8.3-java)
-    killbill (7.0.0)
+    killbill (7.0.3)
       rack (>= 1.5.2)
       sinatra (~> 1.3.4)
       typhoeus (~> 0.6.9)
       tzinfo (~> 1.2.0)
     maven-tools (1.0.13)
       virtus (~> 1.0)
-    minitest (5.8.3)
+    minitest (5.8.4)
     monetize (1.1.0)
       money (~> 6.5.0)
     money (6.5.1)
       i18n (>= 0.6.4, <= 0.7.0)
-    nokogiri (1.6.7.1-java)
+    nokogiri (1.6.7.2-java)
     offsite_payments (2.1.0)
       actionpack (>= 3.2.20, < 5.0.0)
       active_utils (~> 3.0.0)
@@ -149,4 +149,4 @@ DEPENDENCIES
   rspec (~> 2.12.0)
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/NEWS

@@ -1,3 +1,9 @@
+0.2.1
+    Fix merchant_id look-up in multi-tenancy configuration
+    Increase default message field length to 510
+    Add endpoint to generate token
+    Add ability to add additional cards on existing customer using nonce
+
 0.2.0
     Initial release for Kill Bill 0.16.x
 

data/README.md

@@ -1,11 +1,11 @@
 killbill-braintree-plugin
 =========================
 
-Plugin was first developed by Ardura sp. z o.o.
-See original repo https://bitbucket.org/safekiddo/killbill-braintree-blue-plugin.git
+Plugin to use [Braintree](https://www.braintreepayments.com/) as a gateway.
 
-We cloned the repo to have it on github along with the other payment plugins supported on Kill Bill.
-It is advisable to also check for latest commit from original repo before using.
+Release builds are available on [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.kill-bill.billing.plugin.ruby%22%20AND%20a%3A%22braintree_blue-plugin%22) with coordinates `org.kill-bill.billing.plugin.ruby:braintree_blue-plugin`.
+
+This plugin was originally developed by [Ardura sp. z o.o.](https://bitbucket.org/safekiddo/killbill-braintree-blue-plugin.git).
 
 Kill Bill compatibility
 -----------------------
@@ -46,3 +46,218 @@ To go to production, create a `braintree_blue.yml` configuration file under `/va
   :test: false
 ```
 
+Usage
+-----
+
+To create a customer and tokenize a credit card:
+
+```
+curl -v \
+     -X POST \
+     -u admin:password \
+     -H 'X-Killbill-ApiKey: bob' \
+     -H 'X-Killbill-ApiSecret: lazar' \
+     -H 'X-Killbill-CreatedBy: admin' \
+     -H 'Content-Type: application/json' \
+     -d '{
+       "pluginName": "killbill-braintree_blue",
+       "pluginInfo": {
+         "properties": [
+           {
+             "key": "ccFirstName",
+             "value": "John"
+           },
+           {
+             "key": "ccLastName",
+             "value": "Doe"
+           },
+           {
+             "key": "address1",
+             "value": "5th Street"
+           },
+           {
+             "key": "city",
+             "value": "San Francisco"
+           },
+           {
+             "key": "zip",
+             "value": "94111"
+           },
+           {
+             "key": "state",
+             "value": "CA"
+           },
+           {
+             "key": "country",
+             "value": "US"
+           },
+           {
+             "key": "ccExpirationMonth",
+             "value": 12
+           },
+           {
+             "key": "ccExpirationYear",
+             "value": 2017
+           },
+           {
+             "key": "ccNumber",
+             "value": "4111111111111111"
+           }
+         ]
+       }
+     }' \
+     "http://127.0.0.1:8080/1.0/kb/accounts/<ACCOUNT_ID>/paymentMethods?isDefault=true"
+```
+
+The token can then be used for payments:
+
+```
+curl -v \
+     -X POST \
+     -u admin:password \
+     -H 'X-Killbill-ApiKey: bob' \
+     -H 'X-Killbill-ApiSecret: lazar' \
+     -H 'X-Killbill-CreatedBy: admin' \
+     -H 'Content-Type: application/json' \
+     -d '{
+       "transactionType": "AUTHORIZE",
+       "amount": 5
+     }' \
+     http://127.0.0.1:8080/1.0/kb/accounts/<ACCOUNT_ID>/payments
+```
+
+Alternatively, if you are using the JS v2 SDK, generate a nonce as follows:
+
+```
+<!DOCTYPE html>
+<html>
+<head>
+  <script src="https://js.braintreegateway.com/v2/braintree.js"></script>
+</head>
+<body>
+  <script>
+    var client = new braintree.api.Client({clientToken: token});
+
+    client.tokenizeCard({
+      number: "4111111111111111",
+      expirationDate: "10/20"
+    }, function (err, nonce) {
+      console.log(nonce);
+    });
+  </script>
+</body>
+</html>
+```
+
+where `token` is the server-side generated client token. For convenience, the plugin provides an endpoint to generate it:
+
+```
+curl http://127.0.0.1:8080/plugins/killbill-braintree_blue/token?kb_tenant_id=<TENANT_ID>
+```
+
+You can then create the customer with the nonce:
+
+```
+curl -v \
+     -X POST \
+     -u admin:password \
+     -H 'X-Killbill-ApiKey: bob' \
+     -H 'X-Killbill-ApiSecret: lazar' \
+     -H 'X-Killbill-CreatedBy: admin' \
+     -H 'Content-Type: application/json' \
+     -d '{
+       "pluginName": "killbill-braintree_blue",
+       "pluginInfo": {
+         "properties": [
+           {
+             "key": "ccFirstName",
+             "value": "John"
+           },
+           {
+             "key": "ccLastName",
+             "value": "Doe"
+           },
+           {
+             "key": "address1",
+             "value": "5th Street"
+           },
+           {
+             "key": "city",
+             "value": "San Francisco"
+           },
+           {
+             "key": "zip",
+             "value": "94111"
+           },
+           {
+             "key": "state",
+             "value": "CA"
+           },
+           {
+             "key": "country",
+             "value": "US"
+           },
+           {
+             "key": "token",
+             "value": "<NONCE>"
+           }
+         ]
+       }
+     }' \
+     "http://127.0.0.1:8080/1.0/kb/accounts/<ACCOUNT_ID>/paymentMethods?isDefault=true"
+```
+
+To add a second card on an existing customer using a nonce:
+
+```
+curl -v \
+     -X POST \
+     -u admin:password \
+     -H 'X-Killbill-ApiKey: bob' \
+     -H 'X-Killbill-ApiSecret: lazar' \
+     -H 'X-Killbill-CreatedBy: admin' \
+     -H 'Content-Type: application/json' \
+     -d '{
+       "pluginName": "killbill-braintree_blue",
+       "pluginInfo": {
+         "properties": [
+           {
+             "key": "token",
+             "value": "<NONCE>"
+           }
+         ]
+       }
+     }' \
+     "http://127.0.0.1:8080/1.0/kb/accounts/<ACCOUNT_ID>/paymentMethods?isDefault=true"
+```
+
+Plugin properties
+-----------------
+
+| Key                          | Description                                                       |
+| ---------------------------: | ----------------------------------------------------------------- |
+| skip_gw                      | If true, skip the call to Braintree                               |
+| payment_processor_account_id | Config entry name of the merchant account to use                  |
+| external_key_as_order_id     | If true, set the payment external key as the Braintree order id   |
+| customer                     | Braintree customer id                                             |
+| payment_method_nonce         | Payment method nonce                                              |
+| token                        | Braintree token                                                   |
+| cc_first_name                | Credit card holder first name                                     |
+| cc_last_name                 | Credit card holder last name                                      |
+| cc_type                      | Credit card brand                                                 |
+| cc_expiration_month          | Credit card expiration month                                      |
+| cc_expiration_year           | Credit card expiration year                                       |
+| cc_verification_value        | CVC/CVV/CVN                                                       |
+| email                        | Purchaser email                                                   |
+| address1                     | Billing address first line                                        |
+| address2                     | Billing address second line                                       |
+| city                         | Billing address city                                              |
+| zip                          | Billing address zip code                                          |
+| state                        | Billing address state                                             |
+| country                      | Billing address country                                           |
+| eci                          | Network tokenization attribute                                    |
+| payment_cryptogram           | Network tokenization attribute                                    |
+| transaction_id               | Network tokenization attribute                                    |
+| payment_instrument_name      | ApplePay tokenization attribute                                   |
+| payment_network              | ApplePay tokenization attribute                                   |
+| transaction_identifier       | ApplePay tokenization attribute                                   |

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/db/ddl.sql

@@ -57,7 +57,7 @@ CREATE TABLE `braintree_blue_responses` (
   `kb_payment_transaction_id` varchar(255) DEFAULT NULL,
   `transaction_type` varchar(255) DEFAULT NULL,
   `payment_processor_account_id` varchar(255) DEFAULT NULL,
-  `message` varchar(255) DEFAULT NULL,
+  `message` varchar(510) DEFAULT NULL,
   `authorization` varchar(255) DEFAULT NULL,
   `fraud_review` tinyint(1) DEFAULT NULL,
   `test` tinyint(1) DEFAULT NULL,

data/lib/braintree_blue/api.rb

@@ -4,7 +4,7 @@ module Killbill #:nodoc:
 
       def initialize
         gateway_builder = Proc.new do |config|
-          # Change this if needed
+          ::ActiveMerchant::Billing::BraintreeBlueGateway.application_id = config[:channel] || 'killbill_SP'
           ::ActiveMerchant::Billing::BraintreeBlueGateway.new :merchant_id => config[:merchant_id],
                                                               :public_key  => config[:public_key],
                                                               :private_key => config[:private_key]
@@ -30,7 +30,7 @@ module Killbill #:nodoc:
           :payment_method_token => true
         }
 
-        options.merge(get_merchant_id(currency))
+        options.merge(get_merchant_id(currency, context.tenant_id))
 
         properties = merge_properties(properties, options)
         super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
@@ -39,7 +39,7 @@ module Killbill #:nodoc:
       def capture_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
         # Pass extra parameters for the gateway here
         options = {}
-        options.merge(get_merchant_id(currency))
+        options.merge(get_merchant_id(currency, context.tenant_id))
         properties = merge_properties(properties, options)
         super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
       end
@@ -48,7 +48,7 @@ module Killbill #:nodoc:
         options = {
           :payment_method_token => true
         }
-        options.merge(get_merchant_id(currency))
+        options.merge(get_merchant_id(currency, context.tenant_id))
         properties = merge_properties(properties, options)
         super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
       end
@@ -64,7 +64,7 @@ module Killbill #:nodoc:
         options = {
           :payment_method_token => true
         }
-        options.merge(get_merchant_id(currency))
+        options.merge(get_merchant_id(currency, context.tenant_id))
         properties = merge_properties(properties, options)
         super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
       end
@@ -72,7 +72,7 @@ module Killbill #:nodoc:
       def refund_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
         # Pass extra parameters for the gateway here
         options = {}
-        options.merge(get_merchant_id(currency))
+        options.merge(get_merchant_id(currency, context.tenant_id))
         properties = merge_properties(properties, options)
         super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
       end
@@ -88,7 +88,7 @@ module Killbill #:nodoc:
       def search_payments(search_key, offset, limit, properties, context)
         # Pass extra parameters for the gateway here
         options = {}
-        options.merge(get_merchant_id(currency))
+        options.merge(get_merchant_id(currency, context.tenant_id))
         properties = merge_properties(properties, options)
         super(search_key, offset, limit, properties, context)
       end
@@ -110,7 +110,7 @@ module Killbill #:nodoc:
              !find_value_from_properties(payment_method_props.properties, :token).blank?
           pm_props_hsh = properties_to_hash(payment_method_props.properties)
 
-          # Pass 'credit_card_token' (along with CC details) or 'payment_method_nonce'
+          # Pass 'token' (along with CC details) or 'payment_method_nonce'
           # For convenience, we translate 'token' into 'payment_method_nonce'
           # Note: we remove the token because the Braintree AM implementation always requires a CreditCard object
           options[:payment_method_nonce] = pm_props_hsh.delete(:token)
@@ -191,17 +191,19 @@ module Killbill #:nodoc:
         end
       end
 
-      def get_merchant_id(currency)
+      def get_merchant_id(currency, kb_tenant_id=nil)
+        config = ::Killbill::Plugin::ActiveMerchant.config(kb_tenant_id)
         options = {}
-        if (config[:braintree_blue][:multicurrency])
-            case currency
-                when "USD"
-                    options = { :merchant_account_id => config[:multicurrency][:USD] }
-                when "EUR"
-                    options = { :merchant_account_id => config[:multicurrency][:EUR] }
-                when "PLN"
-                    options = { :merchant_account_id => config[:multicurrency][:PLN] }
-            end
+        if config[:braintree_blue][:multicurrency]
+          multicurrency = config[:multicurrency] || {}
+          case currency
+            when "USD"
+              options = {:merchant_account_id => multicurrency[:USD]}
+            when "EUR"
+              options = {:merchant_account_id => multicurrency[:EUR]}
+            when "PLN"
+              options = {:merchant_account_id => multicurrency[:PLN]}
+          end
         end
         options
       end

data/lib/braintree_blue/application.rb

@@ -2,6 +2,8 @@
 
 set :views, File.expand_path(File.dirname(__FILE__) + '/views')
 
+require 'braintree'
+
 include Killbill::Plugin::ActiveMerchant::Sinatra
 
 configure do
@@ -22,6 +24,22 @@ helpers do
   end
 end
 
+# curl -v http://127.0.0.1:9292/plugins/killbill-braintree_blue/token
+get '/plugins/killbill-braintree_blue/token', :provides => 'json' do
+  kb_tenant_id = request.GET['kb_tenant_id']
+  environment = request.GET['environment'] || 'sandbox'
+  customer_id = request.GET['customer_id']
+
+  bconfig = (config(kb_tenant_id) || {})[:braintree_blue] || {}
+
+  Braintree::Configuration.environment = environment.to_sym
+  Braintree::Configuration.merchant_id = bconfig[:merchant_id]
+  Braintree::Configuration.private_key = bconfig[:private_key]
+  Braintree::Configuration.public_key = bconfig[:public_key]
+
+  Braintree::ClientToken.generate(:customer_id => customer_id)
+end
+
 # curl -v http://127.0.0.1:9292/plugins/killbill-braintree_blue/form
 get '/plugins/killbill-braintree_blue/form', :provides => 'html' do
   order_id   = request.GET['order_id']

data/lib/braintree_blue/ext/active_merchant/active_merchant.rb

@@ -0,0 +1,40 @@
+module ActiveMerchant
+  module Billing
+    class BraintreeBlueGateway
+
+      def add_credit_card_to_customer(credit_card, options)
+        commit do
+          if options[:payment_method_nonce]
+            credit_card_params = { payment_method_nonce: options[:payment_method_nonce] }
+          else
+            credit_card_params = {
+                token: options[:credit_card_token],
+                cardholder_name: credit_card.name,
+                number: credit_card.number,
+                cvv: credit_card.verification_value,
+                expiration_month: credit_card.month.to_s.rjust(2, "0"),
+                expiration_year: credit_card.year.to_s,
+            }
+          end
+          parameters = {
+              customer_id: options[:customer],
+          }.merge credit_card_params
+
+          options[:billing_address].compact!
+          parameters[:billing_address] = map_address(options[:billing_address]) unless options[:billing_address].empty?
+
+          result = @braintree_gateway.credit_card.create(parameters)
+          ActiveMerchant::Billing::Response.new(
+              result.success?,
+              message_from_result(result),
+              {
+                  customer_vault_id: (result.credit_card.customer_id if result.success?),
+                  credit_card_token: (result.credit_card.token if result.success?)
+              },
+              authorization: (result.credit_card.customer_id if result.success?)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/braintree_blue.rb

@@ -16,6 +16,8 @@ require 'yaml'
 require 'killbill'
 require 'killbill/helpers/active_merchant'
 
+require 'braintree_blue/ext/active_merchant/active_merchant.rb'
+
 require 'braintree_blue/api'
 require 'braintree_blue/private_api'
 

data/pom.xml

@@ -25,7 +25,7 @@
     <groupId>org.kill-bill.billing.plugin.ruby</groupId>
     <artifactId>braintree_blue-plugin</artifactId>
     <packaging>pom</packaging>
-    <version>0.2.0</version>
+    <version>0.2.1</version>
     <name>braintree_blue-plugin</name>
     <url>http://github.com/killbill/killbill-braintree_blue-plugin</url>
     <description>Plugin for accessing BraintreeBlue as a payment gateway</description>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-braintree_blue
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: killbill
@@ -303,6 +303,7 @@ files:
 - lib/braintree_blue.rb
 - lib/braintree_blue/api.rb
 - lib/braintree_blue/application.rb
+- lib/braintree_blue/ext/active_merchant/active_merchant.rb
 - lib/braintree_blue/models/payment_method.rb
 - lib/braintree_blue/models/response.rb
 - lib/braintree_blue/models/transaction.rb
@@ -337,7 +338,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.6
 signing_key:
 specification_version: 4
 summary: Plugin to use BraintreeBlue as a gateway.