rack-time-zone-middleware 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.travis.yml +12 -0
- data/Gemfile +7 -0
- data/LICENSE +21 -0
- data/README.md +107 -0
- data/Rakefile +21 -0
- data/lib/rack-time-zone-middleware.rb +1 -0
- data/lib/rack/time-zone-middleware.rb +47 -0
- data/lib/rack/time-zone-middleware/version.rb +5 -0
- data/rack-time-zone-middleware.gemspec +30 -0
- metadata +125 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 099d747f1c77445c92b0d447489488ccefa0b555
|
4
|
+
data.tar.gz: cf95cf6124acee7e7b0477ade1aa68e2027c36cb
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d9561629fac0db9087ac8a462371d78b8ffe8f40a536c16de5fdf6a0e5d5d1f9444d0020d97e5896e3a05cf38ad82073f057ed055780775fc852f4deaa8dad7b
|
7
|
+
data.tar.gz: b4ac0366e88457377c5ceb450423ceb61a69655c76570aa350c5857bcd62aa55b88f557089d96302f3dd04f117d7b1969d9bcb66471692a35e125540906ae3eb
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 Alexander Merkulov
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,107 @@
|
|
1
|
+
# Rack::TimeZoneMiddleware
|
2
|
+
|
3
|
+
[![Gem Version](https://badge.fury.io/rb/rack-time-zone-middleware.svg)](https://badge.fury.io/rb/rack-time-zone-middleware)
|
4
|
+
[![Build Status](https://travis-ci.org/merqlove/rack-time-zone-middleware.svg?branch=master)](https://travis-ci.org/merqlove/rack-time-zone-middleware)
|
5
|
+
[![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)
|
6
|
+
[![Code Climate](https://codeclimate.com/github/merqlove/rack-time-zone-middleware/badges/gpa.svg)](https://codeclimate.com/github/merqlove/rack-time-zone-middleware)
|
7
|
+
|
8
|
+
Adding ability to detect timezone at UI side and get it within Rack/Rails via cookies with/o custom handler.
|
9
|
+
|
10
|
+
This gem created for usecase of loading predefined TimeZone into Rails environment.
|
11
|
+
You can set cookie with TimeZone name at UI side(from Angular, React, Ember, Backbone or vanilla JS).
|
12
|
+
After that all XHR requests to your Rails/Rack backend will be fetched with this Middleware.
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
Add this line to your application's Gemfile:
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
gem 'rack-time-zone-middleware'
|
20
|
+
```
|
21
|
+
|
22
|
+
And then execute:
|
23
|
+
|
24
|
+
$ bundle
|
25
|
+
|
26
|
+
Or install it yourself as:
|
27
|
+
|
28
|
+
$ gem install rack-time-zone-middleware
|
29
|
+
|
30
|
+
## Usage
|
31
|
+
|
32
|
+
### Sinatra/Padrino application
|
33
|
+
|
34
|
+
```ruby
|
35
|
+
require 'rack/time-zone-middleware'
|
36
|
+
|
37
|
+
# Default TimeZone handler.
|
38
|
+
use Rack::TimeZoneMiddleware
|
39
|
+
|
40
|
+
# Configured TimeZone handler.
|
41
|
+
use Rack::TimeZoneMiddleware default_tz: 'Europe/Moscow', default_as_tz: 'Moscow', default_key: 'dummy.time_zone'
|
42
|
+
|
43
|
+
# Your own TimeZone handler. All options & instance methods is available through middleware parameter.
|
44
|
+
use Rack::TimeZoneMiddleware do |middleware, env|
|
45
|
+
request = ::Rack::Request.new(env)
|
46
|
+
|
47
|
+
time_zone = request&.cookies['dummy.time_zone'] || middleware.options[:default_tz]
|
48
|
+
env['dummy.time_zone'] = middleware.find_as_time_zone(time_zone)
|
49
|
+
|
50
|
+
middleware.app.call(env)
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
### Rails application
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
# Default TimeZone handler.
|
58
|
+
config.middleware.use Rack::TimeZoneMiddleware
|
59
|
+
|
60
|
+
# Configured TimeZone handler.
|
61
|
+
config.middleware.use Rack::TimeZoneMiddleware default_tz: 'Europe/Moscow', default_as_tz: 'Moscow', default_key: 'dummy.time_zone'
|
62
|
+
|
63
|
+
# Your own TimeZone handler. All options & instance methods is available through middleware parameter.
|
64
|
+
config.middleware.use Rack::TimeZoneMiddleware do |middleware, env|
|
65
|
+
request = ::Rack::Request.new(env)
|
66
|
+
|
67
|
+
time_zone = request&.cookies['dummy.time_zone'] || middleware.options[:default_tz]
|
68
|
+
env['dummy.time_zone'] = middleware.find_as_time_zone(time_zone)
|
69
|
+
|
70
|
+
middleware.app.call(env)
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
### Options
|
75
|
+
|
76
|
+
| name | description |
|
77
|
+
|---|---|
|
78
|
+
| default_tz | Default TimeZone for fallback(default: 'Europe/Moscow') |
|
79
|
+
| default_as_tz | Default `ActiveSupport::TimeZone` fallback key(default: 'Moscow') |
|
80
|
+
| default_key | Default cookie and environment keys(default: 'dummy.time_zone') |
|
81
|
+
|
82
|
+
## Dependencies:
|
83
|
+
|
84
|
+
- [Rack](https://github.com/rack/rack)
|
85
|
+
- [ActiveSupport](https://github.com/rails/rails)
|
86
|
+
|
87
|
+
## Contributing
|
88
|
+
|
89
|
+
1. Fork it ( https://github.com/merqlove/rack-time-zone-middleware/fork )
|
90
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
91
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
92
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
93
|
+
5. Create a new Pull Request
|
94
|
+
|
95
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/merqlove/rack-time-zone-middleware.
|
96
|
+
|
97
|
+
### Testing
|
98
|
+
|
99
|
+
$ rake test
|
100
|
+
|
101
|
+
## Development
|
102
|
+
|
103
|
+
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).
|
104
|
+
|
105
|
+
Copyright (c) 2016 Alexander Merkulov
|
106
|
+
|
107
|
+
MIT License
|
data/Rakefile
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
require 'bundler/gem_tasks'
|
2
|
+
|
3
|
+
begin
|
4
|
+
Bundler.setup(:default, :development)
|
5
|
+
rescue Bundler::BundlerError => _
|
6
|
+
$stderr.puts e.message
|
7
|
+
$stderr.puts 'Run `bundle install` to install missing gems'
|
8
|
+
exit e.status_code
|
9
|
+
end
|
10
|
+
|
11
|
+
require 'rake/testtask'
|
12
|
+
|
13
|
+
desc 'Run all the tests'
|
14
|
+
task :default => [:test]
|
15
|
+
|
16
|
+
desc 'Run specs'
|
17
|
+
Rake::TestTask.new do |t|
|
18
|
+
t.libs << 'test'
|
19
|
+
t.verbose = true
|
20
|
+
t.test_files = FileList['test/*_test.rb']
|
21
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require 'rack/time-zone-middleware'
|
@@ -0,0 +1,47 @@
|
|
1
|
+
require 'rack/time-zone-middleware/version'
|
2
|
+
require 'active_support/values/time_zone'
|
3
|
+
|
4
|
+
module Rack
|
5
|
+
class TimeZoneMiddleware
|
6
|
+
DEFAULT_TIME_ZONE = 'Europe/Moscow'
|
7
|
+
DEFAULT_AS_TIME_ZONE = 'Moscow'
|
8
|
+
DEFAULT_KEY = 'dummy.time_zone'
|
9
|
+
|
10
|
+
attr_reader :app, :runner, :options
|
11
|
+
|
12
|
+
def initialize(app, opts = {}, &block)
|
13
|
+
@app = app
|
14
|
+
|
15
|
+
@options = {}
|
16
|
+
options[:default_tz] = opts.fetch(:default_tz, DEFAULT_TIME_ZONE)
|
17
|
+
options[:default_as_tz] = opts.fetch(:default_as_tz, DEFAULT_AS_TIME_ZONE)
|
18
|
+
options[:default_key] = opts.fetch(:default_key, DEFAULT_KEY)
|
19
|
+
|
20
|
+
if block_given?
|
21
|
+
@runner = block
|
22
|
+
else
|
23
|
+
@runner = ->(mw, env) { _call(mw, env) }
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
def call(env)
|
28
|
+
runner.call(self, env)
|
29
|
+
end
|
30
|
+
|
31
|
+
def find_as_time_zone(name)
|
32
|
+
zone_name, _ = ::ActiveSupport::TimeZone::MAPPING.detect { |_, v| v.eql? name }
|
33
|
+
zone_name || options[:default_as_tz]
|
34
|
+
end
|
35
|
+
|
36
|
+
private
|
37
|
+
|
38
|
+
def _call(mw, env)
|
39
|
+
request = ::Rack::Request.new(env)
|
40
|
+
|
41
|
+
time_zone = request.cookies[mw.options[:default_key]] || mw.options[:default_tz]
|
42
|
+
env[mw.options[:default_key]] = mw.find_as_time_zone(time_zone)
|
43
|
+
|
44
|
+
mw.app.call(env)
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'rack/time-zone-middleware/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'rack-time-zone-middleware'
|
8
|
+
spec.version = Rack::TimeZoneMiddleware::VERSION
|
9
|
+
spec.authors = ['Alexander Merkulov']
|
10
|
+
spec.email = ['sasha@merqlove.ru']
|
11
|
+
|
12
|
+
spec.summary = %q{TimeZone handler middleware for Rack/Rails apps.}
|
13
|
+
spec.description = %q{Adding ability to detect timezone at UI side and get it within Rack/Rails via cookies with/o custom handler.}
|
14
|
+
spec.homepage = 'https://github.com/merqlove/rack-time-zone-middleware'
|
15
|
+
|
16
|
+
spec.required_ruby_version = '>= 2.0.0'
|
17
|
+
|
18
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
19
|
+
spec.bindir = 'exe'
|
20
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
21
|
+
spec.require_paths = ['lib']
|
22
|
+
spec.licenses = ['MIT']
|
23
|
+
|
24
|
+
spec.add_runtime_dependency 'activesupport', '>= 4.0.0'
|
25
|
+
spec.add_runtime_dependency 'rack', '>= 1.2.0'
|
26
|
+
|
27
|
+
spec.add_development_dependency 'bundler', '~> 1.0'
|
28
|
+
spec.add_development_dependency 'rake'
|
29
|
+
spec.add_development_dependency 'minitest', '~> 5.6'
|
30
|
+
end
|
metadata
ADDED
@@ -0,0 +1,125 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: rack-time-zone-middleware
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.2
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Alexander Merkulov
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-07-15 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: activesupport
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 4.0.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 4.0.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rack
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 1.2.0
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 1.2.0
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: minitest
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '5.6'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '5.6'
|
83
|
+
description: Adding ability to detect timezone at UI side and get it within Rack/Rails
|
84
|
+
via cookies with/o custom handler.
|
85
|
+
email:
|
86
|
+
- sasha@merqlove.ru
|
87
|
+
executables: []
|
88
|
+
extensions: []
|
89
|
+
extra_rdoc_files: []
|
90
|
+
files:
|
91
|
+
- ".gitignore"
|
92
|
+
- ".travis.yml"
|
93
|
+
- Gemfile
|
94
|
+
- LICENSE
|
95
|
+
- README.md
|
96
|
+
- Rakefile
|
97
|
+
- lib/rack-time-zone-middleware.rb
|
98
|
+
- lib/rack/time-zone-middleware.rb
|
99
|
+
- lib/rack/time-zone-middleware/version.rb
|
100
|
+
- rack-time-zone-middleware.gemspec
|
101
|
+
homepage: https://github.com/merqlove/rack-time-zone-middleware
|
102
|
+
licenses:
|
103
|
+
- MIT
|
104
|
+
metadata: {}
|
105
|
+
post_install_message:
|
106
|
+
rdoc_options: []
|
107
|
+
require_paths:
|
108
|
+
- lib
|
109
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
110
|
+
requirements:
|
111
|
+
- - ">="
|
112
|
+
- !ruby/object:Gem::Version
|
113
|
+
version: 2.0.0
|
114
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
115
|
+
requirements:
|
116
|
+
- - ">="
|
117
|
+
- !ruby/object:Gem::Version
|
118
|
+
version: '0'
|
119
|
+
requirements: []
|
120
|
+
rubyforge_project:
|
121
|
+
rubygems_version: 2.5.1
|
122
|
+
signing_key:
|
123
|
+
specification_version: 4
|
124
|
+
summary: TimeZone handler middleware for Rack/Rails apps.
|
125
|
+
test_files: []
|