zoho_invoice 0.3.1 → 0.3.2

data/.gitignore

@@ -5,6 +5,8 @@
 .config
 .yardoc
 .rvmrc
+.ruby-version
+.ruby-gemset
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -38,6 +38,24 @@ homebase $ irb
  => "blahblahblahnumbersnstuff"
 ```
 
+## Client Setup
+
+One of the great things about zoho_invoice is the ability for clients to inherit from a global config and override it if need be.
+
+```
+homebase $ irb
+> require 'zoho_invoice'
+ => true
+> ZohoInvoice.authtoken = 'first_authtoken'
+ => "first_authtoken"
+> ZohoInvoice.apikey = 'first_apikey'
+ => "first_apikey"
+> client = ZohoInvoice::Client.new
+ => #<ZohoInvoice::Client:0x007f9e6cf274b8 @authtoken="first_authtoken", @scope="invoiceapi", @apikey="first_apikey", @client_options={:url=>"https://invoice.zoho.com"}>
+> another_client = ZohoInvoice::Client.new(:authtoken => "override_authtoken")
+ => #<ZohoInvoice::Client:0x007f9e6cf395a0 @authtoken="override_authtoken", @scope="invoiceapi", @apikey="first_apikey", @client_options={:url=>"https://invoice.zoho.com"}>
+```
+
 ## Usage
 
 ```ruby

data/lib/zoho_invoice/base.rb

@@ -138,6 +138,41 @@ module ZohoInvoice
 
     private
 
+    def self.retrieve(client, url)
+      klass = self.to_s.split('::').last
+      page = 1
+      query = {}
+      objects_to_hydrate = []
+
+      begin
+        result_hash = client.get(url, query).body
+        potential_objects = result_hash['Response'][klass + 's']
+
+        if potential_objects
+          potential_objects = potential_objects[klass]
+          if potential_objects.is_a? Hash
+            potential_objects = [potential_objects]
+          end
+          objects_to_hydrate += potential_objects
+        end
+
+        page_context = result_hash['Response']['PageContext']
+        if page_context
+          num_pages = page_context['Total_Pages'].to_i
+          page += 1
+          query = { :page => page }
+        else
+          num_pages = nil
+        end
+      end while num_pages && page <= num_pages
+
+      self.process_objects(client, objects_to_hydrate)
+    rescue Faraday::Error::ClientError => e
+      if e.response[:body]
+        raise ZohoInvoice::Error::ClientError.from_response(e.response)
+      end
+    end
+
     def self.process_objects(client, objects_to_hydrate)
       if objects_to_hydrate.nil?
         return []

data/lib/zoho_invoice/customer.rb

@@ -17,9 +17,22 @@ module ZohoInvoice
       :shipping_state,
       :shipping_country,
       :shipping_fax,
-      :customer_id
+      :customer_id,
+      :active
 
     has_many :contacts
 
+    def self.all(client, options = {})
+      self.all_active(client, options) + self.all_inactive(client, options)
+    end
+
+    def self.all_active(client, options = {})
+      retrieve(client, '/api/customers').each { |c| c.active = true }
+    end
+
+    def self.all_inactive(client, options = {})
+      retrieve(client, '/api/customers/inactive').each { |c| c.active = false }
+    end
+
   end
 end

data/lib/zoho_invoice/invoice.rb

@@ -22,14 +22,7 @@ module ZohoInvoice
     has_many :invoice_items
 
     def self.find_by_customer_id(client, id, options = {})
-      result_hash = client.get("/api/invoices/customer/#{id}").body
-      potential_objects = result_hash['Response']["Invoices"]
-      objects_to_hydrate = potential_objects["Invoice"] if potential_objects
-      self.process_objects(client, objects_to_hydrate)
-    rescue Faraday::Error::ClientError => e
-      if e.response[:body]
-        raise ZohoInvoice::Error::ClientError.from_response(e.response)
-      end
+      retrieve(client, "/api/invoices/customer/#{id}")
     end
 
     def self.find_by_multiple_customer_ids(client, ids, options={})
@@ -41,14 +34,7 @@ module ZohoInvoice
     end
 
     def self.find_unpaid_by_customer_id(client, id, options = {})
-      result_hash = client.get("/api/invoices/unpaid/customer/#{id}").body
-      potential_objects = result_hash['Response']["Invoices"]
-      objects_to_hydrate = potential_objects["Invoice"] if potential_objects
-      self.process_objects(client, objects_to_hydrate)
-    rescue Faraday::Error::ClientError => e
-      if e.response[:body]
-        raise ZohoInvoice::Error::ClientError.from_response(e.response)
-      end
+      retrieve(client, "/api/invoices/unpaid/customer/#{id}")
     end
 
     def self.find_unpaid_by_multiple_customer_ids(client, ids, options={})
