redis_token 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1edc5c50c5911fb657241844a937efc3a37a34b6
+  data.tar.gz: 94373d284d69125bcd1c1cac7f59949e24b9e1c6
+SHA512:
+  metadata.gz: a2d0c42b20bd11a876faa48a8ab7a67ddbac1a2361a3bd32d26aa29cc5b21351e3245fd441280b527f59fdd6fbf346fbbe92dd8715e22e14490070de2286fc25
+  data.tar.gz: 91df9c97d381c41562d7f8173488eab676b09d9f514c6ef096beac3e7ba5793c17bd39a8f652695c4aacff5f2076160077297f23f2df1a6e9459656a4dcc4e8c

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Artem Baikuzin
+
+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,63 @@
+# redis_token
+
+API tokens redis store
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_token'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_token
+
+## Usage
+
+```ruby
+
+before_action :create_service
+
+def auth
+  client = Client.find_by_email(params[:email])
+
+  if client.password == params[:password]
+    token = @redis_token.create(client.id, payload: { source: :native })
+    json(access_token: token)
+
+    ...
+  end
+
+  ...
+end
+
+def secured_method
+  value = @redis_token.get(params[:access_token])
+  return unathorized unless value
+
+  client = Client.find_by_id(value[:owner])
+  payload = value[:payload]
+
+  ...
+end
+
+def client_tokens
+  @tokens = []
+
+  @redis_token.each(client.id) do |token, value|
+    @tokens << { token: token, value: value }
+  end
+end
+
+private
+
+def create_service
+  @redis_token ||= RedisToken.new(prefix: 'myproject.tokens.', ttl: 30.days)
+end
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/redis_token/version.rb

@@ -0,0 +1,3 @@
+class RedisToken
+  VERSION = '0.0.1'.freeze
+end

data/lib/redis_token.rb

@@ -0,0 +1,146 @@
+require 'redis_token/version'
+require 'redis'
+
+require 'securerandom'
+require 'time'
+
+class RedisToken
+  # Token lives 14 days by default
+  DEFAULT_TTL = 14 * 24 * 60 * 60
+
+  attr_reader :redis
+  attr_accessor :default_ttl
+  attr_accessor :prefix
+  attr_reader :created_value
+
+  def initialize(args = {}, opts = {})
+    @redis = if args.nil? || args.is_a?(Hash)
+               init_params(args)
+               Redis.new(args)
+             else
+               init_params(opts)
+               args
+             end
+
+    @default_ttl ||= DEFAULT_TTL
+  end
+
+  def create(owner, args = {})
+    raise 'owner should be specified' unless owner
+
+    token = args[:token] || generate_token
+    value = { owner: owner, at: Time.now }
+
+    payload = args[:payload]
+    value[:payload] = payload if payload
+
+    @created_value = value
+    key_ttl = args[:ttl] || @default_ttl
+
+    @redis.multi do |multi|
+      multi.set(token_to_key(token), Marshal.dump(value), ex: key_ttl)
+      multi.set(token_to_owner(owner, token), nil, ex: key_ttl)
+    end
+
+    token
+  end
+
+  def get(token, args = {})
+    key = token_to_key(token)
+    value = redis_get(key)
+    return unless value
+    return value if args[:slide_expire] === false
+
+    key_ttl = args[:ttl] || @default_ttl
+
+    @redis.multi do |multi|
+      multi.expire(key, key_ttl)
+      multi.expire(token_to_owner(value[:owner], token), key_ttl)
+    end
+
+    value
+  end
+
+  def set(token, args = {})
+    key = token_to_key(token)
+    value = redis_get(key)
+    return false unless value
+    value[:payload] = args[:payload]
+
+    key_ttl = args[:ttl] || @redis.ttl(key)
+
+    @redis.multi do |multi|
+      multi.set(key, Marshal.dump(value), ex: key_ttl)
+      multi.expire(token_to_owner(value[:owner], token), key_ttl)
+    end
+
+    true
+  end
+
+  def each(owner)
+    mask = "#{@prefix}#{owner}.*"
+
+    cursor = 0
+    loop do
+      cursor, r = @redis.scan(cursor, match: mask)
+      cursor = cursor.to_i
+
+      r.each do |key|
+        token = owner_key_to_token(owner, key)
+        yield(token, redis_get(token_to_key(token)))
+      end
+
+      break if cursor == 0
+    end
+  end
+
+  def del(token)
+    key = token_to_key(token)
+    value = redis_get(key)
+    return false unless value
+
+    @redis.multi do |multi|
+      multi.del(key)
+      multi.del(token_to_owner(value[:owner], token))
+    end
+
+    true
+  end
+
+  def ttl(token)
+    @redis.ttl(token_to_key(token))
+  end
+
+  private
+
+  def generate_token
+    SecureRandom.hex(16)
+  end
+
+  def init_params(args)
+    @default_ttl = args[:ttl]
+    @prefix = args[:prefix]
+  end
+
+  def token_to_key(token)
+    "#{@prefix}#{token}"
+  end
+
+  def token_to_owner(owner, token)
+    "#{@prefix}#{owner}.#{token}"
+  end
+
+  def owner_key_to_token(owner, key)
+    key.sub("#{@prefix}#{owner}.", '')
+  end
+
+  def redis_get(key)
+    value = @redis.get(key)
+    return unless value
+    Marshal.load(value)
+  end
+
+  def check_owner(owner)
+    raise 'owner should be specified' unless owner
+  end
+end

data/redis_token.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_token/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redis_token'
+  spec.version       = RedisToken::VERSION
+  spec.authors       = ['Artem Baikuzin']
+  spec.email         = ['ybinzu@gmail.com']
+
+  spec.summary       = %q{API tokens redis store}
+  spec.description   = %q{Create and get API tokens with redis}
+  spec.homepage      = 'https://github.com/ybinzu/redis_token'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|bin)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'redis', '~> 3.3', '>= 3.3.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.10', '>= 5.10.3'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1', '>= 1.1.14'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: redis_token
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Artem Baikuzin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.10.3
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.14
+description: Create and get API tokens with redis
+email:
+- ybinzu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_token.rb
+- lib/redis_token/version.rb
+- redis_token.gemspec
+homepage: https://github.com/ybinzu/redis_token
+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.6.11
+signing_key: 
+specification_version: 4
+summary: API tokens redis store
+test_files: []