rack-a_day_without 0.0.1 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjIxNDM3NmRjZDI3Yjc0ZDc1ZDJjZDAyMWFhMzE5OWYxN2ZiZTFhOA==
+    OWQ0MTVhOTE2NzM3YTFhMTExYTM0YWE2Njg5MjI0ODc2MDdkYWU1Nw==
   data.tar.gz: !binary |-
-    ZjNjMWM0ZjI1ZDhhNmEyMTc5NDg1YzA1Njc4MjE2OTY1NWE3ZDNjZA==
+    NzNhOTA3OWY4MmQ4NDVmMmIzYzNjYTJhOTE0ZWZlMTkyNzk2YTc1NA==
 SHA512:
   metadata.gz: !binary |-
-    N2Q4ZDkyZDA4OWJhZmI2OGMxM2RhYzc3MTMyMDVmN2FiNDU5Zjg3NmU2NWQz
-    ZTM0ZGY2NDQzZGRmY2M4YzZmZTc4MzE3ODBjOTI5YjBhMjMwOTM3ZTM5Yjk2
-    NTdlYTJiNjJkNDQyOWQ3Y2M1OTgxYzljN2JmMDc4ZmY3ZDcwOWU=
+    NzU3OTA3NDgyM2Q3NTc1YzIwNjY4OTY4OWQ4NTI2YWVhNDUyMGRlNDQ0YzYw
+    YTZjYzU1Y2Y0ZDNkNDc4OTlmMTRjYmU5YmRhYjFmNzA2M2ZhMWQzNjEzYjI4
+    Nzc1ZjVmOTEyYjVmY2ZlNDhjYjc0ZjUwY2RjMGQzNDgyOWQwYTI=
   data.tar.gz: !binary |-
-    NTBlYzQzMjJlNmZkYTAzYjZlZjk2MjZlNTkwM2JkOGVlNjJjMDRkNTAwMTBj
-    ODhkNTUzNmE4MTUwOGZjNTczNzJiZmQ4ZjRiMGY2OGNmNjUxOGFlMGE5Njhk
-    YWNjMmNhOGViOTE3ODM1MmM0ZmQxNzBkZmM2YTdmMThmMzhhZGI=
+    NjU4Y2U4NDJlMDhkMzlkMDBkNWUyZTM1NzljYTZmNWZjZDdmNWRjNDlmZjJl
+    MjgwZDU2M2NiZGRjODMyZmRjYTM3NjA3NzMxODQ5MDFjMjgwN2YyOGVhZmVj
+    NThhMGU5ZjYzOTQ4MmFkZDIxNjY0ZjU4NTZjNGIzZTk0YTc5ZTE=

data/.travis.yml

@@ -1,3 +1,4 @@
 language: ruby
 rvm:
+  - 2.1.2
   - 1.9.3

data/README.md

@@ -1,6 +1,9 @@
 # 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).
