restforce 1.3.0 → 1.4.0

data/spec/integration/data/client_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+shared_examples_for Restforce::Data::Client do
+  describe '.picklist_values' do
+    requests 'sobjects/Account/describe',
+      :fixture => 'sobject/sobject_describe_success_response'
+
+    context 'when given a picklist field' do
+      subject { client.picklist_values('Account', 'Picklist_Field') }
+      it { should be_an Array }
+      its(:length) { should eq 3 }
+      it { should include_picklist_values ['one', 'two', 'three'] }
+    end
+
+    context 'when given a multipicklist field' do
+      subject { client.picklist_values('Account', 'Picklist_Multiselect_Field') }
+      it { should be_an Array }
+      its(:length) { should eq 3 }
+      it { should include_picklist_values ['four', 'five', 'six'] }
+    end
+
+    describe 'dependent picklists' do
+      context 'when given a picklist field that has a dependency' do
+        subject { client.picklist_values('Account', 'Dependent_Picklist_Field', :valid_for => 'one') }
+        it { should be_an Array }
+        its(:length) { should eq 2 }
+        it { should include_picklist_values ['seven', 'eight'] }
+        it { should_not include_picklist_values ['nine'] }
+      end
+
+      context 'when given a picklist field that does not have a dependency' do
+        subject { client.picklist_values('Account', 'Picklist_Field', :valid_for => 'one') }
+        it 'raises an exception' do
+          expect { subject }.to raise_error(/Picklist_Field is not a dependent picklist/)
+        end
+      end
+    end
+  end
+
+  describe '.faye', :event_machine => 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.' }
+    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
+
+  describe '.subcribe', :event_machine => 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
+
+describe Restforce::Data::Client do
+  describe 'with mashify' do
+    it_behaves_like Restforce::Client
+  end
+
+  describe 'without mashify', :mashify => false do
+    it_behaves_like Restforce::Client
+  end
+end

data/spec/spec_helper.rb

@@ -12,17 +12,3 @@ WebMock.disable_net_connect!
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}
-
-RSpec.configure do |config|
-  config.before do
-    EventMachine.stub(:connect) if defined?(EventMachine)
-  end
-
-  config.around :eventmachine => true do |example|
-    EM.run {
-      example.run
-      EM.stop
-    }
-  end
-end
-

data/spec/support/client_integration.rb

@@ -0,0 +1,45 @@
+module ClientIntegrationExampleGroup
+  def self.included(base)
+    base.class_eval do
+      let(:oauth_token)    { '00Dx0000000BV7z!AR8AQAxo9UfVkh8AlV0Gomt9Czx9LjHnSSpwBMmbRcgKFmxOtvxjTrKW19ye6PE3Ds1eQz3z8jr3W7_VbWmEu4Q8TVGSTHxs' }
+      let(:refresh_token)  { 'refresh' }
+      let(:instance_url)   { 'https://na1.salesforce.com' }
+      let(:username)       { 'foo'            }
+      let(:password)       { 'bar'            }
+      let(:security_token) { 'security_token' }
+      let(:client_id)      { 'client_id'      }
+      let(:client_secret)  { 'client_secret'  }
+      let(:cache)          { nil }
+
+      let(:base_options) do
+        {
+          :oauth_token    => oauth_token,
+          :refresh_token  => refresh_token,
+          :instance_url   => instance_url,
+          :username       => username,
+          :password       => password,
+          :security_token => security_token,
+          :client_id      => client_id,
+          :client_secret  => client_secret,
+          :cache          => cache
+        }
+      end
+
+      let(:client_options) { base_options }
+
+      subject(:client) { described_class.new client_options }
+    end
+  end
+
+  RSpec.configure do |config|
+    config.include self,
+      :example_group => {
+        :describes => lambda { |described| described <= Restforce::AbstractClient },
+        :file_path => %r{spec/integration}
+      }
+
+    config.before :mashify => false do
+      client.middleware.delete(Restforce::Middleware::Mashify)
+    end
+  end
+end

data/spec/support/concerns.rb

@@ -0,0 +1,18 @@
+module ConcernsExampleGroup
+  def self.included(base)
+    base.class_eval do
+      let(:klass) do
+        context = self
+        Class.new { include context.described_class }
+      end
+
+      let(:client) { klass.new }
+
+      subject { client }
+    end
+  end
+
+  RSpec.configure do |config|
+    config.include self, :example_group => { :file_path => %r{spec/unit/concerns} }
+  end
+end

data/spec/support/event_machine.rb

@@ -0,0 +1,14 @@
+RSpec.configure do |config|
+  config.before do
+    EventMachine.stub(:connect) if defined?(EventMachine)
+  end
+
+  config.filter_run_excluding :event_machine => true if RUBY_PLATFORM == 'java'
+
+  config.around :event_machine => true do |example|
+    EM.run {
+      example.run
+      EM.stop
+    }
+  end
+end

data/spec/support/middleware.rb

