killbill-paypal-express 1.6.4 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe1f13de94d8a2b969153a632b2535bcad835554
-  data.tar.gz: 3910bf4a1da4b9dbb589e645030f367e752b5b1f
+  metadata.gz: e6edd71974c6e3f234a22b6012786d8311d4145e
+  data.tar.gz: b0cf73fbec05c8a238d0575a69d870810cb2c436
 SHA512:
-  metadata.gz: 52172874baa3fa108d1a0622f7a7969b268d0747ba3c12f2d369ea0968a31fc9f7637fdec3244ea9c529e8e6c39836b9ae1ee4a345db6517a37e19a6737cc5c4
-  data.tar.gz: c39b4197ff9a3d91a8887f9e8aac08a947f4337b2160057be4e31999fe877b32aa89334354e5b51d2af311acc85770d99e23d9176e6ebeb3464abcec73502e8e
+  metadata.gz: 2d7de8573d9a997cce9dffd8dc470573f9ec220151722d96c9e44dca6f372652c9b7c135b3c6670d9220deaab3ed635e3dd293607f4458eef09403106c498c31
+  data.tar.gz: 388ed005eef4307c1105621f39d85f8db4f00b30c2e5124c73a77d1a04e2c19b48f3f8f6d8a8608cffcd25c4536fd222c0502e52aacae02cac4c2c0adb81282e

data/Jarfile

@@ -1,6 +1,6 @@
-jar 'com.ning.billing:killbill-api', '0.7.8'
-jar 'com.ning.billing.plugin:killbill-plugin-api-notification', '0.6.2'
-jar 'com.ning.billing.plugin:killbill-plugin-api-payment', '0.6.2'
-jar 'com.ning.billing.plugin:killbill-plugin-api-currency', '0.6.2'
-jar 'com.ning.billing:killbill-util:tests', '0.7.1'
+jar 'com.ning.billing:killbill-api', '0.8.0'
+jar 'com.ning.billing.plugin:killbill-plugin-api-notification', '0.6.3'
+jar 'com.ning.billing.plugin:killbill-plugin-api-payment', '0.6.3'
+jar 'com.ning.billing.plugin:killbill-plugin-api-currency', '0.6.3'
+jar 'com.ning.billing:killbill-util:tests', '0.8.8'
 jar 'javax.servlet:javax.servlet-api', '3.0.1'

data/NEWS

@@ -1,3 +1,11 @@
+1.6.5
+    Implement payments and refunds search
+    Fix amount to cents conversion
+    Update to latest killbill (2.0.0)
+
+1.6.4
+    Update to latest killbill (1.9.0)
+
 1.6.3
     Fix bugs for currency conversion during payment/refunds
 

data/README.md

@@ -6,6 +6,9 @@ killbill-paypal-express-plugin
 
 Plugin to use Express Checkout as a gateway.
 
+Release builds are available on [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.ning.killbill.ruby%22%20AND%20a%3A%22paypal-express-plugin%22) with coordinates `com.ning.killbill.ruby:paypal-express-plugin`.
+
+
 Usage
 -----
 

data/VERSION

@@ -1 +1 @@
-1.6.4
+1.6.5

data/killbill-paypal-express.gemspec

@@ -22,9 +22,10 @@ Gem::Specification.new do |s|
 
   s.rdoc_options << '--exclude' << '.'
 
-  s.add_dependency 'killbill', '~> 1.9.0'
+  s.add_dependency 'killbill', '~> 2.0.0'
   s.add_dependency 'activemerchant', '~> 1.36.0'
   s.add_dependency 'activerecord', '~> 3.2.1'
+  s.add_dependency 'money', '~> 6.0.0'
   s.add_dependency 'sinatra', '~> 1.3.4'
   if defined?(JRUBY_VERSION)
     s.add_dependency 'activerecord-jdbcmysql-adapter', '~> 1.2.9'

data/lib/paypal_express/api.rb

@@ -17,7 +17,8 @@ module Killbill::PaypalExpress
     end
 
     def process_payment(kb_account_id, kb_payment_id, kb_payment_method_id, amount, currency, call_context = nil, options = {})
-      amount_in_cents = (amount * 100).to_i
+      # Use Money to compute the amount in cents, as it depends on the currency (1 cent of BTC is 1 Satoshi, not 0.01 BTC)
+      amount_in_cents = Money.new_with_amount(amount, currency).cents.to_i
 
       # If the payment was already made, just return the status
       paypal_express_transaction = PaypalExpressTransaction.from_kb_payment_id(kb_payment_id) rescue nil
