activeresource 5.0.0 → 5.1.1

data/lib/active_resource/connection.rb

@@ -1,27 +1,28 @@
-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/uri"
+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,11 +32,12 @@ 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.
@@ -52,14 +54,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 +68,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 +93,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 +133,32 @@ 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 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}"))
         end
       end
 
@@ -227,7 +220,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
@@ -235,10 +228,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
@@ -253,8 +248,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
 
@@ -278,22 +273,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,7 @@ module ActiveResource
     end
 
     def to_s
-      message = "Failed."
+      message = "Failed.".dup
       message << "  Response code = #{response.code}." if response.respond_to?(:code)
       message << "  Response message = #{response.message}." if response.respond_to?(:message)
       message
@@ -34,7 +36,7 @@ module ActiveResource
   # 3xx Redirection
   class Redirection < ConnectionError # :nodoc:
     def to_s
-      response['Location'] ? "#{super} => #{response['Location']}" : super
+      response["Location"] ? "#{super} => #{response['Location']}" : super
     end
   end
 
@@ -76,7 +78,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:
     #

data/lib/active_resource/http_mock.rb

@@ -1,5 +1,7 @@
-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:
@@ -74,12 +76,11 @@ module ActiveResource
     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.
       #
@@ -203,9 +204,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 +239,6 @@ module ActiveResource
       def net_connection_disabled?
         !net_connection_enabled?
       end
-
     end
 
     # body?       methods
@@ -294,15 +294,15 @@ module ActiveResource
 
     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 +310,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 +337,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 +368,6 @@ module ActiveResource
         def stub_http?
           HttpMock.net_connection_disabled? && defined?(@http) && @http.kind_of?(Net::HTTP)
         end
-
       end
   end
 end

data/lib/active_resource/log_subscriber.rb

@@ -1,9 +1,20 @@
+# frozen_string_literal: true
+
 module ActiveResource
   class LogSubscriber < ActiveSupport::LogSubscriber
     def request(event)
       result = event.payload[:result]
-      info "#{event.payload[:method].to_s.upcase} #{event.payload[:request_uri]}"
-      info "--> %d %s %d (%.1fms)" % [result.code, result.message, result.body.to_s.length, event.duration]
+
+      # When result is nil, the connection could not even be initiated
+      # with the server, so we log an internal synthetic error response (523).
+      code    = result.try(:code)    || 523  # matches CloudFlare's convention
+      message = result.try(:message) || "ActiveResource connection error"
+      body    = result.try(:body)    || ""
+
+      log_level_method = code.to_i < 400 ? :info : :error
+
+      send log_level_method, "#{event.payload[:method].to_s.upcase} #{event.payload[:request_uri]}"
+      send log_level_method, "--> %d %s %d (%.1fms)" % [code, message, body.to_s.length, event.duration]
     end
 
     def logger
@@ -12,4 +23,4 @@ module ActiveResource
   end
 end
 
-ActiveResource::LogSubscriber.attach_to :active_resource
+ActiveResource::LogSubscriber.attach_to :active_resource

data/lib/active_resource/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_resource"
 require "rails"
 
@@ -6,10 +8,18 @@ module ActiveResource
     config.active_resource = ActiveSupport::OrderedOptions.new
 
     initializer "active_resource.set_configs" do |app|
-      app.config.active_resource.each do |k,v|
-        ActiveResource::Base.send "#{k}=", v
+      ActiveSupport.on_load(:active_resource) do
+        app.config.active_resource.each do |k, v|
+          send "#{k}=", v
+        end
+      end
+    end
+
+    initializer "active_resource.add_active_job_serializer" do |app|
+      if defined? app.config.active_job.custom_serializers
+        require "active_resource/active_job_serializer"
+        app.config.active_job.custom_serializers << ActiveResource::ActiveJobSerializer
       end
     end
   end
 end
-

data/lib/active_resource/reflection.rb

@@ -1,5 +1,7 @@
-require 'active_support/core_ext/class/attribute'
-require 'active_support/core_ext/module/deprecation'
+# frozen_string_literal: true
+
+require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/module/deprecation"
 
 module ActiveResource
   # = Active Resource reflection
