activeresource 4.1.0 → 6.0.0

data/lib/active_resource/callbacks.rb

@@ -1,4 +1,6 @@
-require 'active_support/core_ext/array/wrap'
+# frozen_string_literal: true
+
+require "active_support/core_ext/array/wrap"
 
 module ActiveResource
   module Callbacks

data/lib/active_resource/collection.rb

@@ -1,19 +1,22 @@
-require 'active_support/core_ext/module/delegation'
-require 'active_support/inflector'
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/delegation"
+require "active_support/inflector"
 
 module ActiveResource # :nodoc:
   class Collection # :nodoc:
+    SELF_DEFINE_METHODS = [:to_a, :collect!, :map!, :all?]
     include Enumerable
-    delegate :to_yaml, :all?, *Array.instance_methods(false), :to => :to_a
+    delegate :to_yaml, :all?, *(Array.instance_methods(false) - SELF_DEFINE_METHODS), to: :to_a
 
     # The array of actual elements returned by index actions
     attr_accessor :elements, :resource_class, :original_params
-    
+
     # ActiveResource::Collection is a wrapper to handle parsing index responses that
     # do not directly map to Rails conventions.
     #
-    # You can define a custom class that inherets from ActiveResource::Collection
-    # in order to to set the elements instance. 
+    # You can define a custom class that inherits from ActiveResource::Collection
+    # in order to to set the elements instance.
     #
     # GET /posts.json delivers following response body:
     #   {
@@ -21,12 +24,12 @@ module ActiveResource # :nodoc:
     #       {
     #         title: "ActiveResource now has associations",
     #         body: "Lorem Ipsum"
-    #       }
+    #       },
     #       {...}
-    #     ]
+    #     ],
     #     next_page: "/posts.json?page=2"
     #   }
-    # 
+    #
     # A Post class can be setup to handle it with:
     #
     #   class Post < ActiveResource::Base
@@ -44,7 +47,7 @@ module ActiveResource # :nodoc:
     #     end
     #   end
     #
-    # The result from a find method that returns multiple entries will now be a 
+    # The result from a find method that returns multiple entries will now be a
     # PostParser instance.  ActiveResource::Collection includes Enumerable and
     # instances can be iterated over just like an array.
     #    @posts = Post.find(:all) # => PostCollection:xxx
@@ -56,11 +59,11 @@ module ActiveResource # :nodoc:
     def initialize(elements = [])
       @elements = elements
     end
-    
+
     def to_a
       elements
     end
-    
+
     def collect!
       return elements unless block_given?
       set = []
@@ -81,5 +84,11 @@ module ActiveResource # :nodoc:
     rescue NoMethodError
       raise "Cannot build resource from resource type: #{resource_class.inspect}"
     end
+
+    def where(clauses = {})
+      raise ArgumentError, "expected a clauses Hash, got #{clauses.inspect}" unless clauses.is_a? Hash
+      new_clauses = original_params.merge(clauses)
+      resource_class.where(new_clauses)
+    end
   end
 end

data/lib/active_resource/connection.rb

@@ -1,27 +1,27 @@
-require 'active_support/core_ext/benchmark'
-require 'active_support/core_ext/uri'
-require 'active_support/core_ext/object/inclusion'
-require 'net/https'
-require 'date'
-require 'time'
-require 'uri'
+# frozen_string_literal: true
+
+require "active_support/core_ext/benchmark"
+require "active_support/core_ext/object/inclusion"
+require "net/https"
+require "date"
+require "time"
+require "uri"
 
 module ActiveResource
   # Class to handle connections to remote web services.
   # This class is used by ActiveResource::Base to interface with REST
   # services.
   class Connection
