vtiger 0.3.4 → 0.3.6

data/README.rdoc

@@ -37,7 +37,7 @@ Vtiger::API.api_settings = {
     cmd.add_lead  etc...
 
 == REQUIREMENTS:
-
+now using yajl as  replacement to json.gem
 
 
 == INSTALL:

data/bin/add_contact.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env jruby -S
+# == Synopsis
+#   Add a contact to vtiger 
+# == Usage
+#  add_contact.rb -u vtiger_url  -e Contacts  -n username -k access_key -c contactName
+# Note -a flag for response  --- eg true or false
+# == Useful commands
+#  jruby add_contact.rb -u democrm.estormtech.com -c test  -n scott -k xxxxx 
+# == Author
+#   Scott Sproule  --- Ficonab.com (scott.sproule@ficonab.com)
+# == Copyright
+#    Copyright (c) 2007 Ficonab Pte. Ltd.
+#     See license for license details
+require 'yaml'
+require 'rubygems'
+gem 'vtiger'
+require 'vtiger'
+require 'optparse'
+require 'rdoc/usage'
+require 'java' if RUBY_PLATFORM =~ /java/
+
+
+
+ arg_hash=Vtiger::Options.parse_options(ARGV)
+ RDoc::usage if arg_hash[:help]==true
+require 'pp'
+  options = arg_hash
+   # set up variables using hash
+   
+   puts "vtiger add contact #{Time.now}"
+   puts "vtiger url: #{arg_hash[:url]} "
+    puts "vtiger contact: #{arg_hash[:contact]} "
+    cmd = Vtiger::Commands.new()
+    cmd.challenge(options)
+    cmd.login(options)
+    cmd.addobject(options)
+  #   consumer_session.close
+   #  puts "#{result}"
+ #  sleep(1)
+   
+  
+    
+    puts  '-------------finished processing!!!'
+ 
+ 

data/bin/add_lead.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby
+# == Synopsis
+#   Add a contact to vtiger 
+# == Usage
+#  add_contact.rb -u vtiger_url  -e Contacts  -n username -k access_key -c contactName
+# Note -a flag for response  --- eg true or false
+# == Useful commands
+#  add_lead.rb -u democrm.estormtech.com -c test -e Contacts  -n scott -k xxxxx 
+# == Author
+#   Scott Sproule  --- Ficonab.com (scott.sproule@ficonab.com)
+# == Copyright
+#    Copyright (c) 2007 Ficonab Pte. Ltd.
+#     See license for license details
+require 'yaml'
+require 'rubygems'
+gem 'vtiger'
+require 'vtiger'
+require 'optparse'
+require 'rdoc/usage'
+require 'java' if RUBY_PLATFORM =~ /java/
+
+#testing of chagnes
+
+ arg_hash=Vtiger::Options.parse_options(ARGV)
+ RDoc::usage if arg_hash[:help]==true
+require 'pp'
+  options = arg_hash
+   # set up variables using hash
+   
+   puts "vtiger add contact #{Time.now}"
+   puts "vtiger url: #{arg_hash[:url]} "
+    puts "vtiger contact: #{arg_hash[:contact]} "
+    cmd = Vtiger::Commands.new()
+    cmd.challenge(options)
+    cmd.login(options)
+    cmd.addlead(options)
+  #   consumer_session.close
+   #  puts "#{result}"
+ #  sleep(1)
+   
+  
+    
+    puts  '-------------finished processing!!!'
+ 

data/bin/add_trouble_ticket.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby
+# == Synopsis
+#   Add a contact to vtiger 
+# == Usage
+#  add_trouble_ticket.rb -u vtiger_url  -e HelpDesk  -n username -k access_key -c contactName
+# Note -a flag for response  --- eg true or false
+# == Useful commands
+#  add_trouble_ticket.rb -u democrm.estormtech.com -t titletest -e HelpDesk  -n scott -k xxxxx 
+# == Author
+#   Scott Sproule  --- Ficonab.com (scott.sproule@ficonab.com)
+# == Copyright
+#    Copyright (c) 2007 Ficonab Pte. Ltd.
+#     See license for license details
+require 'yaml'
+require 'rubygems'
+gem 'vtiger'
+require 'vtiger'
+require 'optparse'
+require 'rdoc/usage'
+require 'java' if RUBY_PLATFORM =~ /java/
+
+#testing of chagnes
+
+ arg_hash=Vtiger::Options.parse_options(ARGV)
+ RDoc::usage if arg_hash[:help]==true
+require 'pp'
+  options = arg_hash
+   # set up variables using hash
+   
+   puts "vtiger add trouble ticket #{Time.now}"
+   puts "vtiger url: #{arg_hash[:url]} "
+    puts "vtiger contact: #{arg_hash[:contact]} "
+    cmd = Vtiger::Commands.new()
+    cmd.challenge(options)
+    cmd.login(options)
+    cmd.add_trouble_ticket(options,"Open",arg_hash[:title],{})
+  #   consumer_session.close
+   #  puts "#{result}"
+ #  sleep(1)
+   
+  
+    
+    puts  '-------------finished processing!!!'

data/bin/describe_object.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env jruby -S
+# == Synopsis
+#   Describe objects on vtiger server.  Use the list_types command to get access to all the types
+# == Usage
+#  describe object.rb -u vtiger_url  -e object  -n username -k access_key
+# Note -a flag for response  --- eg true or false
+# 
+# == Useful commands
+#  jruby -S describe_object.rb -e Contacts -u democrm.estormtech.com  -n scott -k xxx
+#   (this is a long response, try grep -A 5 to look five lines after what you are interested)
+
+# == Author
+#   Scott Sproule  --- Ficonab.com (scott.sproule@ficonab.com)
+# == Copyright
+#    Copyright (c) 2007 Ficonab Pte. Ltd.
+#     See license for license details
+require 'yaml'
+require 'rubygems'
+gem 'vtiger'
+require 'vtiger'
+require 'optparse'
+require 'rdoc/usage'
+require 'java' if RUBY_PLATFORM =~ /java/
+
+
+
+ arg_hash=Vtiger::Options.parse_options(ARGV)
+ RDoc::usage if arg_hash[:help]==true
+require 'pp'
+  options = arg_hash
+   # set up variables using hash
+   
+   puts "vtiger add contact #{Time.now}"
+   puts "vtiger url: #{arg_hash[:url]} "
+    puts "vtiger contact: #{arg_hash[:contact]} "
+    cmd = Vtiger::Commands.new()
+    cmd.challenge(options)
+    cmd.login(options)
+    cmd.describe_object(options)
+  #   consumer_session.close
+   #  puts "#{result}"
+ #  sleep(1)
+   
+  
+    
+    puts  '-------------finished processing!!!'
+ 
+   

data/bin/helloworld.rb

@@ -0,0 +1 @@
+puts "hello world"

data/bin/list_types.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env jruby -S
+# == Synopsis
+#   List the types on the vtiger server
+# == Usage
+#  jruby -S list_types.rb -u website  -n username -k accesskey
+# 
+# == Useful commands
+#  list_types.rb -u democrm.estormtech.com  -n scott -k xxx
+# == Author
+#   Scott Sproule  --- Ficonab.com (scott.sproule@ficonab.com)
+# == Copyright
+#    Copyright (c) 2007 Ficonab Pte. Ltd.
+#     See license for license details
+require 'yaml'
+require 'rubygems'
+gem 'vtiger'
+require 'vtiger'
+require 'optparse'
+require 'rdoc/usage'
+require 'java' if RUBY_PLATFORM =~ /java/
+
+
+
+ arg_hash=Vtiger::Options.parse_options(ARGV)
+ RDoc::usage if arg_hash[:help]==true
+require 'pp'
+  options = arg_hash
+   # set up variables using hash
+   
+   puts "vtiger add contact #{Time.now}"
+   puts "vtiger url: #{arg_hash[:url]} "
+    puts "vtiger contact: #{arg_hash[:contact]} "
+    cmd = Vtiger::Commands.new()
+    cmd.challenge(options)
+    cmd.login(options)
+    cmd.list_types(options)
+  #   consumer_session.close
+   #  puts "#{result}"
+ #  sleep(1)
+   
+  
+    
+    puts  '-------------finished processing!!!'
+ 
+ 

data/bin/query.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env jruby -S
+# == Synopsis
+#   Query the vtiger server
+# == Usage
+#  jruby -S query.rb -u website  -n username -k accesskey -q sql_query string
+# 
+# == Useful commands
+#  jruby -S query.rb -u democrm.estormtech.com  -n scott -k xxxxx -q 'select * from Accounts;'
+# == Author
+#   Scott Sproule  --- Ficonab.com (scott.sproule@ficonab.com)
+# == Copyright
+#    Copyright (c) 2007 Ficonab Pte. Ltd.
+#     See license for license details
+require 'yaml'
+require 'rubygems'
+gem 'vtiger'
+require 'vtiger'
+require 'optparse'
+require 'rdoc/usage'
+require 'java' if RUBY_PLATFORM =~ /java/
+
+
+
+ arg_hash=Vtiger::Options.parse_options(ARGV)
+ RDoc::usage if arg_hash[:help]==true
+require 'pp'
+  options = arg_hash
+   # set up variables using hash
+   
+   puts "vtiger add contact #{Time.now}"
+   puts "vtiger url: #{arg_hash[:url]} "
+    puts "vtiger contact: #{arg_hash[:contact]} "
+    cmd = Vtiger::Commands.new()
+    cmd.challenge(options)
+    cmd.login(options)
+    cmd.query(options)
+  #   consumer_session.close
+   #  puts "#{result}"
+ #  sleep(1)
+   
+  
+    
+    puts  '-------------finished processing!!!'
+ 
+    
+   # Thread.exit
+
+  

data/bin/update_stock_inventory.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env jruby -S
+# == Synopsis
+#   Update stock for give product
+# == Usage
+#  update_stock_inventory.rb -u vtiger_url  -e Products  -n username -k access_key -p productName -q -1
+# == Useful commands
+# note uppercase Q and lowercase -p for product.
+#  jruby update_stock_inventory.rb -u democrm.estormtech.com -c test  -n scott -k xxxxx  -p "test for rap" -Q -1
+# == Author
+#   Scott Sproule  --- Ficonab.com (scott.sproule@ficonab.com)
+# == Copyright
+#    Copyright (c) 2007 Ficonab Pte. Ltd.
+#     See license for license details
+require 'yaml'
+require 'rubygems'
+gem 'vtiger'
+require 'vtiger'
+require 'optparse'
+require 'rdoc/usage'
+require 'java' if RUBY_PLATFORM =~ /java/
+
+
+
+ arg_hash=Vtiger::Options.parse_options(ARGV)
+ RDoc::usage if arg_hash[:help]==true
+require 'pp'
+  options = arg_hash
+   # set up variables using hash
+   
+   puts "vtiger add contact #{Time.now}"
+   puts "vtiger url: #{arg_hash[:url]} "
+    puts "vtiger contact: #{arg_hash[:contact]} "
+    cmd = Vtiger::Commands.new()
+    cmd.challenge(options)
+    cmd.login(options)
+    cmd.query_product_inventory(options)
+  #   consumer_session.close
+   #  puts "#{result}"
+ #  sleep(1)
+   
+  
+    
+    puts  '-------------finished processing!!!'
+ 
+    
+   # Thread.exit
+   # exit!
+  

data/bin/yahoo_csv.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env jruby -S
+# == Synopsis
+#   Update accounts or accounts based on yahoo statistics
+# == Usage
+#  yahoo_csv.rb -u vtiger_url  -e Contacts  -n username -k access_key  -f csvfilename
+# == Useful commands
+#  yahoo_csv.rb -u testsmartroam.estormtech.com -e Contacts  -n admin -k xxx   -f csvfilename
+# == Author
+#   Scott Sproule  --- Ficonab.com (scott.sproule@ficonab.com)
+# == Copyright
+#    Copyright (c) 2009 Ficonab Pte. Ltd.
+#     See license for license details
+require 'yaml'
+require 'rubygems'
+gem 'vtiger'
+require 'vtiger'
+require 'optparse'
+require 'rdoc/usage'
+require 'java' if RUBY_PLATFORM =~ /java/
+ arg_hash=Vtiger::Options.parse_options(ARGV)
+ RDoc::usage if arg_hash[:help]==true
+require 'pp'
+  options = arg_hash
+   # set up variables using hash
+   fieldmapping={}
+   fieldmapping[:tsipid]='cf_579'  #TSIPID   cf_578  accounts
+   fieldmapping[:referring_domain]='cf_622'  #referring domain
+   fieldmapping[:traffic_source]='cf_623'  #traffic source
+   fieldmapping[:campaign]='cf_624'  #campaign
+   fieldmapping[:revenue]='cf_627'  #revenue
+   fieldmapping[:unique_actions]='cf_628'  #campaign
+   fieldmapping[:search_phrase]='cf_629'  #campaign
+   puts "vtiger update contact #{Time.now}"
+   puts "vtiger url: #{arg_hash[:url]} "
+    puts "vtiger contact: #{arg_hash[:contact]} "
+    cmd = Vtiger::Commands.new()
+    cmd.challenge(options)
+    cmd.login(options)
+    tsipid='77'
+   # account_id = cmd.query_tsipid(tsipid,fieldmapping,options)
+   # puts "updating account id: #{account_id} tsipid '77' "
+   # values=cmd.retrieve_object(account_id)
+   # puts values.length
+  
+   success_summary=""
+    fail_summary=""
+   counter=0
+   total= 0
+     member_label="Member"
+  #  cmd.update_yahoo(fieldmapping,values,"www.google.com","traffic_source", "campaign123")
+    traffic_rows=Vtiger::Misc.read_csv_file(options[:filename]) 
+    traffic_rows.collect { |row|
+        #puts row
+         break if row[member_label]=="Subtotal"
+        success,summary =cmd.process_row(row,fieldmapping,options)
+        total+=1
+        success_summary << "#{total} #{summary}" if success
+        counter+=1 if success
+        fail_summary << "#{total} #{summary}" if !success
+       
+      }
+    
+      puts  "% complete success #{counter} of total #{total}"
+      puts "Success: #{success_summary}"
+      puts "Fail: #{fail_summary}"
+      
+      
+   
+    
+  #   consumer_session.close
+   #  puts "#{result}"
+ #  sleep(1)
+   
+  
+    
+    puts  '-------------finished processing!!!'
+ 
+    
+   # Thread.exit
+   # exit!
+  

data/lib/vtiger/base.rb

@@ -1,5 +1,6 @@
 require 'net/http'
-require 'json'
+#require 'yajl'
+require 'yajl'
 require 'digest/md5'
 require 'erb'
  class Hash  
@@ -49,11 +50,12 @@ module Vtiger
 
            body_enc=body.url_encode
           # puts "attemping post: #{self.endpoint_url}#{operation} body: #{body} body_enc= #{body_enc}"
-           response=ht.post(self.endpoint_url+operation,body_enc,response_header)
+           resp=ht.post(self.endpoint_url+operation,body_enc,response_header)
 
            # p response.body.to_s
-            r=JSON.parse response.body
-            r
+           self.json_parse resp.body
+           # r=JSON.parse response.body
+          #  r
         end
         def http_ask_get(input_url)
          # puts "about to HTTP.get on '#{input_url}'"
@@ -70,8 +72,8 @@ module Vtiger
 
 
          # puts "resp: " + resp 
-          r=JSON.parse resp.body
-          r
+          self.json_parse resp.body
+       #   r
         end
 
         def login(options)
@@ -109,13 +111,9 @@ def describe_object(options)
             # scott not working -- JSON.generate(input_array,{'array_nl'=>'true'})
             result = http_ask_get(self.endpoint_url+"operation=describe&sessionName=#{self.session_name}&elementType=#{options[:element_type]}")
            # puts JSON.pretty_generate(result)
-           if defined? RAILS_ENV
-              puts "in JSON code rails env: #{RAILS_ENV}"
-               puts object_map.to_json
-           else
-             puts "rails env is not defined"
-             puts self.json_please(result)    #scott  tmp=JSON.generate(object_map)
-           end
+         
+          puts "#{result.inspect}"    #scott  tmp=JSON.generate(object_map)
+           
 end
 def addobject(options)
           puts "in addobject"
@@ -129,15 +127,27 @@ def addobject(options)
          # self.session_name=result["result"]["sessionName"]
          #  puts JSON.pretty_generate(result)
 end
+def json_parse(incoming)
+   json = StringIO.new(incoming)
+   parser = Yajl::Parser.new
+   hash = parser.parse(json)
+end
 def json_please(object_map)
    if defined? RAILS_ENV
        #puts "in JSON code rails env: #{RAILS_ENV}"
         tmp=object_map.to_json
     else
       puts "rails env is not defined"
-      tmp=JSON.fast_generate(object_map)   #scott  tmp=JSON.generate(object_map)
+   #   json = StringIO.new()
+      str = Yajl::Encoder.encode(object_map)
+      
+   #    parser = Yajl::Parser.new
+    #   tmp = parser.parse(object_map.to_s)
+        #   object_map.to_json    #  can remove eventually this if statements
+      
+     # tmp=YAJL.generate(object_map)   #scott  tmp=JSON.generate(object_map)
     end
-    tmp
+    str
 end
 def updateobject(values)
             #puts "in updateobject"

data/lib/vtiger/commands.rb

@@ -1,7 +1,8 @@
 require 'net/http'
-require 'json'
+#require 'yajl'
 #require 'digest/md5'
 require 'erb'
+require 'rubygems'
 gem 'activesupport'
 require 'active_support/core_ext/class/attribute_accessors'
  
@@ -32,6 +33,23 @@ module Vtiger
       # puts JSON.pretty_generate(result)
       result["success"]
     end
+    def add_trouble_ticket(options,status,title,hashv)
+       puts "in add trouble ticket"
+       object_map= { 'assigned_user_id'=>"#{self.userid}",'ticketstatus'=>"#{status}", 'ticket_title'=>"#{title}"}
+       object_map=object_map.merge hashv
+       # 'tsipid'=>"1234"
+       tmp=self.json_please(object_map)
+       input_array ={'operation'=>'create','elementType'=>"HelpDesk",'sessionName'=>"#{self.session_name}", 'element'=>tmp} # removed the true
+       puts "input array:"  + input_array.to_s   #&username=#{self.username}&accessKey=#{self.md5}
+       # scott not working -- JSON.generate(input_array,{'array_nl'=>'true'})
+       result = http_crm_post("operation=create",input_array)
+       puts "#{result.inspect}"
+      # self.session_name=result["result"]["sessionName"]
+       # puts JSON.pretty_generate(result)
+       ttnumber="invalid"
+       ttnumber =result["result"]["ticket_no"]  if result["success"]
+       return result["success"],ttnumber 
+     end
     def action(options)
       puts "in action"
     end

data/lib/vtiger/support.rb

@@ -34,7 +34,8 @@ module Vtiger
                                                                                           }                                          
         opts.on("-D","--email VAL", String) {|val|  temp_hash[:email ] = val
                                                      temp_hash[:destination]=val }
