activeresource-response 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 778a018729531e904d1ff54a1a3309bedac596894b70a495ffc9d9f1839c8014
-  data.tar.gz: 579cd1eb6153c248c5b500c022725a14d9ff4aa7ec74d3489a95f25bc0291ada
+  metadata.gz: ac95d9180051ba82db3f5e1983cf87321855351f8a7a06e546a866207d2bcdd3
+  data.tar.gz: 354b4839689f1c964eaa251fbf264e9cccfd80b3378a0d6c466c38b05016bc10
 SHA512:
-  metadata.gz: 826b1faf27ea5bde5a5a7194b1dd755f13586906edccd307cdf5dcc6d86ff79ed2d5dbcd95e7f2bfb8789f6afd4c2348a9a1f87d3cb38b21f41bc2649b690dbc
-  data.tar.gz: ec4a5ff57d041ee895b34858e7d01bfe68e6b986253e480cb6c9c169e97a859eee4fedd4880c615b5c1493462c37f1177d6652dbb7306fc4ad710781ba5104b0
+  metadata.gz: 3965902ea880021dbffd11ccb6796fdfce27c636fa7592c71a4ca710d61dbc04801e60045b7adf861c47576a868fe6d6bd616e7fa49179396b4a3dd1c473d964
+  data.tar.gz: 82615892c23ef13731a3a1e7288a47d5df8caf054fb61fe2de21c7fe0eea410221954dbbc5ab653a8fe93be8dacdbdd8fdfdd71597c8ddbe6dbcaaaaca8589a0

data/README.md

@@ -1,23 +1,23 @@
-## Activeresource-response 
-This gem adds possibility to access http response (Net::HTTPResponse) object from result (single object or collection) of activeresource call (methods : find, all, first, last, get )
+## ActiveResource-Response
+This gem adds the ability to access the HTTP response (`Net::HTTPResponse`) object from the result (either a single object or a collection) of an ActiveResource call (methods: `find`, `all`, `first`, `last`, `get`).
 
-#### Why It can be used?
-Such functionallity can be used for easily implementing pagination in a REST API so that an ActiveResource client can navigate paginated results.
+#### Why Can It Be Used?
+This functionality can be used to easily implement pagination in a REST API, so that an ActiveResource client can navigate paginated results.
 
-#### How to use?
-Add dependency to your Gemfile
+#### How to Use?
+Add the dependency to your `Gemfile`:
 
 ```ruby
 gem "activeresource-response"
 ```
 
-Just open your ActiveResource class  and add 
+Open your ActiveResource class and add:
 
 ```ruby
 add_response_method :your_method_name
 ```
 
-You can add method to ActiveResource::Base to use it in all subclasses
+You can add the method to `ActiveResource::Base` to use it in all subclasses:
 
 ```ruby
 class ActiveResource::Base
@@ -25,7 +25,7 @@ class ActiveResource::Base
 end
 ```
 
-You can remove method from ActiveResource subclass
+You can remove the method from an ActiveResource subclass:
 
 ```ruby
 class Order < ActiveResource::Base
@@ -33,25 +33,25 @@ class Order < ActiveResource::Base
 end
 ```
 
-## Full example of usage with kaminari gem
+## Full Example of Usage with the Kaminari Gem
 
-ActiveResource Class
+ActiveResource Class:
 
 ```ruby
 class Order < ActiveResource::Base
   self.format = :json
   self.site = 'http://0.0.0.0:3000/'
   self.element_name = "order" 
-  add_response_method :http_response  # our new method for returned objects 
+  add_response_method :http_response  # Our new method for returned objects
 end
 ```
 
-```ruby
-Server Side
+Server Side:
 
+```ruby
 class OrdersController < ApplicationController
   def index
-    @orders = Order.page(params[:page]).per(params[:per_page] || 10) #default 10 per page
+    @orders = Order.page(params[:page]).per(params[:per_page] || 10) # default 10 per page
     response.headers["X-total"] = @orders.total_count.to_s
     response.headers["X-offset"] = @orders.offset_value.to_s
     response.headers["X-limit"] = @orders.limit_value.to_s
@@ -60,13 +60,13 @@ class OrdersController < ApplicationController
 end
 ```
 
-Client Side
+Client Side:
 
 ```ruby
 class OrdersController < ApplicationController
   def index
     orders = Order.all(params: params)     