-
-    HTTP_FORMAT_HEADER_NAMES = {  :get => 'Accept',
-      :put => 'Content-Type',
-      :post => 'Content-Type',
-      :patch => 'Content-Type',
-      :delete => 'Accept',
-      :head => 'Accept'
+    HTTP_FORMAT_HEADER_NAMES = {  get: "Accept",
+      put: "Content-Type",
+      post: "Content-Type",
+      patch: "Content-Type",
+      delete: "Accept",
+      head: "Accept"
     }
 
-    attr_reader :site, :user, :password, :auth_type, :timeout, :open_timeout, :read_timeout, :proxy, :ssl_options
-    attr_accessor :format
+    attr_reader :site, :user, :password, :bearer_token, :auth_type, :timeout, :open_timeout, :read_timeout, :proxy, :ssl_options
+    attr_accessor :format, :logger
 
     class << self
       def requests
@@ -31,19 +31,20 @@ module ActiveResource
 
     # The +site+ parameter is required and will set the +site+
     # attribute to the URI for the remote resource service.
-    def initialize(site, format = ActiveResource::Formats::JsonFormat)
-      raise ArgumentError, 'Missing site URI' unless site
-      @proxy = @user = @password = nil
+    def initialize(site, format = ActiveResource::Formats::JsonFormat, logger: nil)
+      raise ArgumentError, "Missing site URI" unless site
+      @proxy = @user = @password = @bearer_token = nil
       self.site = site
       self.format = format
+      self.logger = logger
     end
 
     # Set URI for remote service.
     def site=(site)
       @site = site.is_a?(URI) ? site : URI.parse(site)
       @ssl_options ||= {} if @site.is_a?(URI::HTTPS)
-      @user = URI.parser.unescape(@site.user) if @site.user
-      @password = URI.parser.unescape(@site.password) if @site.password
+      @user = URI::DEFAULT_PARSER.unescape(@site.user) if @site.user
+      @password = URI::DEFAULT_PARSER.unescape(@site.password) if @site.password
     end
 
     # Set the proxy for remote service.
@@ -52,14 +53,13 @@ module ActiveResource
     end
 
     # Sets the user for remote service.
-    def user=(user)
-      @user = user
-    end
+    attr_writer :user
 
     # Sets the password for remote service.
-    def password=(password)
-      @password = password
-    end
+    attr_writer :password
+
+    # Sets the bearer token for remote service.
+    attr_writer :bearer_token
 
     # Sets the auth type for remote service.
     def auth_type=(auth_type)
@@ -67,24 +67,16 @@ module ActiveResource
     end
 
     # Sets the number of seconds after which HTTP requests to the remote service should time out.
-    def timeout=(timeout)
-      @timeout = timeout
-    end
+    attr_writer :timeout
 
     # Sets the number of seconds after which HTTP connects to the remote service should time out.
-    def open_timeout=(timeout)
-      @open_timeout = timeout
-    end
+    attr_writer :open_timeout
 
     # Sets the number of seconds after which HTTP read requests to the remote service should time out.
-    def read_timeout=(timeout)
-      @read_timeout = timeout
-    end
+    attr_writer :read_timeout
 
     # Hash of options applied to Net::HTTP instance when +site+ protocol is 'https'.
-    def ssl_options=(options)
-      @ssl_options = options
-    end
+    attr_writer :ssl_options
 
     # Executes a GET request.
     # Used to get (find) resources.
@@ -100,19 +92,19 @@ module ActiveResource
 
     # Executes a PATCH request (see HTTP protocol documentation if unfamiliar).
     # Used to update resources.
-    def patch(path, body = '', headers = {})
+    def patch(path, body = "", headers = {})
       with_auth { request(:patch, path, body.to_s, build_request_headers(headers, :patch, self.site.merge(path))) }
     end
 
     # Executes a PUT request (see HTTP protocol documentation if unfamiliar).
     # Used to update resources.
-    def put(path, body = '', headers = {})
+    def put(path, body = "", headers = {})
       with_auth { request(:put, path, body.to_s, build_request_headers(headers, :put, self.site.merge(path))) }
     end
 
     # Executes a POST request.
     # Used to create new resources.
-    def post(path, body = '', headers = {})
+    def post(path, body = "", headers = {})
       with_auth { request(:post, path, body.to_s, build_request_headers(headers, :post, self.site.merge(path))) }
     end
 
@@ -140,32 +132,36 @@ module ActiveResource
       # Handles response and error codes from the remote service.
       def handle_response(response)
         case response.code.to_i
-          when 301, 302, 303, 307
-            raise(Redirection.new(response))
-          when 200...400
-            response
-          when 400
-            raise(BadRequest.new(response))
-          when 401
-            raise(UnauthorizedAccess.new(response))
-          when 403
-            raise(ForbiddenAccess.new(response))
-          when 404
-            raise(ResourceNotFound.new(response))
-          when 405
-            raise(MethodNotAllowed.new(response))
-          when 409
-            raise(ResourceConflict.new(response))
-          when 410
-            raise(ResourceGone.new(response))
-          when 422
-            raise(ResourceInvalid.new(response))
-          when 401...500
-            raise(ClientError.new(response))
-          when 500...600
-            raise(ServerError.new(response))
-          else
-            raise(ConnectionError.new(response, "Unknown response code: #{response.code}"))
+        when 301, 302, 303, 307
+          raise(Redirection.new(response))
+        when 200...400
+          response
+        when 400
+          raise(BadRequest.new(response))
+        when 401
+          raise(UnauthorizedAccess.new(response))
+        when 403
+          raise(ForbiddenAccess.new(response))
+        when 404
+          raise(ResourceNotFound.new(response))
+        when 405
+          raise(MethodNotAllowed.new(response))
+        when 409
+          raise(ResourceConflict.new(response))
+        when 410
+          raise(ResourceGone.new(response))
+        when 412
+          raise(PreconditionFailed.new(response))
+        when 422
+          raise(ResourceInvalid.new(response))
+        when 429
+          raise(TooManyRequests.new(response))
+        when 401...500
+          raise(ClientError.new(response))
+        when 500...600
+          raise(ServerError.new(response))
+        else
+          raise(ConnectionError.new(response, "Unknown response code: #{response.code}"))
         end
       end
 
@@ -177,7 +173,9 @@ module ActiveResource
 
       def new_http
         if @proxy
-          Net::HTTP.new(@site.host, @site.port, @proxy.host, @proxy.port, @proxy.user, @proxy.password)
+          user = URI::DEFAULT_PARSER.unescape(@proxy.user) if @proxy.user
+          password = URI::DEFAULT_PARSER.unescape(@proxy.password) if @proxy.password
+          Net::HTTP.new(@site.host, @site.port, @proxy.host, @proxy.port, user, password)
         else
           Net::HTTP.new(@site.host, @site.port)
         end
@@ -201,9 +199,6 @@ module ActiveResource
           if defined? @ssl_options
             http.use_ssl = true
 
-            # Default to no cert verification (WTF? FIXME)
-            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-
             # All the SSL options have corresponding http settings.
             @ssl_options.each { |key, value| http.send "#{key}=", value }
           end
@@ -228,7 +223,7 @@ module ActiveResource
         yield
       rescue UnauthorizedAccess => e
         raise if retried || auth_type != :digest
-        @response_auth_header = e.response['WWW-Authenticate']
+        @response_auth_header = e.response["WWW-Authenticate"]
         retried = true
         retry
       end
@@ -236,10 +231,12 @@ module ActiveResource
       def authorization_header(http_method, uri)
         if @user || @password
           if auth_type == :digest
-            { 'Authorization' => digest_auth_header(http_method, uri) }
+            { "Authorization" => digest_auth_header(http_method, uri) }
           else
-            { 'Authorization' => 'Basic ' + ["#{@user}:#{@password}"].pack('m').delete("\r\n") }
+            { "Authorization" => "Basic " + ["#{@user}:#{@password}"].pack("m").delete("\r\n") }
           end
+        elsif @bearer_token
+          { "Authorization" => "Bearer #{@bearer_token}" }
         else
           {}
         end
@@ -254,8 +251,8 @@ module ActiveResource
         ha1 = Digest::MD5.hexdigest("#{@user}:#{params['realm']}:#{@password}")
         ha2 = Digest::MD5.hexdigest("#{http_method.to_s.upcase}:#{request_uri}")
 
-        params.merge!('cnonce' => client_nonce)
-        request_digest = Digest::MD5.hexdigest([ha1, params['nonce'], "0", params['cnonce'], params['qop'], ha2].join(":"))
+        params["cnonce"] = client_nonce
+        request_digest = Digest::MD5.hexdigest([ha1, params["nonce"], "0", params["cnonce"], params["qop"], ha2].join(":"))
         "Digest #{auth_attributes_for(uri, request_digest, params)}"
       end
 
@@ -279,22 +276,22 @@ module ActiveResource
             %Q(qop="#{params['qop']}"),
             %Q(uri="#{uri.path}"),
             %Q(nonce="#{params['nonce']}"),
-            %Q(nc="0"),
+            'nc="0"',
             %Q(cnonce="#{params['cnonce']}"),
             %Q(response="#{request_digest}")]
 
