activeresource 3.2.22.5 → 5.1.1

data/lib/active_resource/custom_methods.rb

@@ -1,26 +1,28 @@
-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
-  # of the "default" REST methods with your own custom resource requests.  For example,
+  # of the "default" REST methods with your own custom resource requests. For example,
   # say you use Rails to expose a REST service and configure your routes with:
   #
   #    map.resources :people, :new => { :register => :post },
   #                           :member => { :promote => :put, :deactivate => :delete }
   #                           :collection => { :active => :get }
   #
-  #  This route set creates routes for the following HTTP requests:
+  # This route set creates routes for the following HTTP requests:
   #
-  #    POST    /people/new/register.json # PeopleController.register
-  #    PUT     /people/1/promote.json    # PeopleController.promote with :id => 1
-  #    DELETE  /people/1/deactivate.json # PeopleController.deactivate with :id => 1
-  #    GET     /people/active.json       # PeopleController.active
+  #    POST      /people/new/register.json # PeopleController.register
+  #    PATCH/PUT /people/1/promote.json    # PeopleController.promote with :id => 1
+  #    DELETE    /people/1/deactivate.json # PeopleController.deactivate with :id => 1
+  #    GET       /people/active.json       # PeopleController.active
   #
   # Using this module, Active Resource can use these custom REST methods just like the
   # standard methods.
   #
   #   class Person < ActiveResource::Base
-  #     self.site = "http://37s.sunrise.i:3000"
+  #     self.site = "https://37s.sunrise.com"
   #   end
   #
   #   Person.new(:name => 'Ryan').post(:register)  # POST /people/new/register.json
@@ -59,11 +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 put(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 = "")
           connection.put(custom_method_collection_url(custom_method_name, options), body, headers)
         end
 
@@ -81,7 +87,7 @@ module ActiveResource
     module ClassMethods
       def custom_method_collection_url(method_name, options = {})
         prefix_options, query_options = split_options(options)
-        "#{prefix(prefix_options)}#{collection_name}/#{method_name}.#{format.extension}#{query_string(query_options)}"
+        "#{prefix(prefix_options)}#{collection_name}/#{method_name}#{format_extension}#{query_string(query_options)}"
       end
     end
 
@@ -98,7 +104,11 @@ module ActiveResource
       end
     end
 
-    def put(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 = "")
       connection.put(custom_method_element_url(method_name, options), body, self.class.headers)
     end
 
@@ -109,11 +119,11 @@ module ActiveResource
 
     private
       def custom_method_element_url(method_name, options = {})
-        "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/#{id}/#{method_name}.#{self.class.format.extension}#{self.class.__send__(:query_string, options)}"
+        "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/#{id}/#{method_name}#{self.class.format_extension}#{self.class.__send__(:query_string, options)}"
       end
 
       def custom_method_new_element_url(method_name, options = {})
-        "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/new/#{method_name}.#{self.class.format.extension}#{self.class.__send__(:query_string, options)}"
+        "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/new/#{method_name}#{self.class.format_extension}#{self.class.__send__(:query_string, options)}"
       end
   end
 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.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/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/http_mock.rb

@@ -1,10 +1,12 @@
-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:
 
-  # One thing that has always been a pain with remote web services is testing.  The HttpMock
+  # 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
   # requests.
   #
@@ -15,17 +17,17 @@ module ActiveResource
   #
   #   mock.http_method(path, request_headers = {}, body = nil, status = 200, response_headers = {})
   #
-  # * <tt>http_method</tt> - The HTTP method to listen for.  This can be +get+, +post+, +put+, +delete+ or
+  # * <tt>http_method</tt> - The HTTP method to listen for. This can be +get+, +post+, +patch+, +put+, +delete+ or
   #   +head+.
   # * <tt>path</tt> - A string, starting with a "/", defining the URI that is expected to be
   #   called.
-  # * <tt>request_headers</tt> - Headers that are expected along with the request.  This argument uses a
-  #   hash format, such as <tt>{ "Content-Type" => "application/json" }</tt>.  This mock will only trigger
+  # * <tt>request_headers</tt> - Headers that are expected along with the request. This argument uses a
+  #   hash format, such as <tt>{ "Content-Type" => "application/json" }</tt>. This mock will only trigger
   #   if your tests sends a request with identical headers.
