rack-synctime 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +19 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +51 -0
- data/Rakefile +1 -0
- data/lib/rack-synctime.rb +1 -0
- data/lib/rack/synctime.rb +26 -0
- data/lib/rack/synctime/version.rb +5 -0
- data/rack-synctime.gemspec +24 -0
- metadata +91 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Bartlomiej Wojtowicz (bart)
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
# Rack::Synctime
|
2
|
+
|
3
|
+
Rack::Synctime is a simple Rack middleware that returns sync time (time when request started) in HTTP headers. Header name can be changed also sync time can be modified using time offset i.e. -5 seconds (server time in seconds decreased by 5) etc. This can be useful if you develop mobile applications (Android, iOS, ...) and you need information when request started in response header.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'rack-synctime'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install rack-synctime
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
Put the following line in your application.rb file:
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
config.middleware.use Rack::Synctime
|
25
|
+
```
|
26
|
+
|
27
|
+
Custom header name:
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
config.middleware.use Rack::Synctime, "Custom-Header-Name"
|
31
|
+
```
|
32
|
+
|
33
|
+
Time offset:
|
34
|
+
|
35
|
+
```ruby
|
36
|
+
config.middleware.use Rack::Synctime, Rack::Synctime::DEFAULT_HEADER_NAME, -3600 # server time -1 hour
|
37
|
+
```
|
38
|
+
|
39
|
+
## Note
|
40
|
+
In Rails app sync time header name might be transformed into capitalized string by other mechanisms. So if you use custom header name make sure you have expected result.
|
41
|
+
|
42
|
+
## Demo
|
43
|
+
You can check out demo here: [Rack::Synctime demo](https://github.com/b-wojtowicz/rack-synctime-demo)
|
44
|
+
|
45
|
+
## Contributing
|
46
|
+
|
47
|
+
1. Fork it
|
48
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
49
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
50
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
51
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
@@ -0,0 +1 @@
|
|
1
|
+
require 'rack/synctime'
|
@@ -0,0 +1,26 @@
|
|
1
|
+
module Rack
|
2
|
+
|
3
|
+
class Synctime
|
4
|
+
|
5
|
+
DEFAULT_HEADER_NAME = "X-Synced-At"
|
6
|
+
|
7
|
+
def initialize(app, header_name = DEFAULT_HEADER_NAME, time_offset = 0)
|
8
|
+
@app = app
|
9
|
+
@synced_at_header_name = header_name
|
10
|
+
@time_offset = time_offset
|
11
|
+
end
|
12
|
+
|
13
|
+
def call(env)
|
14
|
+
now = current_time_with_offset
|
15
|
+
resp = @app.call(env)
|
16
|
+
resp[1][@synced_at_header_name] = now.to_s
|
17
|
+
resp
|
18
|
+
end
|
19
|
+
|
20
|
+
def current_time_with_offset
|
21
|
+
Time.now.to_i + @time_offset
|
22
|
+
end
|
23
|
+
|
24
|
+
end
|
25
|
+
|
26
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'rack/synctime/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |gem|
|
7
|
+
gem.name = "rack-synctime"
|
8
|
+
gem.version = Rack::Synctime::VERSION
|
9
|
+
gem.authors = ["Bartlomiej Wojtowicz"]
|
10
|
+
gem.email = ["wojtowicz.bartlomiej@gmail.com"]
|
11
|
+
gem.homepage = "https://github.com/b-wojtowicz/rack-synctime"
|
12
|
+
gem.summary = %q{A simple Rack middleware that returns sync time in HTTP headers}
|
13
|
+
gem.description = %q{Rack::Synctime is a simple Rack middleware that returns sync time (time when request started) in HTTP headers (#{Rack::Synctime::DEFAULT_HEADER_NAME} by default). Header name can be changed also sync time can be modified using time offset i.e. -5 seconds (server time in seconds decreased by 5) etc. This can be useful if you develop mobile applications (Android, iOS, ...) and you need information when request started in response header.}
|
14
|
+
|
15
|
+
gem.files = `git ls-files`.split($/)
|
16
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
17
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
18
|
+
gem.require_paths = ["lib"]
|
19
|
+
|
20
|
+
|
21
|
+
gem.required_rubygems_version = ">= 1.3.6"
|
22
|
+
gem.add_development_dependency "bundler", "~> 1.0"
|
23
|
+
gem.add_development_dependency "rack", "~> 1.2.0"
|
24
|
+
end
|
metadata
ADDED
@@ -0,0 +1,91 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: rack-synctime
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Bartlomiej Wojtowicz
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-03-17 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.0'
|
22
|
+
type: :development
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '1.0'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: rack
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ~>
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: 1.2.0
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ~>
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: 1.2.0
|
46
|
+
description: Rack::Synctime is a simple Rack middleware that returns sync time (time
|
47
|
+
when request started) in HTTP headers (#{Rack::Synctime::DEFAULT_HEADER_NAME} by
|
48
|
+
default). Header name can be changed also sync time can be modified using time offset
|
49
|
+
i.e. -5 seconds (server time in seconds decreased by 5) etc. This can be useful
|
50
|
+
if you develop mobile applications (Android, iOS, ...) and you need information
|
51
|
+
when request started in response header.
|
52
|
+
email:
|
53
|
+
- wojtowicz.bartlomiej@gmail.com
|
54
|
+
executables: []
|
55
|
+
extensions: []
|
56
|
+
extra_rdoc_files: []
|
57
|
+
files:
|
58
|
+
- .gitignore
|
59
|
+
- Gemfile
|
60
|
+
- LICENSE.txt
|
61
|
+
- README.md
|
62
|
+
- Rakefile
|
63
|
+
- lib/rack-synctime.rb
|
64
|
+
- lib/rack/synctime.rb
|
65
|
+
- lib/rack/synctime/version.rb
|
66
|
+
- rack-synctime.gemspec
|
67
|
+
homepage: https://github.com/b-wojtowicz/rack-synctime
|
68
|
+
licenses: []
|
69
|
+
post_install_message:
|
70
|
+
rdoc_options: []
|
71
|
+
require_paths:
|
72
|
+
- lib
|
73
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
74
|
+
none: false
|
75
|
+
requirements:
|
76
|
+
- - ! '>='
|
77
|
+
- !ruby/object:Gem::Version
|
78
|
+
version: '0'
|
79
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
80
|
+
none: false
|
81
|
+
requirements:
|
82
|
+
- - ! '>='
|
83
|
+
- !ruby/object:Gem::Version
|
84
|
+
version: 1.3.6
|
85
|
+
requirements: []
|
86
|
+
rubyforge_project:
|
87
|
+
rubygems_version: 1.8.24
|
88
|
+
signing_key:
|
89
|
+
specification_version: 3
|
90
|
+
summary: A simple Rack middleware that returns sync time in HTTP headers
|
91
|
+
test_files: []
|