-        auth_attrs << %Q(opaque="#{params['opaque']}") unless params['opaque'].blank?
+        auth_attrs << %Q(opaque="#{params['opaque']}") unless params["opaque"].blank?
         auth_attrs.join(", ")
       end
 
       def http_format_header(http_method)
-        {HTTP_FORMAT_HEADER_NAMES[http_method] => format.mime_type}
+        { HTTP_FORMAT_HEADER_NAMES[http_method] => format.mime_type }
       end
 
       def legitimize_auth_type(auth_type)
         return :basic if auth_type.nil?
         auth_type = auth_type.to_sym
-        auth_type.in?([:basic, :digest]) ? auth_type : :basic
+        auth_type.in?([:basic, :digest, :bearer]) ? auth_type : :basic
       end
   end
 end

data/lib/active_resource/custom_methods.rb

@@ -1,4 +1,6 @@
-require 'active_support/core_ext/object/blank'
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/blank"
 
 module ActiveResource
   # A module to support custom REST methods and sub-resources, allowing you to break out
@@ -59,15 +61,15 @@ module ActiveResource
           derooted.is_a?(Array) ? derooted.map { |e| Formats.remove_root(e) } : derooted
         end
 
-        def post(custom_method_name, options = {}, body = '')
+        def post(custom_method_name, options = {}, body = "")
           connection.post(custom_method_collection_url(custom_method_name, options), body, headers)
         end
 
