rubyzoho 0.1.6 → 0.1.7

data/.travis.yml

@@ -2,16 +2,13 @@
 language: ruby
 rvm:
 - 1.9.3
-# - jruby
-
 matrix:
   allow-failures:
-    - rvm: jruby
-
+  - rvm: jruby
 env:
   global:
-  - secure: ! 'E2ZilvytrU4gPdPZna7EMJmrDHQPfjo7KLnY4geip1coSrmISaf3VhKlGMDY
+  - secure: ! 'Es86LRVpGFcxK8Ay0NzjtPgL1a7GQ25WRq4FgixHplZ8BbB2g/LGm2hFFnrD
 
-      NubPbNdM6K98F98hQfMszGjt7YJz8y5dJrpwT4847ZL9k0FLN8XsjdxW7gH4
+      TQHNvTttEhrXDRXvYqv0ePTSb2I4Tn6xOzBZTIwZlmNDl6uj/5ZL9C9I3LQb
 
-      Dqocd1v5HY2gK60quwr0YPza10bgw6XseYXlrMtVgpTFOYv5HTg='
+      1MP0XFN0GfkOpw4DqVerdzDDoRzQw7AbTBttaOVyO3Nhiddtc3E='

data/Gemfile

@@ -13,6 +13,7 @@ end
 group :development do
   gem 'bundler', '>= 1.2'
   gem 'cucumber', '>= 1.2.1'
+  gem 'holepicker'
   gem 'jeweler', '~> 1.8.4'
   gem 'relish', '>= 0.6'
   gem 'rdoc', '>= 3.12.1'

data/README.rdoc

