activeresource 5.0.0 → 5.1.1

data/lib/active_resource/base.rb

@@ -1,26 +1,28 @@
-require 'active_support'
-require 'active_support/core_ext/class/attribute_accessors'
-require 'active_support/core_ext/class/attribute'
-require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/kernel/reporting'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/core_ext/module/aliasing'
-require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/object/to_query'
-require 'active_support/core_ext/object/duplicable'
-require 'set'
-require 'uri'
-
-require 'active_support/core_ext/uri'
-require 'active_resource/connection'
-require 'active_resource/formats'
-require 'active_resource/schema'
-require 'active_resource/log_subscriber'
-require 'active_resource/associations'
-require 'active_resource/reflection'
-require 'active_resource/threadsafe_attributes'
-
-require 'active_model/serializers/xml'
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/class/attribute_accessors"
+require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/kernel/reporting"
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/module/aliasing"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/to_query"
+require "active_support/core_ext/object/duplicable"
+require "set"
+require "uri"
+
+require "active_support/core_ext/uri"
+require "active_resource/connection"
+require "active_resource/formats"
+require "active_resource/schema"
+require "active_resource/log_subscriber"
+require "active_resource/associations"
+require "active_resource/reflection"
+require "active_resource/threadsafe_attributes"
+
+require "active_model/serializers/xml"
 
 module ActiveResource
   # ActiveResource::Base is the main class for mapping RESTful resources as models in a Rails application.
@@ -300,7 +302,12 @@ module ActiveResource
     ##
     # :singleton-method:
     # The logger for diagnosing and tracing Active Resource calls.
-    cattr_accessor :logger
+    cattr_reader :logger
+
+    def self.logger=(logger)
+      self._connection = nil
+      @@logger = logger
+    end
 
     class_attribute :_format
     class_attribute :_collection_parser
@@ -378,7 +385,7 @@ module ActiveResource
           @schema ||= {}.with_indifferent_access
           @known_attributes ||= []
 
-          schema_definition.attrs.each do |k,v|
+          schema_definition.attrs.each do |k, v|
             @schema[k] = v
             @known_attributes << k
           end
@@ -417,7 +424,7 @@ module ActiveResource
         raise ArgumentError, "Expected a hash" unless the_schema.kind_of? Hash
 
         schema do
-          the_schema.each {|k,v| attribute(k,v) }
+          the_schema.each { |k, v| attribute(k, v) }
         end
       end
 
@@ -619,7 +626,7 @@ module ActiveResource
       # * <tt>:ssl_timeout</tt> -The SSL timeout in seconds.
       def ssl_options=(options)
         self._connection = nil
-        @ssl_options  = options
+        @ssl_options = options
       end
 
       # Returns the SSL options hash.
@@ -636,7 +643,9 @@ module ActiveResource
       # or not (defaults to <tt>false</tt>).
       def connection(refresh = false)
         if _connection_defined? || superclass == Object
-          self._connection = connection_class.new(site, format) if refresh || _connection.nil?
+          self._connection = connection_class.new(
+            site, format, logger: logger
+          ) if refresh || _connection.nil?
           _connection.proxy = proxy if proxy
           _connection.user = user if user
           _connection.password = password if password
@@ -682,15 +691,15 @@ module ActiveResource
           return primary_key if primary_key.is_a?(Symbol)
           primary_key.dup.freeze
         else
-          'id'
+          "id"
         end
       end
 
       # Gets the \prefix for a resource's nested URL (e.g., <tt>prefix/collectionname/1.json</tt>)
       # This method is regenerated at runtime based on what the \prefix is set to.
-      def prefix(options={})
+      def prefix(options = {})
         default = site.path
-        default << '/' unless default[-1..-1] == '/'
+        default << "/" unless default[-1..-1] == "/"
         # generate the actual method based on the current site path
         self.prefix = default
         prefix(options)
