ryandotsmith-asf-soap-adapter 1.0.3

data/lib/salesforce/feed_post.rb

@@ -0,0 +1,27 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 FeedPost < SfBase
+    set_table_name 'feed_posts'
+  end
+end

data/lib/salesforce/feed_tracked_change.rb

@@ -0,0 +1,27 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 FeedTrackedChange < SfBase
+    set_table_name 'feed_tracked_changes'
+  end
+end

data/lib/salesforce/file_writer.rb

@@ -0,0 +1,61 @@
+require 'logger'
+module Salesforce
+  class FileWriter < Object
+
+    def initialize
+      super
+      #### define @logger
+      # http://ruby-doc.org/core/classes/@logger.html
+      # TODO use a log file, rather than Standout
+      @logger = Logger.new(STDOUT)
+      @logger.debug 'FileWriter initialized.'
+    end
+    
+    # This method optimizes the file writing process. If the local file already exists
+    # and matchs the remote filesize, it skips writing. Otherwise, it writes the file.
+    # <b>returns local_file_name = RAILS_ROOT/public/tmp/<parent_dir>/filename</b>
+    #
+    # 'filename' the remote filename
+    # 'filesize' the size of the remote file
+    # 'filedata' contains encoded file data
+    # 'parent_dir' the subdirectory where the file will be stored at
+    def do_write_file(filename, filesize, filedata, parent_dir)
+      # Downloaded files are put in the subdirectory matching each session-id in the /public/tmp directory.
+      # creates dir, if it does not exists
+      dir = "/tmp/#{parent_dir}"
+      # Creating the 'tmp' under the 'public' to hold downloaded files.
+      Dir.mkdir(RAILS_ROOT + "/public/tmp" ) unless File.directory?(RAILS_ROOT + "/public/tmp")
+      # Putting files in each user's sesseion directory.
+      Dir.mkdir(RAILS_ROOT + "/public" + dir ) unless File.directory?(RAILS_ROOT + "/public" + dir)
+      local_file_name =  dir + "/#{filename}"
+
+      writefile_flag = true
+      #local_file_name =  '/tmp/' + session_id + "-" + filename
+
+      if !File.exist?(RAILS_ROOT + "/public" + local_file_name)
+        # local file does not exist, write the local file
+        @logger.info("local file does not exist, write the local file.")
+        writefile_flag = true
+      elsif File.size(RAILS_ROOT + "/public" + local_file_name).to_i == filesize.to_i
+        # local file exists & file size matchs remote file sizem, skip writing the local local file
+        @logger.info("local file exists & file size matchs remote file sizem, skip writing the local local file.")
+        writefile_flag = false
+      else
+        @logger.info("Write the local file: " + RAILS_ROOT + "/public" + local_file_name)
+        writefile_flag = true
+      end
+
+      if writefile_flag
+        #Now, construct the file, 1st decode, 2nd, write it out
+        attachment = File.new(RAILS_ROOT + "/public" + local_file_name, 'w+b')
+        # Salesforce sends back an encoded data. It needs to be decoded into binary.
+        # otherwise, it starts off with "/9j/4AAQSkZJRgABA......."
+        decoded_data = Base64.decode64(filedata)
+        attachment.write(decoded_data)     #=> 10
+      end
+  
+      return local_file_name
+    end
+
+  end
+end

data/lib/salesforce/group.rb

@@ -0,0 +1,28 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 Group < SfBase
+    set_table_name 'groups'
+
+  end
+end

data/lib/salesforce/group_member.rb

@@ -0,0 +1,28 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 GroupMember < SfBase
+    #table name must match the Salesforce, or it does not work. This is a quirk of the ActiveSalesforce
+    set_table_name 'group_members'
+  end
+end

data/lib/salesforce/lead.rb

@@ -0,0 +1,27 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 Lead < SfBase
+    set_table_name 'leads'
+  end
+end

data/lib/salesforce/lead_feed.rb

@@ -0,0 +1,27 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 LeadFeed < SfBase
+    set_table_name 'lead_feeds'
+  end
+end