@@ -1,13 +1,13 @@
-{<img src="https://travis-ci.org/amalc/rubyzoho.png?branch=master" alt="Build Status" />}[https://travis-ci.org/amalc/rubyzoho]
+= rubyzoho {<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] {<img src="https://codeclimate.com/github/amalc/rubyzoho.png" />}[https://codeclimate.com/github/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
 ActiveRecord lifecycle, but without ActiveRecord. Current focus is on Zoho CRM.
 
+<b>Release notes are at the \end of this page.</b>
+
 == Install
     gem install rubyzoho
 
@@ -86,7 +86,7 @@ To get a list of all accounts:
 Or for all task subjects:
 
     t = RubyZoho::Crm::Task.all
-    pp t.collect { |task| task.subject }
+    pp t.collect { |task| task.subject }  # => ['Subject 1'], ['Subject 2'], ... ['Subject n']
 
 Or for all quotes:
 
@@ -109,7 +109,7 @@ works.
 To sort a result set:
     r = RubyZoho::Crm::Contact.all
     sorted =  r.sort {|a, b| a.last_name <=> b.last_name }
-    pp sorted.collect { |c| c.last_name }
+    pp sorted.collect { |c| c.last_name }  # => ['Name 1', ['Name 2'], ... ['Name n']]
 
 To find by ID, note well, ID is a *string*:
     leads = RubyZoho::Crm::Lead.all
@@ -148,11 +148,28 @@ To update a record (<b>Note, that the attribute is :id</b>):
         :email => 'changed_email@domain.com'
     )
 
+Custom fields are like any other field or method in Ruby:
+    a = RubyZoho::Crm::Account.find_by_account_name('Very Big Account')
+    pp a.custom_field # => 'Custom field content'
+
+Or:
+    c = RubyZoho::Crm::Contact.new(
+      :first_name => 'First Name',
+      :last_name => 'Last Name',
+      :email => 'email@domain.com',
+      :account_name => a.first.account_name,
+      :accountid => a.first.accountid,  # accountid instead of account_id because of Zoho's convention
+      :custom_field_2 => 'Custom text'
+    )
+    pp c.save   # Reflects back the new Zoho record ID, and various create and modify times and users
+
+To attach a file to a record (Tested for +Accounts+, +Contacts+, +Leads+, +Potentials+ and +Tasks+ only):
+    l = RubyZoho::Crm::Lead.find_by_email('email@domain.com')
+    l.attach_file(file_path, file_name)     # Can only be attached to a pre-existing record
 
-Objects currently supported are:
+Classes (Zoho modules) currently supported are:
     RubyZoho::Crm::Account
     RubyZoho::Crm::Contact
-    RubyZoho::Crm::Event
     RubyZoho::Crm::Lead
     RubyZoho::Crm::Potential
     RubyZoho::Crm::Task
@@ -165,7 +182,7 @@ or where the Zoho API sends back an explicit error code which <b>isn't</b> in th
 
     ['4422', '5000']
 
-a standard Ruby +RuntimeError+ exception is raised with the Zoho API message.
+a standard Ruby +RuntimeError+ exception is raised with the Zoho's API message.
 
 == Optimizations for Development and Testing
 Set <tt>config.cache_fields = true</tt> in the configuration block. This caches \module field
@@ -196,22 +213,20 @@ either the related \module's record id, which is stored with the Task. But no, c
 Please open an issue on GitHub. Or better yet, send in a pull request with the fix or enhancement!
 
 === Known Bugs or Issues
-1. Caching is causing a problem with Quotes.
-2. If you're having trouble with updating custom fields, be sure to check the permission of the user that created the custom field.
+1. If you're having trouble with updating custom fields, be sure to check the permission of the user that created the custom field.
 
 === Roadmap (Ranked)
-1. Get related records using AR style syntax, e.g.
-        pp a.contacts
-   to get contacts associated with an account.
-2. Support for multiple find fields.
-3. AR style master/detail updates e.g. where +a+ is an account.
+1. AR style master/detail updates e.g. where +a+ is an account.
     a << RubyZoho::Crm::Contact.new(
         :last_name => 'Last Name',
         :first_name => 'First Name'
     )
+2. Get related records using AR style syntax, e.g.
+        pp a.contacts
+   to get contacts associated with an account.
+3. Support for multiple find fields.
 
 == 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.
@@ -222,13 +237,35 @@ Please open an issue on GitHub. Or better yet, send in a pull request with the f
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 ---
+== Acknowledgements
+Giant buckets of Gratitude to the giants, sung and unsung heroes who put together and support the Open Source movement,
+Linux, Ruby and Rails. We stand on the shoulders of giants. Thank you.
 
-== Trademarks
+== Credits
+wcgiles@github (\@\waynecgiles) for professional and patient debugging and continued debugging of this gem.
 
+== Trademarks
 Zoho, the Zoho suite and related applications are owned, trademarked and copyrighted by the Zoho Corporation Pvt. Ltd.
 This software is not associated in anyway with the Zoho Corporation Pvt. Ltd.
 
 == Copyright
+Copyright (c) 2013 amalc (\@\amalc). Released under the MIT license. See LICENSE.txt for further details.
+
+---
+= Releases
+== Release Candidates
+
+== Development
+[0.1.8]
+        1. Modules Supported: Accounts, Contacts, Leads, Potentials, Quotes, Tasks and Users
+        2. ActiveRecord style syntax for Class.\new, Class.delete, Class.find, Class.update, Object.save
+        3. << syntax for Account/Tasks on Master/Detail relationships
+[0.1.7]
+        1. Bug for attach_file method, respect the file_name parameter.
+        2. \:\id is the primary key across all classes in addition to Zoho's existing convention.
+
+== Released
+[0.1.1 - 0.1.6] Alpha Releases
+                1. Configuration block signature changed
+[0.0.1 - 0.0.5] Alpha Releases
 
-Copyright (c) 2013 amalc. Released under the MIT license. See LICENSE.txt for
-further details.

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/lib/ruby_zoho.rb

@@ -49,26 +49,28 @@ module RubyZoho
     class << self
       attr_accessor :module_name
     end
+    @module_name = 'Crm'
 
     def initialize(object_attribute_hash = {})
-      @fields = object_attribute_hash == {} ? RubyZoho.configuration.api.fields(RubyZoho::Crm.module_name) :
+      @fields = object_attribute_hash == {} ? RubyZoho.configuration.api.fields(self.class.module_name) :
           object_attribute_hash.keys
       RubyZoho::Crm.create_accessor(self.class, @fields)
+      RubyZoho::Crm.create_accessor(self.class, [:module_name])
+      public_send(:module_name=, self.class.module_name)
+      update_or_create_attrs(object_attribute_hash)
+      self
+    end
+
+    def update_or_create_attrs(object_attribute_hash)
       retry_counter = object_attribute_hash.count
       begin
         object_attribute_hash.map { |(k, v)| public_send("#{k}=", v) }
       rescue NoMethodError => e
         m = e.message.slice(/`(.*?)=/)
-        unless m.nil?
-          m.gsub!('`', '')
-          m.gsub!('(', '')
-          m.gsub!(')', '')
-          RubyZoho::Crm.create_accessor(self.class, [m.chop])
-        end
+        RubyZoho::Crm.create_accessor(self.class, [m.gsub(/[`()]*/, '').chop]) unless m.nil?
         retry_counter -= 1
         retry if retry_counter > 0
       end
-      self
     end
 
     def attr_writers
@@ -103,6 +105,10 @@ module RubyZoho
       end
     end
 
+    def self.find(id)
+      self.find_by_id(id)
+    end
+
     def self.method_missing(meth, *args, &block)
       if meth.to_s =~ /^find_by_(.+)$/
         run_find_by_method($1, *args, &block)
@@ -111,29 +117,64 @@ module RubyZoho
       end
     end
 
+    def method_missing(meth, *args, &block)
+      if [:seid=, :semodule=].index(meth)
+        run_create_accessor(self.class, meth)
+        self.send(meth, args[0])
+      else
+        super
+      end
+    end
+
+    def self.method_is_module?(str_or_sym)
+      return nil if str_or_sym.nil?
+      s = str_or_sym.class == String ? str_or_sym : ApiUtils.symbol_to_string(str_or_sym)
+      possible_module = s[s.length - 1].downcase == 's' ? s : s + 's'
+      i = RubyZoho.configuration.crm_modules.index(possible_module.capitalize)
+      return str_or_sym unless i.nil?
+      nil
+    end
+
+    def run_create_accessor(klass, meth)
+      method = meth.to_s.chop.to_sym
+      RubyZoho::Crm.create_accessor(klass, [method])
+      nil
+    end
+
     def self.run_find_by_method(attrs, *args, &block)
       attrs = attrs.split('_and_')
       conditions = Array.new(args.size, '=')
       h = RubyZoho.configuration.api.find_records(
-          Crm.module_name, ApiUtils.string_to_symbol(attrs[0]), conditions[0], args[0]
+          self.module_name, ApiUtils.string_to_symbol(attrs[0]), conditions[0], args[0]
       )
       return h.collect { |r| new(r) } unless h.nil?
       nil
     end
 
     def self.all         #TODO Refactor into low level API
+      max_records = 200
       result = []
       i = 1
-      begin
-        batch = RubyZoho.configuration.api.some(Crm.module_name, i, 200)
-        i += 200
+      batch = []
+      until batch.nil?
+        batch = RubyZoho.configuration.api.some(self.module_name, i, max_records)
         result.concat(batch) unless batch.nil?
-      end while !batch.nil?
+        break if !batch.nil? && batch.count < max_records
+        i += max_records
+      end
       result.collect { |r| new(r) }
     end
 
+    def << object
+      object.semodule = self.module_name
+      object.seid = self.id
+      object.fields << :seid
+      object.fields << :semodule
+      save_object(object)
+    end
+
     def attach_file(file_path, file_name)
-      RubyZoho.configuration.api.attach_file(Crm.module_name, self.send(primary_key), file_path)
+      RubyZoho.configuration.api.attach_file(self.class.module_name, self.send(primary_key), file_path, file_name)
     end
 
     def create(object_attribute_hash)
@@ -142,18 +183,26 @@ module RubyZoho
     end
 
     def self.delete(id)
-      RubyZoho.configuration.api.delete_record(Crm.module_name, id)
+      RubyZoho.configuration.api.delete_record(self.module_name, id)
     end
 
     def primary_key
-      RubyZoho.configuration.api.primary_key(Crm::module_name)
+      RubyZoho.configuration.api.primary_key(self.class.module_name)
     end
 
     def save
       h = {}
       @fields.each { |f| h.merge!({ f => eval("self.#{f.to_s}") }) }
       h.delete_if { |k, v| v.nil? }
-      r = RubyZoho.configuration.api.add_record(Crm.module_name, h)
+      r = RubyZoho.configuration.api.add_record(self.class.module_name, h)
+      up_date(r)
+    end
+
+    def save_object(object)
+      h = {}
+      object.fields.each { |f| h.merge!({ f => object.send(f) }) }
+      h.delete_if { |k, v| v.nil? }
+      r = RubyZoho.configuration.api.add_record(object.module_name, h)
       up_date(r)
     end
 
@@ -161,58 +210,22 @@ module RubyZoho
       raise(RuntimeError, 'No ID found', object_attribute_hash.to_s) if object_attribute_hash[:id].nil?
       id = object_attribute_hash[:id]
       object_attribute_hash.delete(:id)
-      RubyZoho.configuration.api.update_record(Crm.module_name, id, object_attribute_hash)
+      r = RubyZoho.configuration.api.update_record(self.module_name, id, object_attribute_hash)
+      new(object_attribute_hash.merge!(r))
     end
 
     def up_date(object_attribute_hash)
-      retry_counter = object_attribute_hash.length
-      begin
-        object_attribute_hash.map { |(k, v)| public_send("#{k}=", v) }
-      rescue NoMethodError => e
-        m = e.message.slice(/`(.*?)=/)
-        unless m.nil?
-          m.gsub!('`', '')
-          m.gsub!('(', '')
-          m.gsub!(')', '')
-          RubyZoho::Crm.create_accessor(self.class, [m.chop])
-        end
-        retry_counter -= 1
-        retry if retry_counter > 0
-      end
+      update_or_create_attrs(object_attribute_hash)
       self
     end
 
-
     def self.setup_classes
       RubyZoho.configuration.crm_modules.each do |module_name|
         klass_name = module_name.chop
         c = Class.new(RubyZoho::Crm) do
           include RubyZoho
           attr_reader :fields
-
-          def initialize(object_attribute_hash = {})
-            klass = self.class.to_s
-            Crm.module_name = klass.slice(klass.rindex('::') + 2, klass.length) + 's'
-            super
-          end
-
-          def self.all
-            klass = self.to_s
-            Crm.module_name = klass.slice(klass.rindex('::') + 2, klass.length) + 's'
-            super
-          end
-
-          def self.delete(id)
-            klass = self.to_s
-            Crm.module_name = klass.slice(klass.rindex('::') + 2, klass.length) + 's'
-            super
-          end
-
-          def self.method_missing(meth, *args, &block)
-            klass = self.to_s
-            Crm.module_name = klass.slice(klass.rindex('::') + 2, klass.length) + 's'
-            super
-          end
+          @module_name = module_name
         end
         const_set(klass_name, c)
       end

data/lib/zoho_api.rb

@@ -42,7 +42,7 @@ module ZohoApi
           :headers => { 'Content-length' => '0' })
       check_for_errors(r)
       x_r = REXML::Document.new(r.body).elements.to_a('//recorddetail')
-      to_hash_with_id(x_r, module_name)[0]
+      to_hash(x_r, module_name)[0]
     end
 
     def add_field(row, field, value)
@@ -62,11 +62,11 @@ module ZohoApi
       tag
     end
 
-    def attach_file(module_name, record_id, file_path)
+    def attach_file(module_name, record_id, file_path, file_name)
       mime_type = (MIME::Types.type_for(file_path)[0] || MIME::Types["application/octet-stream"][0])
       url_path = create_url(module_name, "uploadFile?authtoken=#{@auth_token}&scope=crmapi&id=#{record_id}")
       url = URI.parse(create_url(module_name, url_path))
-      io = UploadIO.new(file_path, mime_type, file_path)
+      io = UploadIO.new(file_path, mime_type, file_name)
       req = Net::HTTP::Post::Multipart.new url_path, 'content' => io
       http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = true
@@ -92,12 +92,7 @@ module ZohoApi
     end
 
     def delete_record(module_name, record_id)
-      r = self.class.post(create_url(module_name, 'deleteRecords'),
-        :query => { :newFormat => 1, :authtoken => @auth_token,
-          :scope => 'crmapi', :id => record_id },
-        :headers => { 'Content-length' => '0' })
-      raise('Adding contact failed', RuntimeError, r.response.body.to_s) unless r.response.code == '200'
-      check_for_errors(r)
+      post_action(module_name, record_id, 'deleteRecords')
     end
 
     def fields(module_name)
@@ -129,7 +124,7 @@ module ZohoApi
     end
 
     def find_records(module_name, field, condition, value)
-      sc_field = ApiUtils.symbol_to_string(field)
+      sc_field = field == :id ? primary_key(module_name) : ApiUtils.symbol_to_string(field)
       return find_record_by_related_id(module_name, sc_field, value) if related_id?(module_name, sc_field)
       primary_key?(module_name, sc_field) == false ? find_record_by_field(module_name, sc_field, condition, value) :
           find_record_by_id(module_name, value)
@@ -144,7 +139,7 @@ module ZohoApi
                                     :fromIndex => 1, :toIndex => NUMBER_OF_RECORDS_TO_GET})
       check_for_errors(r)
       x = REXML::Document.new(r.body).elements.to_a("/response/result/#{module_name}/row")
-      to_hash(x)
+      to_hash(x, module_name)
     end
 
     def find_record_by_id(module_name, id)
@@ -154,7 +149,7 @@ module ZohoApi
       raise(RuntimeError, 'Bad query', "#{module_name} #{id}") 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)
+      to_hash(x, module_name)
     end
 
     def find_record_by_related_id(module_name, sc_field, value)
@@ -167,43 +162,22 @@ module ZohoApi
              :searchValue => value})
       check_for_errors(r)
       x = REXML::Document.new(r.body).elements.to_a("/response/result/#{module_name}/row")
