sugarcrm 0.9.11 → 0.9.12

data/README.rdoc

@@ -140,6 +140,17 @@ A less clunky way to interact with SugarCRM via REST.
     } 
   )
 
+== USING THE GEM WITH RAILS 3
+
+Note: this gem requires Rails 3 as it depends on Active Support >= 3.
+
+1. Add the sugarcrm gem to your Gemfile (sugarcrm gem version >= 0.9.12)
+2. Run `bundle install`
+4. Run `rails g sugarcrm:config`
+5. Edit the configuration file in `config/sugarcrm.yml` to match your environment
+
+Example app here: https://github.com/davidsulc/sugar_on_rails_basic
+
 == USING A CONFIGURATION FILE
 
 If you want to use a configuration file instead of always specifying the url, username, and password to connect to SugarCRM, you can add your credentials to one (or more) of

data/Rakefile

@@ -18,6 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/chicks/sugarcrm"
   gem.authors = ["Carl Hicks", "David Sulc"]
   gem.executables = ['sugarcrm']
+  gem.files = FileList['./lib/**/*', './*'].exclude("*.lock").to_a
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.9.11
+0.9.12

data/lib/rails/generators/sugarcrm/config/config_generator.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Sugarcrm
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc 'Creates a SugarCRM gem configuration file at config/sugarcrm.yml, and an initializer at config/initializers/sugarcrm.rb'
+
+      def self.source_root
+        @_sugarcrm_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def create_config_file
+        template 'sugarcrm.yml', File.join('config', 'sugarcrm.yml')
+      end
+
+      def create_initializer_file
+        template 'initializer.rb', File.join('config', 'initializers', 'sugarcrm.rb')
+      end
+    end
+  end
+end
+

data/lib/rails/generators/sugarcrm/config/templates/initializer.rb

@@ -0,0 +1,4 @@
+# Load the values in config/sugarcrm.yml into a hash
+config_values = SugarCRM::Session.parse_config_file(File.join(Rails.root, 'config', 'sugarcrm.yml'))
+# Connect to appropriate SugarCRM instance (depending on Rails environment)
+SugarCRM::Session.from_hash(config_values[Rails.env.to_sym])

data/lib/rails/generators/sugarcrm/config/templates/sugarcrm.yml

@@ -0,0 +1,19 @@
+development:
+  base_url: http://127.0.0.1/sugarcrm # where your SugarCRM instance is located
+  username: admin
+  password: letmein
+  # connection pool settings
+  # if you don't know what purpose this serves, you can safely ignore these settings
+  # works similarly to Rails' database connection pooling (documented here: http://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/ConnectionPool.html)
+#   pool: 3 # the maximum number of simulatenous connections the gem should open with the SugarCRM server (default is 5)
+#   wait_timeout: 7 # maximum time to wait for an available connection to SugarCRM server, in seconds (default is 5)
+
+test:
+  base_url: http://127.0.0.1/sugarcrm
+  username: admin
+  password: letmein
+
+production:
+  base_url: http://127.0.0.1/sugarcrm
+  username: admin
+  password: letmein

data/lib/sugarcrm.rb

@@ -10,6 +10,7 @@ require 'json'
 
 require 'sugarcrm/session'
 require 'sugarcrm/module_methods'
+require 'sugarcrm/connection_pool'
 require 'sugarcrm/connection'
 require 'sugarcrm/exceptions'
 require 'sugarcrm/finders'

data/lib/sugarcrm/associations/association_collection.rb

@@ -81,6 +81,13 @@ module SugarCRM
       @collection.send(method_name.to_sym, *args, &block)
     end
     
+    # respond correctly for delegated methods
+    def respond_to?(method_name)
+      load
+      return true if @collection.respond_to? method_name
+      super
+    end
+    
     def save
       begin
         save!

data/lib/sugarcrm/associations/associations.rb

@@ -52,5 +52,10 @@ module SugarCRM
       @associations.send(method_name.to_sym, *args, &block)
     end
     
+    # respond correctly for delegated methods
+    def respond_to?(method_name)
+      return true if @associations.respond_to? method_name
+      super
+    end
   end
 end

data/lib/sugarcrm/attributes/attribute_methods.rb

