asf-soap-adapter 1.1.0 → 1.3.0

data/LICENSE

@@ -1,20 +1,25 @@
-Copyright (c) 2009 Raymond Gao
-
-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.
+Copyright (c) 2010, Salesforce.com
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this 
+  list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, 
+  this list of conditions and the following disclaimer in the documentation 
+  and/or other materials provided with the distribution.
+* Neither the name of Salesforce.com nor the names of its contributors may be 
+  used to endorse or promote products derived from this software without 
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -12,14 +12,9 @@ begin
     gem.authors = ["Doug Chasman","Luigi Montanez","Senthil Nayagam","Justin Ball","Jesse Hallett", "Andrew Freeberg", "Blaine Schanfeldt", "Matte Edens", "Raymond Gao"]
 
     # Requiring RForce as an add-on gem, rather than hard-code the 0.4.0
-    # Using Ray Gao's version of Rforce, since the DEFAULT_BATCH_SIZE (rforce/binding.rb) has been expanded from 10 to 2000
-    # Furthermore, added 'oath' gem as a dependency, which is needed by 'Rforce' gem
-    #gem.add_dependency('rforce-raygao', '>=1.0')
-    gem.add_dependency('rforce', '>=0.6')
+    gem.add_dependency('rforce', '>=0.4.1')
     gem.add_dependency('builder', '>= 1.2.4')
     gem.add_dependency('hpricot', '>=0.8.2')
-    gem.add_dependency('facets', '=2.8.4')
-    gem.add_dependency('oauth', '=0.4.4')
 
     #gem.add_dependency('rails', '>= 2.3.3')
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.3.0

data/asf-soap-adapter.gemspec

@@ -5,26 +5,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{asf-soap-adapter}
-  s.version = "1.1.0"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Doug Chasman", "Luigi Montanez", "Senthil Nayagam", "Justin Ball", "Jesse Hallett", "Andrew Freeberg", "Blaine Schanfeldt", "Matte Edens", "Raymond Gao"]
-  s.date = %q{2011-01-19}
+  s.authors = ["Doug Chasman", "Luigi Montanez", "Senthil Nayagam", "Justin Ball", "Jesse Hallett", "Andrew Freeberg", "Blaine Schanfeldt", "Matte Edens", "Raymond Gao", "Quinton Wall"]
+  s.date = %q{2010-02-04}
   s.description = %q{ASF-Soap-Adapter is an improved version of ActiveSalesforce (ASF) is a Rails connection adapter that provides direct access to Salesforce.com hosted data and metadata via the ActiveRecord model layer. Objects, fields, and relationships are all auto surfaced as active record attributes and rels. It has been patched to V20 of the Web Services API and has support Chatter model.}
-  s.email = %q{raygao2000@yahoo.com}
+  s.email = %q{qwall@salesforce.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
   ]
   s.files = [
-    ".document",
-     ".gitignore",
      "LICENSE",
-     "README.rdoc",
      "Rakefile",
      "VERSION",
      "asf-soap-adapter.gemspec",
-     "asf-soap-adapter.pptx",
      "deploy",
      "lib/active_record/connection_adapters/activesalesforce.rb",
      "lib/active_record/connection_adapters/activesalesforce_adapter.rb",
@@ -280,24 +275,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rforce>, [">= 0.6"])
+      s.add_runtime_dependency(%q<rforcedotcom>, [">= 20.0.0"])
       s.add_runtime_dependency(%q<builder>, [">= 1.2.4"])
       s.add_runtime_dependency(%q<hpricot>, [">= 0.8.2"])
-      s.add_runtime_dependency(%q<facets>, ["= 2.8.4"])
-      s.add_runtime_dependency(%q<oauth>, ["= 0.4.4"])
     else
-      s.add_dependency(%q<rforce>, [">= 0.6"])
+      s.add_runtime_dependency(%q<rforcedotcom>, [">= 20.0.0"])
       s.add_dependency(%q<builder>, [">= 1.2.4"])
       s.add_dependency(%q<hpricot>, [">= 0.8.2"])