-        def patch(custom_method_name, options = {}, body = '')
+        def patch(custom_method_name, options = {}, body = "")
           connection.patch(custom_method_collection_url(custom_method_name, options), body, headers)
         end
 
-        def put(custom_method_name, options = {}, body = '')
+        def put(custom_method_name, options = {}, body = "")
           connection.put(custom_method_collection_url(custom_method_name, options), body, headers)
         end
 
@@ -102,11 +104,11 @@ module ActiveResource
       end
     end
 
-    def patch(method_name, options = {}, body = '')
+    def patch(method_name, options = {}, body = "")
       connection.patch(custom_method_element_url(method_name, options), body, self.class.headers)
     end
 
-    def put(method_name, options = {}, body = '')
+    def put(method_name, options = {}, body = "")
       connection.put(custom_method_element_url(method_name, options), body, self.class.headers)
     end
 

data/lib/active_resource/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveResource
   class ConnectionError < StandardError # :nodoc:
     attr_reader :response
@@ -8,7 +10,9 @@ module ActiveResource
     end
 
     def to_s
-      message = "Failed."
+      return @message if @message
+
+      message = +"Failed."
       message << "  Response code = #{response.code}." if response.respond_to?(:code)
       message << "  Response message = #{response.message}." if response.respond_to?(:message)
       message
@@ -20,7 +24,7 @@ module ActiveResource
     def initialize(message)
       @message = message
     end
-    def to_s; @message ;end
+    def to_s; @message ; end
   end
 
   # Raised when a OpenSSL::SSL::SSLError occurs.
@@ -28,13 +32,13 @@ module ActiveResource
     def initialize(message)
       @message = message
     end
-    def to_s; @message ;end
+    def to_s; @message ; end
   end
 
   # 3xx Redirection
   class Redirection < ConnectionError # :nodoc:
     def to_s
-      response['Location'] ? "#{super} => #{response['Location']}" : super
+      response["Location"] ? "#{super} => #{response['Location']}" : super
     end
   end
 
@@ -69,6 +73,14 @@ module ActiveResource
   class ResourceGone < ClientError # :nodoc:
   end
 
+  # 412 Precondition Failed
+  class PreconditionFailed < ClientError # :nodoc:
+  end
+
+  # 429 Too Many Requests
+  class TooManyRequests < ClientError # :nodoc:
+  end
+
   # 5xx Server Error
   class ServerError < ConnectionError # :nodoc:
   end
@@ -76,7 +88,7 @@ module ActiveResource
   # 405 Method Not Allowed
   class MethodNotAllowed < ClientError # :nodoc:
     def allowed_methods
-      @response['Allow'].split(',').map { |verb| verb.strip.downcase.to_sym }
+      @response["Allow"].split(",").map { |verb| verb.strip.downcase.to_sym }
     end
   end
 end

data/lib/active_resource/formats/json_format.rb

@@ -1,4 +1,6 @@
-require 'active_support/json'
+# frozen_string_literal: true
+
+require "active_support/json"
 
 module ActiveResource
   module Formats
@@ -18,6 +20,7 @@ module ActiveResource
       end
 
       def decode(json)
+        return nil if json.nil?
         Formats.remove_root(ActiveSupport::JSON.decode(json))
       end
     end

data/lib/active_resource/formats/xml_format.rb

@@ -1,4 +1,6 @@
-require 'active_support/core_ext/hash/conversions'
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/conversions"
 
 module ActiveResource
   module Formats
@@ -13,7 +15,7 @@ module ActiveResource
         "application/xml"
       end
 
-      def encode(hash, options={})
+      def encode(hash, options = {})
         hash.to_xml(options)
       end
 

data/lib/active_resource/formats.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module ActiveResource
   module Formats
-    autoload :XmlFormat, 'active_resource/formats/xml_format'
-    autoload :JsonFormat, 'active_resource/formats/json_format'
+    autoload :XmlFormat, "active_resource/formats/xml_format"
+    autoload :JsonFormat, "active_resource/formats/json_format"
 
     # Lookup the format class from a mime type reference symbol. Example:
     #
@@ -12,7 +14,7 @@ module ActiveResource
     end
 
     def self.remove_root(data)
-      if data.is_a?(Hash) && data.keys.size == 1
+      if data.is_a?(Hash) && data.keys.size == 1 && data.values.first.is_a?(Enumerable)
         data.values.first
       else
         data

data/lib/active_resource/http_mock.rb

@@ -1,8 +1,10 @@
-require 'active_support/core_ext/kernel/reporting'
-require 'active_support/core_ext/object/inclusion'
+# frozen_string_literal: true
+
+require "active_support/core_ext/kernel/reporting"
+require "active_support/core_ext/object/inclusion"
 
 module ActiveResource
-  class InvalidRequestError < StandardError; end #:nodoc:
+  class InvalidRequestError < StandardError; end # :nodoc:
 
   # One thing that has always been a pain with remote web services is testing. The HttpMock
   # class makes it easy to test your Active Resource models by creating a set of mock responses to specific
@@ -50,7 +52,7 @@ module ActiveResource
   #   end
   #
   class HttpMock
