activeresource-response 1.1.1 → 1.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NWEwMjAxODIwODM1OTg5MGJlYjUyZWIwNjIxNDZkOTkyZjQ5YmViMA==
-  data.tar.gz: !binary |-
-    YWNlYTBkMjM3NWRkMDMxYTg0M2VkNDc1OWExYjI4OTIyMjhmMDJhZQ==
+SHA256:
+  metadata.gz: c12ab32aee7b9d83f5d71af0fe372188b7aab41618aec5e52ade786e6fe069dd
+  data.tar.gz: 63c1b88d91b907be17ca321eefa29652764310ef26bb46e319f2d3a0d2633742
 SHA512:
-  metadata.gz: !binary |-
-    N2U5Y2MxODhlYjEzMjFiZjhhY2FlMzA2Mjk5ZTFiZjIzY2RiZWM2ZDc2ZGY0
-    M2M2NTliMThiNjA5N2MzMjBjYmJlMzk1Y2VjMDZhZDFmYjRjYWI1OTBjOGFj
-    NWY3OGI4ZmNjMzc3YjkwMWY0NGI2ZjEzNzFiZDFkMzE5NzM3Njc=
-  data.tar.gz: !binary |-
-    OGEyZDA2OTBlZGNkYjUxYzNmNDM3ZmM5OWM2NGFjYTg5ZDk2NzY5NzE4ZTAz
-    MWRmNGM5MDVhNTRjYmIwNDE0NjE4NjhiNTgzNTViNTNkMzZmM2U2OTc5ZmM5
-    NzU1MjhhNjU4NzVlNDc0NGIxNjg1NzZjMTliMGY4NTM1YzlmYmM=
+  metadata.gz: 9db8b4905c290ffd6570c2f1b2a27802947214a8fbc1dafea58042cb83d06c80a7632a475c20d352d509678a2fb15730511e965df25b32ebf4ea2f6f7c5ede08
+  data.tar.gz: bde35f4d766636db84404ac2f6c0a9b4823f74acaa9ad25847db798b4ac49ebb86a3058dd33fd463209eca4bd6198e55af48dee8df09970839533611da926b59

data/.travis.yml

@@ -1,6 +1,3 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - jruby-19mode
-  - 2.1.0
-  - jruby-head
+  - 2.3.0

data/Gemfile

@@ -1,4 +1,8 @@
 source "http://rubygems.org"
+group :test do
+  gem 'coveralls', '0.8.5',  require: false # Test coverage website. Go to https://coveralls.io
+  gem 'tins', '< 1.3.4', platforms: [:ruby_19, :jruby]
+  gem 'term-ansicolor', '<  1.4.0', platforms: [:ruby_19, :jruby]
+end
 
-# Specify your gem's dependencies in activeresource-response.gemspec
 gemspec

data/README.md

