rubyzoho 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,5 +1,7 @@
 {<img src="https://travis-ci.org/amalc/rubyzoho.png?branch=master" alt="Build Status" />}[https://travis-ci.org/amalc/rubyzoho]
 
+{<img src="https://gemnasium.com/amalc/rubyzoho.png" alt="Dependency Status" />}[https://gemnasium.com/amalc/rubyzoho]
+
 = rubyzoho
 
 Abstracting Zoho's API into a set of Ruby classes, with reflection of Zoho's fields using a more familiar
@@ -9,7 +11,21 @@ ActiveRecord lifecycle but without ActiveRecord.
     gem install rubyzoho
 
 == Configure
-Put the following in an initializer (e.g. zoho.rb):
+
+=== Rails
+Put the following in an initializer (e.g. <tt><RAILS_ROOT>/config/initializers/zoho.rb</tt>):
+
+    require 'ruby_zoho'
+
+    RubyZoho.configure do |config|
+      config.api_key = '<< API Key from Zoho>>'
+      # config.crm_modules = ['Accounts', 'Contacts', 'Leads', 'Potentials'] # Defaults to free edition if not set
+      # config.crm_modules = ['Quotes', 'SalesOrders', 'Invoices'] # Depending on what kind of account you've got, adds to free edition modules
+      # Currently only Quotes are suported
+    end
+
+=== Ruby
+Make sure the following block is executed prior to making calls to the gem.
 
     require 'ruby_zoho'
 
@@ -23,9 +39,10 @@ Please be aware that Zoho limits API calls. So running tests repeatedly will qui
 your daily allowance.
 
 
+
 == Use
-RubyZoho attempts to follow the ActiveRecord lifecycle, i.e. new, save and delete
-at this point.
+RubyZoho attempts to follow the ActiveRecord lifecycle, i.e. new, save, update and delete.
+See examples below.
 
 To get a list of supported attributes for a Zoho CRM contact:
 
@@ -52,8 +69,8 @@ To retrieve an existing record:
 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.
+API. Note, what is returned is an Array class which is also Enumerable. Use +.each+,
++.map+, +.first+, +.last+, etc to navigate through the result set.
 
 Equality is the only match currently supported.
 
@@ -128,13 +145,16 @@ To update a record:
 Objects currently supported are:
     RubyZoho::Crm::Account
     RubyZoho::Crm::Contact
+    RubyZoho::Crm::Event
     RubyZoho::Crm::Lead
     RubyZoho::Crm::Potential
+    RubyZoho::Crm::Task
     RubyZoho::Crm::Quote
+    RubyZoho::Crm::User
 
 
 ==Bugs and Enhancments
-Please open an issue on GitHub. Or better yet, send in a pull request.
+Please open an issue on GitHub. Or better yet, send in a pull request with the fix or enhancement!
 
 ---
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/ruby_zoho.rb

@@ -21,7 +21,7 @@ module RubyZoho
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration) if block_given?
-    self.configuration.crm_modules ||= ['Accounts', 'Contacts', 'Leads', 'Potentials']
+    self.configuration.crm_modules ||= []
     self.configuration.api = ZohoApi::Crm.new(self.configuration.api_key, self.configuration.crm_modules)
   end
 
@@ -37,15 +37,17 @@ module RubyZoho
       @fields = RubyZoho.configuration.api.module_fields[
           ApiUtils.string_to_symbol(Crm.module_name)]
       RubyZoho::Crm.create_accessor(self.class, @fields)
-      retry_counter = -1
+      retry_counter = object_attribute_hash.count
       begin
         object_attribute_hash.map { |(k, v)| public_send("#{k}=", v) }
       rescue NoMethodError => e
-        m = e.message.slice(/`[a-z]*id='/)  # Get method name with id
-        RubyZoho::Crm.create_accessor(self.class,
-            [ApiUtils.string_to_symbol(m.slice(/[a-z]*=/).chop)]) unless m.nil?
-        retry_counter += 1
-        retry if retry_counter <= 0
+        m = e.message.slice(/`(.*?)=/)
+        unless m.nil?
+          m.gsub!('`', '')
+          RubyZoho::Crm.create_accessor(self.class, [m.chop])
+        end
+        retry_counter -= 1
+        retry if retry_counter > 0
       end
       self
     end
@@ -67,7 +69,8 @@ module RubyZoho
     end
 
     def self.method_name?(n)
-      return /[@$"]/ !~ n.inspect
+      name = n.class == String ? ApiUtils.string_to_symbol(n) : n
+      return /[@$"]/ !~ name.inspect
     end
 
     def self.create_getter(klass, *names)
@@ -189,6 +192,32 @@ module RubyZoho
     end
 
 
+    class Event < RubyZoho::Crm
+      include RubyZoho
+      attr_reader :fields
+      Crm.module_name = 'Events'
+
+      def initialize(object_attribute_hash = {})
+        Crm.module_name = 'Events'
+        super
+      end
+
+      def self.all
+        Crm.module_name = 'Events'
+        super
+      end
+
+      def self.delete(id)
+        Crm.module_name = 'Events'
+        super
+      end
+
+      def self.method_missing(meth, *args, &block)
+        Crm.module_name = 'Events'
+        super
+      end
+    end
+
     class Lead < RubyZoho::Crm
       include RubyZoho
       attr_reader :fields
@@ -241,6 +270,32 @@ module RubyZoho
       end
     end
 
+    class Task < RubyZoho::Crm
+      include RubyZoho
+      attr_reader :fields
+      Crm.module_name = 'Tasks'
+
+      def initialize(object_attribute_hash = {})
+        Crm.module_name = 'Tasks'
+        super
+      end
+
+      def self.all
+        Crm.module_name = 'Tasks'
+        super
+      end
+
+      def self.delete(id)
+        Crm.module_name = 'Tasks'
+        super
+      end
+
+      def self.method_missing(meth, *args, &block)
+        Crm.module_name = 'Tasks'
+        super
+      end
+    end
+
     class Quote < RubyZoho::Crm
       include RubyZoho
       attr_reader :fields
@@ -267,6 +322,37 @@ module RubyZoho
       end
     end
 
+    class User < RubyZoho::Crm
+      def initialize(object_attribute_hash = {})
+        Crm.module_name = 'Users'
+        super
+      end
+
+      def self.delete(id)
+        raise 'Cannot delete users through API'
+      end
+
+      def save
+        raise 'Cannot delete users through API'
+      end
+
+      def self.all
+        result = RubyZoho.configuration.api.users('AllUsers')
+        result.collect { |r| new(r) }
+      end
+
+      def self.find_by_email(email)
+        r = []
+        self.all.index { |u| r << u if u.email == email }
+        r
+      end
+
+      def self.method_missing(meth, *args, &block)
+        Crm.module_name = 'Users'
+        super
+      end
+    end
+
   end
 
 end

data/lib/zoho_api.rb

@@ -18,6 +18,7 @@ module ZohoApi
     include HTTMultiParty
 
     @@module_fields = {}
+    @@users = []
 
     #debug_output $stderr
 
@@ -25,7 +26,7 @@ module ZohoApi
 
     def initialize(auth_token, modules)
       @auth_token = auth_token
-      @modules = modules
+      @modules = %w(Accounts Contacts Events Leads Potentials Tasks Users).concat(modules).uniq
       @module_fields = reflect_module_fields
     end
 
@@ -38,8 +39,7 @@ module ZohoApi
           :query => { :newFormat => 1, :authtoken => @auth_token,
                       :scope => 'crmapi', :xmlData => x },
           :headers => { 'Content-length' => '0' })
-      raise('Adding record failed', RuntimeError, r.response.body.to_s) unless r.response.code == '200'
-      r.response.code
+      check_for_errors(r)
     end
 
     def add_field(row, field, value)
@@ -90,9 +90,13 @@ module ZohoApi
     end
 
     def check_for_errors(response)
-      return
-      raise(RuntimeError, 'Exceeded API calls.') unless response.body.to_s.index('You crossed your API search limit').nil?
-      response
+      raise(RuntimeError, "Web service call failed with #{response.code}") unless response.code == 200
+      x = REXML::Document.new(response.body)
+      code =  REXML::XPath.first(x, '//code')
+      raise(RuntimeError, "Zoho Error Code #{code.text}: #{REXML::XPath.first(x, '//message').text}.") unless
+          code.nil? || ['4422', '5000'].index(code.text)
+      return code.text unless code.nil?
+      response.code
     end
 
     def create_url(module_name, api_call)
@@ -109,21 +113,14 @@ module ZohoApi
     end
 
     def fields(module_name)
+      return user_fields if module_name == 'Users'
       mod_name = ApiUtils.string_to_symbol(module_name)
       return @@module_fields[mod_name] unless @@module_fields[mod_name].nil?
       r = self.class.post(create_url(module_name, 'getFields'),
           :query => { :authtoken => @auth_token, :scope => 'crmapi' },
           :headers => { 'Content-length' => '0' })
-      @@module_fields[mod_name] = []
-      x = REXML::Document.new(r.body)
-      REXML::XPath.each(x, "/#{module_name}/section/FL/@dv") do |f|
-        field = ApiUtils.string_to_symbol(f.to_s)
-        @@module_fields[mod_name] << field if method_name?(field)
-      end
-      raise('Getting fields failed', RuntimeError, module_name) unless r.response.code == '200'
       check_for_errors(r)
-      @@module_fields[mod_name] << ApiUtils.string_to_symbol(module_name.chop + 'id')
-      @@module_fields
+      update_module_fields(mod_name, module_name, r)
     end
 
     def first(module_name)
@@ -142,7 +139,6 @@ module ZohoApi
                          :query => {:newFormat => 1, :authtoken => @auth_token, :scope => 'crmapi',
                                     :selectColumns => 'All', :searchCondition => search_condition,
                                     :fromIndex => 1, :toIndex => NUMBER_OF_RECORDS_TO_GET})
-      raise(RuntimeError, 'Bad query', "#{sc_field} #{condition} #{value}") unless r.body.index('<error>').nil?
       check_for_errors(r)
       x = REXML::Document.new(r.body).elements.to_a("/response/result/#{module_name}/row")
       to_hash(x)
@@ -167,15 +163,16 @@ module ZohoApi
       @@module_fields
     end
 
-    def related_records(module_name, id)
-      r = self.class.get(create_url("#{module_name}", 'getRelatedRecords'),
+    def related_records(parent_module, parent_record_id, related_module)
+      r = self.class.get(create_url("#{related_module}", 'getRelatedRecords'),
          :query => { :newFormat => 1, :authtoken => @auth_token, :scope => 'crmapi',
-                     :parentModule => module_name, :id => id})
-      raise(RuntimeError, 'Bad query for related records', module_name) unless r.body.index('<error>').nil?
-      check_for_errors(r)
-      x = REXML::Document.new(r.body).elements.to_a("/response/result/#{module_name}/row")
+                     :parentModule => parent_module, :id => parent_record_id})
+
+      pp r.body
+      x = REXML::Document.new(r.body).elements.to_a("/response/result/#{parent_module}/row")
       puts "====="
