restforce 0.1.10 → 1.0.0

data/Gemfile

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in restforce.gemspec
 gemspec
 
+gem 'rake'
 gem 'jruby-openssl', :platforms => :jruby

data/README.md

@@ -1,4 +1,6 @@
-# Restforce [![travis-ci](https://secure.travis-ci.org/ejholmes/restforce.png)](https://secure.travis-ci.org/ejholmes/restforce) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/ejholmes/restforce)
+# Restforce
+
+[![travis-ci](https://secure.travis-ci.org/ejholmes/restforce.png)](https://secure.travis-ci.org/ejholmes/restforce) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/ejholmes/restforce) [![Dependency Status](https://gemnasium.com/ejholmes/restforce.png)](https://gemnasium.com/ejholmes/restforce)
 
 Restforce is a ruby gem for the [Salesforce REST api](http://www.salesforce.com/us/developer/docs/api_rest/index.htm).
 It's meant to be a lighter weight alternative to the [databasedotcom gem](https://github.com/heroku/databasedotcom) that offers
@@ -10,7 +12,6 @@ Features include:
 * Support for interacting with multiple users from different orgs.
 * Support for parent-to-child relationships.
 * Support for aggregate queries.
-* Remove the need to materialize constants.
 * Support for the [Streaming API](#streaming)
 * Support for blob data types.
 * Support for GZIP compression.
@@ -140,6 +141,25 @@ _See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_que
 
 * * *
 
+### find(sobject, id, field=nil)
+
+Finds the record with the specified id and the specified sobject type and
+returns all fields for the sobject. An external id field can be used instead
+of the default Id field by specifiying the name of the external id field as the
+last parameter.
+
+```ruby
+client.find('Account', '001D000000INjVe')
+# => #<Restforce::SObject Id="001D000000INjVe" Name="Test" LastModifiedBy="005G0000002f8FHIAY" ... >
+
+client.find('Account', '1234', 'Some_External_Id_Field__c')
+# => #<Restforce::SObject Id="001D000000INjVe" Name="Test" LastModifiedBy="005G0000002f8FHIAY" ... >
+```
+
+_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_sobject_upsert.htm_
+
+* * *
+
 ### search(sosl)
 
 Performs a sosl query and returns the result. The result will be a
@@ -319,8 +339,7 @@ Restforce supports the [Streaming API](http://wiki.developerforce.com/page/Getti
 pub/sub with Salesforce a trivial task:
 
 ```ruby
-# Restforce uses faye as the underlying implementation for CometD. I recommend
-# using faye 0.8.3.
+# Restforce uses faye as the underlying implementation for CometD.
 require 'faye'
 
 # Initialize a client with your username/password/oauth token/etc.

data/lib/restforce/client/api.rb

@@ -191,7 +191,7 @@ module Restforce
       # Returns the Id of the newly created record if the record was created.
       # Raises an error if something bad happens.
       def upsert!(sobject, field, attrs)
-        external_id = attrs.has_key?(field.to_sym) ? attrs.delete(field.to_sym) : attrs.delete(field.to_s)
+        external_id = attrs.delete(attrs.keys.find { |k| k.to_s.downcase == field.to_s.downcase })
         response = api_patch "sobjects/#{sobject}/#{field.to_s}/#{external_id}", attrs
         (response.body && response.body['id']) ? response.body['id'] : true
       end
@@ -219,6 +219,18 @@ module Restforce
         true
       end
 
+      # Public: Finds a single record and returns all fields.
+      #
+      # sobject - The String name of the sobject.
+      # id      - The id of the record. If field is specified, id should be the id
+      #           of the external field.
+      # field   - External ID field to use (default: nil).
+      #
+      # Returns the Restforce::SObject sobject record.
+      def find(sobject, id, field=nil)
+        api_get(field ? "sobjects/#{sobject}/#{field}/#{id}" : "sobjects/#{sobject}/#{id}").body
+      end
+
     private
 
       # Internal: Returns a path to an api endpoint

data/lib/restforce/client/connection.rb

@@ -20,18 +20,31 @@ module Restforce
       # Internal: Internal faraday connection where all requests go through
       def connection
         @connection ||= Faraday.new(@options[:instance_url]) do |builder|
+          # Parses JSON into Hashie::Mash structures.
           builder.use      Restforce::Middleware::Mashify, self, @options
+          # Handles multipart file uploads for blobs.
           builder.use      Restforce::Middleware::Multipart
+          # Converts the request into JSON.
           builder.request  :json
+          # Handles reauthentication for 403 responses.
           builder.use      authentication_middleware, self, @options if authentication_middleware
+          # Sets the oauth token in the headers.
           builder.use      Restforce::Middleware::Authorization, self, @options
+          # Ensures the instance url is set.
           builder.use      Restforce::Middleware::InstanceURL, self, @options
+          # Parses returned JSON response into a hash.
           builder.response :json
+          # Caches GET requests.
           builder.use      Restforce::Middleware::Caching, cache, @options if cache
+          # Follows 30x redirects.
           builder.use      FaradayMiddleware::FollowRedirects
+          # Raises errors for 40x responses.
           builder.use      Restforce::Middleware::RaiseError
+          # Log request/responses
           builder.use      Restforce::Middleware::Logger, Restforce.configuration.logger, @options if Restforce.log?
+          # Compress/Decompress the request/response
           builder.use      Restforce::Middleware::Gzip, self, @options
+
           builder.adapter  Faraday.default_adapter
         end
       end

data/lib/restforce/client/streaming.rb

@@ -4,12 +4,12 @@ module Restforce
 
       # Public: Subscribe to a PushTopic
       #
-      # channel - The name of the PushTopic channel to subscribe to.
-      # block   - A block to run when a new message is received.
+      # channels - The name of the PushTopic channel(s) to subscribe to.
+      # block    - A block to run when a new message is received.
       #
       # Returns a Faye::Subscription
-      def subscribe(channel, &block)
-        faye.subscribe "/topic/#{channel}", &block
+      def subscribe(channels, &block)
+        faye.subscribe Array(channels).map { |channel| "/topic/#{channel}" }, &block
       end
 
       # Public: Faye client to use for subscribing to PushTopics

data/lib/restforce/config.rb

@@ -67,7 +67,7 @@ module Restforce
     attr_accessor :compress
 
     def initialize
-      @api_version            ||= '24.0'
+      @api_version            ||= '26.0'
       @host                   ||= 'login.salesforce.com'
       @authentication_retries ||= 3
     end

data/lib/restforce/middleware/multipart.rb

@@ -33,16 +33,16 @@ module Restforce
 
     def create_multipart(env, params)
       boundary = env[:request][:boundary]
-
       parts = []
-      skip  = []
-      params.each do |key, value|
-        if value.respond_to? :content_type
-          parts << Faraday::Parts::Part.new(boundary, key.to_s, value); skip << key
-        end
+
+      # Fields
+      parts << Faraday::Parts::Part.new(boundary, 'entity_content', params.reject { |k,v| v.respond_to? :content_type }.to_json)
+
+      # Files
+      params.each do |k,v|
+        parts << Faraday::Parts::Part.new(boundary, k.to_s, v) if v.respond_to? :content_type
       end
-      parts << Faraday::Parts::Part.new(boundary, 'entity_content', params.reject { |key, _| skip.include? key }.to_json)
-      parts.reverse!
+
       parts << Faraday::Parts::EpiloguePart.new(boundary)
 
       body = Faraday::CompositeReadIO.new(parts)

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '0.1.10'
+  VERSION = '1.0.0'
 end

data/restforce.gemspec

@@ -15,14 +15,13 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Restforce::VERSION
 
-  gem.add_dependency 'rake'
   gem.add_dependency 'faraday', '~> 0.8.4'
-  gem.add_dependency 'faraday_middleware', '~> 0.8.8'
+  gem.add_dependency 'faraday_middleware', '>= 0.8.8'
   gem.add_dependency 'json', '~> 1.7.5'
   gem.add_dependency 'hashie', '~> 1.2.0'
 
   gem.add_development_dependency 'rspec', '~> 2.12.0'
   gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'faye', '0.8.3' unless RUBY_PLATFORM == 'java'
+  gem.add_development_dependency 'faye' unless RUBY_PLATFORM == 'java'
 end

data/spec/fixtures/sobject/query_paginated_first_page_response.json

@@ -1,7 +1,7 @@
 {
   "totalSize" : 2,
   "done" : false,
-  "nextRecordsUrl" : "/services/data/v24.0/query/01gD",
+  "nextRecordsUrl" : "/services/data/v26.0/query/01gD",
   "records" : [ {
     "attributes" : {
       "type" : "Whizbang",

data/spec/lib/client_spec.rb

@@ -50,31 +50,22 @@ shared_examples_for 'methods' do
 
     context 'without required options for authentication middleware to be provided' do
       let(:client_options) { {} }
-
       it { should be_nil }
     end
 
     context 'with username, password, security token, client id and client secret provided' do
       let(:client_options) { password_options }
-
       it { should eq Restforce::Middleware::Authentication::Password }
     end
 
     context 'with refresh token, client id and client secret provided' do
       let(:client_options) { oauth_options }
-
       it { should eq Restforce::Middleware::Authentication::Token }
     end
   end
 
   describe '.list_sobjects' do
-    before do
-      @request = stub_api_request :sobjects, :with => 'sobject/describe_sobjects_success_response'
-    end
-
-    after do
-      expect(@request).to have_been_requested
-    end
+    requests :sobjects, :fixture => 'sobject/describe_sobjects_success_response'
 
     subject { client.list_sobjects }
     it { should be_an Array }
@@ -83,28 +74,14 @@ shared_examples_for 'methods' do
 
   describe '.describe' do
     context 'with no arguments' do
-      before do
-        @request = stub_api_request :sobjects,
-          :with => 'sobject/describe_sobjects_success_response'
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests :sobjects, :fixture => 'sobject/describe_sobjects_success_response'
 
       subject { client.describe }
       it { should be_an Array }
     end
 
     context 'with an argument' do
-      before do
-        @request = stub_api_request 'sobjects/Whizbang/describe',
-          :with => 'sobject/sobject_describe_success_response'
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests 'sobjects/Whizbang/describe', :fixture => 'sobject/sobject_describe_success_response'
 
       subject { client.describe('Whizbang') }
       its(['name']) { should eq 'Whizbang' }
@@ -112,28 +89,14 @@ shared_examples_for 'methods' do
   end
 
   describe '.query' do
-    before do
-      @request = stub_api_request 'query\?q=SELECT%20some,%20fields%20FROM%20object',
-        :with => 'sobject/query_success_response'
-    end
-
-    after do
-      expect(@request).to have_been_requested
-    end
+    requests 'query\?q=SELECT%20some,%20fields%20FROM%20object', :fixture => 'sobject/query_success_response'
 
     subject { client.query('SELECT some, fields FROM object') }
     it { should be_an Array }
   end
 
   describe '.search' do
-    before do
-      @request = stub_api_request 'search\?q=FIND%20%7Bbar%7D',
-        :with => 'sobject/search_success_response'
-    end
-
-    after do
-      expect(@request).to have_been_requested
-    end
+    requests 'search\?q=FIND%20%7Bbar%7D', :fixture => 'sobject/search_success_response'
 
     subject { client.search('FIND {bar}') }
     it { should be_an Array }
@@ -141,14 +104,7 @@ shared_examples_for 'methods' do
   end
 
   describe '.org_id' do
-    before do
-      @request = stub_api_request 'query\?q=select%20id%20from%20Organization',
-        :with => 'sobject/org_query_response'
-    end
-
-    after do
-      expect(@request).to have_been_requested
-    end
+    requests 'query\?q=select%20id%20from%20Organization', :fixture => 'sobject/org_query_response'
 
     subject { client.org_id }
     it { should eq '00Dx0000000BV7z' }
@@ -156,32 +112,20 @@ shared_examples_for 'methods' do
 
   describe '.create' do
     context 'without multipart' do
-      before do
-        @request = stub_api_request 'sobjects/Account',
-          :with => 'sobject/create_success_response',
-          :method => :post,
-          :body => "{\"Name\":\"Foobar\"}"
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests 'sobjects/Account',
+        :method => :post,
+        :with_body => "{\"Name\":\"Foobar\"}",
+        :fixture => 'sobject/create_success_response'
 
       subject { client.create('Account', :Name => 'Foobar') }
       it { should eq 'some_id' }
     end
 
     context 'with multipart' do
-      before do
-        @request = stub_api_request 'sobjects/Account',
-          :with => 'sobject/create_success_response',
-          :method => :post,
-          :body => %r(----boundary_string\r\nContent-Disposition: form-data; name=\"entity_content\";\r\nContent-Type: application/json\r\n\r\n{\"Name\":\"Foobar\"}\r\n----boundary_string\r\nContent-Disposition: form-data; name=\"Blob\"; filename=\"blob.jpg\"\r\nContent-Length: 42171\r\nContent-Type: image/jpeg\r\nContent-Transfer-Encoding: binary)
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests 'sobjects/Account',
+        :method => :post,
+        :with_body => %r(----boundary_string\r\nContent-Disposition: form-data; name=\"entity_content\";\r\nContent-Type: application/json\r\n\r\n{\"Name\":\"Foobar\"}\r\n----boundary_string\r\nContent-Disposition: form-data; name=\"Blob\"; filename=\"blob.jpg\"\r\nContent-Length: 42171\r\nContent-Type: image/jpeg\r\nContent-Transfer-Encoding: binary),
+        :fixture => 'sobject/create_success_response'
 
       subject { client.create('Account', :Name => 'Foobar', :Blob => Restforce::UploadIO.new(File.expand_path('../../fixtures/blob.jpg', __FILE__), 'image/jpeg')) }
       it { should eq 'some_id' }
@@ -190,17 +134,11 @@ shared_examples_for 'methods' do
 
   describe '.update!' do
     context 'with invalid Id' do
-      before do
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe',
-          :with => 'sobject/delete_error_response',
-          :method => :patch,
-          :body => "{\"Name\":\"Foobar\"}",
-          :status => 404
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests 'sobjects/Account/001D000000INjVe',
+        :method => :patch,
+        :with_body => "{\"Name\":\"Foobar\"}",
+        :status => 404,
+        :fixture => 'sobject/delete_error_response'
 
       subject { client.update!('Account', :Id => '001D000000INjVe', :Name => 'Foobar') }
       specify { expect { subject }.to raise_error Faraday::Error::ResourceNotFound }
@@ -214,61 +152,35 @@ shared_examples_for 'methods' do
     end
 
     context 'with invalid Id' do
-      before do
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe',
-          :with => 'sobject/delete_error_response',
-          :method => :patch,
-          :body => "{\"Name\":\"Foobar\"}",
-          :status => 404
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests 'sobjects/Account/001D000000INjVe',
+        :method => :patch,
+        :with_body => "{\"Name\":\"Foobar\"}",
+        :status => 404,
+        :fixture => 'sobject/delete_error_response'
 
       subject { client.update('Account', :Id => '001D000000INjVe', :Name => 'Foobar') }
       it { should be_false }
     end
 
     context 'with success' do
-      before do
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe',
-          :method => :patch,
-          :body => "{\"Name\":\"Foobar\"}"
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
-
-      context 'with symbol Id key' do
-        subject { client.update('Account', :Id => '001D000000INjVe', :Name => 'Foobar') }
-        it { should be_true }
-      end
-
-      context 'with string Id key' do
-        subject { client.update('Account', 'Id' => '001D000000INjVe', 'Name' => 'Foobar') }
-        it { should be_true }
-      end
-
-      context 'with a lower case id' do
-        subject { client.update('Account', 'id' => '001D000000INjVe', 'Name' => 'Foobar') }
-        it { should be_true }
+      requests 'sobjects/Account/001D000000INjVe',
+        :method => :patch,
+        :with_body => "{\"Name\":\"Foobar\"}"
+
+      [:Id, :id, 'Id', 'id'].each do |key|
+        context "with #{key.inspect} as the key" do
+          subject { client.update('Account', key => '001D000000INjVe', :Name => 'Foobar') }
+          it { should be_true }
+        end
       end
     end
   end
 
   describe '.upsert!' do
     context 'when updated' do
-      before do
-        @request = stub_api_request 'sobjects/Account/External__c/foobar',
-          :method => :patch,
-          :body => "{\"Name\":\"Foobar\"}"
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests 'sobjects/Account/External__c/foobar',
+        :method => :patch,
+        :with_body => "{\"Name\":\"Foobar\"}"
 
       context 'with symbol external Id key' do
         subject { client.upsert!('Account', 'External__c', :External__c => 'foobar', :Name => 'Foobar') }
@@ -282,25 +194,16 @@ shared_examples_for 'methods' do
     end
 
     context 'when created' do
-      before do
-        @request = stub_api_request 'sobjects/Account/External__c/foobar',
-          :method => :patch,
-          :body => "{\"Name\":\"Foobar\"}",
-          :with => 'sobject/upsert_created_success_response'
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
-
-      context 'with symbol external Id key' do
-        subject { client.upsert!('Account', 'External__c', :External__c => 'foobar', :Name => 'Foobar') }
-        it { should eq 'foo' }
-      end
-
-      context 'with string external Id key' do
-        subject { client.upsert!('Account', 'External__c', 'External__c' => 'foobar', 'Name' => 'Foobar') }
-        it { should eq 'foo' }
+      requests 'sobjects/Account/External__c/foobar',
+        :method => :patch,
+        :with_body => "{\"Name\":\"Foobar\"}",
+        :fixture => 'sobject/upsert_created_success_response'
+
+      [:External__c, 'External__c', :external__c, 'external__c'].each do |key|
+        context "with #{key.inspect} as the external id" do
+          subject { client.upsert!('Account', 'External__c', key => 'foobar', :Name => 'Foobar') }
+          it { should eq 'foo' }
+        end
       end
     end
   end
@@ -309,28 +212,16 @@ shared_examples_for 'methods' do
     subject { client.destroy!('Account', '001D000000INjVe') }
 
     context 'with invalid Id' do
-      before do
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe',
-          :with => 'sobject/delete_error_response',
-          :method => :delete,
-          :status => 404
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests 'sobjects/Account/001D000000INjVe',
+        :fixture => 'sobject/delete_error_response',
+        :method => :delete,
+        :status => 404
 
       specify { expect { subject }.to raise_error Faraday::Error::ResourceNotFound }
     end
 
     context 'with success' do
-      before do 
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe', :method => :delete
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests 'sobjects/Account/001D000000INjVe', :method => :delete
 
       it { should be_true }
     end
@@ -340,36 +231,42 @@ shared_examples_for 'methods' do
     subject { client.destroy('Account', '001D000000INjVe') }
 
     context 'with invalid Id' do
-      before do
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe',
-          :with => 'sobject/delete_error_response',
-          :method => :delete,
-          :status => 404
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests 'sobjects/Account/001D000000INjVe',
+        :fixture => 'sobject/delete_error_response',
+        :method => :delete,
+        :status => 404
 
       it { should be_false }
     end
 
     context 'with success' do
-      before do 
-        @request = stub_api_request 'sobjects/Account/001D000000INjVe', :method => :delete
-      end
-
-      after do
-        expect(@request).to have_been_requested
-      end
+      requests 'sobjects/Account/001D000000INjVe', :method => :delete
 
       it { should be_true }
     end
   end
 
+  describe '.find' do
+    context 'with no external id passed' do
+      requests 'sobjects/Account/001D000000INjVe',
+        :fixture => 'sobject/sobject_find_success_response'
+
+      subject { client.find('Account', '001D000000INjVe') }
+      it { should be_a Hash }
+    end
+
+    context 'when an external id is passed' do
+      requests 'sobjects/Account/External_Field__c/1234',
+        :fixture => 'sobject/sobject_find_success_response'
+
+      subject { client.find('Account', '1234', 'External_Field__c') }
+      it { should be_a Hash }
+    end
+  end
+
   describe '.authenticate!' do
     before do
-      @request = stub_login_request(:body => "grant_type=password&client_id=client_id&client_secret=" \
+      @request = stub_login_request(:with_body => "grant_type=password&client_id=client_id&client_secret=" \
         "client_secret&username=foo&password=barsecurity_token").
         to_return(:status => 200, :body => fixture(:auth_success_response))
     end
@@ -424,45 +321,69 @@ shared_examples_for 'methods' do
   end
 
   describe '.without_caching' do
-    let(:cache) { MockCache.new }
+    requests 'query\?q=SELECT%20some,%20fields%20FROM%20object',
+      :fixture => 'sobject/query_success_response'
 
     before do
-      @request = stub_api_request 'query\?q=SELECT%20some,%20fields%20FROM%20object',
-        :with => 'sobject/query_success_response'
       cache.should_receive(:delete).and_call_original
       cache.should_receive(:fetch).and_call_original
     end
 
-    after do
-      expect(@request).to have_been_requested
-    end
-
+    let(:cache) { MockCache.new }
     subject { client.without_caching { client.query('SELECT some, fields FROM object') } }
     it { should be_an Array }
   end
 
-  describe '.faye' do
-    subject { client.send(:faye) }
+  unless RUBY_PLATFORM == 'java'
+    describe '.faye', :eventmachine => true do
+      subject { client.faye }
 
-    context 'with missing instance url' do
-      let(:instance_url) { nil }
-      specify { expect { subject }.to raise_error RuntimeError, 'Instance URL missing. Call .authenticate! first.' }
+      context 'with missing instance url' do
+        let(:instance_url) { nil }
+        specify { expect { subject }.to raise_error RuntimeError, 'Instance URL missing. Call .authenticate! first.' }
+      end
+
+      context 'with oauth token and instance url' do
+        let(:instance_url) { 'http://google.com' }
+        let(:oauth_token) { 'bar' }
+        specify { expect { subject }.to_not raise_error }
+      end
+
+      context 'when the connection goes down' do
+        it 'should reauthenticate' do
+          access_token = double('access token')
+          access_token.stub(:access_token).and_return('token')
+          client.should_receive(:authenticate!).and_return(access_token)
+          client.faye.should_receive(:set_header).with('Authorization', "OAuth token")
+          client.faye.trigger('transport:down')
+        end
+      end
     end
 
-    context 'with oauth token and instance url' do
-      let(:instance_url) { 'http://foobar' }
-      let(:oauth_token) { 'bar' }
-      specify { expect { subject }.to_not raise_error }
+    describe '.subcribe', :eventmachine => true do
+      context 'when given a single pushtopic' do
+        it 'subscribes to the pushtopic' do
+          client.faye.should_receive(:subscribe).with(['/topic/PushTopic'])
+          client.subscribe('PushTopic')
+        end
+      end
+
+      context 'when given an array of pushtopics' do
+        it 'subscribes to each pushtopic' do
+          client.faye.should_receive(:subscribe).with(['/topic/PushTopic1', '/topic/PushTopic2'])
+          client.subscribe(['PushTopic1', 'PushTopic2'])
+        end
+      end
     end
-  end unless RUBY_PLATFORM == 'java'
+  end
 
   describe 'authentication retries' do
     context 'when retries reaches 0' do
       before do
         @auth_request = stub_api_request('query\?q=SELECT%20some,%20fields%20FROM%20object',
           :status => 401,
-          :with => 'expired_session_response')
-        @query_request = stub_login_request(:body => "grant_type=password&client_id=client_id&client_secret=" \
+          :fixture => 'expired_session_response')
+        @query_request = stub_login_request(:with_body => "grant_type=password&client_id=client_id&client_secret=" \
           "client_secret&username=foo&password=barsecurity_token").
           to_return(:status => 200, :body => fixture(:auth_success_response))
       end
@@ -481,7 +402,7 @@ shared_examples_for 'methods' do
         to_return(:status => 401, :body => fixture('expired_session_response')).then.
         to_return(:status => 200, :body => fixture('sobject/query_success_response'))
 
-      @login = stub_login_request(:body => "grant_type=password&client_id=client_id&client_secret=" \
+      @login = stub_login_request(:with_body => "grant_type=password&client_id=client_id&client_secret=" \
         "client_secret&username=foo&password=barsecurity_token").
         to_return(:status => 200, :body => fixture(:auth_success_response))
     end
@@ -509,16 +430,8 @@ describe 'with mashify middleware' do
 
     describe '.query' do
       context 'with pagination' do
-        before do
-          @requests = [].tap do |requests|
-            requests << stub_api_request('query\?q', :with => 'sobject/query_paginated_first_page_response')
-            requests << stub_api_request('query/01gD', :with => 'sobject/query_paginated_last_page_response')
-          end
-        end
-
-        after do
-          @requests.each { |request| expect(request).to have_been_requested }
-        end
+        requests 'query\?q', :fixture => 'sobject/query_paginated_first_page_response'
+        requests 'query/01gD', :fixture => 'sobject/query_paginated_last_page_response'
 
         subject { client.query('SELECT some, fields FROM object').next_page }
         it { should be_a Restforce::Collection }

data/spec/lib/collection_spec.rb

@@ -18,11 +18,8 @@ describe Restforce::Collection do
       specify { expect(subject.instance_variable_get(:@client)).to eq client }
 
       describe 'each record' do
-        it 'should be a Restforce::SObject' do
-          records.each do |record|
-            expect(record).to be_a Restforce::SObject
-          end
-        end
+        subject { records }
+        it { should be_all { |record| expect(record).to be_a Restforce::SObject } }
       end
     end
 
@@ -34,7 +31,7 @@ describe Restforce::Collection do
       it               { should respond_to :each }
       its(:size)       { should eq 1 }
       its(:total_size) { should eq 2 }
-      its(:next_page_url)  { should eq '/services/data/v24.0/query/01gD' }
+      its(:next_page_url)  { should eq "/services/data/v#{Restforce.configuration.api_version}/query/01gD" }
       specify { expect(subject.instance_variable_get(:@client)).to eq client }
 
       describe '.next_page' do

data/spec/lib/config_spec.rb

@@ -11,7 +11,7 @@ describe Restforce do
     it { should be_a Restforce::Configuration }
 
     context 'by default' do
-      its(:api_version)            { should eq '24.0' }
+      its(:api_version)            { should eq '26.0' }
       its(:host)                   { should eq 'login.salesforce.com' }
       its(:authentication_retries) { should eq 3 }
       [:username, :password, :security_token, :client_id, :client_secret,

data/spec/lib/sobject_spec.rb

@@ -53,16 +53,13 @@ describe Restforce::SObject do
     end
 
     context 'when an Id is present' do
+      requests 'sobjects/Whizbang/001D000000INjVe',
+        :method => :patch,
+        :with_body => "{\"Checkbox_Label\":false,\"Text_Label\":\"Hi there!\",\"Date_Label\":\"2010-01-01\"," +
+        "\"DateTime_Label\":\"2011-07-07T00:37:00.000+0000\",\"Picklist_Multiselect_Label\":\"four;six\"}"
+
       before do
         hash.merge!(:Id => '001D000000INjVe')
-        @request = stub_api_request 'sobjects/Whizbang/001D000000INjVe',
-          :method => :patch,
-          :body => "{\"Checkbox_Label\":false,\"Text_Label\":\"Hi there!\",\"Date_Label\":\"2010-01-01\"," +
-          "\"DateTime_Label\":\"2011-07-07T00:37:00.000+0000\",\"Picklist_Multiselect_Label\":\"four;six\"}"
-      end
-
-      after do
-        expect(@request).to have_been_requested
       end
 
       specify { expect { subject }.to_not raise_error }
@@ -73,16 +70,13 @@ describe Restforce::SObject do
     subject { sobject.save! }
 
     context 'when an exception is raised' do
+      requests 'sobjects/Whizbang/001D000000INjVe',
+        :fixture => 'sobject/delete_error_response',
+        :method => :patch,
+        :status => 404
+
       before do
         hash.merge!(:Id => '001D000000INjVe')
-        @request = stub_api_request 'sobjects/Whizbang/001D000000INjVe',
-          :with => 'sobject/delete_error_response',
-          :method => :patch,
-          :status => 404
-      end
-
-      after do
-        expect(@request).to have_been_requested
       end
 
       specify { expect { subject }.to raise_error Faraday::Error::ResourceNotFound }
@@ -97,13 +91,10 @@ describe Restforce::SObject do
     end
 
     context 'when an Id is present' do
+      requests 'sobjects/Whizbang/001D000000INjVe', :method => :delete
+
       before do 
         hash.merge!(:Id => '001D000000INjVe')
-        @request = stub_api_request 'sobjects/Whizbang/001D000000INjVe', :method => :delete
-      end
-
-      after do
-        expect(@request).to have_been_requested
       end
 
       specify { expect { subject }.to_not raise_error }
@@ -114,16 +105,13 @@ describe Restforce::SObject do
     subject { sobject.destroy! }
 
     context 'when an exception is raised' do
+      requests 'sobjects/Whizbang/001D000000INjVe',
+        :fixture => 'sobject/delete_error_response',
+        :method => :delete,
+        :status => 404
+
       before do
         hash.merge!(:Id => '001D000000INjVe')
-        @request = stub_api_request 'sobjects/Whizbang/001D000000INjVe',
-          :with => 'sobject/delete_error_response',
-          :method => :delete,
-          :status => 404
-      end
-
-      after do
-        expect(@request).to have_been_requested
       end
 
       specify { expect { subject }.to raise_error Faraday::Error::ResourceNotFound }
@@ -131,14 +119,8 @@ describe Restforce::SObject do
   end
 
   describe '.describe' do
-    before do
-      @request = stub_api_request 'sobjects/Whizbang/describe',
-        :with => 'sobject/sobject_describe_success_response'
-    end
-
-    after do
-      expect(@request).to have_been_requested
-    end
+    requests 'sobjects/Whizbang/describe',
+      :fixture => 'sobject/sobject_describe_success_response'
 
     subject { sobject.describe }
     it { should be_a Hash }

data/spec/spec_helper.rb

@@ -14,5 +14,11 @@ WebMock.disable_net_connect!
 Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}
 
 RSpec.configure do |config|
-  config.include FixtureHelpers
+  config.around :eventmachine => true do |example|
+    EM.run {
+      example.run
+      EM.stop
+    }
+  end
 end
+

data/spec/support/fixture_helpers.rb

@@ -1,31 +1,45 @@
 module FixtureHelpers
+  module InstanceMethods
 
-  def stub_api_request(endpoint, options = {})
-    options = {
-      :method => :get,
-      :status => 200,
-      :api_version => '24.0',
-      :with => nil
-    }.merge(options)
-
-    stub = stub_request(options[:method], %r{/services/data/v#{options[:api_version]}/#{endpoint}})
-    stub = stub.with(:body => options[:body]) if options[:body] && !RUBY_VERSION.match(/^1.8/)
-    stub = stub.to_return(:status => options[:status], :body => fixture(options[:with])) if options[:with]
-    stub
-  end
+    def stub_api_request(endpoint, options={})
+      options = {
+        :method => :get,
+        :status => 200,
+        :api_version => Restforce.configuration.api_version
+      }.merge(options)
+
+      stub = stub_request(options[:method], %r{/services/data/v#{options[:api_version]}/#{endpoint}})
+      stub = stub.with(:body => options[:with_body]) if options[:with_body] && !RUBY_VERSION.match(/^1.8/)
+      stub = stub.to_return(:status => options[:status], :body => fixture(options[:fixture])) if options[:fixture]
+      stub
+    end
+
+    def stub_login_request(options={})
+      stub = stub_request(:post, "https://login.salesforce.com/services/oauth2/token")
+      stub = stub.with(:body => options[:with_body]) if options[:with_body] && !RUBY_VERSION.match(/^1.8/)
+      stub
+    end
 
-  def stub_login_request(options = {})
-    options = {
-      :body => nil
-    }.merge(options)
+    def fixture(f)
+      File.read(File.expand_path("../../fixtures/#{f}.json", __FILE__))
+    end
 
-    stub = stub_request(:post, "https://login.salesforce.com/services/oauth2/token")
-    stub = stub.with(:body => options[:body]) if options[:body] && !RUBY_VERSION.match(/^1.8/)
-    stub
   end
 
-  def fixture(f)
-    File.read(File.expand_path("../../fixtures/#{f}.json", __FILE__))
+  module ClassMethods
+    def requests(endpoint, options={})
+      before do
+        (@requests ||= []) << stub_api_request(endpoint, options)
+      end
+
+      after do
+        @requests.each { |request| expect(request).to have_been_requested }
+      end
+    end
   end
+end
 
+RSpec.configure do |config|
+  config.include FixtureHelpers::InstanceMethods
+  config.extend FixtureHelpers::ClassMethods
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-14 00:00:00.000000000 Z
+date: 2012-12-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -48,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.8
   type: :runtime
@@ -56,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.8
 - !ruby/object:Gem::Dependency
@@ -144,17 +128,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '0'
 description: A lightweight ruby client for the Salesforce REST api.
 email:
 - eric@ejholmes.net