activeresource 5.0.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f09e2bfd3d8332924184d674556d18d2d0533dcf
-  data.tar.gz: 5dbc9edf5003415fd3565692dffa8a6342d0a1b2
+SHA256:
+  metadata.gz: 9e0cde8f42f06f37aa13a7098b9a1e828aac34c90971a62f4c9a1a7fcf529ce7
+  data.tar.gz: 11e7f85a7c565de83cb5248d8ee35783b343b8714e8ed9adcf08462f8aaceeda
 SHA512:
-  metadata.gz: 27ba6aabd0eea02c3f2adb1d6d92311c94415d9ac32589f24abc517f1384a0ab6471717ab50e017a4993b069452f85e636053e3e49ffeb37c60873fcc4f9f671
-  data.tar.gz: 3c8c8780b50ada3328e3df5b0d544e19cc3977dd4199c750991f403e00cfaa9c45213328cfdc717ebb0d86bbd931bc8b48724f17d7c56d7f996c6ace763e0ad6
+  metadata.gz: 133f4a82c31d9c925bc1c04a304c63e03982d45aa51b97d7e9ba580a433579802fb811a32009d40ebb7fc84e947fe65c60fd658b2cebb2f2f4c724efc536f528
+  data.tar.gz: 0f0042b3b644fe8584d34403913f2e11363a684fe438d536303871baaed2a98f26319b0e1dcd036364b42597b48e76c5713a627ea4431a2b2ec9263fce98b3a6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2016 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -30,10 +30,6 @@ Or added to a Gemfile:
 
   gem 'activeresource'
 
-For compatibility with Rails 5, use:
-
-  gem 'activeresource', github: 'rails/activeresource', branch: 'master'
-
 Source code can be downloaded on GitHub
 
 * https://github.com/rails/activeresource/tree/master/activeresource
@@ -57,6 +53,11 @@ life cycle methods that operate against a persistent store.
 As you can see, the methods are quite similar to Active Record's methods for dealing with database
 records.  But rather than dealing directly with a database record, you're dealing with HTTP resources (which may or may not be database records).
 
+Connection settings (`site`, `headers`, `user`, `password`, `proxy`) and the connections themselves are store in
+thread-local variables to make them thread-safe, so you can also set these dynamically, even in a multi-threaded environment, for instance:
+
+    ActiveResource::Base.site = api_site_for(request)
+
 ==== Authentication
 
 Active Resource supports the token based authentication provided by Rails through the <tt>ActionController::HttpAuthentication::Token</tt> class using custom headers.
@@ -64,8 +65,32 @@ Active Resource supports the token based authentication provided by Rails throug
    class Person < ActiveResource::Base
      self.headers['Authorization'] = 'Token token="abcd"'
    end
-   
-You can also set any specific HTTP header using the same way.
+
+You can also set any specific HTTP header using the same way.  As mentioned above, headers are thread-safe, so you can set headers dynamically, even in a multi-threaded environment:
+
+    ActiveResource::Base.headers['Authorization'] = current_session_api_token
+    
+Global Authentication to be used across all subclasses of ActiveResource::Base should be handled using the ActiveResource::Connection class.
+
+    ActiveResource::Base.connection.auth_type = :bearer
+    ActiveResource::Base.connection.bearer_token = @bearer_token
+    
+    class Person < ActiveResource::Base
+      self.connection.auth_type = :bearer
+      self.connection.bearer_token = @bearer_token
+    end
+
+ActiveResource supports 2 options for HTTP authentication today.
+
+1. Basic
+
+    ActiveResource::Connection.new("http://my%40email.com:%31%32%33@localhost")
+    # username: my@email.com password: 123
+
+2. Bearer Token
+
+    ActiveResource::Base.connection.auth_type = :bearer
+    ActiveResource::Base.connection.bearer_token = @bearer_token
 
 ==== Protocol
 
@@ -115,7 +140,7 @@ Collections can also be requested in a similar fashion
 
    # Expects a response of
    #
-   # [ 
+   # [
    #   {"id":1,"first":"Tyler","last":"Durden"},
    #   {"id":2,"first":"Tony","last":"Stark",}
    # ]
@@ -205,7 +230,7 @@ class definition below:
   end
 
   post = Post.find(1)      # issues GET http://blog.io/posts/1.json
-  comments = post.comments # issues GET http://blog.io/posts/1/comments.json
+  comments = post.comments # issues GET http://blog.io/comments.json?post_id=1
 
 
 If you control the server, you may wish to include nested resources thus avoiding a
@@ -221,6 +246,19 @@ The server-side model can be adjusted as follows to include comments in the resp
     end
   end
 
+==== Logging
+
+Active Resource instruments the event `request.active_resource` when doing a request
+to the remote service. You can subscribe to it by doing:
+
+   ActiveSupport::Notifications.subscribe('request.active_resource')  do |name, start, finish, id, payload|
+
+The `payload` is a `Hash` with the following keys:
+
+* `method` as a `Symbol`
+* `request_uri` as a `String`
+* `result` as an `Net::HTTPResponse`
+
 == License
 
 Active Resource is released under the MIT license:
