sugarcrm 0.5.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Carl Hicks
+
+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.rdoc

@@ -0,0 +1,62 @@
+= SugarCRM
+
+* http://github.com/chicks/sugarcrm
+
+REST Bindings for SugarCRM!  
+
+== SUMMARY: 
+
+Ruby Gem for interacting with SugarCRM via REST
+
+== FEATURES/PROBLEMS:
+
+* The response hash gets converted into a Ruby object, via Hash#to_obj method.
+* Only the following methods are currently implemented:
+
+  * get_entry
+  * get_entries
+  * get_entry_list
+  * get_module_fields
+  * get_relationships
+
+== SYNOPSIS:
+
+  require 'sugarcrm'
+  sugarcrm = SugarCRM::Base.new("http://localhost/sugarcrm", 'user', 'password', {:debug => false})
+
+  # Lookup a user by name.  Find any associated accounts
+  sugarcrm.get_entry_list(
+    "Users",
+    "users.user_name = \'#{USER}\'",
+    {
+      :fields => ["first_name", "last_name"],
+      :link_fields => [
+        {
+          "name"  => "accounts",
+          "value" => ["id", "name"]
+        }
+      ]          
+    } 
+  )
+
+== REQUIREMENTS:
+
+* json gem
+
+== INSTALL:
+
+* sudo gem install sugarcrm
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Carl Hicks. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sugarcrm"
+    gem.summary = %Q{Ruby based REST client for SugarCRM}
+    gem.description = %Q{A Ruby based REST client for SugarCRM.}
+    gem.email = "carl.hicks@gmail.com"
+    gem.homepage = "http://github.com/chicks/sugarcrm"
+    gem.authors = ["Carl Hicks"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_dependency "json", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sugarcrm #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.1

data/lib/net/http_digest_auth.rb

@@ -0,0 +1,44 @@
+# net_http_digest_auth.rb
+require 'digest/md5'
+require 'net/http'
+
+module Net
+  module HTTPHeader
+    @@nonce_count = -1
+    CNONCE = Digest::MD5.new.update("%x" % (Time.now.to_i + rand(65535))).hexdigest
+    def digest_auth(user, password, response)
+      # based on http://segment7.net/projects/ruby/snippets/digest_auth.rb
+      @@nonce_count += 1
+
+      response['www-authenticate'] =~ /^(\w+) (.*)/
+
+      params = {}
+      $2.gsub(/(\w+)="(.*?)"/) { params[$1] = $2 }
+
+      a_1 = "#{user}:#{params['realm']}:#{password}"
+      a_2 = "#{@method}:#{@path}"
+      request_digest = ''
+      request_digest << Digest::MD5.new.update(a_1).hexdigest
+      request_digest << ':' << params['nonce']
+      request_digest << ':' << ('%08x' % @@nonce_count)
+      request_digest << ':' << CNONCE
+      request_digest << ':' << params['qop']
+      request_digest << ':' << Digest::MD5.new.update(a_2).hexdigest
+
+      header = []
+      header << "Digest username=\"#{user}\""
+      header << "realm=\"#{params['realm']}\""
+      
+      header << "qop=#{params['qop']}"
+
+      header << "algorithm=MD5"
+      header << "uri=\"#{@path}\""
+      header << "nonce=\"#{params['nonce']}\""
+      header << "nc=#{'%08x' % @@nonce_count}"
+      header << "cnonce=\"#{CNONCE}\""
+      header << "response=\"#{Digest::MD5.new.update(request_digest).hexdigest}\""
+
+      @header['Authorization'] = header
+    end
+  end
+end

data/lib/stdlib/array.rb

@@ -0,0 +1,14 @@
+# A fancy way of iterating over an array and converting hashes to objects
+class Array
+  def to_obj
+    # Make a deep copy of the array
+    a = Marshal.load(Marshal.dump(self))
+    a.each do |i|
+      case i.class.to_s
+        when "Hash" then i = i.to_obj
+        when "Array" then i = i.to_obj
+      end
+    end
+    a
+  end
+end

data/lib/stdlib/hash.rb

@@ -0,0 +1,17 @@
+# A fancy way of iterating over a hash and converting hashes to objects
+class Hash
+  def to_obj
+    o = Object.new
+    self.each do |k,v|
+      # If we're looking at a hash or array, we need to look through them and convert any hashes to objects as well
+      case v.class.to_s
+        when "Hash"  then v = v.to_obj
+        when "Array" then v = v.to_obj
+      end
+      o.instance_variable_set("@#{k}", v)  ## create and initialize an instance variable for this key/value pair
+      o.class.send(:define_method, k, proc{o.instance_variable_get("@#{k}")})  ## create the getter that returns the instance variable
+      o.class.send(:define_method, "#{k}=", proc{|v| o.instance_variable_set("@#{k}", v)})  ## create the setter that sets the instance variable
+    end
+    o
+  end
+end

data/lib/stdlib/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def to_obj
+    self
+  end
+end

data/lib/sugarcrm.rb

@@ -0,0 +1,141 @@
+#! /usr/bin/env ruby
+
+module SugarCRM
+
+Dir["#{File.dirname(__FILE__)}/sugarcrm/**/*.rb"].each { |f| load(f) }
+Dir["#{File.dirname(__FILE__)}/stdlib/**/*.rb"].each { |f| load(f) }
+
+require 'pp'
+require 'ostruct'
+require 'uri'
+require 'net/https'
+require 'openssl'
+require 'digest/md5'
+
+require 'rubygems'
+require 'json'
+
+class LoginError < RuntimeError
+end
+
+class EmptyResponse < RuntimeError
+end
+
+class UnhandledResponse < RuntimeError
+end
+
+class InvalidSugarCRMUrl < RuntimeError
+end
+
+class Base 
+
+  URL = "/service/v2/rest.php"
+  attr :url, true
+  attr :user, false
+  attr :pass, false
+  attr :ssl, false
+  attr :connection, true
+  attr :session, true
+  attr :debug, true
+
+  def initialize(url, user, pass, options={})
+    {:debug => false}.merge! options
+
+    @user = user
+    @pass = pass
+    @url  = URI.parse(url)
+    @debug = options[:debug]
+
+    # Handles http/https in url string
+    @ssl  = false
+    @ssl  = true if @url.scheme == "https"
+
+    # Appends the rest.php path onto the end of the URL if it's not included
+    if @url.path !~ /rest.php$/
+      @url.path += URL
+    end
+      
+    login!
+    raise LoginError, "Invalid Login" unless logged_in?
+  end
+
+  def connected?
+    return false unless @connection
+    return false unless @connection.started?
+    true
+  end
+
+  def logged_in?
+    @session ? true : false
+  end
+
+
+  protected
+
+    def connect!
+      @connection = Net::HTTP.new(@url.host, @url.port)
+      if @ssl
+        @connection.use_ssl = true
+        @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      @connection.start
+    end
+
+    def login!
+      connect! unless connected?
+      json = <<-EOF
+        {
+          \"user_auth\": {
+            \"user_name\": \"#{@user}\"\,
+            \"password\": \"#{OpenSSL::Digest::MD5.new(@pass)}\"\,
+            \"version\": \"2\"\,
+          },
+          \"application\": \"\"
+        }
+      EOF
+      json.gsub!(/^\s{8}/,'')
+      response = get(:login, json)
+      @session = response.id
+    end
+
+    def get(method,json)
+      query =  @url.path.dup
+      query << '?method=' << method.to_s
+      query << '&input_type=JSON'
+      query << '&response_type=JSON'
+      query << '&rest_data=' << json
+
+      if @debug 
+        puts "#{method}: Request"
+        puts query
+        puts "\n"
+      end
+      response = @connection.get(URI.escape(query))
+
+      case response
+        when Net::HTTPOK 
+          raise EmptyResponse unless response.body
+          response_json = JSON.parse response.body
+          return false if response_json["result_count"] == 0
+          if @debug 
+            puts "#{method}: JSON Response:"
+            pp response_json
+            puts "\n"
+          end
+          response_obj = response_json.to_obj
+          return response_obj
+        when Net::HTTPNotFound
+          raise InvalidSugarCRMUrl, "#{@url} is invalid"
+        else
+          if @debug 
+            puts "#{method}: Raw Response:"
+            puts response.body
+            puts "\n"
+          end
+          raise UnhandledResponse, "Can't handle response #{response}"
+      end
+    end
+
+end
+
+end