@@ -705,7 +714,7 @@ module ActiveResource
 
       # Sets the \prefix for a resource's nested URL (e.g., <tt>prefix/collectionname/1.json</tt>).
       # Default value is <tt>site.path</tt>.
-      def prefix=(value = '/')
+      def prefix=(value = "/")
         # Replace :placeholders with '#{embedded options[:lookups]}'
         prefix_call = value.gsub(/:\w+/) { |key| "\#{URI.parser.escape options[#{key}].to_s}" }
 
@@ -763,7 +772,37 @@ module ActiveResource
         check_prefix_options(prefix_options)
 
         prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-        "#{prefix(prefix_options)}#{collection_name}/#{URI.parser.escape id.to_s}#{format_extension}#{query_string(query_options)}"
+        "#{prefix(prefix_options)}#{collection_name}/#{URI.encode_www_form_component(id.to_s)}#{format_extension}#{query_string(query_options)}"
+      end
+
+      # Gets the element url for the given ID in +id+. If the +query_options+ parameter is omitted, Rails
+      # will split from the \prefix options.
+      #
+      # ==== Options
+      # +prefix_options+ - A \hash to add a \prefix to the request for nested URLs (e.g., <tt>:account_id => 19</tt>
+      # would yield a URL like <tt>https://37s.sunrise.com/accounts/19/purchases.json</tt>).
+      #
+      # +query_options+ - A \hash to add items to the query string for the request.
+      #
+      # ==== Examples
+      #   Post.element_url(1)
+      #   # => https://37s.sunrise.com/posts/1.json
+      #
+      #   class Comment < ActiveResource::Base
+      #     self.site = "https://37s.sunrise.com/posts/:post_id"
+      #   end
+      #
+      #   Comment.element_url(1, :post_id => 5)
+      #   # => https://37s.sunrise.com/posts/5/comments/1.json
+      #
+      #   Comment.element_url(1, :post_id => 5, :active => 1)
+      #   # => https://37s.sunrise.com/posts/5/comments/1.json?active=1
+      #
+      #   Comment.element_url(1, {:post_id => 5}, {:active => 1})
+      #   # => https://37s.sunrise.com/posts/5/comments/1.json?active=1
+      #
+      def element_url(id, prefix_options = {}, query_options = nil)
+        URI.join(site, element_path(id, prefix_options, query_options)).to_s
       end
 
       # Gets the new element path for REST resources.
@@ -931,11 +970,18 @@ module ActiveResource
         options = arguments.slice!(0) || {}
 
         case scope
-          when :all   then find_every(options)
-          when :first then find_every(options).to_a.first
-          when :last  then find_every(options).to_a.last
-          when :one   then find_one(options)
-          else             find_single(scope, options)
+        when :all
+          find_every(options)
+        when :first
+          collection = find_every(options)
+          collection && collection.first
+        when :last
+          collection = find_every(options)
+          collection && collection.last
+        when :one
+          find_one(options)
+        else
+          find_single(scope, options)
         end
       end
 
@@ -962,7 +1008,7 @@ module ActiveResource
 
       def where(clauses = {})
         raise ArgumentError, "expected a clauses Hash, got #{clauses.inspect}" unless clauses.is_a? Hash
-        find(:all, :params => clauses)
+        find(:all, params: clauses)
       end
 
 
@@ -996,7 +1042,7 @@ module ActiveResource
           prefix_options, query_options = split_options(options[:params])
           path = element_path(id, prefix_options, query_options)
           response = connection.head(path, headers)
-          (200..206).include? response.code
+          (200..206).include? response.code.to_i
         end
         # id && !find_single(id, options).nil?
       rescue ActiveResource::ResourceNotFound, ActiveResource::ResourceGone
@@ -1024,7 +1070,7 @@ module ActiveResource
             else
               prefix_options, query_options = split_options(options[:params])
               path = collection_path(prefix_options, query_options)
