rack-time-zone-middleware 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 099d747f1c77445c92b0d447489488ccefa0b555
+  data.tar.gz: cf95cf6124acee7e7b0477ade1aa68e2027c36cb
+SHA512:
+  metadata.gz: d9561629fac0db9087ac8a462371d78b8ffe8f40a536c16de5fdf6a0e5d5d1f9444d0020d97e5896e3a05cf38ad82073f057ed055780775fc852f4deaa8dad7b
+  data.tar.gz: b4ac0366e88457377c5ceb450423ceb61a69655c76570aa350c5857bcd62aa55b88f557089d96302f3dd04f117d7b1969d9bcb66471692a35e125540906ae3eb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+.ruby-version

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2.2
+  - 2.1.6
+  - jruby-9.0.0.0
+notifications:
+  email:
+    - api@mrcr.ru
+script:
+    - bundle exec rake
+sudo: false

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rack', '~> 1.6'
+gem 'activesupport', '~> 4.0'
+gem 'coveralls', require: false

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexander Merkulov
+
+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,107 @@
+# Rack::TimeZoneMiddleware
+
+[![Gem Version](https://badge.fury.io/rb/rack-time-zone-middleware.svg)](https://badge.fury.io/rb/rack-time-zone-middleware)
+[![Build Status](https://travis-ci.org/merqlove/rack-time-zone-middleware.svg?branch=master)](https://travis-ci.org/merqlove/rack-time-zone-middleware)
+[![Coverage Status](https://coveralls.io/repos/github/merqlove/rack-time-zone-middleware/badge.svg?branch=master)](https://coveralls.io/github/merqlove/rack-time-zone-middleware?branch=master)
+[![Code Climate](https://codeclimate.com/github/merqlove/rack-time-zone-middleware/badges/gpa.svg)](https://codeclimate.com/github/merqlove/rack-time-zone-middleware)
+
+Adding ability to detect timezone at UI side and get it within Rack/Rails via cookies with/o custom handler.
+
+This gem created for usecase of loading predefined TimeZone into Rails environment.  
+You can set cookie with TimeZone name at UI side(from Angular, React, Ember, Backbone or vanilla JS).  
+After that all XHR requests to your Rails/Rack backend will be fetched with this Middleware. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-time-zone-middleware'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-time-zone-middleware
+
+## Usage
+
+### Sinatra/Padrino application
+
+```ruby
+require 'rack/time-zone-middleware'
+
+# Default TimeZone handler.
+use Rack::TimeZoneMiddleware
+
+# Configured TimeZone handler.
+use Rack::TimeZoneMiddleware default_tz: 'Europe/Moscow', default_as_tz: 'Moscow', default_key: 'dummy.time_zone'
+
+# Your own TimeZone handler. All options & instance methods is available through middleware parameter.
+use Rack::TimeZoneMiddleware do |middleware, env|
+  request = ::Rack::Request.new(env)
+    
+  time_zone = request&.cookies['dummy.time_zone'] || middleware.options[:default_tz]
+  env['dummy.time_zone'] = middleware.find_as_time_zone(time_zone)
+  
+  middleware.app.call(env)    
+end
+```
+
+### Rails application
+
+```ruby
+# Default TimeZone handler.
+config.middleware.use Rack::TimeZoneMiddleware
+
+# Configured TimeZone handler.
+config.middleware.use Rack::TimeZoneMiddleware default_tz: 'Europe/Moscow', default_as_tz: 'Moscow', default_key: 'dummy.time_zone'
+
+# Your own TimeZone handler. All options & instance methods is available through middleware parameter.
+config.middleware.use Rack::TimeZoneMiddleware do |middleware, env|
+  request = ::Rack::Request.new(env)
+    
+  time_zone = request&.cookies['dummy.time_zone'] || middleware.options[:default_tz]
+  env['dummy.time_zone'] = middleware.find_as_time_zone(time_zone)
+  
+  middleware.app.call(env)    
+end
+```
+
+### Options
+
+| name  | description |
+|---|---|
+| default_tz | Default TimeZone for fallback(default: 'Europe/Moscow') |
+| default_as_tz | Default `ActiveSupport::TimeZone` fallback key(default: 'Moscow') |
+| default_key | Default cookie and environment keys(default: 'dummy.time_zone') |
+
+## Dependencies:
+
+- [Rack](https://github.com/rack/rack)
+- [ActiveSupport](https://github.com/rails/rails)
+
+## Contributing
+
+1. Fork it ( https://github.com/merqlove/rack-time-zone-middleware/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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/merqlove/rack-time-zone-middleware.
+
+### Testing
+
+    $ rake test 
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Copyright (c) 2016 Alexander Merkulov
+
+MIT License

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => _
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake/testtask'
+
+desc 'Run all the tests'
+task :default => [:test]
+
+desc 'Run specs'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.verbose = true
+  t.test_files = FileList['test/*_test.rb']
+end

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

@@ -0,0 +1 @@
+require 'rack/time-zone-middleware'

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

@@ -0,0 +1,47 @@
+require 'rack/time-zone-middleware/version'
+require 'active_support/values/time_zone'
+
+module Rack
+  class TimeZoneMiddleware
+    DEFAULT_TIME_ZONE    = 'Europe/Moscow'
+    DEFAULT_AS_TIME_ZONE = 'Moscow'
+    DEFAULT_KEY          = 'dummy.time_zone'
+
+    attr_reader :app, :runner, :options
+
+    def initialize(app, opts = {}, &block)
+      @app = app
+
+      @options = {}
+      options[:default_tz]    = opts.fetch(:default_tz, DEFAULT_TIME_ZONE)
+      options[:default_as_tz] = opts.fetch(:default_as_tz, DEFAULT_AS_TIME_ZONE)
+      options[:default_key]   = opts.fetch(:default_key, DEFAULT_KEY)
+
+      if block_given?
+        @runner = block
+      else
+        @runner = ->(mw, env) { _call(mw, env) }
+      end
+    end
+
+    def call(env)
+      runner.call(self, env)
+    end
+
+    def find_as_time_zone(name)
+      zone_name, _ = ::ActiveSupport::TimeZone::MAPPING.detect { |_, v| v.eql? name }
+      zone_name || options[:default_as_tz]
+    end
+
+    private
+
+    def _call(mw, env)
+      request = ::Rack::Request.new(env)
+
+      time_zone = request.cookies[mw.options[:default_key]] || mw.options[:default_tz]
+      env[mw.options[:default_key]] = mw.find_as_time_zone(time_zone)
+
+      mw.app.call(env)
+    end
+  end
+end

data/lib/rack/time-zone-middleware/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class TimeZoneMiddleware
+    VERSION = '0.1.2'
+  end
+end

data/rack-time-zone-middleware.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/time-zone-middleware/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-time-zone-middleware'
+  spec.version       = Rack::TimeZoneMiddleware::VERSION
+  spec.authors       = ['Alexander Merkulov']
+  spec.email         = ['sasha@merqlove.ru']
+
+  spec.summary       = %q{TimeZone handler middleware for Rack/Rails apps.}
+  spec.description   = %q{Adding ability to detect timezone at UI side and get it within Rack/Rails via cookies with/o custom handler.}
+  spec.homepage      = 'https://github.com/merqlove/rack-time-zone-middleware'
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.licenses      = ['MIT']
+
+  spec.add_runtime_dependency 'activesupport', '>= 4.0.0'
+  spec.add_runtime_dependency 'rack', '>= 1.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.6'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rack-time-zone-middleware
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Alexander Merkulov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+description: Adding ability to detect timezone at UI side and get it within Rack/Rails
+  via cookies with/o custom handler.
+email:
+- sasha@merqlove.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-time-zone-middleware.rb
+- lib/rack/time-zone-middleware.rb
+- lib/rack/time-zone-middleware/version.rb
+- rack-time-zone-middleware.gemspec
+homepage: https://github.com/merqlove/rack-time-zone-middleware
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: TimeZone handler middleware for Rack/Rails apps.
+test_files: []