rack-noncache 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90e77c300227a2e4546e97d8f0ef905fcae0244b
-  data.tar.gz: 067fcb81574f903d880228d639f3b425c1be6efb
+  metadata.gz: 98ee0e056e4c7cc4d17da92940bff448d0847f3e
+  data.tar.gz: 1a3ac367d4d4a519afefa3be1dcf96e2975fc999
 SHA512:
-  metadata.gz: 3f31abdcc6fdeffa4b490782250182ea4d0fc3faa9666864931d9ffbbad1007715acd07d082f88f36060ba294dbf75fa9d0b1c9cd7918603bbf84098e0dc9183
-  data.tar.gz: 9ecd519bab72dee6f1b930c69f821db8394d3310a9b196aaf48eded9a7d2f62f0505cb439c525281e33502bba7194335e994f8e7db435074e441f4f2e3f0305d
+  metadata.gz: 060c8f8943da2fee141d03619dcf49baf2eed678eab15597dd615ac1d4a389825059ce7b01f762217962fec7511d160910ff698e57fc1003190769109f61f700
+  data.tar.gz: 42fee0365a4308e35761e12c8bd599c455ee259473ef5b014942b2c425afcc2371db100c2d6b28876bfaa7b060ccc76bde396fcd2fabee065a103eecae598a2b

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+data.db

data/.pryrc

@@ -0,0 +1,6 @@
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+end

data/.ruby-gemset

@@ -0,0 +1 @@
+rack-noncache

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+- 2.1.2
+before_install:
+- gem update --system
+- gem --version
+script:
+- export TRAVIS=true
+- bundle exec rake
+after_success:
+  coveralls
+addons:
+  sauce_connect: true
+  code_climate:
+    repo_token: f6d5a24aa8a0c85d8bc0f2d622f0056918b56c764fb812b711d68469bdb8356a

data/README.md