-      to_hash(x)
-    end
-
-    def valid_related?(module_name, field)
-      return nil if field.downcase == 'smownerid'
-      valid_relationships = {
-          'Leads' => %w(email),
-          'Accounts' => %w(accountid accountname),
-          'Contacts' => %w(contactid accountid vendorid email),
-          'Potentials' => %w(potentialid accountid campaignid contactid potentialname),
-          'Campaigns' => %w(campaignid campaignname),
-          'Cases' => %w(caseid productid accountid potentialid),
-          'Solutions' => %w(solutionid productid),
-          'Products' => %w(productid vendorid productname),
-          'Purchase Order' => %w(purchaseorderid contactid vendorid),
-          'Quotes' => %w(quoteid potentialid accountid contactid),
-          'Sales Orders' => %w(salesorderid potentialid accountid contactid quoteid),
-          'Invoices' => %w(invoiceid accountid salesorderid contactid),
-          'Vendors' => %w(vendorid vendorname),
-          'Tasks' => %w(taskid),
-          'Events' => %w(eventid),
-          'Notes' => %w(notesid)
-      }
-      valid_relationships[module_name].index(field.downcase)
-    end
-
-    def related_id?(module_name, field_name)
-      field = field_name.to_s
-      return false if field.rindex('id').nil?
-      return false if %w[Calls Events Tasks].index(module_name) && field_name.downcase == 'activityid'
-      field.downcase.gsub('id', '') != module_name.chop.downcase
+      to_hash(x, module_name)
     end
 
     def method_name?(n)
       return /[@$"]/ !~ n.inspect
     end
 
+    def post_action(module_name, record_id, action_type)
+      r = self.class.post(create_url(module_name, action_type),
+                          :query => {:newFormat => 1, :authtoken => @auth_token,
+                                     :scope => 'crmapi', :id => record_id},
+                          :headers => {'Content-length' => '0'})
+      raise('Adding contact failed', RuntimeError, r.response.body.to_s) unless r.response.code == '200'
+      check_for_errors(r)
+    end
+
     def primary_key(module_name)
       activity_keys = { 'Tasks' => :activityid, 'Events' => :activityid, 'Calls' => :activityid }
       return activity_keys[module_name] unless activity_keys[module_name].nil?
@@ -211,8 +185,18 @@ module ZohoApi
     end
 
     def primary_key?(module_name, field_name)
-      return true if %w[Calls Events Tasks].index(module_name) && field_name.downcase == 'activityid'
-      field_name.downcase.gsub('id', '') == module_name.chop.downcase
+      return nil if field_name.nil? || module_name.nil?
+      fn = field_name.class == String ? field_name : field_name.to_s
+      return true if fn == 'id'
+      return true if %w[Calls Events Tasks].index(module_name) && fn.downcase == 'activityid'
+      fn.downcase.gsub('id', '') == module_name.chop.downcase
+    end
+
+    def related_id?(module_name, field_name)
+      field = field_name.to_s
+      return false if field.rindex('id').nil?
+      return false if %w[Calls Events Tasks].index(module_name) && field_name.downcase == 'activityid'
+      field.downcase.gsub('id', '') != module_name.chop.downcase
     end
 
     def reflect_module_fields
@@ -236,17 +220,19 @@ module ZohoApi
       return nil unless r.response.code == '200'
       check_for_errors(r)
       x = REXML::Document.new(r.body).elements.to_a("/response/result/#{module_name}/row")
-      to_hash(x)
+      to_hash(x, module_name)
     end
 
-    def to_hash(xml_results)
+    def to_hash(xml_results, module_name)
       r = []
       xml_results.each do |e|
         record = {}
+        record[:module_name] = module_name
         e.elements.to_a.each do |n|
           k = ApiUtils.string_to_symbol(n.attribute('val').to_s.gsub('val=', ''))
           v = n.text == 'null' ? nil : n.text
           record.merge!({ k => v })
+          record.merge!({ :id => v }) if primary_key?(module_name, k)
         end
         r << record
       end
@@ -255,13 +241,7 @@ module ZohoApi
     end
 
     def to_hash_with_id(xml_results, module_name)
-      h = to_hash(xml_results)
-      primary_key = module_name.chop.downcase + 'id'
-      h.each do |e|
-        e.merge!({ primary_key.to_sym => e[:id] }) if e[primary_key.to_sym].nil? && !e[:id].nil?
-        e.merge!({ e[:id] => primary_key.to_sym }) if e[:id].nil? && !e[primary_key.to_sym].nil?
-      end
-      h
+      to_hash(xml_results, module_name)
     end
 
     def update_module_fields(mod_name, module_name, r)
@@ -287,8 +267,8 @@ module ZohoApi
                       :xmlData => x },
           :headers => { 'Content-length' => '0' })
       check_for_errors(r)