@@ -54,6 +54,10 @@ module SugarCRM; module AttributeMethods
     false
   end
   
+  def destroyed?
+    @attributes[:deleted]
+  end
+  
   def attributes_changed?
     @modified_attributes.length > 0
   end
@@ -62,11 +66,17 @@ module SugarCRM; module AttributeMethods
   def new?
     @attributes[:id].blank?
   end
+  alias :new_record? :new?
   
   # List the required attributes for save
   def required_attributes
     self.class._module.required_fields
   end
+  alias :required_fields :required_attributes
+  
+  def to_model
+    self
+  end
 
   protected
   
@@ -99,6 +109,9 @@ module SugarCRM; module AttributeMethods
       def #{k}=(value)
         write_attribute :#{k},value
       end
+      def #{k}\?
+        has_attribute\? :#{k}
+      end
       ?
     end
     self.class.attribute_methods_generated = true
@@ -158,5 +171,9 @@ module SugarCRM; module AttributeMethods
     @attributes[key] = value
   end
   
+  def has_attribute?(key)
+    @attributes.has_key? key
+  end
+  
 end; end
   

data/lib/sugarcrm/base.rb

@@ -154,7 +154,7 @@ module SugarCRM; class Base
     params          = {}
     params[:id]     = serialize_id
     params[:deleted]= {:name => "deleted", :value => "1"}
-    (self.class.connection.set_entry(self.class._module.name, params).class == Hash)       
+    @attributes[:deleted] = (self.class.connection.set_entry(self.class._module.name, params).class == Hash)
   end
   
   # Reloads the record from SugarCRM

data/lib/sugarcrm/connection/api/get_available_modules.rb

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}"
+        "session": "#{@sugar_session_id}"
       }
     EOF
     

data/lib/sugarcrm/connection/api/get_document_revision.rb

@@ -4,8 +4,8 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}",
-        "id": #{id}
+        "session": "#{@sugar_session_id}",
+        "id": "#{id}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')

data/lib/sugarcrm/connection/api/get_entries.rb

@@ -10,7 +10,7 @@ module SugarCRM; class Connection
 
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "module_name": "#{module_name}",
         "ids": #{ids.to_json},
         "select_fields": #{resolve_fields(module_name, options[:fields])},

data/lib/sugarcrm/connection/api/get_entries_count.rb

@@ -8,7 +8,7 @@ module SugarCRM; class Connection
 
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "module_name": "#{module_name}",
         "query": "#{query}",
         "deleted": #{options[:deleted]}

data/lib/sugarcrm/connection/api/get_entry.rb

@@ -9,7 +9,7 @@ module SugarCRM; class Connection
     
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "module_name": "#{module_name}",
         "id": "#{id}",
         "select_fields": #{resolve_fields(module_name, options[:fields])},

data/lib/sugarcrm/connection/api/get_entry_list.rb

@@ -14,7 +14,7 @@ module SugarCRM; class Connection
 
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "module_name": "#{module_name}",
         "query": "#{query}",
         "order_by": "#{options[:order_by]}",

data/lib/sugarcrm/connection/api/get_module_fields.rb

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?  
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "module_name": "#{module_name}"
       }
     EOF

data/lib/sugarcrm/connection/api/get_note_attachment.rb

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "id": "#{id}"
       }
     EOF

data/lib/sugarcrm/connection/api/get_relationships.rb

@@ -8,12 +8,12 @@ module SugarCRM; class Connection
       :query => '',
       :fields => [], 
       :link_fields => [], 
-      :deleted => ''
+      :deleted => 0
     }.merge! opts  
 
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "module_name": "#{module_name}",
         "module_id": "#{id}",
         "link_field_name": "#{related_to.downcase}",

data/lib/sugarcrm/connection/api/get_report_entries.rb

@@ -6,7 +6,7 @@ module SugarCRM; class Connection
 
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "ids": #{ids.to_json},
         "select_fields": "#{options[:select_fields].to_json}"
       }

data/lib/sugarcrm/connection/api/get_user_id.rb

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}"
+        "session": "#{@sugar_session_id}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')

data/lib/sugarcrm/connection/api/get_user_team_id.rb

@@ -5,7 +5,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}"
+        "session": "#{@sugar_session_id}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')