@@ -54,7 +55,8 @@ module Killbill::PaypalExpress
     end
 
     def process_refund(kb_account_id, kb_payment_id, amount, currency, call_context = nil, options = {})
-      amount_in_cents = (amount * 100).to_i
+      # Use Money to compute the amount in cents, as it depends on the currency (1 cent of BTC is 1 Satoshi, not 0.01 BTC)
+      amount_in_cents = Money.new_with_amount(amount, currency).cents.to_i
 
       # Check for currency conversion
       actual_amount, actual_currency = convert_amount_currency_if_required(amount_in_cents, currency, kb_payment_id)
@@ -74,11 +76,11 @@ module Killbill::PaypalExpress
     end
 
     def get_refund_info(kb_account_id, kb_payment_id, tenant_context = nil, options = {})
-      paypal_express_transaction = PaypalExpressTransaction.refund_from_kb_payment_id(kb_payment_id)
+      paypal_express_transactions = PaypalExpressTransaction.refunds_from_kb_payment_id(kb_payment_id)
 
       # We could also re-fetch it via: @gateway.transaction_details(transaction_id)
       # but we would need to reconstruct the refund_info object
-      paypal_express_transaction.paypal_express_response.to_refund_response
+      paypal_express_transactions.map { |t| t.paypal_express_response.to_refund_response }
     end
 
     def add_payment_method(kb_account_id, kb_payment_method_id, payment_method_props, set_default = false, call_context = nil, options = {})
@@ -173,6 +175,14 @@ module Killbill::PaypalExpress
       end
     end
 
+    def search_payments(search_key, offset = 0, limit = 100, call_context = nil, options = {})
+      PaypalExpressResponse.search(search_key, offset, limit, :payment)
+    end
+
+    def search_refunds(search_key, offset = 0, limit = 100, call_context = nil, options = {})
+      PaypalExpressResponse.search(search_key, offset, limit, :refund)
+    end
+
     def search_payment_methods(search_key, offset = 0, limit = 100, call_context = nil, options = {})
       PaypalExpressPaymentMethod.search(search_key, offset, limit)
     end

data/lib/paypal_express/models/paypal_express_response.rb

@@ -125,12 +125,57 @@ module Killbill::PaypalExpress
       to_killbill_response :refund
     end
 
+    # VisibleForTesting
+    def self.search_query(api_call, search_key, offset = nil, limit = nil)
+      t = self.arel_table
+
+      # Exact matches only
+      where_clause =     t[:authorization].eq(search_key)
+                     .or(t[:billing_agreement_id].eq(search_key))
+                     .or(t[:payment_info_transactionid].eq(search_key))
+
+      # Only search successful payments and refunds
+      where_clause = where_clause.and(t[:api_call].eq(api_call))
+                                 .and(t[:success].eq(true))
+
+      query = t.where(where_clause)
+               .order(t[:id])
+
+      if offset.blank? and limit.blank?
+        # true is for count distinct
+        query.project(t[:id].count(true))
+      else
+        query.skip(offset) unless offset.blank?
+        query.take(limit) unless limit.blank?
+        query.project(t[Arel.star])
+        # Not chainable
+        query.distinct
+      end
+      query
+    end
+
+    def self.search(search_key, offset = 0, limit = 100, type = :payment)
+      api_call = type == :payment ? 'charge' : 'refund'
+      pagination = Killbill::Plugin::Model::Pagination.new
+      pagination.current_offset = offset
+      pagination.total_nb_records = self.count_by_sql(self.search_query(api_call, search_key))
+      pagination.max_nb_records = self.where(:api_call => api_call, :success => true).count
+      pagination.next_offset = (!pagination.total_nb_records.nil? && offset + limit >= pagination.total_nb_records) ? nil : offset + limit
+      # Reduce the limit if the specified value is larger than the number of records
+      actual_limit = [pagination.max_nb_records, limit].min
+      pagination.iterator = StreamyResultSet.new(actual_limit) do |offset,limit|
+        self.find_by_sql(self.search_query(api_call, search_key, offset, limit))
+            .map { |x| type == :payment ? x.to_payment_response : x.to_refund_response }
+      end
+      pagination
+    end
+
     private
 
     def to_killbill_response(type)
       if paypal_express_transaction.nil?
-        # payment_info_grossamount is e.g. "100.00" - we need to convert it in cents
-        amount_in_cents = payment_info_grossamount ? (payment_info_grossamount.to_f * 100).to_i : nil
+        # payment_info_grossamount may have a value but we cannot convert it to cents since we don't have the currency
+        amount_in_cents = nil
         currency = nil
         created_date = created_at
         first_payment_reference_id = nil