-      raise('Updating record failed', RuntimeError, r.response.body.to_s) unless r.response.code == '200'
-      r.response.code
+      x_r = REXML::Document.new(r.body).elements.to_a('//recorddetail')
+      to_hash_with_id(x_r, module_name)[0]
     end
 
     def user_fields
@@ -316,6 +296,29 @@ module ZohoApi
       @@users = result
     end
 
+    def valid_related?(module_name, field)
+      return nil if field.downcase == 'smownerid'
+      valid_relationships = {
+          'Leads' => %w(email),
+          'Accounts' => %w(accountid accountname),
+          'Contacts' => %w(contactid accountid vendorid email),
+          'Potentials' => %w(potentialid accountid campaignid contactid potentialname),
+          'Campaigns' => %w(campaignid campaignname),
+          'Cases' => %w(caseid productid accountid potentialid),
+          'Solutions' => %w(solutionid productid),
+          'Products' => %w(productid vendorid productname),
+          'Purchase Order' => %w(purchaseorderid contactid vendorid),
+          'Quotes' => %w(quoteid potentialid accountid contactid),
+          'Sales Orders' => %w(salesorderid potentialid accountid contactid quoteid),
+          'Invoices' => %w(invoiceid accountid salesorderid contactid),
+          'Vendors' => %w(vendorid vendorname),
+          'Tasks' => %w(taskid),
+          'Events' => %w(eventid),
+          'Notes' => %w(notesid)
+      }
+      valid_relationships[module_name].index(field.downcase)
+    end
+
   end
 
 end

