rack-time-zone-header 0.1.1

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*.gemspec
+*.log
+*.pid
+*.sqlite3
+*.tmproj
+.DS_Store
+log/*
+pkg/*

data/HISTORY.rdoc

@@ -0,0 +1,3 @@
+=== Version 0.1.1 2010-07-178
+
+Initial release of Rack::TimeZoneHeader middleware.

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright © 2010 Square, Inc.
+
+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,21 @@
+= Rack::TimeZoneHeader
+
+Rack middleware for parsing IETF draft {Time-Zone}[http://tools.ietf.org/html/draft-sharhalakis-httptz-05] HTTP headers.
+
+== Prerequisites
+
+* {Rack}[http://rack.rubyforge.org/]
+
+== Testing
+
+Testing requires the RSpec gem:
+
+* {Rspec}[http://rspec.info/]
+
+To test, run:
+  `rake`
+
+== License
+
+Copyright © 2010 Square, Inc.
+See LICENSE.txt in this directory.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+require File.join(File.dirname(__FILE__), 'lib', 'rack', 'time_zone_header', 'version')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.version = Rack::TimeZoneHeader::VERSION::STRING
+    gemspec.name = "rack-time-zone-header"
+    gemspec.summary = "Rack middleware for Time-Zone HTTP headers"
+    gemspec.description = "Allow web service clients to specify the request time zone in an HTTP header."
+    gemspec.email = "github@squareup.com"
+    gemspec.homepage = "http://github.com/square/rack-time-zone-header"
+    gemspec.authors = [
+      "Randy Reddig",
+      "Cameron Walters",
+    ]
+    gemspec.extra_rdoc_files = [
+      'README.rdoc',
+      'HISTORY.rdoc',
+      'LICENSE.txt',
+    ]
+    gemspec.add_dependency              "rack",         ">=1.0.0"
+    gemspec.add_dependency              "tzinfo",       ">=0.3.14"
+    gemspec.add_development_dependency  "rack-test",    ">=0.5.3"
+    gemspec.add_development_dependency  "rspec",        ">=1.3.0"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["--options", "spec/spec.opts"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+  t.rcov = ENV["RCOV"]
+  t.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/}
+  t.verbose = true
+end
+
+task :spec => :check_dependencies
+task :default => :spec
+
+desc "Remove trailing whitespace"
+task :whitespace do
+  sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
+end

data/lib/rack-time-zone-header.rb

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

data/lib/rack/time_zone_header.rb

@@ -0,0 +1,20 @@
+require 'rack/time_zone_header/version'
+require 'tzinfo'
+
+# Code to parse headers in this format:
+# http://tools.ietf.org/html/draft-sharhalakis-httptz-05
+
+module Rack
+  class TimeZoneHeader
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      header = env["HTTP_TIME_ZONE"] || env["HTTP_X_TIME_ZONE"] || env["HTTP_TIMEZONE"]
+      zone = TZInfo::Timezone.get(header.split(";").last) rescue nil
+      env["time.zone"] = zone if zone
+      @app.call(env)
+    end
+  end
+end

data/lib/rack/time_zone_header/version.rb

@@ -0,0 +1,11 @@
+module Rack
+  class TimeZoneHeader
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 1
+      TINY  = 1
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

data/spec/rack/time_zone_header_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Rack::TimeZoneHeader do
+  before :each do
+    @app = lambda { |env| [200, {"Content-Type" => "text/plain"}, [""]] }
+  end
+
+  ["HTTP_TIME_ZONE", "HTTP_X_TIME_ZONE", "HTTP_TIMEZONE"].each do |header_name|
+    [
+      nil,
+      "",
+      ";;;",
+      "*",
+      "US/Mint_Plaza",
+      "PONIES",
+    ].each do |header_value|
+      describe "with invalid header #{header_name}: #{header_value}" do
+        before :each do
+          @request = Rack::MockRequest.env_for("/", header_name => header_value, :lint => true, :fatal => true)
+          @status, @headers, @response = described_class.new(@app).call(@request)
+        end
+
+        it "does not assign a TZInfo::Timezone instance to env['time.zone']" do
+          @request['time.zone'].should be_nil
+        end
+      end
+    end
+
+    [
+      "America/Los_Angeles",
+      "US/Pacific",
+      ";;US/Eastern",
+      "2010-05-13T16:00:05-7:00;;US/Pacific",
+      "2010-05-12T18:42:20+7:00;;Asia/Bangkok",
+      "2010-05-13T18:20:21-4:00;;US/Eastern",
+      "2010-05-13T19:17:59-3:00;;America/Sao_Paulo",
+    ].each do |header_value|
+      describe "with valid header #{header_name}: #{header_value}" do
+        before :each do
+          @request = Rack::MockRequest.env_for("/", header_name => header_value, :lint => true, :fatal => true)
+          @time_zone_name = header_value.split(";").last
+          @zime_zone = TZInfo::Timezone.get(@time_zone_name)
+          @status, @headers, @response = described_class.new(@app).call(@request)
+        end
+
+        it "assigns a TZInfo::Timezone instance to env['time.zone']" do
+          @request['time.zone'].should be_a_kind_of(TZInfo::Timezone)
+        end
+
+        it "the TZInfo::Timezone instance should reflect the header value" do
+          @request['time.zone'].should == @zime_zone
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'rack-time-zone-header'
+require 'spec/expectations'
+require 'rack/test'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: rack-time-zone-header
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Randy Reddig
+- Cameron Walters
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 3
+        - 14
+        version: 0.3.14
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id004
+description: Allow web service clients to specify the request time zone in an HTTP header.
+email: github@squareup.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- HISTORY.rdoc
+- LICENSE.txt
+- README.rdoc
+files: 
+- .gitignore
+- HISTORY.rdoc
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/rack-time-zone-header.rb
+- lib/rack/time_zone_header.rb
+- lib/rack/time_zone_header/version.rb
+- spec/rack/time_zone_header_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/square/rack-time-zone-header
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rack middleware for Time-Zone HTTP headers
+test_files: 
+- spec/rack/time_zone_header_spec.rb
+- spec/spec_helper.rb