@@ -236,9 +274,9 @@ See {CONTRIBUTING}[https://github.com/rails/activeresource/blob/master/CONTRIBUT
 
 == Support
 
-API documentation is at
+Full API documentation is available at
 
-* http://rubydoc.info/gems/activeresource/4.0.0/frames
+* http://rubydoc.info/gems/activeresource
 
 Bug reports and feature requests can be filed with the rest for the Ruby on Rails project here:
 

data/lib/active_resource/active_job_serializer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActiveResource
+  class ActiveJobSerializer < ActiveJob::Serializers::ObjectSerializer
+    def serialize(resource)
+      super(
+        "class" => resource.class.name,
+        "persisted" => resource.persisted?,
+        "prefix_options" => resource.prefix_options.as_json,
+        "attributes" => resource.attributes.as_json
+      )
+    end
+
+    def deserialize(hash)
+      hash["class"].constantize.new(hash["attributes"]).tap do |resource|
+        resource.persisted      = hash["persisted"]
+        resource.prefix_options = hash["prefix_options"]
+      end
+    end
+
+    private
+      def klass
+        ActiveResource::Base
+      end
+  end
+end

data/lib/active_resource/associations/builder/association.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module ActiveResource::Associations::Builder
   class Association #:nodoc:
-
     # providing a Class-Variable, which will have a different store of subclasses
     class_attribute :valid_options
     self.valid_options = [:class_name]
@@ -25,8 +26,8 @@ module ActiveResource::Associations::Builder
 
     private
 
-    def validate_options
-      options.assert_valid_keys(self.class.valid_options)
-    end
+      def validate_options
+        options.assert_valid_keys(self.class.valid_options)
+      end
   end
 end

data/lib/active_resource/associations/builder/belongs_to.rb

@@ -1,4 +1,6 @@
-module ActiveResource::Associations::Builder 
+# frozen_string_literal: true
+
+module ActiveResource::Associations::Builder
   class BelongsTo < Association
     self.valid_options += [:foreign_key]
 
@@ -8,7 +10,7 @@ module ActiveResource::Associations::Builder
       validate_options
       reflection = model.create_reflection(self.class.macro, name, options)
       model.defines_belongs_to_finder_method(reflection)
-      return reflection
+      reflection
     end
   end
 end

data/lib/active_resource/associations/builder/has_many.rb

@@ -1,4 +1,6 @@
-module ActiveResource::Associations::Builder 
+# frozen_string_literal: true
+
+module ActiveResource::Associations::Builder
   class HasMany < Association
     self.macro = :has_many
 

data/lib/active_resource/associations/builder/has_one.rb

@@ -1,7 +1,9 @@
-module ActiveResource::Associations::Builder 
+# frozen_string_literal: true
+
+module ActiveResource::Associations::Builder
   class HasOne < Association
     self.macro = :has_one
-    
+
     def build
       validate_options
       model.create_reflection(self.class.macro, name, options).tap do |reflection|

data/lib/active_resource/associations.rb

@@ -1,10 +1,11 @@
-module ActiveResource::Associations
+# frozen_string_literal: true
 
+module ActiveResource::Associations
   module Builder
-    autoload :Association, 'active_resource/associations/builder/association'
-    autoload :HasMany,     'active_resource/associations/builder/has_many'
-    autoload :HasOne,      'active_resource/associations/builder/has_one'
-    autoload :BelongsTo,   'active_resource/associations/builder/belongs_to'
+    autoload :Association, "active_resource/associations/builder/association"
+    autoload :HasMany,     "active_resource/associations/builder/has_many"
+    autoload :HasOne,      "active_resource/associations/builder/has_one"
+    autoload :BelongsTo,   "active_resource/associations/builder/belongs_to"
   end
 
 
@@ -112,7 +113,7 @@ module ActiveResource::Associations
   # <tt>belongs_to :customer, :foreign_key => 'user_id'</tt>
   # Creates a belongs_to association called customer which would be resolved by the foreign_key <tt>user_id</tt> instead of <tt>customer_id</tt>
   #
-  def belongs_to(name, options={})
+  def belongs_to(name, options = {})
     Builder::BelongsTo.build(self, name, options)
   end
 
@@ -147,7 +148,7 @@ module ActiveResource::Associations
       elsif attributes.include?(method_name)
         attributes[method_name]
       elsif !new_record?
-        instance_variable_set(ivar_name, reflection.klass.find(:all, :params => {:"#{self.class.element_name}_id" => self.id}))
+        instance_variable_set(ivar_name, reflection.klass.find(:all, params: { :"#{self.class.element_name}_id" => self.id }))
       else
         instance_variable_set(ivar_name, self.class.collection_parser.new)
       end
@@ -165,11 +166,10 @@ module ActiveResource::Associations
       elsif attributes.include?(method_name)
         attributes[method_name]
       elsif reflection.klass.respond_to?(:singleton_name)
-        instance_variable_set(ivar_name, reflection.klass.find(:params => {:"#{self.class.element_name}_id" => self.id}))
+        instance_variable_set(ivar_name, reflection.klass.find(params: { :"#{self.class.element_name}_id" => self.id }))
       else
-        instance_variable_set(ivar_name, reflection.klass.find(:one, :from => "/#{self.class.collection_name}/#{self.id}/#{method_name}#{self.class.format_extension}"))
+        instance_variable_set(ivar_name, reflection.klass.find(:one, from: "/#{self.class.collection_name}/#{self.id}/#{method_name}#{self.class.format_extension}"))
       end
     end
   end
-
 end