access_token 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +10 -0
  3. data/.travis.yml +8 -0
  4. data/CHANGELOG.md +5 -0
  5. data/CODE_OF_CONDUCT.md +13 -0
  6. data/Gemfile +4 -0
  7. data/LICENSE.txt +21 -0
  8. data/README.md +169 -0
  9. data/Rakefile +9 -0
  10. data/access_token.gemspec +32 -0
  11. data/examples/rails-app/.gitignore +17 -0
  12. data/examples/rails-app/Gemfile +13 -0
  13. data/examples/rails-app/Gemfile.lock +149 -0
  14. data/examples/rails-app/README.rdoc +28 -0
  15. data/examples/rails-app/Rakefile +6 -0
  16. data/examples/rails-app/app/assets/images/.keep +0 -0
  17. data/examples/rails-app/app/assets/stylesheets/application.css +15 -0
  18. data/examples/rails-app/app/controllers/application_controller.rb +23 -0
  19. data/examples/rails-app/app/controllers/auth_controller.rb +13 -0
  20. data/examples/rails-app/app/controllers/concerns/.keep +0 -0
  21. data/examples/rails-app/app/controllers/profile_controller.rb +7 -0
  22. data/examples/rails-app/app/helpers/application_helper.rb +2 -0
  23. data/examples/rails-app/app/mailers/.keep +0 -0
  24. data/examples/rails-app/app/models/.keep +0 -0
  25. data/examples/rails-app/app/models/concerns/.keep +0 -0
  26. data/examples/rails-app/app/models/user.rb +3 -0
  27. data/examples/rails-app/app/views/layouts/application.html.erb +13 -0
  28. data/examples/rails-app/bin/bundle +3 -0
  29. data/examples/rails-app/bin/rails +4 -0
  30. data/examples/rails-app/bin/rake +4 -0
  31. data/examples/rails-app/bin/setup +29 -0
  32. data/examples/rails-app/config.ru +4 -0
  33. data/examples/rails-app/config/application.rb +26 -0
  34. data/examples/rails-app/config/boot.rb +3 -0
  35. data/examples/rails-app/config/database.yml +25 -0
  36. data/examples/rails-app/config/environment.rb +5 -0
  37. data/examples/rails-app/config/environments/development.rb +41 -0
  38. data/examples/rails-app/config/environments/production.rb +79 -0
  39. data/examples/rails-app/config/environments/test.rb +42 -0
  40. data/examples/rails-app/config/initializers/assets.rb +11 -0
  41. data/examples/rails-app/config/initializers/backtrace_silencers.rb +7 -0
  42. data/examples/rails-app/config/initializers/cookies_serializer.rb +3 -0
  43. data/examples/rails-app/config/initializers/filter_parameter_logging.rb +4 -0
  44. data/examples/rails-app/config/initializers/inflections.rb +16 -0
  45. data/examples/rails-app/config/initializers/mime_types.rb +4 -0
  46. data/examples/rails-app/config/initializers/session_store.rb +3 -0
  47. data/examples/rails-app/config/initializers/wrap_parameters.rb +14 -0
  48. data/examples/rails-app/config/locales/en.yml +23 -0
  49. data/examples/rails-app/config/routes.rb +4 -0
  50. data/examples/rails-app/config/secrets.yml +25 -0
  51. data/examples/rails-app/db/migrate/20150601000736_create_users.rb +17 -0
  52. data/examples/rails-app/db/schema.rb +25 -0
  53. data/examples/rails-app/db/seeds.rb +7 -0
  54. data/examples/rails-app/lib/assets/.keep +0 -0
  55. data/examples/rails-app/lib/tasks/.keep +0 -0
  56. data/examples/rails-app/log/.keep +0 -0
  57. data/examples/rails-app/public/404.html +67 -0
  58. data/examples/rails-app/public/422.html +67 -0
  59. data/examples/rails-app/public/500.html +66 -0
  60. data/examples/rails-app/public/favicon.ico +0 -0
  61. data/examples/rails-app/public/robots.txt +5 -0
  62. data/examples/rails-app/test/controllers/.keep +0 -0
  63. data/examples/rails-app/test/fixtures/.keep +0 -0
  64. data/examples/rails-app/test/fixtures/users.yml +9 -0
  65. data/examples/rails-app/test/helpers/.keep +0 -0
  66. data/examples/rails-app/test/integration/.keep +0 -0
  67. data/examples/rails-app/test/mailers/.keep +0 -0
  68. data/examples/rails-app/test/models/.keep +0 -0
  69. data/examples/rails-app/test/models/user_test.rb +7 -0
  70. data/examples/rails-app/test/test_helper.rb +10 -0
  71. data/examples/rails-app/vendor/assets/stylesheets/.keep +0 -0
  72. data/examples/sinatra-app/Gemfile +9 -0
  73. data/examples/sinatra-app/Gemfile.lock +76 -0
  74. data/examples/sinatra-app/config.ru +2 -0
  75. data/examples/sinatra-app/server.rb +78 -0
  76. data/lib/access_token.rb +84 -0
  77. data/lib/access_token/memcached_store.rb +25 -0
  78. data/lib/access_token/null_store.rb +19 -0
  79. data/lib/access_token/redis_store.rb +28 -0
  80. data/lib/access_token/version.rb +3 -0
  81. metadata +305 -0
