rubyzoho 0.0.2 → 0.0.3

data/.rspec

@@ -1,3 +1,4 @@
 --color
 --format progress
 --format documentation 
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.2.11)
+    activesupport (3.2.12)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     archive-tar-minitar (0.5.2)
@@ -26,16 +26,16 @@ GEM
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.7.6)
+    json (1.7.7)
     metaclass (0.0.1)
-    mime-types (1.19)
+    mime-types (1.21)
     mocha (0.10.5)
       metaclass (~> 0.0.1)
-    multi_json (1.5.0)
-    multi_xml (0.5.2)
+    multi_json (1.5.1)
+    multi_xml (0.5.3)
     nokogiri (1.5.6)
     rake (10.0.3)
-    rdoc (3.12)
+    rdoc (3.12.1)
       json (~> 1.4)
     relish (0.6)
       archive-tar-minitar (>= 0.5.2)

data/README.rdoc

@@ -7,23 +7,112 @@ Travis CI - YRI 1.9.x
 Abstracting Zoho's API into a set of Ruby classes, with reflection of Zoho's fields using a more familiar
 ActiveRecord lifecycle but without ActiveRecord.
 
-== Installation
+== Install
     gem install rubyzoho
 
-== Configuration
+== Configure
 Put the following in an initializer (e.g. zoho.rb):
 
     RubyZoho.configure do |config|
-      config.api_key = << API Key from Zoho>>
+      config.api_key = '<< API Key from Zoho>>'
     end
 
 Please be aware that Zoho limits API calls. So running tests repeatedly will quickly exhaust
 your daily allowance.
 
+
+== Use
+RubyZoho attempts to follow the ActiveRecord lifecycle, i.e. new, save and delete
+at this point.
+
+To get a list of supported attributes for a Zoho CRM contact:
+
+    require 'ruby_zoho'
+
+    c = RubyZoho::Crm::Contact.new
+    c.attr_writers  # => Give a list of updatable attributes
+    c.fields # => Hash of all fields
+
+Attributes are reflected from the current API instance of Zoho, dynamically on
+initialization of the API, when the RubyZoho.configure block is called. This
+includes custom fields.
+
+Another example:
+
+    l = RubyZoho::Crm::Lead.new
+    l.attr_writers  # => Give a list of updatable attributes
+    l.fields # => Hash of all fields
+
+To retrieve an existing record:
+
+    l = RubyZoho::Crm::Lead.find_by_email('email@domain.com')
+
+Returns one or more records matching the query. The find_by_<attribute> follows
+ActiveRecord style reflections, so if the attribute is present in the API, it can
+be queried. There is currently a single attribute limitation imposed by the Zoho 
+API. Note, what is returned is an Array class. Use subscripts at this point to access
+or iterate through the returned set of records.
+
+Equality is the only match currently supported.
+
+To get a list of all accounts:
+
+    a = RubyZoho::Crm::Account.all
+    a.each do |account|
+      pp account.account_name
+    end
+
+Or for all quotes:
+
+    q = RubyZoho::Crm::Quote.all
+    q.each do |quote|
+      pp quote.subject
+      pp quote.quote_name
+    end
+
+To create a new record:
+
+    c = RubyZoho::Crm::Contact.new(
+      :first_name => 'First Name',
+      :last_name => 'Last Name',
+      :email => 'email@domain.com',
+      etc.
+    )
+    c.save
+    r = RubyZoho::Crm::Contact.find_by_email('email@domain.com')
+    r[0].contactid # => Has the newly created contact's ID
+
+
+To add a contact to an existing account:
+
+    a = RubyZoho::Crm::Account.find_by_account_name('Very Big Account')
+    c = RubyZoho::Crm::Contact.new(
+      :first_name => 'First Name',
+      :last_name => 'Last Name',
+      :email => 'email@domain.com',
+      :account_name => a[0].account_name,
+      :accountid => a[0].accountid  # accountid instead of account_id because of Zoho's convention
+      etc.
+    )
+    c.save
+
+
+Objects currently supported are:
+    RubyZoho::Crm::Account
+    RubyZoho::Crm::Contact
+    RubyZoho::Crm::Lead
+    RubyZoho::Crm::Potential
+    RubyZoho::Crm::Quote
+
+
+==Bugs and Enhancments
+Please open an issue on GitHub. Or better yet, send in a pull request.
+
 ---
 
 == Contributing to rubyzoho
- 
+
+* Pull requests with unit tests or specs and a version branch are welcomed.
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/rubyzoho.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "rubyzoho"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["amalc"]
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "lib/api_utils.rb",
     "lib/ruby_zoho.rb",
     "lib/zoho_api.rb",
+    "rubyzoho-0.0.2.gem",
     "rubyzoho.gemspec",
     "spec/api_utils_spec.rb",
     "spec/fixtures/sample_contact.xml",
@@ -44,7 +45,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/amalc/rubyzoho"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
+  s.rubygems_version = "1.8.24"
   s.summary = "A set of Ruby classes supporting the ActiveRecord lifecycle for the Zoho API."
 
   if s.respond_to? :specification_version then

data/spec/ruby_zoho_spec.rb

@@ -37,6 +37,9 @@ describe RubyZoho::Crm do
     r.each { |m| m.email.should eq('bob@smith.com') }
     r = RubyZoho::Crm::Contact.find_by_last_name('Smithereens')
     r.should_not eq(nil)
+    r.first.should_not eq(nil)
+    r.last.should_not eq(nil)
+    r.map { |c| c.last_name }.count.should eq(3)
     r.first.last_name.should eq('Smithereens')
     r.each { |m| RubyZoho::Crm::Contact.delete(m.contactid) }
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyzoho
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -208,6 +208,7 @@ files:
 - lib/api_utils.rb
 - lib/ruby_zoho.rb
 - lib/zoho_api.rb
+- rubyzoho-0.0.2.gem
 - rubyzoho.gemspec
 - spec/api_utils_spec.rb
 - spec/fixtures/sample_contact.xml
@@ -239,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A set of Ruby classes supporting the ActiveRecord lifecycle for the Zoho