-    @orders = Kaminari::PaginatableArray.new(orders,{
+    @orders = Kaminari::PaginatableArray.new(orders, {
       limit: orders.http_response['X-limit'].to_i,
       offset: orders.http_response['X-offset'].to_i,
       total_count: orders.http_response['X-total'].to_i
@@ -75,92 +75,102 @@ class OrdersController < ApplicationController
 end
 ```
 
-### will_paginate compatibility
-will_paginate has a little different API, so to populate headers 
+### Will_paginate Compatibility
+`will_paginate` has a slightly different API, so to populate the headers:
 
 ```ruby
 response.headers["X-total"] = @orders.total_entries.to_s
 response.headers["X-offset"] = @orders.offset.to_s
 response.headers["X-limit"] = @orders.per_page.to_s
-``` 
+```
 
-On the API client side you might also use will_paginate, in that case you can just require will_paginate/array (in initializer for example)
- ```ruby
- orders = Order.all(params: params)     
- @orders = WillPaginate::Collection.create(params[:page] || 1, params[:per_page] || 10, orders.http_response['X-total'].to_i) do |pager|
+On the API client side, you might also use `will_paginate`. In that case, you can just require `will_paginate/array` (e.g., in an initializer):
+
+```ruby
+orders = Order.all(params: params)     
+@orders = WillPaginate::Collection.create(params[:page] || 1, params[:per_page] || 10, orders.http_response['X-total'].to_i) do |pager|
   pager.replace orders
 end
 ```
 
-### Every time when http connection invoked ActiveResource connection object  stores http response. You can access it with http_response method. 
-Example
+### Every Time an HTTP Connection is Invoked
+The ActiveResource connection object stores the HTTP response. You can access it with the `http_response` method. 
+
+Example:
+
 ```ruby
 class Order < ActiveResource::Base
   self.site = 'http://0.0.0.0:3000/'
   self.element_name = "order" 
-  add_response_method :my_response  # our new method 
+  add_response_method :my_response  # Our new method 
 end
 
 orders = Order.all
 first_order = Order.find(1) 
-#see Net::HTTPResponse#[] method
+# See Net::HTTPResponse#[] method
 orders.my_response['content-length'] 
 # => "3831" 
 first_order.my_response['content-length'] 
-#=> "260"
-#connection also always has last http response object , to access it use http_response method
+# => "260"
+# Connection also always has the last HTTP response object. To access it, use the http_response method:
 Order.connection.http_response.to_hash
 # => {"content-type"=>["application/json; charset=utf-8"], "x-ua-compatible"=>["IE=Edge"], "etag"=>["\"573cabd02b2f1f90405f7f4f77995fab\""], "cache-control"=>["max-age=0, private, must-revalidate"], "x-request-id"=>["2911c13a0c781044c474450ed789613d"], "x-runtime"=>["0.071018"], "content-length"=>["260"], "server"=>["WEBrick/1.3.1 (Ruby/1.9.2/2011-02-18)"], "date"=>["Sun, 19 Feb 2012 10:21:29 GMT"], "connection"=>["close"]} 
- ```
- 
-### Custom get method
-You can access response from result of custom get method
-Example
+```
+
+### Custom `get` Method
+You can access the response from the result of a custom `get` method.
+
+Example:
+
 ```ruby
 class Country < ActiveResource::Base
   self.site = 'http://0.0.0.0:3000/'
-  add_response_method :http  # our new method
+  add_response_method :http  # Our new method
 end
+
 cities = Country.find(1).get(:cities)
-cities.http #method from Country class is available
-``` 
+cities.http  # Method from the Country class is available
+```
+
+### Headers and Cookies Methods
+You can get cookies and headers from the response.
+
+Example:
 
-### Headers and cookies methods 
-You can get cookies and headers from response 
-Example
 ```ruby
 class Country < ActiveResource::Base
   self.site = 'http://0.0.0.0:3000/'
-  add_response_method :my_response  # our new method
+  add_response_method :my_response  # Our new method
 end
+
 countries = Country.all
 countries.my_response.headers
 
-# collection with symbolized keys => {:content_type=>["application/json; charset=utf-8"], :x_ua_compatible=>["IE=Edge"], ..., :set_cookie=>["bar=foo; path=/", "foo=bar; path=/"]} 
+# Collection with symbolized keys:
+# {:content_type=>["application/json; charset=utf-8"], :x_ua_compatible=>["IE=Edge"], ..., :set_cookie=>["bar=foo; path=/", "foo=bar; path=/"]}
 
 countries.my_response.cookies
- # => {"bar"=>"foo", "foo"=>"bar"}   
- ```
- 
-### Note About Http response 
-http response is object of ```Net::HTTPOK```, ```Net::HTTPClientError``` or one of other subclasses
-of Net::HTTPResponse class. For more information see documentation  http://www.ruby-doc.org/stdlib-1.9.3/libdoc/net/http/rdoc/Net/HTTPResponse.html
+# => {"bar"=>"foo", "foo"=>"bar"}   
+```
+
+### Note About HTTP Response
+The HTTP response is an object of `Net::HTTPOK`, `Net::HTTPClientError`, or one of the other subclasses of the `Net::HTTPResponse` class. For more information, see the documentation: [Net::HTTPResponse](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/net/http/rdoc/Net/HTTPResponse.html).
 
 ### Testing with ActiveResource::HttpMock
-Add this line to your test to patch http_mock
+Add this line to your test to patch `http_mock`:
 
 ```ruby
- require "active_resource_response/http_mock"
+require "active_resource_response/http_mock"
 ```
 
 ### Contributing
-  Fork it
-  Create your feature branch (git checkout -b my-new-feature)
-  Commit your changes (git commit -am 'Add some feature')
-  Push to the branch (git push origin my-new-feature)
-  Create new Pull Request
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
 
-
-#### Please, feel free to contact me if you have any questions
+#### Please feel free to contact me if you have any questions:
 fedoronchuk(at)gmail.com
 
+

data/activeresource-response.gemspec

@@ -8,12 +8,13 @@ Gem::Specification.new do |s|
   s.version     = ActiveResourceResponse::Version::VERSION
   s.authors     = ["Igor Fedoronchuk"]
   s.email       = ["fedoronchuk@gmail.com"]
-  s.homepage    = "http://fivell.github.com/activeresource-response/"
+  s.homepage    = "https://github.com/didww/activeresource-response"
   s.summary     = %q{activeresource extension}
   s.description = %q{This gem adds possibility to access http response object from result of ActiveResource::Base find method }
   s.license     = 'MIT'
 
-  s.add_runtime_dependency('activeresource', ['>= 6.1', '< 6.2'])
+  s.add_runtime_dependency('activeresource', ['>= 6.1', '< 6.3'])
+  s.add_dependency 'activesupport'
   s.add_dependency "jruby-openssl" if RUBY_PLATFORM == "java"
   s.add_development_dependency "minitest"
   s.add_development_dependency 'rake'

data/lib/active_resource_response/connection.rb

@@ -22,6 +22,18 @@
 #++
 module ActiveResourceResponse
   module Connection
+    class Current < ActiveSupport::CurrentAttributes
+      attribute :http_responses, default: {}
+
+      def http_response(klass)
+        http_responses[klass]
+      end
+
+      def set_http_response(klass, response)
+        http_responses[klass] = response
+      end
+    end
+
     def self.included(base)
       base.class_eval do
         alias_method :origin_handle_response, :handle_response
@@ -38,15 +50,11 @@ module ActiveResourceResponse
         end
 
         def http_response
-          http_storage[:ActiveResourceResponse]
+          Current.http_response(self.class)
         end
 
         def http_response=(response)
-          http_storage[:ActiveResourceResponse] = response
-        end
-
-        def http_storage
-          Thread.current
+          Current.set_http_response self.class, response
         end
       end
     end

data/lib/active_resource_response/version.rb

@@ -23,6 +23,6 @@
 
 module ActiveResourceResponse
   module Version
-    VERSION = "3.0.0"
+    VERSION = "3.1.0"
   end
 end

data/test/active_resource_response_test.rb

@@ -50,6 +50,8 @@ class ActiveResourceResponseTest < Minitest::Test
       mock.get "/streets/1/city.json", {}, @city.to_json, 200, {"X-total"=>'1'}
       mock.get "/streets/1.json", {}, @street.to_json, 200, {"X-total"=>'1'}
     end
+
+    ActiveResourceResponse::Connection::Current.reset
   end
 
 
@@ -115,7 +117,7 @@ class ActiveResourceResponseTest < Minitest::Test
   end
 
   def test_get_headers_from_find_when_404_custom_prefix
-    Status.all params: { country_id: 1 }
+    Status.all(params: { country_id: 1 }).to_a
     assert_equal Status.http_response.code, 404
   end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activeresource-response
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Igor Fedoronchuk
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -19,7 +18,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '6.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +28,21 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -103,11 +116,10 @@ files:
 - test/fixtures/street.rb
 - test/lint_test.rb
 - test/test_helper.rb
-homepage: http://fivell.github.com/activeresource-response/
+homepage: https://github.com/didww/activeresource-response
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,8 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key:
+rubygems_version: 4.0.4
 specification_version: 4
 summary: activeresource extension
 test_files: