activeresource-conditional-get 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2-p290@activeresource-conditional-get

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+gem "activeresource", ">= 2.3.10"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Sergey Rozum
+
+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

@@ -0,0 +1,47 @@
+= activeresource-conditional-get
+
+HTTP conditional get support for ActiveResource.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activeresource-conditional-get'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activeresource-conditional-get
+
+== Usage
+
+Works out of box after adding:
+
+    ActiveResource::Base.cache = Rails.cache
+    
+Or
+  
+    ActiveResource::Base.cache = ActiveSupport::Cache.lookup_store(:mem_cache_store)
+    
+
+== References
+
+* [activeresource](https://github.com/rails/activeresource)
+* [HTTP Conditional Get](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)
+
+== Contributing to activeresource-conditional-get
+
+* Fork it
+* Create your feature branch (`git checkout -b my-new-feature`)
+* Commit your changes (`git commit -am 'Added some feature'`)
+* Push to the branch (`git push origin my-new-feature`)
+* Create new Pull Request
+
+== Copyright
+
+Copyright (c) 2012 Sergey Rozum. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "activeresource-conditional-get"
+  gem.homepage = "http://github.com/srozum/activeresource-conditional-get"
+  gem.license = "MIT"
+  gem.summary = %Q{HTTP conditional get support for ActiveResource}
+  gem.description = %Q{HTTP conditional get support for ActiveResource}
+  gem.email = "sergey.rozum@gmail.com"
+  gem.authors = ["Sergey Rozum"]
+  # dependencies defined in Gemfile
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activeresource-conditional-get #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/activeresource-conditional-get.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "activeresource-conditional-get"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sergey Rozum"]
+  s.date = "2012-06-06"
+  s.description = "HTTP conditional get support for ActiveResource"
+  s.email = "sergey.rozum@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "activeresource-conditional-get.gemspec",
+    "lib/active_resource/conditional_get.rb",
+    "lib/active_resource/conditional_get/base.rb",
+    "lib/active_resource/conditional_get/connection.rb",
+    "lib/activeresource_conditional_get.rb",
+    "test/helper.rb",
+    "test/test_activeresource-conditional-get.rb"
+  ]
+  s.homepage = "http://github.com/srozum/activeresource-conditional-get"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.21"
+  s.summary = "HTTP conditional get support for ActiveResource"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activeresource>, [">= 2.3.10"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<activeresource>, [">= 2.3.10"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<activeresource>, [">= 2.3.10"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

data/lib/active_resource/conditional_get.rb

@@ -0,0 +1,2 @@
+require 'active_resource/conditional_get/base'
+require 'active_resource/conditional_get/connection'

data/lib/active_resource/conditional_get/base.rb

@@ -0,0 +1,32 @@
+require 'active_resource/base'
+
+module ActiveResource
+  class Base
+
+    cattr_accessor :cache
+
+    class << self
+      
+      def connection_with_cache(refresh = false)
+        if defined?(@connection) || superclass == Object
+          @connection = Connection.new(site, format) if refresh || @connection.nil?
+          @connection.proxy = proxy if proxy
+          @connection.user = user if user
+          @connection.password = password if password
+          @connection.auth_type = auth_type if auth_type
+          @connection.timeout = timeout if timeout
+          @connection.ssl_options = ssl_options if ssl_options
+          @connection.cache = cache if cache
+          @connection
+        else
+          superclass.connection
+        end
+      end
+
+      alias_method :connection_without_cache, :connection
+      alias_method :connection, :connection_with_cache
+      
+    end
+
+  end
+end

data/lib/active_resource/conditional_get/connection.rb

@@ -0,0 +1,42 @@
+require 'active_resource/connection'
+
+module ActiveResource
+  class Connection
+    extend ActiveSupport::Concern
+    
+    attr_accessor :cache
+
+    def get_with_conditional_get(path, headers = {})
+      return get_without_conditional_get(path, headers) unless cache
+      begin
+        cached_response = cache.read(cache_key(path))
+        if cached_response
+          headers.update('If-None-Match' => cached_response['eTag']) if cached_response['eTag']
+          headers.update('If-Modified-Since' => cached_response['Cache-Control']) if cached_response['Cache-Control']
+        end
+
+        response = get_without_conditional_get(path, headers)
+        
+        return cached_response if (response.try(:code).to_i == 304) && cached_response
+        
+        if (response['Cache-Control'] =~ /public/) && (response['eTag'] || response['Last-Modified'])
+          if response['Cache-Control'] =~ /max-age=(\d+)/ && $1.to_i > 0
+            cache.write(cache_key(path), response, :expires_in => $1.to_i)
+          end
+        end
+        return response
+      rescue ActiveResource::TimeoutError => e
+        cached_response || raise(e)
+      end
+    end
+
+    alias_method_chain :get, :conditional_get
+
+    private
+    
+    def cache_key(path)
+      'conditional_get:' + Digest::MD5.hexdigest(path)
+    end
+    
+  end
+end

data/lib/activeresource_conditional_get.rb

@@ -0,0 +1,5 @@
+unless defined?(ActiveResource)
+  require 'active_resource'
+end
+
+require 'active_resource/conditional_get'

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'activeresource-conditional-get'
+
+class Test::Unit::TestCase
+end

data/test/test_activeresource-conditional-get.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestActiveresourceConditionalGet < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: activeresource-conditional-get
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sergey Rozum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.10
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: HTTP conditional get support for ActiveResource
+email: sergey.rozum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- activeresource-conditional-get.gemspec
+- lib/active_resource/conditional_get.rb
+- lib/active_resource/conditional_get/base.rb
+- lib/active_resource/conditional_get/connection.rb
+- lib/activeresource_conditional_get.rb
+- test/helper.rb
+- test/test_activeresource-conditional-get.rb
+homepage: http://github.com/srozum/activeresource-conditional-get
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2584738020901776792
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: HTTP conditional get support for ActiveResource
+test_files: []