-      pp x.each { |i| i.to_s }
+      pp check_for_errors(r)
+      return nil unless check_for_errors(r).nil?
     end
 
     def some(module_name, index = 1, number_of_records = nil)
@@ -203,6 +200,18 @@ module ZohoApi
       r
     end
 
+    def update_module_fields(mod_name, module_name, r)
+      @@module_fields[mod_name] = []
+      x = REXML::Document.new(r.body)
+      REXML::XPath.each(x, "/#{module_name}/section/FL/@dv") do |f|
+        field = ApiUtils.string_to_symbol(f.to_s)
+        @@module_fields[mod_name] << field if method_name?(field)
+      end
+      @@module_fields[mod_name] << ApiUtils.string_to_symbol(module_name.chop + 'id')
+      return @@module_fields[mod_name] unless @@module_fields.nil?
+      nil
+    end
+
     def update_record(module_name, id, fields_values_hash)
       x = REXML::Document.new
       contacts = x.add_element module_name
@@ -218,6 +227,31 @@ module ZohoApi
       r.response.code
     end
 
+    def user_fields
+      @@module_fields[:users] = users[0].keys
+    end
+
+    def users(user_type = 'AllUsers')
+      return @@users unless @@users == [] || user_type == 'Refresh'
+      r = self.class.get(create_url('Users', 'getUsers'),
+          :query => { :newFormat => 1, :authtoken => @auth_token, :scope => 'crmapi',
+              :type => 'AllUsers' })
+      check_for_errors(r)
+      x = REXML::Document.new(r.body).elements.to_a("/users")
+      result = []
+      x.each do |e|
+        e.elements.to_a.each do |n|
+          record = {}
+          record.merge!( { :user_name => n.text })
+          n.attributes.each_pair do |k, v|
+            record.merge!({ k.to_s.to_sym => v.to_string.match(/'(.*?)'/).to_s.gsub("'", '') })
+          end
+          result << record
+        end
+      end
+      @@users = result
+    end
+
   end
 
 end

