sugarcrm_v10 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06ca102c42b10633cd05923819b2051c4a268256
+  data.tar.gz: 84cd5503d66b49c8149a372bbf45cdfa1e34ec13
+SHA512:
+  metadata.gz: 557c8186cd54318abae7a9846173d4b40b27c8c6e324b36c0c9f9be17b312351adb283ee3dd41a6a4b12d12fe7dfe074c7da7e083163743f842f8b2708badba5
+  data.tar.gz: e368aea76a879c89513508b0b3920e8e1fb83aaad50a666afacec6a8e7ec5141d60d3bd209cae08a78a666e22330e616a6d4ad5a1e5584cc1b95f744f0f52272

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sugarcrm_v10.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Pournamithayyil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+SugarCRM REST v10
+Summary:
+An effective tool to interact with SugarCRM through the REST v10 api 
+Features:
+•	Supports creating, updating, retrieving records from modules in SugarCRM 
+•	Lists records filtered by an expression
+•	Access to related modules
+•	Supports uploading and downloading documents via document module
+•	Access API methods directly on the SugarCRM.connection object
+
+Synopsis:
+Establishing a connection:
+SugarCRM::Connection.connect(<host>,<consumer_key>,<consumer_secret>,<username>,<password>,<platform>)
+SugarCRM::Connection.connect(https://instance.sugarcrm.com,”testkey”,”sugar”,”admin”,”xxxx”,”sugarplatform”)
+
+Create a new record to a module:
+SugarCRM::Connection.create_record(<module>,<record>)
+SugarCRM::Connection.create_record(“Contacts”,{
+:first_name  => “Shanker”,
+:last_name => “Raj”,
+})
+
+Retrieve all records from a module: 
+SugarCRM::Connection.fetch_all(<module>,<max_num>,<offset>)
+#retrieves first 20 records
+SugarCRM::Connection.fetch_all(“Accounts”)
+#retrieves 10 records with offset 5 
+SugarCRM::Connection.fetch_all(“Accounts”,10,5)  
+
+Retrieve records by fields: 
+SugarCRM::Connection.fetch_any_fields(<module>,<max_num>,<offset><fields>)
+#retrieves  name and email addresses of 30 records with offset 2
+SugarCRM::Connection.fetch_any_fields(“Contacts”,30,2,[”name”,”email_address”])
+
+Retrieve a single record from a module:
+SugarCRM::Connection.fetch_single_record(<module>,<id>)
+#retrieves record with id 3  
+SugarCRM::Connection.fetch_single_record(“Accounts”,3)
+#retrieves only first_name of the record
+SugarCRM::Connection.fetch_single_record(“Accounts”,3).first_name
+
+Update a record of a module:
+SugarCRM::Connection.update_record(<module>,<id>,<data>)
+#updates billing address of a user
+SugarCRM::Connection.update_record(“Users”,2,{
+:billing_address => “abc”
+})
+
+Retrieve records by conditions:
+SugarCRM::Connection.filter_records(<module>,<max_num>,<offset>,<fields>,<filter>)
+
+#retrieves first 30 records with first_name ‘Ann’
+SugarCRM::Connection.filter_records(“Contacts”, 30,0, {
+:first_name =>"Ann"
+})
+#retrieves all ‘address’ and ‘phone’ whose first_name starts with‘A’
+SugarCRM::Connection.filter_records(“Contacts”,nil,nil, [”phone”,”address”],{
+:first_name =>{"$starts”=> ”Ann"
+}})
+
+Filter records with and/or sub-expression types :
+SugarCRM::Connection.filter_by_and_or(<module>,<max_num>,<offset>,<fields>,<filter>)
+#retrieves first 4 records whose last name is Hona and primary address state is CA 
+SugarCRM::Connection.filter_by_and_or("Accounts",4,0,[
+“name”,”title”
+],{
+"$and"=>{"last_name"=>"Hona",
+"primary_address_state"=>"CA"
+}})
+
+#Add a meeting to a contact :
+SugarCRM::Connection.create_related(<module>,<id>,<data>,<link_name>)
+SugarCRM::Connection.create_related("Contacts",3,{
+"name"=>"Test Meeting4",
+"description"=>"SugarMeeting4",
+"duration_hours"=>2
+},"meetings")
+
+Retrieve related module fields :
+SugarCRM::Connection.fetch_related(<module>,<id>,<fields>,<link_name>)
+#retrieves all document id related to a contact
+SugarCRM::Connection.fetch_related("Contacts",9,”id”,"documents")
+
+Download a document via document module :
+SugarCRM::Connection. download_document(<document_id>,<path_to_save>)
+SugarCRM::Connection. download_document(“2”,’E:/’)
+
+Upload a file :
+SugarCRM::Connection. upload_document(<options>)
+SugarCRM::Connection. upload_document ("name" => 'E:\ filename.pdf',    
+"status_id" => "Active",
+"doc_type" => "Forms",
+"category_id" => "Application",
+"document_name" => "filename.pdf",
+"template_type" => "Forms",
+"revision" => 1,
+"active_date" => Date.today,
+"subcategory_id" =>  "Other",
+)
+Using gem in Console :
+1.	Type ‘irb’ in command prompt
+2.	Use ‘require sugarcrm’ to require the gem
+3.	Connect to SugarCRM instance by calling SugarCRM::Connection.connect providing the arguments(refer the documentation above)
+4.	Now you can access all the above API methods directly on the SugarCRM.connection object
+Sugarcrm gem with Concurrent Sessions :
+The SugarCRM gem works with more than one session concurrently. Call SugarCRM::Connection.connect on each and access the methods on its object as shown below:
+Sugarcrm_conn1 = SugarCRM::Connection.connect(url1,..)
+Sugarcrm_conn1.fetch_all(“Accounts”)
+Sugarcrm_conn2 = SugarCRM::Connection.connect(url2,..)
+Sugarcrm_conn1.fetch_all(“Accounts”)
+
+Install :
+ $ gem install sugarcrm_v10
+
+
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/sugarcrm_v10.rb

@@ -0,0 +1,402 @@
+require 'active_support'
+require 'uri'
+require 'net/https'
+require 'json'
+require 'rest-client'
+require 'ostruct'
+require 'win32ole'
+require 'open-uri'
+require 'pdf-reader'
+require 'logger'
+require 'benchmark'
+
+module SugarCRM;
+
+class Connection
+
+def self.connect(url,consumer_key,consumer_secret,username,password,platform)  
+   begin
+    $consumer_key = consumer_key
+    $consumer_secret = consumer_secret
+    $username = username
+    $password = password
+    $platform = platform
+    
+    $url=url
+    uri = URI.parse(url)
+  
+    if uri.is_a?(URI::HTTP) && !uri.host.nil?
+  
+    oauth2_token_arguments = {"grant_type" =>"password", "client_id" =>consumer_key, "client_secret" =>consumer_secret, "username" =>username, "password" =>password, "platform" =>platform}
+   
+    http = Net::HTTP.new uri.host, uri.port  
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    request = Net::HTTP::Post.new uri.request_uri
+    request["Content-Type"] = "application/x-www-form-urlencoded"
+    request.body = URI.encode_www_form(oauth2_token_arguments)  
+    response = http.request request
+    $token = nil
+                
+    if response.kind_of? Net::HTTPSuccess
+       $token = JSON.parse response.body
+    return SugarCRM::Connection
+     else 
+       raise "Unable to connect to sugarcrm"
+     end
+   end
+    rescue Exception=>e
+     puts e
+    end
+end
+
+ def self.get_refreshtoken() #generates new token
+  
+    uri = URI.parse($url)
+    oauth2_token_arguments = {"grant_type" =>"refresh_token", "client_id" =>$consumer_key, "client_secret" =>$consumer_secret,"refresh_token"=>$token["refresh_token"]}
+    http = Net::HTTP.new uri.host, uri.port  
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    request = Net::HTTP::Post.new uri.request_uri
+    request["Content-Type"] = "application/x-www-form-urlencoded"
+    request.body = URI.encode_www_form(oauth2_token_arguments)  
+    response = http.request request
+    if response.kind_of? Net::HTTPSuccess
+     $token = JSON.parse response.body
+     return $token["access_token"]
+    else
+     return nil
+   end
+end
+ 
+def self.execute_uri(url) #getrequest
+ 
+  uri = URI.parse url
+  http = Net::HTTP.new uri.host, uri.port
+  http.use_ssl = true
+  http.verify_mode = OpenSSL::SSL::VERIFY_NONE     
+  request = Net::HTTP::Get.new uri.request_uri
+  request["Content-Type"] = "application/json"
+  request["OAuth-Token"] = $token["access_token"]
+  response = http.request request
+
+end
+
+def self.execute_postreq(url,record)
+
+  uri = URI.parse url
+  http = Net::HTTP.new uri.host, uri.port
+  http.use_ssl = true
+  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  request = Net::HTTP::Post.new (url)
+  request["OAuth-Token"] = $token["access_token"]
+  request.add_field('Content-Type', 'application/json')
+  request.body = record.to_json
+  response = http.request(request)
+
+end
+
+def self.execute_putreq(url,record)
+
+  uri = URI.parse url
+  http = Net::HTTP.new uri.host, uri.port
+  http.use_ssl = true
+  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  request = Net::HTTP::Put.new (url)
+  request["OAuth-Token"] = $token["access_token"]
+  request.add_field('Content-Type', 'application/json')
+  request.body = record.to_json
+  response = http.request(request)
+ 
+end
+
+
+def self.fetch_single_record(module_name,id)  # returns a single record with given id
+  begin
+
+  if get_refreshtoken()==nil
+    connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+  end
+
+  id=id.to_s
+  uri = URI.parse($url)
+  url = "https://"+uri.host+"/rest/v10/"+module_name+"/#{id}"
+  response = execute_uri(url)
+  raise "Module or record id not found" unless response.is_a? Net::HTTPSuccess
+  resp = JSON.parse response.body
+  return res= OpenStruct.new(resp)
+  rescue =>e
+    puts e
+  end
+end
+
+
+def self.fetch_all(module_name,max_num=20,offset=0) # returns a set of records with all fields.
+  begin
+   if get_refreshtoken()==nil
+     connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+   end
+  raise "Maximum number/offset should be a numeric value" unless max_num.is_a? Integer
+  raise "Maximum number/offset should be a numeric value" unless offset.is_a? Integer
+  uri=URI.parse($url)
+  url="https://"+uri.host+"/rest/v10/"+module_name+"?max_num=#{max_num}&offset=#{offset}"
+  response=execute_uri(url)
+  raise "Module '#{module_name}' not found" unless response.is_a? Net::HTTPSuccess
+  resp= JSON.parse response.body
+  records=resp["records"]
+  raise "No records found!" if records.empty?
+  return records
+  rescue Exception => e
+    puts e
+    end
+  end
+
+def self.fetch_any_fields(module_name,max_num=20,offset=0,fields) #returns a set of records , passing required fields and module name
+
+  begin
+    if get_refreshtoken()==nil
+      connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+    end
+  uri = URI.parse($url)
+  raise "Maximum number/offset should be a numeric value" unless max_num.is_a? Integer
+  raise "Maximum number/offset should be a numeric value" unless offset.is_a? Integer
+   
+  if fields.kind_of?(Array)
+     @field=fields[0]
+      i=1
+      while i<fields.length
+        @field=@field+","+fields[i]
+         i+=1
+       end 
+  else
+      @field=fields
+  end    
+  url = "https://"+uri.host+"/rest/v10/"+module_name+"?max_num=#{max_num}&"+"fields=#{@field}&"+"offset=#{offset}"
+  response = execute_uri(url)
+  raise "Module '#{module_name}' not found" unless response.is_a? Net::HTTPSuccess
+  
+  resp = JSON.parse response.body
+  records=resp["records"]
+  raise "No records found!" if records.empty?
+  return records
+  rescue Exception=>e
+    puts e
+    end
+  end
+
+
+def self.create_record(module_name,record) #creates a new record 
+  begin
+   if get_refreshtoken()==nil
+     connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+    end
+  uri = URI.parse($url)
+  url = "https://"+uri.host+"/rest/v10/"+module_name
+  response = execute_postreq(url,record)
+  raise "Module '#{module_name}' not found" unless response.is_a? Net::HTTPSuccess
+  rec= JSON.parse response.body
+  id=rec["id"]
+  return id
+  rescue Exception =>e
+  puts e
+  end
+ end
+ 
+ def self.update_record(module_name,id,record) #updates the given record
+  begin
+   if get_refreshtoken()==nil
+    connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+    end
+  updated = Hash.new
+  id = id.to_s
+  uri = URI.parse($url)
+  url = "https://"+uri.host+"/rest/v10/"+module_name+"/#{id}"
+  response = execute_putreq(url,record)
+  raise "Module or record id not found" unless response.is_a? Net::HTTPSuccess
+  rec= JSON.parse response.body
+  return rec
+  rescue Exception=>e
+  puts e
+   end
+  end
+
+
+def self.filter_by_and_or(module_name,max_num=20,offset=2,fields=nil,filter) # executes and/or  nested conditions 
+  begin
+   if get_refreshtoken()==nil
+     connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+  end
+ 
+  @filter1=""
+  @filter2=""
+  filter.each do |key,value|
+  value.each do |k,v|
+  if v.class==Hash
+     v.each do |x,y|
+     @filter1 = "&filter"+"#{[0]}"+"[#{key}]"+"#{[0]}"+"[#{k}]"+"[#{x}]"+"="+"#{y}"+@filter1
+  end
+   else
+     @filter2 = "&filter"+"#{[0]}"+"[#{key}]"+"#{[0]}"+"[#{k}]"+"="+"#{v}"+@filter2
+    end
+   end
+   end
+  @filter= @filter1+@filter2
+  if fields!=nil
+    if fields.kind_of?(Array)
+      @field=fields.join(",")
+    else
+      @field=fields
+    end  
+  end 
+  uri = URI.parse($url)
+  url = "https://"+uri.host+"/rest/v10/"+module_name+"?max_num=#{max_num}"+"&offset=#{offset}"+"#{@filter}"+"&fields=#{@field}"
+  response = execute_uri(url)
+  raise "Module not found" unless response.is_a? Net::HTTPSuccess
+  resp= JSON.parse response.body
+  records= resp["records"]
+  raise "No records found!" if records.empty?
+  return records
+  rescue Exception =>e
+    puts e
+   end
+  end
+
+def self.filter_records(module_name,max_num=20,offset=0,fields=nil,filter) #filter records with conditions { $starts,$contains ,$lt etc..}
+
+
+ begin
+  if get_refreshtoken()==nil
+    connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+  end
+  raise " Add filter conditions" unless filter.class==Hash
+ 
+  @filter2=""
+  @filter1=""
+  filter.each do |k,v|
+  if v.class == Hash
+     v.each do |key,value|
+     @filter1 = "&filter"+"#{[0]}"+"[#{k}]"+"[#{key}]"+"="+"#{value}" + @filter1
+  end
+    else
+     @filter2 = "&filter"+"#{[0]}"+"[#{k}]"+"="+"#{v}" + @filter2
+    end
+  end
+  @filter = @filter1 + @filter2
+
+  if fields!=nil 
+    if fields.kind_of?(Array)
+      @field=fields.join(",")
+ 
+    else
+      @field=fields
+    end   
+  end
+  uri = URI.parse($url)
+  url = "https://"+uri.host+"/rest/v10/"+module_name+"?max_num=#{max_num}"+"#{@filter}"+"&offset=#{offset}"+"&fields=#{@field}"
+  response = execute_uri(url)
+  raise "Module not found" unless response.is_a? Net::HTTPSuccess
+  resp= JSON.parse response.body
+  records= resp["records"]
+
+  raise "No records found!" if records.empty?
+    return records 
+  rescue Exception =>e
+  puts e
+    end
+  end 
+
+def self.fetch_related(module_name,id,fields=nil,link_name) # fetches related module fields
+   begin
+  if get_refreshtoken()==nil
+     connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+   end
+  uri = URI.parse($url)
+  if fields.kind_of?(Array)
+     @field=fields.join(",")
+
+   else
+     @field=fields
+   end   
+  url = "https://"+uri.host+"/rest/v10/#{module_name}/#{id}/link/#{link_name}"+"&fields=#{@field}"
+  response = execute_uri(url)
+  raise "Module  or record id not found" unless response.is_a? Net::HTTPSuccess
+  resp = JSON.parse response.body
+  records = resp["records"]
+  raise "No records found!" if records.empty?
+  return records
+  rescue Exception =>e
+  puts e
+    end
+  end
+
+def self.create_related(module_name,id,record,link_name) # Creates a single record and relate it to this module
+  begin
+  if get_refreshtoken()==nil
+     connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+  end
+  uri = URI.parse($url)
+  url = "https://"+uri.host+"/rest/v10/#{module_name}/#{id}/link/#{link_name}"
+  response = execute_postreq(url,record)
+  raise "Module  or record id not found" unless response.is_a? Net::HTTPSuccess
+  resp = JSON.parse response.body
+  id = resp["id"]
+  return id
+   rescue =>e
+    puts e
+   end
+  end
+
+ 
+def self.download_document(doc_id,path) #downloads a document via document module
+  begin
+  if get_refreshtoken()==nil
+    connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+  end
+  uri= URI.parse($url)
+  rec = fetch_single_record("Documents",doc_id)
+  doc_rev_id =  rec['document_revision_id']
+  file_name = rec['document_name']
+  url = "https://"+uri.host+"/rest/v10/DocumentRevisions/#{doc_rev_id}/file/filename"  
+  response = execute_uri(url)
+  raise "Document id not found" unless response.is_a? Net::HTTPSuccess
+  file_contents = response.body
+  file_contents.force_encoding(Encoding::ISO_8859_1).encode(Encoding::UTF_8)
+  file = path + file_name 
+  IO.binwrite file,file_contents
+  rescue =>e
+  puts e
+
+  end
+ end
+
+
+def self.upload_document(hash_options) #uploads a file to Documents module 
+  begin
+  if get_refreshtoken()==nil
+     connect($url,$consumer_key,$consumer_secret,$username,$password,$platform)
+  end
+  uri = URI.parse($url)
+  
+  revision =revision.to_i  
+  request_opt = JSON.generate(hash_options)
+  res = RestClient.post 'https://'+uri.host+'/rest/v10/Documents', request_opt, :content_type => 'application/json', :'OAuth-Token' => $token['access_token'], :'Cache-Control'  => 'no-cache', :use_ssl => true, :verify_mode => OpenSSL::SSL::VERIFY_NONE
+  root = JSON.parse res.body 
+  @id = root['id']
+  document_id = @id
+  path=hash_options["name"]
+  response = RestClient.post "https://"+ uri.host+"/rest/v10/Documents/#{document_id}/file/filename", :filename => File.new(path, 'rb'), 
+  :format => 'sugar-html-json',
+  :'OAuth-Token' => $token['access_token'],
+  :'Cache-Control' => 'no-cache',
+  :use_ssl => true, 
+  :verify_mode => OpenSSL::SSL::VERIFY_NONE
+
+  return document_id
+  rescue Exception =>e
+   puts "Couldn't upload the file"
+  end
+ end
+
+end
+end
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: sugarcrm_v10
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pournamithayyil
+- Ashique Shereef
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- pournami1707@gmail.com
+- ashiqshereef96@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sugarcrm_v10.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Interacts with Sugarcrm via REST v10 api
+test_files: []