restforce 0.0.1

data/spec/fixtures/sobject/sobject_find_error_response.json

@@ -0,0 +1,4 @@
+[ {
+  "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,2 @@
+{"id":"foo" +
+"","errors":[],"success":true}

data/spec/fixtures/sobject/upsert_error_response.json

@@ -0,0 +1 @@
+[{"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 @@
+["/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/lib/client_spec.rb

@@ -0,0 +1,214 @@
+require 'spec_helper'
+
+shared_examples_for 'methods' do
+  describe '#new' do
+    context 'without options passed in' do
+      it 'should not raise an exception' do
+        expect {
+          described_class.new
+        }.to_not raise_error
+      end
+    end
+
+    context 'with a non-hash value' do
+      it 'should raise an exception' do
+        expect {
+          described_class.new 'foo'
+        }.to raise_error, 'Please specify a hash of options'
+      end
+    end
+  end
+
+  describe '@options' do
+    subject { client.instance_variable_get :@options }
+
+    its([:oauth_token])    { should eq oauth_token    }
+    its([:refresh_token])  { should eq refresh_token  }
+    its([:client_id])      { should eq client_id      }
+    its([:client_secret])  { should eq client_secret  }
+    its([:username])       { should eq username       }
+    its([:password])       { should eq password       }
+    its([:security_token]) { should eq security_token }
+  end
+
+  describe '.authentication_middleware' do
+    subject { client.send :authentication_middleware }
+
+    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 oauth token, refresh token, client id and client secret provided' do
+      let(:client_options) { oauth_options }
+
+      it { should eq Restforce::Middleware::Authentication::OAuth }
+    end
+  end
+  
+  describe '.describe_sobjects' do
+    before do
+      stub_api_request :sobjects, with: 'sobject/describe_sobjects_success_response'
+    end
+
+    subject { client.describe_sobjects }
+    it { should be_an Array }
+  end
+
+  describe '.list_sobjects' do
+    before do
+      stub_api_request :sobjects, with: 'sobject/describe_sobjects_success_response'
+    end
+
+    subject { client.list_sobjects }
+    it { should be_an Array }
+    it { should eq ['Account'] }
+  end
+
+  describe '.describe' do
+    before do
+      stub_api_request 'sobject/Whizbang/describe', with: 'sobject/sobject_describe_success_response'
+    end
+
+    subject { client.describe('Whizbang') }
+    its(['name']) { should eq 'Whizbang' }
+  end
+
+  describe '.query' do
+    before do
+      stub_api_request :query, with: 'sobject/query_success_response'
+    end
+
+    subject { client.query('SELECT some, fields FROM object') }
+    it { should be_an Array }
+  end
+
+  describe '.search' do
+    before do
+      stub_api_request :search, with: 'sobject/search_success_response'
+    end
+
+    subject { client.search('FIND {bar}') }
+    it { should be_an Array }
+    its(:size) { should eq 2 }
+  end
+
+  describe '.org_id' do
+    before do
+      stub_api_request :query, with: 'sobject/org_query_response'
+    end
+
+    subject { client.org_id }
+    it { should eq '00Dx0000000BV7z' }
+  end
+
+  describe '.create' do
+    before do
+      @request = stub_api_request 'sobjects/Account', with: 'sobject/create_success_response', method: :post, body: "{\"Name\":\"Foobar\"}"
+    end
+
+    after do
+      @request.should have_been_requested
+    end
+
+    subject { client.create('Account', Name: 'Foobar') }
+    it { should eq 'some_id' }
+  end
+
+  describe '.update' do
+    pending 'with invalid Id'
+    pending 'with missing Id'
+    context 'with success' do
+      before do
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe', method: :patch, body: "{\"Name\":\"Foobar\"}"
+      end
+
+      after do
+        @request.should 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
+    end
+  end
+
+  describe '.destroy' do
+    pending 'with invalid Id'
+
+    context 'with success' do
+      before do 
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe', method: :delete
+      end
+
+      after do
+        @request.should have_been_requested
+      end
+
+      subject { client.destroy('Account', '001D000000INjVe') }
+      it { should be_true }
+    end
+  end
+end
+
+describe 'with mashify middleware' do
+  describe Restforce::Client do
+    include_context 'basic client'
+    include_examples 'methods'
+
+    describe '.mashify?' do
+      subject { client.send :mashify? }
+
+      it { should be_true }
+    end
+
+    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| request.should have_been_requested }
+        end
+
+        subject { client.query('SELECT some, fields FROM object').next_page }
+        it { should be_a Restforce::Collection }
+        specify { subject.first.Text_Label.should eq 'Last Page' }
+      end
+    end
+  end
+end
+
+describe 'without mashify middleware' do
+  before do
+    client.send(:connection).builder.delete(Restforce::Middleware::Mashify)
+  end
+
+  describe Restforce::Client do
+    include_context 'basic client'
+    include_examples 'methods'
+    
+    describe '.mashify?' do
+      subject { client.send :mashify? }
+
+      it { should be_false }
+    end
+  end
+end

data/spec/lib/collection_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Restforce::Collection do
+  let(:client) { double('client') }
+
+  describe '#new' do
+    subject { records }
+
+    context 'without pagination' do
+      let(:records) do
+        described_class.new(JSON.parse(fixture('sobject/query_success_response')), client)
+      end
+
+      it               { should respond_to :each }
+      its(:size)       { should eq 1 }
+      its(:total_size) { should eq 1 }
+      its(:next_page_url)  { should be_nil }
+      specify { subject.instance_variable_get(:@client).should eq client }
+
+      describe 'each record' do
+        it 'should be a Restforce::SObject' do
+          records.each do |record|
+            record.should be_a Restforce::SObject
+          end
+        end
+      end
+    end
+
+    context 'with pagination' do
+      let(:records) do
+        described_class.new(JSON.parse(fixture('sobject/query_paginated_first_page_response')), client)
+      end
+
+      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' }
+      specify { subject.instance_variable_get(:@client).should eq client }
+
+      describe '.next_page' do
+        before do
+          client.should_receive(:get).and_return(Faraday::Response.new(body: Restforce::Collection.new({'records' => {}}, client)))
+        end
+
+        subject { records.next_page }
+        it { should be_a Restforce::Collection }
+      end
+    end
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Restforce do
+  after do
+    Restforce.instance_variable_set :@configuration, nil
+  end
+
+  describe '#configuration' do
+    subject { Restforce.configuration }
+
+    it { should be_a Restforce::Configuration }
+
+    context 'by default' do
+      its(:api_version)  { should eq '24.0' }
+      its(:host)         { should eq 'login.salesforce.com' }
+      [:username, :password, :security_token, :client_id, :client_secret,
+       :oauth_token, :refresh_token, :instance_url].each do |attr|
+        its(attr) { should be_nil }
+      end
+    end
+  end
+
+  describe '#configure' do
+    [:username, :password, :security_token, :client_id, :client_secret,
+     :oauth_token, :refresh_token, :instance_url, :api_version, :host].each do |attr|
+      it "allows #{attr} to be set" do
+        Restforce.configure do |config|
+          config.send("#{attr}=", 'foobar')
+        end
+        Restforce.configuration.send(attr).should eq 'foobar'
+      end
+    end
+  end
+
+  describe '#log?' do
+    subject { Restforce.log? }
+
+    context 'by default' do
+      it { should be_false }
+    end
+  end
+
+  describe '#log' do
+    after do
+      Restforce.log = false
+    end
+
+    context 'with logging disabled' do
+      before do
+        Restforce.log = false
+        Restforce.configuration.logger.should_not_receive(:debug)
+      end
+
+      it 'doesnt log anytning' do
+        Restforce.log 'foobar'
+      end
+    end
+    
+    context 'with logging enabled' do
+      before do
+        Restforce.log = true
+        Restforce.configuration.logger.should_receive(:debug).with('foobar')
+      end
+
+      it 'logs something' do
+        Restforce.log 'foobar'
+      end
+    end
+  end
+end

data/spec/lib/middleware/authentication/oauth_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Restforce::Middleware::Authentication::OAuth do
+  let(:app)        { double('app')            }
+  let(:env)        { { }  }
+  let(:middleware) { described_class.new app, nil, options }
+
+  let(:options) do
+    { host: 'login.salesforce.com',
+      refresh_token: 'refresh_token',
+      client_id: 'client_id',
+      client_secret: 'client_secret' }
+  end
+
+  it_behaves_like 'authentication middleware' do
+    let(:success_request) do
+      stub_request(:post, "https://login.salesforce.com/services/oauth2/token").
+        with(:body => "grant_type=refresh_token&refresh_token=refresh_token&" \
+        "client_id=client_id&client_secret=client_secret").
+        to_return(:status => 200, :body => fixture(:auth_success_response))
+    end
+
+    let(:fail_request) do
+      stub_request(:post, "https://login.salesforce.com/services/oauth2/token").
+        with(:body => "grant_type=refresh_token&refresh_token=refresh_token&" \
+        "client_id=client_id&client_secret=client_secret").
+        to_return(:status => 400, :body => fixture(:auth_success_response))
+    end
+  end
+end

data/spec/lib/middleware/authentication/password_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Restforce::Middleware::Authentication::Password do
+  let(:app)        { double('app')            }
+  let(:env)        { { }  }
+  let(:middleware) { described_class.new app, nil, options }
+
+  let(:options) do
+    { host: 'login.salesforce.com',
+      username: 'foo',
+      password: 'bar',
+      security_token: 'security_token',
+      client_id: 'client_id',
+      client_secret: 'client_secret' }
+  end
+
+  it_behaves_like 'authentication middleware' do
+    let(:success_request) do
+      stub_request(:post, "https://login.salesforce.com/services/oauth2/token").
+        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
+
+    let(:fail_request) do
+      stub_request(:post, "https://login.salesforce.com/services/oauth2/token").
+        with(:body => "grant_type=password&client_id=client_id&client_secret=" \
+        "client_secret&username=foo&password=barsecurity_token").
+        to_return(:status => 400, :body => fixture(:auth_success_response))
+    end
+  end
+
+  describe '.password' do
+    subject { middleware.password }
+    it      { should eq 'barsecurity_token' }
+  end
+end