data/lib/sugarcrm/get_entries.rb

@@ -0,0 +1,23 @@
+module SugarCRM; class Base
+# Retrieve a list of SugarBeans by ID.  This method will not 
+# work with the report module.
+def get_entries(module_name, ids, options={})
+  login! unless logged_in?
+  {
+    :fields => '', 
+    :link_fields => [], 
+  }.merge! options
+
+  json = <<-EOF
+    {
+      \"session\": \"#{@session}\"\,
+      \"module_name\": \"#{module_name}\"\,
+      \"ids\": \"#{ids.to_json}\"\,
+      \"select_fields\": #{options[:fields].to_json}\,
+      \"link_name_to_fields_array\": #{options[:link_fields].to_json}\,
+    }
+  EOF
+  json.gsub!(/^\s{6}/,'')
+  get(:get_entries, json)
+end
+end; end

data/lib/sugarcrm/get_entry.rb

@@ -0,0 +1,25 @@
+module SugarCRM; class Base
+  def get_entry(module_name, id, options={})
+    login! unless logged_in?
+    { :fields => [], 
+      :link_fields => [], 
+    }.merge! options
+
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"module_name\": \"#{module_name}\"\,
+        \"id\": \"#{id}\"\,
+        \"select_fields\": #{options[:fields].to_json}\,
+      }
+    EOF
+    
+    placeholder = <<-EOF
+        \"select_fields\": [\"name\"]
+        \"link_name_to_fields_array\": \"#{options[:link_fields]}\"\,
+    EOF
+    
+    json.gsub!(/^\s{6}/,'')
+    get(:get_entry, json)
+  end
+end; end

