rubyzoho 0.1.7 → 0.1.11

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTYwNTBjNmI5YTEzZDQzNjQwZjExOTc0YzkxNDRlZjIxODA1ZDFlNQ==
+  data.tar.gz: !binary |-
+    MzY4ZmVlZTY2ZjlmMjdkZjE0Njc3YWRjMmFkZWZmM2Q5NTBkYTYzYw==
+SHA512:
+  metadata.gz: !binary |-
+    YmQ5MzBhODczNzA1Yzk0ZTAyYjRlZTAwNWRmYWYxNTc0ZWE5ODA0ZTczZmUz
+    YTlhYjdlZDA3YWQ1MjlkOTg0MDYwMWUyOThkODhkZDM0ZTgwNTIxOGRhZDVi
+    ZjlmMzMwNDJlMWExYTUyZmMzOTYyNDRkMmVhZTQ1NmM2NGJlN2Y=
+  data.tar.gz: !binary |-
+    ODg2YjA0YTU0MjE2NTcwYTZkN2MzMDYwZjQ0M2NjNDY4MGFmOWJkZjgxNzQ0
+    NDYxOWJjMDRkZjAwOTNjNGI0OWE1NGZlZGM0N2ZjYTljYTU5ZjI4Y2U3ZjBl
+    ZWY0NTQ3ODE4YjI4MDMzMGU2NjgyMWVjZjZkOTA4YjBlOTU4Mjc=

data/.coverall.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.ruby-gemset

@@ -0,0 +1 @@
+rubyzoho

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -7,8 +7,4 @@ matrix:
   - rvm: jruby
 env:
   global:
-  - secure: ! 'Es86LRVpGFcxK8Ay0NzjtPgL1a7GQ25WRq4FgixHplZ8BbB2g/LGm2hFFnrD
-
-      TQHNvTttEhrXDRXvYqv0ePTSb2I4Tn6xOzBZTIwZlmNDl6uj/5ZL9C9I3LQb
-
-      1MP0XFN0GfkOpw4DqVerdzDDoRzQw7AbTBttaOVyO3Nhiddtc3E='
+  - secure: "Z9gYY+iN1CB6+6KOG9zhCFHqNoUpeDrO0asn6ocpsaAVpQ+5L1ehdLcneZR+c/8fEyplC1sPtPQaq3u1/xrZ8dluev6iRoDZvEAS3GDg594lIB9owBJXXQKKGddyKfdCcp6xcNphJtcgSNtuxfNmhQyTvSBp0TjBgVvknoa1dNE="

data/Gemfile

@@ -1,13 +1,15 @@
 source 'http://rubygems.org'
 
-gem 'httmultiparty', '>= 0.3.8'
-gem 'roxml', '>= 3.3.1'
+gem 'activemodel'
+gem 'httmultiparty'
+gem 'roxml'
 gem 'multipart-post'
 
 group :test do
   gem 'rspec', '>= 2.12.0'
   gem 'xml-simple', '>=1.1.2'
   gem 'simplecov', '>= 0.7.1', :require => false, :group => :test
+  gem 'coveralls', require: false
 end
 
 group :development do

data/README.rdoc

@@ -1,4 +1,4 @@
-= 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]
+= 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://coveralls.io/repos/amalc/rubyzoho/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/amalc/rubyzoho] {<img src="https://badge.fury.io/rb/rubyzoho.png" alt="Gem Version" />}[http://badge.fury.io/rb/rubyzoho]
 
 
 
