restforce 1.5.3 → 2.0.0

data/lib/restforce/concerns/caching.rb

@@ -1,7 +1,6 @@
 module Restforce
   module Concerns
     module Caching
-
       # Public: Runs the block with caching disabled.
       #
       # block - A query/describe/etc.
@@ -14,13 +13,12 @@ module Restforce
         options.delete(:use_cache)
       end
 
-    private
+      private
 
       # Internal: Cache to use for the caching middleware
       def cache
         options[:cache]
       end
-
     end
   end
 end

data/lib/restforce/concerns/canvas.rb

@@ -1,12 +1,10 @@
 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/concerns/connection.rb

@@ -1,7 +1,6 @@
 module Restforce
   module Concerns
     module Connection
-
       # Public: The Faraday::Builder instance used for the middleware stack. This
       # can be used to insert an custom middleware.
       #
@@ -16,25 +15,31 @@ module Restforce
       end
       alias_method :builder, :middleware
 
-    private
+      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 unless (options[:mashify] == false)
+          unless (options[:mashify] == false)
+            builder.use    Restforce::Middleware::Mashify, self, options
+          end
+
           # 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
+          if authentication_middleware
+            builder.use    authentication_middleware, self, options
+          end
           # Sets the oauth token in the headers.
           builder.use      Restforce::Middleware::Authorization, self, options
           # Ensures the instance url is set.
           builder.use      Restforce::Middleware::InstanceURL, self, options
           # Parses returned JSON response into a hash.
-          builder.response :json, :content_type => /\bjson$/
+          builder.response :json, content_type: /\bjson$/
           # Caches GET requests.
           builder.use      Restforce::Middleware::Caching, cache, options if cache
           # Follows 30x redirects.
@@ -42,7 +47,9 @@ module Restforce
           # 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
 
@@ -56,10 +63,10 @@ module Restforce
 
       # Internal: Faraday Connection options
       def connection_options
-        { :request => {
-            :timeout => options[:timeout],
-            :open_timeout => options[:timeout] },
-          :proxy => options[:proxy_uri]
+        { request: {
+            timeout: options[:timeout],
+            open_timeout: options[:timeout] },
+          proxy: options[:proxy_uri]
         }
       end
 
@@ -68,7 +75,6 @@ module Restforce
       def mashify?
         middleware.handlers.index(Restforce::Middleware::Mashify)
       end
-
     end
   end
 end

data/lib/restforce/concerns/picklists.rb

@@ -1,7 +1,6 @@
 module Restforce
   module Concerns
     module Picklists
-
       # Public: Get the available picklist values for a picklist or multipicklist field.
       #
       # sobject - The String name of the sobject.
@@ -27,18 +26,18 @@ module Restforce
         PicklistValues.new(describe(sobject)['fields'], field, options)
       end
 
-    private
+      private
 
       class PicklistValues < Array
-
         def initialize(fields, field, options = {})
-          @fields, @field = fields, field
+          @fields = fields
+          @field = field
           @valid_for = options.delete(:valid_for)
           raise "#{field} is not a dependent picklist" if @valid_for && !dependent?
           replace(picklist_values)
         end
 
-      private
+        private
 
         attr_reader :fields
 
@@ -60,7 +59,8 @@ module Restforce
         end
 
         def controlling_picklist
-          @_controlling_picklist ||= controlling_field['picklistValues'].find { |picklist_entry| picklist_entry['value'] == @valid_for }
+          @_controlling_picklist ||= controlling_field['picklistValues'].
+            find { |picklist_entry| picklist_entry['value'] == @valid_for }
         end
 
         def index
@@ -77,14 +77,14 @@ module Restforce
 
         # Returns true if the picklist entry is valid for the controlling picklist.
         #
-        # See http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_describesobjects_describesobjectresult.htm
+        # See http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_des
+        # cribesobjects_describesobjectresult.htm
         def valid?(picklist_entry)
-          valid_for = picklist_entry['validFor'].ljust(16, 'A').unpack('m').first.unpack('q*')
+          valid_for = picklist_entry['validFor'].ljust(16, 'A').unpack('m').first.
+            unpack('q*')
           (valid_for[index >> 3] & (0x80 >> index % 8)) != 0
         end
-
       end
-
     end
   end
 end

data/lib/restforce/concerns/streaming.rb

@@ -1,7 +1,6 @@
 module Restforce
   module Concerns
     module Streaming
-
       # Public: Subscribe to a PushTopic
       #
       # channels - The name of the PushTopic channel(s) to subscribe to.
@@ -14,19 +13,25 @@ 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|
+        unless options[:instance_url]
+          raise 'Instance URL missing. Call .authenticate! first.'
+        end
+
+        url = "#{options[:instance_url]}/cometd/#{options[:api_version]}"
+
+        @faye ||= Faye::Client.new(url).tap do |client|
           client.set_header 'Authorization', "OAuth #{options[:oauth_token]}"
+
           client.bind 'transport:down' do
             Restforce.log "[COMETD DOWN]"
             client.set_header 'Authorization', "OAuth #{authenticate!.access_token}"
           end
+
           client.bind 'transport:up' do
             Restforce.log "[COMETD UP]"
           end
         end
       end
-
     end
   end
 end

data/lib/restforce/concerns/verbs.rb

@@ -1,7 +1,6 @@
 module Restforce
   module Concerns
     module Verbs
-
       # Internal: Define methods to handle a verb.
       #
       # verbs - A list of verbs to define methods for.
@@ -62,7 +61,6 @@ module Restforce
           send(verb, *args, &block)
         end
       end
-
     end
   end
 end

data/lib/restforce/config.rb

@@ -45,7 +45,9 @@ module Restforce
       end
 
       def initialize(configuration, name, options = {})
-        @configuration, @name, @options = configuration, name, options
+        @configuration = configuration
+        @name = name
+        @options = options
         @default = options.fetch(:default, nil)
       end
 
@@ -55,7 +57,8 @@ module Restforce
         self
       end
 
-    private
+      private
+
       attr_reader :default
       alias_method :default_provided?, :default
 
@@ -68,7 +71,10 @@ module Restforce
         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)