-
+       opts.on("-t","--title VAL", String) {|val|  temp_hash[:title ] = val                                                                                             
+                                                 }
     
       opts.on("-c","--contact VAL", String) {|val|  temp_hash[:contact ] = val 
                                               puts "contact #{val}"     }  

data/test/test_helper.rb

@@ -2,5 +2,5 @@ require 'stringio'
 require 'test/unit'
 require 'yaml'
 require 'rubygems'
-gem 'json_pure'
+#gem 'json_pure'
 require File.dirname(__FILE__) + '/../lib/vtiger'

data/test/test_vtiger.rb

@@ -66,6 +66,19 @@ class TestVtiger < Test::Unit::TestCase
      assert lead,"lead should succeed"
   end
   
+  def test_add_trouble_ticket
+     cmd = Vtiger::Commands.new()
+     challenge=cmd.challenge(@options)
+     login=cmd.login(@options)
+     hv={}
+    # hv[:firstname]='test'
+     tt,ticketnum=cmd.add_trouble_ticket(@options,"Open","testing title",hv)
+     
+     puts "trouble ticket is #{tt} ticket number is #{ticketnum}"
+     assert challenge,"challenge is false "
+     assert login,"login should succeed"
+     assert tt,"trouble ticket should succeed"
+  end
   
   def test_describe_object
       cmd = Vtiger::Commands.new()

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vtiger
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Scott Sproule
@@ -15,14 +15,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-23 00:00:00 +08:00
+date: 2010-06-23 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
 description: Use to access vtiger crm system from ruby.
 email: scott.sproule@estormtech.com
-executables: []
-
+executables: 
+- add_contact.rb
+- add_lead.rb
+- describe_object.rb
+- list_types.rb
+- query.rb
+- yahoo_csv.rb
+- add_trouble_ticket.rb
+- update_stock_inventory.rb
 extensions: []
 
 extra_rdoc_files: []
@@ -34,6 +41,15 @@ files:
 - lib/vtiger.rb
 - test/test_helper.rb
 - test/test_vtiger.rb
+- bin/add_contact.rb
+- bin/add_lead.rb
+- bin/add_trouble_ticket.rb
+- bin/describe_object.rb
+- bin/helloworld.rb
+- bin/list_types.rb
+- bin/query.rb
+- bin/update_stock_inventory.rb
+- bin/yahoo_csv.rb
 - History.txt
 - Manifest.txt
 - PostInstall.txt