-              instantiate_collection( (format.decode(connection.get(path, headers).body) || []), query_options, prefix_options )
+              instantiate_collection((format.decode(connection.get(path, headers).body) || []), query_options, prefix_options)
             end
           rescue ActiveResource::ResourceNotFound
             # Swallowing ResourceNotFound exceptions and return nil - as per
@@ -1091,8 +1137,8 @@ module ActiveResource
           prefix_options, query_options = {}, {}
 
           (options || {}).each do |key, value|
-            next if key.blank? || !key.respond_to?(:to_sym)
-            (prefix_parameters.include?(key.to_sym) ? prefix_options : query_options)[key.to_sym] = value
+            next if key.blank?
+            (prefix_parameters.include?(key.to_s.to_sym) ? prefix_options : query_options)[key.to_s.to_sym] = value
           end
 
           [ prefix_options, query_options ]
@@ -1157,13 +1203,13 @@ module ActiveResource
     #   not_ryan.hash            # => {:not => "an ARes instance"}
     def clone
       # Clone all attributes except the pk and any nested ARes
-      cloned = Hash[attributes.reject {|k,v| k == self.class.primary_key || v.is_a?(ActiveResource::Base)}.map { |k, v| [k, v.clone] }]
+      cloned = Hash[attributes.reject { |k, v| k == self.class.primary_key || v.is_a?(ActiveResource::Base) }.map { |k, v| [k, v.clone] }]
       # Form the new resource - bypass initialize of resource with 'new' as that will call 'load' which
       # attempts to convert hashes into member objects and arrays into collections of objects. We want
       # the raw objects to be cloned so we bypass load by directly setting the attributes hash.
       resource = self.class.new({})
       resource.prefix_options = self.prefix_options
-      resource.send :instance_variable_set, '@attributes', cloned
+      resource.send :instance_variable_set, "@attributes", cloned
       resource
     end
 
@@ -1338,13 +1384,13 @@ module ActiveResource
     #   Person.delete(guys_id)
     #   that_guy.exists? # => false
     def exists?
-      !new? && self.class.exists?(to_param, :params => prefix_options)
+      !new? && self.class.exists?(to_param, params: prefix_options)
     end
 
     # Returns the serialized string representation of the resource in the configured
     # serialization format specified in ActiveResource::Base.format. The options
     # applicable depend on the configured encoding format.
-    def encode(options={})
+    def encode(options = {})
       send("to_#{self.class.format.extension}", options)
     end
 
@@ -1360,7 +1406,7 @@ module ActiveResource
     #   my_branch.reload
     #   my_branch.name # => "Wilson Road"
     def reload
-      self.load(self.class.find(to_param, :params => @prefix_options).attributes, false, true)
+      self.load(self.class.find(to_param, params: @prefix_options).attributes, false, true)
     end
 
     # A method to manually load attributes from a \hash. Recursively loads collections of
@@ -1401,21 +1447,21 @@ module ActiveResource
       attributes.each do |key, value|
         @attributes[key.to_s] =
           case value
-            when Array
-              resource = nil
-              value.map do |attrs|
-                if attrs.is_a?(Hash)
-                  resource ||= find_or_create_resource_for_collection(key)
-                  resource.new(attrs, persisted)
-                else
-                  attrs.duplicable? ? attrs.dup : attrs
-                end
+          when Array
+            resource = nil
+            value.map do |attrs|
+              if attrs.is_a?(Hash)
+                resource ||= find_or_create_resource_for_collection(key)
+                resource.new(attrs, persisted)
+              else
+                attrs.duplicable? ? attrs.dup : attrs
               end
-            when Hash
-              resource = find_or_create_resource_for(key)
-              resource.new(value, persisted)
-            else
-              value.duplicable? ? value.dup : value
+            end
+          when Hash
+            resource = find_or_create_resource_for(key)
+            resource.new(value, persisted)
+          else
+            value.duplicable? ? value.dup : value
           end
       end
       self
@@ -1472,12 +1518,20 @@ module ActiveResource
       end
     end
 