-  # * <tt>body</tt> - The data to be returned.  This should be a string of Active Resource parseable content,
+  # * <tt>body</tt> - The data to be returned. This should be a string of Active Resource parseable content,
   #   such as Json.
   # * <tt>status</tt> - The HTTP response code, as an integer, to return with the response.
-  # * <tt>response_headers</tt> - Headers to be returned with the response.  Uses the same hash format as
+  # * <tt>response_headers</tt> - Headers to be returned with the response. Uses the same hash format as
   #   <tt>request_headers</tt> listed above.
   #
   # In order for a mock to deliver its content, the incoming request must match by the <tt>http_method</tt>,
@@ -55,7 +57,7 @@ module ActiveResource
         @responses = responses
       end
 
-      [ :post, :put, :get, :delete, :head ].each do |method|
+      [ :post, :patch, :put, :get, :delete, :head ].each do |method|
         # def post(path, request_headers = {}, body = nil, status = 200, response_headers = {})
         #   @responses[Request.new(:post, path, nil, request_headers)] = Response.new(body || "", status, response_headers)
         # end
@@ -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.
       #
@@ -133,7 +134,7 @@ module ActiveResource
       #
       # === Example
       #
-      # Request.new(:#{method}, path, nil, request_headers)
+      # Request.new(method, path, nil, request_headers)
       #
       #   @matz  = { :person => { :id => 1, :name => "Matz" } }.to_json
       #
@@ -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
 
@@ -214,10 +215,34 @@ module ActiveResource
         requests.clear
         responses.clear
       end
+
+      # Enables all ActiveResource::Connection instances to use real
+      # Net::HTTP instance instead of a mock.
+      def enable_net_connection!
+        @@net_connection_enabled = true
+      end
+
+      # Sets all ActiveResource::Connection to use HttpMock instances.
+      def disable_net_connection!
+        @@net_connection_enabled = false
+      end
+
+      # Checks if real requests can be used instead of the default mock used in tests.
+      def net_connection_enabled?
+        if defined?(@@net_connection_enabled)
+          @@net_connection_enabled
+        else
+          @@net_connection_enabled = false
+        end
+      end
+
+      def net_connection_disabled?
+        !net_connection_enabled?
+      end
     end
 
     # body?       methods
-    { true  => %w(post put),
+    { true  => %w(post patch put),
       false => %w(get delete head) }.each do |has_body, methods|
       methods.each do |method|
         # def post(path, body, headers)
@@ -269,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
@@ -285,18 +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
 
-      if @body.nil?
-        self['Content-Length'] = "0"
-      else
-        self['Content-Length'] = body.size.to_s
-      end
+      self["Content-Length"] = @body.nil? ? "0" : body.size.to_s
     end
 
     # Returns true if code is 2xx,
@@ -316,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
@@ -328,7 +349,24 @@ module ActiveResource
     private
       silence_warnings do
         def http
-          @http ||= HttpMock.new(@site)
+          if unstub_http?
+            @http = configure_http(new_http)
+          elsif stub_http?
+            @http = http_stub
+          end
+          @http ||= http_stub
+        end
+
+        def http_stub
+          HttpMock.new(@site)
+        end
+
+        def unstub_http?
+          HttpMock.net_connection_enabled? && defined?(@http) && @http.kind_of?(HttpMock)
+        end
+
+        def stub_http?
+          HttpMock.net_connection_disabled? && defined?(@http) && @http.kind_of?(Net::HTTP)
         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/observing.rb

@@ -1,29 +0,0 @@
-module ActiveResource
-  module Observing
-    extend ActiveSupport::Concern
-    include ActiveModel::Observing
-
-    included do
-      %w( create save update destroy ).each do |method|
-        # def create_with_notifications(*args, &block)
-        #   notify_observers(:before_create)
-        #   if result = create_without_notifications(*args, &block)
-        #     notify_observers(:after_create)
-        #   end
-        #   result
-        # end
-        # alias_method_chain(create, :notifications)
-        class_eval(<<-EOS, __FILE__, __LINE__ + 1)
-          def #{method}_with_notifications(*args, &block)
-            notify_observers(:before_#{method})
-            if result = #{method}_without_notifications(*args, &block)
-              notify_observers(:after_#{method})
-            end
-            result
-          end
-        EOS
-        alias_method_chain(method, :notifications)
-      end
-    end
-  end
-end

data/lib/active_resource/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_resource"
 require "rails"
 
@@ -6,9 +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
+end