data/rubyzoho.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rubyzoho"
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["amalc"]
-  s.date = "2013-02-20"
+  s.date = "2013-02-24"
   s.description = ""
   s.email = ""
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "lib/api_utils.rb",
     "lib/ruby_zoho.rb",
     "lib/zoho_api.rb",
+    "rubyzoho-0.1.6.gem",
     "rubyzoho.gemspec",
     "spec/api_utils_spec.rb",
     "spec/fixtures/sample.pdf",
@@ -56,6 +57,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<multipart-post>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 1.2"])
       s.add_development_dependency(%q<cucumber>, [">= 1.2.1"])
+      s.add_development_dependency(%q<holepicker>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<relish>, [">= 0.6"])
       s.add_development_dependency(%q<rdoc>, [">= 3.12.1"])
@@ -67,6 +69,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<multipart-post>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 1.2"])
       s.add_dependency(%q<cucumber>, [">= 1.2.1"])
+      s.add_dependency(%q<holepicker>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<relish>, [">= 0.6"])
       s.add_dependency(%q<rdoc>, [">= 3.12.1"])
@@ -79,6 +82,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<multipart-post>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 1.2"])
     s.add_dependency(%q<cucumber>, [">= 1.2.1"])
+    s.add_dependency(%q<holepicker>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<relish>, [">= 0.6"])
     s.add_dependency(%q<rdoc>, [">= 3.12.1"])