data/rubyzoho.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rubyzoho"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["amalc"]
-  s.date = "2013-02-16"
+  s.date = "2013-02-18"
   s.description = ""
   s.email = ""
   s.extra_rdoc_files = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "lib/api_utils.rb",
     "lib/ruby_zoho.rb",
     "lib/zoho_api.rb",
+    "rubyzoho-0.1.1.gem",
     "rubyzoho.gemspec",
     "spec/api_utils_spec.rb",
     "spec/fixtures/sample.pdf",

data/spec/ruby_zoho_spec.rb

@@ -13,12 +13,12 @@ describe RubyZoho::Crm do
       #config.api_key = params['auth_token']
       #config.api_key = 'e194b2951fb238e26bc096de9d0cf5f8'
       config.api_key = '62cedfe9427caef8afb9ea3b5bf68154'
-      config.crm_modules = ['Accounts', 'Contacts', 'Leads', 'Potentials', 'Quotes']
+      config.crm_modules = %w(Quotes)
     end
-    r = RubyZoho::Crm::Contact.find_by_last_name('Smithereens')
-    r.each { |m| RubyZoho::Crm::Contact.delete(m.contactid) } unless r.nil?
-    r = RubyZoho::Crm::Contact.find_by_email('raj@portra.com')
-    r.each { |c|  RubyZoho::Crm::Contact.delete(c.contactid) } unless r.nil?
+    #r = RubyZoho::Crm::Contact.find_by_last_name('Smithereens')
+    #r.each { |m| RubyZoho::Crm::Contact.delete(m.contactid) } unless r.nil?
+    #r = RubyZoho::Crm::Contact.find_by_email('raj@portra.com')
+    #r.each { |c|  RubyZoho::Crm::Contact.delete(c.contactid) } unless r.nil?
   end
 
   it 'should add accessors using a list of names' do
