rubyzoho 0.0.3 → 0.0.4

data/README.rdoc

@@ -30,8 +30,8 @@ To get a list of supported attributes for a Zoho CRM contact:
     require 'ruby_zoho'
 
     c = RubyZoho::Crm::Contact.new
-    c.attr_writers  # => Give a list of updatable attributes
-    c.fields # => Hash of all fields
+    c.attr_writers  # => List of updatable attributes
+    c.fields # => Array of all fields
 
 Attributes are reflected from the current API instance of Zoho, dynamically on
 initialization of the API, when the RubyZoho.configure block is called. This
@@ -40,8 +40,8 @@ includes custom fields.
 Another example:
 
     l = RubyZoho::Crm::Lead.new
-    l.attr_writers  # => Give a list of updatable attributes
-    l.fields # => Hash of all fields
+    l.attr_writers  # => List of updatable attributes
+    l.fields # => Array of all fields
 
 To retrieve an existing record:
 
@@ -70,6 +70,25 @@ Or for all quotes:
       pp quote.quote_name
     end
 
+To get the first quote:
+    q.first
+
+Or the last one:
+    q.last
+
+Since the result is Enumerable:
+    q.map { |m| m.last_name }
+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 }
+
+To find by ID, note well, ID is a *string*:
+    leads = RubyZoho::Crm::Lead.all
+    l = RubyZoho::Crm::Lead.find_by_leadid(leads.last.leadid)
+
 To create a new record:
 
     c = RubyZoho::Crm::Contact.new(
@@ -80,7 +99,7 @@ To create a new record:
     )
     c.save
     r = RubyZoho::Crm::Contact.find_by_email('email@domain.com')
-    r[0].contactid # => Has the newly created contact's ID
+    r.first.contactid # => Has the newly created contact's ID
 
 
 To add a contact to an existing account:
@@ -90,8 +109,8 @@ To add a contact to an existing account:
       :first_name => 'First Name',
       :last_name => 'Last Name',
       :email => 'email@domain.com',
-      :account_name => a[0].account_name,
-      :accountid => a[0].accountid  # accountid instead of account_id because of Zoho's convention
+      :account_name => a.first.account_name,
+      :accountid => a.first.accountid  # accountid instead of account_id because of Zoho's convention
       etc.
     )
     c.save
@@ -121,8 +140,13 @@ Please open an issue on GitHub. Or better yet, send in a pull request.
 * 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
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/zoho_api.rb

@@ -45,6 +45,20 @@ module ZohoApi
       row
     end
 
+    def attach_file(module_name, record_id, file_content)
+      pp module_name
+      pp record_id
+      pp file_content.size
+      r = self.class.post(create_url(module_name, 'uploadFile'),
+          :query => { :newFormat => 1, :authtoken => @auth_token,
+            :scope => 'crmapi',
+            :id => record_id, :content => Base64.encode64(file_content) },
+          :headers => { 'Content-length' => '0' })
+      pp r
+      raise('Adding record failed', RuntimeError, r.response.body.to_s) unless r.response.code == '200'
+      r.response.code
+    end
+
     def create_url(module_name, api_call)
       "https://crm.zoho.com/crm/private/xml/#{module_name}/#{api_call}"
     end
@@ -68,11 +82,25 @@ 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) :
+          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 + ')'
       r = self.class.get(create_url("#{module_name}", 'getSearchRecords'),
+                         :query => {:newFormat => 2, :authtoken => @auth_token, :scope => 'crmapi',
+                                    :selectColumns => 'All', :searchCondition => search_condition,
+                                    :fromIndex => 1, :toIndex => NUMBER_OF_RECORDS_TO_GET})
+      raise(RuntimeError, 'Bad query', "#{sc_field} #{condition} #{value}") unless r.body.index('<error>').nil?
+      x = REXML::Document.new(r.body).elements.to_a("/response/result/#{module_name}/row")
+      to_hash(x)
+    end
+
+    def find_record_by_id(module_name, id)
+      r = self.class.get(create_url("#{module_name}", 'getRecordById'),
          :query => { :newFormat => 2, :authtoken => @auth_token, :scope => 'crmapi',
-                     :selectColumns => 'All', :searchCondition => search_condition,
-                     :fromIndex => 1, :toIndex =>  NUMBER_OF_RECORDS_TO_GET })
+                     :selectColumns => 'All', :id => id})
       raise(RuntimeError, 'Bad query', "#{sc_field} #{condition} #{value}") unless r.body.index('<error>').nil?
       x = REXML::Document.new(r.body).elements.to_a("/response/result/#{module_name}/row")
       to_hash(x)

