rack-a_day_without 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjIxNDM3NmRjZDI3Yjc0ZDc1ZDJjZDAyMWFhMzE5OWYxN2ZiZTFhOA==
+  data.tar.gz: !binary |-
+    ZjNjMWM0ZjI1ZDhhNmEyMTc5NDg1YzA1Njc4MjE2OTY1NWE3ZDNjZA==
+SHA512:
+  metadata.gz: !binary |-
+    N2Q4ZDkyZDA4OWJhZmI2OGMxM2RhYzc3MTMyMDVmN2FiNDU5Zjg3NmU2NWQz
+    ZTM0ZGY2NDQzZGRmY2M4YzZmZTc4MzE3ODBjOTI5YjBhMjMwOTM3ZTM5Yjk2
+    NTdlYTJiNjJkNDQyOWQ3Y2M1OTgxYzljN2JmMDc4ZmY3ZDcwOWU=
+  data.tar.gz: !binary |-
+    NTBlYzQzMjJlNmZkYTAzYjZlZjk2MjZlNTkwM2JkOGVlNjJjMDRkNTAwMTBj
+    ODhkNTUzNmE4MTUwOGZjNTczNzJiZmQ4ZjRiMGY2OGNmNjUxOGFlMGE5Njhk
+    YWNjMmNhOGViOTE3ODM1MmM0ZmQxNzBkZmM2YTdmMThmMzhhZGI=

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in a_day_without.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jack Jennings
+
+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,72 @@
+# Rack::ADayWithout
+
+`Rack::ADayWithout` is a middleware for Rack-based web applications, originally built to display alternate content for the [Day Without Art](https://en.wikipedia.org/wiki/Day_Without_Art).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-a_day_without', require: 'rack/a_day_without'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-a_day_without
+
+## Usage
+
+Use `Rack::ADayWithout` as a middleware in your Rack (or Rails) application. The `on` option must be set to the date the site should serve the alternate content.
+
+```ruby
+use Rack::ADayWithout, 'Art', on: '1/12/2014'
+```
+
+You can also use the alternate syntax which uses child-classes to set the `subject` of ADayWithout. This is equivalent to the above example:
+
+```ruby
+use Rack::ADayWithout::Art, on: '1/12/2014'
+```
+
+### Writing Content
+
+By default, the middleware will write an empty content string for all requests on the specified day. If the `content` or `file` options are set, the content string or file contents will be written instead.
+
+```ruby
+use Rack::ADayWithout, 'Art', on: '1/12/2014', content: 'A Day Without Art'
+# or...
+use Rack::ADayWithout, 'Art', on: '1/12/2014', file: './public/index.html'
+```
+
+### Bypass Routes
+
+The `bypass` option allows some routes to pass through the middleware without being blocked. This can be useful if you have an admin area that should still be available during the day without. `bypass` can be set to be a `String`, a `Regexp` or an `Array` of either.
+
+```ruby
+use Rack::ADayWithout, 'Art', on: '1/12/2014',
+  bypass: [/^\/admin/, '/about']
+```
+
+## With Rails
+
+Load the rack middleware inside of `config/application.rb`:
+
+```ruby
+module YourApp
+  class Application < Rails::Application
+    # ...
+
+    config.middleware.use Rack::ADayWithout, 'Art', on: '22/11/2014'
+  end
+end
+```
+
+## Contributing
+
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task :default => :test

data/lib/rack/a_day_without/version.rb

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

data/lib/rack/a_day_without.rb

@@ -0,0 +1,73 @@
+require "date"
+require "rack"
+require "rack/a_day_without/version"
+
+module Rack
+  class ADayWithout
+
+    def self.const_missing const_name
+      const_set const_name, self.new_subject_subclass
+    end
+
+    def self.new_subject_subclass
+      Class.new(self) do
+        def initialize app, options = {}
+          subject = self.class.name.split('::').last
+          super app, subject, options
+        end
+      end
+    end
+
+    def initialize app, subject, options = {}
+      @app = app
+      @subject = subject
+      @content = options[:content]
+      @file = options[:file]
+      @date = parse_date options[:on]
+      @allowed = parse_allowed_routes options[:bypass]
+    end
+
+    def call env
+      allowed = allowed_path? env['PATH_INFO']
+      if @date == Date.today && !allowed
+        res = Response.new
+        res["X-Day-Without"] = @subject
+        res.write content
+        res.finish
+      else
+        @app.call env
+      end
+    end
+
+    private
+
+    def content
+      if @file
+        ::File.read @file
+      else
+        @content.to_s
+      end
+    end
+
+    def parse_allowed_routes allowed
+      if allowed.nil?
+        []
+      elsif allowed.respond_to? :to_ary
+        allowed.to_ary || [allowed]
+      else
+        [allowed]
+      end
+    end
+
+    def parse_date dateish
+      Date.parse dateish.to_s
+    end
+
+    def allowed_path? path
+      @allowed.any? do |a|
+        a.is_a?(Regexp) ? a.match(path.to_s) : a == path.to_s
+      end
+    end
+
+  end
+end

data/rack-a_day_without.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/a_day_without/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-a_day_without"
+  spec.version       = Rack::ADayWithout::VERSION
+  spec.authors       = ["Jack Jennings"]
+  spec.email         = ["j@ckjennin.gs"]
+  spec.summary       = %q{Rack middleware for serving alternate content on a given day}
+  spec.homepage      = "http://github.com/jackjennings/rack-a_day_without"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "rack", "~> 1.4"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "minitest", "~> 5.4"
+end

data/test/fixtures/index.html

@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html><head></head><body>Hi!</body></html>

data/test/minitest_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rack/a_day_without'
+
+require 'minitest'
+require 'minitest/autorun'

data/test/test_rack_a_day_without.rb

@@ -0,0 +1,140 @@
+require 'minitest_helper'
+
+describe Rack::ADayWithout do
+
+  it 'must have a version number' do
+    Rack::ADayWithout::VERSION.wont_be_nil
+  end
+
+  describe 'when used as middleware' do
+    before do
+      @app = Proc.new do
+        Rack::Response.new {|r| r.write 'Downstream app'}.finish
+      end
+    end
+
+    it 'blocks a request' do
+      endpoint = Rack::ADayWithout.new @app, 'Art', on: Date.today
+      status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar'))
+      status.must_equal 200
+      body.body.must_equal ['']
+    end
+
+    it 'passes a request' do
+      endpoint = Rack::ADayWithout.new @app, 'Art', on: Date.new
+      status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar'))
+      status.must_equal 200
+      body.body.must_equal ['Downstream app']
+    end
+
+    it 'blocks with supplied content' do
+      endpoint = Rack::ADayWithout.new @app, 'Art',
+                                       on: Date.today,
+                                       content: 'foobar'
+      status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar'))
+      status.must_equal 200
+      body.body.must_equal ['foobar']
+    end
+
+    it 'blocks with supplied file' do
+      path = 'test/fixtures/index.html'
+      content = File.read(path)
+      endpoint = Rack::ADayWithout.new @app, 'Art',
+                                       on: Date.today,
+                                       file: path
+      status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar'))
+      status.must_equal 200
+      body.body.must_equal [content]
+    end
+
+    it 'passes allowed routes' do
+      endpoint = Rack::ADayWithout.new @app, 'Art',
+                                       on: Date.today,
+                                       bypass: '/bar'
+      status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar'))
+      status.must_equal 200
+      body.body.must_equal ['Downstream app']
+    end
+
+    it 'blocks sub-path of allowed routes' do
+      endpoint = Rack::ADayWithout.new @app, 'Art',
+                                       on: Date.today,
+                                       bypass: '/bar'
+      status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar/bar'))
+      status.must_equal 200
+      body.body.must_equal ['']
+    end
+
+    it 'passes allowed routes as regexp' do
+      endpoint = Rack::ADayWithout.new @app, 'Art',
+                                       on: Date.today,
+                                       bypass: %r{^/bar}
+      status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar/baz'))
+      status.must_equal 200
+      body.body.must_equal ['Downstream app']
+    end
+
+    it 'passes allowed routes as array' do
+      endpoint = Rack::ADayWithout.new @app, 'Art',
+                                       on: Date.today,
+                                       bypass: ['/bar', '/baz']
+      status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar'))
+      status.must_equal 200
+      body.body.must_equal ['Downstream app']
+    end
+
+    it 'passes allowed routes as array with regexps' do
+      endpoint = Rack::ADayWithout.new @app, 'Art',
+                                       on: Date.today,
+                                       bypass: [%r{^/bar}, '/baz']
+      status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar/baz'))
+      status.must_equal 200
+      body.body.must_equal ['Downstream app']
+    end
+
+    it 'sets HTTP header when blocked' do
+      endpoint = Rack::ADayWithout.new @app, 'Art',
+                                       on: Date.today
+      status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar'))
+      headers['X-Day-Without'].must_equal 'Art'
+    end
+  end
+
+  describe 'when initialized' do
+    it 'parses a date' do
+      date = '20/10/2014'
+      endpoint = Rack::ADayWithout.new @app, 'Art', on: date
+      endpoint.instance_variable_get('@date').must_equal Date.parse(date)
+    end
+
+    it 'parses a date' do
+      date = '20/10/2014'
+      endpoint = Rack::ADayWithout.new @app, 'Art', on: date
+      endpoint.instance_variable_get('@date').must_equal Date.parse(date)
+    end
+
+    it 'stores a subject' do
+      endpoint = Rack::ADayWithout.new @app, 'Art', on: Date.new
+      endpoint.instance_variable_get('@subject').must_equal 'Art'
+    end
+
+    it 'stores allowed routes in array' do
+      endpoint = Rack::ADayWithout.new @app, 'Art', on: Date.new, bypass: 'foo'
+      endpoint.instance_variable_get('@allowed').must_equal ['foo']
+    end
+  end
+
+  describe 'when dynamically subclassed' do
+    it 'creates a subclass' do
+      endpoint = Rack::ADayWithout::Art
+      endpoint.name.must_equal "Rack::ADayWithout::Art"
+      endpoint.ancestors.must_include Rack::ADayWithout
+    end
+
+    it 'store subject by name' do
+      endpoint = Rack::ADayWithout::Art.new @app, on: Date.today
+      endpoint.instance_variable_get('@subject').must_equal 'Art'
+    end
+  end
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rack-a_day_without
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jack Jennings
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.4'
+description: 
+email:
+- j@ckjennin.gs
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/a_day_without.rb
+- lib/rack/a_day_without/version.rb
+- rack-a_day_without.gemspec
+- test/fixtures/index.html
+- test/minitest_helper.rb
+- test/test_rack_a_day_without.rb
+homepage: http://github.com/jackjennings/rack-a_day_without
+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.4.4
+signing_key: 
+specification_version: 4
+summary: Rack middleware for serving alternate content on a given day
+test_files:
+- test/fixtures/index.html
+- test/minitest_helper.rb
+- test/test_rack_a_day_without.rb