data/spec/ruby_zoho_spec.rb

@@ -7,13 +7,9 @@ describe RubyZoho::Crm do
 
   before(:all) do
     base_path = File.join(File.dirname(__FILE__), 'fixtures')
-    config_file = File.join(base_path, 'zoho_api_configuration.yaml')
     @sample_pdf = File.join(base_path, 'sample.pdf')
-    #params = YAML.load(File.open(config_file))
     RubyZoho.configure do |config|
-      #config.api_key = params['auth_token']
-      #config.api_key = 'e194b2951fb238e26bc096de9d0cf5f8'
-      config.api_key = '62cedfe9427caef8afb9ea3b5bf68154'
+      config.api_key =  ENV['ZOHO_API_KEY'].strip
       config.crm_modules = %w(Quotes)
       config.cache_fields = true
     end
@@ -29,11 +25,12 @@ describe RubyZoho::Crm do
     c.first_name.should eq('Raj')
     c.email = 'raj@portra.com'
     c.email.should eq('raj@portra.com')
+    c.module_name.should eq('Contacts')
   end
 
   it 'should attach a file to an account' do
     r = RubyZoho::Crm::Account.all.first
-    r.attach_file(@sample_pdf, File.basename(@sample_pdf)).should eq('200')
+    r.attach_file(@sample_pdf, '1_' + File.basename(@sample_pdf)).should eq('200')
   end
 
   it 'should attach a file to a contact' do
@@ -56,9 +53,31 @@ describe RubyZoho::Crm do
     r.attach_file(@sample_pdf, File.basename(@sample_pdf)).should eq('200')
   end
 
+  it 'should concatenate a related object and save it' do
+    subject = "[DELETE THIS] New subject as of #{Time.now}"
+    a = RubyZoho::Crm::Account.all.last
+    a << RubyZoho::Crm::Task.new(
+        :subject => subject,
+        :description => 'Nothing',
+        :status => 'Not Started',
+        :priority => 'High',
+        :send_notification_email => 'False',
+        :due_date => '2014-02-16 16:00:00',
+        :start_datetime => Time.now.to_s[1,19],
+        :end_datetime => '2014-02-16 16:00:00'
+    )
+    r = RubyZoho::Crm::Task.find_by_subject(subject)
+    r.first.relatedtoid.should eq(a.accountid)
+  end
+
+  it 'should determine if a method is a module' do
+    good_methods = [:contact, :contacts, 'contacts', 'lead', 'leads', :potentials, :quotes]
+    good_methods.map { |m| RubyZoho::Crm.method_is_module?(m).should_not eq(nil) }
+  end
+
   it 'should find a contact by email or last name' do
     r = RubyZoho::Crm::Contact.find_by_email('bob@smith.com')
-    r.each { |m| RubyZoho::Crm::Contact.delete(m.contactid) } unless r.nil?
+    r.each { |m| RubyZoho::Crm::Contact.delete(m.id) } unless r.nil?
     1.upto(3) do
       c = RubyZoho::Crm::Contact.new(
         :first_name => 'Bob',
@@ -74,21 +93,21 @@ describe RubyZoho::Crm do
     r.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) }
+    r.each { |m| RubyZoho::Crm::Contact.delete(m.id) }
   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)