data/rubyzoho.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rubyzoho"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["amalc"]
-  s.date = "2013-02-12"
+  s.date = "2013-02-13"
   s.description = ""
   s.email = ""
   s.extra_rdoc_files = [
@@ -30,9 +30,9 @@ Gem::Specification.new do |s|
     "lib/api_utils.rb",
     "lib/ruby_zoho.rb",
     "lib/zoho_api.rb",
-    "rubyzoho-0.0.2.gem",
     "rubyzoho.gemspec",
     "spec/api_utils_spec.rb",
+    "spec/fixtures/sample.pdf",
     "spec/fixtures/sample_contact.xml",
     "spec/fixtures/sample_contact_search.xml",
     "spec/fixtures/sample_contacts.xml",

data/spec/ruby_zoho_spec.rb

@@ -93,6 +93,22 @@ describe RubyZoho::Crm do
     r.map { |r| r.class.should eq(RubyZoho::Crm::Quote) }
   end
 
+  it 'should find a contact by ID' do
+    contacts = RubyZoho::Crm::Contact.all
+    contact_id = contacts.first.contactid
+    c = RubyZoho::Crm::Contact.find_by_contactid(contact_id)
+    c.first.contactid.should eq(contact_id)
+    c.first.last_name.should eq(contacts.first.last_name)
+    c.first.email.should eq(contacts.first.email)
+  end
+
+  it 'should find a lead by ID' do
+    leads = RubyZoho::Crm::Lead.all
+    lead_id = leads.first.leadid
+    l = RubyZoho::Crm::Lead.find_by_leadid(lead_id)
+    l.first.leadid.should eq(lead_id)
+  end
+
   it 'should save a contact record' do
     c = RubyZoho::Crm::Contact.new(
       :first_name => 'Raj',
@@ -100,9 +116,16 @@ describe RubyZoho::Crm do
       :email => 'raj@portra.com')
     c.save
     r = RubyZoho::Crm::Contact.find_by_email('raj@portra.com')
+    r.first.email.should eq('raj@portra.com')
     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',

data/spec/zoho_api_spec.rb

@@ -24,6 +24,7 @@ describe ZohoApi do
     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')
     @zoho = ZohoApi::Crm.new('62cedfe9427caef8afb9ea3b5bf68154')
   end
 
@@ -42,6 +43,25 @@ describe ZohoApi do
     contact.count.should eq(1)
   end
 
+  it 'should attach a file to a contact record' do
+    pending
+    h = { :first_name => 'Robert',
+          :last_name => 'Smith',
+          :email => 'rsmith@smithereens.com',
+          :department => 'Waste Collection and Management',
+          :phone => '13452129087',
+          :mobile => '12341238790'
+    }
+    #@zoho.add_record('Contacts', h)
+    contact = @zoho.find_records('Contacts', :email, '=', h[:email])
+    pp contact[0][:contactid]
+    pp File.read(@sample_pdf).size
+    pp Base64.encode64(File.read(@sample_pdf)).size
+    @zoho.attach_file('Contacts', contact[0][:contactid],
+        File.read(@sample_pdf))
+    #@zoho.delete_record('Contacts', contact[0][:contactid])
+  end
+
   it 'should delete a contact record with id' do
     add_dummy_contact
     c = @zoho.find_records('Contacts', :email, '=', 'bob@smith.com')
@@ -55,6 +75,16 @@ describe ZohoApi do
     delete_dummy_contact
   end
 
+  it 'should find by module and id' do
+    add_dummy_contact
+    r = @zoho.find_records('Contacts', :email, '=', 'bob@smith.com')
+    r[0][:email].should eq('bob@smith.com')
+    id = r[0][:contactid]
+    c = @zoho.find_record_by_id('Contacts', id)
+    c[0][:contactid].should eq(id)
+    delete_dummy_contact
+  end
+
   it 'should get a list of fields for a module' do
     r = @zoho.fields('Contacts')
     r.count.should be >= 43

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyzoho
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2013-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -208,9 +208,9 @@ files:
 - lib/api_utils.rb
 - lib/ruby_zoho.rb
 - lib/zoho_api.rb
-- rubyzoho-0.0.2.gem
 - rubyzoho.gemspec
 - spec/api_utils_spec.rb
+- spec/fixtures/sample.pdf
 - spec/fixtures/sample_contact.xml
 - spec/fixtures/sample_contact_search.xml
 - spec/fixtures/sample_contacts.xml