sfdc 3.0.0 → 3.0.1

data/spec/fixtures/sobject/sobject_find_error_response.json

@@ -0,0 +1,6 @@
+[
+  {
+    "message": "Provided external ID field does not exist or is not accessible: 23foo",
+    "errorCode": "NOT_FOUND"
+  }
+]

data/spec/fixtures/sobject/sobject_find_success_response.json

@@ -0,0 +1,29 @@
+{
+  "attributes": {
+    "type": "Whizbang",
+    "url": "/services/data/v20.0/sobjects/Whizbang/23foo"
+  },
+  "Id": "23foo",
+  "OwnerId": "owner_id",
+  "IsDeleted": false,
+  "Name": "My First Whizbang",
+  "CreatedById": "created_by_id",
+  "LastModifiedById": "last_modified_by_id",
+  "Auto_Number": "A-1",
+  "Checkbox_Label": true,
+  "Currency_Label": 23.0,
+  "Date_Label": "2010-01-01",
+  "DateTime_Label": "2011-07-07T00:37:00.000+0000",
+  "OtherDateTime_Label": null,
+  "Email_Label": "danny@example.com",
+  "Number_Label": 23.0,
+  "Percent_Label": 33.0,
+  "Phone_Label": "(415) 555-1212",
+  "Picklist_Label": "one",
+  "Picklist_Multiselect_Label": "four;six",
+  "Text_Label": "some text",
+  "TextArea_Label": "a text area",
+  "TextAreaLong_Label": "a loooooooooooooong text area",
+  "TextAreaRich_Label": "Rich <strong>text</strong>",
+  "URL_Label": "http://pivotallabs.com"
+}

data/spec/fixtures/sobject/upsert_created_success_response.json

@@ -0,0 +1,5 @@
+{
+  "id": "foo",
+  "errors": [],
+  "success": true
+}

data/spec/fixtures/sobject/upsert_error_response.json

@@ -0,0 +1,6 @@
+[
+  {
+    "message": "Provided external ID field does not exist or is not accessible: Namez",
+    "errorCode": "NOT_FOUND"
+  }
+]

data/spec/fixtures/sobject/upsert_multiple_error_response.json

@@ -0,0 +1,4 @@
+[
+  "/services/data/v23.0/sobjects/Whizbang/foo",
+  "/services/data/v23.0/sobjects/Whizbang/bar"
+]

data/spec/fixtures/sobject/write_error_response.json

@@ -0,0 +1,6 @@
+[
+  {
+    "message": "No such column 'foo' on sobject of type Bar",
+    "errorCode": "INVALID_FIELD"
+  }
+]

data/spec/integration/abstract_client_spec.rb

