rforce 0.4.1 → 0.5

data/History.txt

@@ -1,3 +1,14 @@
+== 0.5.1 2010-12-11
+
+* 2 minor enhancements:
+  * Increase batch size (Raymond Gao)
+  * Removed Facets dependency (Justin Ramos, Aaron Qian)
+
+== 0.4.1 2010-03-21
+
+* 1 minor enhancement:
+  * Experimental OAuth support
+
 == 0.4 2010-01-21
 
 * 1 minor enhancement:

data/Rakefile

@@ -8,8 +8,8 @@ require 'rforce/version'
 
 Hoe.new('rforce', RForce::VERSION) do |p|
   p.developer         'Ian Dees', 'undees@gmail.com'
-  p.extra_deps      = [['builder', '>= 2.0.0'], ['facets', '>= 2.4']]
-  p.extra_dev_deps  = [['rspec', '>= 1.3']]
+  p.extra_deps      = [['builder', '~> 2.0']]
+  p.extra_dev_deps  = [['rspec', '~> 1.3']]
   p.remote_rdoc_dir = ''
   p.rspec_options   = ['-rubygems', '--options', 'spec/spec.opts']
 end

data/lib/rforce/binding.rb

@@ -2,16 +2,19 @@ require 'net/https'
 require 'uri'
 require 'zlib'
 require 'stringio'
+require 'rexml/document'
 require 'builder'
-
+require 'oauth'
 
 module RForce
   # Implements the connection to the SalesForce server.
   class Binding
     include RForce
-    
-    DEFAULT_BATCH_SIZE = 10
-    attr_accessor :batch_size, :url, :assignment_rule_id, :use_default_rule, :update_mru, :client_id, :trigger_user_email, 
+
+    # Increase the maximum fetch size to 2000, as allowed by Salesforce
+    # Added by Raymond Gao
+    DEFAULT_BATCH_SIZE = 2000
+    attr_accessor :batch_size, :url, :assignment_rule_id, :use_default_rule, :update_mru, :client_id, :trigger_user_email,
       :trigger_other_email, :trigger_auto_response_email
 
     # Fill in the guts of this typical SOAP envelope
@@ -43,12 +46,15 @@ module RForce
     MruHeader = '<partner:MruHeader soap:mustUnderstand="1"><partner:updateMru>true</partner:updateMru></partner:MruHeader>'
     ClientIdHeader = '<partner:CallOptions soap:mustUnderstand="1"><partner:client>%s</partner:client></partner:CallOptions>'
 
-    # Connect to the server securely.
-    def initialize(url, sid = nil)
-      init_server(url)
-
+    # Connect to the server securely.  If you pass an oauth hash, it
+    # must contain the keys :consumer_key, :consumer_secret,
+    # :access_token, :access_secret, and :login_url.
+    def initialize(url, sid = nil, oauth = nil)
       @session_id = sid
+      @oauth = oauth
       @batch_size = DEFAULT_BATCH_SIZE
+
+      init_server(url)
     end
 
 
@@ -59,23 +65,42 @@ module RForce
 
     def init_server(url)
       @url = URI.parse(url)
-      @server = Net::HTTP.new(@url.host, @url.port)
-      @server.use_ssl = @url.scheme == 'https'
-      @server.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
-      # run ruby with -d or env variable SHOWSOAP=true to see SOAP wiredumps.
-      @server.set_debug_output $stderr if show_debug
+      if (@oauth)
+        consumer = OAuth::Consumer.new \
+          @oauth[:consumer_key],
+          @oauth[:consumer_secret],
+          { :site => url }
+
+        consumer.http.set_debug_output $stderr if show_debug
+
+        @server  = OAuth::AccessToken.new \
+          consumer,
+          @oauth[:access_token],
+          @oauth[:access_secret]
+
+        class << @server
+          alias_method :post2, :post
+        end
+      else
+        @server = Net::HTTP.new(@url.host, @url.port)
+        @server.use_ssl = @url.scheme == 'https'
+        @server.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+        # run ruby with -d or env variable SHOWSOAP=true to see SOAP wiredumps.
+        @server.set_debug_output $stderr if show_debug
+      end
     end
 
 
-    # Log in to the server and remember the session ID
-    # returned to us by SalesForce.
+    # Log in to the server with a user name and password, remembering
+    # the session ID returned to us by SalesForce.
     def login(user, password)
       @user = user
       @password = password
 
       response = call_remote(:login, [:username, user, :password, password])
-      
+
       raise "Incorrect user name / password [#{response.fault}]" unless response.loginResponse
 
       result = response[:loginResponse][:result]
@@ -86,6 +111,25 @@ module RForce
       response
     end
 
+    # Log in to the server with OAuth, remembering
+    # the session ID returned to us by SalesForce.
+    def login_with_oauth
+      result = @server.post @oauth[:login_url], '', {}
+
+      case result
+      when Net::HTTPSuccess
+        doc = REXML::Document.new result.body
+        @session_id = doc.elements['*/sessionId'].text
+        server_url  = doc.elements['*/serverUrl'].text
+        init_server server_url
+
+        return {:sessionId => @sessionId, :serverUrl => server_url}
+      when Net::HTTPUnauthorized
+        raise 'Invalid OAuth tokens'
+      else
+        raise "Unexpected error: #{response.inspect}"
+      end
+    end
 
     # Call a method on the remote server.  Arguments can be
     # a hash or (if order is important) an array of alternating
