databasedotcom 1.0.1

data/lib/databasedotcom/collection.rb

@@ -0,0 +1,37 @@
+module Databasedotcom
+  # A collection of Sobject or Record objects that holds a single page of results, and understands how to
+  # retrieve the next page, if any. Inherits from Array, thus, behaves as an Enumerable.
+
+  class Collection < Array
+    attr_reader :total_size, :next_page_url, :previous_page_url, :current_page_url, :client
+
+    # Creates a paginatable collection. You should never need to call this.
+    def initialize(client, total_size, next_page_url=nil, previous_page_url=nil, current_page_url=nil) #:nodoc:
+      @client = client
+      @total_size = total_size
+      @next_page_url = next_page_url
+      @previous_page_url = previous_page_url
+      @current_page_url = current_page_url
+    end
+
+    # Does this collection have a next page?
+    def next_page?
+      !!self.next_page_url
+    end
+
+    # Retrieve the next page of this collection.  Returns the new collection, which is an empty collection if no next page exists
+    def next_page
+      self.next_page? ? @client.next_page(@next_page_url) : Databasedotcom::Collection.new(self.client, 0)
+    end
+
+    # Does this collection have a previous page?
+    def previous_page?
+      !!self.previous_page_url
+    end
+
+    # Retrieve the previous page of this collection. Returns the new collection, which is an empty collection if no previous page exists
+    def previous_page
+      self.previous_page? ? @client.previous_page(@previous_page_url) : Databasedotcom::Collection.new(self.client, 0)
+    end
+  end
+end

data/lib/databasedotcom/core_extensions.rb

@@ -0,0 +1,3 @@
+require 'databasedotcom/core_extensions/class_extensions'
+require 'databasedotcom/core_extensions/string_extensions'
+require 'databasedotcom/core_extensions/hash_extensions'

data/lib/databasedotcom/core_extensions/class_extensions.rb

@@ -0,0 +1,41 @@
+# This extends Class to be able to use +cattr_accessor+ if active_support is not being used.
+class Class
+  unless respond_to?(:cattr_reader)
+    def cattr_reader(sym)
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}
+          @@#{sym}
+        end
+
+        def #{sym}
+          @@#{sym}
+        end
+      EOS
+    end
+
+    def cattr_writer(sym)
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+    end
+
+    def cattr_accessor(*syms, &blk)
+      cattr_reader(*syms)
+      cattr_writer(*syms, &blk)
+    end
+  end
+end

data/lib/databasedotcom/core_extensions/hash_extensions.rb

@@ -0,0 +1,8 @@
+class Hash
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+end

data/lib/databasedotcom/core_extensions/string_extensions.rb

@@ -0,0 +1,8 @@
+# This extends String to add the +resourcerize+ method.
+class String
+
+  # Dasherizes and downcases a camelcased string. Used for Feed types.
+  def resourcerize
+    self.gsub(/([a-z])([A-Z])/, '\1-\2').downcase
+  end
+end

data/lib/databasedotcom/sales_force_error.rb

@@ -0,0 +1,26 @@
+module Databasedotcom
+  # An exception raised when any non successful request is made to Force.com.
+  class SalesForceError < StandardError
+    # the Net::HTTPResponse from the API call
+    attr_accessor :response
+    # the +errorCode+ from the server response body
+    attr_accessor :error_code
+
+    def initialize(response)
+      self.response = response
+      parsed_body = JSON.parse(response.body) rescue nil
+      if parsed_body
+        if parsed_body.is_a?(Array)
+          message = parsed_body[0]["message"]
+          self.error_code = parsed_body[0]["errorCode"]
+        else
+          message = parsed_body["error_description"]
+          self.error_code = parsed_body["error"]
+        end
+      else
+        message = response.body
+      end
+      super(message)
+    end
+  end
+end

data/lib/databasedotcom/sobject.rb

@@ -0,0 +1,2 @@
+require 'databasedotcom/sobject/sobject'
+

data/lib/databasedotcom/sobject/sobject.rb

@@ -0,0 +1,291 @@
+module Databasedotcom
+  module Sobject
+    # Parent class of dynamically created sobject types. Interacts with Force.com through a Client object that is passed in during materialization.
+    class Sobject
+      cattr_accessor :client
+      extend ActiveModel::Naming if defined?(ActiveModel::Naming)
+
+      # Returns a new Sobject. The default values for all attributes are set based on its description.
+      def initialize(attrs = {})
+        super
+        self.class.description["fields"].each do |field|
+          self.send("#{field["name"]}=", field["defaultValueFormula"])
+        end
+        self.attributes=(attrs)
+      end
+
+      def attributes=(attrs)
+        attrs.each do |key, value|
+          self.send("#{key}=", value)
+        end
+      end
+
+      # Returns true if the object has been persisted in the Force.com database.
+      def persisted?
+        !self.Id.nil?
+      end
+
+      # Returns true if this record has not been persisted in the Force.com database.
+      def new_record?
+        !self.persisted?
+      end
+
+      # Returns self.
+      def to_model
+        self
+      end
+
+      # Returns a unique object id for self.
+      def to_key
+        [object_id]
+      end
+
+      # Returns the Force.com Id for this instance.
+      def to_param
+        self.Id
+      end
+
+      # Updates the corresponding record on Force.com by setting the attribute +attr_name+ to +attr_value+.
+      #
+      #    client.materialize("Car")
+      #    c = Car.new
+      #    c.update_attribute("Color", "Blue")
+      def update_attribute(attr_name, attr_value)
+        update_attributes(attr_name => attr_value)
+      end
+
+      # Updates the corresponding record on Force.com with the attributes specified by the +new_attrs+ hash.
+      #
+      #    client.materialize("Car")
+      #    c = Car.new
+      #    c.update_attributes {"Color" => "Blue", "Year" => "2012"}
+      def update_attributes(new_attrs)
+        if self.client.update(self.class, self.Id, new_attrs)
+          new_attrs = new_attrs.is_a?(Hash) ? new_attrs : JSON.parse(new_attrs)
+          new_attrs.each do |attr, value|
+            self.send("#{attr}=", value)
+          end
+        end
+        self
+      end
+
+      # Updates the corresponding record on Force.com with the attributes of self.
+      #
+      #    client.materialize("Car")
+      #    c = Car.find_by_Color("Yellow")
+      #    c.Color = "Green"
+      #    c.save
+      def save
+        attr_hash = {}
+        self.class.description["fields"].select { |f| f["updateable"] }.collect { |f| f["name"] }.each { |attr| attr_hash[attr] = self.send(attr) }
+
+        if self.Id.nil?
+          self.client.create(self.class, attr_hash)
+        else
+          self.client.update(self.class, self.Id, attr_hash)
+        end
+      end
+
+      # Deletes the corresponding record from the Force.com database. Returns self.
+      #
+      #    client.materialize("Car")
+      #    c = Car.find_by_Color("Yellow")
+      #    c.delete
+      def delete
+        if self.client.delete(self.class, self.Id)
+          self
+        end
+      end
+
+      # Reloads the record from the Force.com database. Returns the reloaded record.
+      #
+      #    client.materialize("Car")
+      #    c = Car.find_by_Color("Yellow")
+      #    c.reload
+      def reload
+        self.class.find(self.Id)
+      end
+
+      def [](attr_name)
+        self.send(attr_name) rescue nil
+      end
+
+      def []=(attr_name, value)
+        raise ArgumentError.new("No attribute named #{attr_name}") unless self.class.attributes.include?(attr_name)
+        self.send("#{attr_name}=", value)
+      end
+
+      # Returns an Array of attribute names that this Sobject has.
+      #
+      #    client.materialize("Car")
+      #    Car.attributes               #=> ["Id", "Name", "Color", "Year"]
+      def self.attributes
+        self.description["fields"].collect { |f| f["name"] }
+      end
+
+      # Materializes the dynamically created Sobject class by adding all attribute accessors for each field as described in the description of the object on Force.com
+      def self.materialize(sobject_name)
+        self.cattr_accessor :description
+        self.cattr_accessor :type_map
+        self.cattr_accessor :sobject_name
+
+        self.sobject_name = sobject_name
+        self.description = self.client.describe_sobject(self.sobject_name)
+        self.type_map = {}
+        self.description["fields"].each do |field|
+          name = field["name"]
+          attr_accessor name.to_sym
+          self.type_map[name] = {:type => field["type"], :label => field["label"], :picklist_values => field["picklistValues"], :updateable? => field["updateable"]}
+        end
+      end
+
+      # Returns the Force.com type of the attribute +attr_name+. Raises ArgumentError if attribute does not exist.
+      #
+      #    client.materialize("Car")
+      #    Car.field_type("Color")    #=> "string"
+      def self.field_type(attr_name)
+        self.type_map_attr(attr_name, :type)
+      end
+
+      # Returns the label for the attribute +attr_name+. Raises ArgumentError if attribute does not exist.
+      def self.label_for(attr_name)
+        self.type_map_attr(attr_name, :label)
+      end
+
+      # Returns the possible picklist options for the attribute +attr_name+. If +attr_name+ is not of type picklist or multipicklist, [] is returned. Raises ArgumentError if attribute does not exist.
+      def self.picklist_values(attr_name)
+        self.type_map_attr(attr_name, :picklist_values)
+      end
+
+      # Returns true if the attribute +attr_name+ can be updated. Raises ArgumentError if attribute does not exist.
+      def self.updateable?(attr_name)
+        self.type_map_attr(attr_name, :updateable?)
+      end
+
+      # Delegates to Client.find with arguments +record_id+ and self
+      #
+      #    client.materialize("Car")
+      #    Car.find("rid")    #=>   #<Car @Id="rid", ...>
+      def self.find(record_id)
+        self.client.find(self, record_id)
+      end
+
+      # Returns all records of type self as instances.
+      #
+      #    client.materialize("Car")
+      #    Car.all    #=>   [#<Car @Id="1", ...>, #<Car @Id="2", ...>, #<Car @Id="3", ...>, ...]
+      def self.all
+        self.client.query("SELECT #{self.field_list} FROM #{self.sobject_name}")
+      end
+
+      # Returns a collection of instances of self that match the conditional +where_expr+, which is the WHERE part of a SOQL query.
+      #
+      #    client.materialize("Car")
+      #    Car.query("Color = 'Blue'")    #=>   [#<Car @Id="1", @Color="Blue", ...>, #<Car @Id="5", @Color="Blue", ...>, ...]
+      def self.query(where_expr)
+        self.client.query("SELECT #{self.field_list} FROM #{self.sobject_name} WHERE #{where_expr}")
+      end
+
+      # Delegates to Client.search
+      def self.search(sosl_expr)
+        self.client.search(sosl_expr)
+      end
+
+      # Find the first record. If the +where_expr+ argument is present, it must be the WHERE part of a SOQL query
+      def self.first(where_expr=nil)
+        where = where_expr ? "WHERE #{where_expr} " : ""
+        self.client.query("SELECT #{self.field_list} FROM #{self.sobject_name} #{where}ORDER BY Id ASC LIMIT 1").first
+      end
+
+      # Find the last record. If the +where_expr+ argument is present, it must be the WHERE part of a SOQL query
+      def self.last(where_expr=nil)
+        where = where_expr ? "WHERE #{where_expr} " : ""
+        self.client.query("SELECT #{self.field_list} FROM #{self.sobject_name} #{where}ORDER BY Id DESC LIMIT 1").first
+      end
+
+      #Delegates to Client.upsert with arguments self, +field+, +values+, and +attrs+
+      def self.upsert(field, value, attrs)
+        self.client.upsert(self.sobject_name, field, value, attrs)
+      end
+
+      # Delegates to Client.delete with arguments +record_id+ and self
+      def self.delete(record_id)
+        self.client.delete(self.sobject_name, record_id)
+      end
+
+      # Sobject objects support dynamic finders similar to ActiveRecord.
+      #
+      #    client.materialize("Car")
+      #    Car.find_by_Color("Blue")
+      #    Car.find_all_by_Year("2011")
+      #    Car.find_by_Color_and_Year("Blue", "2011")
+      #    Car.find_or_create_by_Year("2011")
+      #    Car.find_or_initialize_by_Name("Foo")
+      def self.method_missing(method_name, *args, &block)
+        if method_name.to_s =~ /^find_(or_create_|or_initialize_)?by_(.+)$/ || method_name.to_s =~ /^find_(all_)by_(.+)$/
+          named_attrs = $2.split('_and_')
+          attrs_and_values_for_find = []
+          hash_args = args.length == 1 && args[0].is_a?(Hash)
+          attrs_and_values_for_write = hash_args ? args[0] : {}
+
+          named_attrs.each_with_index do |attr, index|
+            value = hash_args ? args[0][attr] : args[index]
+            attrs_and_values_for_find << "#{attr} = '#{value}'"
+            attrs_and_values_for_write[attr] = value unless hash_args
+          end
+
+          limit_clause = method_name.to_s.include?('_all_by_') ? "" : " LIMIT 1"
+
+          results = self.client.query("SELECT #{self.field_list} FROM #{self.sobject_name} WHERE #{attrs_and_values_for_find.join(' AND ')}#{limit_clause}")
+          results = limit_clause == "" ? results : results.first rescue nil
+
+          if results.nil?
+            if method_name.to_s =~ /^find_or_create_by_(.+)$/
+              results = self.client.create(self, attrs_and_values_for_write)
+            elsif method_name.to_s =~ /^find_or_initialize_by_(.+)$/
+              results = self.new
+              attrs_and_values_for_write.each { |attr, val| results.send("#{attr}=", val) }
+            end
+          end
+
+          results
+        else
+          super
+        end
+      end
+
+      # Delegates to Client.create with arguments +object_attributes+ and self
+      def self.create(object_attributes)
+        self.client.create(self, object_attributes)
+      end
+
+      # Coerce values submitted from a Rails form to the values expected by the database
+      # returns a new hash with updated values
+      def self.coerce_params(params)
+        params.each do |attr, value|
+          case self.field_type(attr)
+            when "boolean"
+              params[attr] = value.is_a?(String) ? value.to_i != 0 : value
+            when "currency", "percent", "double"
+              params[attr] = value.to_f
+            when "date"
+              params[attr] = Date.parse(value) rescue Date.today
+            when "datetime"
+              params[attr] = DateTime.parse(value) rescue DateTime.now
+          end
+        end
+      end
+
+      private
+
+      def self.field_list
+        self.description['fields'].collect { |f| f['name'] }.join(',')
+      end
+
+      def self.type_map_attr(attr_name, key)
+        raise ArgumentError.new("No attribute named #{attr_name}") unless self.type_map.has_key?(attr_name)
+        self.type_map[attr_name][key]
+      end
+    end
+  end
+end

data/lib/databasedotcom/version.rb

@@ -0,0 +1,3 @@
+module Databasedotcom
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: databasedotcom
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Glenn Gillen, Danny Burkes & Richard Zhao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.8.6
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: A ruby wrapper for the Force.com REST API
+email: 
+- me@glenngillen.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- MIT-LICENSE
+- lib/databasedotcom/chatter/comment.rb
+- lib/databasedotcom/chatter/conversation.rb
+- lib/databasedotcom/chatter/feed.rb
+- lib/databasedotcom/chatter/feed_item.rb
+- lib/databasedotcom/chatter/feeds.rb
+- lib/databasedotcom/chatter/filter_feed.rb
+- lib/databasedotcom/chatter/group.rb
+- lib/databasedotcom/chatter/group_membership.rb
+- lib/databasedotcom/chatter/like.rb
+- lib/databasedotcom/chatter/message.rb
+- lib/databasedotcom/chatter/photo_methods.rb
+- lib/databasedotcom/chatter/record.rb
+- lib/databasedotcom/chatter/subscription.rb
+- lib/databasedotcom/chatter/user.rb
+- lib/databasedotcom/chatter.rb
+- lib/databasedotcom/client.rb
+- lib/databasedotcom/collection.rb
+- lib/databasedotcom/core_extensions/class_extensions.rb
+- lib/databasedotcom/core_extensions/hash_extensions.rb
+- lib/databasedotcom/core_extensions/string_extensions.rb
+- lib/databasedotcom/core_extensions.rb
+- lib/databasedotcom/sales_force_error.rb
+- lib/databasedotcom/sobject/sobject.rb
+- lib/databasedotcom/sobject.rb
+- lib/databasedotcom/version.rb
+- lib/databasedotcom.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: databasedotcom
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the Force.com REST API
+test_files: []
+