data/lib/salesforce/news_feed.rb

@@ -0,0 +1,27 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 NewsFeed < SfBase
+    set_table_name 'news_feeds'
+  end
+end

data/lib/salesforce/opportunity.rb

@@ -0,0 +1,27 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 Opportunity < SfBase
+    set_table_name 'opportunities'
+  end
+end

data/lib/salesforce/opportunity_feed.rb

@@ -0,0 +1,27 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 OpportunityFeed < SfBase
+    set_table_name 'opportunity_feeds'
+  end
+end

data/lib/salesforce/organization.rb

@@ -0,0 +1,27 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 Organization < SfBase
+    set_table_name "organizations"
+  end
+end

data/lib/salesforce/product2.rb

@@ -0,0 +1,27 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 Product2 < SfBase
+    set_table_name 'product2s'
+  end
+end

data/lib/salesforce/product2_feed.rb

@@ -0,0 +1,27 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+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 Product2Feed < SfBase
+    set_table_name 'product2_feeds'
+  end
+end

data/lib/salesforce/sf_base.rb

@@ -0,0 +1,94 @@
+=begin
+asf-soap-adapter
+Copyright 2010 Raymond Gao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+# Salesforce package contains convenience classes for mapping Salesforce objects into
+# ActiveRecord objects. The SfBase is the mother of all other objects. Additionally,
+# SfUtitlity class provides several useful methods for manipulating SF objects.
+module Salesforce
+  # SfBase is the mother of all other objects. It establishes the SOAP connection
+  # to Salesforce Server and turns it into A/R objects.
+  # Main methods are:
+  #   1. self.loging (username, password, security_token) -> static method
+  #   2. logout (session {as both single or hash}) -> instance method
+  #   3. self.swap_connction(connection) -> static method
+  #   4. self.query_by_sql(sql) -> static method
+  # For complete list of Salesforce Standard Objects in V20.
+  class SfBase < ActiveRecord::Base
+    self.abstract_class = true
+
+    # By default the 'salesforce-default-realm' in the 'database.yml' is the default
+    # connection, meaning all Salesforce objects will use that for the A/R connection.
+    # However, a web application is designed to support multiple users. Therefore,
+    # each user should have his/her own connection. To do that, the web-application
+    # should use the 'before-filter' to swap contexts/connections for each user.
+    # A good place to put that filter is in the 'application_controller.rb' file.
+    # The context can be changed for 1) a single SF class. Or 2) the root (SfObject),
+    # it will affect every other class inherited from the SfObject.
+    def self.login(user, pass, token)
+      params = {:adapter => "activesalesforce",
+        :url => "https://login.salesforce.com/services/Soap/u/20.0",
+        :username => user,
+        :password => pass + token
+      }
+      self.establish_connection(params)
+    end
+
+    # Logs out of the Salesforce session
+    def logout(session_ids=Hash.new)
+      result = SfBase.connection.binding.invalidateSessions(session_ids)
+      if"invalidateSessionsResponse" == result.to_s
+        return true
+      else
+        return false
+      end
+      #result this.connection.binding.logout(Hash.new)
+    end
+
+    establish_connection "salesforce-default-realm"
+  
+    set_table_name 'salesforce_sf_bases'
+
+    # Swaps the connection to Salesforce
+    def self.swap_connection (connection)
+      @@connection = connection
+    end
+
+    #Provides a method to directly call SQL via RFORCe
+    def self.query_by_sql(sql)
+      query_results = connection.binding.query :searchString => sql
+      return query_results.queryResponse.result.records unless query_results.queryResponse.result.size < 1 
+    end
+
+    attr_reader :current_connection, :connection_owner, :current_connection_binding
+
+    # Return a read only version of the current_connection
+    def current_connection
+      connection
+    end
+
+    # Returns the owner's info of the current Salesforce WS connection
+    def connection_owner
+      connection.get_user_info
+    end
+
+    # Return a read-only version of the binding associated with the current connection
+    def current_connection_binding
+      connection.binding
+    end
+ 
+  end
+end