@@ -59,5 +45,9 @@ module ZohoInvoice
       return new_hash
     end
 
+    def self.all(client)
+      retrieve(client, '/api/invoices')
+    end
+
   end
 end

data/lib/zoho_invoice/version.rb

@@ -1,3 +1,3 @@
 module ZohoInvoice
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/fixtures/successful_customers_response

@@ -0,0 +1,7 @@
+<Response>
+  <Customers uri='/api/customers'>
+    <Customer>
+      <CustomerID>1</CustomerID>
+    </Customer>
+  </Customers>
+</Response>

data/spec/fixtures/successful_multiple_customer_response

@@ -1,5 +1,5 @@
 <Response>
-  <Invoices uri='/api/views/invoices/customer/1234'>
+  <Invoices uri='/api/invoices/customer/1234'>
     <Invoice>
       <InvoiceID>1</InvoiceID>
       <Status>Open</Status>

data/spec/fixtures/successful_multiple_page_response_page_1

@@ -0,0 +1,19 @@
+<Response>
+  <Invoices uri='/api/invoices/customer/1234'>
+    <Invoice>
+      <InvoiceID>1</InvoiceID>
+      <Status>Open</Status>
+    </Invoice>
+    <Invoice>
+      <InvoiceID>2</InvoiceID>
+      <Status>Open</Status>
+    </Invoice>
+  </Invoices>
+  <PageContext>
+    <Page>1</Page>
+    <Per_Page>2</Per_Page>
+    <Total>3</Total>
+    <Total_Pages>2</Total_Pages>
+  </PageContext>
+</Response>
+

data/spec/fixtures/successful_multiple_page_response_page_2

@@ -0,0 +1,15 @@
+<Response>
+  <Invoices uri='/api/invoices/customer/1234'>
+    <Invoice>
+      <InvoiceID>3</InvoiceID>
+      <Status>Open</Status>
+    </Invoice>
+  </Invoices>
+  <PageContext>
+    <Page>2</Page>
+    <Per_Page>2</Per_Page>
+    <Total>3</Total>
+    <Total_Pages>2</Total_Pages>
+  </PageContext>
+</Response>
+

data/spec/fixtures/successful_single_customer_response

@@ -1,5 +1,5 @@
 <Response>
-  <Invoices uri='/api/views/invoices/customer/1234'>
+  <Invoices uri='/api/invoices/customer/1234'>
     <Invoice>
       <InvoiceID>1</InvoiceID>
       <Status>Open</Status>

data/spec/fixtures/successful_unpaid_multiple_customer_response

@@ -1,5 +1,5 @@
 <Response>
-  <Invoices uri='/api/views/invoices/unpaid/customer/1234'>
+  <Invoices uri='/api/invoices/unpaid/customer/1234'>
     <Invoice>
       <InvoiceID>1</InvoiceID>
       <Status>Open</Status>

data/spec/fixtures/successful_unpaid_single_customer_response

@@ -1,5 +1,5 @@
 <Response>
-  <Invoices uri='/api/views/invoices/unpaid/customer/1234'>
+  <Invoices uri='/api/invoices/unpaid/customer/1234'>
     <Invoice>
       <InvoiceID>1</InvoiceID>
       <Status>Open</Status>

data/spec/spec_helper.rb