-      s.add_dependency(%q<facets>, ["= 2.8.4"])
-      s.add_dependency(%q<oauth>, ["= 0.4.4"])
     end
   else
-    s.add_dependency(%q<rforce>, [">= 0.6"])
+    s.add_runtime_dependency(%q<rforcedotcom>, [">= 20.0.0"])
     s.add_dependency(%q<builder>, [">= 1.2.4"])
     s.add_dependency(%q<hpricot>, [">= 0.8.2"])
-    s.add_dependency(%q<facets>, ["= 2.8.4"])
-    s.add_dependency(%q<oauth>, ["= 0.4.4"])
   end
 end
 

data/lib/active_record/connection_adapters/activesalesforce_adapter.rb

@@ -279,11 +279,8 @@ module ActiveRecord
           if commands.length >= MAX_BOXCAR_SIZE or (previous_command and (command.verb != previous_command.verb))
             send_commands(commands)
 
-            #Patch from Kostyl
-            commands = [command] # Otherwise command will be lost at all (every 200th command (MAX_BOXCAR_SIZE = 200))
-            previous_command = command
-            #commands = []
-            #previous_command = nil
+            commands = []
+            previous_command = nil
           else
             commands << command
             previous_command = command
@@ -864,7 +861,7 @@ module ActiveRecord
         # See if a table name to AR class mapping was registered
         klass = @class_to_entity_map[table_name.upcase]
 
-        entity_name = klass ? raw_table_name : table_name.camelize
+        entity_name = klass ? raw_table_name : (table_name =~ /__/ ? table_name : table_name.camelize)
         entity_def = get_entity_def(entity_name)
 
         [table_name, entity_def.columns, entity_def]
@@ -912,4 +909,4 @@ module ActiveRecord
     end
 
   end
-end
+end

data/test/asf-soap-adapter-rails-app/doc/README_FOR_APP

@@ -0,0 +1,2 @@
+Use this README file to introduce your application and point to useful places in the API for learning more.
+Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: asf-soap-adapter
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 27
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 3
   - 0
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Doug Chasman
@@ -19,26 +19,28 @@ authors:
 - Blaine Schanfeldt
 - Matte Edens
 - Raymond Gao
+- Quinton Wall
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-01-19 00:00:00 -06:00
+date: 2010-02-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rforce
+  name: rforcedotcom
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 191
         segments: 
+        - 20
+        - 0
         - 0
-        - 6
-        version: "0.6"
+        version: 20.0.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -73,56 +75,19 @@ dependencies:
         version: 0.8.2
   type: :runtime
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: facets
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 39
-        segments: 
-        - 2
-        - 8
-        - 4
-        version: 2.8.4
-  type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: oauth
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 4
-        - 4
-        version: 0.4.4
-  type: :runtime
-  version_requirements: *id005
 description: ASF-Soap-Adapter is an improved version of ActiveSalesforce (ASF) is a Rails connection adapter that provides direct access to Salesforce.com hosted data and metadata via the ActiveRecord model layer. Objects, fields, and relationships are all auto surfaced as active record attributes and rels. It has been patched to V20 of the Web Services API and has support Chatter model.
-email: raygao2000@yahoo.com
+email: qwall@salesforce.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
 files: 
-- .document
-- .gitignore
 - LICENSE
-- README.rdoc
 - Rakefile
 - VERSION
 - asf-soap-adapter.gemspec
-- asf-soap-adapter.pptx
 - deploy
 - lib/active_record/connection_adapters/activesalesforce.rb
 - lib/active_record/connection_adapters/activesalesforce_adapter.rb

data/.document

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

data/.gitignore