data/lib/sugarcrm/get_entry_list.rb

@@ -0,0 +1,31 @@
+module SugarCRM; class Base
+# Retrieve a list of SugarBeans.  This is the primary method for getting 
+# a list of SugarBeans using the REST API.
+def get_entry_list(module_name, query, options={})
+  login! unless logged_in?
+  {
+    :order_by => '', 
+    :offset => '', 
+    :fields => '', 
+    :link_fields => [], 
+    :max_results => '', 
+    :deleted => ''
+  }.merge! options
+
+  json = <<-EOF
+    {
+      \"session\": \"#{@session}\"\,
+      \"module_name\": \"#{module_name}\"\,
+      \"query\": \"#{query}\"\,
+      \"order_by\": \"#{options[:order_by]}\"\,
+      \"offset\": \"#{options[:offset]}\"\,
+      \"select_fields\": #{options[:fields].to_json}\,
+      \"link_name_to_fields_array\": #{options[:link_fields].to_json}\,
+      \"max_results\": \"#{options[:max_results]}\"\,
+      \"deleted\": #{options[:deleted]}
+    }
+  EOF
+  json.gsub!(/^\s{6}/,'')
+  get(:get_entry_list, json)
+end
+end; end

data/lib/sugarcrm/get_module_fields.rb

@@ -0,0 +1,15 @@
+module SugarCRM; class Base
+  
+def get_module_fields(module_name)
+  login! unless logged_in?
+  json = <<-"EOF"
+    {
+      \"session\": \"#{@session}\"\,
+      \"module_name": \"#{module_name}"
+    }
+  EOF
+  json.gsub!(/^\s{6}/,'')
+  get(:get_module_fields, json)
+end
+
+end; end

data/lib/sugarcrm/get_relationships.rb

@@ -0,0 +1,20 @@
+module SugarCRM; class Base
+# A standard REST call to get a list of relationships
+def get_relationships(module_name, id, related_to, options={})
+  login! unless logged_in?
+  json = <<-EOF
+    {
+      \"session\": \"#{@session}\"\,
+      \"module_name\": \"#{module_name}\"\,
+      \"module_ids\": \"#{id}\"\,
+      \"link_field_name\": \"#{related_to.downcase}\"\,
+      \"related_module_query\": \"#{options[:related_module_query]}\"\,
+      \"related_fields\": #{options[:related_fields].to_json}\,
+      \"related_module_link_name_to_fields_array\": #{options[:related_link_fields].to_json}\,
+      \"deleted\": #{options[:deleted]}
+    }
+  EOF
+  json.gsub!(/^\s{6}/,'')
+  get(:get_relationships, json)
+end
+end; end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sugarcrm'
+
+class Test::Unit::TestCase
+end

