rubyzoho 0.1.2 → 0.1.3

data/.travis.yml

@@ -1,5 +1,17 @@
+---
 language: ruby
 rvm:
-  - 1.9.3
-  # - jruby-19mode # JRuby in 1.9 mode
-  # - rbx-19mode
+- 1.9.3
+# - jruby
+
+matrix:
+  allow-failures:
+    - rvm: jruby
+
+env:
+  global:
+  - secure: ! 'E2ZilvytrU4gPdPZna7EMJmrDHQPfjo7KLnY4geip1coSrmISaf3VhKlGMDY
+
+      NubPbNdM6K98F98hQfMszGjt7YJz8y5dJrpwT4847ZL9k0FLN8XsjdxW7gH4
+
+      Dqocd1v5HY2gK60quwr0YPza10bgw6XseYXlrMtVgpTFOYv5HTg='

data/Gemfile

@@ -1,25 +1,21 @@
-source "http://rubygems.org"
-
-gem 'httmultiparty'
-gem 'roxml'
+source 'http://rubygems.org'
 
+gem 'httmultiparty', '>= 0.3.8'
+gem 'roxml', '>= 3.3.1'
+gem 'multipart-post'
 
 group :test do
-  gem 'cucumber'
-  gem 'rspec', ">= 2.12.0"
-  gem "shoulda", ">= 0"
-  gem 'xml-simple'
-  gem 'simplecov', :require => false, :group => :test
+  gem 'rspec', '>= 2.12.0'
+  gem 'xml-simple', '>=1.1.2'
+  gem 'simplecov', '>= 0.7.1', :require => false, :group => :test
 end
 
 group :development do
-  gem "bundler"
-  gem 'cucumber'
-  gem "jeweler", "~> 1.8.4"
-  gem 'relish'
-  gem "rdoc"
-  gem 'rspec', ">= 2.12.0"
-  gem "shoulda", ">= 0"
-  gem 'xml-simple'
-  gem 'simplecov', :require => false, :group => :test
+  gem 'bundler', '>= 1.2'
+  gem 'cucumber', '>= 1.2.1'
+  gem 'jeweler', '~> 1.8.4'
+  gem 'relish', '>= 0.6'
+  gem 'rdoc', '>= 3.12.1'
+  gem 'rspec', '>= 2.12.0'
+  gem 'xml-simple', '>=1.1.2'
 end

data/README.rdoc

@@ -5,7 +5,7 @@
 = 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.
+ActiveRecord lifecycle, but without ActiveRecord. Current focus is on Zoho CRM.
 
 == Install
     gem install rubyzoho
@@ -32,11 +32,12 @@ Make sure the following block is executed prior to making calls to the gem.
     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 = ['Accounts', 'Contacts', 'Leads', 'Potentials', 'Quotes', 'SalesOrders', 'Invoices'] # Depending on what kind of account you've got
+      # 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
 
 Please be aware that Zoho limits API calls. So running tests repeatedly will quickly exhaust
-your daily allowance.
+your daily allowance. See below for some optimizations during development and testing.
 
 
 
@@ -81,6 +82,11 @@ To get a list of all accounts:
       pp account.account_name
     end
 
+Or for all task subjects:
+
+    t = RubyZoho::Crm::Task.all
+    pp t.collect { |task| task.subject }
+
 Or for all quotes:
 
     q = RubyZoho::Crm::Quote.all
@@ -134,7 +140,7 @@ To add a contact to an existing account:
     )
     c.save
 
