restforce 1.4.1 → 1.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f155672fa355a4c60e63fa1f66ef16692a16e886
+  data.tar.gz: aa39f74eda4066a8a8addce8907423e9cb536bd7
+SHA512:
+  metadata.gz: e081ce4d5954161f172634639c36e8a7646f5500934830f1a2795ca40ae49b6e706a16109f19e6998a0082284061e469a09ff55252aa6ae7e8432485dfd281d3
+  data.tar.gz: 17dd0fe6fb064e1e05f312a3ac6edcaf10dfafbec79c422db8de824dc1b98bfacfa3a9c29f0a3eb885e27a97f40cfff05b82c408c941fbbdc077ad7075a4ef5a

data/README.md

@@ -229,6 +229,18 @@ client.describe('Account')
 # => { ... }
 ```
 
+### describe_layouts
+
+```ruby
+# get layouts for an sobject type
+client.describe_layout('Account')
+# => { ... }
+
+# get the details for a specific layout
+client.describe_layouts('Account', '012E0000000RHEp')
+# => { ... }
+```
+
 ### picklist\_values
 
 

data/lib/restforce/collection.rb

@@ -22,6 +22,11 @@ module Restforce
     end
     alias_method :length, :size
 
+    # Return array of the elements on the current page
+    def current_page
+      first(@raw_page['records'].size)
+    end
+
     # Return the current and all of the following pages.
     def pages
       [self] + (has_next_page? ? next_page.pages : [])

data/lib/restforce/concerns/api.rb

@@ -65,6 +65,30 @@ module Restforce
         end
       end
 
+      # Public: Returns a detailed description of the Page Layout for the
+      # specified sobject type, or URIs for layouts if the sobject has
+      # multiple Record Types.
+      #
+      # This resource was introduced in version 28.0.
+      #
+      # Examples:
+      #  # get the layouts for the sobject
+      #  client.describe_layouts('Account')
+      #  # => { ... }
+      #
+      #  # get the layout for the specified Id for the sobject
+      #  client.describe_layouts('Account', '012E0000000RHEp')
+      #  # => { ... }
+      #
+      # Returns the Hash representation of the describe_layouts result
+      def describe_layouts(sobject, layout_id = nil)
+        if layout_id
+          api_get("sobjects/#{sobject.to_s}/describe/layouts/#{layout_id}").body
+        else
+          api_get("sobjects/#{sobject.to_s}/describe/layouts").body
+        end
+      end
+
       # Public: Get the current organization's Id.
       #
       # Examples

data/lib/restforce/concerns/base.rb

@@ -37,6 +37,9 @@ module Restforce
       #        :timeout                - Faraday connection request read/open timeout. (default: nil).
       #
       #        :proxy_uri              - Proxy URI: 'http://proxy.example.com:port' or 'http://user@pass:proxy.example.com:port'
+      #
+      #        :authentication_callback
+      #                                - A Proc that is called with the response body after a successful authentication.
       def initialize(opts = {})
         raise ArgumentError, 'Please specify a hash of options' unless opts.is_a?(Hash)
         @options = Hash[Restforce.configuration.options.map { |option| [option, Restforce.configuration.send(option)] }]

data/lib/restforce/concerns/connection.rb

@@ -51,7 +51,7 @@ module Restforce
       end
 
       def adapter
-        Restforce.configuration.adapter
+        options[:adapter]
       end
 
       # Internal: Faraday Connection options

data/lib/restforce/config.rb

@@ -125,6 +125,9 @@ module Restforce
 
     option :proxy_uri, :default => lambda { ENV['PROXY_URI'] }
 
+    # A Proc that is called with the response body after a successful authentication.
+    option :authentication_callback
+
     def logger
       @logger ||= ::Logger.new STDOUT
     end

data/lib/restforce/mash.rb

@@ -46,6 +46,10 @@ module Restforce
       deep_update(source_hash) if source_hash
       default ? super(default) : super(&blk)
     end
+
+    def dup
+      self.class.new(self, @client, self.default)
+    end
   
     def convert_value(val, duping=false)
       case val

data/lib/restforce/middleware/authentication.rb

@@ -24,6 +24,7 @@ module Restforce
       raise Restforce::AuthenticationError, error_message(response) if response.status != 200
       @options[:instance_url] = response.body['instance_url']
       @options[:oauth_token]  = response.body['access_token']
+      @options[:authentication_callback].call(response.body) if @options[:authentication_callback]
       response.body
     end
 

data/lib/restforce/sobject.rb

@@ -2,7 +2,7 @@ module Restforce
   class SObject < Restforce::Mash
 
     def sobject_type
-      self.attributes.type
+      self.attributes['type']
     end
 
     # Public: Get the describe for this sobject type
@@ -10,6 +10,11 @@ module Restforce
       @client.describe(sobject_type)
     end
 
+    # Public: Describe layouts for this sobject type
+    def describe_layouts(layout_id = nil)
+      @client.describe_layouts(sobject_type, layout_id)
+    end
+
     # Public: Persist the attributes to Salesforce.
     #
     # Examples

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '1.4.1'
+  VERSION = '1.4.2'
 end

data/restforce.gemspec

@@ -17,11 +17,11 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'faraday', '~> 0.8.4'
   gem.add_dependency 'faraday_middleware', '>= 0.8.8'
-  gem.add_dependency 'json', '~> 1.7.5'
-  gem.add_dependency 'hashie', '~> 1.2.0'
+  gem.add_dependency 'json', ['>= 1.7.5', '< 1.9.0']
+  gem.add_dependency 'hashie', ['>= 1.2.0', '< 2.1']
 
-  gem.add_development_dependency 'rspec', '~> 2.12.0'
-  gem.add_development_dependency 'webmock', '~> 1.9.0'
+  gem.add_development_dependency 'rspec', '~> 2.14.0'
+  gem.add_development_dependency 'webmock', '~> 1.13.0'
   gem.add_development_dependency 'simplecov', '~> 0.7.1'
   gem.add_development_dependency 'faye' unless RUBY_PLATFORM == 'java'
 end

data/spec/spec_helper.rb

@@ -9,6 +9,12 @@ require 'webmock/rspec'
 
 WebMock.disable_net_connect!
 
+RSpec.configure do |config|
+  config.order = 'random'
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
 # 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}

data/spec/support/middleware.rb

@@ -6,6 +6,8 @@ module MiddlewareExampleGroup
       let(:retries)        { 3 }
       let(:options)        { { } }
       let(:client)         { double(Restforce::AbstractClient) }
+      let(:auth_callback)  { double(Proc) }
+      let(:success_response) { Restforce::Mash.new(JSON.parse(fixture(:auth_success_response))) }
       subject(:middleware) { described_class.new app, client, options }
     end
   end
@@ -25,16 +27,27 @@ shared_examples_for 'authentication middleware' do
     context 'when successful' do
       let!(:request) { success_request }
 
-      before do
-        middleware.authenticate!
-      end
-
       describe '@options' do
         subject { options }
 
+        before do
+          middleware.authenticate!
+        end
+
         its([:instance_url]) { should eq 'https://na1.salesforce.com' }
         its([:oauth_token])  { should eq '00Dx0000000BV7z!AR8AQAxo9UfVkh8AlV0Gomt9Czx9LjHnSSpwBMmbRcgKFmxOtvxjTrKW19ye6PE3Ds1eQz3z8jr3W7_VbWmEu4Q8TVGSTHxs' }
       end
+
+      context 'when an authentication_callback is specified' do
+        before(:each) do
+          options.merge!(:authentication_callback => auth_callback)
+        end
+
+        it 'calls the authentication callback with the response body' do
+          auth_callback.should_receive(:call).with(success_response)
+          middleware.authenticate!
+        end
+      end
     end
 
     context 'when unsuccessful' do
@@ -45,6 +58,19 @@ shared_examples_for 'authentication middleware' do
           middleware.authenticate!
         }.to raise_error Restforce::AuthenticationError, /^invalid_grant: .*/
       end
+
+      context 'when an authentication_callback is specified' do
+        before(:each) do
+          options.merge!(:authentication_callback => auth_callback)
+        end
+
+        it 'does not call the authentication callback' do
+          auth_callback.should_not_receive(:call)
+          expect do
+            middleware.authenticate!
+          end.to raise_error
+        end
+      end
     end
   end
 end

data/spec/unit/collection_spec.rb

@@ -32,12 +32,14 @@ describe Restforce::Collection do
 
         its(:size)  { should eq 2 }
         its(:first) { should be_a Restforce::SObject }
+        its(:current_page) { should be_a Array }
+        its(:current_page) { should have(1).element }
       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))
+            and_return(double(:body => Restforce::Collection.new(next_page, client)))
         end
 
         its(:pages)          { should be_all { |page| expect(page).to be_a Restforce::Collection } }

data/spec/unit/concerns/api_spec.rb

@@ -37,6 +37,28 @@ describe Restforce::Concerns::API do
     end
   end
 
+  describe '.describe_layouts' do
+    subject(:describe_layouts) { client.describe_layouts('Whizbang') }
+
+    it 'returns the layouts for the sobject' do
+      client.should_receive(:api_get).
+        with('sobjects/Whizbang/describe/layouts').
+        and_return(response)
+      expect(describe_layouts).to eq response.body
+    end
+
+    context 'when given the id of a layout' do
+      subject(:describe_layouts) { client.describe_layouts('Whizbang', '012E0000000RHEp') }
+
+      it 'returns the describe for the specified layout' do
+        client.should_receive(:api_get).
+          with('sobjects/Whizbang/describe/layouts/012E0000000RHEp').
+          and_return(response)
+        expect(describe_layouts).to eq response.body
+      end
+    end
+  end
+
   describe '.org_id' do
     subject(:org_id) { client.org_id }
 

data/spec/unit/concerns/authentication_spec.rb

@@ -22,7 +22,7 @@ describe Restforce::Concerns::Authentication do
         authentication_middleware.
           should_receive(:new).
           with(nil, client, client.options).
-          and_return(stub(:authenticate! => 'foo'))
+          and_return(double(:authenticate! => 'foo'))
         expect(result).to eq 'foo'
       end
     end
@@ -95,4 +95,4 @@ describe Restforce::Concerns::Authentication do
       it { should_not be_true }
     end
   end
-end
+end

data/spec/unit/concerns/connection_spec.rb

@@ -11,4 +11,12 @@ describe Restforce::Concerns::Connection do
 
     it { should eq builder }
   end
+
+  describe '#adapter' do
+    before do
+      client.stub :options => {:adapter => :typhoeus}
+    end
+
+    its(:adapter) { should eq(:typhoeus) }
+  end
 end

data/spec/unit/config_spec.rb

@@ -25,7 +25,7 @@ describe Restforce do
       its(:adapter)                { should eq Faraday.default_adapter }
       [:username, :password, :security_token, :client_id, :client_secret,
        :oauth_token, :refresh_token, :instance_url, :compress, :timeout,
-       :proxy_uri].each do |attr|
+       :proxy_uri, :authentication_callback].each do |attr|
         its(attr) { should be_nil }
       end
     end
@@ -55,7 +55,7 @@ describe Restforce do
   describe '#configure' do
     [:username, :password, :security_token, :client_id, :client_secret, :compress, :timeout,
      :oauth_token, :refresh_token, :instance_url, :api_version, :host, :authentication_retries,
-     :proxy_uri].each do |attr|
+     :proxy_uri, :authentication_callback].each do |attr|
       it "allows #{attr} to be set" do
         Restforce.configure do |config|
           config.send("#{attr}=", 'foobar')

data/spec/unit/sobject_spec.rb

@@ -65,4 +65,22 @@ describe Restforce::SObject do
 
     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

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 1.4.1
-  prerelease: 
+  version: 1.4.2
 platform: ruby
 authors:
 - Eric J. Holmes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-19 00:00:00.000000000 Z
+date: 2013-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,87 +27,88 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.8
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     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
-    none: false
     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
-    none: false
     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
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +116,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,17 +123,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faye
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A lightweight ruby client for the Salesforce REST api.
@@ -257,33 +252,26 @@ files:
 - spec/unit/tooling/client_spec.rb
 homepage: https://github.com/ejholmes/restforce
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1556101281965570886
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1556101281965570886
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A lightweight ruby client for the Salesforce REST api.
 test_files:
 - spec/fixtures/auth_error_response.json