@@ -53,6 +53,23 @@ def multiple_invoice_test(fixture_to_use, num_customers, method_to_test, method_
   end
 end
 
+def customer_test(path, fixture_to_use, num_customers, active, method_to_test, *args)
+  stub_get(path).
+    with(:query => default_credentials).
+    to_return(:status => 200, :body => fixture(fixture_to_use), :headers => {:content_type => 'application/xml'})
+  result = ZohoInvoice::Customer.send(method_to_test, args[0])
+  expect(a_get(path).with(:query => default_credentials)).to have_been_made
+  expect(result.class).to eq(Array)
+  expect(result.length).to eq(num_customers)
+  if num_customers > 0
+    result.each_with_index do |r, i|
+      expect(r.class).to eq(ZohoInvoice::Customer)
+      expect(r.customer_id).to eq((i+1).to_s)
+      expect(r.active).to be(active)
+    end
+  end
+end
+
 def error_test(path, fixture_to_use, method_to_test, message, code, response_status, http_status, *args)
   stub_get(path).
     with(:query => default_credentials).

data/spec/zoho_invoice/customer_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe ZohoInvoice::Customer do
+  describe "retrieving customers" do
+    before do
+      @client = ZohoInvoice::Client.new(default_credentials)
+    end
+
+    it "should return an array of active customers" do
+      customer_test('/api/customers', 'successful_customers_response', 1, true, :all_active, @client)
+    end
+
+    it "should return an array of inactive customers" do
+      customer_test('/api/customers/inactive', 'successful_customers_response', 1, false, :all_inactive, @client)
+    end
+
+    it "should return an array of all customers" do
+      stub_get('/api/customers').
+        with(:query => default_credentials).
+        to_return(:status => 200, :body => fixture('successful_customers_response'), :headers => {:content_type => 'application/xml'})
+
+      stub_get('/api/customers/inactive').
+        with(:query => default_credentials).
+        to_return(:status => 200, :body => fixture('successful_customers_response'), :headers => {:content_type => 'application/xml'})
+
+      result = ZohoInvoice::Customer.send('all', @client)
+      expect(a_get('/api/customers').with(:query => default_credentials)).to have_been_made
+      expect(a_get('/api/customers/inactive').with(:query => default_credentials)).to have_been_made
+      expect(result.class).to eq(Array)
+      expect(result.length).to eq(2)
+
+      result.each_with_index do |r, i|
+        expect(r.class).to eq(ZohoInvoice::Customer)
+        expect(r.active.to_s).to match(/true|false/)
+      end
+    end
+  end
+end

data/spec/zoho_invoice/invoice_spec.rb

@@ -54,4 +54,31 @@ describe ZohoInvoice::Invoice do
     end
   end
 
+  describe "retrieving multiple pages" do
+    before do
+      @client = ZohoInvoice::Client.new(default_credentials)
+    end
+
+    it "should return all invoices from a paginated response" do
+      stub_get('/api/invoices/customer/1234').
+        with(:query => default_credentials).
+        to_return(:status => 200, :body => fixture('successful_multiple_page_response_page_1'), :headers => {:content_type => 'application/xml'})
+      
+      stub_get('/api/invoices/customer/1234').
+        with(:query => default_credentials.merge(:page => 2)).
+        to_return(:status => 200, :body => fixture('successful_multiple_page_response_page_2'), :headers => {:content_type => 'application/xml'})
+
+      result = ZohoInvoice::Invoice.send(:find_by_customer_id, @client, '1234')
+      expect(a_get('/api/invoices/customer/1234').with(:query => default_credentials)).to have_been_made
+      expect(a_get('/api/invoices/customer/1234').with(:query => default_credentials.merge(:page => 2))).to have_been_made
+      expect(result.class).to eq(Array)
+      expect(result.length).to eq(3)
+
+      result.each_with_index do |r, i|
+        expect(r.class).to eq(ZohoInvoice::Invoice)
+        expect(r.invoice_id).to eq((i+1).to_s)
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zoho_invoice
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,9 +130,12 @@ files:
 - spec/fixtures/invalid_user
 - spec/fixtures/please_select_an_item
 - spec/fixtures/successful_authtoken
+- spec/fixtures/successful_customers_response
 - spec/fixtures/successful_empty_customer_response
 - spec/fixtures/successful_empty_response
 - spec/fixtures/successful_multiple_customer_response
+- spec/fixtures/successful_multiple_page_response_page_1
+- spec/fixtures/successful_multiple_page_response_page_2
 - spec/fixtures/successful_multiple_record_response
 - spec/fixtures/successful_single_customer_response
 - spec/fixtures/successful_single_record_response
@@ -146,6 +149,7 @@ files:
 - spec/zoho_invoice/client_spec.rb
 - spec/zoho_invoice/collection_spec.rb
 - spec/zoho_invoice/contact_spec.rb
+- spec/zoho_invoice/customer_spec.rb
 - spec/zoho_invoice/error/client_error_spec.rb
 - spec/zoho_invoice/invoice_spec.rb
 - spec/zoho_invoice/string_spec.rb
@@ -184,9 +188,12 @@ test_files:
 - spec/fixtures/invalid_user
 - spec/fixtures/please_select_an_item
 - spec/fixtures/successful_authtoken
+- spec/fixtures/successful_customers_response
 - spec/fixtures/successful_empty_customer_response
 - spec/fixtures/successful_empty_response
 - spec/fixtures/successful_multiple_customer_response
+- spec/fixtures/successful_multiple_page_response_page_1
+- spec/fixtures/successful_multiple_page_response_page_2
 - spec/fixtures/successful_multiple_record_response
 - spec/fixtures/successful_single_customer_response
 - spec/fixtures/successful_single_record_response
@@ -200,6 +207,7 @@ test_files:
 - spec/zoho_invoice/client_spec.rb
 - spec/zoho_invoice/collection_spec.rb
 - spec/zoho_invoice/contact_spec.rb
+- spec/zoho_invoice/customer_spec.rb
 - spec/zoho_invoice/error/client_error_spec.rb
 - spec/zoho_invoice/invoice_spec.rb
 - spec/zoho_invoice/string_spec.rb