@@ -0,0 +1,306 @@
+require 'spec_helper'
+
+shared_examples_for Sfdc::AbstractClient do
+  describe '.list_sobjects' do
+    requests :sobjects, :fixture => 'sobject/describe_sobjects_success_response'
+
+    subject { client.list_sobjects }
+    it { should be_an Array }
+    it { should eq ['Account'] }
+  end
+
+  describe '.describe' do
+    context 'with no arguments' do
+      requests :sobjects, :fixture => 'sobject/describe_sobjects_success_response'
+
+      subject { client.describe }
+      it { should be_an Array }
+    end
+
+    context 'with an argument' do
+      requests 'sobjects/Whizbang/describe', :fixture => 'sobject/sobject_describe_success_response'
+
+      subject { client.describe('Whizbang') }
+      its(['name']) { should eq 'Whizbang' }
+    end
+  end
+
+  describe '.query' do
+    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 Enumerable }
+  end
+
+  describe '.search' do
+    requests 'search\?q=FIND%20%7Bbar%7D', :fixture => 'sobject/search_success_response'
+
+    subject { client.search('FIND {bar}') }
+    it { should be_an Array }
+    its(:size) { should eq 2 }
+  end
+
+  describe '.org_id' do
+    requests 'query\?q=select%20id%20from%20Organization', :fixture => 'sobject/org_query_response'
+
+    subject { client.org_id }
+    it { should eq '00Dx0000000BV7z' }
+  end
+
+  describe '.create' do
+    context 'without multipart' do
+      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
+      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 => Sfdc::UploadIO.new(File.expand_path('../../fixtures/blob.jpg', __FILE__), 'image/jpeg')) }
+      it { should eq 'some_id' }
+    end
+  end
+
+  describe '.update!' do
+    context 'with invalid Id' do
+      requests 'sobjects/Account/001D000000INjVe',
+        :method => :patch,
+        :with_body => "{\"Name\":\"Foobar\"}",
+        :status => 404,
+        :fixture => 'sobject/delete_error_response'
+
+      subject { lambda { client.update!('Account', :Id => '001D000000INjVe', :Name => 'Foobar') } }
+      it { should raise_error Faraday::Error::ResourceNotFound }
+    end
+  end
+
+  describe '.update' do
+    context 'with missing Id' do
+      subject { lambda { client.update('Account', :Name => 'Foobar') } }
+      it { should raise_error ArgumentError, 'Id field missing from attrs.' }
+    end
+
+    context 'with invalid Id' do
+      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
+      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
+      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') }
+        it { should be_true }
+      end
+
+      context 'with string external Id key' do
+        subject { client.upsert!('Account', 'External__c', 'External__c' => 'foobar', 'Name' => 'Foobar') }
+        it { should be_true }
+      end
+    end
+
+    context 'when created' do
+      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
+
+  describe '.destroy!' do
+    subject(:destroy!) { client.destroy!('Account', '001D000000INjVe') }
+
+    context 'with invalid Id' do
+      requests 'sobjects/Account/001D000000INjVe',
+        :fixture => 'sobject/delete_error_response',
+        :method => :delete,
+        :status => 404
+
+      subject { lambda { destroy! } }
+      it { should raise_error Faraday::Error::ResourceNotFound }
+    end
+
+    context 'with success' do
+      requests 'sobjects/Account/001D000000INjVe', :method => :delete
+
+      it { should be_true }
+    end
+  end
+
+  describe '.destroy' do
+    subject { client.destroy('Account', '001D000000INjVe') }
+
+    context 'with invalid Id' do
+      requests 'sobjects/Account/001D000000INjVe',
+        :fixture => 'sobject/delete_error_response',
+        :method => :delete,
+        :status => 404
+
+      it { should be_false }
+    end
+
+    context 'with success' do
+      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
+    subject(:authenticate!) { client.authenticate! }
+
+    context 'when successful' do
+      before do
+        @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
+
+      after do
+        expect(@request).to have_been_requested
+      end
+
+      it { should be_a Hash }
+    end
+
+    context 'when no authentication middleware is present' do
+      before do
+        client.stub(:authentication_middleware).and_return(nil)
+      end
+
+      subject { lambda { authenticate! } }
+      it { should raise_error Sfdc::AuthenticationError, 'No authentication middleware present'}
+    end
+  end
+
+  describe '.without_caching' do
+    requests 'query\?q=SELECT%20some,%20fields%20FROM%20object',
+      :fixture => 'sobject/query_success_response'
+
+    before do
+      cache.should_receive(:delete).and_call_original
+      cache.should_receive(:fetch).and_call_original
+    end
+
+    let(:cache) { MockCache.new }
+    subject { client.without_caching { client.query('SELECT some, fields FROM object') } }
+    it { should be_an Enumerable }
+  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,
+          :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
+
+      subject { lambda { client.query('SELECT some, fields FROM object') } }
+      it { should raise_error Sfdc::UnauthorizedError }
+    end
+  end
+
+  describe '.query with caching' do
+    let(:cache) { MockCache.new }
+
+    before do
+      @query = stub_api_request('query\?q=SELECT%20some,%20fields%20FROM%20object').
+        with(:headers => { 'Authorization' => "OAuth #{oauth_token}" }).
+        to_return(:status => 401, :body => fixture('expired_session_response'), :headers => { 'Content-Type' => 'application/json' }).then.
+        to_return(:status => 200, :body => fixture('sobject/query_success_response'), :headers => { 'Content-Type' => 'application/json' })
+
+      @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
+
+    after do
+      expect(@query).to have_been_made.times(2)
+      expect(@login).to have_been_made
+    end
+
+    subject { client.query('SELECT some, fields FROM object') }
+    it { should be_an Enumerable }
+  end
+end
+
+describe Sfdc::AbstractClient do
+  describe 'with mashify' do
+    it_behaves_like Sfdc::AbstractClient
+
+    describe '.query' do
+      context 'with pagination' do
+        subject { client.query('SELECT some, fields FROM object').next_page }
+
+        requests 'query\?q', :fixture => 'sobject/query_paginated_first_page_response'
+        requests 'query/01gD', :fixture => 'sobject/query_paginated_last_page_response'
+
+        it { should be_a Sfdc::Collection }
+        its('first.Text_Label') { should eq 'Last Page'}
+      end
+    end
+  end
+
+  describe 'without mashify', :mashify => false do
+    it_behaves_like Sfdc::AbstractClient
+  end
+end

data/spec/integration/data/client_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+shared_examples_for Sfdc::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 Sfdc::Data::Client do
+  describe 'with mashify' do
+    it_behaves_like Sfdc::Client
+  end
+
+  describe 'without mashify', :mashify => false do
+    it_behaves_like Sfdc::Client
+  end
+end