rack-refresh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c406857b2daed8baa5f6bbd7121368a4473169c
+  data.tar.gz: c1b16f8e8194320e3d8d2566b26c52de31539357
+SHA512:
+  metadata.gz: 585e9fcf29a000bf4bbb5b4784277d2a4284238e8c205de6206f5ed4e21ce0190a98060504f3d1894b98550bb0b0e312504b685de38caa73c2c9cf4e8bcdf1e1
+  data.tar.gz: fd8e28c4722a1fe7e5c367af4e6ac8d03e5a6cf2325916db82b3000b160c211d6f03dd98490d6db37981bd0fed8b687a6218b2a68b396d6b5a77ff8409969274

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-refresh.gemspec
+group :test do
+  gem 'rack-test', require: "rack/test"
+  gem 'rack', require: "rack/builder"
+end
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 namusyaka
+
+MIT License
+
+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.md

@@ -0,0 +1,83 @@
+# Rack::Refresh
+
+Rack Middleware for adding `Refresh` field to response headers.
+
+**`Refresh` is supported by modern browsers, but it isn't official HTTP standard.
+So please be careful when using this.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-refresh'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-refresh
+
+## Usage
+
+`Rack::Refresh` is easy to use.
+I would explain how to use it in three sections.
+
+```ruby
+use Rack::Refresh do
+  refresh "/", interval: 5, url: "http://www.google.com/"
+  refresh do |env|
+    env["PATH_INFO"] == "/path" && env["REQUEST_METHOD"].to_s.upcase == "GET"
+  end
+  refresh %r{/hello.+?} do |env|
+    env["PATH_INFO"].start_with?("/hello")
+  end
+end
+```
+
+### with Path
+
+The path can be set string and regex.
+The refresh field will be added to response headers if the path matches with `ENV["PATH_INFO"]`
+
+```ruby
+use Rack::Refresh do
+  # String
+  refresh "/", url: "http://www.google.com/"
+  # Regex
+  refresh %r{/foo}, url: "http://www.google.com/"
+end
+```
+
+### with Block
+
+The refresh field will be added to response headers if the return value of block is `true`.
+
+```ruby
+use Rack::Refresh do
+  refresh do |env|
+    env["PATH_INFO"].start_with?("/hello")
+  end
+end
+```
+
+### Configuration
+
+`:url` and `:interval` can be set in `refresh` and `use` methods.
+If options are set in both methods, `refresh`'s option will be priority.
+
+```ruby
+use Rack::Refresh, url: "http://www.google.com/", interval: 5 do
+  refresh "/" #=> Refresh: 5; url=http://www.google.com/
+  refresh "/foo", url: "http://namusyaka.info/", interval: 0 #=> Refresh: 0; url=http://namusyaka.info/
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/namusyaka/rack-refresh/fork )
+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

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+desc "Run all specs."
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = "--color"
+end
+task default: :spec
+

data/lib/rack-refresh.rb

@@ -0,0 +1 @@
+require 'rack/refresh'

data/lib/rack/refresh.rb

@@ -0,0 +1,47 @@
+require 'rack/refresh/version'
+
+module Rack
+  class Refresh
+    def initialize(app, url: nil, interval: 0, **options, &block)
+      @app      = app
+      @url      = url
+      @interval = interval
+      instance_eval(&block) if block_given?
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      response = @app.call(env)
+      route = find_refresh_route_from(env)
+      refresh_for(response, route[:interval], route[:url]) if route
+      response
+    end
+
+    def refresh(path = nil, interval: nil, url: nil, &matcher)
+      current_route = {interval: interval || @interval, url: url || @url}
+      raise ArgumentError, "`:url` must be set in refresh" unless current_route[:url]
+      return unless path || block_given?
+      current_route[:path] = path
+      current_route[:matcher] = matcher
+      routes << current_route
+    end
+
+    def refresh_for(response, interval, url)
+      response[1]["Refresh"] = "#{interval}; url=#{url}"
+    end
+
+    def find_refresh_route_from(env)
+      path_info = env["PATH_INFO"]
+      routes.find{|route| route[:path] ? (route[:path] === path_info) : route[:matcher].call(env) }
+    end
+
+    def routes
+      @routes ||= []
+    end
+
+    private :find_refresh_route_from, :routes, :refresh_for
+  end
+end

data/lib/rack/refresh/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Refresh
+    VERSION = "0.0.1"
+  end
+end

data/rack-refresh.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/refresh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-refresh"
+  spec.version       = Rack::Refresh::VERSION
+  spec.authors       = ["namusyaka"]
+  spec.email         = ["namusyaka@gmail.com"]
+  spec.summary       = %q{Rack Middleware for adding Refresh field to response headers}
+  spec.description   = %q{Rack Middleware for adding Refresh field to response headers}
+  spec.homepage      = "https://github.com/namusyaka/rack-refresh"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/refresh_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Rack::Refresh do
+  context "with path" do
+    before do
+      mock_app do
+        use Rack::Refresh do
+          refresh "/", url: "https://www.google.co.jp/"
+          refresh "/some", url: "https://www.google.co.jp/some", interval: 5
+          refresh %r{\A/archives/\d+\z}, url: "http://namusyaka.info/"
+        end
+        run TestApp.new
+      end
+    end
+
+    it "can be set path as the condition for refreshing response" do
+      get "/"
+      expect(last_response.headers["Refresh"]).to eq("0; url=https://www.google.co.jp/")
+      get "/some"
+      expect(last_response.headers["Refresh"]).to eq("5; url=https://www.google.co.jp/some")
+    end
+
+    it "can be set path as the condition for refreshing response if path is an instance of regexp" do
+      get "/archives/1234"
+      expect(last_response.headers["Refresh"]).to eq("0; url=http://namusyaka.info/")
+    end
+
+    it "should not refresh response if the path is not matched with env['PATH_INFO']" do
+      get "/hello_world"
+      expect(last_response.headers["Refresh"]).to be_nil
+    end
+  end
+
+  context "with block" do
+    before do
+      mock_app do
+        use Rack::Refresh do
+          refresh url: "https://www.google.co.jp/" do |env|
+            env["PATH_INFO"].start_with?("/hello")
+          end
+        end
+        run TestApp.new
+      end
+    end
+
+    it "can be set block as the condition for refreshing response" do
+      get "/hello"
+      expect(last_response.headers["Refresh"]).to eq("0; url=https://www.google.co.jp/")
+    end
+
+    it "should not refresh response if the return value of block is false" do
+      get "/hell_world"
+      expect(last_response.headers["Refresh"]).to be_nil
+    end
+  end
+
+  context "with parent options" do
+    before do
+      mock_app do
+        use Rack::Refresh, url: "https://www.google.co.jp/", interval: 5 do
+          refresh "/"
+          refresh %r{/\d+}, url: "http://namusyaka.info/", interval: 3
+        end
+        run TestApp.new
+      end
+    end
+
+    it "can be set options as the default condition for refreshing response" do
+      get "/"
+      expect(last_response.headers["Refresh"]).to eq("5; url=https://www.google.co.jp/")
+    end
+
+    it "can override the parent options by setting refresh options" do
+      get "/1234"
+      expect(last_response.headers["Refresh"]).to eq("3; url=http://namusyaka.info/")
+    end
+  end
+
+  describe "exception" do
+    it "should raise ArgumentError if :url is not set in refresh method" do
+      expect { Rack::Refresh.new{ refresh "/" }}.to raise_error(ArgumentError)
+    end
+
+    it "should not raise ArgumentError if :url is set as the parent options" do
+      expect { Rack::Refresh.new(nil, url: "https://www.google.co.jp/"){ refresh "/" }}.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require File.expand_path("../../lib/rack/refresh", __FILE__)
+require 'bundler' unless defined?(Bundler)
+Bundler.require(:test)
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end
+
+def app
+  @app
+end
+
+def mock_app(&block)
+  @app = Rack::Builder.new(&block)
+end
+
+class TestApp
+  def call(env)
+    [200, {"Content-Type" => "text/plain"}, ["test app"]]
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rack-refresh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- namusyaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack Middleware for adding Refresh field to response headers
+email:
+- namusyaka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-refresh.rb
+- lib/rack/refresh.rb
+- lib/rack/refresh/version.rb
+- rack-refresh.gemspec
+- spec/refresh_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/namusyaka/rack-refresh
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Rack Middleware for adding Refresh field to response headers
+test_files:
+- spec/refresh_spec.rb
+- spec/spec_helper.rb
+has_rdoc: