restforce 1.3.0 → 1.4.0

data/lib/restforce/{client → concerns}/caching.rb

@@ -1,5 +1,5 @@
 module Restforce
-  class Client
+  module Concerns
     module Caching
 
       # Public: Runs the block with caching disabled.
@@ -8,17 +8,17 @@ module Restforce
       #
       # Returns the result of the block
       def without_caching(&block)
-        @options[:use_cache] = false
+        options[:use_cache] = false
         block.call
       ensure
-        @options.delete(:use_cache)
+        options.delete(:use_cache)
       end
 
     private
 
       # Internal: Cache to use for the caching middleware
       def cache
-        @options[:cache]
+        options[:cache]
       end
 
     end

data/lib/restforce/concerns/canvas.rb

@@ -0,0 +1,12 @@
+module Restforce
+  module Concerns
+    module Canvas
+
+      def decode_signed_request(signed_request)
+        raise 'client_secret not set.' unless options[:client_secret]
+        SignedRequest.decode(signed_request, options[:client_secret])
+      end
+
+    end
+  end
+end

data/lib/restforce/{client → concerns}/connection.rb

@@ -1,5 +1,5 @@
 module Restforce
-  class Client
+  module Concerns
     module Connection
 
       # Public: The Faraday::Builder instance used for the middleware stack. This
@@ -14,36 +14,37 @@ module Restforce
       def middleware
         connection.builder
       end
+      alias_method :builder, :middleware
 
     private
 
       # Internal: Internal faraday connection where all requests go through
       def connection
-        @connection ||= Faraday.new(@options[:instance_url], connection_options) do |builder|
+        @connection ||= Faraday.new(options[:instance_url], connection_options) do |builder|
           # Parses JSON into Hashie::Mash structures.
-          builder.use      Restforce::Middleware::Mashify, self, @options
+          builder.use      Restforce::Middleware::Mashify, self, options
           # Handles multipart file uploads for blobs.
           builder.use      Restforce::Middleware::Multipart
           # Converts the request into JSON.
           builder.request  :json
           # Handles reauthentication for 403 responses.
-          builder.use      authentication_middleware, self, @options if authentication_middleware
+          builder.use      authentication_middleware, self, options if authentication_middleware
           # Sets the oauth token in the headers.
-          builder.use      Restforce::Middleware::Authorization, self, @options
+          builder.use      Restforce::Middleware::Authorization, self, options
           # Ensures the instance url is set.
-          builder.use      Restforce::Middleware::InstanceURL, self, @options
+          builder.use      Restforce::Middleware::InstanceURL, self, options
           # Parses returned JSON response into a hash.
           builder.response :json, :content_type => /\bjson$/
           # Caches GET requests.
-          builder.use      Restforce::Middleware::Caching, cache, @options if cache
+          builder.use      Restforce::Middleware::Caching, cache, options if cache
           # Follows 30x redirects.
           builder.use      FaradayMiddleware::FollowRedirects
           # Raises errors for 40x responses.
           builder.use      Restforce::Middleware::RaiseError
           # Log request/responses
-          builder.use      Restforce::Middleware::Logger, Restforce.configuration.logger, @options if Restforce.log?
+          builder.use      Restforce::Middleware::Logger, Restforce.configuration.logger, options if Restforce.log?
           # Compress/Decompress the request/response
-          builder.use      Restforce::Middleware::Gzip, self, @options
+          builder.use      Restforce::Middleware::Gzip, self, options
 
           builder.adapter  adapter
         end
@@ -56,9 +57,9 @@ module Restforce
       # Internal: Faraday Connection options
       def connection_options
         { :request => {
-            :timeout => @options[:timeout],
-            :open_timeout => @options[:timeout] }, 
-          :proxy => @options[:proxy_uri]
+            :timeout => options[:timeout],
+            :open_timeout => options[:timeout] },
+          :proxy => options[:proxy_uri]
         }
       end
 

