killbill 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ab7a1b0644b090a4bd24355986ad459158e65cf
-  data.tar.gz: 2e34dc457ad13a50897234fa07a1a15537f5cee4
+  metadata.gz: b3e2b2173652205054ae00074eaa95b29b28a5a0
+  data.tar.gz: fe6277ad4bbeb755a90e5ce3883d761621f99b9f
 SHA512:
-  metadata.gz: 6d9cd10ec85f822ccea718d786917d46630f350bd7036cba20cfd44f478f3441de7b6656a8452efe92ec22c747c6f213cbb4284f99082b692ce8aa1556af4689
-  data.tar.gz: 4bec7027a2331f7be7e7b60069d3a7c02ffefe5a517e3ae8e4f638558df05a7dbf8a129ac932957ee989b5f8389fd04914c37509fd66b93f9f5ddd7b24fea687
+  metadata.gz: eb8653e32d042dc14cb4abfa7c824a9c1ca455691ecf38ca7e04a2555514679773124cdff1c571e4d7148f6103884a1eb1bfbfefc64c4b81cab9854f01aed03e
+  data.tar.gz: 2500df5527371c926a8963678e2fe187d61af4f89be8c4800e09133a6acd7440371c68813a752fbe6ed4373475a17aedcc30b5b73bdb046ba239c50ccaf77f50

data/.gitignore

@@ -22,3 +22,4 @@ Jarfile.lock
 Gemfile.lock
 *.swp
 .idea
+test.db

data/Jarfile

@@ -1,6 +1,6 @@
-jar 'org.kill-bill.billing:killbill-api', '0.8.2-SNAPSHOT'
-jar 'org.kill-bill.billing.plugin:killbill-plugin-api-notification', '0.6.4-SNAPSHOT'
-jar 'org.kill-bill.billing.plugin:killbill-plugin-api-payment', '0.6.4-SNAPSHOT'
-jar 'org.kill-bill.billing.plugin:killbill-plugin-api-currency', '0.6.4-SNAPSHOT'
-jar 'org.kill-bill.billing:killbill-util:tests', '0.9.0-SNAPSHOT'
+jar 'org.kill-bill.billing:killbill-api', '0.9.2'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-notification', '0.7.0'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-payment', '0.7.0'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-currency', '0.7.0'
+jar 'org.kill-bill.billing:killbill-util:tests', '0.11.1'
 jar 'javax.servlet:javax.servlet-api', '3.0.1'

data/NEWS

@@ -1,3 +1,7 @@
+3.1.0
+    Regenerate files for killbill-api 0.9.2 and killbill-plugin-api 0.7.0
+    Add ActiveMerchant plugin generator
+
 3.0.0
     Update package com.ning -> org.killbill
 

data/README.md

@@ -56,28 +56,43 @@ How to write a Payment plugin
         puts "MyPaymentPlugin plugin started"
       end
 
-      def charge(killbill_account_id, killbill_payment_id, amount_in_cents, options = {})
+      def process_payment(kb_account_id, kb_payment_id, kb_payment_method_id, amount, currency, context)
       end
 
-      def refund(killbill_account_id, killbill_payment_id, amount_in_cents, options = {})
+      def get_payment_info(kb_account_id, kb_payment_id, context)
       end
 
-      def get_payment_info(killbill_payment_id, options = {})
+      def search_payments(search_key, offset, limit, context)
       end
 
-      def add_payment_method(payment_method, options = {})
+      def process_refund(kb_account_id, kb_payment_id, refund_amount, currency, context)
       end
 
-      def delete_payment_method(external_payment_method_id, options = {})
+      def get_refund_info(kb_account_id, kb_payment_id, context)
       end
 
-      def update_payment_method(payment_method, options = {})
+      def search_refunds(search_key, offset, limit, context)
       end
 
-      def set_default_payment_method(payment_method, options = {})
+      def add_payment_method(kb_account_id, kb_payment_method_id, payment_method_props, set_default, context)
       end
 
-      def create_account(killbill_account, options = {})
+      def delete_payment_method(kb_account_id, kb_payment_method_id, context)
+      end
+
+      def get_payment_method_detail(kb_account_id, kb_payment_method_id, context)
+      end
+
+      def set_default_payment_method(kb_account_id, kb_payment_method_id, context)
+      end
+
+      def get_payment_methods(kb_account_id, refresh_from_gateway, context)
+      end
+
+      def search_payment_methods(search_key, offset, limit, context)
+      end
+
+      def reset_payment_methods(kb_account_id, payment_methods)
       end
 
       # Overriding this method is optional, only if you need to do some tear down work
@@ -93,6 +108,23 @@ Make sure to create the corresponding killbill.properties file:
     mainClass=MyPaymentPlugin
     pluginType=PAYMENT
 
