sfdc 3.0.0 → 3.0.1

data/spec/unit/middleware/authorization_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Sfdc::Middleware::Authorization do
+  let(:options) { { :oauth_token => 'token' } }
+
+  describe '.call' do
+    subject { lambda { middleware.call(env) } }
+
+    it { should change { env[:request_headers]['Authorization'] }.to eq 'OAuth token' }
+  end
+end

data/spec/unit/middleware/gzip_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Sfdc::Middleware::Gzip do
+  let(:options) { { :oauth_token => 'token' } }
+
+  # Return a gzipped string.
+  def gzip(str)
+    StringIO.new.tap do |io|
+      gz = Zlib::GzipWriter.new(io)
+      gz.write(str)
+      gz.close
+    end.string
+  end
+
+  describe '.call' do
+    subject { lambda { middleware.call(env) } }
+
+    before do
+      app.should_receive(:on_complete) { middleware.on_complete(env) }
+      app.should_receive(:call) do
+        env[:body] = gzip fixture('sobject/query_success_response')
+        env[:response_headers]['Content-Encoding'] = 'gzip'
+        app
+      end
+    end
+
+    it 'decompresses the body' do
+      should change { env[:body] }.to(fixture('sobject/query_success_response'))
+    end
+
+    context 'when :compress is false' do
+      it { should_not change { env[:request_headers]['Accept-Encoding'] } }
+    end
+
+    context 'when :compress is true' do
+      before do
+        options[:compress] = true
+      end
+
+      it { should change { env[:request_headers]['Accept-Encoding'] }.to('gzip') }
+    end
+  end
+
+  describe '.decompress' do
+    let(:body) { gzip fixture('sobject/query_success_response') }
+
+    subject { middleware.decompress(body) }
+    it { should eq fixture('sobject/query_success_response') }
+  end
+
+  describe '.gzipped?' do
+    subject { middleware.gzipped?(env) }
+
+    context 'when gzipped' do
+      before do
+        env[:response_headers]['Content-Encoding'] = 'gzip'
+      end
+
+      it { should be_true }
+    end
+
+    context 'when not gzipped' do
+      it { should be_false }
+    end
+  end
+end

data/spec/unit/middleware/instance_url_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Sfdc::Middleware::InstanceURL do
+  describe '.call' do
+    subject { lambda { middleware.call(nil) } }
+
+    context 'when the instance url is not set' do
+      before do
+        client.stub_chain :connection, :url_prefix => URI.parse('http:/')
+      end
+
+      it { should raise_error Sfdc::UnauthorizedError }
+    end
+
+    context 'when the instance url is set' do
+      before do
+        client.stub_chain :connection, :url_prefix => URI.parse('http://foobar.com/')
+        app.should_receive(:call).once
+      end
+
+      it { should_not raise_error }
+    end
+  end
+end

data/spec/unit/middleware/logger_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Sfdc::Middleware::Logger do
+  let(:logger)     { double('logger') }
+  let(:middleware) { described_class.new app, logger, options }
+
+  describe '.call' do
+    subject { lambda { middleware.call(env) } }
+
+    before do
+      app.should_receive(:call).once.and_return(app)
+      app.should_receive(:on_complete).once { middleware.on_complete(env) }
+      logger.should_receive(:debug).with('request')
+      logger.should_receive(:debug).with('response')
+    end
+
+    it { should_not raise_error }
+  end
+end

data/spec/unit/middleware/mashify_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Sfdc::Middleware::Mashify do
+  let(:env) { { :body => JSON.parse(fixture('sobject/query_success_response')) } }
+
+  describe '.call' do
+    subject { lambda { middleware.call(env) } }
+
+    it { should change { env[:body] }.to(kind_of(Sfdc::Collection)) }
+  end
+end

