rack-timetraveler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cdf12fd5a721f577239b323c8343225e44ab06f
+  data.tar.gz: b7533e551ef358d4f58fbbddee663d35efc59932
+SHA512:
+  metadata.gz: f062f8d175666f4cb83fecb5ea5379d95a1bb138db0aa4adcaffedde4d153eb2e8b7924dae5c2271c31ecd49175e2527822bb764e5667aabfb5b73bee1807c5d
+  data.tar.gz: 06819ddd27cc5580af9fedb97231d0d16dfed4c3d1b3bc32ecc2ca51b64c76f04cdf186c15020aa88862aae7a37b1aaca7f280301054b8a6f946be6dfc5720e4

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,24 @@
+*.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
+
+/vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+  - 2.3.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 luckypool
+
+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,62 @@
+# Rack::TimeTraveler
+
+[![Build Status](https://travis-ci.org/luckypool/rack-timetraveler.svg?branch=master)](https://travis-ci.org/luckypool/rack-timetraveler)
+[![Coverage Status](https://coveralls.io/repos/github/luckypool/rack-timetraveler/badge.svg?branch=master)](https://coveralls.io/github/luckypool/rack-timetraveler?branch=master)
+[![Dependency Status](https://gemnasium.com/luckypool/rack-timetraveler.svg)](https://gemnasium.com/luckypool/rack-timetraveler)
+
+
+Rack::TimeTraveler is a Rack::Middleware, and provides "time travel" capabilities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-timetraveler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-timetraveler
+
+## Usage
+
+Simple usage 
+
+```ruby
+use Rack::TimeTraveler
+```
+
+If you needs customized usage
+
+```ruby
+@fetcher = lambda do |env|
+  # You can fetch customized timestamp.
+  # Default is fetch from ENV['RACK_TIME_TRAVELER_TIMESTAMP']
+  0
+end
+
+use Rack::TimeTraveler,
+  timestamp_fetcher: @fetcher,          # You can also fetch from cache/DB
+  enabled_environments: [:development]  # enabled only development
+```
+
+#### Examples
+
+See [examples/app_1.ru](./examples/app_1.ru)
+
+    $ bundle exec rackup examples/app_1.ru
+    $ curl localhost:9292
+    $ curl localhost:9292 -H 'RACK_TIME_TRAVELER_TIMESTAMP:0'
+    Time is 1970-01-01 09:00:00 +0900
+
+
+## Contributing
+
+1. Fork it ( https://github.com/luckypool/rack-timetraveler/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,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/examples/app_1.ru

@@ -0,0 +1,20 @@
+$:.unshift Pathname(__FILE__).dirname.parent + 'lib'
+
+require 'rack'
+require 'rack-timetraveler'
+
+class App
+  def call(env)
+    [200, {'Content-Type' => 'text/plain'}, ["Time is #{Time.now.to_s}"]]
+  end
+end
+
+use Rack::TimeTraveler
+run App.new
+
+# Check below:
+#
+# $ bundle exec rackup examples/app_1.ru
+#
+# $ curl localhost:9292
+# $ curl localhost:9292 -H 'RACK_TIME_TRAVELER_TIMESTAMP:0'

data/examples/app_2.ru

@@ -0,0 +1,22 @@
+$:.unshift Pathname(__FILE__).dirname.parent + 'lib'
+
+require 'rack'
+require 'rack-timetraveler'
+
+class App
+  def call(env)
+    [200, {'Content-Type' => 'text/plain'}, ["Time is #{Time.now.to_s}"]]
+  end
+end
+
+@fetcher = lambda do |env|
+  # You can fetch customized timestamp.
+  # Default is fetch from ENV['RACK_TIME_TRAVELER_TIMESTAMP']
+  0
+end
+
+use Rack::TimeTraveler,
+  timestamp_fetcher: @fetcher,
+  enabled_environments: [:development]
+
+run App.new

data/lib/rack-timetraveler.rb

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

data/lib/rack/timetraveler.rb

@@ -0,0 +1,49 @@
+require 'rack'
+require 'timecop'
+
+class Rack::TimeTraveler
+  attr_reader :app, :options
+
+  def initialize(app, options = {})
+    @app, @options = app, options
+
+    default_fetcher = lambda { |env| fetch_from_env(env) }
+    @options[:timestamp_fetcher] ||= default_fetcher
+
+    @options[:enabled_environments] ||= [:development, :test]
+  end
+
+  def call(env)
+    return @app.call(env) unless enabled?
+
+    time = validate_timestamp(env)
+
+    return @app.call(env) if time.nil?
+
+    Timecop.travel(time) { @app.call(env) }
+  end
+
+  private
+
+  def enabled?
+    @options[:enabled_environments].map(&:to_s).include?(ENV['RACK_ENV'])
+  end
+
+  def validate_timestamp(env)
+    timestamp = fetch_timestamp(env)
+    return if timestamp.nil?
+    Time.at(Integer(timestamp))
+  rescue
+    nil
+  end
+
+  def fetch_timestamp(env)
+    fetcher = @options[:timestamp_fetcher]
+    fetcher.call(env)
+  end
+
+  def fetch_from_env(env)
+    env['HTTP_RACK_TIME_TRAVELER_TIMESTAMP'] ||
+      env['RACK_TIME_TRAVELER_TIMESTAMP']
+  end
+end

data/rack-timetraveler.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-timetraveler'
+  spec.version       = '0.0.1'
+  spec.authors       = ['luckypool']
+  spec.email         = ['luckypool314@gmail.com']
+  spec.description   = 'You can be a Time Traveler.'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/luckypool/rack-timetraveler'
+  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_runtime_dependency 'timecop', '~> 0.8.0'
+  spec.add_runtime_dependency 'rack'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '~>3.3'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/rack/timetraveler_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Rack::TimeTraveler do
+  def build_app(options = {})
+    Rack::Builder.new {
+      use Rack::TimeTraveler, options
+      run lambda {|env| [200, {}, ["Time is #{Time.now.to_i}"]]}
+    }.to_app
+  end
+
+  def app
+    build_app
+  end
+
+  context 'when using default fetcer (using HEADER)' do
+    let(:timestamp) { 0 }
+    it 'travels to the epocktime' do
+      get '/', {}, 'RACK_TIME_TRAVELER_TIMESTAMP' => timestamp
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq "Time is #{timestamp}"
+    end
+
+    context 'given invalid timestamp' do
+      let(:timestamp) { 'invalid' }
+      it 'travels to the epocktime' do
+        get '/', {}, 'RACK_TIME_TRAVELER_TIMESTAMP' => timestamp
+        expect(last_response.status).to eq 200
+        expect(last_response.body).to eq "Time is #{Time.now.to_i}"
+      end
+    end
+  end
+
+
+  context 'when disabled traveling' do
+    def app
+      build_app(enabled_environments: [:not_test])
+    end
+
+    it 'travels to the epocktime' do
+      get '/', {}, 'RACK_TIME_TRAVELER_TIMESTAMP' => 0
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq "Time is #{Time.now.to_i}"
+    end
+  end
+
+  context 'when using custom fetcher' do
+    def app
+      fetcher = lambda { |env| 0 }
+      build_app(timestamp_fetcher: fetcher)
+    end
+
+    let(:timestamp) { 0 }
+    it 'travels to the epocktime' do
+      get '/'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq "Time is #{timestamp}"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rack/test'
+require 'rspec'
+
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+    add_filter '.bundle/'
+    add_filter 'vendor'
+end
+
+require 'rack/timetraveler'
+
+RSpec.configure do |conf|
+  ENV['RACK_ENV'] ||= 'test'
+  conf.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: rack-timetraveler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- luckypool
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: pry-byebug
+  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: rack-test
+  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: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: simplecov
+  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: You can be a Time Traveler.
+email:
+- luckypool314@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/app_1.ru
+- examples/app_2.ru
+- lib/rack-timetraveler.rb
+- lib/rack/timetraveler.rb
+- rack-timetraveler.gemspec
+- spec/rack/timetraveler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/luckypool/rack-timetraveler
+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.5
+signing_key: 
+specification_version: 4
+summary: You can be a Time Traveler.
+test_files:
+- spec/rack/timetraveler_spec.rb
+- spec/spec_helper.rb