-To update a record:
+To update a record (<b>Note, that the attribute is :id</b>):
     l = RubyZoho::Crm::Lead.find_by_email('email@domain.com')
     RubyZoho::Crm::Lead.update(
         :id => l.first.leadid,
@@ -152,11 +158,44 @@ Objects currently supported are:
     RubyZoho::Crm::Quote
     RubyZoho::Crm::User
 
+== Error Handling
+Errors, i.e. situations where the Zoho API either returns an http code something other than 200
+or where the Zoho API sends back an explicit error code which <b>isn't</b> in the set
+
+    ['4422', '5000']
+
+a standard Ruby +RuntimeError+ exception is raised with the Zoho API message.
+
+== Optimizations for Development and Testing
+Set <tt>config.cache_fields = true</tt> in the configuration block. This caches \module field
+lists and is useful during development and testing, to reduce total API calls during start up.
+Defaults to false. We <b>do not</b> recommend use of this in production. The gem will need
+write access to its own directory for this to work.
+
+    RubyZoho.configure do |config|
+      # Other stuff for initialization
+      config.cache_fields = true
+    end
+
+== Idiosyncractic Behavior
+    From freedictionary.com
+    id·i·o·syn·cra·sy ( d - -s ng kr -s ). n. pl. id·i·o·syn·cra·sies.
+    1. A structural or behavioral characteristic peculiar to an individual or group.
+
+
+The Zoho API is definitely opinionated. And we have yet to be able plumb the depths of its
+views. If it behaves unexpectedly, try the Zoho forums before opening an issue here. It
+just may be the way the API works...
+
+An example of this is retrieving related records. You would think that since a Task can
+be related to an Account or a Potential etc. that you should be able to retrieve it by
+either the related \module's record id, which is stored with the Task. But no, can't be done.
 
-==Bugs and Enhancments
+== Bugs and Enhancements
 Please open an issue on GitHub. Or better yet, send in a pull request with the fix or enhancement!
 
----
+=== Known Bugs
+1. Caching is causing a problem with Quotes.
 
 == Contributing to rubyzoho
 
@@ -169,12 +208,13 @@ Please open an issue on GitHub. Or better yet, send in a pull request with the f
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * 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.
 
+---
+
 == 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. Released under the MIT license. See LICENSE.txt for

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/ruby_zoho.rb

@@ -1,15 +1,17 @@
 require 'zoho_api'
 require 'api_utils'
+require 'yaml'
 
 
 module RubyZoho
 
   class Configuration
-    attr_accessor :api, :api_key, :crm_modules
+    attr_accessor :api, :api_key, :cache_fields, :crm_modules
 
     def initialize
       self.api_key = nil
       self.api = nil
+      self.cache_fields = false
       self.crm_modules = nil
     end
   end
@@ -22,10 +24,25 @@ module RubyZoho
     self.configuration ||= Configuration.new
     yield(configuration) if block_given?
     self.configuration.crm_modules ||= []
-    self.configuration.api = ZohoApi::Crm.new(self.configuration.api_key, self.configuration.crm_modules)
+    self.configuration.crm_modules = %w[Accounts Calls Contacts Events Leads Potentials Tasks].concat(
+        self.configuration.crm_modules).uniq
+    self.configuration.api = init_api(self.configuration.api_key,
+        self.configuration.crm_modules, self.configuration.cache_fields)
+    RubyZoho::Crm.setup_classes()
   end
 
-
+  def self.init_api(api_key, modules, cache_fields)
+    base_path = File.join(File.dirname(__FILE__), '..', 'spec', 'fixtures')
+    if File.exists?(File.join(base_path, 'fields.snapshot')) && cache_fields == true
+      fields = YAML.load(File.read(File.join(base_path, 'fields.snapshot')))
+      zoho = ZohoApi::Crm.new(api_key, modules, fields)
+    else
+      zoho = ZohoApi::Crm.new(api_key, modules)
+      fields = zoho.module_fields
+      File.open(File.join(base_path, 'fields.snapshot'), 'wb') { |file| file.write(fields.to_yaml) } if cache_fields == true
+    end
+    zoho
+  end
 
   class Crm
 
@@ -44,6 +61,8 @@ module RubyZoho
         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
@@ -52,7 +71,6 @@ module RubyZoho
       self
     end
 
-
     def attr_writers
       self.methods.grep(/\w=$/)
     end
@@ -137,192 +155,42 @@ module RubyZoho
       RubyZoho.configuration.api.update_record(Crm.module_name, id, object_attribute_hash)
     end
 
-
-    class Account < RubyZoho::Crm
-      include RubyZoho
-      attr_reader :fields
-      Crm.module_name = 'Accounts'
-
-      def initialize(object_attribute_hash = {})
-        Crm.module_name = 'Accounts'
-        super
-      end
-
-      def self.all
-        Crm.module_name = 'Accounts'
-        super
-      end
-
-      def self.delete(id)
-        Crm.module_name = 'Accounts'
-        super
-      end
-
-      def self.method_missing(meth, *args, &block)
-        Crm.module_name = 'Accounts'
-        super
-      end
-    end
-
-
-    class Contact < RubyZoho::Crm
-      include RubyZoho
-      attr_reader :fields
-      Crm.module_name = 'Contacts'
-
-      def initialize(object_attribute_hash = {})
-        Crm.module_name = 'Contacts'
-        super
-      end
-
-      def self.all
-        Crm.module_name = 'Contacts'
-        super
-      end
-
-      def self.method_missing(meth, *args, &block)
-        Crm.module_name = 'Contacts'
-        super
-      end
-
-      def self.delete(id)
-        Crm.module_name = 'Contacts'
-        super
-      end
-    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
-      Crm.module_name = 'Leads'
-
-      def initialize(object_attribute_hash = {})
-        Crm.module_name = 'Leads'
-        super
-      end
-
-      def self.all
-        Crm.module_name = 'Leads'
-        super
-      end
-
-      def self.delete(id)
-        Crm.module_name = 'Leads'
-        super
-      end
-
-      def self.method_missing(meth, *args, &block)
-        Crm.module_name = 'Leads'
-        super
-      end
-    end
-
-    class Potential < RubyZoho::Crm
-      include RubyZoho
-      attr_reader :fields
-      Crm.module_name = 'Potentials'
-
-      def initialize(object_attribute_hash = {})
-        Crm.module_name = 'Potentials'
-        super
-      end
-
-      def self.all
-        Crm.module_name = 'Potentials'
-        super
-      end
-
-      def self.delete(id)
-        Crm.module_name = 'Potentials'
-        super
-      end
-
-      def self.method_missing(meth, *args, &block)
-        Crm.module_name = 'Potentials'
-        super
-      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
-      Crm.module_name = 'Quotes'
-
-      def initialize(object_attribute_hash = {})
-        Crm.module_name = 'Quotes'
-        super
-      end
-
-      def self.all
-        Crm.module_name = 'Quotes'
-        super
-      end
-
-      def self.delete(id)
-        Crm.module_name = 'Quotes'
-        super
-      end
-
-      def self.method_missing(meth, *args, &block)
-        Crm.module_name = 'Quotes'
-        super
+    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
+        end
+        const_set(klass_name, c)
       end
     end
 
-    class User < RubyZoho::Crm
+    c = Class.new(RubyZoho::Crm) do
       def initialize(object_attribute_hash = {})
         Crm.module_name = 'Users'
         super
@@ -353,6 +221,7 @@ module RubyZoho
       end
     end
 
-  end
+    Kernel.const_set 'User', c
 
+  end
 end

data/lib/zoho_api.rb

@@ -24,10 +24,10 @@ module ZohoApi
 
     attr_reader :auth_token, :module_fields
 
-    def initialize(auth_token, modules)
+    def initialize(auth_token, modules, fields = nil)
       @auth_token = auth_token
       @modules = %w(Accounts Contacts Events Leads Potentials Tasks Users).concat(modules).uniq
-      @module_fields = reflect_module_fields
+      @module_fields = fields.nil? ? reflect_module_fields : fields
     end
 
     def add_record(module_name, fields_values_hash)
@@ -35,6 +35,7 @@ module ZohoApi
       element = x.add_element module_name
       row = element.add_element 'row', { 'no' => '1'}
       fields_values_hash.each_pair { |k, v| add_field(row, ApiUtils.symbol_to_string(k), v) }
+      #pp x.to_s
       r = self.class.post(create_url(module_name, 'insertRecords'),
           :query => { :newFormat => 1, :authtoken => @auth_token,
                       :scope => 'crmapi', :xmlData => x },
@@ -56,8 +57,6 @@ module ZohoApi
             :scope => 'crmapi',
             :id => record_id, :content => File.open(file_path) },
           :headers => { 'Content-length' => '0' })