+    id = contacts.first.id
+    c = RubyZoho::Crm::Contact.find_by_contactid(id)
+    c.first.contactid.should eq(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
+    lead_id = leads.first.id
     l = RubyZoho::Crm::Lead.find_by_leadid(lead_id)
     l.first.leadid.should eq(lead_id)
   end
@@ -136,42 +155,50 @@ describe RubyZoho::Crm do
   end
 
   it 'should get a list of calls' do
-    pending
+    #pending
     r = RubyZoho::Crm::Call.all
-    r.count.should be > 1  unless r.nil?
-    r.map { |r| r.class.should eq(RubyZoho::Crm::Call) }  unless r.nil?
+    unless r.nil?
+      #r.count.should be > 1
+      r.map { |e| e.class.should eq(RubyZoho::Crm::Call) }
+      r.map { |e| e.id.should eq(e.activityid)}
+    end
   end
 
   it 'should get a list of contacts' do
     r = RubyZoho::Crm::Contact.all
     r.count.should be > 1
-    r.map { |r| r.class.should eq(RubyZoho::Crm::Contact) }
+    r.map { |e| e.class.should eq(RubyZoho::Crm::Contact) }
+    r.map { |e| e.id.should eq(e.contactid)}
   end
 
   it 'should get a list of events' do
     r = RubyZoho::Crm::Event.all
     r.map { |r| r.class.should eq(RubyZoho::Crm::Event) } unless r.nil?
+    r.map { |e| e.id.should eq(e.eventid)}
   end
 
   it 'should get a list of potentials' do
     r = RubyZoho::Crm::Potential.all
     r.count.should be > 1
     r.map { |r| r.class.should eq(RubyZoho::Crm::Potential) }
+    r.map { |e| e.id.should eq(e.potentialid)}
   end
 
   it 'should get a list of quotes' do
     r = RubyZoho::Crm::Quote.all
     r.count.should be >= 1
     r.map { |r| r.class.should eq(RubyZoho::Crm::Quote) }
+    r.map { |e| e.id.should eq(e.quoteid)}
   end
 
   it 'should get a list of tasks' do
     r = RubyZoho::Crm::Task.all
     r.map { |r| r.class.should eq(RubyZoho::Crm::Task) } unless r.nil?
+    r.map { |e| e.id.should eq(e.activityid)}
   end
 
   it 'should get a list of users' do
-    r = RubyZoho::Crm::User.all
+    pp r = RubyZoho::Crm::User.all
     r.count.should be >= 1
   end
 
@@ -195,7 +222,7 @@ describe RubyZoho::Crm do
     r = RubyZoho::Crm::Lead.find_by_email('raj@portra.com')
     r.should_not eq(nil)
     r.first.email.should eq(l.email)
-    r.each { |c|  RubyZoho::Crm::Lead.delete(c.leadid) }
+    r.each { |c|  RubyZoho::Crm::Lead.delete(c.id) }
   end
 
   it 'should save and retrieve an account record with a custom field' do
@@ -203,10 +230,10 @@ describe RubyZoho::Crm do
     a = accounts.first
     if defined?(a.par_ltd)
       RubyZoho::Crm::Lead.update(
-          :id => a.accountid,
+          :id => a.id,
           :test_custom => '$1,000,000'
       )
-      a2 = RubyZoho::Crm::Account.find_by_accountid(a.accountid)
+      a2 = RubyZoho::Crm::Account.find(a.accountid)
       a2.first.test_custom.should eq('$1,000,000')
     end
   end
@@ -226,7 +253,7 @@ describe RubyZoho::Crm do
     p.save
     r = RubyZoho::Crm::Potential.find_by_potential_name(p.potential_name)
     r.first.potential_name.should eq(h[:potential_name])
-    potential = RubyZoho::Crm::Potential.find_by_potentialid(r.first.potentialid)
+    potential = RubyZoho::Crm::Potential.find(r.first.potentialid)
     potential.first.potentialid.should eq(r.first.potentialid)
     p_by_account_id = RubyZoho::Crm::Potential.find_by_accountid(accounts.first.accountid)
     p_found = p_by_account_id.map { |pn| pn if pn.potential_name == h[:potential_name]}.compact
@@ -255,16 +282,11 @@ describe RubyZoho::Crm do
   end
 
   it 'should save an task record related to an account' do
-    pending
     a = RubyZoho::Crm::Account.all.first
-    #u = RubyZoho::Crm::User.all.first
-    #c = RubyZoho::Crm::Contact.all.last
-    #pp tasks = RubyZoho::Crm::Task.all
-    #throw :stop
-    e = RubyZoho::Crm::Tassk.new(
+    e = RubyZoho::Crm::Task.new(
         :task_owner =>  a.account_owner,
         :subject => "Task should be related to #{a.account_name} #{Time.now}",
-        #:description => 'Nothing',
+        :description => 'Nothing',
         :smownerid => "#{a.smownerid}",
         :status => 'Not Started',
         :priority => 'High',
@@ -273,19 +295,20 @@ describe RubyZoho::Crm do
         :start_datetime => Time.now.to_s[1,19],
         :end_datetime => '2014-02-16 16:00:00',
         :related_to => "#{a.account_name}",
-        :relatedtoid => "#{a.accountid}",
+        :seid => "#{a.accountid}",
         :semodule => "Accounts"
-        #:contact_name => "#{c.first_name} #{c.last_name}",
-        #:contactid => c.contactid
     )
-    pp e.save
+    r_expected  = e.save
+    r = RubyZoho::Crm::Task.find_by_activityid(r_expected.id)
+    r.first.subject.should eq(r_expected.subject)
   end
 
   it 'should get tasks by user' do
-    #pp u = RubyZoho::Crm::User.all.first
-    #pp tasks = RubyZoho::Crm::Task.find_by_smownerid(u.id)
-    #pp tasks = RubyZoho::Crm::Task.all
-    #tasks.map { |t| RubyZoho::Crm::Task.delete(t.activityid)} unless tasks.nil?
+    pending
+    pp u = RubyZoho::Crm::User.all.first
+    pp tasks = RubyZoho::Crm::Task.find_by_smownerid(u.id)
+    pp tasks = RubyZoho::Crm::Task.all
+    tasks.map { |t| RubyZoho::Crm::Task.delete(t.activityid)} unless tasks.nil?
   end
 
   it 'should sort contact records' do
@@ -295,6 +318,8 @@ describe RubyZoho::Crm do
   end
 
   it 'should update a lead record' do
+    r_changed = RubyZoho::Crm::Lead.find_by_email('changed_raj@portra.com')
+    r_changed.each { |c|  RubyZoho::Crm::Lead.delete(c.leadid) } unless r_changed.nil?
     l = RubyZoho::Crm::Lead.new(
       :first_name => 'Raj',
       :last_name => 'Portra',
@@ -307,8 +332,8 @@ describe RubyZoho::Crm do
     )
     r_changed = RubyZoho::Crm::Lead.find_by_email('changed_raj@portra.com')
     r.first.leadid.should eq(r_changed.first.leadid)
-    r_changed.should_not eq(nil)
     r.each { |c|  RubyZoho::Crm::Lead.delete(c.leadid) }
+    r_changed.each { |c|  RubyZoho::Crm::Lead.delete(c.leadid) }
   end
 
   it 'should validate a field name' do

data/spec/zoho_api_spec.rb

@@ -33,15 +33,9 @@ describe ZohoApi do
 
   before(:all) do
     base_path = File.join(File.dirname(__FILE__), 'fixtures')
-    config_file = File.join(base_path, 'zoho_api_configuration.yaml')
-    #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', 'Events', 'Leads', 'Tasks', 'Potentials']
-    #api_key = '783539943dc16d7005b0f3b78367d5d2'
-    api_key = 'e194b2951fb238e26bc096de9d0cf5f8'
-    #api_key = '62cedfe9427caef8afb9ea3b5bf68154'
-    @zoho = init_api(api_key, base_path, modules)
+    @zoho = init_api(ENV['ZOHO_API_KEY'].strip, base_path, modules)
     @h_smith = { :first_name => 'Robert',
           :last_name => 'Smith',
           :email => 'rsmith@smithereens.com',
@@ -84,14 +78,14 @@ describe ZohoApi do
   it 'should attach a file to a contact record' do
     @zoho.add_record('Contacts', @h_smith)
     contacts = @zoho.find_records('Contacts', :email, '=', @h_smith[:email])
-    @zoho.attach_file('Contacts', contacts[0][:contactid], @sample_pdf)
+    @zoho.attach_file('Contacts', contacts[0][:contactid], @sample_pdf, File.basename(@sample_pdf))
     @zoho.delete_record('Contacts', contacts[0][:contactid])
   end
 
   it 'should attach a file to a potential record' do
     pending
     potential = @zoho.first('Potentials').first
-    @zoho.attach_file('Potentials', potential[:potentialid], @sample_pdf)
+    @zoho.attach_file('Potentials', potential[:potentialid], @sample_pdf, File.basename(@sample_pdf))
   end
 
   it 'should delete a contact record with id' do
@@ -146,15 +140,15 @@ describe ZohoApi do
 
   it 'should get a list of fields for a module' do
     r = @zoho.fields('Accounts')
-    r.count.should >= 25
+    r.count.should >= 10
     r = @zoho.fields('Contacts')
-    r.count.should be >= 21
+    r.count.should be >= 10
     r = @zoho.fields('Events')
     r.count.should >= 10
     r = @zoho.fields('Leads')
-    r.count.should be >= 16
+    r.count.should be >= 10
     r = @zoho.fields('Potentials')
-    r.count.should be >= 15
+    r.count.should be >= 10
     r = @zoho.fields('Tasks')
     r.count.should >= 10
     r = @zoho.fields('Users')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyzoho
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: holepicker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +207,7 @@ files:
 - lib/api_utils.rb
 - lib/ruby_zoho.rb
 - lib/zoho_api.rb
+- rubyzoho-0.1.6.gem
 - rubyzoho.gemspec
 - spec/api_utils_spec.rb
 - spec/fixtures/sample.pdf