killbill-client 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fa054d6429ec8d29d211fe1d581ecd3e1cb8f90
-  data.tar.gz: 9658639f68539f0f6d7ea5d77b96027e3485045d
+  metadata.gz: 7c3cd7bf2ed2d8a9477660ab9e345657fa331eb3
+  data.tar.gz: b249ca8abe133b75a6f38e23364cbef0a79e5629
 SHA512:
-  metadata.gz: 058d93cbc47043cfbaa068f1c15e09ff1c48386768b2af5d85d8a9e903d914d8040feaefe4fbf1b510deeb63e000a2d638a42cab10085f513ada53d90b9f3ecb
-  data.tar.gz: aad960ae930ae5057c3c4b3a1a9a0dd87737dafbd588e8572bd5beee1b2e70a1d14954f2f2a681f1d48583b3ecaeb1df50dfec882be72829af89745b757ba41b
+  metadata.gz: 58171e8f433fde25fd3d146586f4bcbe5f1f647ff7087162cdba2aa368c9b100c8797bc68b029f7b7f04636196548748a6b328783974b66c57f09c4a5a1ed646
+  data.tar.gz: 8df7abc43524e0b912cd2216ab1bdec510f609469ee08298169b235a57f46abc2a6532379b18ceeb1b7b9bce4a2f02e3378c9271984c7c39327ac93a70bd608d

data/lib/killbill_client.rb

@@ -41,10 +41,15 @@ module KillBillClient
 
     attr_writer :url
 
-    # Tenant key/password. Optional.
+    # Tenant key/secret. Optional.
     attr_accessor :api_key
     attr_accessor :api_secret
 
+    # RBAC username/password. Optional.
+    # These can also be configured on a per request basis
+    attr_accessor :username
+    attr_accessor :password
+
     # @return [String, nil] A default currency.
     def default_currency
       return @default_currency if defined? @default_currency

data/lib/killbill_client/api/net_http_adapter.rb

@@ -47,11 +47,21 @@ module KillBillClient
           end
           request = METHODS[method].new uri.request_uri, head
 
-          # Configure auth, if enabled
+          # Configure multi-tenancy headers, if enabled
           if KillBillClient.api_key and KillBillClient.api_secret
-            request.basic_auth(*[KillBillClient.api_key, KillBillClient.api_secret].flatten[0, 2])
-            request['X-Killbill-ApiKey'] = KillBillClient.api_key
-            request['X-Killbill-ApiSecret'] = KillBillClient.api_secret
+            request['X-Killbill-ApiKey'] = options[:api_key] || KillBillClient.api_key
+            request['X-Killbill-ApiSecret'] = options[:api_secret] || KillBillClient.api_secret
+          end
+
+          # Configure RBAC, if enabled
+          username = options[:username] || KillBillClient.username
+          password = options[:password] || KillBillClient.password
+          if username and password
+            request.basic_auth(*[username, password].flatten[0, 2])
+          end
+          session_id = options[:session_id]
+          if session_id
+            request['Cookie'] = "JSESSIONID=#{session_id}"
           end
 
           if options[:body]

data/lib/killbill_client/models/account.rb

@@ -4,16 +4,17 @@ module KillBillClient
       KILLBILL_API_ACCOUNTS_PREFIX = "#{KILLBILL_API_PREFIX}/accounts"
 
       class << self
-        def find_by_id(account_id, with_balance = false, with_balance_and_cba = false)
+        def find_by_id(account_id, with_balance = false, with_balance_and_cba = false, options = {})
           get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}",
               {
                   :accountWithBalance => with_balance,
                   :accountWithBalanceAndCBA => with_balance_and_cba
-              }
+              },
+              options
         end
       end
 
-      def create(user = nil, reason = nil, comment = nil)
+      def create(user = nil, reason = nil, comment = nil, options = {})
         created_account = self.class.post KILLBILL_API_ACCOUNTS_PREFIX,
                                           to_json,
                                           {},
@@ -21,27 +22,27 @@ module KillBillClient
                                               :user => user,
                                               :reason => reason,
                                               :comment => comment,
-                                          }
+                                          }.merge(options)
         created_account.refresh
       end
 
-      def payments
+      def payments(options = {})
         self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/payments",
                        {},
-                       {},
+                       options,
                        Payment
       end
 
-      def tags(audit = 'NONE')
+      def tags(audit = 'NONE', options = {})
         self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/tags",
                        {
                            :audit => audit
                        },
-                       {},
+                       options,
                        Tag
       end
 
-      def add_tag(tag_name, user = nil, reason = nil, comment = nil)
+      def add_tag(tag_name, user = nil, reason = nil, comment = nil, options = {})
         tag_definition = TagDefinition.find_by_name(tag_name)
         if tag_definition.nil?
           tag_definition = TagDefinition.new