@@ -50,6 +50,28 @@ describe RubyZoho::Crm do
     r.each { |m| RubyZoho::Crm::Contact.delete(m.contactid) }
   end
 
+  it 'should find a contact by ID' do
+    contacts = RubyZoho::Crm::Contact.all
+    contact_id = contacts.first.contactid
+    c = RubyZoho::Crm::Contact.find_by_contactid(contact_id)
+    c.first.contactid.should eq(contact_id)
+    c.first.last_name.should eq(contacts.first.last_name)
+    c.first.email.should eq(contacts.first.email)
+  end
+
+  it 'should find a lead by ID' do
+    leads = RubyZoho::Crm::Lead.all
+    lead_id = leads.first.leadid
+    l = RubyZoho::Crm::Lead.find_by_leadid(lead_id)
+    l.first.leadid.should eq(lead_id)
+  end
+
+  it 'should find a user by email address' do
+    users = RubyZoho::Crm::User.all
+    r = RubyZoho::Crm::User.find_by_email(users.first.email)
+    r.first.email.should eq(users.first.email)
+  end
+
   it 'should get a list of attr_writers for accounts' do
     c = RubyZoho::Crm::Account.new
     c.attr_writers.count.should be >= 18
@@ -87,6 +109,12 @@ describe RubyZoho::Crm do
     r.map { |r| r.class.should eq(RubyZoho::Crm::Contact) }
   end
 
+  it 'should get a list of events' do
+    r = RubyZoho::Crm::Event.all
+    r.count.should be > 1
+    r.map { |r| r.class.should eq(RubyZoho::Crm::Event) }
+  end
+
   it 'should get a list of potentials' do
     r = RubyZoho::Crm::Potential.all
     r.count.should be > 1
@@ -99,20 +127,15 @@ describe RubyZoho::Crm do
     r.map { |r| r.class.should eq(RubyZoho::Crm::Quote) }
   end
 
-  it 'should find a contact by ID' do
-    contacts = RubyZoho::Crm::Contact.all
-    contact_id = contacts.first.contactid
-    c = RubyZoho::Crm::Contact.find_by_contactid(contact_id)
-    c.first.contactid.should eq(contact_id)
-    c.first.last_name.should eq(contacts.first.last_name)
-    c.first.email.should eq(contacts.first.email)
+  it 'should get a list of tasks' do
+    r = RubyZoho::Crm::Task.all
+    r.count.should be > 1
+    r.map { |r| r.class.should eq(RubyZoho::Crm::Task) }
   end
 