+[![Build Status](https://travis-ci.org/jackjennings/rack-a_day_without.svg)](https://travis-ci.org/jackjennings/rack-a_day_without)
+[![Gem Version](https://badge.fury.io/rb/rack-a_day_without.svg)](http://badge.fury.io/rb/rack-a_day_without)
+
+`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). All requests on a given day will be served blank or alternate content.
 
 ## Installation
 
@@ -18,26 +21,42 @@ Or install it yourself as:
 
 ## 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.
+Use `Rack::ADayWithout` as a middleware in your Rack (or Rails) application. The first parameter defines the `subject` of ADayWithout. The `on` option must be set to the date the middleware should inject the alternate content. `on` should be either a string that can be parsed by `Date.parse` or an instance of `Date`.
 
 ```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:
+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'
 ```
 
+The child class is generated dynamically, and doesn't need to be defined beforehand. Thus the following are all valid:
+
+```ruby
+use Rack::ADayWithout::War, on: '1/1/2100'
+use Rack::ADayWithout::Pizza, on: '1/2/3456'
+use Rack::ADayWithout::Foo, on: '15/7/2020'
+```
+
+### Setting Timezone
+
+By default `ADayWithout` will use GMT dates. You can set the `timezone` option for the middleware to use a different timezone that `tzinfo` knows about.
+
+```ruby
+use Rack::ADayWithout::Art, on: '1/12/2014', timezone: 'America/New_York'
+```
+
 ### 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'
+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'
+use Rack::ADayWithout::Art, on: '1/12/2014', file: './public/index.html'
 ```
 
 ### Bypass Routes
@@ -45,7 +64,7 @@ use Rack::ADayWithout, 'Art', on: '1/12/2014', file: './public/index.html'
 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',
+use Rack::ADayWithout::Art, on: '1/12/2014',
   bypass: [/^\/admin/, '/about']
 ```
 
@@ -58,7 +77,7 @@ module YourApp
   class Application < Rails::Application
     # ...
 
-    config.middleware.use Rack::ADayWithout, 'Art', on: '22/11/2014'
+    config.middleware.use Rack::ADayWithout::Art, on: '22/11/2014'
   end
 end
 ```

data/lib/rack/a_day_without.rb

@@ -1,10 +1,14 @@
 require "date"
+require "tzinfo"
+require "uri"
 require "rack"
 require "rack/a_day_without/version"
 
 module Rack
   class ADayWithout
 
+    attr_accessor :subject
+
     def self.const_missing const_name
       const_set const_name, self.new_subject_subclass
     end
@@ -21,34 +25,103 @@ module Rack
     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]
+      @options = {
+        timezone: 'GMT',
+        disabled_on: false
+      }.merge options
     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
+      request = Request.new env
+
+      return @app.call env unless request.get? && !request.xhr?
+
+      if disabling_query? request
+        disable! request
+        @app.call env
+      elsif !disabled?(request) && date == today && !allowed?(request)
+        block request
       else
         @app.call env
       end
     end
 
-    private
+    def timezone
+      @timezone ||= parse_timezone @options[:timezone]
+    end
+
+    def date
+      @date ||= parse_date @options[:on]
+    end
+
+    def allowed_paths
+      @allowed ||= parse_allowed_routes @options[:bypass]
+    end
+
+    def today
+      timezone.now.to_date
+    end
 
     def content
-      if @file
-        ::File.read @file
+      if @options[:file]
+        ::File.read @options[:file]
+      else
+        @options[:content].to_s
+      end
+    end
+
+    def allowed? request
+      allowed_path? request.path_info
+    end
+
+    def allowed_path? path
+      allowed_paths.any? do |a|
+        a.is_a?(Regexp) ? a.match(path.to_s) : a == path.to_s
+      end
+    end
+
+    def disabling_query? request
+      key = @options[:disabled_on]
+      key != false && request.params.keys.include?(key)
+    end
+
+    def disable! request
+      if defined?(ActionDispatch::Request)
+        request = ActionDispatch::Request.new(request.env)
+        request.cookie_jar[:day_with] = { value: true, path: '/' }
+      end
+    end
+
+    def disabled? request
+      if defined?(ActionDispatch::Request)
+        request = ActionDispatch::Request.new(request.env)
+        request.cookie_jar[:day_with] || false
       else
-        @content.to_s
+        false
       end
     end
 
+    private
+
+    def redirect request
+      params = request.params
+      params.delete @options[:disabled_on]
+      query = URI.encode params.map {|k,v| "#{k}=#{v}"}.join("&")
+      location = [request.scheme, '://', request.host, request.path].join
+      location << "?#{query}" unless query.empty?
+
+      Response.new do |r|
+        r.redirect location
+      end.finish
+    end
+
+    def block request
+      Response.new do |r|
+        r["X-Day-Without"] = subject
+        r.write content
+      end.finish
+    end
+
     def parse_allowed_routes allowed
       if allowed.nil?
         []
@@ -63,10 +136,8 @@ module Rack
       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
+    def parse_timezone timezone
+      TZInfo::Timezone.get timezone
     end
 
   end

data/lib/rack/a_day_without/version.rb

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

data/rack-a_day_without.gemspec

@@ -18,8 +18,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rack", "~> 1.4"
+  spec.add_dependency "tzinfo", ">= 0.3.29"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 0"
   spec.add_development_dependency "minitest", "~> 5.4"
+  spec.add_development_dependency "actionpack", "~> 4"
 end

data/test/minitest_helper.rb

@@ -3,3 +3,15 @@ require 'rack/a_day_without'
 
 require 'minitest'
 require 'minitest/autorun'
+
+def today timezone = 'GMT'
+  timezone(timezone).now.to_date
+end
+
+def tomorrow timezone = 'GMT'
+  timezone(timezone).now.to_date + 1
+end
+
+def timezone name
+  TZInfo::Timezone.get name
+end

data/test/test_rack_a_day_without.rb

@@ -1,4 +1,23 @@
 require 'minitest_helper'
+require 'uri'
+require 'action_dispatch'
+
+TWENTY_FOUR_HOURS = (60 * 60 * 24)
+
+def create_app options = {}
+  downstream = Proc.new do
+    Rack::Response.new do |r|
+      r.write 'Downstream app'
+    end.finish
+  end
+
+  Rack::Builder.new do
+    use ActionDispatch::Cookies
+    use ActionDispatch::Session::CookieStore, key: '_test_session'
+    use Rack::ADayWithout, 'Art', options
+    run downstream
+  end
+end
 
 describe Rack::ADayWithout do
 
@@ -9,28 +28,28 @@ describe Rack::ADayWithout do
   describe 'when used as middleware' do
     before do
       @app = Proc.new do
-        Rack::Response.new {|r| r.write 'Downstream app'}.finish
+        Rack::Response.new do |r|
+          r.write 'Downstream app'
+        end.finish
       end
     end
 
     it 'blocks a request' do
-      endpoint = Rack::ADayWithout.new @app, 'Art', on: Date.today
+      endpoint = create_app on: 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
+      endpoint = create_app on: tomorrow
       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'
+      endpoint = create_app on: today, content: 'foobar'
       status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar'))
       status.must_equal 200
       body.body.must_equal ['foobar']
@@ -39,88 +58,127 @@ describe Rack::ADayWithout do
     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
+      endpoint = create_app on: 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'
+      endpoint = create_app on: 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'
+      endpoint = create_app on: 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}
+      endpoint = create_app on: 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']
+      endpoint = create_app on: 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']
+      endpoint = create_app on: 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
+      endpoint = create_app on: today
       status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar'))
       headers['X-Day-Without'].must_equal 'Art'
     end
+    
+    describe 'when sent a diabling request' do
+      it 'should show' do
+        endpoint = create_app on: today, disabled_on: 'day_with'
+        status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar?day_with'))
+        body.body.must_equal ['Downstream app']
+      end
+
+      it 'should redirect with other params' do
+        endpoint = create_app on: today, disabled_on: 'day_with'
+        status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar?day_with&foobar=true'))
+        body.body.must_equal ['Downstream app']
+      end
+
+      ## TODO: Not sure how to make this test pass...
+      # it 'should display regular content in subsequent requests' do
+      #   endpoint = create_app on: today, disabled_on: 'day_with'
+      #   endpoint.call(Rack::MockRequest.env_for('/bar?day_with'))
+      #   status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar'))
+      #   body.body.must_equal ['Downstream app']
+      # end
+
+      it 'should disable when set to false' do
+        endpoint = create_app on: today, disabled_on: false
+        status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar?day_with'))
+        status.must_equal 200
+        body.body.must_equal ['']
+      end
+    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)
+      endpoint.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)
+      endpoint.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'
+      endpoint = Rack::ADayWithout.new @app, 'Art', on: tomorrow
+      endpoint.subject.must_equal 'Art'
+    end
+
+    it 'stores a default timezone' do
+      endpoint = Rack::ADayWithout.new @app, 'Art', on: today
+      endpoint.timezone.name.must_equal 'GMT'
+    end
+
+    it 'stores a timezone' do
+      tz = 'America/New_York'
+      endpoint = Rack::ADayWithout.new @app, 'Art', on: today, timezone: tz
+      endpoint.timezone.name.must_equal tz
     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']
+      endpoint = Rack::ADayWithout.new @app, 'Art', on: tomorrow, bypass: 'foo'
+      endpoint.allowed_paths.must_equal ['foo']
+    end
+
+    it 'obeys timezones' do
+      now = timezone('America/New_York').now
+      midnight = now + TWENTY_FOUR_HOURS - now.to_i % TWENTY_FOUR_HOURS + 10
+      frozen_today = midnight.to_date
+      Time.stub :now, midnight do
+        endpoint = Rack::ADayWithout.new @app, 'Art',
+          on: frozen_today,
+          timezone: 'America/Los_Angeles'
+        endpoint.today.wont_equal endpoint.date
+      end
     end
   end
 
@@ -132,8 +190,8 @@ describe Rack::ADayWithout do
     end
 
     it 'store subject by name' do
-      endpoint = Rack::ADayWithout::Art.new @app, on: Date.today
-      endpoint.instance_variable_get('@subject').must_equal 'Art'
+      endpoint = Rack::ADayWithout::Art.new @app, on: today
+      endpoint.subject.must_equal 'Art'
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-a_day_without
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Jack Jennings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
+date: 2014-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.29
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.29
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
 description: 
 email:
 - j@ckjennin.gs