@@ -22,7 +22,8 @@ Put the following in an initializer (e.g. <tt><RAILS_ROOT>/config/initializers/z
       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
+      # config.ignore_fields_with_bad_names = true # Ignores field with special characters in the name (Release 1.8)
+      # Currently only Quotes are supported
     end
 
 === Ruby
@@ -34,6 +35,7 @@ Make sure the following block is executed prior to making calls to the gem.
       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
+      # config.ignore_fields_with_bad_names = true # Ignores field with special characters in the name (Release 1.8)
       # Currently only Quotes are suported
     end
 
@@ -44,7 +46,7 @@ your daily allowance. See below for some optimizations during development and te
 
 == Use
 RubyZoho attempts to follow the ActiveRecord lifecycle, i.e. new, save, update and delete.
-See examples below.
+See examples below. (<b>N.B. Fields _cannot_ have special characters in them.</b>)
 
 To get a list of supported attributes for a Zoho CRM contact:
 
@@ -241,8 +243,15 @@ Please open an issue on GitHub. Or better yet, send in a pull request with the f
 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.
 
-== Credits
-wcgiles@github (\@\waynecgiles) for professional and patient debugging and continued debugging of this gem.
+== Credits and Contributions
+Thanks to a growing and wonderful community!
+@aeldaly
+@fheemeyer
+@qume
+@tjsousa
+@wcgiles
+
+Drop me a line if I've left anybody out and my advance apologies.
 
 == Trademarks
 Zoho, the Zoho suite and related applications are owned, trademarked and copyrighted by the Zoho Corporation Pvt. Ltd.
@@ -253,18 +262,24 @@ Copyright (c) 2013 amalc (\@\amalc). Released under the MIT license. See LICENSE
 
 ---
 = Releases
-== Release Candidates
+== Release Candidates (Uses {Semantic Versioning}[http://semver.org/])
 
 == Development
-[0.1.8]
+[0.1.12]
         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
+        4. Option in config to ignore fields with improper field names
+
+[0.1.11] (Current master branch)
+        1. Incorporate fix to namespace collision between Devise and RubyZoho, User renamed to CRMUser thanks to @qume.
+        2. Other fixes from  @tjsousa, @aeldaly and @fheemeyer.
+        3. Refactor of the code base to improve modularization and test coverage.
+== Released
 [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.
+        2. \:\id is the primary key across all Zoho related classes (modules) 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

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.11

data/lib/api_utils.rb

@@ -11,6 +11,7 @@ module ApiUtils
   end
 
   def self.string_to_symbol(s)
+    s.gsub!(/[()%]*/, '')
     s.gsub(' ', '_').downcase.to_sym
   end
 

data/lib/crm.rb

@@ -0,0 +1,112 @@
+require 'active_model'
+require 'crud_methods'
+require 'zoho_crm_utils'
+
+class RubyZoho::Crm
+
+  class << self
+    attr_accessor :module_name
+  end
+  @module_name = 'Crm'
+
+  include CrudMethods
+  include ZohoCrmUtils
+
+  def initialize(object_attribute_hash = {})
+    @fields = object_attribute_hash == {} ? RubyZoho.configuration.api.fields(self.class.module_name) :
+        object_attribute_hash.keys
+    create_accessor(self.class, @fields)
+    create_accessor(self.class, [:module_name])
+    public_send(:module_name=, self.class.module_name)
+    update_or_create_attrs(object_attribute_hash)
+    self
+  end
+
+  def self.method_missing(meth, *args, &block)
+    if meth.to_s =~ /^find_by_(.+)$/
+      run_find_by_method($1, *args, &block)
+    else
+      super
+    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.run_find_by_method(attrs, *args, &block)
+    attrs = attrs.split('_and_')
+    conditions = Array.new(args.size, '=')
+    h = RubyZoho.configuration.api.find_records(
+        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 << object
+    object.semodule = self.module_name
+    object.seid = self.id
+    object.fields << :seid
+    object.fields << :semodule
+    save_object(object)
+  end
+
+  def primary_key
+    RubyZoho.configuration.api.primary_key(self.class.module_name)
+  end
+
+  def self.setup_classes
+    RubyZoho.configuration.crm_modules.each do |module_name|
+      klass_name = module_name.chop
+      c = Class.new(self) do
+        include RubyZoho
+        include ActiveModel
+        extend ActiveModel::Naming
+
+        attr_reader :fields
+        @module_name = module_name
+      end
+      const_set(klass_name, c)
+    end
+  end
+
+  c = Class.new(self) do
+    def initialize(object_attribute_hash = {})
+      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
+
+  Kernel.const_set 'CRMUser', c
+
+end

data/lib/crud_methods.rb

@@ -0,0 +1,76 @@
+module CrudMethods
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    def first
+      r = RubyZoho.configuration.api.first(self.module_name)
+      new(r[0])
+    end
+
+    def all #TODO Refactor into low level API
+      max_records = 200
+      result = []
+      i = 1
+      batch = []
+      until batch.nil?
+        batch = RubyZoho.configuration.api.some(self.module_name, i, max_records)
+        result.concat(batch) unless batch.nil?
+        break if !batch.nil? && batch.count < max_records
+        i += max_records
+      end
+      result.collect { |r| new(r) }
+    end
+
+    def find(id)
+      self.find_by_id(id)
+    end
+
+    def delete(id)
+      RubyZoho.configuration.api.delete_record(self.module_name, id)
+    end
+
+    def update(object_attribute_hash)
+      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)
+      r = RubyZoho.configuration.api.update_record(self.module_name, id, object_attribute_hash)
+      new(object_attribute_hash.merge!(r))
+    end
+
+  end
+
+  def attach_file(file_path, file_name)
+    RubyZoho.configuration.api.attach_file(self.class.module_name, self.send(primary_key), file_path, file_name)
+  end
+
+  def create(object_attribute_hash)
+    initialize(object_attribute_hash)
+    save
+  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(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
+
+  def up_date(object_attribute_hash)
+    update_or_create_attrs(object_attribute_hash)
+    self
+  end
+
+end

data/lib/ruby_zoho.rb

@@ -2,17 +2,17 @@ require 'zoho_api'
 require 'api_utils'
 require 'yaml'
 
-
 module RubyZoho
 
   class Configuration
-    attr_accessor :api, :api_key, :cache_fields, :crm_modules
+    attr_accessor :api, :api_key, :cache_fields, :crm_modules, :ignore_fields_with_bad_names
 
     def initialize
       self.api_key = nil
       self.api = nil
       self.cache_fields = false
       self.crm_modules = nil
+      self.ignore_fields_with_bad_names = true
     end
   end
 
@@ -27,7 +27,7 @@ module RubyZoho
     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)
+                                      self.configuration.crm_modules, self.configuration.cache_fields)
     RubyZoho::Crm.setup_classes()
   end
 
@@ -35,234 +35,16 @@ module RubyZoho
     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)
+      zoho = ZohoApi::Crm.new(api_key, modules,
+                              self.configuration.ignore_fields_with_bad_names, fields)
     else
-      zoho = ZohoApi::Crm.new(api_key, modules)
+      zoho = ZohoApi::Crm.new(api_key, modules, self.configuration.ignore_fields_with_bad_names)
       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
-
-    class << self
-      attr_accessor :module_name
-    end
-    @module_name = 'Crm'
-
-    def initialize(object_attribute_hash = {})
-      @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(/`(.*?)=/)
-        RubyZoho::Crm.create_accessor(self.class, [m.gsub(/[`()]*/, '').chop]) unless m.nil?
-        retry_counter -= 1
-        retry if retry_counter > 0
-      end
-    end
-
-    def attr_writers
-      self.methods.grep(/\w=$/)
-    end
-
-    def self.create_accessor(klass, names)
-      names.each do |name|
-        n = name
-        n = name.to_s if name.class == Symbol
-        raise(RuntimeError, "Bad field name: #{name}") unless method_name?(name)
-        create_getter(klass, n)
-        create_setter(klass, n)
-      end
-      names
-    end
-
-    def self.method_name?(n)
-      name = n.class == String ? ApiUtils.string_to_symbol(n) : n
-      return /[@$"]/ !~ name.inspect
-    end
-
-    def self.create_getter(klass, *names)
-      names.each do |name|
-        klass.send(:define_method, "#{name}") { instance_variable_get("@#{name}") }
-      end
-    end
-
-    def self.create_setter(klass, *names)
-      names.each do |name|
-        klass.send(:define_method, "#{name}=") { |val| instance_variable_set("@#{name}", val) }
-      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)
-      else
-        super
-      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(
-          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
-      batch = []
-      until batch.nil?
-        batch = RubyZoho.configuration.api.some(self.module_name, i, max_records)
-        result.concat(batch) unless 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(self.class.module_name, self.send(primary_key), file_path, file_name)
-    end
-
-    def create(object_attribute_hash)
-      initialize(object_attribute_hash)
-      save
-    end
-
-    def self.delete(id)
-      RubyZoho.configuration.api.delete_record(self.module_name, id)
-    end
-
-    def primary_key
-      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(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
+  require 'crm'
 
-    def self.update(object_attribute_hash)
-      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)
-      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)
-      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
-          @module_name = module_name
-        end
-        const_set(klass_name, c)
-      end
-    end
-
-    c = Class.new(RubyZoho::Crm) do
-      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
-
-    Kernel.const_set 'User', c
-
-  end
 end