killbill-client 0.5.0 → 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afc7f7b3206167692cc8e770b0d94c7dee22c3fc
+  data.tar.gz: 36f151c0680ad5b724e07f24ec285b3ad6fe7d65
+SHA512:
+  metadata.gz: ff6427c84fc9e582af9f2439793276478b883feb49c19fbaf4e273b7f3fd9de57342503f1cd0ef94eeab2fadb0a0d0d8cece83ed3643d94f9cfbc62024ccd766
+  data.tar.gz: d64f2c1ff40af7acfe76963cba4ca024b021809bc2e200308c45302443afe58579fb02b54dae552aa297a74ff3d7d8c176cf7e1ec6ffdc80ac88915aac9eddc4

data/lib/killbill_client/models/payment_method.rb

@@ -20,12 +20,20 @@ module KillBillClient
               options
         end
 
-        def find_in_batches_by_search_key(search_key, offset = 0, limit = 100, with_plugin_info = false, options = {})
+        def find_in_batches(offset = 0, limit = 100, options = {})
+          get "#{KILLBILL_API_PAYMENT_METHODS_PREFIX}/#{Resource::KILLBILL_API_PAGINATION_PREFIX}",
+              {
+                  :offset => offset,
+                  :limit => limit
+              },
+              options
+        end
+
+        def find_in_batches_by_search_key(search_key, offset = 0, limit = 100, options = {})
           get "#{KILLBILL_API_PAYMENT_METHODS_PREFIX}/search/#{search_key}",
               {
                   :offset => offset,
-                  :limit => limit,
-                  :withPluginInfo => with_plugin_info
+                  :limit => limit
               },
               options
         end

data/lib/killbill_client/models/resource.rb

@@ -4,7 +4,8 @@ module KillBillClient
   module Model
     class Resource
 
-      attr_reader :etag,
+      attr_reader :clazz,
+                  :etag,
                   :session_id,
                   :response
 
@@ -53,10 +54,12 @@ module KillBillClient
             record = from_json resource_class, response.body
             session_id = extract_session_id(response)
             record.instance_eval {
+                @clazz = resource_class
                 @etag = response['ETag']
                 @session_id = session_id
-                @pagination_nb_results = response['X-Killbill-Pagination-NbResults']
-                @pagination_total_nb_results = response['X-Killbill-Pagination-TotalNbResults']
+                @pagination_max_nb_records = response['X-Killbill-Pagination-MaxNbRecords'].to_i unless response['X-Killbill-Pagination-MaxNbRecords'].nil?
+                @pagination_total_nb_records = response['X-Killbill-Pagination-TotalNbRecords'].to_i unless response['X-Killbill-Pagination-TotalNbRecords'].nil?
+                @pagination_next_page = response['X-Killbill-Pagination-NextPageUri']
                 @response = response
             }
             record

data/lib/killbill_client/models/resources.rb

@@ -2,12 +2,25 @@ module KillBillClient
   module Model
     class Resources < ::Array
 
-     attr_reader :etag,
-                 :session_id,
-                  :pagination_nb_results,
-                  :pagination_total_nb_results,
-                 :response
+      attr_reader :clazz,
+                  :etag,
+                  :session_id,
+                  :pagination_max_nb_records,
+                  :pagination_total_nb_records,
+                  :pagination_next_page
+                  :response
 
+      # Same as .each, but fetch remaining pages as we go
+      def each_in_batches(&block)
+        each(&block)
+
+        # Non-pagination usecase or last page reached
+        return if @pagination_next_page.nil?
+
+        # Query the server for the next page
+        resources = Resource.get(@pagination_next_page, {}, {}, @clazz)
+        resources.each_in_batches(&block)
+      end
     end
   end
 end

data/lib/killbill_client/version.rb

@@ -2,7 +2,7 @@ module KillBillClient
   module Version
     MAJOR = 0
     MINOR = 5
-    PATCH = 0
+    PATCH = 1
     PRE = nil
 
     VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join('.').freeze

data/spec/killbill_client/remote/model_spec.rb