@@ -139,8 +184,8 @@ module Killbill::PaypalExpress
         amount_in_cents = paypal_express_transaction.amount_in_cents
         currency = paypal_express_transaction.currency
         created_date = paypal_express_transaction.created_at
-        first_payment_reference_id = paypal_express_transaction.paypal_express_txn_id
-        second_payment_reference_id = nil
+        first_reference_id = paypal_express_transaction.paypal_express_txn_id
+        second_reference_id = nil
       end
 
       effective_date = created_date
@@ -149,26 +194,29 @@ module Killbill::PaypalExpress
 
       if type == :payment
         p_info_plugin = Killbill::Plugin::Model::PaymentInfoPlugin.new
-        p_info_plugin.amount = BigDecimal.new(amount_in_cents.to_s) / 100.0 if amount_in_cents
+        p_info_plugin.kb_payment_id = kb_payment_id
+        p_info_plugin.amount = Money.new(amount_in_cents, currency).to_d if currency
         p_info_plugin.currency = currency
         p_info_plugin.created_date = created_date
         p_info_plugin.effective_date = effective_date
         p_info_plugin.status = (success ? :PROCESSED : :ERROR)
         p_info_plugin.gateway_error = gateway_error
         p_info_plugin.gateway_error_code = gateway_error_code
-        p_info_plugin.first_payment_reference_id = first_payment_reference_id
-        p_info_plugin.second_payment_reference_id = second_payment_reference_id
+        p_info_plugin.first_payment_reference_id = first_reference_id
+        p_info_plugin.second_payment_reference_id = second_reference_id
         p_info_plugin
       else
         r_info_plugin = Killbill::Plugin::Model::RefundInfoPlugin.new
-        r_info_plugin.amount = BigDecimal.new(amount_in_cents.to_s) / 100.0 if amount_in_cents
+        r_info_plugin.kb_payment_id = kb_payment_id
+        r_info_plugin.amount = Money.new(amount_in_cents, currency).to_d if currency
         r_info_plugin.currency = currency
         r_info_plugin.created_date = created_date
         r_info_plugin.effective_date = effective_date
         r_info_plugin.status = (success ? :PROCESSED : :ERROR)
         r_info_plugin.gateway_error = gateway_error
         r_info_plugin.gateway_error_code = gateway_error_code
-        r_info_plugin.reference_id = first_payment_reference_id
+        r_info_plugin.first_refund_reference_id = first_reference_id
+        r_info_plugin.second_refund_reference_id = second_reference_id
         r_info_plugin
       end
     end

data/lib/paypal_express/models/paypal_express_transaction.rb

@@ -8,18 +8,11 @@ module Killbill::PaypalExpress
                     :paypal_express_txn_id
 
     def self.from_kb_payment_id(kb_payment_id)
-      single_transaction_from_kb_payment_id :charge, kb_payment_id
+      transaction_from_kb_payment_id :charge, kb_payment_id, :single
     end
 
-    def self.refund_from_kb_payment_id(kb_payment_id)
-      single_transaction_from_kb_payment_id :refund, kb_payment_id
-    end
-
-    def self.single_transaction_from_kb_payment_id(api_call, kb_payment_id)
-      paypal_express_transactions = find_all_by_api_call_and_kb_payment_id(api_call, kb_payment_id)
-      raise "Unable to find Paypal Express transaction id for payment #{kb_payment_id}" if paypal_express_transactions.empty?
-      raise "Killbill payment mapping to multiple Paypal Express transactions for payment #{kb_payment_id}" if paypal_express_transactions.size > 1
-      paypal_express_transactions[0]
+    def self.refunds_from_kb_payment_id(kb_payment_id)
+      transaction_from_kb_payment_id :refund, kb_payment_id, :multiple
     end
 
     def self.find_candidate_transaction_for_refund(kb_payment_id, amount_in_cents)
@@ -38,5 +31,18 @@ module Killbill::PaypalExpress
 
       paypal_express_transactions.first
     end
+
+    private
+
+    def self.transaction_from_kb_payment_id(api_call, kb_payment_id, how_many)
+      paypal_express_transactions = find_all_by_api_call_and_kb_payment_id(api_call, kb_payment_id)
+      raise "Unable to find Paypal Express transaction id for payment #{kb_payment_id}" if paypal_express_transactions.empty?
+      if how_many == :single
+        raise "Killbill payment mapping to multiple Paypal Express transactions for payment #{kb_payment_id}" if paypal_express_transactions.size > 1
+        paypal_express_transactions[0]
+      else
+        paypal_express_transactions
+      end
+    end
   end
 end