@@ -1,25 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-doc
-pkg
-.yardoc
-
-## PROJECT::SPECIFIC
-nbproject/*
-recorded_results/*

data/README.rdoc

@@ -1,125 +0,0 @@
-== Welcome to ActiveSalesforce SOAP Adapter (asf-soap-adapter)
-
-The "asf-soap-adapter" is based on the ActiveSalesforce-Adapter (link:classes/ActiveRecord/Base.html and link:classes/ActiveRecord/ConnectionAdapters/SalesforceAdapter.html). It has been updated to include new methods/APIs from the latest version of the Salesforce Web Services (SOAP-based) APIs. At the time of release, that API is at version 20. 
-Major features:
-1. Removed hardcoded version of v19, v18, etc in the code. Now, you just specify it in the 'database.yml' file with 'api_version'. By default it is at 20.0
-2. Adding RForce GEM as a prerequisite. By removing embedded RForce 0.4.0 files, we can now taken advantage of RForce 0.4.1 GEM, which is cleaner and addressed several problems with Hash. One thing to note: if you are using <em>RFORCE:MethodHash</em> class. It has been been replaced by <OpenHash> class. To use it, simply call <em>OpenHash.new({})</em> in place of MethodHash. Previously, there was a bug with the MethodHash class causing Id to be put into an array, e.g. FeedPost.Id[0], even though there was only one element. So, now it is FeedPost.Id.
-3. Adding several useful Salesforce convenience classes, which is under Saleforce module. You can use <em>Salesforce::Account, Salesforce::User</em>, etc. This frees you from having to create Ruby Models in your application, which can be in a pain, if you using Rails db generation tools, e.g. Hobo, which checks to see if you have a database table for that class. With these convenience classes, you are no longer required to create those tables.
-4. Support for Chatter newsfeeds. Retrieving Chatter Feed has always been difficult. There are several challenges. First, you can not select directly from the <em>FeedPost</em>, <em>FeedTrackedChanges</em>, and <em>FeedComments</em> tables. That means you always needed to put that in a subquery, as: <em>SELECT Id, Type, (FeedPost.ID, FeedPost.Body, FeedPost.ContentType, et.... ), (Select Id, FieldName, OldValue, NewValue from FeedTrackedChanges), (Select Id, CommentBody, .... from FeedComments) form {feed_type}Feed where parentid='#####'</em>. Doing that over and over again can be repetitive and against the DRY (Don't Repeat Yourself) principle of Rails programming. Therefore, a convenience class has been provided from you. see <em>Salesforce::ChatterFeed</em>. See following example.
-    chatter_feed_finder = Salesforce::ChatterFeed.new
-    # The following two lines shows how to get the account_feed.id. You can replace it with your
-    account_feed = Salesforce::AccountFeed.first
-    object_id = account_feed.id
-    feed_no_attachment = chatter_feed_finder.get_all_chatter_feeds_without_attachments(object_id, 'Account', user.connection.binding, 'test-session-id')
-Furthermore, the syntaxes from the methods are:
-    chatter_feed_finder.get_all_chatter_feeds_with_attachments(object_id, object_type, binding, directory_name, limit, get_attachment)
-    chatter_feed_finder.get_all_chatter_feeds_without_attachments(object_id, object_type, binding, directory_name, limit)
-    chatter_feed_finder.get_single_chatter_feed_with_attachment(feedpost_id, feed_type, binding, directory_name, limit)
-where, 
-       object_id -> id of the feed
-       object_type -> type of feed, e.g. AccountFeed, CampaignFeed, ContactFeed, UserFeed, ....
-       binding -> the RForce binding used to for connecting to Salesforce Web Services Server
-       directory_name -> where the attachment will be saved at, it is stored under the RAILS_ROOT/public/tmp/{your directory}
-       limit -> max of number of feed retrieved which this call
-       get_attachment -> boolean flag: yes (get attachment), no (don't get attachment)
-5. Salesforce Object lookup utility, provide a Salesforce object Id, and figure out if it is an Account, User, Lead, etc. <em>Salesforce::SfUtility.determine_sf_object_type(id)</em>. See the document for other useful method in this class.
-6. Ability to call non-traditional SQLs. e.g. with "LIMIT", "GROUP BY", "HAVING", and "WITH DATA CATEGORY". example:
-    another = Salesforce::SfBase.query_by_sql("SELECT LeadSource, COUNT(Name) FROM Lead GROUP BY LeadSource")
-    assert another.size
-7. more ....
-
-    zero_result = Salesforce::SfBase.query_by_sql("SELECT Name, Count(Id) FROM Account GROUP BY Name HAVING Count(Id) > 100")
-    assert_nil zero_result
-6. The best part, is this gem is backward compatible with the original ActiveSalesforce-Adapter GEM release. You only need to make minimum changes to your application to use this GEM. To use this gem, simply replace the declaration in <em>config/environment.rb</em> with <em>config.gem "asf-soap-adapter", :lib => "activerecord-activesalesforce-adapter"</em> in the <em>Rails::Initializer.run do |config|</em> section.
-== Significant Changes
-1. Detached hardcoded RForce 0.4.0 and replaced with RForce 0.4.1 gem.
-2. Dynamic Adapter version from 'database.yml' file via 'api_version' parameter
-3. Conveninence classes, Salesforce::Account, User, ....
-4. Chatter Feed
-5. Object Lookup Utility (SF id -> SF object type)
-6. Nontraditional query support
-
-== Installation
-
-1. Add: <em>config.gem "asf-soap-adapter", :lib => "activerecord-activesalesforce-adapter"</em> to <em>Rails::Initializer.run do |config|</em> section in your <em>config/environment.rb</em> file.
-2. run <em>sudo rake gems:install</em> from your rails base directory.
-
-== Getting started
-
-1. If you have not already done so generate your initial rails app:
-
-    rails myappname
-
-2. Edit config/environment.rb and add a config.gem requirement:
-
-    Rails::Initializer.run do |config|
-      ...
-      config.gem "asf-soap-adapter", :lib => 'asf-soap-adapter'
-      ...
-    end
-
-3. Edit database.yml
-
-salesforce-default-realm:
-    adapter: activesalesforce
-    url: https://www.salesforce.com
-    username: <username>
-    password: <password + security token>
-    api_version: 20.0
-
-    NOTE: "url" is an optional parameter.  If you want to access your Salesforce Sandbox account add the following line.   
-      url: https://test.salesforce.com
-          "api_version" is also optional. If you don't specify a version, it is automatically default to 20.0.
-
-4. Create your salesforce models using a Salesforce::<ModelName> namespace.
-
-   A lot of the Salesforce Models have already been provided as convenience class. If you need to add more:
-
-    script/generate model Salesforce::NewObject
-
-    update the file
-module Salesforce
-  # See http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_objects_list.htm
-  # For complete list of Salesforce Standard Objects in V20.
-  class NewObject < SfBase
-    set_table_name 'NewObject' # must be a valid Salesforce Table, otherwise, it will complain.
-  end
-end
-
-5. Run a quick test to make sure things are working
-
-    > script/console
-    Loading development environment (Rails 2.3.9)
-    
-    >> Salesforce::Contact.first
-    => <Salesforce::Contact id: "003T000000GqvJsIAJ", ... >
-
-6. Proceed using standard Rails development techniques!
-
-== Advanced Features
-
-1. Session ID based Authentication: Add the following to /app/controllers/application.rb to enable SID auth for all controllers
-
-   class ApplicationController < ActionController::Base
-     before_filter ActiveSalesforce::SessionIDAuthenticationFilter
-   end
-
-2. Boxcar'ing of updates, inserts, and deletes. Use <YourModel>.transaction() to demark boxcar boundaries.
-
-== Description of contents
-
-lib
- Application specific libraries. Basically, any kind of custom code that doesn't
- belong under controllers, models, or helpers. This directory is in the load path.
- -- active_record   -> asf model
- -- salesforce      -> convenience classes and utilities
-
-test
- Unit and functional tests along with fixtures. See enclosed test app (asf-soap-adapter-rails-app) for full-fledge tests.
-
-== Additional Note:
-The enclosed test app (asf-soap-adapter-rails-app) shows how to use the framework. Go into its "test/unit" directory, where examples are provided.
-
-I am currently, updating my reference app SFRWatcher to SFRWatcher_v20 to match the switch from the old gem to this new gem. Once it is ready, it will be posted on the web soon.  The project home: http://asf-soap-adapter.are4.us
-
-Copyright (c) 2010 Raymond Gao. See LICENSE for details.