+            instance_variable_set(
+              :"@#{our_name}",
+              our_default.respond_to?(:call) ? our_default.call : our_default
+            )
         end
       end
     end
@@ -82,26 +88,26 @@ module Restforce
       end
     end
 
-    option :api_version, :default => '26.0'
+    option :api_version, default: '26.0'
 
     # The username to use during login.
-    option :username, :default => lambda { ENV['SALESFORCE_USERNAME'] }
+    option :username, default: lambda { ENV['SALESFORCE_USERNAME'] }
 
     # The password to use during login.
-    option :password, :default => lambda { ENV['SALESFORCE_PASSWORD'] }
+    option :password, default: lambda { ENV['SALESFORCE_PASSWORD'] }
 
     # The security token to use during login.
-    option :security_token, :default => lambda { ENV['SALESFORCE_SECURITY_TOKEN'] }
+    option :security_token, default: lambda { ENV['SALESFORCE_SECURITY_TOKEN'] }
 
     # The OAuth client id
-    option :client_id, :default => lambda { ENV['SALESFORCE_CLIENT_ID'] }
+    option :client_id, default: lambda { ENV['SALESFORCE_CLIENT_ID'] }
 
     # The OAuth client secret
-    option :client_secret, :default => lambda { ENV['SALESFORCE_CLIENT_SECRET'] }
+    option :client_secret, default: lambda { ENV['SALESFORCE_CLIENT_SECRET'] }
 
     # Set this to true if you're authenticating with a Sandbox instance.
     # Defaults to false.
-    option :host, :default => lambda { ENV['SALESFORCE_HOST'] || 'login.salesforce.com' }
+    option :host, default: lambda { ENV['SALESFORCE_HOST'] || 'login.salesforce.com' }
 
     option :oauth_token
     option :refresh_token
@@ -112,7 +118,7 @@ module Restforce
     option :cache
 
     # The number of times reauthentication should be tried before failing.
-    option :authentication_retries, :default => 3
+    option :authentication_retries, default: 3
 
     # Set to true if you want responses from Salesforce to be gzip compressed.
     option :compress
@@ -125,10 +131,10 @@ module Restforce
     option :timeout
 
     # Faraday adapter to use. Defaults to Faraday.default_adapter.
-    option :adapter, :default => lambda { Faraday.default_adapter }
+    option :adapter, default: lambda { Faraday.default_adapter }
 
     # TODO: Rename this to `SALESFORCE_PROXY_URI` in next major version
-    option :proxy_uri, :default => lambda { ENV['PROXY_URI'] }
+    option :proxy_uri, default: lambda { ENV['PROXY_URI'] }
 
     # A Proc that is called with the response body after a successful authentication.
     option :authentication_callback

data/lib/restforce/data/client.rb

@@ -11,7 +11,14 @@ module Restforce
       #
       # Returns the url to the resource.
       def url(resource)
-        "#{instance_url}/#{(resource.respond_to?(:to_sparam) ? resource.to_sparam : resource)}"
+        resource_name_for_url =
+          if resource.respond_to?(:to_sparam)
+            resource.to_sparam
+          else
+            resource
+          end
+
+        "#{instance_url}/#{resource_name_for_url}"
       end
     end
   end

data/lib/restforce/mash.rb

@@ -2,15 +2,13 @@ require 'hashie/mash'
 
 module Restforce
   class Mash < Hashie::Mash
-
     class << self
-
       # Pass in an Array or Hash and it will be recursively converted into the
       # appropriate Restforce::Collection, Restforce::SObject and
       # Restforce::Mash objects.
       def build(val, client)
         if val.is_a?(Array)
-          val.collect { |val| self.build(val, client) }
+          val.collect { |a_val| self.build(a_val, client) }
         elsif val.is_a?(Hash)
           self.klass(val).new(val, client)
         else
@@ -21,11 +19,11 @@ module Restforce
       # When passed a hash, it will determine what class is appropriate to
       # represent the data.
       def klass(val)
-        if val.has_key? 'records'
+        if val.key? 'records'
           # When the hash has a records key, it should be considered a collection
           # of sobject records.
           Restforce::Collection
-        elsif val.has_key? 'attributes'
+        elsif val.key? 'attributes'
           if val['attributes']['type'] == 'Attachment'
             Restforce::Attachment
           else
@@ -38,7 +36,6 @@ module Restforce
           Restforce::Mash
         end
       end
-
     end
 
     def initialize(source_hash = nil, client = nil, default = nil, &blk)
@@ -50,8 +47,8 @@ module Restforce
     def dup
       self.class.new(self, @client, self.default)
     end
-  
-    def convert_value(val, duping=false)
+
+    def convert_value(val, duping = false)
       case val
       when self.class
         val.dup
@@ -59,11 +56,10 @@ module Restforce
         val = val.dup if duping
         self.class.klass(val).new(val, @client)
       when Array
-        val.collect{ |e| convert_value(e) }
+        val.collect { |e| convert_value(e) }
       else
         val
       end
     end
-
   end
 end

data/lib/restforce/middleware.rb

@@ -13,7 +13,9 @@ module Restforce
     autoload :Gzip,           'restforce/middleware/gzip'
 
     def initialize(app, client, options)
-      @app, @client, @options = app, client, options
+      @app = app
+      @client = client
+      @options = options
     end
 
     # Internal: Proxy to the client.

data/lib/restforce/middleware/authentication.rb

@@ -21,10 +21,18 @@ module Restforce
       response = connection.post '/services/oauth2/token' do |req|
         req.body = encode_www_form(params)
       end
-      raise Restforce::AuthenticationError, error_message(response) if response.status != 200
+
+      if response.status != 200
+        raise Restforce::AuthenticationError, error_message(response)
+      end
+
       @options[:instance_url] = response.body['instance_url']
       @options[:oauth_token]  = response.body['access_token']
-      @options[:authentication_callback].call(response.body) if @options[:authentication_callback]
+
+      if @options[:authentication_callback]
+        @options[:authentication_callback].call(response.body)
+      end
+
       response.body
     end
 
@@ -39,7 +47,11 @@ module Restforce
         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?
+
+        builder.use Restforce::Middleware::Logger,
+                    Restforce.configuration.logger,
+                    @options if Restforce.log?
+
         builder.adapter Faraday.default_adapter
       end
     end
@@ -56,16 +68,18 @@ module Restforce
         URI.encode_www_form(params)
       else
         params.map do |k, v|
-          k, v = CGI.escape(k.to_s), CGI.escape(v.to_s)
+          k = CGI.escape(k.to_s)
+          v = CGI.escape(v.to_s)
           "#{k}=#{v}"
         end.join('&')
       end
     end
 
-  private
+    private
+
     def faraday_options
-      { :url   => "https://#{@options[:host]}",
-        :proxy => @options[:proxy_uri] }.reject { |k, v| v.nil? }
+      { url: "https://#{@options[:host]}",
+        proxy: @options[:proxy_uri] }.reject { |k, v| v.nil? }
     end
   end
 end