-  it 'should find a lead by ID' do
-    leads = RubyZoho::Crm::Lead.all
-    lead_id = leads.first.leadid
-    l = RubyZoho::Crm::Lead.find_by_leadid(lead_id)
-    l.first.leadid.should eq(lead_id)
+  it 'should get a list of users' do
+    r = RubyZoho::Crm::User.all
+    r.count.should be >= 1
   end
 
   it 'should save a contact record' do

data/spec/zoho_api_spec.rb

@@ -25,7 +25,7 @@ describe ZohoApi do
     #params = YAML.load(File.open(config_file))
     #@zoho = ZohoApi::Crm.new(params['auth_token'])
     @sample_pdf = File.join(base_path, 'sample.pdf')
-    modules = ['Accounts', 'Contacts', 'Leads', 'Potentials']
+    modules = ['Accounts', 'Contacts', 'Events', 'Leads', 'Tasks', 'Potentials']
     #api_key = '783539943dc16d7005b0f3b78367d5d2'
     #api_key = 'e194b2951fb238e26bc096de9d0cf5f8'
     api_key = '62cedfe9427caef8afb9ea3b5bf68154'
@@ -37,8 +37,8 @@ describe ZohoApi do
           :phone => '13452129087',
           :mobile => '12341238790'
     }
-    contacts = @zoho.find_records('Contacts', :email, '=', @h_smith[:email])
-    contacts.each { |c| @zoho.delete_record('Contacts', c[:contactid]) } unless contacts.nil?
+    #contacts = @zoho.find_records('Contacts', :email, '=', @h_smith[:email])
+    #contacts.each { |c| @zoho.delete_record('Contacts', c[:contactid]) } unless contacts.nil?
   end
 
   it 'should add a new contact' do
@@ -81,14 +81,25 @@ describe ZohoApi do
   end
 
   it 'should get a list of fields for a module' do
+    r = @zoho.fields('Accounts')
+    r.count.should >= 30
     r = @zoho.fields('Contacts')
     r.count.should be >= 35
+    r = @zoho.fields('Events')
+    r.count.should >= 10
     r = @zoho.fields('Leads')
     r.count.should be >= 23
     r = @zoho.fields('Potentials')
     r.count.should be >= 15
-    r = @zoho.fields('Accounts')
-    r.count.should >= 30
+    r = @zoho.fields('Tasks')
+    r.count.should >= 10
+    r = @zoho.fields('Users')
+    r.count.should >= 7
+  end
+
+  it 'should get a list of user fields' do
+    r = @zoho.user_fields
+    r.count.should be >= 7
   end
 
   it 'should retrieve records by module name' do
@@ -100,10 +111,31 @@ describe ZohoApi do
 
   it 'should return related records by module and id' do
     pending
-    r = @zoho.some('Contacts')
-    pp r.first
-    related = @zoho.related_records('Contacts', r.first[:contactid])
-    pp related
+    r = @zoho.some('Accounts').first
+    pp r
+    related = @zoho.related_records('Accounts', r[:accountid], 'Attachments')
+  end
+
+  it 'should return events' do
+    r = @zoho.some('Events').first
+    r.should_not eq(nil)
+  end
+
+  it 'should return users' do
+    r = @zoho.users
+    r.should_not eq(nil)
+  end
+
+  it 'should do a full CRUD lifecycle on tasks' do
+    pending
+    mod_name = 'Tasks'
+    fields = @zoho.fields(mod_name)
+    fields.count >= 10
+    fields.index(:task_owner).should_not eq(nil)
+    @zoho.add_record(mod_name, {:task_owner => 'Task Owner', :subject => 'Test Task', :due_date => '1/1/2100'})
+    r = @zoho.some(mod_name).first
+    pp r
+    r.should_not eq(nil)
   end
 
   it 'should update a contact' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyzoho
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty
@@ -208,6 +208,7 @@ files:
 - lib/api_utils.rb
 - lib/ruby_zoho.rb
 - lib/zoho_api.rb
+- rubyzoho-0.1.1.gem
 - rubyzoho.gemspec
 - spec/api_utils_spec.rb
 - spec/fixtures/sample.pdf