@@ -59,12 +60,12 @@ module KillBillClient
                                           :user => user,
                                           :reason => reason,
                                           :comment => comment,
-                                      },
+                                      }.merge(options),
                                       Tag
         created_tag.refresh
       end
 
-      def remove_tag(tag_name, user = nil, reason = nil, comment = nil)
+      def remove_tag(tag_name, user = nil, reason = nil, comment = nil, options = {})
         tag_definition = TagDefinition.find_by_name(tag_name)
         return nil if tag_definition.nil?
 
@@ -76,7 +77,7 @@ module KillBillClient
                               :user => user,
                               :reason => reason,
                               :comment => comment,
-                          }
+                          }.merge(options)
       end
     end
   end

data/lib/killbill_client/models/account_timeline.rb

@@ -8,11 +8,12 @@ module KillBillClient
       has_many :invoices, KillBillClient::Model::Invoice
 
       class << self
-        def find_by_account_id(account_id, audit = 'MINIMAL')
+        def find_by_account_id(account_id, audit = 'MINIMAL', options = {})
           get "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/timeline",
               {
                 :audit => audit
-              }
+              },
+              options
         end
       end
     end

data/lib/killbill_client/models/invoice.rb

@@ -10,11 +10,12 @@ module KillBillClient
       create_alias :bundle_keys, :external_bundle_keys
 
       class << self
-        def find_by_id_or_number(id_or_number, with_items = true)
+        def find_by_id_or_number(id_or_number, with_items = true, options = {})
           get "#{KILLBILL_API_INVOICES_PREFIX}/#{id_or_number}",
               {
                 :withItems => with_items
-              }
+              },
+              options
         end
       end
     end

data/lib/killbill_client/models/invoice_item.rb

@@ -1,7 +1,7 @@
 module KillBillClient
   module Model
     class InvoiceItem < InvoiceItemAttributesSimple
-      def create(user = nil, reason = nil, comment = nil)
+      def create(user = nil, reason = nil, comment = nil, options = {})
         created_invoice_item = self.class.post "#{Invoice::KILLBILL_API_INVOICES_PREFIX}/charges",
                                                to_json,
                                                {},
@@ -9,7 +9,7 @@ module KillBillClient
                                                    :user => user,
                                                    :reason => reason,
                                                    :comment => comment,
-                                               }
+                                               }.merge(options)
         created_invoice_item.refresh(Invoice)
       end
     end

data/lib/killbill_client/models/models.rb

@@ -1,4 +1,5 @@
 require 'killbill_client/models/resource'
+require 'killbill_client/models/resources'
 
 require 'killbill_client/models/gen/require_gen'
 
@@ -16,8 +17,10 @@ require 'killbill_client/models/account'
 require 'killbill_client/models/invoice'
 require 'killbill_client/models/payment'
 require 'killbill_client/models/payment_method'
+require 'killbill_client/models/security'
 require 'killbill_client/models/tag'
 require 'killbill_client/models/tag_definition'
+require 'killbill_client/models/tenant'
 require 'killbill_client/models/account_timeline'
 
 module KillBillClient

data/lib/killbill_client/models/payment_method.rb

@@ -4,28 +4,31 @@ module KillBillClient
       KILLBILL_API_PAYMENT_METHODS_PREFIX = "#{KILLBILL_API_PREFIX}/paymentMethods"
 
       class << self
-        def find_by_id(payment_method_id, with_plugin_info = false)
+        def find_by_id(payment_method_id, with_plugin_info = false, options = {})
           get "#{KILLBILL_API_PAYMENT_METHODS_PREFIX}/#{payment_method_id}",
               {
                   :withPluginInfo => with_plugin_info
-              }
+              },
+              options
         end
 
-        def find_all_by_account_id(account_id, with_plugin_info = false)
+        def find_all_by_account_id(account_id, with_plugin_info = false, options = {})
           get "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/paymentMethods",
               {
                   :withPluginInfo => with_plugin_info
-              }
+              },
+              options
         end
 
-        def find_all_by_search_key(search_key, with_plugin_info = false)
+        def find_all_by_search_key(search_key, with_plugin_info = false, options)
           get "#{KILLBILL_API_PAYMENT_METHODS_PREFIX}/search/#{search_key}",
               {
                   :withPluginInfo => with_plugin_info
-              }
+              },
+              options
         end
 
-        def set_default(payment_method_id, account_id, user = nil, reason = nil, comment = nil)
+        def set_default(payment_method_id, account_id, user = nil, reason = nil, comment = nil, options = {})
           put "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/paymentMethods/#{payment_method_id}/setDefault",
               nil,
               {},
@@ -33,10 +36,10 @@ module KillBillClient
                   :user => user,
                   :reason => reason,
                   :comment => comment,