@@ -0,0 +1,2 @@
1
+ require File.expand_path('../server', __FILE__)
2
+ run App
@@ -0,0 +1,78 @@
1
+ require 'bundler/setup'
2
+ Bundler.require
3
+
4
+ ActiveRecord::Base.establish_connection(
5
+ adapter: 'sqlite3',
6
+ database: 'sample.sqlite3'
7
+ )
8
+
9
+ class User < ActiveRecord::Base
10
+ has_secure_password
11
+ end
12
+
13
+ ActiveRecord::Schema.define(version: 0) do
14
+ next if table_exists?(:users)
15
+
16
+ create_table :users do |t|
17
+ t.string :email, null: false
18
+ t.string :password_digest, null: false
19
+ t.timestamps null: false
20
+ end
21
+
22
+ add_index :users, :email, unique: true
23
+ User.create!(email: 'john@example.com', password: 'test')
24
+ end
25
+
26
+ class BaseEndpoint < Sinatra::Application
27
+ helpers do
28
+ def access_token
29
+ @access_token ||= AccessToken.new(
30
+ request: request,
31
+ response: response,
32
+ secret: '220c6a866bff52edc0825ee5e15be8f02953764cb7a8d54ba44b46c26a7fa8867d8aa09cc11f23843d72819d98823248e1a6dcd52abc0783cace5de459dd43dd7d8da6313cbebacb475e099c0686d210cf51636800206a19526844ab8ced6af1906a9500',
33
+ store: AccessToken::RedisStore.new
34
+ )
35
+ end
36
+
37
+ def authenticate!
38
+ user_id = access_token.resolve
39
+ halt(401) unless user_id
40
+
41
+ @current_user = User.find_by_id(user_id)
42
+ halt(401) unless @current_user
43
+ access_token.update(current_user)
44
+ end
45
+
46
+ def current_user
47
+ @current_user
48
+ end
49
+ end
50
+
51
+ before do
52
+ content_type 'application/json'
53
+ end
54
+ end
55
+
56
+ class ProfileEndpoint < BaseEndpoint
57
+ before { authenticate! }
58
+
59
+ get '/profile' do
60
+ current_user.to_json
61
+ end
62
+ end
63
+
64
+ class AuthEndpoint < BaseEndpoint
65
+ post '/auth' do
66
+ user = User.find_by_email(params[:email].to_s)
67
+ .try(:authenticate, params[:password].to_s)
68
+
69
+ halt(401) unless user
70
+ access_token.update(user)
71
+ user.to_json
72
+ end
73
+ end
74
+
75
+ App = Rack::Cascade.new([
76
+ AuthEndpoint,
77
+ ProfileEndpoint
78
+ ])
@@ -0,0 +1,84 @@
1
+ class AccessToken
2
+ require 'parsel'
3
+
4
+ require 'access_token/version'
5
+ require 'access_token/redis_store'
6
+ require 'access_token/memcached_store'
7
+ require 'access_token/null_store'
8
+
9
+ BEARER_HEADER = 'Bearer'.freeze
10
+ EXPIRES_HEADER = 'Expires'.freeze
11
+ AUTHORIZATION_HEADER = 'HTTP_AUTHORIZATION'.freeze
12
+ TIME_KEY = 'time'.freeze
13
+ ID_KEY = 'id'.freeze
14
+ SIGNATURE_KEY = 'signature'.freeze
15
+ BEARER_REGEX = /\ABearer (.*?)\z/
16
+
17
+ # Set the HTTP request object.
18
+ # It must implement the `ip` and `user_agent` methods.
19
+ attr_reader :request
20
+
21
+ # Set the HTTP response object.
22
+ # It must implement the `headers` method.
23
+ attr_reader :response
24
+
25
+ # Set the token store strategy.
26
+ # By default it uses in-memory store.
27
+ attr_reader :store
28
+
29
+ # Set the token encryptor strategy.
30
+ # By default it uses the Parsel::JSON encryptor.
31
+ attr_reader :encryptor
32
+
33
+ # Set the token TTL.
34
+ # Defaults to 86400 (24 hours).
35
+ attr_reader :ttl
36
+
37
+ # Set the encryption secret.
38
+ attr_reader :secret
39
+
40
+ def initialize(request:, response:, secret:, ttl: 3600, store: NullStore.new, encryptor: Parsel::JSON)
41
+ @request = request
42
+ @response = response
43
+ @store = store
44
+ @secret = secret
45
+ @ttl = ttl
46
+ @encryptor = encryptor
47
+ end
48
+
49
+ def request_signature
50
+ @request_signature ||= Digest::SHA1.hexdigest("#{request.ip}#{request.user_agent}")
51
+ end
52
+
53
+ def update(record)
54
+ now = Time.now
55
+ timestamp = now.to_i
56
+ data = {TIME_KEY => timestamp, SIGNATURE_KEY => request_signature, ID_KEY => record.id}
57
+ token = encryptor.encrypt(secret, data)
58
+ store.set(token, timestamp, ttl)
59
+ response[BEARER_HEADER] = token
60
+ response[EXPIRES_HEADER] = (Time.now + ttl).httpdate
61
+ token
62
+ end
63
+
64
+ def resolve(token = bearer)
65
+ return unless store.key?(token)
66
+
67
+ data = encryptor.decrypt(secret, token)
68
+ store.del(token)
69
+
70
+ return unless data
71
+ return unless fresh?(data[TIME_KEY])
72
+ return unless request_signature == data[SIGNATURE_KEY]
73
+
74
+ data[ID_KEY]
75
+ end
76
+
77
+ def bearer
78
+ request.env[AUTHORIZATION_HEADER].to_s[BEARER_REGEX, 1]
79
+ end
80
+
81
+ def fresh?(timestamp)
82
+ timestamp > Time.now.to_i - ttl
83
+ end
84
+ end
@@ -0,0 +1,25 @@
1
+ class AccessToken
2
+ class MemcachedStore
3
+ attr_reader :client
4
+
5
+ def initialize(client = Dalli::Client.new)
6
+ @client = client
7
+ end
8
+
9
+ def set(key, value, ttl)
10
+ client.set(key, value)
11
+ end
12
+
13
+ def get(key)
14
+ client.get(key)
15
+ end
16
+
17
+ def del(key)
18
+ client.delete(key)
19
+ end
20
+
21
+ def key?(key)
22
+ client.get(key) != nil
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,19 @@
1
+ class AccessToken
2
+ class NullStore
3
+ def set(key, value, ttl)
4
+ true
5
+ end
6
+
7
+ def get(key)
8
+ true
9
+ end
10
+
11
+ def del(key)
12
+ true
13
+ end
14
+
15
+ def key?(key)
16
+ true
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,28 @@
1
+ class AccessToken
2
+ class RedisStore
3
+ attr_reader :client
4
+
5
+ def initialize(client = Redis.new)
6
+ @client = client
7
+ end
8
+
9
+ def set(key, value, ttl)
10
+ client.multi do
11
+ client.set(key, value)
12
+ client.expire(key, ttl)
13
+ end
14
+ end
15
+
16
+ def get(key)
17
+ client.get(key)
18
+ end
19
+
20
+ def del(key)
21
+ client.del(key)
22
+ end
23
+
24
+ def key?(key)
25
+ client.exists(key)
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,3 @@
1
+ class AccessToken
2
+ VERSION = '0.1.0'
3
+ end
metadata ADDED
@@ -0,0 +1,305 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: access_token
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Nando Vieira
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-06-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: parsel
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.9'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.9'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: minitest
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-utils
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rack-test
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: sinatra
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: activerecord
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: sqlite3
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: bcrypt
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: pry-meta
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
158
+ - !ruby/object:Gem::Version
159
+ version: '0'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ - !ruby/object:Gem::Dependency
168
+ name: redis
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - ">="
172
+ - !ruby/object:Gem::Version
173
+ version: '0'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - ">="
179
+ - !ruby/object:Gem::Version
180
+ version: '0'
181
+ - !ruby/object:Gem::Dependency
182
+ name: dalli
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - ">="
186
+ - !ruby/object:Gem::Version
187
+ version: '0'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - ">="
193
+ - !ruby/object:Gem::Version
194
+ version: '0'
195
+ description: Access token for client-side and API authentication.
196
+ email:
197
+ - fnando.vieira@gmail.com
198
+ executables: []
199
+ extensions: []
200
+ extra_rdoc_files: []
201
+ files:
202
+ - ".gitignore"
203
+ - ".travis.yml"
204
+ - CHANGELOG.md
205
+ - CODE_OF_CONDUCT.md
206
+ - Gemfile
207
+ - LICENSE.txt
208
+ - README.md
209
+ - Rakefile
210
+ - access_token.gemspec
211
+ - examples/rails-app/.gitignore
212
+ - examples/rails-app/Gemfile
213
+ - examples/rails-app/Gemfile.lock
214
+ - examples/rails-app/README.rdoc
215
+ - examples/rails-app/Rakefile
216
+ - examples/rails-app/app/assets/images/.keep
217
+ - examples/rails-app/app/assets/stylesheets/application.css
218
+ - examples/rails-app/app/controllers/application_controller.rb
219
+ - examples/rails-app/app/controllers/auth_controller.rb
220
+ - examples/rails-app/app/controllers/concerns/.keep
221
+ - examples/rails-app/app/controllers/profile_controller.rb
222
+ - examples/rails-app/app/helpers/application_helper.rb
223
+ - examples/rails-app/app/mailers/.keep
224
+ - examples/rails-app/app/models/.keep
225
+ - examples/rails-app/app/models/concerns/.keep
226
+ - examples/rails-app/app/models/user.rb
227
+ - examples/rails-app/app/views/layouts/application.html.erb
228
+ - examples/rails-app/bin/bundle
229
+ - examples/rails-app/bin/rails
230
+ - examples/rails-app/bin/rake
231
+ - examples/rails-app/bin/setup
232
+ - examples/rails-app/config.ru
233
+ - examples/rails-app/config/application.rb
234
+ - examples/rails-app/config/boot.rb
235
+ - examples/rails-app/config/database.yml
236
+ - examples/rails-app/config/environment.rb
237
+ - examples/rails-app/config/environments/development.rb
238
+ - examples/rails-app/config/environments/production.rb
239
+ - examples/rails-app/config/environments/test.rb
240
+ - examples/rails-app/config/initializers/assets.rb
241
+ - examples/rails-app/config/initializers/backtrace_silencers.rb
242
+ - examples/rails-app/config/initializers/cookies_serializer.rb
243
+ - examples/rails-app/config/initializers/filter_parameter_logging.rb
244
+ - examples/rails-app/config/initializers/inflections.rb
245
+ - examples/rails-app/config/initializers/mime_types.rb
246
+ - examples/rails-app/config/initializers/session_store.rb
247
+ - examples/rails-app/config/initializers/wrap_parameters.rb
248
+ - examples/rails-app/config/locales/en.yml
249
+ - examples/rails-app/config/routes.rb
250
+ - examples/rails-app/config/secrets.yml
251
+ - examples/rails-app/db/migrate/20150601000736_create_users.rb
252
+ - examples/rails-app/db/schema.rb
253
+ - examples/rails-app/db/seeds.rb
254
+ - examples/rails-app/lib/assets/.keep
255
+ - examples/rails-app/lib/tasks/.keep
256
+ - examples/rails-app/log/.keep
257
+ - examples/rails-app/public/404.html
258
+ - examples/rails-app/public/422.html
259
+ - examples/rails-app/public/500.html
260
+ - examples/rails-app/public/favicon.ico
261
+ - examples/rails-app/public/robots.txt
262
+ - examples/rails-app/test/controllers/.keep
263
+ - examples/rails-app/test/fixtures/.keep
264
+ - examples/rails-app/test/fixtures/users.yml
265
+ - examples/rails-app/test/helpers/.keep
266
+ - examples/rails-app/test/integration/.keep
267
+ - examples/rails-app/test/mailers/.keep
268
+ - examples/rails-app/test/models/.keep
269
+ - examples/rails-app/test/models/user_test.rb
270
+ - examples/rails-app/test/test_helper.rb
271
+ - examples/rails-app/vendor/assets/stylesheets/.keep
272
+ - examples/sinatra-app/Gemfile
273
+ - examples/sinatra-app/Gemfile.lock
274
+ - examples/sinatra-app/config.ru
275
+ - examples/sinatra-app/server.rb
276
+ - lib/access_token.rb
277
+ - lib/access_token/memcached_store.rb
278
+ - lib/access_token/null_store.rb
279
+ - lib/access_token/redis_store.rb
280
+ - lib/access_token/version.rb
281
+ homepage: http://rubygems.org/gems/access_token
282
+ licenses:
283
+ - MIT
284
+ metadata: {}
285
+ post_install_message:
286
+ rdoc_options: []
287
+ require_paths:
288
+ - lib
289
+ required_ruby_version: !ruby/object:Gem::Requirement
290
+ requirements:
291
+ - - ">="
292
+ - !ruby/object:Gem::Version
293
+ version: '0'
294
+ required_rubygems_version: !ruby/object:Gem::Requirement
295
+ requirements:
296
+ - - ">="
297
+ - !ruby/object:Gem::Version
298
+ version: '0'
299
+ requirements: []
300
+ rubyforge_project:
301
+ rubygems_version: 2.4.6
302
+ signing_key:
303
+ specification_version: 4
304
+ summary: Access token for client-side and API authentication.
305
+ test_files: []