@@ -31,6 +31,34 @@ describe KillBillClient::Model do
     account.external_key.should == external_key
     account.payment_method_id.should be_nil
 
+    # Try to retrieve it (bis repetita placent)
+    accounts = KillBillClient::Model::Account.find_in_batches
+    # Can't test equality if the remote server has extra data
+    accounts.pagination_total_nb_records.should >= 1
+    accounts.pagination_max_nb_records.should >= 1
+    accounts.size.should >= 1
+    # If the remote server has lots of data, we need to page through the results (good test!)
+    found = nil
+    accounts.each_in_batches do |account|
+      found = account if account.external_key == external_key
+      break unless found.nil?
+    end
+    found.should_not be_nil
+
+    # Try to retrieve it via the search API
+    accounts = KillBillClient::Model::Account.find_in_batches_by_search_key(account.name)
+    # Can't test equality if the remote server has extra data
+    accounts.pagination_total_nb_records.should >= 1
+    accounts.pagination_max_nb_records.should >= 1
+    accounts.size.should >= 1
+    # If the remote server has lots of data, we need to page through the results (good test!)
+    found = nil
+    accounts.each_in_batches do |account|
+      found = account if account.external_key == external_key
+      break unless found.nil?
+    end
+    found.should_not be_nil
+
     # Add/Remove a tag
     account.tags.size.should == 0
     account.add_tag('TEST', 'KillBill Spec test')
@@ -54,6 +82,20 @@ describe KillBillClient::Model do
     pm = KillBillClient::Model::PaymentMethod.find_by_id pm.payment_method_id, true
     pm.account_id.should == account.account_id
 
+    # Try to retrieve it (bis repetita placent)
+    pms = KillBillClient::Model::PaymentMethod.find_in_batches
+    # Can't test equality if the remote server has extra data
+    pms.pagination_total_nb_records.should >= 1
+    pms.pagination_max_nb_records.should >= 1
+    pms.size.should >= 1
+    # If the remote server has lots of data, we need to page through the results (good test!)
+    found = nil
+    pms.each_in_batches do |payment_method|
+      found = payment_method if payment_method.payment_method_id == pm.payment_method_id
+      break unless found.nil?
+    end
+    found.should_not be_nil
+
     account = KillBillClient::Model::Account.find_by_id account.account_id
     account.payment_method_id.should == pm.payment_method_id
 

data/spec/killbill_client/resources_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe KillBillClient::Model::Resources do
+  it 'should respect the next page url when calling the .each_in_batches method' do
+    stuff = KillBillClient::Model::Resources.new
+    1.upto(10).each { |i| stuff << i }
+    stuff.size.should == 10
+
+    idx = 1
+    stuff.each_in_batches do |i|
+      i.should == idx
+      idx += 1
+    end
+  end
+end

metadata

@@ -1,64 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: killbill-client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
-  prerelease:
+  version: 0.5.1
 platform: ruby
 authors:
 - Killbill core team
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: 10.0.0
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: 10.0.0
-    none: false
-  prerelease: false
-  type: :development
 - !ruby/object:Gem::Dependency
   name: rspec
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
-    none: false
-  prerelease: false
-  type: :development
 description: An API client library for Kill Bill.
 email: killbilling-users@googlegroups.com
 executables: []
@@ -139,11 +132,13 @@ files:
 - spec/killbill_client/model_relation_spec.rb
 - spec/killbill_client/remote/api_spec.rb
 - spec/killbill_client/remote/model_spec.rb
+- spec/killbill_client/resources_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.killbilling.org
 licenses:
 - Apache License (2.0)
-post_install_message:
+metadata: {}
+post_install_message: 
 rdoc_options:
 - --exclude
 - .
@@ -154,24 +149,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.6
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
       version: '0'
-      hash: 2
-  none: false
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
-specification_version: 3
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
 summary: Kill Bill client library.
 test_files:
 - spec/killbill_client/model_relation_spec.rb
 - spec/killbill_client/remote/api_spec.rb
 - spec/killbill_client/remote/model_spec.rb
+- spec/killbill_client/resources_spec.rb
 - spec/spec_helper.rb