vtiger 0.3.4

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-07-17
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,22 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/vtiger.rb
+lib/vtiger/base.rb
+lib/vtiger/support.rb
+lib/vtiger/commands.rb
+bin/add_contact.rb
+bin/yahoo_csv.rb
+bin/update_stock_inventory.rb
+bin/add_lead.rb
+bin/describe_object.rb
+bin/helloworld.rb
+bin/query.rb
+bin/list_types.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_vtiger.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on vtiger, see http://vtiger.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,234 @@
+= vtiger
+* http://estormtech.com
+This gem provides access to vtiger from ruby.  It uses the vtiger web services to access the data in  vtiger system. 
+
+See the binary files to test the system. 
+
+== DESCRIPTION:
+
+There are a set of base commands  (eg hpttp get, http post, login, challenge etc)
+And commands which are more specific to the actual usage such as addlead, describe object
+
+Options can be passed as hash  or preset using a Class variable  (which is why the cattr_accessor definition is required from activesupport)
+
+Vtiger::API.api_settings = {
+    :username => 'admin',
+    :key => 'ssss'
+    :url => 'democrm.estormtech.com'
+  }
+
+
+
+== FEATURES/PROBLEMS:
+
+* TBD
+
+== SYNOPSIS:
+
+  	 Vtiger::Api.api_settings = {
+       :username => 'admin',
+       :key => 'ssss',
+       :url => 'democrm.estormtech.com',
+       :element_type => 'Contacts'
+     }
+   cmd = Vtiger::Commands.new()
+   challenge=cmd.challenge({})
+   login=cmd.login({})
+    cmd.add_lead  etc...
+
+== REQUIREMENTS:
+
+
+
+== INSTALL:
+
+find userid from vtiger_users  (supposed to be in preferences section)
+select username,accessKey from vtiger_users;
+
+
+tokens are stored in
+ vtiger_ws_userauthtoken  
+
+==== Usage:
+Server Types: list types on the server
+ list_types.rb -u democrm.estormtech.com  -n scott -k xxxxx
+
+Describe Object:
+ describe_object.rb -u crm.estormtech.com  -n admin  -k xx  -e Contacts
+
+Getting the custom field ids
+ describe_object.rb -u crm.estormtech.com  -n admin  -k xxx  -e Contacts | grep for the label name
+
+
+== Testing via Curl
+Testing via curl
+
+
+ curl -d username=scott -d accessKey=xxx http://crm.yoururl.com/webservice.php?operation=login
+Name":"3a8b6b834a63eb909ecfa","userId":"19x5","version":"0.2","vtigerVersion":"5.1.0 RC"}}
+
+
+
+List types
+
+
+{
+  "success": true,
+  "result": {
+    "types": [
+      "Calendar",
+      "Leads",
+      "Accounts",
+      "Contacts",
+      "Potentials",
+      "Products",
+      "Documents",
+      "Emails",
+      "HelpDesk",
+      "Faq",
+      "Vendors",
+      "PriceBooks",
+      "Quotes",
+      "PurchaseOrder",
+      "SalesOrder",
+      "Invoice",
+      "Campaigns",
+      "Events",
+      "Users",
+      "ServiceContracts",
+      "PBXManager",
+      "Services",
+      "Groups",
+      "Currency",
+      "DocumentFolders"
+    ],
+    "information": {
+      "Calendar": {
+        "isEntity": true,
+        "label": "Calendar",
+        "singular": "To Do"
+      },
+      "Leads": {
+        "isEntity": true,
+        "label": "Leads",
+        "singular": "Lead"
+      },
+      "Accounts": {
+        "isEntity": true,
+        "label": "Accounts",
+        "singular": "Account"
+      },
+      "Contacts": {
+        "isEntity": true,
+        "label": "Contacts",
+        "singular": "Contact"
+      },
+      "Potentials": {
+        "isEntity": true,
+        "label": "Potentials",
+        "singular": "Potential"
+      },
+      "Products": {
+        "isEntity": true,
+        "label": "Products",
+        "singular": "Product"
+      },
+      "Documents": {
+        "isEntity": true,
+        "label": "Documents",
+        "singular": "Document"
+      },
+      "Emails": {
+        "isEntity": true,
+        "label": "Email",
+        "singular": "Email"
+      },
+      "HelpDesk": {
+        "isEntity": true,
+        "label": "Trouble Tickets",
+        "singular": "Ticket"
+      },
+      "Faq": {
+        "isEntity": true,
+        "label": "FAQ",
+        "singular": "Faq"
+      },
+      "Vendors": {
+        "isEntity": true,
+        "label": "Vendors",
+        "singular": "Vendor"
+      },
+      "PriceBooks": {
+        "isEntity": true,
+        "label": "Price Books",
+        "singular": "PriceBook"
+      },
+      "Quotes": {
+        "isEntity": true,
+        "label": "Quotes",
+        "singular": "Quote"
+      },
+      "PurchaseOrder": {
+        "isEntity": true,
+        "label": "Purchase Order",
+        "singular": "PurchaseOrder"
+      },
+      "SalesOrder": {
+        "isEntity": true,
+        "label": "Sales Order",
+        "singular": "SalesOrder"
+      },
+      "Invoice": {
+        "isEntity": true,
+        "label": "Invoice",
+        "singular": "Invoice"
+      },
+      "Campaigns": {
+        "isEntity": true,
+        "label": "Campaigns",
+        "singular": "Campaign"
+      },
+      "Events": {
+        "isEntity": true,
+        "label": "Events",
+        "singular": "Event"
+      },
+      "Users": {
+        "isEntity": true,
+        "label": "Users",
+        "singular": "User"
+      },
+      "ServiceContracts": {
+        "isEntity": true,
+        "label": "Service Contracts",
+        "singular": "Service Contract"
+      },
+      "PBXManager": {
+        "isEntity": true,
+        "label": "PBX Manager",
+        "singular": "SINGLE_PBXManager"
+      },
+      "Services": {
+        "isEntity": true,
+        "label": "Services",
+        "singular": "Service"
+      },
+      "Groups": {
+        "isEntity": false,
+        "label": "Groups",
+        "singular": "Groups"
+      },
+      "Currency": {
+        "isEntity": false,
+        "label": "Currency",
+        "singular": "Currency"
+      },
+      "DocumentFolders": {
+        "isEntity": false,
+        "label": "DocumentFolders",
+        "singular": "DocumentFolders"
+      }
+    }
+  }
+}
+-------------finished processing!!!

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+#require './lib/test'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'vtiger' do
+  self.developer 'scott sproule', 'scott.sproule@ficonab.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "vtiger"
+    gemspec.summary = "Vtiger support of webservices from ruby"
+    gemspec.description = "vtiger webservice calls"
+    gemspec.email = "scott.sproule@estormtech.com"
+    gemspec.homepage = "http://github.com/semdinsp/vtiger-ruby-webservices"
+    gemspec.authors = ["Scott Sproule"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end

data/Rakefile.orig

@@ -0,0 +1,30 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/vtiger'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+gem 'hoe'
+require 'hoe'
+$hoe = Hoe.new('vtiger', Vtiger::VERSION) do |p|
+  p.developer('scott sproule', 'scott.sproule@ficonab.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/vtiger.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+Dir[File.join(File.dirname(__FILE__), 'vtiger/**/*.rb')].sort.each { |lib| require lib }
+module Vtiger
+  VERSION = '0.3.4'
+end

data/lib/vtiger/base.rb

@@ -0,0 +1,155 @@
+require 'net/http'
+require 'json'
+require 'digest/md5'
+require 'erb'
+ class Hash  
+  def url_encode  
+    to_a.map do |name_value|  
+      name_value.map { |e| CGI.escape e.to_s }.join '='  
+     end.join '&'  
+   end  
+ end
+
+module Vtiger
+  class Base
+     attr_accessor :md5,:token, :endpoint_url, :access_key, :session_name, :url, :username,  :userid
+     
+     def challenge(options)
+
+       #puts "in challenge"
+       self.url=options[:url] || Vtiger::Api.api_settings[:url]
+       self.username = options[:username]|| Vtiger::Api.api_settings[:username]
+       self.access_key = options[:key] || Vtiger::Api.api_settings[:key]
+       self.endpoint_url="http://#{self.url}/webservice.php?"
+       operation = "operation=getchallenge&username=#{self.username}"; 
+        #puts "challenge: " + self.endpoint_url + operation
+        r=http_ask_get(self.endpoint_url+operation)
+       # puts JSON.pretty_generate(r)
+       # puts "success is: " + r["success"].to_s   #==true
+        self.token = r["result"]["token"] #if r["success"]==true
+
+        #puts "token is: " + self.token
+         create_digest
+        #puts "digest is: #{self.md5} token #{self.token}" 
+        self.token!=nil
+     end
+     def create_digest
+        #access key from my_preferences page of vtiger
+        digest_string="#{self.token}#{self.access_key}"
+        self.md5=Digest::MD5.hexdigest(digest_string)
+        puts "#{self.url}: string #{digest_string} results in digest: "+self.md5 + " access key: "+ self.access_key + " token: " + self.token
+      end
+       def http_crm_post(operation, body)
+          response = nil
+          response_header = {"Content-type" => "application/x-www-form-urlencoded"}
+          #puts " endpoint: #{self.endpoint_url}"
+           t=URI.split(self.endpoint_url.to_s)
+          # puts "host is: " + t[2]   #FIX THIS.
+           ht =Net::HTTP.start(t[2],80)
+
+           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)
+
+           # p response.body.to_s
+            r=JSON.parse response.body
+            r
+        end
+        def http_ask_get(input_url)
+         # puts "about to HTTP.get on '#{input_url}'"
+         # url=ERB::Util.url_encode(input_url)
+         # resp= Net::HTTP.get(URI.parse(url))
+          url = URI.parse(input_url)
+         # puts "inspect url: " + url.inspect
+              req = Net::HTTP::Get.new("#{url.path}?#{url.query}")
+              resp = Net::HTTP.start(url.host, url.port) {|http|
+            #    puts "url path is #{url.path}"
+                http.request(req)
+              }
+          #   puts resp.body
+
+
+         # puts "resp: " + resp 
+          r=JSON.parse resp.body
+          r
+        end
+
+        def login(options)
+         # puts "in login"
+          input_array ={'operation'=>'login', 'username'=>self.username, 'accessKey'=>self.md5} # 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=login",input_array)
+          self.session_name=result["result"]["sessionName"] if result["result"]!=nil
+          self.userid = result["result"]["userId"] if result["result"]!=nil
+          puts "session name is: #{self.session_name} userid #{self.userid}"
+          self.userid!=nil
+        end
+def retrieve_object(objid)
+            puts "in retrieve object"
+             #&username=#{self.username}&accessKey=#{self.md5}
+              # scott not working -- JSON.generate(input_array,{'array_nl'=>'true'})
+              result = http_ask_get(self.endpoint_url+"operation=retrieve&sessionName=#{self.session_name}&id=#{objid}")
+           #   puts JSON.pretty_generate(result)
+               values=result["result"]
+               values
+end
+def query(options)
+        puts "in query object"
+         #&username=#{self.username}&accessKey=#{self.md5}
+          # scott not working -- JSON.generate(input_array,{'array_nl'=>'true'})
+          action_string=ERB::Util.url_encode("#{options[:query]}")
+          result = http_ask_get(self.endpoint_url+"operation=query&sessionName=#{self.session_name}&query="+action_string)
+          # http_ask_get(self.endpoint_url+"operation=query&sessionName=#{self.session_name}&userId=#{self.userid}&query="+action_string)
+       #   puts JSON.pretty_generate(result)
+end
+def describe_object(options)
+          puts "in describe object"
+           #&username=#{self.username}&accessKey=#{self.md5}
+            # 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
+end
+def addobject(options)
+          puts "in addobject"
+          object_map= { 'assigned_user_id'=>"#{self.userid}",'lastname'=>"#{options[:contact]}",'cf_554'=>"1234"}
+          # 'tsipid'=>"1234"
+          tmp=self.json_please(object_map)
+          input_array ={'operation'=>'create','elementType'=>"#{options[:element_type]}",'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)
+         # self.session_name=result["result"]["sessionName"]
+         #  puts JSON.pretty_generate(result)
+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)
+    end
+    tmp
+end
+def updateobject(values)
+            #puts "in updateobject"
+            object_map= { 'assigned_user_id'=>"#{self.userid}",'id'=>"#{self.object_id}" }.merge values.to_hash
+            # 'tsipid'=>"1234"
+            tmp=self.json_please(object_map)
+            input_array ={'operation'=>'update','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=update",input_array)
+           # self.session_name=result["result"]["sessionName"]
+           #  puts JSON.pretty_generate(result)
+end
+  end #clase base
+end #moduble

data/lib/vtiger/commands.rb

@@ -0,0 +1,126 @@
+require 'net/http'
+require 'json'
+#require 'digest/md5'
+require 'erb'
+gem 'activesupport'
+require 'active_support/core_ext/class/attribute_accessors'
+ 
+
+module Vtiger
+  class Api
+  @@api_settings = {}
+   cattr_accessor :api_settings
+  end
+  class Commands < Vtiger::Base
+    attr_accessor  :product_id, :qty_in_stock, :new_quantity, :object_id, :account_name
+   
+   
+    
+     # scott was: def updateobject(options,values)
+ # add a lead with ln last name, co company, and hashv a hash of other values you want to set    
+    def addlead(options,ln,co,hashv)
+      puts "in addobject"
+      object_map= { 'assigned_user_id'=>"#{self.userid}",'lastname'=>"#{ln}", 'company'=>"#{co}"}
+      object_map=object_map.merge hashv
+      # 'tsipid'=>"1234"
+      tmp=self.json_please(object_map)
+      input_array ={'operation'=>'create','elementType'=>"Leads",'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)
+     # self.session_name=result["result"]["sessionName"]
+      # puts JSON.pretty_generate(result)
+      result["success"]
+    end
+    def action(options)
+      puts "in action"
+    end
+      def list_types(options)
+        puts "in list types"
+         #&username=#{self.username}&accessKey=#{self.md5}
+          # scott not working -- JSON.generate(input_array,{'array_nl'=>'true'})
+          result = http_ask_get(self.endpoint_url+"operation=listtypes&sessionName=#{self.session_name}")
+         # puts JSON.pretty_generate(result)
+      end
+      
+         
+      def update_yahoo(fieldmapping,values,referring_domain,traffic_source, campaign,revenue,actions,search_phrase)
+        #self.object id found in query_tsipid
+       # puts "fm: #{fieldmapping[:traffic_source]} ts: #{traffic_source} values: #{values} "
+      #  values[fieldmapping[:traffic_source].to_s]=traffic_source
+      #  values[fieldmapping[:campaign].to_s]=campaign
+        values[fieldmapping[:referring_domain].to_s]=referring_domain
+          values[fieldmapping[:revenue].to_s]=revenue  #revenue
+           values[fieldmapping[:unique_actions].to_s]=actions  #campaign
+           values[fieldmapping[:search_phrase].to_s]=search_phrase
+        updateobject(values)
+      end
+      def process_row(row,fieldmapping,options)
+        result_summary=""
+        success=false
+         member_label="Member"
+         refering_domain_label="Referring URL (Direct)"
+         traffic_src_label="Traffic Sources (Intelligent)"
+         campaign_label="Campaign"
+         unique_label="Unique Actions"
+         rev_label="Revenue"
+         search_label="Search Phrases (Direct)"
+          account_id = self.query_tsipid(row[member_label].to_s,fieldmapping,options)
+           #puts "database id: #{account_id}"
+           if account_id!='failed'  
+           values=self.retrieve_object(account_id)
+           self.update_yahoo(fieldmapping,values,row[refering_domain_label],
+                       row[traffic_src_label], row[campaign_label],row[rev_label],row[unique_label],row[search_label])
+           result_summary = " Success: row of yahoo csv with TSIPID: #{row[member_label].to_s}\n" 
+           success=true
+           else  
+             result_summary =" Failure: row of yahoo csv with Member: #{row[member_label].to_s}\n"      
+              # else
+         end    #if
+         return success,result_summary
+      end
+       def query_tsipid(id,fieldmapping,options)
+          puts "in query id"
+           #&username=#{self.username}&accessKey=#{self.md5}
+            # scott not working -- JSON.generate(input_array,{'array_nl'=>'true'})
+            action_string=ERB::Util.url_encode("select id,lastname from #{options[:element_type]} where #{fieldmapping[:tsipid]} = '#{id}';")
+          #  action_string=ERB::Util.url_encode("select id,accountname from #{options[:element_type]} where #{fieldmapping[:tsipid]} = '#{id}';")  ACCOUNTS
+            puts "action string:" +action_string
+            res = http_ask_get(self.endpoint_url+"operation=query&sessionName=#{self.session_name}&query="+action_string)
+            # http_ask_get(self.endpoint_url+"operation=query&sessionName=#{self.session_name}&userId=#{self.userid}&query="+action_string)
+         #   puts JSON.pretty_generate(res)
+            values=res["result"][0]   #comes back as array
+            #puts values.inspect
+            # return the account id
+             self.object_id = 'failed'
+             if values!= nil 
+                self.object_id=values["id"]
+               self.account_name=values["accountname"] 
+             end
+             self.object_id
+          #  self.new_quantity = self.qty_in_stock.to_i + options[:quantity].to_i
+           #  updateobject(options,{'qtyinstock'=> "#{self.new_quantity}","productname"=>"#{options[:productname]}"})
+        end
+        def query_product_inventory(options)
+          puts "in query product count"
+           #&username=#{self.username}&accessKey=#{self.md5}
+            # scott not working -- JSON.generate(input_array,{'array_nl'=>'true'})
+            action_string=ERB::Util.url_encode("select id, qtyinstock, productname from Products where productname like '#{options[:productname]}';")
+            puts "action string:" +action_string
+            res = http_ask_get(self.endpoint_url+"operation=query&sessionName=#{self.session_name}&query="+action_string)
+            # http_ask_get(self.endpoint_url+"operation=query&sessionName=#{self.session_name}&userId=#{self.userid}&query="+action_string)
+            puts JSON.pretty_generate(res)
+            values=res["result"][0]   #comes back as array
+            puts values.inspect
+            self.product_id = values["id"]
+            self.object_id=self.product_id
+            self.qty_in_stock = values["qtyinstock"]
+            # NOTE INTEGER VALUES
+            self.new_quantity = self.qty_in_stock.to_i + options[:quantity].to_i
+            # NEEDS TO RETREIVE OBEJCT
+            puts "#{self.product_id}, #{self.qty_in_stock} New quantity should be: #{self.new_quantity}"
+            updateobject({'qtyinstock'=> "#{self.new_quantity}","productname"=>"#{options[:productname]}"})
+        end
+  end
+  
+end

data/lib/vtiger/support.rb

@@ -0,0 +1,99 @@
+# basic format for stomp messages
+require 'rexml/document'
+#require 'xml_helper.rb'
+#require 'rubygems'
+#gem 'stomp_message'
+#require 'stomp_message'
+require 'optparse'
+require 'rdoc/usage'
+gem 'fastercsv'
+require 'fastercsv'
+
+module Vtiger
+  class Misc
+    def self.read_csv_file(filepath)
+      FasterCSV.read( filepath, { :headers           => true})  
+    end
+  end
+  class Options
+    def self.parse_options(params)
+       opts = OptionParser.new
+    #   puts "argv are #{params}"
+       temp_hash = {}
+       temp_hash[:ack]= 'false'   # no ack by default
+       temp_hash[:msisdn] = 'not_defined'
+       email_flag=false
+        opts.on("-u","--url VAL", String) {|val|  temp_hash[:url ] = val
+                                                puts "url is #{val}"
+                                                }
+      # takes ruby hash code and converts to yaml
+      
+       opts.on("-H","--body_hash VAL", String) {|val|   temp=eval(val)
+                                                 temp_hash[:body ] = temp.to_yaml
+                                                                                        #  puts "host is #{val}"
+                                                                                          }                                          
+        opts.on("-D","--email VAL", String) {|val|  temp_hash[:email ] = val
+                                                     temp_hash[:destination]=val }
+
+    
+      opts.on("-c","--contact VAL", String) {|val|  temp_hash[:contact ] = val 
+                                              puts "contact #{val}"     }  
+      opts.on("-p","--productname VAL", String) {|val|  temp_hash[:productname ] = val 
+                                             puts "productname #{val}"     }             
+      opts.on("-Q","--quantity VAL", String) {|val|  temp_hash[:quantity ] = val 
+                   puts "stock to change #{val}"     }                                            
+           opts.on("-i","--objectid VAL", String) {|val|  temp_hash[:objectid ] = val 
+                                                                                        puts "objectid #{val}"     }
+                 opts.on("-q","--query VAL", String) {|val|  temp_hash[:query ] = val 
+                                                                                          puts "contact #{val}"     }
+        opts.on("-e","--elementtype VAL", String) {|val|  temp_hash[:element_type ] = val 
+                                                                                      puts "elementtype #{val}"     }
+          opts.on("-k","--access_key VAL", String) {|val|  temp_hash[:key ] = val 
+                                puts "key #{val}"     }
+     opts.on("-n","--username VAL", String) {|val|  temp_hash[:username ] = val 
+                                   puts "username #{val}"     }
+      opts.on("-f","--filename VAL", String) {|val|  temp_hash[:filename ] = val 
+                                                     puts "filename #{val}"     }                                                                                                                                                    
+       opts.on("-d","--debug", "turn on debug") { |val| temp_hash[:debug ] = true              }                          
+                                             
+                                       
+       opts.parse(params)
+                     # puts " in HTTP #{hostname} port #{port} url: #{url}"
+      
+      return temp_hash
+
+     end # parse options
+  end #class
+  # help build xml commands from messages
+ 
+  end  #module
+  
+  def RDoc.usage_no_exit(*args)
+      # main_program_file = caller[1].sub(/:\d+$/, '')
+        main_program_file = caller[1].split(':')[0]
+      #puts "main program is #{main_program_file}"
+     # puts " caller is #{caller.inspect}"
+      comment = File.open(main_program_file) do |file|
+        find_comment(file)
+      end
+
+      comment = comment.gsub(/^\s*#/, '')
+
+      markup = SM::SimpleMarkup.new
+      flow_convertor = SM::ToFlow.new
+
+      flow = markup.convert(comment, flow_convertor)
+
+      format = "plain"
+
+      unless args.empty?
+        flow = extract_sections(flow, args)
+      end
+
+      options = RI::Options.instance
+      if args = ENV["RI"]
+        options.parse(args.split)
+      end
+      formatter = options.formatter.new(options, "")
+      formatter.display_flow(flow)
+    end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'stringio'
+require 'test/unit'
+require 'yaml'
+require 'rubygems'
+gem 'json_pure'
+require File.dirname(__FILE__) + '/../lib/vtiger'

data/test/test_vtiger.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestVtiger < Test::Unit::TestCase
+
+  def setup
+    @options={}
+    @options[:url]='democrm.estormtech.com'   
+    @options[:key]='xBY6leZ5kZHQm2Y'
+    @options[:username]="admin"
+    @options[:element_type]="Contacts"  
+  end
+  
+  def test_login
+     cmd = Vtiger::Commands.new()
+     challenge=cmd.challenge(@options)
+     login=cmd.login(@options)
+     assert challenge,"challenge is false"
+     assert login,"login is false"
+  end
+   
+  def test_api_login
+    Vtiger::Api.api_settings = {
+         :username => 'admin',
+         :key => 'xBY6leZ5kZHQm2Y',
+         :url => 'democrm.estormtech.com',
+         :element_type => 'Contacts'
+       }
+     cmd = Vtiger::Commands.new()
+     challenge=cmd.challenge({})
+     login=cmd.login({})
+     assert challenge,"challenge is false"
+     assert login,"login is false"
+  end
+  def test_api_login2
+    Vtiger::Api.api_settings = {
+         :username => 'admin',
+         :key => 'xBY6leZ5kZHQm2Y',
+         :url => 'democrm.estormtech.com',
+         :element_type => 'Contacts'
+       }
+     cmd = Vtiger::Commands.new()
+     options={}
+     options[:username]='admin'
+     challenge=cmd.challenge(options)
+     login=cmd.login(options)
+     assert challenge,"challenge is false"
+     assert login,"login is false"
+  end
+  def test_bad_login
+     cmd = Vtiger::Commands.new()
+     @options[:username]='test'
+     challenge=cmd.challenge(@options)
+     login=cmd.login(@options)
+     assert challenge,"challenge is false "
+     assert !login,"login should not succeed"
+  end
+  def test_add_lead
+     cmd = Vtiger::Commands.new()
+     challenge=cmd.challenge(@options)
+     login=cmd.login(@options)
+     hv={}
+     hv[:firstname]='test'
+     lead=cmd.addlead(@options,"testlastname","testco",hv)
+     assert challenge,"challenge is false "
+     assert login,"login should succeed"
+     assert lead,"lead should succeed"
+  end
+  
+  
+  def test_describe_object
+      cmd = Vtiger::Commands.new()
+      challenge=cmd.challenge(@options)
+      login=cmd.login(@options)
+        @options[:element_type]="Leads"  
+      cmd.describe_object(@options)
+      assert challenge,"challenge is false "
+      assert login,"login should succeed"
+     
+   end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: vtiger
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 4
+  version: 0.3.4
+platform: ruby
+authors: 
+- Scott Sproule
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-23 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: Use to access vtiger crm system from ruby.
+email: scott.sproule@estormtech.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/vtiger/base.rb
+- lib/vtiger/commands.rb
+- lib/vtiger/support.rb
+- lib/vtiger.rb
+- test/test_helper.rb
+- test/test_vtiger.rb
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- Rakefile
+- Rakefile.orig
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/semdinsp/vtiger-ruby-webservices
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 19
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: vtiger
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Vtiger web service support via ruby
+test_files: []
+