@@ -1,3 +1,21 @@
+module MiddlewareExampleGroup
+  def self.included(base)
+    base.class_eval do
+      let(:app)            { double('@app', :call => nil)            }
+      let(:env)            { { :request_headers => {}, :response_headers => {} } }
+      let(:retries)        { 3 }
+      let(:options)        { { } }
+      let(:client)         { double(Restforce::AbstractClient) }
+      subject(:middleware) { described_class.new app, client, options }
+    end
+  end
+
+  RSpec.configure do |config|
+    config.include self,
+      :example_group => { :file_path => %r{spec/unit/middleware} }
+  end
+end
+
 shared_examples_for 'authentication middleware' do
   describe '.authenticate!' do
     after do
@@ -28,6 +46,5 @@ shared_examples_for 'authentication middleware' do
         }.to raise_error Restforce::AuthenticationError, /^invalid_grant: .*/
       end
     end
-
   end
 end

data/spec/unit/abstract_client_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Restforce::AbstractClient do
+  subject { described_class }
+
+  it { should < Restforce::Concerns::Base }
+  it { should < Restforce::Concerns::Connection }
+  it { should < Restforce::Concerns::Authentication }
+  it { should < Restforce::Concerns::Caching }
+  it { should < Restforce::Concerns::API }
+end

data/spec/{lib → unit}/attachment_spec.rb

@@ -1,13 +1,10 @@
 require 'spec_helper'
 
 describe Restforce::Attachment do
-  include_context 'basic client'
-
+  let(:client)   { double(Restforce::AbstractClient) }
   let(:body_url) { '/services/data/v26.0/sobjects/Attachment/00PG0000006Hll5MAC/Body' }
-  let(:hash) { { 'Id' => '1234', 'Body' => body_url } }
-  let(:sobject) do
-    described_class.new(hash, client)
-  end
+  let(:hash)     { { 'Id' => '1234', 'Body' => body_url } }
+  let(:sobject)  { described_class.new(hash, client) }
 
   describe '.Body' do
     it 'requests the body' do

data/spec/unit/collection_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Restforce::Collection do
+  let(:client) { double(Restforce::AbstractClient) }
+
+  describe '#new' do
+    context 'without pagination' do
+      subject(:collection) do
+        described_class.new(JSON.parse(fixture('sobject/query_success_response')), client)
+      end
+
+      it                   { should respond_to :each }
+      its(:size)           { should eq 1 }
+      its(:has_next_page?) { should be_false }
+      it                   { should have_client client }
+
+      describe 'each record' do
+        it { should be_all { |record| expect(record).to be_a Restforce::SObject } }
+      end
+    end
+
+    context 'with pagination' do
+      let(:first_page)     { JSON.parse(fixture('sobject/query_paginated_first_page_response')) }
+      let(:next_page)      { JSON.parse(fixture('sobject/query_paginated_last_page_response')) }
+      subject(:collection) { described_class.new(first_page, client) }
+
+      it { should respond_to :each }
+      it { should have_client client }
+
+      context 'when only values from the first page are being requested' do
+        before { client.should_receive(:get).never }
+
+        its(:size)  { should eq 2 }
+        its(:first) { should be_a Restforce::SObject }
+      end
+
+      context 'when all of the values are being requested' do
+        before do
+          client.stub(:get).
+            and_return(stub :body => Restforce::Collection.new(next_page, client))
+        end
+
+        its(:pages)          { should be_all { |page| expect(page).to be_a Restforce::Collection } }
+        its(:has_next_page?) { should be_true }
+        it { should be_all   { |record| expect(record).to be_a Restforce::SObject } }
+        its(:next_page)      { should be_a Restforce::Collection }
+      end
+    end
+  end
+end

data/spec/unit/concerns/api_spec.rb