@@ -0,0 +1,170 @@
+## 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 )
+
+[![Build Status](http://img.shields.io/travis/Fivell/activeresource-response.png)](https://travis-ci.org/Fivell/activeresource-response)
+[![Coverage Status](http://img.shields.io/coveralls/Fivell/activeresource-response.svg)](https://coveralls.io/r/Fivell/activeresource-response)
+
+
+#### 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.
+
+#### How to use?
+Add dependency to your Gemfile
+
+```ruby
+gem "activeresource-response"
+```
+
+Just 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
+
+```ruby
+class ActiveResource::Base
+  add_response_method :my_response  
+end
+```
+
+You can remove method from ActiveResource subclass
+
+```ruby
+class Order < ActiveResource::Base
+  remove_response_method  
+end
+```
+
+## Full example of usage with kaminari gem
+
+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 
+end
+```
+
+```ruby
+Server Side
+
+class OrdersController < ApplicationController
+  def index
+    @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
+    respond_with(@orders)
+  end
+end
+```
+
+Client Side
+
+```ruby
+class OrdersController < ApplicationController
+  def index
+    orders = Order.all(params: params)     
+    @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
+    }) 
+  end
+end
+```
+
+### will_paginate compatibility
+will_paginate has a little different API, so to populate 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|
+  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
+```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 
+end
+
+orders = Order.all
+first_order = Order.find(1) 
+#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
+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
+```ruby
+class Country < ActiveResource::Base
+  self.site = 'http://0.0.0.0:3000/'
+  add_response_method :http  # our new method
+end
+cities = Country.find(1).get(:cities)
+cities.http #method from Country class is available
+``` 
+
+### 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
+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=/"]} 
+
+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
+
+### Testing with ActiveResource::HttpMock
+Add this line to your test to patch http_mock
+
+```ruby
+ 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
+
+
+#### Please, feel free to contact me if you have any questions
+fedoronchuk(at)gmail.com
+

data/activeresource-response.gemspec

@@ -13,14 +13,11 @@ Gem::Specification.new do |s|
   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', ['>= 3', '< 5'])
+  s.add_runtime_dependency('activeresource', ['>= 3', '< 6'])
   s.add_dependency "jruby-openssl" if RUBY_PLATFORM == "java"
-  s.add_development_dependency "test-unit",'~> 2.5'
+  s.add_development_dependency "minitest" , '~> 5.3'
   s.add_development_dependency 'rake', '~> 10'
 
-  s.extra_rdoc_files = %w( README.rdoc )
-  s.rdoc_options.concat ['--main', 'README.rdoc']
-   
 
   s.files         = `git ls-files | sed '/.gitignore/d'`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/active_resource_response/connection.rb

@@ -33,14 +33,22 @@ module ActiveResourceResponse
             raise
           ensure
             response.extend HttpResponse
-            Thread.current[:ActiveResourceResponse] = response
+            self.http_response=(response)
           end
         end
 
         def http_response
-          Thread.current[:ActiveResourceResponse]
+          http_storage[:ActiveResourceResponse]
+        end
+
+        def http_response=(response)
+          http_storage[:ActiveResourceResponse] = response
+        end
+
+        def http_storage
+          Thread.current
         end
       end
     end
   end
-end
+end

data/lib/active_resource_response/http_mock.rb

@@ -32,6 +32,7 @@ module ActiveResourceResponse
             Hash[@headers.map{|k, value| [k, Array.wrap(value)] } ]
           end
 
+          remove_method :[]
           def [](key)
             @headers[key]
           end

data/lib/active_resource_response/version.rb

@@ -23,6 +23,6 @@
 
 module ActiveResourceResponse
   module Version
-    VERSION = "1.1.1"
+    VERSION = "1.2.0"
   end
 end

data/test/active_resource_response_test.rb

@@ -20,21 +20,9 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
+require_relative 'test_helper'
 
-lib = File.expand_path("#{File.dirname(__FILE__)}/../lib")
-unit_tests = File.expand_path("#{File.dirname(__FILE__)}/../test")
-$:.unshift(lib)
-$:.unshift(unit_tests)
-
-require 'test/unit'
-require 'active_resource_response'
-require "fixtures/country"
-require "fixtures/city"
-require "fixtures/region"
-require "fixtures/street"
-require "active_resource_response/http_mock"
-
-class ActiveResourceResponseTest < Test::Unit::TestCase
+class ActiveResourceResponseTest < MiniTest::Test
 
 
   def setup
@@ -83,17 +71,17 @@ class ActiveResourceResponseTest < Test::Unit::TestCase
   end
 
 
-  def test_get_headers_from_custom_methods
+  def test_headers_from_custom
     cities = Region.get("cities")
     assert cities.respond_to?(:http_response)
     assert_equal cities.http_response.headers[:x_total].first.to_i, 2
     assert_equal cities.http_response['X-total'].to_i, 2
-    count = Country.find(1).get("population")
+    population = Country.find(1).get("population")
 
     #immutable objects doing good
     some_numeric = 45000000
-    assert_equal count, some_numeric
-    assert count.respond_to?(:http)
+    assert_equal population['count'], some_numeric
+    assert population.respond_to?(:http)
     assert !some_numeric.respond_to?(:http)
 
     assert_equal Country.connection.http_response.headers[:x_total].first.to_i, 1
@@ -103,20 +91,17 @@ class ActiveResourceResponseTest < Test::Unit::TestCase
     assert cities.respond_to?(:http), "Cities should respond to http"
     assert_equal cities.http.headers[:x_total].first.to_i, 1, "Cities total value should be 1"
     regions_population = Region.get("population")
-    assert_equal regions_population.to_i, 45000000
+    assert_equal regions_population['count'], 45000000
     cities = Region.find(1).get("cities")
     assert cities.respond_to?(:http_response)
     assert_equal cities.http_response.headers[:x_total], ['1']
-
   end
 
-
   def test_methods_without_http
     cities = City.all
     assert_kind_of City, cities.first
-    count = cities.first.get("population")
+    count = cities.first.get("population")['count']
     assert_equal count.to_i, 2500000
-
   end
 
   def test_get_headers_from_find
@@ -131,10 +116,9 @@ class ActiveResourceResponseTest < Test::Unit::TestCase
     #from class
     assert_equal Country.http_response.cookies['foo'], 'bar'
     assert_equal Country.http_response.cookies['bar'], 'foo'
-
   end
 
-  def test_get_headers_after_exception
+  def test_headers_after_exception
     country = Country.create(@country[:country])
     assert_equal Country.http_response.headers[:x_total], ['1']
     assert_equal Country.http_response.code, 422
@@ -154,7 +138,7 @@ class ActiveResourceResponseTest < Test::Unit::TestCase
      assert region.respond_to?(ActiveResourceResponseBase.http_response_method)
   end
   
-  def test_active_model_naming_methods
+  def test_model_naming_methods
       street = Country.find(1)
       assert street.class.respond_to?(:model_name)
   end

data/test/lint_test.rb

@@ -21,25 +21,15 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-lib = File.expand_path("#{File.dirname(__FILE__)}/../lib")
-unit_tests = File.expand_path("#{File.dirname(__FILE__)}/../test")
-$:.unshift(lib)
-$:.unshift(unit_tests)
+require_relative 'test_helper'
 
 
-require 'active_resource_response'
-require "fixtures/country"
-require "fixtures/city"
-require "fixtures/region"
-require "fixtures/street"
-require "active_resource_response/http_mock"
-
 
 #made pass lint test because of "to_key should return nil when `persisted?` returns false" error
 require "active_resource_response/lint"
 ActiveResource::Base.send :include, ActiveResourceResponse::Lint
 
-class ActiveResourceResponseLintTest <  Test::Unit::TestCase
+class ActiveResourceResponseLintTest <  MiniTest::Test
 
   include ActiveModel::Lint::Tests
 
@@ -47,8 +37,11 @@ class ActiveResourceResponseLintTest <  Test::Unit::TestCase
       @street = {:street => {:id => 1, :name => "Deribasovskaya", :population => 2300}}
       ActiveResource::HttpMock.respond_to do |mock|
          mock.get "/streets/1.json", {}, @street.to_json, 200, {"X-total"=>'1'}
-     end
+      end
      @model = Street.find(1)   
    end
+
+
+
 end
   

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'coveralls'
+Coveralls.wear!
+require 'minitest/autorun'
+require 'i18n'
+lib = File.expand_path("#{File.dirname(__FILE__)}/../lib")
+unit_tests = File.expand_path("#{File.dirname(__FILE__)}/../test")
+$:.unshift(lib)
+$:.unshift(unit_tests)
+I18n.config.enforce_available_locales = true
+require 'active_resource_response'
+require "fixtures/country"
+require "fixtures/city"
+require "fixtures/region"
+require "fixtures/street"
+require "active_resource_response/http_mock"

metadata

@@ -1,76 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: activeresource-response
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Igor Fedoronchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-29 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '5.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-description: ! 'This gem adds possibility to access http response object from result
+description: 'This gem adds possibility to access http response object from result
   of ActiveResource::Base find method '
 email:
 - fedoronchuk@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
-- .travis.yml
+- ".travis.yml"
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - activeresource-response.gemspec
 - lib/active_resource_response.rb
@@ -88,29 +87,28 @@ files:
 - test/fixtures/region.rb
 - test/fixtures/street.rb
 - test/lint_test.rb
+- test/test_helper.rb
 homepage: http://fivell.github.com/activeresource-response/
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- --main
-- README.rdoc
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: activeresource extension
@@ -121,3 +119,4 @@ test_files:
 - test/fixtures/region.rb
 - test/fixtures/street.rb
 - test/lint_test.rb
+- test/test_helper.rb

data/README.rdoc

@@ -1,131 +0,0 @@
-= 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 )
-
-== Build status {<img src="https://secure.travis-ci.org/Fivell/activeresource-response.png" />}[http://travis-ci.org/Fivell/activeresource-response]  
-
-
-== 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.
-
-== How to use?
-Add dependency to your Gemfile
-
-  gem "activeresource-response"
-
-Just open your ActiveResource class  and add 
- 
-  add_response_method :your_method_name
-
-You can add method to ActiveResource::Base to use it in all subclasses
-
-  class ActiveResource::Base
-    add_response_method :my_response  
-  end
-
-
-You can remove method from ActiveResource subclass
-
-  class Order < ActiveResource::Base
-    remove_response_method  
-  end
-
-
-== Full example of usage with kaminari gem
-
-Rest Client
-
-  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 
-  end
-
-Server Side
-
-  class OrdersController < ApplicationController
-    def index
-      @orders = Order.page(params[:page]).per(params[: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
-      respond_with(@orders)
-    end
-  end
-
-Client Side
-
-  class OrdersController < ApplicationController
-    def index
-      orders = Order.all(:params=>params)     
-      @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
-        }) 
-    end
-  end
-
- 
-== Every time when http connection invoked ActiveResource connection object  stores http response. You can access it with http_response method. 
-Example
-
-  class Order < ActiveResource::Base
-    self.site = 'http://0.0.0.0:3000/'
-    self.element_name = "order" 
-    add_response_method :my_response  # our new method 
-  end
-
-  orders = Order.all
-  first_order = Order.find(1) 
-  #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
-  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
-
-  class Country < ActiveResource::Base
-    self.site = 'http://0.0.0.0:3000/'
-    add_response_method :http  # our new method
-  end
-  cities = Country.find(1).get(:cities)
-  cities.http #method from Country class is available
- 
-
-== Headers and cookies methods 
-You can get cookies and headers from response 
-Example
-
-  class Country < ActiveResource::Base
-    self.site = 'http://0.0.0.0:3000/'
-    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=/"]} 
-
-
-  countries.my_response.cookies
- # => {"bar"=>"foo", "foo"=>"bar"}   
-  
-== 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
-
-== Testing with ActiveResource::HttpMock
-Add this line to your test to patch http_mock
-
- # require "active_resource_response/http_mock"
-
-== Please, feel free to contact me if you have any questions
-fedoronchuk(at)gmail.com
-