levene 0.0.1

data/Manifest.txt

@@ -0,0 +1,18 @@
+Manifest.txt
+README.markdown
+Rakefile
+levene.gemspec
+lib/levene.rb
+lib/levene/version.rb
+lib/levene/connection.rb
+lib/levene/models/account.rb
+lib/levene/models/base.rb
+lib/levene/models/campaign.rb
+lib/levene/models/campaign_member.rb
+lib/levene/models/contact.rb
+lib/levene/models/lead.rb
+lib/levene/models/opportunity.rb
+lib/levene/extensions/binding.rb
+test/helper.rb
+test/test_login.rb
+test/test_lead_model.rb

data/README.markdown

@@ -0,0 +1,46 @@
+# Levene
+
+* https://github.com/robrasmussen/levene
+
+
+## DESCRIPTION
+
+A light wrapper around RForce to make working with Salesforce a little
+easier.
+
+## USAGE
+
+Levene allows you to easily create models that map to their Salesforce
+API counterpart:
+
+    class Contact < Levene::Models::Base
+    end
+
+Levene depends on a few environment variables being defined:
+
+SALESFORCE_DEV_USER: The Salesforce account you're using
+SALESFORCE_DEV_PASS: Your Salesforce password + security token
+
+(If you don't have a Salesforce dev account or an account with API
+access, you'll have to take care of that first.)
+
+
+Creating a subclass of Levene::Models::Base will cause the fields of the
+relevant Salesforce object to be looked up, and will create accessors
+and ActiveModel validations based on the field definititions.
+
+    contact = Contact.new
+    contact.valid? #=> false
+    contact.errors.full_messages #=> ["Last name can't be blank"] 
+    contact.first_name = "Ricky"
+    contact.last_name = "Roma"
+    contact.description = "The guy is a closer."
+    contact.save #=> true
+    contact.id #=> "00AA000006636drIAA"
+
+
+This is not a replacement for the ActiveRecord connection adapter for
+Salesforce. Levene is mostly for people who need to push data up to 
+Salesforce in the background. *It is not thread-safe*.
+
+

data/Rakefile

@@ -0,0 +1,21 @@
+require "rubygems"
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+
+Hoe.plugins.delete :rubyforge
+Hoe.plugin :minitest #gem install hoe-seattlerb
+Hoe.plugin :gemspec  #gem install hoe-gemspec
+
+Hoe.spec 'levene' do
+  developer('Robert Rasmussen', 'rob.rasmussen@gmail.com')
+
+  self.readme_file      = 'README.markdown'
+  self.extra_rdoc_files = FileList['README.markdown']
+
+  self.extra_deps << [ 'activemodel', '>=3.0.3' ]
+  self.extra_deps << [ 'activesupport', '>=3.0.3' ]
+  self.extra_deps << [ 'rforce', '~>0.6.0' ]
+
+  self.extra_dev_deps << [ 'nokogiri', '>=1.4.4' ]
+end
+

data/levene.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{levene}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Robert Rasmussen"]
+  s.date = %q{2011-01-20}
+  s.description = %q{A light wrapper around RForce to make working with Salesforce a little
+easier.}
+  s.email = ["rob.rasmussen@gmail.com"]
+  s.extra_rdoc_files = ["Manifest.txt", "README.markdown"]
+  s.files = ["Manifest.txt", "README.markdown", "Rakefile", "levene.gemspec", "lib/levene.rb", "lib/levene/version.rb", "lib/levene/connection.rb", "lib/levene/models/account.rb", "lib/levene/models/base.rb", "lib/levene/models/campaign.rb", "lib/levene/models/campaign_member.rb", "lib/levene/models/contact.rb", "lib/levene/models/lead.rb", "lib/levene/models/opportunity.rb", "lib/levene/extensions/binding.rb", "test/helper.rb", "test/test_login.rb", "test/test_lead_model.rb", "test/test_base_model.rb"]
+  s.homepage = %q{https://github.com/robrasmussen/levene}
+  s.rdoc_options = ["--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{levene}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A light wrapper around RForce to make working with Salesforce a little easier.}
+  s.test_files = ["test/test_base_model.rb", "test/test_lead_model.rb", "test/test_login.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activemodel>, [">= 3.0.3"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.3"])
+      s.add_runtime_dependency(%q<rforce>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<minitest>, [">= 1.6.0"])
+      s.add_development_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_development_dependency(%q<hoe>, [">= 2.8.0"])
+    else
+      s.add_dependency(%q<activemodel>, [">= 3.0.3"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.3"])
+      s.add_dependency(%q<rforce>, ["~> 0.6.0"])
+      s.add_dependency(%q<minitest>, [">= 1.6.0"])
+      s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_dependency(%q<hoe>, [">= 2.8.0"])
+    end
+  else
+    s.add_dependency(%q<activemodel>, [">= 3.0.3"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.3"])
+    s.add_dependency(%q<rforce>, ["~> 0.6.0"])
+    s.add_dependency(%q<minitest>, [">= 1.6.0"])
+    s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+    s.add_dependency(%q<hoe>, [">= 2.8.0"])
+  end
+end

data/lib/levene/connection.rb

@@ -0,0 +1,30 @@
+module Levene
+  class Connection
+
+    def login(username, password)
+      login_result = self.binding.login username, password
+      true
+    rescue
+      false
+    end
+
+    def binding
+      @binding ||= ::RForce::Binding.new 'https://login.salesforce.com/services/Soap/u/20.0'
+    end
+
+    def start
+      yield binding
+      logout
+    end
+
+    def logout
+      self.binding.logout
+      @binding = nil
+    end
+
+    def has_session?
+      !self.binding.instance_variable_get("@session_id").nil?
+    end
+
+  end
+end

data/lib/levene/extensions/binding.rb

@@ -0,0 +1,46 @@
+module Levene
+  module Extensions
+    module Binding
+
+      def logout
+        response = call_remote(:logout, [])
+        @session_id = nil
+      end
+
+      def describe(model)
+        result = call_remote(:describeSObject, :sObjectType => model.name.demodulize)
+        if result[:Fault]
+          raise result[:Fault][:faultstring]
+        else
+          return result[:describeSObjectResponse][:result][:fields]
+        end
+      end
+
+      def query(model, conditions)
+        full_query = "SELECT #{model.columns.collect {|c| c[:name]}.join(", ")} FROM #{model.model_name.demodulize} #{conditions || ""}"
+        result = call_remote(:query, :queryString => full_query)
+        if result[:Fault]
+          raise result[:Fault][:faultstring]
+        else
+          result[:queryResponse][:result].nil? ? [] : [result[:queryResponse][:result][:records]].flatten
+        end
+      end
+
+      def create(model)
+        return false unless model.valid?
+        result = call_remote(:create, model.to_s_object)
+        if result[:Fault]
+          raise result[:Fault][:faultstring]
+        else
+          unless result[:createResponse][:result][:id].nil?
+            model.id = result[:createResponse][:result][:id]
+            return true
+          else
+            model.errors.add_to_base(result[:createResponse][:result][:errors][:message])
+            return false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/levene/models/account.rb

@@ -0,0 +1,6 @@
+module Levene
+  module Models
+    class Account < Base
+    end
+  end
+end

data/lib/levene/models/base.rb

@@ -0,0 +1,140 @@
+require 'active_model'
+require 'active_support/core_ext/class/attribute'
+
+module Levene
+  module Models
+    class Base
+      extend ActiveModel::Naming
+      include ActiveModel::Validations
+
+      class_attribute :connection
+
+      def attributes
+        self.class.attr_names.inject({}) do |memo, name|
+          memo[name] = self.send(name)
+          memo
+        end
+      end
+
+      def attributes=(attrs)
+        attrs.each do |attr, val|
+          if attr[0] == attr[0].upcase
+            attr = attr.to_s.underscore
+            attr = attr[0].downcase + attr[1..-1]
+          end
+
+          if attr == "id" && Array === val
+            val = val.first
+          end
+
+          self.send "#{attr}=", val if self.respond_to?("#{attr}=".to_sym)
+        end
+      end
+
+      def save
+        if self.id.nil?
+          self.connection.binding.create(self) 
+        else
+          self.connection.binding.update(self)
+        end
+      end
+
+      def to_s_object
+        attributeMap = self.attributes.inject({}) do |memo, attr|
+          next memo if attr.last.nil? || attr.last.blank?
+          levene_attr_name = attr.first.to_s.camelize
+          if attr.first.to_s.ends_with?("__c")
+            levene_attr_name.gsub!(/_c$/, "__c")
+          end
+          memo[levene_attr_name] = attr.last
+          memo
+        end
+
+        fieldsToNull = self.attributes.select {|k,v| self.class.column_hash[k][:createable] == "true" && (v.nil? || v.blank?)}.collect {|k,v| k.to_s.camelize}
+        fieldsToNull = fieldsToNull.collect {|k| k[0].downcase + k[1..-1]}
+        
+        {:sObject => {"xsi:type" => self.class.model_name.demodulize}.merge(attributeMap)}
+      end
+
+      class << self
+        attr_accessor :abstract
+        alias_method :abstract?, :abstract
+        attr_accessor :columns
+        attr_accessor :attr_names
+        attr_accessor :column_hash
+
+        def abstract!
+          self.abstract = true
+        end
+
+        def inherited(klazz)
+          klazz.abstract = false
+          klazz.get_column_definitions
+        end
+
+        def find(*ids)
+          results = self.connection.find(self,ids)
+        end
+
+        def find_by_soql(query)
+          result = self.connection.binding.query(self, query)
+          return [] if result == [nil]
+          result.collect {|r| obj = self.new; obj.attributes = r; obj}
+        end
+
+        def get_column_definitions
+          self.columns = self.connection.binding.describe(self)
+          self.columns.each do |col|
+            next if col[:deprecatedAndHidden] == "true"
+
+            attribute = (col[:name][0].downcase + col[:name][1..-1]).underscore
+            self.attr_names ||= []
+            self.attr_names << attribute.to_sym
+            self.column_hash ||= {}
+            self.column_hash[attribute.to_sym] = col
+
+            attr_accessor attribute
+
+            if col[:nillable] == "false" && col[:createable] == "true" && col[:defaultedOnCreate] != "true"
+              validates_presence_of attribute
+            end
+
+            if col[:type] == "string" && col[:length] && col[:length].to_i > 0
+              validates_length_of attribute, :maximum => col[:length].to_i
+            end
+
+            if col[:picklistValues]
+              valid_values = col[:picklistValues].select {|h| h[:active] == "true"}.collect {|h| h[:value]}
+              default = col[:picklistValues].find {|h| h[:defaultValue] == "true"}
+              if col[:nillable] == "true" || col[:createable] == "false"
+                validates_inclusion_of attribute, :in => valid_values, :allow_nil => true
+              else
+                validates_inclusion_of attribute, :in => valid_values
+              end
+
+              if default
+                class_eval """def #{attribute}
+                    @#{attribute} ||= \"#{default[:value]}\"
+                   end"""
+              end
+            end
+          end
+        end
+
+        def connection_established?
+          !connection.nil? && connection.has_session?
+        end
+
+        def establish_connection
+          self.connection = Levene::Connection.new
+          self.connection.login ENV["SALESFORCE_DEV_USER"], ENV["SALESFORCE_DEV_PASS"]
+        end
+
+      end
+
+      abstract!
+      establish_connection
+      
+    end
+  end
+end

data/lib/levene/models/campaign.rb

@@ -0,0 +1,6 @@
+module Levene
+  module Models
+    class Campaign < Base
+    end
+  end
+end

data/lib/levene/models/campaign_member.rb

@@ -0,0 +1,6 @@
+module Levene
+  module Models
+    class CampaignMember < Base
+    end
+  end
+end

data/lib/levene/models/contact.rb

@@ -0,0 +1,6 @@
+module Levene
+  module Models
+    class Contact < Base
+    end
+  end
+end

data/lib/levene/models/lead.rb

@@ -0,0 +1,6 @@
+module Levene
+  module Models
+    class Lead < Base
+    end
+  end
+end

data/lib/levene/models/opportunity.rb

@@ -0,0 +1,6 @@
+module Levene
+  module Models
+    class Opportunity < Base
+    end
+  end
+end

data/lib/levene/version.rb

@@ -0,0 +1,3 @@
+module Levene
+  VERSION = "0.0.1"
+end

data/lib/levene.rb

@@ -0,0 +1,21 @@
+require 'rforce'
+require 'active_support'
+
+module Levene
+  autoload :Connection, "levene/connection.rb"
+  module Models
+    autoload :Base, "levene/models/base.rb"
+    autoload :Account, "levene/models/account.rb"
+    autoload :Campaign, "levene/models/campaign.rb"
+    autoload :CampaignMember, "levene/models/campaign_member.rb"
+    autoload :Contact, "levene/models/contact.rb"
+    autoload :Lead, "levene/models/lead.rb"
+    autoload :Opportunity, "levene/models/opportunity.rb"
+
+  end
+  module Extensions
+    autoload :Binding, "levene/extensions/binding.rb"
+  end
+end
+
+RForce::Binding.send(:include, Levene::Extensions::Binding)

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'levene'
+
+class Object
+  def must_be_true
+    must_equal true
+  end
+
+  def must_be_false
+    must_equal false
+  end
+end

data/test/test_base_model.rb

@@ -0,0 +1,8 @@
+require 'helper'
+
+describe Levene::Models::Base do
+
+  it "should be abstract" do
+    Levene::Models::Base.abstract?.must_be_true
+  end
+end

data/test/test_lead_model.rb

@@ -0,0 +1,29 @@
+require 'helper'
+
+describe Levene::Models::Lead do
+  before do
+    @lead = Levene::Models::Lead.new
+  end
+
+  it "should conform to ActiveModel::Naming" do
+    @lead.class.model_name.must_equal "Levene::Models::Lead"
+    @lead.class.model_name.human.must_equal "Lead"
+  end
+
+  it "should not be abstract" do
+    @lead.class.abstract?.must_be_false
+  end
+
+  it "should have a list of columns" do
+    @lead.class.columns.count.must_be :>, 0
+  end
+
+  it "should have a connection attribute" do
+    @lead.class.must_respond_to :connection
+  end
+
+  it "should respond to #save" do
+    @lead.must_respond_to :save
+  end
+
+end

data/test/test_login.rb

@@ -0,0 +1,66 @@
+require 'helper'
+
+describe Levene::Connection do
+  before do
+    @connection = Levene::Connection.new
+  end
+
+  it "must respond to #login" do
+    @connection.must_respond_to :login
+  end
+
+  it "must respond to #binding" do
+    @connection.must_respond_to :binding
+  end
+
+  describe "with valid user credentials" do
+    before do
+      @username = ENV["SALESFORCE_DEV_USER"]
+      @password = ENV["SALESFORCE_DEV_PASS"]
+    end
+
+    it "should return a truthy value for a successful login" do
+      assert @connection.login(@username, @password), "Successful login should return something truthy"
+    end
+
+    it "should report is has a ssession after a successful login" do
+      @connection.login(@username, @password)
+      @connection.has_session?.must_be_true
+    end
+  end
+
+  describe "with invalid user credentials" do
+    before do
+      @username= "foo"
+      @password = "bar"
+    end
+    
+    it "should return false for an unsuccessful login" do
+      assert !@connection.login(@username, @password), "Unsuccessful login should return someing falsy"
+    end
+
+    it "should not have a session after an unsuccessful login" do
+      @connection.login(@username, @password)
+      assert @connection.has_session?.must_be_false
+    end
+  end
+
+
+  describe "a logged in connection" do
+    before do
+      @connection.login(ENV["SALESFORCE_DEV_USER"], ENV["SALESFORCE_DEV_PASS"])
+    end
+
+    it "should yield a levene binding from start" do
+      @connection.start do |binding|
+        binding.must_be_kind_of RForce::Binding
+        @connection.has_session?.must_be_true
+      end
+    end
+
+    it "should not have an active binding after the block finished" do
+      @connection.start {|binding| }
+      @connection.has_session?.must_be_false 
+    end
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification 
+name: levene
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Robert Rasmussen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-20 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rforce
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id006
+description: |-
+  A light wrapper around RForce to make working with Salesforce a little
+  easier.
+email: 
+- rob.rasmussen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- README.markdown
+files: 
+- Manifest.txt
+- README.markdown
+- Rakefile
+- levene.gemspec
+- lib/levene.rb
+- lib/levene/version.rb
+- lib/levene/connection.rb
+- lib/levene/models/account.rb
+- lib/levene/models/base.rb
+- lib/levene/models/campaign.rb
+- lib/levene/models/campaign_member.rb
+- lib/levene/models/contact.rb
+- lib/levene/models/lead.rb
+- lib/levene/models/opportunity.rb
+- lib/levene/extensions/binding.rb
+- test/helper.rb
+- test/test_login.rb
+- test/test_lead_model.rb
+- test/test_base_model.rb
+has_rdoc: true
+homepage: https://github.com/robrasmussen/levene
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: levene
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A light wrapper around RForce to make working with Salesforce a little easier.
+test_files: 
+- test/test_base_model.rb
+- test/test_lead_model.rb
+- test/test_login.rb