+
+How to write a Payment plugin integrated with ActiveMerchant
+------------------------------------------------------------
+
+Use the plugin generator:
+
+    ./script/generate active_merchant gateway_name /path/to/dir
+
+Replace `gateway_name` with the snake case of your ActiveMerchant gateway (e.g. `yandex`, `stripe`, `paypal`, etc.).
+
+This will generate a tree of files ready to be plugged into Kill Bill. To package the plugin, run:
+
+    rake killbill:clean ; rake build ; rake killbill:package
+
+Most of the work consists of filling in the blank in `api.rb` (payment plugin API for ActiveMerchant gateways) and `application.rb` (sinatra application for ActiveMerchant integrations). Check the [Stripe plugin](https://github.com/killbill/killbill-stripe-plugin) for an example.
+
+
 How to expose HTTP endpoints
 ----------------------------
 
@@ -135,3 +167,8 @@ To build the artifacts into pkg/:
     # Build the Killbill plugin in the pkg/ directory
     # The <plugin_name>-<plugin-version>/ directory is used as a staging directory
     rake killbill:package
+
+
+In case the templates behind the generator change and you want to upgrade your plugin, you can re-run the above
+command on top of your existing code. For each file, you'll be prompted whether you want to overwrite it, show a
+diff, etc.

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.1.0

data/generators/active_merchant/active_merchant_generator.rb

@@ -0,0 +1,38 @@
+require 'thor/group'
+require 'yaml'
+
+class ActiveMerchantGenerator < KillbillGenerator
+  source_root File.expand_path('..', __FILE__)
+
+  def generate
+    render_templates '/templates/{*,.*}.rb', ['config.yml', 'plugin.gemspec'], nil, false
+    template 'templates/config.yml.rb', "#{output_path}/#{identifier}.yml"
+    template 'templates/plugin.gemspec.rb', "#{output_path}/killbill-#{identifier}.gemspec"
+
+    render_templates '/templates/lib/{*,.*}.rb', ['plugin.rb'], "lib/#{identifier}"
+    template 'templates/lib/plugin.rb', "#{output_path}/lib/#{identifier}.rb"
+
+    render_templates '/templates/lib/models/{*,.*}.rb', [], "lib/#{identifier}/models"
+
+    copy_file 'templates/lib/views/form.erb', "#{output_path}/lib/#{identifier}/views/form.erb"
+
+    template 'templates/db/ddl.sql.rb', "#{output_path}/db/ddl.sql"
+    template 'templates/db/schema.rb', "#{output_path}/db/schema.rb"
+
+    template 'templates/spec/spec_helper.rb', "#{output_path}/spec/spec_helper.rb"
+    template 'templates/spec/base_plugin_spec.rb', "#{output_path}/spec/#{identifier}/base_plugin_spec.rb"
+    template 'templates/spec/integration_spec.rb', "#{output_path}/spec/#{identifier}/remote/integration_spec.rb"
+  end
+
+  protected
+
+  def render_templates(glob, to_exclude = [], extra_dir = nil, keep_rb_extension = true)
+    Dir[File.dirname(__FILE__) + glob].each do |f|
+      filename = File.basename(f, keep_rb_extension ? '' : '.rb')
+
+      next if to_exclude.include? filename
+
+      template f, extra_dir ? "#{output_path}/#{extra_dir}/#{filename}" : "#{output_path}/#{filename}"
+    end
+  end
+end

data/generators/active_merchant/templates/.gitignore.rb

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.jbundler
+Jarfile.lock
+Gemfile.lock
+
+.DS_Store
+
+# Build directory
+killbill-<%= identifier %>/
+
+# Testing database
+test.db
+
+target
+pom.xml.asc
+
+.idea/

data/generators/active_merchant/templates/.travis.yml.rb

@@ -0,0 +1,19 @@
+language: ruby
+
+notifications:
+  email:
+    - kill-bill-commits@googlegroups.com
+
+rvm:
+  - jruby-19mode
+  - jruby-20mode
+  - jruby-head
+
+jdk:
+  - openjdk6
+  - openjdk7
+  - oraclejdk7
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head

data/generators/active_merchant/templates/Gemfile.rb

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/generators/active_merchant/templates/Jarfile.rb

@@ -0,0 +1,6 @@
+jar 'org.kill-bill.billing:killbill-api', '0.8.2'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-notification', '0.6.4'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-payment', '0.6.4'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-currency', '0.6.4'
+jar 'org.kill-bill.billing:killbill-util:tests', '0.9.1'
+jar 'javax.servlet:javax.servlet-api', '3.0.1'

data/generators/active_merchant/templates/LICENSE.rb

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 The Billing Project, LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/generators/active_merchant/templates/NEWS.rb

@@ -0,0 +1,2 @@
+0.0.1
+    Initial release