data/lib/restforce/{client → concerns}/picklists.rb

@@ -1,5 +1,5 @@
 module Restforce
-  class Client
+  module Concerns
     module Picklists
 
       # Public: Get the available picklist values for a picklist or multipicklist field.

data/lib/restforce/{client → concerns}/streaming.rb

@@ -1,5 +1,5 @@
 module Restforce
-  class Client
+  module Concerns
     module Streaming
 
       # Public: Subscribe to a PushTopic
@@ -14,8 +14,8 @@ module Restforce
 
       # Public: Faye client to use for subscribing to PushTopics
       def faye
-        raise 'Instance URL missing. Call .authenticate! first.' unless @options[:instance_url]
-        @faye ||= Faye::Client.new("#{@options[:instance_url]}/cometd/#{@options[:api_version]}").tap do |client|
+        raise 'Instance URL missing. Call .authenticate! first.' unless options[:instance_url]
+        @faye ||= Faye::Client.new("#{options[:instance_url]}/cometd/#{options[:api_version]}").tap do |client|
           client.bind 'transport:down' do
             Restforce.log "[COMETD DOWN]"
             client.set_header 'Authorization', "OAuth #{authenticate!.access_token}"

data/lib/restforce/{client → concerns}/verbs.rb

@@ -1,5 +1,5 @@
 module Restforce
-  class Client
+  module Concerns
     module Verbs
 
       # Internal: Define methods to handle a verb.
@@ -31,13 +31,13 @@ module Restforce
       # Returns nil.
       def define_verb(verb)
         define_method verb do |*args, &block|
-          retries = @options[:authentication_retries]
+          retries = options[:authentication_retries]
           begin
             connection.send(verb, *args, &block)
           rescue Restforce::UnauthorizedError
             if retries > 0
               retries -= 1
-              connection.url_prefix = @options[:instance_url]
+              connection.url_prefix = options[:instance_url]
               retry
             end
             raise
@@ -51,7 +51,7 @@ module Restforce
       # verb - Symbol name of the verb (e.g. :get).
       #
       # Examples
-      #   
+      #
       #   define_api_verb :get
       #   # => api_get 'sobjects'
       #

data/lib/restforce/config.rb

@@ -37,18 +37,48 @@ module Restforce
   end
 
   class Configuration
+    class Option
+      attr_reader :configuration, :name, :options
+
+      def self.define(*args)
+        new(*args).define
+      end
+
+      def initialize(configuration, name, options = {})
+        @configuration, @name, @options = configuration, name, options
+        @default = options.fetch(:default, nil)
+      end
+
+      def define
+        write_attribute
+        define_method if default_provided?
+        self
+      end
+
+    private
+      attr_reader :default
+      alias_method :default_provided?, :default
+
+      def write_attribute
+        configuration.send :attr_accessor, name
+      end
+
+      def define_method
+        our_default = default
+        our_name    = name
+        configuration.send :define_method, our_name do
+          instance_variable_get(:"@#{our_name}") ||
+            instance_variable_set(:"@#{our_name}", our_default.respond_to?(:call) ? our_default.call : our_default)
+        end
+      end
+    end
+
     class << self
       attr_accessor :options
 
-      def option(name, options = {})
-        default = options.fetch(:default, nil)
-        attr_accessor name
-        define_method name do
-          instance_variable_get(:"@#{name}") ||
-            instance_variable_set(:"@#{name}", default.respond_to?(:call) ? default.call : default)
-        end if default
-        self.options ||= []
-        self.options << name
+      def option(*args)
+        option = Option.define(self, *args)
+        (self.options ||= []) << option.name
       end
     end
 
@@ -71,7 +101,7 @@ module Restforce
 
     # Set this to true if you're authenticating with a Sandbox instance.
     # Defaults to false.
-    option :host, :default => 'login.salesforce.com'
+    option :host, :default => lambda { ENV['SALESFORCE_HOST'] || 'login.salesforce.com' }
 
     option :oauth_token
     option :refresh_token

