killbill-client 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc0cb0821172a8b139995e9ce22d57c2e349ea5c
-  data.tar.gz: 28cfe0861830615b3a03219191054047e10680e6
+  metadata.gz: fa7b9310db3e2077873d4782699d17a7b842095d
+  data.tar.gz: 6265f9b80356fd96ed2c8d68b42eb55a33963683
 SHA512:
-  metadata.gz: d54c5903d5a5bf5a157d6798223d00d4b02aebd0d84be8121cd54898e13353cc290c4247613a44c1deed9b9dc8983f4703e222627dcd58401e68f101fdf1fd9d
-  data.tar.gz: 7ffde046dcaf4f470b605cde726d583c0cb0fca9873a52d22f7f09f5a95cf399e7f20593fd19656e66c843a171b269d9da240386657b9a370c4a77f9d91fde9e
+  metadata.gz: 67abf97671a18f027a2df4761201f0181627787af8f12e2e5a45fe4c02f5f58f4c1f7fee9d0508c8f7352348ce3133c6496c8a2a97863b1e986e676c1751da67
+  data.tar.gz: 54680415c950f005332ba9d161ee6a0f8c42091faf495c64cd3eabccbf92b9ed5fe4b692a2f9a3c90e4f2543b5907da649847b90b558217f14c501074006fba5

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 
+sudo: false
+
 notifications:
   email:
     - kill-bill-commits@googlegroups.com

data/README.md

@@ -4,11 +4,69 @@
 killbill-client-ruby
 ====================
 
-Kill Bill ruby library.
+Kill Bill Ruby client library.
+
+Installation
+------------
+
+Get the [killbill-client](https://rubygems.org/gems/killbill-client) gem:
+
+```
+gem install killbill-client
+```
+
+Alternatively, add the dependency in your Gemfile:
+
+```
+gem 'killbill-client', '~> 0.24'
+```
 
 Examples
 --------
 
+Here is a snippet creating your first account and subscription:
+
+```ruby
+require 'killbill_client'
+
+KillBillClient.url = 'http://127.0.0.1:8080'
+
+# Multi-tenancy and RBAC credentials
+options = {
+  :username => 'admin',
+  :password => 'password',
+  :api_key => 'bob',
+  :api_secret => 'lazar'
+}
+
+# Audit log data
+user = 'me'
+reason = 'Going through my first tutorial'
+comment = 'I like it!'
+
+# Create an account
+account = KillBillClient::Model::Account.new
+account.name = 'John Doe'
+account.first_name_length = 4
+account.external_key = 'john-doe'
+account.currency = 'USD'
+account = account.create(user, reason, comment, options)
+
+# Add a subscription
+subscription = KillBillClient::Model::Subscription.new
+subscription.account_id = account.account_id
+subscription.product_name = 'Sports'
+subscription.product_category = 'BASE'
+subscription.billing_period = 'MONTHLY'
+subscription.price_list = 'DEFAULT'
+subscription = subscription.create(user, reason, comment, nil, true, options)
+
+# List invoices
+account.invoices(true, options).each do |invoice|
+  puts invoice.inspect
+end
+```
+
 The following script will tag a list of accounts with OVERDUE_ENFORCEMENT_OFF and AUTO_PAY_OFF:
 
 ```ruby
@@ -29,6 +87,8 @@ File.open(File.dirname(__FILE__) + '/accounts.txt').readlines.map(&:chomp).each
 end
 ```
 
+We have lots of examples in our [integration tests](https://github.com/killbill/killbill-integration-tests).
+
 Tests
 -----
 

data/lib/killbill_client/models/transaction.rb

@@ -56,9 +56,15 @@ module KillBillClient
       end
 
       def capture(user = nil, reason = nil, comment = nil, options = {})
+        query_map = {
+        }
+        if options.include? :controlPluginNames
+          query_map[:controlPluginName] = options.delete(:controlPluginNames)
+        end
+
         created_transaction = self.class.post "#{follow_up_path(payment_id)}",
                                               to_json,
-                                              {},
+                                              query_map,
                                               {
                                                   :user    => user,
                                                   :reason  => reason,
@@ -68,9 +74,15 @@ module KillBillClient
       end
 
       def refund(user = nil, reason = nil, comment = nil, options = {})
+
+        query_map = {
+        }
+        if options.include? :controlPluginNames
+          query_map[:controlPluginName] = options.delete(:controlPluginNames)
+        end
         created_transaction = self.class.post "#{follow_up_path(payment_id)}/refunds",
                                               to_json,
-                                              {},
+                                              query_map,
                                               {
                                                   :user    => user,
                                                   :reason  => reason,
@@ -80,9 +92,15 @@ module KillBillClient
       end
 
       def void(user = nil, reason = nil, comment = nil, options = {})
+
+        query_map = {
+        }
+        if options.include? :controlPluginNames
+          query_map[:controlPluginName] = options.delete(:controlPluginNames)
+        end
         created_transaction = self.class.delete "#{follow_up_path(payment_id)}",
                                                 to_json,
-                                                {},
+                                                query_map,
                                                 {
                                                     :user    => user,
                                                     :reason  => reason,
@@ -92,9 +110,15 @@ module KillBillClient
       end
 
       def chargeback(user = nil, reason = nil, comment = nil, options = {})
+
+        query_map = {
+        }
+        if options.include? :controlPluginNames
+          query_map[:controlPluginName] = options.delete(:controlPluginNames)
+        end
         created_transaction = self.class.post "#{follow_up_path(payment_id)}/chargebacks",
                                               to_json,
-                                              {},
+                                              query_map,
                                               {
                                                   :user    => user,
                                                   :reason  => reason,
@@ -105,6 +129,7 @@ module KillBillClient
 
       private
 
+
       def follow_up_path(payment_id)
         path = Payment::KILLBILL_API_PAYMENTS_PREFIX
         path += "/#{payment_id}" unless payment_id.nil?

data/lib/killbill_client/version.rb

@@ -1,7 +1,7 @@
 module KillBillClient
   module Version
     MAJOR = 0
-    MINOR = 29
+    MINOR = 30
     PATCH = 0
     PRE = nil
 

metadata

@@ -1,65 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: killbill-client
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Killbill core team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-29 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.0.0
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
+  prerelease: false
+  type: :development
 description: An API client library for Kill Bill.
 email: killbilling-users@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -185,33 +185,26 @@ homepage: http://www.killbilling.org
 licenses:
 - Apache License (2.0)
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
-- "--exclude"
-- "."
+- --exclude
+- .
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
 summary: Kill Bill client library.
-test_files:
-- spec/killbill_client/base_uri_spec.rb
-- spec/killbill_client/model_relation_spec.rb
-- spec/killbill_client/remote/api_spec.rb
-- spec/killbill_client/remote/model_spec.rb
-- spec/killbill_client/resource_spec.rb
-- spec/killbill_client/resources_spec.rb
-- spec/spec_helper.rb
+test_files: []