-      pp r.code
-      pp r.body
       raise(RuntimeError, 'Attaching file failed.', r.body.to_s) unless r.response.code == '200'
       r.code
     end
@@ -65,7 +64,6 @@ module ZohoApi
     def add_file(module_name, record_id, file_path)
       url = URI.parse(create_url(module_name, 'uploadFile'))
       r = nil
-      pp record_id
       mime_type = (MIME::Types.type_for(file_path)[0] || MIME::Types["application/octet-stream"][0])
       f = File.open(file_path)
       req = Net::HTTP::Post::Multipart.new url.path,
@@ -74,9 +72,7 @@ module ZohoApi
         'content' => UploadIO.new(f, mime_type, File.basename(file_path)) }
       http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = true
-      pp req.to_hash
       r = http.start { |http| http.request(req) }
-      pp r.body.to_s
       (r.nil? or r.body.nil? or r.body.empty?) ? nil : REXML::Document.new(r.body).to_s
     end
 
@@ -129,12 +125,14 @@ module ZohoApi
 
     def find_records(module_name, field, condition, value)
       sc_field = ApiUtils.symbol_to_string(field)
-      sc_field.rindex('id').nil? ? find_record_by_field(module_name, sc_field, condition, value) :
+      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)
     end
 
     def find_record_by_field(module_name, sc_field, condition, value)