data/spec/unit/middleware/raise_error_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Sfdc::Middleware::RaiseError do
+  let(:body)       { fixture('sobject/query_error_response') }
+  let(:env)        { { :status => status, :body => body } }
+  let(:middleware) { described_class.new app }
+
+  describe '.on_complete' do
+    subject { lambda { middleware.on_complete(env) } }
+
+    context 'when the status code is 404' do
+      let(:status) { 404 }
+      it { should raise_error Faraday::Error::ResourceNotFound, 'INVALID_FIELD: error_message' }
+    end
+
+    context 'when the status code is 400' do
+      let(:status) { 400 }
+      it { should raise_error Faraday::Error::ClientError, 'INVALID_FIELD: error_message' }
+    end
+
+    context 'when the status code is 401' do
+      let(:status) { 401 }
+      it { should raise_error Sfdc::UnauthorizedError, 'INVALID_FIELD: error_message' }
+    end
+
+    context 'when the status code is 413' do
+      let(:status) { 413 }
+      let(:body) { '' } #Zero length response
+      it { should raise_error Faraday::Error::ClientError, 'HTTP 413 - Request Entity Too Large' }
+    end
+  end
+end

data/spec/unit/signed_request_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Sfdc::SignedRequest do
+  let(:client_secret) { 'foo' }
+  let(:message) do
+    digest = OpenSSL::Digest::Digest.new('sha256')
+    signature = Base64.encode64(OpenSSL::HMAC.digest(digest, client_secret, data))
+    "#{signature}.#{data}"
+  end
+
+  describe '.decode' do
+    subject { described_class.new(message, client_secret).decode }
+
+    context 'when the message is valid' do
+      let(:data) { Base64.encode64('{"key": "value"}') }
+      it { should eq('key' => 'value') }
+    end
+
+    context 'when the message is invalid' do
+      let(:message) { 'foobar.awdkjkj' }
+      it { should be_nil }
+    end
+  end
+end

data/spec/unit/sobject_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Sfdc::SObject do
+  let(:client)      { double('Client') }
+  let(:hash)        { JSON.parse(fixture('sobject/query_success_response'))['records'].first }
+  subject(:sobject) { described_class.new(hash, client) }
+
+  describe '#new' do
+    context 'with valid options' do
+      it                 { should be_a Sfdc::SObject }
+      it                 { should have_client client }
+      its(:sobject_type) { should eq 'Whizbang' }
+      its(:Text_Label)   { should eq 'Hi there!' }
+
+      describe 'children' do
+        subject(:children) { sobject.Whizbangs__r }
+
+        it { should be_a Sfdc::Collection }
+
+        describe 'each child' do
+          it { should be_all { |sobject| expect(sobject).to be_a Sfdc::SObject } }
+          it { should be_all { |sobject| expect(sobject).to have_client client } }
+        end
+      end
+
+      describe 'parent' do
+        subject(:parent) { sobject.ParentWhizbang__r }
+
+        it                 { should be_a Sfdc::SObject }
+        its(:sobject_type) { should eq 'Whizbang' }
+        its(:Name)         { should eq 'Parent Whizbang' }
+        it                 { should have_client client }
+      end
+    end
+  end
+
+  { :save     => :update,
+    :save!    => :update!,
+    :destroy  => :destroy,
+    :destroy! => :destroy! }.each do |method, receiver|
+    describe ".#{method}" do
+      subject { lambda { sobject.send(method) } }
+
+      context 'when an Id was not queried' do
+        it { should raise_error ArgumentError, 'You need to query the Id for the record first.' }
+      end
+
+      context 'when an Id is present' do
+        before do
+          hash.merge!(:Id => '001D000000INjVe')
+          client.should_receive(receiver)
+        end
+
+        it { should_not raise_error }
+      end
+    end
+  end
+
+  describe '.describe' do
+    subject { lambda { sobject.describe } }
+
+    before do
+      client.should_receive(:describe).with('Whizbang')
+    end
+
+    it { should_not raise_error }
+  end
+
+  describe '.describe_layouts' do
+    let(:layout_id) { nil }
+    subject { lambda { sobject.describe_layouts } }
+
+    before do
+      client.should_receive(:describe_layouts).with('Whizbang', layout_id)
+    end
+
+    it { should_not raise_error }
+
+    context 'when a layout Id is specified' do
+      let(:layout_id) { '012E0000000RHEp' }
+      subject { lambda { sobject.describe_layouts(layout_id) } }
+
+      it { should_not raise_error }
+    end
+  end
+end

data/spec/unit/tooling/client_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Sfdc::Tooling::Client do
+  subject { described_class }
+
+  it { should < Sfdc::AbstractClient }
+end

metadata

@@ -1,102 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: sfdc
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Bruce Yue
 autorequire: 
-bindir:
-- bin
+bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.8.4
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.8.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.8.8
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.5
+    - - <
+      - !ruby/object:Gem::Version
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.5
+    - - <
+      - !ruby/object:Gem::Version
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 2.14.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: faye
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -109,51 +134,121 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Salesforce API
+description: A lightweight ruby client for the Salesforce REST api.
 email:
 - bruce.yue@outlook.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/sfdc/abstract_client.rb
-- lib/sfdc/attachment.rb
-- lib/sfdc/client.rb
-- lib/sfdc/collection.rb
-- lib/sfdc/concerns/api.rb
-- lib/sfdc/concerns/authentication.rb
-- lib/sfdc/concerns/base.rb
-- lib/sfdc/concerns/caching.rb
-- lib/sfdc/concerns/canvas.rb
-- lib/sfdc/concerns/connection.rb
-- lib/sfdc/concerns/picklists.rb
-- lib/sfdc/concerns/streaming.rb
-- lib/sfdc/concerns/verbs.rb
-- lib/sfdc/config.rb
-- lib/sfdc/data/client.rb
-- lib/sfdc/mash.rb
-- lib/sfdc/middleware/authentication/password.rb
-- lib/sfdc/middleware/authentication/token.rb
-- lib/sfdc/middleware/authentication.rb
-- lib/sfdc/middleware/authorization.rb
-- lib/sfdc/middleware/caching.rb
-- lib/sfdc/middleware/gzip.rb
-- lib/sfdc/middleware/instance_url.rb
-- lib/sfdc/middleware/logger.rb
-- lib/sfdc/middleware/mashify.rb
-- lib/sfdc/middleware/multipart.rb
-- lib/sfdc/middleware/raise_error.rb
-- lib/sfdc/middleware.rb
-- lib/sfdc/signed_request.rb
-- lib/sfdc/sobject.rb
-- lib/sfdc/tooling/client.rb
-- lib/sfdc/upload_io.rb
-- lib/sfdc/version.rb
-- lib/sfdc.rb
-- README.md
+- ./CHANGELOG.md
+- ./Gemfile
+- ./Guardfile
+- ./lib/sfdc/abstract_client.rb
+- ./lib/sfdc/attachment.rb
+- ./lib/sfdc/client.rb
+- ./lib/sfdc/collection.rb
+- ./lib/sfdc/concerns/api.rb
+- ./lib/sfdc/concerns/authentication.rb
+- ./lib/sfdc/concerns/base.rb
+- ./lib/sfdc/concerns/caching.rb
+- ./lib/sfdc/concerns/canvas.rb
+- ./lib/sfdc/concerns/connection.rb
+- ./lib/sfdc/concerns/picklists.rb
+- ./lib/sfdc/concerns/streaming.rb
+- ./lib/sfdc/concerns/verbs.rb
+- ./lib/sfdc/config.rb
+- ./lib/sfdc/data/client.rb
+- ./lib/sfdc/mash.rb
+- ./lib/sfdc/middleware/authentication/password.rb
+- ./lib/sfdc/middleware/authentication/token.rb
+- ./lib/sfdc/middleware/authentication.rb
+- ./lib/sfdc/middleware/authorization.rb
+- ./lib/sfdc/middleware/caching.rb
+- ./lib/sfdc/middleware/gzip.rb
+- ./lib/sfdc/middleware/instance_url.rb
+- ./lib/sfdc/middleware/logger.rb
+- ./lib/sfdc/middleware/mashify.rb
+- ./lib/sfdc/middleware/multipart.rb
+- ./lib/sfdc/middleware/raise_error.rb
+- ./lib/sfdc/middleware.rb
+- ./lib/sfdc/signed_request.rb
+- ./lib/sfdc/sobject.rb
+- ./lib/sfdc/tooling/client.rb
+- ./lib/sfdc/upload_io.rb
+- ./lib/sfdc/version.rb
+- ./lib/sfdc.rb
+- ./LICENSE
+- ./Rakefile
+- ./README.md
+- ./sfdc.gemspec
+- spec/fixtures/auth_error_response.json
+- spec/fixtures/auth_success_response.json
+- spec/fixtures/blob.jpg
+- spec/fixtures/expired_session_response.json
+- spec/fixtures/reauth_success_response.json
+- spec/fixtures/refresh_error_response.json
+- spec/fixtures/refresh_success_response.json
+- spec/fixtures/services_data_success_response.json
+- spec/fixtures/sobject/create_success_response.json
+- spec/fixtures/sobject/delete_error_response.json
+- spec/fixtures/sobject/describe_sobjects_success_response.json
+- spec/fixtures/sobject/list_sobjects_success_response.json
+- spec/fixtures/sobject/org_query_response.json
+- spec/fixtures/sobject/query_aggregate_success_response.json
+- spec/fixtures/sobject/query_empty_response.json
+- spec/fixtures/sobject/query_error_response.json
+- spec/fixtures/sobject/query_paginated_first_page_response.json
+- spec/fixtures/sobject/query_paginated_last_page_response.json
+- spec/fixtures/sobject/query_success_response.json
+- spec/fixtures/sobject/recent_success_response.json
+- spec/fixtures/sobject/search_error_response.json
+- spec/fixtures/sobject/search_success_response.json
+- spec/fixtures/sobject/sobject_describe_error_response.json
+- spec/fixtures/sobject/sobject_describe_success_response.json
+- spec/fixtures/sobject/sobject_find_error_response.json
+- spec/fixtures/sobject/sobject_find_success_response.json
+- spec/fixtures/sobject/upsert_created_success_response.json
+- spec/fixtures/sobject/upsert_error_response.json
+- spec/fixtures/sobject/upsert_multiple_error_response.json
+- spec/fixtures/sobject/upsert_updated_success_response.json
+- spec/fixtures/sobject/write_error_response.json
+- spec/integration/abstract_client_spec.rb
+- spec/integration/data/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/client_integration.rb
+- spec/support/concerns.rb
+- spec/support/event_machine.rb
+- spec/support/fixture_helpers.rb
+- spec/support/matchers.rb
+- spec/support/middleware.rb
+- spec/support/mock_cache.rb
+- spec/unit/abstract_client_spec.rb
+- spec/unit/attachment_spec.rb
+- spec/unit/collection_spec.rb
+- spec/unit/concerns/api_spec.rb
+- spec/unit/concerns/authentication_spec.rb
+- spec/unit/concerns/base_spec.rb
+- spec/unit/concerns/caching_spec.rb
+- spec/unit/concerns/canvas_spec.rb
+- spec/unit/concerns/connection_spec.rb
+- spec/unit/config_spec.rb
+- spec/unit/data/client_spec.rb
+- spec/unit/mash_spec.rb
+- spec/unit/middleware/authentication/password_spec.rb
+- spec/unit/middleware/authentication/token_spec.rb
+- spec/unit/middleware/authentication_spec.rb
+- spec/unit/middleware/authorization_spec.rb
+- spec/unit/middleware/gzip_spec.rb
+- spec/unit/middleware/instance_url_spec.rb
+- spec/unit/middleware/logger_spec.rb
+- spec/unit/middleware/mashify_spec.rb
+- spec/unit/middleware/raise_error_spec.rb
+- spec/unit/signed_request_spec.rb
+- spec/unit/sobject_spec.rb
+- spec/unit/tooling/client_spec.rb
 homepage: http://www.sharealltech.com
-licenses:
-- MIT
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -170,9 +265,74 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: sfdc
+rubyforge_project: 
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Salesforce API
-test_files: []
+summary: A lightweight ruby client for the Salesforce REST api.
+test_files:
+- spec/fixtures/auth_error_response.json
+- spec/fixtures/auth_success_response.json
+- spec/fixtures/blob.jpg
+- spec/fixtures/expired_session_response.json
+- spec/fixtures/reauth_success_response.json
+- spec/fixtures/refresh_error_response.json
+- spec/fixtures/refresh_success_response.json
+- spec/fixtures/services_data_success_response.json
+- spec/fixtures/sobject/create_success_response.json
+- spec/fixtures/sobject/delete_error_response.json
+- spec/fixtures/sobject/describe_sobjects_success_response.json
+- spec/fixtures/sobject/list_sobjects_success_response.json
+- spec/fixtures/sobject/org_query_response.json
+- spec/fixtures/sobject/query_aggregate_success_response.json
+- spec/fixtures/sobject/query_empty_response.json
+- spec/fixtures/sobject/query_error_response.json
+- spec/fixtures/sobject/query_paginated_first_page_response.json
+- spec/fixtures/sobject/query_paginated_last_page_response.json
+- spec/fixtures/sobject/query_success_response.json
+- spec/fixtures/sobject/recent_success_response.json
+- spec/fixtures/sobject/search_error_response.json
+- spec/fixtures/sobject/search_success_response.json
+- spec/fixtures/sobject/sobject_describe_error_response.json
+- spec/fixtures/sobject/sobject_describe_success_response.json
+- spec/fixtures/sobject/sobject_find_error_response.json
+- spec/fixtures/sobject/sobject_find_success_response.json
+- spec/fixtures/sobject/upsert_created_success_response.json
+- spec/fixtures/sobject/upsert_error_response.json
+- spec/fixtures/sobject/upsert_multiple_error_response.json
+- spec/fixtures/sobject/upsert_updated_success_response.json
+- spec/fixtures/sobject/write_error_response.json
+- spec/integration/abstract_client_spec.rb
+- spec/integration/data/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/client_integration.rb
+- spec/support/concerns.rb
+- spec/support/event_machine.rb
+- spec/support/fixture_helpers.rb
+- spec/support/matchers.rb
+- spec/support/middleware.rb
+- spec/support/mock_cache.rb
+- spec/unit/abstract_client_spec.rb
+- spec/unit/attachment_spec.rb
+- spec/unit/collection_spec.rb
+- spec/unit/concerns/api_spec.rb
+- spec/unit/concerns/authentication_spec.rb
+- spec/unit/concerns/base_spec.rb
+- spec/unit/concerns/caching_spec.rb
+- spec/unit/concerns/canvas_spec.rb
+- spec/unit/concerns/connection_spec.rb
+- spec/unit/config_spec.rb
+- spec/unit/data/client_spec.rb
+- spec/unit/mash_spec.rb
+- spec/unit/middleware/authentication/password_spec.rb
+- spec/unit/middleware/authentication/token_spec.rb
+- spec/unit/middleware/authentication_spec.rb
+- spec/unit/middleware/authorization_spec.rb
+- spec/unit/middleware/gzip_spec.rb
+- spec/unit/middleware/instance_url_spec.rb
+- spec/unit/middleware/logger_spec.rb
+- spec/unit/middleware/mashify_spec.rb
+- spec/unit/middleware/raise_error_spec.rb
+- spec/unit/signed_request_spec.rb
+- spec/unit/sobject_spec.rb
+- spec/unit/tooling/client_spec.rb