-              }
+              }.merge(options)
         end
 
-        def destroy(payment_method_id, set_auto_pay_off = false, user = nil, reason = nil, comment = nil)
+        def destroy(payment_method_id, set_auto_pay_off = false, user = nil, reason = nil, comment = nil, options = {})
           delete "#{KILLBILL_API_PAYMENT_METHODS_PREFIX}/#{payment_method_id}",
                  {
                      :deleteDefaultPmWithAutoPayOff => set_auto_pay_off
@@ -45,11 +48,11 @@ module KillBillClient
                      :user => user,
                      :reason => reason,
                      :comment => comment,
-                 }
+                 }.merge(options)
         end
       end
 
-      def create(set_default = true, user = nil, reason = nil, comment = nil)
+      def create(set_default = true, user = nil, reason = nil, comment = nil, options = {})
         created_pm = self.class.post "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/paymentMethods",
                                      to_json,
                                      {
@@ -59,12 +62,12 @@ module KillBillClient
                                          :user => user,
                                          :reason => reason,
                                          :comment => comment,
-                                     }
+                                     }.merge(options)
         created_pm.refresh
       end
 
-      def destroy(set_auto_pay_off = false, user = nil, reason = nil, comment = nil)
-        self.class.destroy(payment_method_id, set_auto_pay_off, user, reason, comment)
+      def destroy(set_auto_pay_off = false, user = nil, reason = nil, comment = nil, options = {})
+        self.class.destroy(payment_method_id, set_auto_pay_off, user, reason, comment, options)
       end
 
       def plugin_info=(info)

data/lib/killbill_client/models/resource.rb

@@ -4,6 +4,10 @@ module KillBillClient
   module Model
     class Resource
 
+      attr_reader :etag,
+                  :session_id,
+                  :response
+
       KILLBILL_API_PREFIX = '/1.0/kb/'
       @@attribute_names = {}
 
@@ -45,7 +49,8 @@ module KillBillClient
             response.body
           when %r{application/json}
             record = from_json resource_class, response.body
-            record.instance_eval { @etag, @response = response['ETag'], response }
+            session_id = extract_session_id(response)
+            record.instance_eval { @etag, @session_id, @response = response['ETag'], session_id, response }
             record
           else
             raise ArgumentError, "#{response['Content-Type']} is not supported by the library"
@@ -64,9 +69,14 @@ module KillBillClient
           data = JSON.parse json
 
           if data.is_a? Array
-            records = []
+            records = Resources.new
             data.each do |data_element|
-              records << instantiate_record_from_json(resource_class, data_element)
+              if data_element.is_a? Enumerable
+                records << instantiate_record_from_json(resource_class, data_element)
+              else
+                # Value (e.g. String)
+                records << data_element
+              end
             end
             records
           else
@@ -103,7 +113,7 @@ module KillBillClient
 
           record
         end
-        
+
         def attribute(name)
           self.send('attr_accessor', name.to_sym)
 
@@ -130,7 +140,7 @@ module KillBillClient
 
          def has_one(attr_name, type = nil)
            send("attr_accessor", attr_name.to_sym)
-           
+
            #add it to attribute_names
            @@attribute_names[self.name] = {} unless @@attribute_names[self.name]
            @@attribute_names[self.name][attr_name.to_sym] = { :type => type, :cardinality => :one }
@@ -143,6 +153,20 @@ module KillBillClient
            alias_method "#{new_name}=".to_sym, "#{old_name}=".to_sym #setter
          end
 
+         # Extract the session id from a response
+         def extract_session_id(response)
+           # The Set-Cookie header looks like
+           # "set-cookie"=>["JSESSIONID=16; Path=/; HttpOnly", "rememberMe=deleteMe; Path=/; Max-Age=0; Expires=Sat, 17-Aug-2013 23:39:37 GMT"],
+           session_cookie = response['set-cookie']
+           unless session_cookie.nil?
+             session_cookie.split(';').each do |chunk|
+               chunk.strip!
+               key, value = chunk.split('=')
+               return value if key == 'JSESSIONID'
+             end
+           end
+           nil
+         end
        end #end self methods
 
        # Set on create call

data/lib/killbill_client/models/resources.rb

@@ -0,0 +1,11 @@
+module KillBillClient
+  module Model
+    class Resources < ::Array
+
+     attr_reader :etag,
+                 :session_id,
+                 :response
+
+    end
+  end
+end

data/lib/killbill_client/models/security.rb

@@ -0,0 +1,15 @@
+module KillBillClient
+  module Model
+    class Security < Resource
+      KILLBILL_API_SECURITY_PREFIX = "#{KILLBILL_API_PREFIX}/security"
+
+      class << self
+        def find_permissions(options = {})
+          get "#{KILLBILL_API_SECURITY_PREFIX}/permissions",
+              {},
+              options
+        end
+      end
+    end
+  end
+end