-      search_condition = '(' + sc_field + '|' + condition + '|' + value + ')'
+      field = sc_field.rindex('id') ? sc_field.downcase : sc_field
+      search_condition = '(' + field + '|' + condition + '|' + value + ')'
       r = self.class.get(create_url("#{module_name}", 'getSearchRecords'),
                          :query => {:newFormat => 1, :authtoken => @auth_token, :scope => 'crmapi',
                                     :selectColumns => 'All', :searchCondition => search_condition,
@@ -154,10 +152,57 @@ module ZohoApi
       to_hash(x)
     end
 
+    def find_record_by_related_id(module_name, sc_field, value)
+      raise(RuntimeError, "[RubyZoho] Not a valid query field #{sc_field} for module #{module_name}") unless
+          valid_related?(module_name, sc_field)
+      field = sc_field.downcase
+      r = self.class.get(create_url("#{module_name}", 'getSearchRecordsByPDC'),
+         :query => { :newFormat => 1, :authtoken => @auth_token, :scope => 'crmapi',
+             :selectColumns => 'All', :version => 2, :searchColumn => field,
+             :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)
+      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
+    end
+
     def method_name?(n)
       return /[@$"]/ !~ n.inspect
     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
+    end
+
     def reflect_module_fields
       @modules.each { |m| fields(m) }
       @@module_fields
@@ -168,11 +213,8 @@ module ZohoApi
          :query => { :newFormat => 1, :authtoken => @auth_token, :scope => 'crmapi',
                      :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 check_for_errors(r)
-      return nil unless check_for_errors(r).nil?
+      check_for_errors(r)
     end
 
     def some(module_name, index = 1, number_of_records = nil)

data/rubyzoho.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rubyzoho"
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["amalc"]
-  s.date = "2013-02-18"
+  s.date = "2013-02-19"
   s.description = ""
   s.email = ""
   s.extra_rdoc_files = [
@@ -22,7 +22,6 @@ Gem::Specification.new do |s|
     ".rvmrc",
     ".travis.yml",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
@@ -30,7 +29,6 @@ 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",
@@ -46,49 +44,46 @@ 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
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httmultiparty>, [">= 0"])
-      s.add_runtime_dependency(%q<roxml>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_runtime_dependency(%q<httmultiparty>, [">= 0.3.8"])
+      s.add_runtime_dependency(%q<roxml>, [">= 3.3.1"])
+      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<jeweler>, ["~> 1.8.4"])
-      s.add_development_dependency(%q<relish>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<relish>, [">= 0.6"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12.1"])
       s.add_development_dependency(%q<rspec>, [">= 2.12.0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<xml-simple>, [">= 0"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<xml-simple>, [">= 1.1.2"])
     else
-      s.add_dependency(%q<httmultiparty>, [">= 0"])
-      s.add_dependency(%q<roxml>, [">= 0"])
-      s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<httmultiparty>, [">= 0.3.8"])
+      s.add_dependency(%q<roxml>, [">= 3.3.1"])
+      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<jeweler>, ["~> 1.8.4"])
-      s.add_dependency(%q<relish>, [">= 0"])
-      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<relish>, [">= 0.6"])
+      s.add_dependency(%q<rdoc>, [">= 3.12.1"])
       s.add_dependency(%q<rspec>, [">= 2.12.0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<xml-simple>, [">= 0"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<xml-simple>, [">= 1.1.2"])
     end
   else
-    s.add_dependency(%q<httmultiparty>, [">= 0"])
-    s.add_dependency(%q<roxml>, [">= 0"])
-    s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<httmultiparty>, [">= 0.3.8"])
+    s.add_dependency(%q<roxml>, [">= 3.3.1"])
+    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<jeweler>, ["~> 1.8.4"])
-    s.add_dependency(%q<relish>, [">= 0"])
-    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<relish>, [">= 0.6"])
+    s.add_dependency(%q<rdoc>, [">= 3.12.1"])
     s.add_dependency(%q<rspec>, [">= 2.12.0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<xml-simple>, [">= 0"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<xml-simple>, [">= 1.1.2"])
   end
 end
 

data/spec/ruby_zoho_spec.rb

@@ -14,6 +14,7 @@ describe RubyZoho::Crm do
       #config.api_key = 'e194b2951fb238e26bc096de9d0cf5f8'
       config.api_key = '62cedfe9427caef8afb9ea3b5bf68154'
       config.crm_modules = %w(Quotes)
+      config.cache_fields = false
     end
     #r = RubyZoho::Crm::Contact.find_by_last_name('Smithereens')
     #r.each { |m| RubyZoho::Crm::Contact.delete(m.contactid) } unless r.nil?
@@ -92,9 +93,14 @@ describe RubyZoho::Crm do
     c.attr_writers.count.should be >= 14
   end
 
+  it 'should get a list of attr_writers for tasks' do
+    c = RubyZoho::Crm::Task.new
+    c.attr_writers.count.should be >= 14
+  end
+
   it 'should get a list of attr_writers for quotes' do
     c = RubyZoho::Crm::Quote.new
-    c.attr_writers.count.should be >= 18
+    c.attr_writers.count.should be >= 18 unless c.nil?
   end
 
   it 'should get a list of accounts' do
@@ -103,6 +109,12 @@ describe RubyZoho::Crm do
     r.map { |r| r.class.should eq(RubyZoho::Crm::Account) }
   end
 
+  it 'should get a list of calls' do
+    r = RubyZoho::Crm::Call.all
+    r.count.should be > 1
+    r.map { |r| r.class.should eq(RubyZoho::Crm::Call) }
+  end
+
   it 'should get a list of contacts' do
     r = RubyZoho::Crm::Contact.all
     r.count.should be > 1
@@ -149,12 +161,6 @@ describe RubyZoho::Crm do
     r.each { |c|  RubyZoho::Crm::Contact.delete(c.contactid) }
   end
 
-  it 'should sort contact records' do
-    r = RubyZoho::Crm::Contact.all
-    sorted =  r.sort {|a, b| a.last_name <=> b.last_name }
-    sorted.collect { |c| c.last_name }.should_not eq(nil)
-  end
-
   it 'should save a lead record' do
     l = RubyZoho::Crm::Lead.new(
       :first_name => 'Raj',
@@ -167,21 +173,80 @@ describe RubyZoho::Crm do
     r.each { |c|  RubyZoho::Crm::Lead.delete(c.leadid) }
   end
 
-  it 'should save a potential record' do
+  it 'should save and retrieve a potential record' do
     accounts = RubyZoho::Crm::Account.all
-    p = RubyZoho::Crm::Potential.new(
+    h = {
         :potential_name => 'A very big potential INDEED!!!!!!!!!!!!!',
         :accountid => accounts.first.accountid,
         :account_name => accounts.first.account_name,
         :closing_date => '1/1/2014',
         :type => 'New Business',
-        :stage => 'Needs Analysis')
+        :stage => 'Needs Analysis'}
+    r = RubyZoho::Crm::Potential.find_by_potential_name(h[:potential_name])
+    r.each { |c|  RubyZoho::Crm::Potential.delete(c.potentialid) } unless r.nil?
+    p = RubyZoho::Crm::Potential.new(h)
     p.save
     r = RubyZoho::Crm::Potential.find_by_potential_name(p.potential_name)
-    r.first.potential_name.should eq('A very big potential INDEED!!!!!!!!!!!!!')
+    r.first.potential_name.should eq(h[:potential_name])
+    potential = RubyZoho::Crm::Potential.find_by_potentialid(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
+    p_found.first.potentialid.should eq(r.first.potentialid)
     r.each { |c|  RubyZoho::Crm::Potential.delete(c.potentialid) }
   end
 
+  it 'should save and retrieve a task record' do
+    accounts = RubyZoho::Crm::Account.all
+    h = {
+        :subject => 'Test Task',
+        :due_date => Date.today.to_s + '23:59',
+        :semodule => 'Accounts',
+        :relatedtoid => accounts.first.accountid,
+        :related_to => accounts.first.account_name,
+        :priority => 'Low' }
+    r = RubyZoho::Crm::Task.find_by_subject(h[:subject])
+    r.each { |t|  RubyZoho::Crm::Task.delete(t.activityid) } unless r.nil?
+    t = RubyZoho::Crm::Task.new(h)
+    t.save
+    r = RubyZoho::Crm::Task.find_by_subject(h[:subject])
+    r.first.subject.should eq(h[:subject])
+    tasks = RubyZoho::Crm::Task.find_by_activityid(r.first.activityid)
+    tasks.first.activityid.should eq(r.first.activityid)
+    r.each { |c|  RubyZoho::Crm::Task.delete(c.activityid) }
+  end
+
+  it 'should save an event record' do
+    pending
+    #accounts = RubyZoho::Crm::Account.all
+    #pp a = accounts.first
+    #events = RubyZoho::Crm::Event.all
+    #pp ev = events.first
+    #RubyZoho::Crm::Event.update(
+    #    :id => ev.activityid,
+    #    :subject => "Hello Dolly #{Time.now}.to_s"
+    #)
+    pp e = RubyZoho::Crm::Event.new(
+        :event_owner =>  'Wayne Giles',
+        :smownerid => '748054000000056023',
+        :start_datetime => '2013-02-16 16:00:00',
+        :end_datetime => '2014-02-16 16:00:00',
+        :subject => 'Test Event',
+        :related_to => "Potential One",
+        :relatedtoid => '748054000000123057',
+        :semodule => "Potentials",
+        :contact_name => "Wayne Smith",
+        :contactid => "748054000000097043"
+    )
+    e.save
+  end
+
+  it 'should sort contact records' do
+    r = RubyZoho::Crm::Contact.all
+    sorted =  r.sort {|a, b| a.last_name <=> b.last_name }
+    sorted.collect { |c| c.last_name }.should_not eq(nil)
+  end
+
   it 'should update a lead record' do
     l = RubyZoho::Crm::Lead.new(
       :first_name => 'Raj',

data/spec/zoho_api_spec.rb

@@ -3,6 +3,7 @@ $:.unshift File.join('..', File.dirname(__FILE__), 'lib')
 require 'spec_helper'
 require 'zoho_api'
 require 'xmlsimple'
+require 'yaml'
 
 describe ZohoApi do
 
@@ -18,6 +19,17 @@ describe ZohoApi do
     @zoho.delete_record('Contacts', c[0][:contactid]) unless c == []
   end
 
+  def init_api(api_key, base_path, modules)
+    if File.exists?(File.join(base_path, 'fields.snapshot'))
+      fields = YAML.load(File.read(File.join(base_path, 'fields.snapshot')))
+      zoho = ZohoApi::Crm.new(api_key, modules, fields)
+    else
+      zoho = ZohoApi::Crm.new(api_key, modules)
+      fields = zoho.module_fields
+      File.open(File.join(base_path, 'fields.snapshot'), 'wb') { |file| file.write(fields.to_yaml) }
+    end
+    zoho
+  end
 
   before(:all) do
     base_path = File.join(File.dirname(__FILE__), 'fixtures')
@@ -27,9 +39,9 @@ describe ZohoApi do
     @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 = ZohoApi::Crm.new(api_key, modules)
+    api_key = 'e194b2951fb238e26bc096de9d0cf5f8'
+    #api_key = '62cedfe9427caef8afb9ea3b5bf68154'
+    @zoho = init_api(api_key, base_path, modules)
     @h_smith = { :first_name => 'Robert',
           :last_name => 'Smith',
           :email => 'rsmith@smithereens.com',
@@ -37,8 +49,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
@@ -48,6 +60,26 @@ describe ZohoApi do
     contacts.should_not eq(nil)
     contacts.count.should eq(1)
   end
+  
+  it 'should add a new event' do
+    pending
+    h = { :event_owner => 'Wayne Giles',
+          :smownerid => '748054000000056023',
+          :start_datetime => '2013-02-16 16:00:00',
+          :end_datetime => '2014-02-16 16:00:00',
+          :subject => 'Test Event',
+          :related_to => 'Potential One',
+          :relatedtoid => '748054000000123057',
+          :semodule => 'Potentials',
+          :contact_name => 'Wayne Smith',
+          :contactid => '748054000000097043' }
+    @zoho.add_record('Events', h)
+    events = @zoho.some('Events')
+    pp events
+    #@zoho.delete_record('Contacts', contacts[0][:contactid])
+    events.should_not eq(nil)
+    events.count.should eq(1)
+  end
 
   it 'should attach a file to a contact record' do
     pending
@@ -80,6 +112,33 @@ describe ZohoApi do
     delete_dummy_contact
   end
 
+  it 'should find by a potential by name,  id and related id' do
+    accounts = @zoho.some('Accounts')
+    p = {
+        :potential_name => 'A very big potential INDEED!!!!!!!!!!!!!',
+        :accountid => accounts.first[:accountid],
+        :account_name => accounts.first[:account_name],
+        :closing_date => '1/1/2014',
+        :type => 'New Business',
+        :stage => 'Needs Analysis'
+    }
+    potentials = @zoho.find_records('Potentials', :potential_name, '=', p[:potential_name])
+    potentials.map { |r| @zoho.delete_record('Potentials', r[:potentialid])} unless potentials.nil?
+
+    @zoho.add_record('Potentials', p)
+    p1 = @zoho.find_records('Potentials', :potential_name, '=', p[:potential_name])
+    p1.should_not eq(nil)
+
+    p2 = @zoho.find_records('Potentials', :potentialid, '=', p1.first[:potentialid])
+    p2.first[:potentialid].should eq(p1.first[:potentialid])
+
+    p_related = @zoho.find_records('Potentials', :accountid, '=', p[:accountid])
+    p_related.first[:accountid].should eq(p[:accountid])
+
+    potentials = @zoho.find_records('Potentials', :potential_name, '=', p[:potential_name])
+    potentials.map { |r| @zoho.delete_record('Potentials', r[:potentialid])} unless potentials.nil?
+  end
+
   it 'should get a list of fields for a module' do
     r = @zoho.fields('Accounts')
     r.count.should >= 30
@@ -116,26 +175,54 @@ describe ZohoApi do
     related = @zoho.related_records('Accounts', r[:accountid], 'Attachments')
   end
 
+  it 'should return calls' do
+    r = @zoho.some('Calls').first
+    r.should_not eq(nil)
+  end
+
   it 'should return events' do
     r = @zoho.some('Events').first
     r.should_not eq(nil)
   end
 
+  it 'should return tasks' do
+    r = @zoho.some('Tasks').first
+    r.should_not eq(nil)
+  end
+
   it 'should return users' do
     r = @zoho.users
     r.should_not eq(nil)
   end
 
+  it 'should test for a primary key' do
+    @zoho.primary_key?('Accounts', 'accountid').should eq(true)
+    @zoho.primary_key?('Accounts', 'potentialid').should eq(false)
+    @zoho.primary_key?('Accounts', 'Potential Name').should eq(false)
+    @zoho.primary_key?('Accounts', 'Account Name').should eq(false)
+    @zoho.primary_key?('Accounts', 'account_name').should eq(false)
+  end
+
+  it 'should test for a related id' do
+    @zoho.related_id?('Potentials', 'Account Name').should eq(false)
+    @zoho.related_id?('Potentials', 'Accountid').should eq(true)
+  end
+
+  it 'should test for a valid related field' do
+    @zoho.valid_related?('Accounts', 'accountid').should_not eq(nil)
+    @zoho.valid_related?('Notes', 'notesid').should_not eq(nil)
+    @zoho.valid_related?('Accounts', 'email').should 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
+    @zoho.add_record(mod_name, {:task_owner => 'Task Owner', :subject => 'Test Task', :due_date => '2100/1/1'})
+    r = @zoho.find_record_by_field('Tasks', 'Subject', '=', 'Test Task')
     r.should_not eq(nil)
+    r.map { |t| @zoho.delete_record('Tasks', t[:activityid]) }
   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.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,9 +26,25 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.8
 - !ruby/object:Gem::Dependency
   name: roxml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -50,7 +66,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +74,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +82,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +90,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +114,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +122,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +130,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +138,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.12.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -139,22 +155,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.12.0
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  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: xml-simple
   requirement: !ruby/object:Gem::Requirement
@@ -162,7 +162,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -170,23 +170,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  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'
+        version: 1.1.2
 description: ''
 email: ''
 executables: []
@@ -200,7 +184,6 @@ files:
 - .rvmrc
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
@@ -208,7 +191,6 @@ 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
@@ -241,7 +223,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

data/Gemfile.lock

@@ -1,88 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (3.2.12)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    archive-tar-minitar (0.5.2)
-    bourne (1.1.2)
-      mocha (= 0.10.5)
-    builder (3.1.4)
-    cucumber (1.2.1)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.3)
-      gherkin (~> 2.11.0)
-      json (>= 1.4.6)
-    diff-lcs (1.1.3)
-    gherkin (2.11.6)
-      json (>= 1.7.6)
-    git (1.2.5)
-    httmultiparty (0.3.8)
-      httparty (>= 0.7.3)
-      multipart-post
-    httparty (0.10.2)
-      multi_json (~> 1.0)
-      multi_xml (>= 0.5.2)
-    i18n (0.6.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.7)
-    metaclass (0.0.1)
-    mime-types (1.21)
-    mocha (0.10.5)
-      metaclass (~> 0.0.1)
-    multi_json (1.5.1)
-    multi_xml (0.5.3)
-    multipart-post (1.1.5)
-    nokogiri (1.5.6)
-    rake (10.0.3)
-    rdoc (3.12.1)
-      json (~> 1.4)
-    relish (0.6)
-      archive-tar-minitar (>= 0.5.2)
-      json (>= 1.4.6)
-      rest-client (>= 1.6.1)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    roxml (3.3.1)
-      activesupport (>= 2.3.0)
-      nokogiri (>= 1.3.3)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
-    shoulda (3.3.2)
-      shoulda-context (~> 1.0.1)
-      shoulda-matchers (~> 1.4.1)
-    shoulda-context (1.0.2)
-    shoulda-matchers (1.4.2)
-      activesupport (>= 3.0.0)
-      bourne (~> 1.1.2)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    xml-simple (1.1.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  cucumber
-  httmultiparty
-  jeweler (~> 1.8.4)
-  rdoc
-  relish
-  roxml
-  rspec (>= 2.12.0)
-  shoulda
-  simplecov
-  xml-simple