data/test/test_json_to_obj.rb

@@ -0,0 +1,48 @@
+require 'helper'
+
+class TestJson2Object < Test::Unit::TestCase
+  def test_object
+    json = {"string" => "value"}.to_json
+    obj  = JSON.parse(json).to_obj
+    assert_equal("value", obj.string)
+  end
+  
+  def test_nested_object
+    json = {"dogs" => {"retriever" => "sparky", "basset" => "jennie", "pinscher" => "carver"}}.to_json
+    obj  = JSON.parse(json).to_obj
+    assert_equal("sparky", obj.dogs.retriever)
+  end
+  
+  def test_array_of_objects
+    json = [{"retriever" => "sparky"}, {"basset" => "jennie"}, {"pinscher" => "carver"}].to_json
+    obj  = JSON.parse(json).to_obj
+    assert_equal("sparky", obj[0].retriever)
+  end
+  
+  def test_deep_nest_mixed
+    json = {"kennels" => [
+            {"dallas" => [
+             {"name" => "north"},
+             {"name"  => "east"},
+            ]},
+            {"frisco" => [
+             {"name" => "south"},
+             {"name"  => "west"}
+            ],
+            "company" => "Doggie Daze"
+            }
+          ]}.to_json
+    obj  = JSON.parse(json).to_obj
+    assert_equal("west", obj.kennels[1].frisco[0].name)
+  end
+  
+  def test_deep_nest_hash
+    json = {"kennels" => {
+            "kennel" => {
+            "dallas" => ["north", "south"],
+            "frisco" => ["east", "west"]}}
+           }.to_json
+    obj  = JSON.parse(json).to_obj
+    assert_equal("north", obj.kennels.kennel.dallas[0])
+  end
+end

data/test/test_sugarcrm.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+# Replace these with your test instance
+URL   = "http://valet/sugarcrm"
+USER  = "admin"
+PASS  = 'letmein' 
+
+class TestSugarcrm < Test::Unit::TestCase
+  context "A SugarCRM::Base instance" do
+    setup do
+      @sugarcrm = SugarCRM::Base.new(URL, USER, PASS, {:debug => true})
+    end
+    
+    should "return a single entry when sent #get_entry." do
+      response = @sugarcrm.get_entry(
+        "Users",
+        1,
+        {:fields => ["first_name", "last_name"]} 
+      )
+      assert_respond_to 'response', :entry_list
+    end
+    
+    should "return a list of entries when sent #get_entries." do
+      response = @sugarcrm.get_entries(
+        "Users",
+        [1],
+        {:fields => ["first_name", "last_name"]} 
+      )
+      assert_respond_to 'response', :entry_list
+    end
+    
+    should "return a list of entries when sent #get_entry_list." do
+      response = @sugarcrm.get_entry_list(
+        "Users",
+        "users.user_name = \'#{USER}\'",
+        {
+          :fields => ["first_name", "last_name"],
+          :link_fields => [
+            {
+              "name"  => "accounts",
+              "value" => ["id", "name"]
+            }
+          ]          
+        } 
+      )
+      assert_respond_to 'response', :entry_list
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: sugarcrm
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
+platform: ruby
+authors: 
+- Carl Hicks
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A Ruby based REST client for SugarCRM.
+email: carl.hicks@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/net/http_digest_auth.rb
+- lib/stdlib/array.rb
+- lib/stdlib/hash.rb
+- lib/stdlib/object.rb
+- lib/sugarcrm.rb
+- lib/sugarcrm/get_entries.rb
+- lib/sugarcrm/get_entry.rb
+- lib/sugarcrm/get_entry_list.rb
+- lib/sugarcrm/get_module_fields.rb
+- lib/sugarcrm/get_relationships.rb
+- test/helper.rb
+- test/test_json_to_obj.rb
+- test/test_sugarcrm.rb
+has_rdoc: true
+homepage: http://github.com/chicks/sugarcrm
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby based REST client for SugarCRM
+test_files: 
+- test/helper.rb
+- test/test_json_to_obj.rb
+- test/test_sugarcrm.rb