@@ -25,7 +27,6 @@ module ActiveResource
 
 
     class AssociationReflection
-
       def initialize(macro, name, options)
         @macro, @name, @options = macro, name, options
       end
@@ -65,13 +66,13 @@ module ActiveResource
       end
 
       private
-      def derive_class_name
-        return (options[:class_name] ? options[:class_name].to_s.camelize : name.to_s.classify)
-      end
+        def derive_class_name
+          (options[:class_name] ? options[:class_name].to_s.camelize : name.to_s.classify)
+        end
 
-      def derive_foreign_key
-        return options[:foreign_key] ? options[:foreign_key].to_s : "#{name.to_s.downcase}_id"
-      end
+        def derive_foreign_key
+          options[:foreign_key] ? options[:foreign_key].to_s : "#{name.to_s.downcase}_id"
+        end
     end
   end
 end

data/lib/active_resource/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveResource # :nodoc:
   class Schema # :nodoc:
     # attributes can be known to be one of these types. They are easy to
@@ -29,8 +31,8 @@ module ActiveResource # :nodoc:
 
       the_type = type.to_s
       # TODO: add defaults
-      #the_attr = [type.to_s]
-      #the_attr << options[:default] if options.has_key? :default
+      # the_attr = [type.to_s]
+      # the_attr << options[:default] if options.has_key? :default
       @attrs[name.to_s] = the_type
       self
     end
@@ -45,7 +47,7 @@ module ActiveResource # :nodoc:
       #   attr_names.each { |name| attribute(name, 'string', options) }
       # end
       class_eval <<-EOV, __FILE__, __LINE__ + 1
-        def #{attr_type.to_s}(*args)
+        def #{attr_type}(*args)
           options = args.extract_options!
           attr_names = args
 

data/lib/active_resource/singleton.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveResource
   module Singleton
     extend ActiveSupport::Concern
@@ -60,20 +62,19 @@ module ActiveResource
       #
       #   Inventory.find
       #   # => raises ResourceNotFound
-      def find(options={})
+      def find(options = {})
         find_singleton(options)
       end
 
       private
-      # Find singleton resource
-      def find_singleton(options)
-        prefix_options, query_options = split_options(options[:params])
-
-        path = singleton_path(prefix_options, query_options)
-        resp = self.format.decode(self.connection.get(path, self.headers).body)
-        instantiate_record(resp, prefix_options)
-      end
-
+        # Find singleton resource
+        def find_singleton(options)
+          prefix_options, query_options = split_options(options[:params])
+
+          path = singleton_path(prefix_options, query_options)
+          resp = self.format.decode(self.connection.get(path, self.headers).body)
+          instantiate_record(resp, prefix_options)
+        end
     end
     # Deletes the resource from the remote service.
     #
@@ -88,27 +89,25 @@ module ActiveResource
 
     protected
 
-    # Update the resource on the remote service
-    def update
-      connection.put(singleton_path(prefix_options), encode, self.class.headers).tap do |response|
-        load_attributes_from_response(response)
+      # Update the resource on the remote service
+      def update
+        connection.put(singleton_path(prefix_options), encode, self.class.headers).tap do |response|
+          load_attributes_from_response(response)
+        end
       end
-    end
 
-    # Create (i.e. \save to the remote service) the \new resource.
-    def create
-      connection.post(singleton_path, encode, self.class.headers).tap do |response|
-        self.id = id_from_response(response)
-        load_attributes_from_response(response)
+      # Create (i.e. \save to the remote service) the \new resource.
+      def create
+        connection.post(singleton_path, encode, self.class.headers).tap do |response|
+          self.id = id_from_response(response)
+          load_attributes_from_response(response)
+        end
       end
-    end
 
     private
 
-    def singleton_path(options = nil)
-      self.class.singleton_path(options || prefix_options)
-    end
-
+      def singleton_path(options = nil)
+        self.class.singleton_path(options || prefix_options)
+      end
   end
-
 end