-    def to_json(options={})
-      super(include_root_in_json ? { :root => self.class.element_name }.merge(options) : options)
+    def to_json(options = {})
+      super(include_root_in_json ? { root: self.class.element_name }.merge(options) : options)
     end
 
-    def to_xml(options={})
-      super({ :root => self.class.element_name }.merge(options))
+    def to_xml(options = {})
+      super({ root: self.class.element_name }.merge(options))
+    end
+
+    def read_attribute_for_serialization(n)
+      if !attributes[n].nil?
+        attributes[n]
+      elsif respond_to?(n)
+        send(n)
+      end
     end
 
     protected
@@ -1505,9 +1559,9 @@ module ActiveResource
       end
 
       def load_attributes_from_response(response)
-        if (response_code_allows_body?(response.code) &&
-            (response['Content-Length'].nil? || response['Content-Length'] != "0") &&
-            !response.body.nil? && response.body.strip.size > 0)
+        if response_code_allows_body?(response.code.to_i) &&
+            (response["Content-Length"].nil? || response["Content-Length"] != "0") &&
+            !response.body.nil? && response.body.strip.size > 0
           load(self.class.format.decode(response.body), true, true)
           @persisted = true
         end
@@ -1515,13 +1569,17 @@ module ActiveResource
 
       # Takes a response from a typical create post and pulls the ID out
       def id_from_response(response)
-        response['Location'][/\/([^\/]*?)(\.\w+)?$/, 1] if response['Location']
+        response["Location"][/\/([^\/]*?)(\.\w+)?$/, 1] if response["Location"]
       end
 
       def element_path(options = nil)
         self.class.element_path(to_param, options || prefix_options)
       end
 
+      def element_url(options = nil)
+        self.class.element_url(to_param, options || prefix_options)
+      end
+
       def new_element_path
         self.class.new_element_path(prefix_options)
       end
@@ -1532,13 +1590,9 @@ module ActiveResource
 
     private
 
-      def read_attribute_for_serialization(n)
-        attributes[n]
-      end
-
       # Determine whether the response is allowed to have a body per HTTP 1.1 spec section 4.4.1
       def response_code_allows_body?(c)
-        !((100..199).include?(c) || [204,304].include?(c))
+        !((100..199).include?(c) || [204, 304].include?(c))
       end
 
       # Tries to find a resource for a given collection name; if it fails, then the resource is created
@@ -1551,7 +1605,7 @@ module ActiveResource
       # if it fails, then the resource is created
       def find_or_create_resource_in_modules(resource_name, module_names)
         receiver = Object
-        namespaces = module_names[0, module_names.size-1].map do |module_name|
+        namespaces = module_names[0, module_names.size - 1].map do |module_name|
           receiver = receiver.const_get(module_name)
         end
         const_args = [resource_name, false]
@@ -1568,7 +1622,11 @@ module ActiveResource
         resource_name = name.to_s.camelize
 
         const_args = [resource_name, false]
-        if self.class.const_defined?(*const_args)
+
+        if !const_valid?(*const_args)
+          # resource_name is not a valid ruby module name and cannot be created normally
+          find_or_create_resource_for(:UnnamedResource)
+        elsif self.class.const_defined?(*const_args)
           self.class.const_get(*const_args)
         else
           ancestors = self.class.name.to_s.split("::")
@@ -1584,6 +1642,13 @@ module ActiveResource
         end
       end
 
+      def const_valid?(*const_args)
+        self.class.const_defined?(*const_args)
+        true
+      rescue NameError
+        false
+      end
+
       # Create and return a class definition for a resource inside the current resource
       def create_resource_for(resource_name)
         resource = self.class.const_set(resource_name, Class.new(ActiveResource::Base))

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,11 +1,13 @@
-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!]
     include Enumerable
-    delegate :to_yaml, :all?, *(Array.instance_methods(false) - SELF_DEFINE_METHODS), :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