data/lib/paypal_express.rb

@@ -1,6 +1,7 @@
 require 'active_record'
 require 'activemerchant'
 require 'bigdecimal'
+require 'money'
 require 'pathname'
 require 'sinatra'
 require 'singleton'

data/pom.xml

@@ -25,7 +25,7 @@
     <groupId>com.ning.killbill.ruby</groupId>
     <artifactId>paypal-express-plugin</artifactId>
     <packaging>pom</packaging>
-    <version>1.6.4</version>
+    <version>1.6.5</version>
     <name>paypal-express-plugin</name>
     <url>http://github.com/killbill/killbill-paypal-express-plugin</url>
     <description>Plugin for accessing paypal as a payment gateway</description>

data/spec/paypal_express/paypal_express_response_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Killbill::PaypalExpress::PaypalExpressResponse do
+  before :all do
+    Killbill::PaypalExpress::PaypalExpressResponse.delete_all
+  end
+
+  it 'should generate the right SQL query' do
+    # Check count query (search query numeric)
+    expected_query = "SELECT COUNT(DISTINCT \"paypal_express_responses\".\"id\") FROM \"paypal_express_responses\"  WHERE ((\"paypal_express_responses\".\"authorization\" = '1234' OR \"paypal_express_responses\".\"billing_agreement_id\" = '1234') OR \"paypal_express_responses\".\"payment_info_transactionid\" = '1234') AND \"paypal_express_responses\".\"api_call\" = 'charge' AND \"paypal_express_responses\".\"success\" = 't' ORDER BY \"paypal_express_responses\".\"id\""
+    # Note that Kill Bill will pass a String, even for numeric types
+    Killbill::PaypalExpress::PaypalExpressResponse.search_query('charge', '1234').to_sql.should == expected_query
+
+    # Check query with results (search query numeric)
+    expected_query = "SELECT  DISTINCT \"paypal_express_responses\".* FROM \"paypal_express_responses\"  WHERE ((\"paypal_express_responses\".\"authorization\" = '1234' OR \"paypal_express_responses\".\"billing_agreement_id\" = '1234') OR \"paypal_express_responses\".\"payment_info_transactionid\" = '1234') AND \"paypal_express_responses\".\"api_call\" = 'charge' AND \"paypal_express_responses\".\"success\" = 't' ORDER BY \"paypal_express_responses\".\"id\" LIMIT 10 OFFSET 0"
+    # Note that Kill Bill will pass a String, even for numeric types
+    Killbill::PaypalExpress::PaypalExpressResponse.search_query('charge', '1234', 0, 10).to_sql.should == expected_query
+
+    # Check count query (search query string)
+    expected_query = "SELECT COUNT(DISTINCT \"paypal_express_responses\".\"id\") FROM \"paypal_express_responses\"  WHERE ((\"paypal_express_responses\".\"authorization\" = 'XXX' OR \"paypal_express_responses\".\"billing_agreement_id\" = 'XXX') OR \"paypal_express_responses\".\"payment_info_transactionid\" = 'XXX') AND \"paypal_express_responses\".\"api_call\" = 'charge' AND \"paypal_express_responses\".\"success\" = 't' ORDER BY \"paypal_express_responses\".\"id\""
+    Killbill::PaypalExpress::PaypalExpressResponse.search_query('charge', 'XXX').to_sql.should == expected_query
+
+    # Check query with results (search query string)
+    expected_query = "SELECT  DISTINCT \"paypal_express_responses\".* FROM \"paypal_express_responses\"  WHERE ((\"paypal_express_responses\".\"authorization\" = 'XXX' OR \"paypal_express_responses\".\"billing_agreement_id\" = 'XXX') OR \"paypal_express_responses\".\"payment_info_transactionid\" = 'XXX') AND \"paypal_express_responses\".\"api_call\" = 'charge' AND \"paypal_express_responses\".\"success\" = 't' ORDER BY \"paypal_express_responses\".\"id\" LIMIT 10 OFFSET 0"
+    Killbill::PaypalExpress::PaypalExpressResponse.search_query('charge', 'XXX', 0, 10).to_sql.should == expected_query
+  end
+
+  it 'should search all fields' do
+    do_search('foo').size.should == 0
+
+    pm = Killbill::PaypalExpress::PaypalExpressResponse.create :api_call => 'charge',
+                                                               :kb_payment_id => '11-22-33-44',
+                                                               :authorization => '55-66-77-88',
+                                                               :billing_agreement_id => 38102343,
+                                                               :payment_info_transactionid => 'order-id-1',
+                                                               :success => true
+
+    # Wrong api_call
+    ignored1 = Killbill::PaypalExpress::PaypalExpressResponse.create :api_call => 'add_payment_method',
+                                                                     :kb_payment_id => pm.kb_payment_id,
+                                                                     :authorization => pm.authorization,
+                                                                     :billing_agreement_id => pm.billing_agreement_id,
+                                                                     :payment_info_transactionid => pm.payment_info_transactionid,
+                                                                     :success => true
+
+    # Not successful
+    ignored2 = Killbill::PaypalExpress::PaypalExpressResponse.create :api_call => 'charge',
+                                                                     :kb_payment_id => pm.kb_payment_id,
+                                                                     :authorization => pm.authorization,
+                                                                     :billing_agreement_id => pm.billing_agreement_id,
+                                                                     :payment_info_transactionid => pm.payment_info_transactionid,
+                                                                     :success => false
+
+    do_search('foo').size.should == 0
+    do_search(pm.authorization).size.should == 1
+    do_search(pm.billing_agreement_id).size.should == 1
+    do_search(pm.payment_info_transactionid).size.should == 1
+
+    pm2 = Killbill::PaypalExpress::PaypalExpressResponse.create :api_call => 'charge',
+                                                                :kb_payment_id => '11-22-33-44',
+                                                                :authorization => '11-22-33-44',
+                                                                :billing_agreement_id => pm.billing_agreement_id,
+                                                                :payment_info_transactionid => 'order-id-2',
+                                                                :success => true
+
+    do_search('foo').size.should == 0
+    do_search(pm.authorization).size.should == 1
+    do_search(pm.billing_agreement_id).size.should == 2
+    do_search(pm.payment_info_transactionid).size.should == 1
+    do_search(pm2.authorization).size.should == 1
+    do_search(pm2.billing_agreement_id).size.should == 2
+    do_search(pm2.payment_info_transactionid).size.should == 1
+  end
+
+  private
+
+  def do_search(search_key)
+    pagination = Killbill::PaypalExpress::PaypalExpressResponse.search(search_key)
+    pagination.current_offset.should == 0
+    results = pagination.iterator.to_a
+    pagination.total_nb_records.should == results.size
+    results
+  end
+end

