sob-has_force 1.0 → 1.0.1

data/CHANGELOG.rdoc

@@ -1,2 +1,7 @@
+== 1.0.1, Released 2009-02-10
+* to_salesforce now returns true automatically if RAILS_ENV == 'test' [sob]
+* added missing documentation to has_force methods [sob]
+* added the option to include fields with the form submission (include_fields) [sob]
+
 == 1.0.0, Released 2009-01-26
 * Initial release

data/lib/force/has_force.rb

@@ -8,26 +8,50 @@ module Force
   end
   
   module ClassMethods
+    # This method includes the Force class and instance methods, allowing a
+    # model to be submitted to SalesForce.com through the Web2Lead tool.
+    #
+    # === Supported Options
+    #
+    # [:skip_fields]
+    #   Specify attributes (as symbols) to remove before sending to salesforce.com
+    # [:transform_fields]
+    #   Specify key,value pairs consisting of old_field => new_field to rename fields before sending to salesforce.com (used for custom fields)
+    # [:oid]
+    #   Your organizations SalesForce.com OID
+    # [:include_fields]
+    #   Additional fields to include with the submission to the Web2Lead gateway. Specified as key,value pairs
+    #
     def has_force(options = {})
       options = {
         :skip_fields => [ :id, :created_at, :created_by, :updated_at, :updated_by, :status ],
         :transform_fields => { },
-        :oid => ''
+        :oid => '',
+        :include_fields => { }
       }.merge(options)
       
       cattr_accessor :force_skip_fields
       cattr_accessor :force_transform_fields
       cattr_accessor :force_oid
+      cattr_accessor :force_include_fields
       
       self.force_skip_fields = options[:skip_fields]
       self.force_transform_fields = options[:transform_fields]
       self.force_oid = options[:oid]
+      self.force_include_fields = options[:include_fields]
       
       send :include, InstanceMethods
     end
   end
   
   module InstanceMethods
+    # This method submits the attributes of an object to SalesForce.com using
+    # the Web2Lead gateway. It does not check for previous submissions so you
+    # should somewhere in your model before calling this function.
+    #
+    # Returns true on <tt>Net::HTTPSuccess</tt> or <tt>Net::HTTPRedirection</tt>
+    # otherwise returns false
+    #
     def to_salesforce
       url = URI.parse('https://www.salesforce.com/servlet/servlet.WebToLead?encoding=UTF-8')
       http = Net::HTTP.new(url.host, url.port)
@@ -36,7 +60,12 @@ module Force
       request = Net::HTTP::Post.new(url.path)
       attribs = (self.attributes - self.class.force_skip_fields.stringify).stringify_values!
       attribs.transform_keys!(self.class.force_transform_fields)
+      attribs = attribs.merge(self.class.force_include_fields)
       request.set_form_data(attribs.merge({:oid => self.class.force_oid}))
+      
+      # always return true in the test environment
+      # prevents massive spam from SalesForce during tests
+      return true if RAILS_ENV == 'test'
       begin
         response = http.request(request)
         case response

data/lib/force.rb

@@ -1,3 +1,3 @@
-require 'force/has_force'
 require 'force/core_ext/array'
-require 'force/core_ext/hash'
+require 'force/core_ext/hash'
+require 'force/has_force'

data/test/has_force_test.rb

@@ -16,6 +16,11 @@ class HasForceTest < Test::Unit::TestCase
     assert_equal('123', Lead.force_oid)
   end
   
+  def test_lead_class_sets_force_include_fields
+    assert_not_nil(Lead.force_include_fields)
+    assert_equal({}, Lead.force_include_fields)
+  end
+  
   def test_lead_class_sets_force_skip_fields
     assert_not_nil(Lead.force_skip_fields)
     assert_equal([:id, :created_at, :created_by, :updated_at, :updated_by, :status], Lead.force_skip_fields)

data/test/test_helper.rb

@@ -2,7 +2,12 @@ ENV['RAILS_ENV'] = 'test'
 ENV['RAILS_ROOT'] ||= File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', '..'))
 
 require 'test/unit'
-require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config', 'environment.rb'))
+if (File.exists?(File.expand_path(File.join(ENV['RAILS_ROOT'], 'config', 'environment.rb'))))
+  require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config', 'environment.rb'))
+else
+  require 'rubygems'
+  require 'activerecord'
+end
 
 def load_schema
   config = YAML::load(IO.read(File.expand_path(File.join(File.dirname(__FILE__), 'database.yml'))))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sob-has_force
 version: !ruby/object:Gem::Version 
-  version: "1.0"
+  version: 1.0.1
 platform: ruby
 authors: 
 - Sean O'Brien
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-26 00:00:00 -08:00
+date: 2009-02-10 00:00:00 -08:00
 default_executable: 
 dependencies: []