data/lib/restforce/data/client.rb

@@ -0,0 +1,18 @@
+module Restforce
+  module Data
+    class Client < AbstractClient
+      include Restforce::Concerns::Streaming
+      include Restforce::Concerns::Picklists
+      include Restforce::Concerns::Canvas
+
+      # Public: Returns a url to the resource.
+      #
+      # resource - A record that responds to to_sparam or a String/Fixnum.
+      #
+      # Returns the url to the resource.
+      def url(resource)
+        "#{instance_url}/#{(resource.respond_to?(:to_sparam) ? resource.to_sparam : resource)}"
+      end
+    end
+  end
+end

data/lib/restforce/middleware/authentication.rb

@@ -29,12 +29,13 @@ module Restforce
 
     # Internal: The params to post to the OAuth service.
     def params
-      raise 'not implemented'
+      raise NotImplementedError
     end
 
     # Internal: Faraday connection to use when sending an authentication request.
     def connection
-      @connection ||= Faraday.new(:url => "https://#{@options[:host]}") do |builder|
+      @connection ||= Faraday.new(faraday_options) do |builder|
+        builder.use Faraday::Request::UrlEncoded
         builder.use Restforce::Middleware::Mashify, nil, @options
         builder.response :json
         builder.use Restforce::Middleware::Logger, Restforce.configuration.logger, @options if Restforce.log?
@@ -59,5 +60,11 @@ module Restforce
         end.join('&')
       end
     end
+
+  private
+    def faraday_options
+      { :url   => "https://#{@options[:host]}",
+        :proxy => @options[:proxy_uri] }.reject { |k, v| v.nil? }
+    end
   end
 end

data/lib/restforce/sobject.rb

@@ -57,7 +57,7 @@ module Restforce
 
     def ensure_id
       return true if self.Id?
-      raise 'You need to query the Id for the record first.'
+      raise ArgumentError, 'You need to query the Id for the record first.'
     end
 
   end

data/lib/restforce/tooling/client.rb

@@ -0,0 +1,13 @@
+module Restforce
+  module Tooling
+    class Client < AbstractClient
+
+      private
+
+        def api_path(path)
+          super("tooling/#{path}")
+        end
+
+    end
+  end
+end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/spec/{lib/client_spec.rb → integration/abstract_client_spec.rb}

@@ -1,74 +1,6 @@
 require 'spec_helper'
 
-shared_examples_for 'methods' do
-  describe '#new' do
-    context 'without options passed in' do
-      it 'does not raise an exception' do
-        expect {
-          described_class.new
-        }.to_not raise_error
-      end
-    end
-
-    context 'with a non-hash value' do
-      it 'raises 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 '.instance_url' do
-    subject { client.instance_url }
-    it { should eq 'https://na1.salesforce.com' }
-  end
-
-  describe '.url' do
-    subject { client.url(resource) }
-
-    context 'when given something that responds to to_sparam' do
-      let(:resource) { Struct.new(:to_sparam).new('1234') }
-      it { should eq 'https://na1.salesforce.com/1234' }
-    end
-
-    context 'when given a string' do
-      let(:resource) { '4321' }
-      it { should eq 'https://na1.salesforce.com/4321' }
-    end
-  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 refresh token, client id and client secret provided' do
-      let(:client_options) { oauth_options }
-      it { should eq Restforce::Middleware::Authentication::Token }
-    end
-  end
-
+shared_examples_for Restforce::AbstractClient do
   describe '.list_sobjects' do
     requests :sobjects, :fixture => 'sobject/describe_sobjects_success_response'
 
@@ -145,15 +77,15 @@ shared_examples_for 'methods' do
         :status => 404,
         :fixture => 'sobject/delete_error_response'
 
-      subject { client.update!('Account', :Id => '001D000000INjVe', :Name => 'Foobar') }
-      specify { expect { subject }.to raise_error Faraday::Error::ResourceNotFound }
+      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 { client.update('Account', :Name => 'Foobar') }
-      specify { expect { subject }.to raise_error RuntimeError, 'Id field missing.' }
+      subject { lambda { client.update('Account', :Name => 'Foobar') } }
+      it { should raise_error ArgumentError, 'Id field missing from attrs.' }
     end
 
     context 'with invalid Id' do
@@ -214,7 +146,7 @@ shared_examples_for 'methods' do
   end
 
   describe '.destroy!' do
-    subject { client.destroy!('Account', '001D000000INjVe') }
+    subject(:destroy!) { client.destroy!('Account', '001D000000INjVe') }
 
     context 'with invalid Id' do
       requests 'sobjects/Account/001D000000INjVe',
@@ -222,7 +154,8 @@ shared_examples_for 'methods' do
         :method => :delete,
         :status => 404
 
-      specify { expect { subject }.to raise_error Faraday::Error::ResourceNotFound }
+      subject { lambda { destroy! } }
+      it { should raise_error Faraday::Error::ResourceNotFound }
     end
 
     context 'with success' do
@@ -269,44 +202,8 @@ shared_examples_for 'methods' do
     end
   end
 
-  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 '.authenticate!' do
-    subject { client.authenticate! }
+    subject(:authenticate!) { client.authenticate! }
 
     context 'when successful' do
       before do
@@ -327,29 +224,8 @@ shared_examples_for 'methods' do
         client.stub(:authentication_middleware).and_return(nil)
       end
 
-      it 'should raise an exception' do
-        expect { subject }.to raise_error Restforce::AuthenticationError, 'No authentication middleware present'
-      end
-    end
-  end
-
-  describe '.cache' do
-    let(:cache) { double('cache') }
-
-    subject { client.send :cache }
-    it { should eq cache }
-  end
-
-  describe '.middleware' do
-    subject { client.middleware }
-    it { should eq client.send(:connection).builder }
-
-    context 'adding middleware' do
-      before do
-        client.middleware.use FaradayMiddleware::Instrumentation
-      end
-
-      its(:handlers) { should include FaradayMiddleware::Instrumentation }
+      subject { lambda { authenticate! } }
+      it { should raise_error Restforce::AuthenticationError, 'No authentication middleware present'}
     end
   end
 
@@ -367,56 +243,6 @@ shared_examples_for 'methods' do
     it { should be_an Enumerable }
   end
 
-  unless RUBY_PLATFORM == 'java'
-    describe '.faye', :eventmachine => 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', :eventmachine => 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 '.decode_signed_request' do
-    it 'proxies to Restforce::SignedRequest' do
-      Restforce::SignedRequest.should_receive(:decode).with('foo', client_secret)
-      client.decode_signed_request('foo')
-    end
-  end
-
   describe 'authentication retries' do
     context 'when retries reaches 0' do
       before do
@@ -428,8 +254,8 @@ shared_examples_for 'methods' do
           to_return(:status => 200, :body => fixture(:auth_success_response))
       end
 
-      subject { client.query('SELECT some, fields FROM object') }
-      specify { expect { subject }.to raise_error Restforce::UnauthorizedError }
+      subject { lambda { client.query('SELECT some, fields FROM object') } }
+      it { should raise_error Restforce::UnauthorizedError }
     end
   end
 
@@ -457,43 +283,24 @@ shared_examples_for 'methods' do
   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 Restforce::AbstractClient do
+  describe 'with mashify' do
+    it_behaves_like Restforce::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'
 
-        subject { client.query('SELECT some, fields FROM object').next_page }
         it { should be_a Restforce::Collection }
-        specify { expect(subject.first.Text_Label).to eq 'Last Page' }
+        its('first.Text_Label') { should eq 'Last Page'}
       end
     end
   end
-end
-
-describe 'without mashify middleware' do
-  before do
-    client.middleware.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
+  describe 'without mashify', :mashify => false do
+    it_behaves_like Restforce::AbstractClient
   end
 end