data/spec/paypal_express/remote/integration_spec.rb

@@ -85,9 +85,10 @@ describe Killbill::PaypalExpress::PaymentPlugin do
     response.success.should be_true
 
     # Check we can retrieve the refund
-    refund_response = @plugin.get_refund_info @pm.kb_account_id, kb_payment_id
-    refund_response.amount.should == amount
-    refund_response.status.should == :PROCESSED
+    refund_responses = @plugin.get_refund_info @pm.kb_account_id, kb_payment_id
+    refund_responses.size.should == 1
+    refund_responses[0].amount.should == amount
+    refund_responses[0].status.should == :PROCESSED
 
     # Try another payment to verify the BAID
     second_amount = BigDecimal.new("94.23")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-paypal-express
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.6.5
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-01-02 00:00:00.000000000 Z
+date: 2014-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: killbill
@@ -16,12 +16,12 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 2.0.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 2.0.0
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
@@ -52,6 +52,20 @@ dependencies:
         version: 3.2.1
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: money
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: sinatra
   version_requirements: !ruby/object:Gem::Requirement
@@ -170,6 +184,7 @@ files:
 - release.sh
 - spec/paypal_express/base_plugin_spec.rb
 - spec/paypal_express/paypal_express_payment_method_spec.rb
+- spec/paypal_express/paypal_express_response_spec.rb
 - spec/paypal_express/remote/integration_spec.rb
 - spec/paypal_express/streamy_result_set_spec.rb
 - spec/spec_helper.rb
@@ -202,6 +217,7 @@ summary: Plugin to use Express Checkout as a gateway.
 test_files:
 - spec/paypal_express/base_plugin_spec.rb
 - spec/paypal_express/paypal_express_payment_method_spec.rb
+- spec/paypal_express/paypal_express_response_spec.rb
 - spec/paypal_express/remote/integration_spec.rb
 - spec/paypal_express/streamy_result_set_spec.rb
 - spec/spec_helper.rb