@@ -0,0 +1,222 @@
+require 'spec_helper'
+
+describe Restforce::Concerns::API do
+  let(:response) { double('Faraday::Response', :body => double('Body')) }
+
+  describe '.list_sobjects' do
+    subject { client.list_sobjects }
+
+    before do
+      client.stub :describe => [ { 'name' => 'foo' } ]
+    end
+
+    it { should eq ['foo'] }
+  end
+
+  describe '.describe' do
+    subject(:describe) { client.describe }
+
+    it 'returns the global describe' do
+      sobjects = double('sobjects')
+      response.body.stub(:[]).with('sobjects').and_return(sobjects)
+      client.should_receive(:api_get).
+        with('sobjects').
+        and_return(response)
+      expect(describe).to eq sobjects
+    end
+
+    context 'when given the name of an sobject' do
+      subject(:describe) { client.describe('Whizbang') }
+
+      it 'returns the full describe' do
+        client.should_receive(:api_get).
+          with('sobjects/Whizbang/describe').
+          and_return(response)
+        expect(describe).to eq response.body
+      end
+    end
+  end
+
+  describe '.org_id' do
+    subject(:org_id) { client.org_id }
+
+    it 'returns the organization id' do
+      organizations = [ { 'Id' => 'foo' } ]
+      client.should_receive(:query).
+        with('select id from Organization').
+        and_return(organizations)
+      expect(org_id).to eq 'foo'
+    end
+  end
+
+  describe '.query' do
+    let(:soql)        { 'Select Id from Account' }
+    subject(:results) { client.query(soql) }
+
+    context 'with mashify middleware' do
+      before do
+        client.stub :mashify? => true
+      end
+
+      it 'returns the body' do
+        client.should_receive(:api_get).
+          with('query', :q => soql).
+          and_return(response)
+        expect(results).to eq response.body
+      end
+    end
+
+    context 'without mashify middleware' do
+      before do
+        client.stub :mashify? => false
+      end
+
+      it 'returns the records attribute of the body' do
+        records = double('records')
+        response.body.stub(:[]).
+          with('records').
+          and_return(records)
+        client.should_receive(:api_get).
+          with('query', :q => soql).
+          and_return(response)
+        expect(results).to eq records
+      end
+    end
+  end
+
+  describe '.search' do
+    let(:sosl)        { 'FIND {bar}' }
+    subject(:results) { client.search(sosl) }
+
+    it 'performs a sosl search' do
+      client.should_receive(:api_get).
+        with('search', :q => sosl).
+        and_return(response)
+      expect(results).to eq response.body
+    end
+  end
+
+  [:create, :update, :upsert, :destroy].each do |method|
+    describe ".#{method}" do
+      let(:args)       { [] }
+      subject(:result) { client.send(method, *args) }
+
+      it "delegates to :#{method}!" do
+        client.should_receive(:"#{method}!").
+          with(*args).
+          and_return(response)
+        expect(result).to eq response
+      end
+
+      it 'rescues exceptions' do
+        [Faraday::Error::ClientError].each do |exception_klass|
+          client.should_receive(:"#{method}!").
+            with(*args).
+            and_raise(exception_klass.new(nil))
+          expect(result).to eq false
+        end
+      end
+    end
+  end
+
+  describe '.create!' do
+    let(:sobject)    { 'Whizbang' }
+    let(:attrs)      { Hash.new }
+    subject(:result) { client.create!(sobject, attrs) }
+
+    it 'send an HTTP POST, and returns the id of the record' do
+      response.body.stub(:[]).with('id').and_return('1234')
+      client.should_receive(:api_post).
+        with('sobjects/Whizbang', attrs).
+        and_return(response)
+      expect(result).to eq '1234'
+    end
+  end
+
+  describe '.update!' do
+    let(:sobject)    { 'Whizbang' }
+    let(:attrs)      { Hash.new }
+    subject(:result) { client.update!(sobject, attrs) }
+
+    context 'when the id field is present' do
+      let(:attrs) { { :id => '1234' } }
+
+      it 'sends an HTTP PATCH, and returns true' do
+        client.should_receive(:api_patch).
+          with('sobjects/Whizbang/1234', attrs)
+        expect(result).to be_true
+      end
+    end
+
+    context 'when the id field is missing from the attrs' do
+      subject { lambda { result }}
+      it { should raise_error ArgumentError, 'Id field missing from attrs.' }
+    end
+  end
+
+  describe '.upsert!' do
+    let(:sobject)    { 'Whizbang' }
+    let(:field)      { :External_ID__c }
+    let(:attrs)      { { 'External_ID__c' => '1234' } }
+    subject(:result) { client.upsert!(sobject, field, attrs) }
+
+    context 'when the record is found and updated' do
+      it 'returns true' do
+        response.body.stub :[]
+        client.should_receive(:api_patch).
+          with('sobjects/Whizbang/External_ID__c/1234', {}).
+          and_return(response)
+        expect(result).to be_true
+      end
+    end
+
+    context 'when the record is found and created' do
+      it 'returns the id of the record' do
+        response.body.stub(:[]).with('id').and_return('4321')
+        client.should_receive(:api_patch).
+          with('sobjects/Whizbang/External_ID__c/1234', {}).
+          and_return(response)
+        expect(result).to eq '4321'
+      end
+    end
+  end
+
+  describe '.destroy!' do
+    let(:id)         { '1234' }
+    let(:sobject)    { 'Whizbang' }
+    subject(:result) { client.destroy!(sobject, id) }
+
+    it 'sends and HTTP delete, and returns true' do
+      client.should_receive(:api_delete).
+        with('sobjects/Whizbang/1234')
+      expect(result).to be_true
+    end
+  end
+
+  describe '.find' do
+    let(:sobject)    { 'Whizbang' }
+    let(:id)         { '1234' }
+    let(:field)      { nil }
+    subject(:result) { client.find(sobject, id, field) }
+
+    context 'when no external id is specified' do
+      it 'returns the full representation of the object' do
+        client.should_receive(:api_get).
+          with('sobjects/Whizbang/1234').
+          and_return(response)
+        expect(result).to eq response.body
+      end
+    end
+
+    context 'when an external id is specified' do
+      let(:field) { :External_ID__c }
+
+      it 'returns the full representation of the object' do
+        client.should_receive(:api_get).
+          with('sobjects/Whizbang/External_ID__c/1234').
+          and_return(response)
+        expect(result).to eq response.body
+      end
+    end
+  end
+end