@@ -104,21 +148,21 @@ module RForce
       extra_headers << AssignmentRuleHeaderUsingDefaultRule if use_default_rule
       extra_headers << MruHeader if update_mru
       extra_headers << (ClientIdHeader % client_id) if client_id
-      
+
       if trigger_user_email or trigger_other_email or trigger_auto_response_email
         extra_headers << '<partner:EmailHeader soap:mustUnderstand="1">'
-        
+
         extra_headers << '<partner:triggerUserEmail>true</partner:triggerUserEmail>' if trigger_user_email
         extra_headers << '<partner:triggerOtherEmail>true</partner:triggerOtherEmail>' if trigger_other_email
         extra_headers << '<partner:triggerAutoResponseEmail>true</partner:triggerAutoResponseEmail>' if trigger_auto_response_email
-        
+
         extra_headers << '</partner:EmailHeader>'
       end
 
       # Fill in the blanks of the SOAP envelope with our
       # session ID and the expanded XML of our request.
       request = (Envelope % [@session_id, @batch_size, extra_headers, expanded])
-      
+
       # reset the batch size for the next request
       @batch_size = DEFAULT_BATCH_SIZE
 
@@ -209,4 +253,3 @@ module RForce
     end
   end
 end
-

data/lib/rforce/soap_pullable.rb

@@ -1,4 +1,4 @@
-require 'facets/openhash'
+require 'rforce/method_keys'
 
 module RForce
   module SoapPullable
@@ -19,7 +19,7 @@ module RForce
         return
       end
 
-      @stack.push OpenHash.new({})
+      @stack.push(MethodHash.new)
     end
 
     def text(data)

data/lib/rforce/soap_response_expat.rb

@@ -4,6 +4,7 @@ require 'rforce/soap_pullable'
 module RForce
   class SoapResponseExpat
     include SoapPullable
+    include MethodKeys
 
     def initialize(content)
       @content = content
@@ -12,7 +13,7 @@ module RForce
     def parse
       @current_value = nil
       @stack = []
-      @parsed = OpenHash.new({})
+      @parsed = {}
       @done = false
       @namespaces = []
 

data/lib/rforce/soap_response_hpricot.rb

@@ -37,7 +37,7 @@ module RForce
       end
 
       # Convert nodes with children into MethodHashes.
-      elements = OpenHash.new({})
+      elements = MethodHash.new
 
       # Add all the element's children to the hash.
       children.each do |e|

data/lib/rforce/soap_response_rexml.rb

@@ -8,6 +8,7 @@ module RForce
   # object whose methods correspond to nested XML elements.
   class SoapResponseRexml
     include SoapPullable
+    include MethodKeys
 
     %w(attlistdecl cdata comment doctype doctype_end elementdecl
        entity entitydecl instruction notationdecl xmldecl).each do |unused|
@@ -17,17 +18,17 @@ module RForce
     def initialize(content)
       @content = content
     end
-    
+
     # Parses an XML string into structured data.
     def parse
       @current_value = nil
       @stack = []
-      @parsed = OpenHash.new({})
+      @parsed = {}
       @done = false
       @namespaces = []
 
       REXML::Document.parse_stream @content, self
-      
+
       @parsed
     end
   end

data/lib/rforce/version.rb

@@ -1,3 +1,3 @@
 module RForce
-  VERSION = '0.4.1'
+  VERSION = '0.5'
 end

data/spec/rforce_spec.rb

@@ -1,5 +1,25 @@
 require 'spec_helper'
 
+describe MethodKeys do
+  it 'lets you access hash keys with methods' do
+    h = {:foo => :bar}
+    class << h; include MethodKeys; end
+
+    h.foo.should == :bar
+    h.nonexistent.should be_nil
+  end
+  
+  it 'provides a Hash-like class' do
+    mh = MethodHash.new
+    mh[:one] = 1
+    mh[:ten] = 10
+
+    mh.one.should == 1
+    mh.ten.should == 10
+    mh.nothing.should be_nil
+  end
+end
+
 describe 'expand' do
   it 'turns Ruby into XML' do
     xmlns = 'urn:partner.soap.sforce.com'
@@ -35,7 +55,7 @@ describe 'a SoapResponse implementation' do
 
       results = begin
         klass = RForce.const_get name
-        klass.new(@contents).parse.queryResponse.result.records
+        klass.new(@contents).parse.queryResponse[:result][:records]
       rescue NameError
         nil
       end
@@ -76,7 +96,7 @@ describe 'a SoapResponse implementation' do
     pending 'expat not installed' unless @expat_recs
     @expat_recs.first.Description.should == expected
 
-    pending 'hpricot not installed' unless @hpricot
+    pending 'hpricot not installed' unless @hpricot_recs
     @hpricot_recs.first.Description.should == expected
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rforce
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  hash: 1
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  version: "0.5"
 platform: ruby
 authors: 
 - Ian Dees
@@ -9,49 +14,55 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-12 00:00:00 -08:00
+date: 2010-12-11 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.0.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: facets
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "2.4"
-    version: 
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
         version: "1.3"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.5.0
-    version: 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id003
 description: RForce is a simple, usable binding to the SalesForce API.
 email: 
 - undees@gmail.com
@@ -92,21 +103,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: rforce
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: RForce is a simple, usable binding to the SalesForce API.