data/lib/killbill_client/models/tag_definition.rb

@@ -4,16 +4,18 @@ module KillBillClient
       KILLBILL_API_TAG_DEFINITIONS_PREFIX = "#{KILLBILL_API_PREFIX}/tagDefinitions"
 
       class << self
-        def all
-          get KILLBILL_API_TAG_DEFINITIONS_PREFIX
+        def all(options = {})
+          get KILLBILL_API_TAG_DEFINITIONS_PREFIX,
+              {},
+              options
         end
 
-        def find_by_name(name)
-          self.all.select { |tag_definition| tag_definition.name == name }.first
+        def find_by_name(name, options = {})
+          self.all(options).select { |tag_definition| tag_definition.name == name }.first
         end
       end
 
-      def create(user = nil, reason = nil, comment = nil)
+      def create(user = nil, reason = nil, comment = nil, options = {})
         created_tag_definition = self.class.post KILLBILL_API_TAG_DEFINITIONS_PREFIX,
                                                  to_json,
                                                  {},
@@ -21,7 +23,7 @@ module KillBillClient
                                                      :user => user,
                                                      :reason => reason,
                                                      :comment => comment,
-                                                 }
+                                                 }.merge(options)
         created_tag_definition.refresh
       end
     end

data/lib/killbill_client/models/tenant.rb

@@ -0,0 +1,33 @@
+module KillBillClient
+  module Model
+    class Tenant < TenantAttributes
+      KILLBILL_API_TENANTS_PREFIX = "#{KILLBILL_API_PREFIX}/tenants"
+
+      class << self
+        def find_by_id(tenant_id, options = {})
+          get "#{KILLBILL_API_TENANTS_PREFIX}/#{tenant_id}",
+              {},
+              options
+        end
+
+        def find_by_api_key(api_key, options = {})
+          get "#{KILLBILL_API_TENANTS_PREFIX}/?apiKey=#{api_key}",
+              {},
+              options
+        end
+      end
+
+      def create(user = nil, reason = nil, comment = nil, options = {})
+        created_tenant = self.class.post KILLBILL_API_TENANTS_PREFIX,
+                                         to_json,
+                                         {},
+                                         {
+                                             :user => user,
+                                             :reason => reason,
+                                             :comment => comment,
+                                         }.merge(options)
+        created_tenant.refresh
+      end
+    end
+  end
+end

data/lib/killbill_client/version.rb

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

data/spec/killbill_client/remote/model_spec.rb

@@ -123,4 +123,32 @@ describe KillBillClient::Model do
     found_tag_definition.description.should == tag_definition.description
     found_tag_definition.is_control_tag.should be_false
   end
+
+  it 'should manipulate tenants' do
+    api_key = Time.now.to_i.to_s
+    api_secret = 'S4cr3333333t!!!!!!lolz'
+
+    tenant = KillBillClient::Model::Tenant.new
+    tenant.api_key = api_key
+    tenant.api_secret = api_secret
+
+    # Create and verify the tenant
+    tenant = tenant.create('KillBill Spec test')
+    tenant.api_key.should == api_key
+    tenant.tenant_id.should_not be_nil
+
+    # Try to retrieve it by id
+    tenant = KillBillClient::Model::Tenant.find_by_id tenant.tenant_id
+    tenant.api_key.should == api_key
+
+    # Try to retrieve it by api key
+    tenant = KillBillClient::Model::Tenant.find_by_api_key tenant.api_key
+    tenant.api_key.should == api_key
+  end
+
+  #it 'should retrieve users permissions' do
+  #  # Tough to verify as it depends on the Kill Bill configuration
+  #  puts KillBillClient::Model::Security.find_permissions
+  #  puts KillBillClient::Model::Security.find_permissions(:username => 'admin', :password => 'password')
+  #end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Killbill core team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-13 00:00:00.000000000 Z
+date: 2013-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -117,11 +117,14 @@ files:
 - lib/killbill_client/models/payment_method.rb
 - lib/killbill_client/models/refund.rb
 - lib/killbill_client/models/resource.rb
+- lib/killbill_client/models/resources.rb
+- lib/killbill_client/models/security.rb
 - lib/killbill_client/models/subscription_deleted_event.rb
 - lib/killbill_client/models/subscription_event.rb
 - lib/killbill_client/models/subscription_new_event.rb
 - lib/killbill_client/models/tag.rb
 - lib/killbill_client/models/tag_definition.rb
+- lib/killbill_client/models/tenant.rb
 - lib/killbill_client/utils.rb
 - lib/killbill_client/version.rb
 - lib/rails/generators/killbill_client/config_generator.rb