zoho_invoice 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,11 @@
-# ZohoInvoice
+# Zoho Invoice
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/neovintage/zoho_invoice.png?branch=master)](https://travis-ci.org/neovintage/zoho_invoice)
+[![Coverage Status](https://coveralls.io/repos/neovintage/zoho_invoice/badge.png?branch=master)](https://coveralls.io/r/neovintage/zoho_invoice)
+
+Need to interact with the Zoho Invoice API?  The zoho_invoice gem has your back.
+
+Until the gem reaches 1.0, the interface for interacting with the gem could change.  On top of that the gem does not support the entire API just yet.  Just the minimum number of domain objects to actually create customers and invoices.  This will change over time.
 
 ## Installation
 
@@ -16,9 +21,43 @@ Or install it yourself as:
 
     $ gem install zoho_invoice
 
+## Configuration
+
+The Zoho Invoice API service requires that you generate an auth token ahead of time using the API, just once.  Fortunately, the gem can handle that in console for you, all you need is your username and password.
+Then you can save the authtoken in your project based on however you do your configuration.
+
+```
+homebase $ irb
+> require 'zoho_invoice'
+ => true
+> result = ZohoInvoice::AuthToken.generate_authtoken('dude@example.com', 'thisismysweetpassword')
+ => #<struct ZohoInvoice::AuthToken::AuthTokenResult authtoken="blahblahblahnumbersnstuff", cause=nil>
+> result.success?
+ => true
+> result.authtoken
+ => "blahblahblahnumbersnstuff"
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'zoho_invoice'
+
+client = ZohoInvoice::Client.new(:authtoken => 'my authtoken', :apikey => 'my apikey')
+
+invoice = ZohoInvoice::Invoice.new(client, :customer_id => 'asdf')
+invoice.save
+```
+
+If you're so inclined, you can scope the resources through the client.
+
+```ruby
+require 'zoho_invoice'
+
+client = ZohoInvoice::Client.new(:authtoken => 'my authtoken', :apikey => 'my apikey')
+invoice = client.invoices.new(:customer_id => 'asdf')
+invoice.save
+```
 
 ## Contributing
 

data/Rakefile

@@ -5,3 +5,4 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task :test => :spec
+task :default => :spec

data/lib/zoho_invoice/base.rb

@@ -95,6 +95,12 @@ module ZohoInvoice
       build_attributes.to_xml(*args)
     end
 
+    def self.create_attributes(attrs)
+      attrs.each do |attr|
+        attr_accessor attr
+      end
+    end
+
   protected
 
     def process_error(request_result)
@@ -140,12 +146,5 @@ module ZohoInvoice
       end
     end
 
-    private
-
-    def self.create_attributes(attrs)
-      attrs.each do |attr|
-        attr_accessor attr
-      end
-    end
   end
 end

data/lib/zoho_invoice/client.rb

@@ -1,7 +1,18 @@
+require 'zoho_invoice/collection'
+
 module ZohoInvoice
   class Client
     include ZohoInvoice::Configurable
 
+    RESOURCES = [
+      :customers,
+      :invoices
+    ]
+
+    RESOURCES.each do |resource|
+      define_method(resource, ->{ ZohoInvoice::Collection.new(resource, self) })
+    end
+
     def initialize(options = {})
       ZohoInvoice::Configurable.keys.each do |key|
         instance_variable_set(:"@#{key}", options[key] || ZohoInvoice.instance_variable_get(:"@#{key}"))

data/lib/zoho_invoice/collection.rb

@@ -0,0 +1,25 @@
+module ZohoInvoice
+  class Collection
+
+    attr_reader :resource, :klass, :client
+
+    def initialize(resource, client)
+      @resource = resource
+      @klass    = "ZohoInvoice::#{resource[0..-2].capitalize}".split('::').reduce(Module, :const_get)
+      @client   = client
+    end
+
+    def search(*args, &block)
+      @klass.search(@client, *args, &block)
+    end
+
+    def new(*args, &block)
+      @klass.new(@client, *args, &block)
+    end
+
+    def create(*args, &block)
+      @klass.create(@client, *args, &block)
+    end
+
+  end
+end

data/lib/zoho_invoice/customer.rb

@@ -22,7 +22,6 @@ module ZohoInvoice
     has_many :contacts
 
     def self.search(client, input_text)
-
     end
 
   end

data/lib/zoho_invoice/invoice_item.rb

@@ -1,7 +1,7 @@
+require 'zoho_invoice/item'
+
 module ZohoInvoice
   class InvoiceItem < Item
 
-    primary_key :item_id
-
   end
 end

data/lib/zoho_invoice/version.rb

@@ -1,3 +1,3 @@
 module ZohoInvoice
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/spec_helper.rb

@@ -14,6 +14,7 @@ require 'zoho_invoice'
 require 'webmock/rspec'
 require 'pry'
 
+Coveralls.wear!
 WebMock.disable_net_connect!
 
 RSpec.configure do |config|

data/spec/zoho_invoice/collection_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe ZohoInvoice::Collection do
+
+  before do
+    @client = ZohoInvoice::Client.new
+    @customers = ZohoInvoice::Collection.new(:customers, @client)
+  end
+
+  it "should correctly find the resource" do
+    expect(@customers.resource ).to eq(:customers)
+    expect(@customers.klass    ).to eq(ZohoInvoice::Customer)
+    expect(@customers.client   ).to eq(@client)
+  end
+
+  it "should forward the initialize call to the underlying resource and pass the client" do
+    customer = nil
+    expect{ customer = @customers.new }.not_to raise_error
+    expect(customer.class).to eq(ZohoInvoice::Customer)
+    expect(customer.client).to eq(@client)
+
+    expect{ customer = @customers.new(:name => 'Dude') }.not_to raise_error
+    expect(customer.name).to eq('Dude')
+    expect(customer.client).to eq(@client)
+  end
+
+  it "should forward the search call to the resource and pass the client" do
+    ZohoInvoice::Customer.stub(:search)
+    ZohoInvoice::Customer.should_receive(:search)
+    expect{ @customers.search('find it') }.not_to raise_error
+  end
+
+  it "should forward the create method to the resource" do
+    ZohoInvoice::Customer.stub(:create)
+    ZohoInvoice::Customer.should_receive(:create)
+    expect{ @customers.create(:name => 'Dude') }.not_to raise_error
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zoho_invoice
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,7 @@ files:
 - lib/zoho_invoice/auth_token.rb
 - lib/zoho_invoice/base.rb
 - lib/zoho_invoice/client.rb
+- lib/zoho_invoice/collection.rb
 - lib/zoho_invoice/configurable.rb
 - lib/zoho_invoice/contact.rb
 - lib/zoho_invoice/customer.rb
@@ -131,6 +132,7 @@ files:
 - spec/zoho_invoice/auth_token_spec.rb
 - spec/zoho_invoice/base_spec.rb
 - spec/zoho_invoice/client_spec.rb
+- spec/zoho_invoice/collection_spec.rb
 - spec/zoho_invoice/contact_spec.rb
 - spec/zoho_invoice_spec.rb
 - zoho_invoice.gemspec
@@ -171,5 +173,6 @@ test_files:
 - spec/zoho_invoice/auth_token_spec.rb
 - spec/zoho_invoice/base_spec.rb
 - spec/zoho_invoice/client_spec.rb
+- spec/zoho_invoice/collection_spec.rb
 - spec/zoho_invoice/contact_spec.rb
 - spec/zoho_invoice_spec.rb