-    class Responder #:nodoc:
+    class Responder # :nodoc:
       def initialize(responses)
         @responses = responses
       end
@@ -72,14 +74,12 @@ module ActiveResource
       end
 
     private
-
       def delete_duplicate_responses(request)
-        @responses.delete_if {|r| r[0] == request }
+        @responses.delete_if { |r| r[0] == request }
       end
     end
 
     class << self
-
       # Returns an array of all request objects that have been sent to the mock. You can use this to check
       # if your model actually sent an HTTP request.
       #
@@ -189,7 +189,7 @@ module ActiveResource
       #   ActiveResource::HttpMock.respond_to(pairs, false)
       #   ActiveResource::HttpMock.responses.length #=> 2
       #
-      def respond_to(*args) #:yields: mock
+      def respond_to(*args) # :yields: mock
         pairs = args.first || {}
         reset! if args.last.class != FalseClass
 
@@ -203,9 +203,9 @@ module ActiveResource
       end
 
       def delete_responses_to_replace(new_responses)
-        new_responses.each{|nr|
+        new_responses.each { |nr|
           request_to_remove = nr[0]
-          @@responses = responses.delete_if{|r| r[0] == request_to_remove}
+          @@responses = responses.delete_if { |r| r[0] == request_to_remove }
         }
       end
 
@@ -238,7 +238,6 @@ module ActiveResource
       def net_connection_disabled?
         !net_connection_enabled?
       end
-
     end
 
     # body?       methods
@@ -268,11 +267,11 @@ module ActiveResource
       end
     end
 
-    def initialize(site) #:nodoc:
+    def initialize(site) # :nodoc:
       @site = site
     end
 
-    def inspect_responses #:nodoc:
+    def inspect_responses # :nodoc:
       self.class.responses.map { |r| r[0].to_s }.inspect
     end
   end
@@ -293,16 +292,15 @@ module ActiveResource
     end
 
     private
-
-    def headers_match?(req)
-      # Ignore format header on equality if it's not defined
-      format_header = ActiveResource::Connection::HTTP_FORMAT_HEADER_NAMES[method]
-      if headers[format_header].present? || req.headers[format_header].blank?
-        headers == req.headers
-      else
-        headers.dup.merge(format_header => req.headers[format_header]) == req.headers
+      def headers_match?(req)
+        # Ignore format header on equality if it's not defined
+        format_header = ActiveResource::Connection::HTTP_FORMAT_HEADER_NAMES[method]
+        if headers[format_header].present? || req.headers[format_header].blank?
+          headers == req.headers
+        else
+          headers.dup.merge(format_header => req.headers[format_header]) == req.headers
+        end
       end
-    end
   end
 
   class Response
@@ -310,15 +308,14 @@ module ActiveResource
 
     def initialize(body, message = 200, headers = {})
       @body, @message, @headers = body, message.to_s, headers
-      @code = @message[0,3].to_i
+      @code = @message[0, 3].to_i
 
       resp_cls = Net::HTTPResponse::CODE_TO_OBJ[@code.to_s]
       if resp_cls && !resp_cls.body_permitted?
         @body = nil
       end
 
-      self['Content-Length'] = @body.nil? ? "0" : body.size.to_s
-
+      self["Content-Length"] = @body.nil? ? "0" : body.size.to_s
     end
 
     # Returns true if code is 2xx,
@@ -338,7 +335,7 @@ module ActiveResource
     # Returns true if the other is a Response with an equal body, equal message
     # and equal headers. Otherwise it returns false.
     def ==(other)
-      if (other.is_a?(Response))
+      if other.is_a?(Response)
         other.body == body && other.message == message && other.headers == headers
       else
         false
@@ -369,7 +366,6 @@ module ActiveResource
         def stub_http?
           HttpMock.net_connection_disabled? && defined?(@http) && @http.kind_of?(Net::HTTP)
         end
-
       end
   end
 end