@@ -1,10 +1,15 @@
-Rack::NonCache
-==============
+[![Gem Version](https://badge.fury.io/rb/rack-noncache.svg)](http://badge.fury.io/rb/rack-noncache)
+[![Build Status](https://travis-ci.org/dsaenztagarro/rack-noncache.png)](https://travis-ci.org/dsaenztagarro/rack-noncache)
+[![Code Climate](https://codeclimate.com/github/dsaenztagarro/rack-noncache/badges/gpa.svg)](https://codeclimate.com/github/dsaenztagarro/rack-noncache)
+[![Coverage Status](https://coveralls.io/repos/dsaenztagarro/rack-noncache/badge.png?branch=master)](https://coveralls.io/r/dsaenztagarro/rack-noncache?branch=master)
+[![Dependency Status](https://gemnasium.com/dsaenztagarro/rack-noncache.svg)](https://gemnasium.com/dsaenztagarro/rack-noncache)
+
+# Rack::NonCache
 
 Rack::NonCache is a rack middleware that disables HTTP browser caching.
 
-Installation
-------------
+
+## Installation
 
 From Gem:
 
@@ -15,72 +20,51 @@ With a local working copy:
     $ git clone git://github.com/dsaenztagarro/rack-noncache.git
     $ rake package && sudo rake install
 
-Basic Usage
------------
+## Basic Usage
 
 Rack::NonCache is implemented as a piece of Rack middleware and can be used with
 any Rack-based application. If your application includes a rackup (`.ru`) file
 or uses Rack::Builder to construct the application pipeline, simply require
 and use as follows:
 
-    require 'rack/noncache'
+```ruby
+require 'rack/noncache'
 
-    use Rack::NonCache,
-      :metastore   => 'file:/var/cache/rack/meta',
+use Rack::NonCache,
+    :whitelist => ['/path/to/non/caching/url', ...,
+                   Regexp.new(/^\/path\/to\/non\/caching\/url/)]
 
-    run app
+run app
+```
 
 Assuming you've designed your backend application to take advantage of HTTP's
 caching features, no further code or configuration is required for basic
 caching.
 
-Using with Rails
-----------------
+## Using with Rails
 
 Add this to your `config/environment.rb`:
 
-    config.middleware.use Rack::NonCache,
-        :whitelist => ['/path/to/non/caching/url', ...,
-                       Regexp.new(/^\/path\/to\/non\/caching\/url/)]
-or:
-
-    config.middleware.use Rack::NonCache,
-        :blacklist => ['/path/to/non/caching/url', ...,
-                       Regexp.new(/^\/path\/to\/non\/caching\/url/)],
-
-You should now see `Rack::NonCache` listed in the middleware pipeline:
-
-    rake middleware
-
-See the following for more information:
-
-    http://snippets.aktagon.com/snippets/302
-
-
-Links
------
-
-GitHub:
-    http://github.com/dsaenztagarro/rack-noncache/
+```ruby
+# White list approach (option 1)
+config.middleware.use Rack::NonCache,
+    :whitelist => ['/path/to/non/caching/url', ...,
+                   Regexp.new(/^\/path\/to\/non\/caching\/url/)]
 
-License
--------
+# Black list approach (option 2)
 
-Copyright (c) 2014 David Saenz Tagarro
+config.middleware.use Rack::NonCache,
+    :blacklist => ['/path/to/non/caching/url', ...,
+                   Regexp.new(/^\/path\/to\/non\/caching\/url/)],
+```
 
-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:
+You should now see `Rack::NonCache` listed in the middleware pipeline: 
+`rake middleware`
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+## Contributing
 
-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 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.
+1. Fork it ( https://github.com/dsaenztagarro/rack-noncache/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

@@ -1 +1,16 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rubocop/rake_task'
+
+Dir.glob('lib/tasks/*.rake').each { |path| load path }
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec'
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = 'features --format pretty'
+end
+
+task default: ['features']

data/features/cache_control.feature

@@ -0,0 +1,22 @@
+Feature: Disable cache in browser navigation
+
+  Scenario Outline: Pressing back browser button
+    Given a <Strategy> for no caching my web application
+    And I am a <Platform> user
+    And I open a '<Browser>' <Version>
+    And I visit the home page
+    And I store 3 todo tasks in session
+    When I click on Show details
+    And I press the back browser button
+    Then I see the 3 todo tasks in todo list
+
+    Examples:
+      | Browser           | Version | Strategy  | Platform   |
+      | firefox           | 34      | whitelist | Linux      |
+      | firefox           | 34      | blacklist | Linux      |
+#       | chrome            | 38      | whitelist | Linux      |
+#       | opera             | 12      | whitelist | Linux      |
+#       | safari            | 8       | whitelist | OS X 10.10 |
+#       | internet explorer | 11      | whitelist | Windows 7  |
+#       | internet explorer | 10      | whitelist | Windows 7  |
+#       | internet explorer | 9       | whitelist | Windows 7  |

data/features/step_definitions/steps.rb

@@ -0,0 +1,46 @@
+Given(/^a (\w+) for no caching my web application$/) do |strategy|
+  @strategy = strategy
+  DataMapper.auto_upgrade!
+end
+
+Given(/^I am a (\w+) user$/) do |platform|
+  @platform = platform
+end
+
+Given(/^I open a '(.+)' (\w+)$/) do |browser_name, browser_version|
+  TestSettings.configure(browser_name: browser_name, version: browser_version,
+                         strategy: @strategy, platform: @platform)
+end
+
+Given(/^I visit the (\w+) page$/) do |page_name|
+  url = case page_name
+        when 'home' then '/index'
+        else
+          '/details'
+        end
+  visit url
+end
+
+Given(/^I store (\d) todo tasks in session$/) do |number|
+  div_xpath = "//div[@class='input-append']"
+  input_el = browser.find_element xpath: "#{div_xpath}/input"
+  add_btn_el = browser.find_element xpath: "//div[@class='input-append']/button"
+
+  number.to_i.times.each do |n|
+    input_el.send_keys("Task #{n}")
+    add_btn_el.click
+    wait_js_inactive
+  end
+end
+
+When(/^I click on (.*)$/) do |text|
+  browser.find_element(link_text: text).click
+end
+
+When(/^I press the (next|back) browser button$/) do |direction|
+  browser.navigate.send(direction)
+end
+
+Then(/^I see the (\d) todo tasks in todo list$/) do |number|
+  expect(browser.find_elements(xpath: '//ul/li').size).to eql(number.to_i)
+end

data/features/support/continous_integration.rb

@@ -0,0 +1,47 @@
+require 'capybara_selenium'
+require_relative 'coverage'
+
+Dir[File.join(__FILE__, '../../lib/**/*.rb')].each { |f| require f }
+
+# Helpers for continous integration
+module TestSettings
+  APP_SERVER_HOST = ENV['CI_APP_SERVER_HOST'] || '127.0.0.1'
+  APP_SERVER_PORT = ENV['CI_APP_SERVER_PORT'] || 8080
+  SELENIUM_SERVER_URL = ENV['CI_SELENIUM_SERVER_URL'] ||
+                        'http://127.0.0.1:4444/wd/hub'
+
+  class << self
+    # @param [Hash] opts The options for browser
+    # @option opts [String] :browser_name The name of the browser. Valid values:
+    #   firefox|chrome|internet explorer|safari|opera
+    # @option opts [Integer] :version The version of the browser
+    # @option opts [String] :strategy The strategy to configure the
+    #   Rack::NonCache middleware
+    def configure(opts = {})
+      CapybaraSelenium.configure do |config|
+        config.app_server.host = APP_SERVER_HOST
+        config.app_server.port = APP_SERVER_PORT.to_i + port_counter
+        config.app_server.config_ru_path = File.expand_path(File.join(
+          __FILE__, "../web_app/config_#{opts[:strategy] || :whitelist}.ru"))
+
+        config.selenium_server.server_url = SELENIUM_SERVER_URL
+        config.selenium_server.capabilities = {
+          'browser' => opts[:browser_name] || :firefox,
+          'browserName' => opts[:browser_name] || :firefox,
+          'version' => opts[:version] || 'ANY',
+          'tunnel-identifier' => ENV['TRAVIS_JOB_NUMBER'],
+          'build' => ENV['TRAVIS_BUILD_NUMBER']
+        }
+      end
+    end
+
+    def port_counter
+      @port_counter ||= 0
+      @port_counter += 1
+    end
+  end
+end
+
+TestSettings.configure
+
+World(TestSettings)

data/features/support/coverage.rb

@@ -0,0 +1,18 @@
+if ENV['TRAVIS']
+  require 'codeclimate-test-reporter'
+  require 'simplecov'
+  require 'coveralls'
+  Coveralls.wear!
+
+  formatters = [SimpleCov::Formatter::HTMLFormatter]
+  formatters << Coveralls::SimpleCov::Formatter
+  if ENV['CODECLIMATE_REPO_TOKEN']
+    formatters << CodeClimate::TestReporter::Formatter
+  end
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
+  SimpleCov.start do
+    add_filter '/features/'
+    add_group 'Libraries', 'lib'
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+require 'capybara'
+require 'capybara/cucumber'
+require 'selenium-webdriver'
+
+Before do
+  DataMapper.auto_migrate!
+end
+
+World(Capybara)

data/features/support/helpers.rb

@@ -0,0 +1,13 @@
+module CucumberHelpers
+  def browser
+    page.driver.browser
+  end
+
+  def wait_js_inactive
+    Selenium::WebDriver::Wait.new.until do
+      browser.execute_script('return jQuery.active') == 0
+    end
+  end
+end
+
+World(CucumberHelpers)

data/features/support/web_app/application.rb

@@ -0,0 +1,70 @@
+require 'sinatra/base'
+require 'sinatra/json'
+require 'data_mapper'
+
+# If you want the logs displayed you have to do this before the call to setup
+DataMapper::Logger.new($stdout, :warn)
+
+# A Sqlite3 connection:
+DataMapper.setup(:default, 'sqlite:data.db')
+
+class Todo
+  include DataMapper::Resource
+
+  property :id,         Serial
+  property :text,       Text
+  # property :created_at, DateTime, :default => lambda { |r,p| Time.now }
+  property :done,       Boolean, default: false
+end
+
+DataMapper.finalize
+DataMapper.auto_upgrade!
+
+# Rack application to work with RackNonCache middleware
+class DummyApp < Sinatra::Base
+  helpers Sinatra::JSON
+  helpers do
+    def json_data
+      JSON.parse request.body.read
+    end
+  end
+
+  before '/todos*' do
+    content_type 'application/json'
+  end
+
+  get '/index' do
+    @todos = Todo.all
+    erb :index
+  end
+
+  get '/details' do
+    erb :details
+  end
+
+  get '/todos' do
+    session[:todos].t
+    Todo.all.to_json
+  end
+
+  get '/todos/:id' do
+    todo = Todo.get(params[:id])
+    todo.to_json
+  end
+
+  put '/todos/:id' do
+    todo = Todo.get(params[:id])
+    todo.update(json_data)
+    todo.to_json
+  end
+
+  post '/todos' do
+    todo = Todo.create(json_data)
+    todo.to_json
+  end
+
+  delete '/todos/:id' do
+    todo = Todo.get(params[:id])
+    todo.destroy
+  end
+end

data/features/support/web_app/config_blacklist.ru

@@ -0,0 +1,13 @@
+require 'rack'
+
+require_relative 'application'
+require_relative '../../../lib/rack/noncache'
+
+app = Rack::Builder.new do
+  use Rack::NonCache, blacklist: []
+  map '/' do
+    run DummyApp
+  end
+end
+
+run app

data/features/support/web_app/config_whitelist.ru

@@ -0,0 +1,13 @@
+require 'rack'
+
+require_relative 'application'
+require_relative '../../../lib/rack/noncache'
+
+app = Rack::Builder.new do
+  use Rack::NonCache, whitelist: [Regexp.new(/index|details$/)]
+  map '/' do
+    run DummyApp
+  end
+end
+
+run app