restforce 1.5.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cea59c76c61a80f9b37c19dd5fcf0dc65724c706
-  data.tar.gz: 803df3bf79c4f7852dd1b1f604ec394981675ac6
+  metadata.gz: b5ecae4e8e7e8b52ae216ad1b0505000eebb2a4f
+  data.tar.gz: 27125a8223a2bf25ec80cc0dff6020021a8f0505
 SHA512:
-  metadata.gz: dc604478ae597a50c0f7ca90236df153a3065f3adca8527012f28e2904e71e0ccda68adedb372e88f183598d99054776cc4e7d5ba5823af200d77bb1fbf3526b
-  data.tar.gz: 5b4fb8dff7ea15b51cb6a6e64d7e3d60985eaa46e2fdf7054725c1c3790faaacbdec056757083a47461462a3b0d6362811725dd019e767932d187c70728fc4d1
+  metadata.gz: c829bf4711eadbadcb26b5db972a4ecc71d08181e124e64dfaf3663713f0e74d1490eee4617d71d3c29827e2c943319eb2ab5a0b0c26ed4f314ebfcc5cec748f
+  data.tar.gz: 90292fda7e4053b90f6de1a4d73ac1df40fa9f4867765fb6082e326de314e27577c1079920f1a04d547dbf1b4f4c9562e695210b842ed3ad294ef8aef131dd2f

data/.rubocop.yml

@@ -0,0 +1,60 @@
+# For all options see https://github.com/bbatsov/rubocop/tree/master/config
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  RunRailsCops: false
+  Include:
+    - Rakefile
+  Exclude:
+    - .*/**/*
+
+# Limit lines to 80 characters.
+LineLength:
+  Max: 90
+
+ClassLength:
+  Enabled: false
+
+ModuleLength:
+  Enabled: false
+
+# Avoid methods longer than 30 lines of code
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 87
+
+# Avoid single-line methods.
+SingleLineMethods:
+  AllowIfMethodIsEmpty: true
+
+StringLiterals:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false # We use them Redis + StatsD (though maybe we shouldn't?)
+
+# Wants underscores in all large numbers. Pain in the ass for things like
+# unix timestamps.
+NumericLiterals:
+  Enabled: false
+
+# Wants you to use the same argument names for every reduce. This seems kinda
+# naff compared to naming them semantically
+SingleLineBlockParams:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: 'only_raise'
+
+# Use trailing rather than leading dots on multi-line call chains
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Allow non-ASCII characters (e.g. £) in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Allow method names beginning with capital letters to match Salesforce conventions
+Style/MethodName:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,117 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-06-06 22:47:07 +0100 using RuboCop version 0.32.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 50
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# Offense count: 187
+Metrics/AbcSize:
+  Max: 61
+
+# Offense count: 26
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 11
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 12
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 164
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
+Style/AlignHash:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
+  Enabled: false
+
+# Offense count: 128
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 21
+# Cop supports --auto-correct.
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+# Offense count: 13
+# Cop supports --auto-correct.
+# Configuration parameters: Keywords.
+Style/CommentAnnotation:
+  Enabled: false
+
+# Offense count: 743
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 9
+Style/DoubleNegation:
+  Enabled: false
+
+# Offense count: 109
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 48
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/IndentHash:
+  Enabled: false
+
+# Offense count: 70
+# Cop supports --auto-correct.
+Style/Lambda:
+  Enabled: false
+
+# Offense count: 577
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+# Offense count: 21
+# Configuration parameters: NamePrefix, NamePrefixBlacklist.
+Style/PredicateName:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/Proc:
+  Enabled: false
+
+# Offense count: 173
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Enabled: false
+
+# Offense count: 28
+# Cop supports --auto-correct.
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: MultiSpaceAllowedForOperators.
+Style/SpaceAroundOperators:
+  Enabled: false
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
+Style/TrivialAccessors:
+  Enabled: false

data/.travis.yml

@@ -1,14 +1,12 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - 2.1.2
-  - jruby-18mode
+  - 2.2.0
   - jruby-19mode
-  - ree
   - rbx-2
 gemfile:
   - Gemfile.travis
-script: bundle exec rake
+script:
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.0 (Jun 27, 2015)
+
+* Drop support for versions of Ruby earlier than 1.9.3, which were [end-of-lifed](https://www.ruby-lang.org/en/news/2014/07/01/eol-for-1-8-7-and-1-9-2/) long ago
+* Take advantages of Ruby 1.9.3 syntax, and drop old Ruby 1.8 shims
+* Enforce code style with [Rubocop](https://github.com/bbatsov/rubocop)
+
 ## 1.5.3 (Jun 26, 2015)
 
 * Fixed a bug with `update!` and `upsert!` mutating provided attributes (@timrogers)

data/README.md

@@ -35,6 +35,8 @@ Or install it yourself as:
 
     $ gem install restforce
 
+__As of [version 2.0.0](https://github.com/ejholmes/restforce/blob/master/CHANGELOG.md#200-jun-27-2015), this gem is only compatible with Ruby 1.9.3 and later.__ To use Ruby 1.9.2 and below, you'll need to manually specify that you wish to use version 1.5.3.
+
 ## Usage
 
 Restforce is designed with flexibility and ease of use in mind. By default, all API calls will

data/Rakefile

@@ -1,7 +1,7 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
 
-task :default => [:spec]
+task default: [:spec]
 
 require 'rspec/core/rake_task'
 desc "Run specs"

data/lib/restforce/abstract_client.rb

@@ -6,4 +6,4 @@ module Restforce
     include Restforce::Concerns::Caching
     include Restforce::Concerns::API
   end
-end
+end

data/lib/restforce/attachment.rb

@@ -1,6 +1,5 @@
 module Restforce
   class Attachment < Restforce::SObject
-
     # Public: Returns the body of the attachment.
     #
     # Examples
@@ -12,12 +11,11 @@ module Restforce
       @client.get(super).body
     end
 
-  private
+    private
 
     def ensure_body
       return true if self.Body?
       raise 'You need to query the Body for the record first.'
     end
-
   end
 end

data/lib/restforce/concerns/api.rb

@@ -72,7 +72,7 @@ module Restforce
       # Returns the Hash representation of the describe call.
       def describe(sobject = nil)
         if sobject
-          api_get("sobjects/#{sobject.to_s}/describe").body
+          api_get("sobjects/#{sobject}/describe").body
         else
           api_get('sobjects').body['sobjects']
         end
@@ -96,9 +96,9 @@ module Restforce
       # 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
+          api_get("sobjects/#{sobject}/describe/layouts/#{layout_id}").body
         else
-          api_get("sobjects/#{sobject.to_s}/describe/layouts").body
+          api_get("sobjects/#{sobject}/describe/layouts").body
         end
       end
 
@@ -125,9 +125,10 @@ module Restforce
       #   # => ['Foo Bar Inc.', 'Whizbang Corp']
       #
       # Returns a Restforce::Collection if Restforce.configuration.mashify is true.
-      # Returns an Array of Hash for each record in the result if Restforce.configuration.mashify is false.
+      # Returns an Array of Hash for each record in the result if
+      # Restforce.configuration.mashify is false.
       def query(soql)
-        response = api_get 'query', :q => soql
+        response = api_get 'query', q: soql
         mashify? ? response.body : response.body['records']
       end
 
@@ -146,9 +147,10 @@ module Restforce
       #   # => ['GenePoint']
       #
       # Returns a Restforce::Collection if Restforce.configuration.mashify is true.
-      # Returns an Array of Hash for each record in the result if Restforce.configuration.mashify is false.
+      # Returns an Array of Hash for each record in the result if
+      # Restforce.configuration.mashify is false.
       def search(sosl)
-        api_get('search', :q => sosl).body
+        api_get('search', q: sosl).body
       end
 
       # Public: Insert a new record.
@@ -262,9 +264,13 @@ module Restforce
       # Returns the Id of the newly created record if the record was created.
       # Raises an exception if an error is returned from Salesforce.
       def upsert!(sobject, field, attrs)
-        external_id = attrs.fetch(attrs.keys.find { |k, v| k.to_s.downcase == field.to_s.downcase }, nil)
-        attrs_without_field = attrs.reject { |k, v| k.to_s.downcase == field.to_s.downcase }
-        response = api_patch "sobjects/#{sobject}/#{field.to_s}/#{external_id}", attrs_without_field
+        external_id = attrs.
+          fetch(attrs.keys.find { |k, v| k.to_s.downcase == field.to_s.downcase }, nil)
+        attrs_without_field = attrs.
+          reject { |k, v| k.to_s.downcase == field.to_s.downcase }
+        response = api_patch "sobjects/#{sobject}/#{field}/#{external_id}",
+                             attrs_without_field
+
         (response.body && response.body['id']) ? response.body['id'] : true
       end
 
@@ -311,8 +317,9 @@ module Restforce
       # field   - External ID field to use (default: nil).
       #
       # Returns the Restforce::SObject sobject record.
-      def find(sobject, id, field=nil)
-        api_get(field ? "sobjects/#{sobject}/#{field}/#{id}" : "sobjects/#{sobject}/#{id}").body
+      def find(sobject, id, field = nil)
+        url = field ? "sobjects/#{sobject}/#{field}/#{id}" : "sobjects/#{sobject}/#{id}"
+        api_get(url).body
       end
 
       # Public: Finds a single record and returns select fields.
@@ -324,15 +331,14 @@ module Restforce
       #           is passed, all fields are selected.
       # field   - External ID field to use (default: nil).
       #
-      def select(sobject, id, select, field=nil)
+      def select(sobject, id, select, field = nil)
         path = field ? "sobjects/#{sobject}/#{field}/#{id}" : "sobjects/#{sobject}/#{id}"
-        path << "?fields=#{select.join(",")}" if select && select.any?
+        path << "?fields=#{select.join(',')}" if select && select.any?
 
         api_get(path).body
       end
 
-
-    private
+      private
 
       # Internal: Returns a path to an api endpoint
       #
@@ -348,7 +354,6 @@ module Restforce
       def exceptions
         [Faraday::Error::ClientError]
       end
-
     end
   end
 end

data/lib/restforce/concerns/authentication.rb

@@ -1,10 +1,12 @@
 module Restforce
   module Concerns
     module Authentication
-
       # Public: Force an authentication
       def authenticate!
-        raise AuthenticationError, 'No authentication middleware present' unless authentication_middleware
+        unless authentication_middleware
+          raise AuthenticationError, 'No authentication middleware present'
+        end
+
         middleware = authentication_middleware.new nil, self, options
         middleware.authenticate!
       end
@@ -34,7 +36,6 @@ module Restforce
           options[:client_id] &&
           options[:client_secret]
       end
-
     end
   end
 end

data/lib/restforce/concerns/base.rb

@@ -1,50 +1,62 @@
 module Restforce
   module Concerns
     module Base
-
       attr_reader :options
 
       # Public: Creates a new client instance
       #
       # opts - A hash of options to be passed in (default: {}).
-      #        :username               - The String username to use (required for password authentication).
-      #        :password               - The String password to use (required for password authentication).
-      #        :security_token         - The String security token to use (required for password authentication).
+      #        :username                - The String username to use (required for
+      #                                   password authentication).
+      #        :password                - The String password to use (required for
+      #                                   password authentication).
+      #        :security_token          - The String security token to use (required for
+      #                                   password authentication).
       #
-      #        :oauth_token            - The String oauth access token to authenticate api
-      #                                  calls (required unless password
-      #                                  authentication is used).
-      #        :refresh_token          - The String refresh token to obtain fresh
-      #                                  oauth access tokens (required if oauth
-      #                                  authentication is used).
-      #        :instance_url           - The String base url for all api requests
-      #                                  (required if oauth authentication is used).
+      #        :oauth_token             - The String oauth access token to authenticate
+      #                                   API calls (required unless password
+      #                                   authentication is used).
+      #        :refresh_token           - The String refresh token to obtain fresh
+      #                                   OAuth access tokens (required if oauth
+      #                                   authentication is used).
+      #        :instance_url            - The String base url for all api requests
+      #                                   (required if oauth authentication is used).
       #
-      #        :client_id              - The oauth client id to use. Needed for both
-      #                                  password and oauth authentication
-      #        :client_secret          - The oauth client secret to use.
+      #        :client_id               - The oauth client id to use. Needed for both
+      #                                   password and oauth authentication
+      #        :client_secret           - The oauth client secret to use.
       #
-      #        :host                   - The String hostname to use during
-      #                                  authentication requests (default: 'login.salesforce.com').
+      #        :host                    - The String hostname to use during
+      #                                   authentication requests
+      #                                   (default: 'login.salesforce.com').
       #
-      #        :api_version            - The String REST api version to use (default: '24.0')
+      #        :api_version             - The String REST api version to use
+      #                                   (default: '24.0')
       #
-      #        :authentication_retries - The number of times that client
-      #                                  should attempt to reauthenticate
-      #                                  before raising an exception (default: 3).
+      #        :authentication_retries  - The number of times that client
+      #                                   should attempt to reauthenticate
+      #                                   before raising an exception (default: 3).
       #
-      #        :compress               - Set to true to have Salesforce compress the response (default: false).
-      #        :mashify                - Set to false to skip the conversion of Salesforce responses to
-      #                                  Restforce::Sobjects and Restforce::Collections. (default: nil).
-      #        :timeout                - Faraday connection request read/open timeout. (default: nil).
+      #        :compress                - Set to true to have Salesforce compress the
+      #                                   response (default: false).
+      #        :mashify                 - Set to false to skip the conversion of
+      #                                   Salesforce responses to Restforce::Sobjects and
+      #                                   Restforce::Collections. (default: nil).
+      #        :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'
+      #        :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.
+      #        :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)] }]
+
+        @options = Hash[Restforce.configuration.options.map do |option|
+          [option, Restforce.configuration.send(option)]
+        end]
+
         @options.merge! opts
         yield builder if block_given?
       end
@@ -57,7 +69,6 @@ module Restforce
       def inspect
         "#<#{self.class} @options=#{@options.inspect}>"
       end
-
     end
   end
-end
+end