data/lib/sugarcrm/connection/api/logout.rb

@@ -5,7 +5,7 @@ module SugarCRM; class Connection
     json = <<-EOF
       {
         "user_auth": {
-          "session": "#{@session.id}"
+          "session": "#{@sugar_session_id}"
         }
       }
     EOF

data/lib/sugarcrm/connection/api/seamless_login.rb

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}"
+        "session": "#{@sugar_session_id}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')

data/lib/sugarcrm/connection/api/search_by_module.rb

@@ -12,7 +12,7 @@ module SugarCRM; class Connection
     
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "search_string": "#{search_string}",
         "modules": "#{modules}",
         "offset": #{options[:offset]},

data/lib/sugarcrm/connection/api/set_campaign_merge.rb

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "targets": #{targets.to_json},
         "campaign-id": "#{campaign_id}"
       }

data/lib/sugarcrm/connection/api/set_document_revision.rb

@@ -1,12 +1,26 @@
 module SugarCRM; class Connection
   # Sets a new revision for a document.
-  def set_document_revision(id, revision)
+  def set_document_revision(document_id, revision_number, opts={})
+    options = { 
+      :file => '', 
+      :file_name => '' 
+    }.merge! opts
+    
+    # Raise an exception of we try to pass :file, but not :file_name
+    if (!options[:file].empty? && options[:file_name].empty?)
+      raise ArgumentException, ":file_name must be specified if :file is specified"
+    end
+    
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}",
-        "document_revision": "#{revision}",
-        "id": #{id}
+        "session": "#{@sugar_session_id}",
+        "document_revision": {
+           "id": "#{document_id}",
+           "filename": "#{options[:file_name]}",
+           "file": "#{Base64.encode64(options[:file])}",
+           "revision": "#{revision_number}"
+        }
       }
     EOF
     json.gsub!(/^\s{6}/,'')

data/lib/sugarcrm/connection/api/set_entries.rb

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "module_name": "#{module_name}",
         "name_value_list": #{name_value_lists.to_json}
       }

data/lib/sugarcrm/connection/api/set_entry.rb

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "module_name": "#{module_name}",
         "name_value_list": #{name_value_list.to_json}
       }

data/lib/sugarcrm/connection/api/set_note_attachment.rb

@@ -9,7 +9,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
            "note": {
               "id": "#{id}",
               "filename": "#{filename}",

data/lib/sugarcrm/connection/api/set_relationship.rb

@@ -9,7 +9,7 @@ module SugarCRM; class Connection
     raise ArgumentError, "related_ids must be an Array" unless related_ids.class == Array
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "module_name": "#{module_name}",
         "module_id": "#{module_id}",
         "link_field_name": "#{link_field_name}",

data/lib/sugarcrm/connection/api/set_relationships.rb

@@ -9,7 +9,7 @@ module SugarCRM; class Connection
     
     json = <<-EOF
       {
-        "session": "#{@session.id}",
+        "session": "#{@sugar_session_id}",
         "module_names": "#{module_names.to_json}",
         "module_ids": #{module_ids.to_json},
         "link_field_names": #{link_field_names.to_json},

data/lib/sugarcrm/connection/connection.rb

@@ -8,8 +8,8 @@ module SugarCRM; class Connection
   attr :url, true
   attr :user, false
   attr :pass, false
-  attr :session_id, true
-  attr_accessor :session
+  attr :session, true
+  attr :sugar_session_id, true
   attr :connection, true
   attr :options, true
   attr :request, true
@@ -29,21 +29,25 @@ module SugarCRM; class Connection
     @response = ""
     resolve_url
     login!
-    @session.update_config({:base_url => url, :username => user, :password => pass}) if @session
     self
   end
   
   # Check to see if we are logged in
   def logged_in?
     connect! unless connected?
-    @session_id ? true : false
+    @sugar_session_id ? true : false
   end
   
   # Login
   def login!
-    @session_id = login["id"]
+    @sugar_session_id = login["id"]
     raise SugarCRM::LoginError, "Invalid Login" unless logged_in?
   end
+  
+  def logout
+    logout
+    @sugar_session_id = nil
+  end
 
   # Check to see if we are connected
   def connected?