hirameki 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.rvmrc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,6 @@
+script: bundle exec rspec spec
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - jruby-head

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+
+## 0.1.0
+
+ * Released the first version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hirameki.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yuki Nishijima
+
+MIT License
+
+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,52 @@
+# Hirameki ![build status](https://secure.travis-ci.org/yuki24/hirameki.png)
+
+Hirameki is a one-time token generator backed by Redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hirameki'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hirameki
+
+If you use Hirameki with Rails, put the following in `config/initializers/`.
+
+```ruby
+Hirameki.configure do |config|
+  config.redis = Redis.new(host: "localhost", port: 6379)
+  config.pepper = "put_a_long_pepper_in_here"
+  config.expiration_time = 10.minutes
+end
+```
+
+## Usage
+
+it's super easy to use Hirameki. Give it a try on irb/pry!
+
+```
+ > token = Hirameki.generate!(10)
+=> "4dc6d4ca42e5204ab2d9cb5a0e0a8ec715c7d152"
+ > Hirameki.get(token)
+=> 10
+```
+
+Thas't it!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2011 Yuki Nishijima. See LICENSE.md for further details.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/hirameki.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hirameki/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yuki Nishijima"]
+  gem.email         = ["mail@yukinishijima.net"]
+  gem.description   = %q{redis based one time token generator.}
+  gem.summary       = %q{redis based one time token generator.}
+  gem.homepage      = "https://github.com/yuki24/hirameki"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "hirameki"
+  gem.require_paths = ["lib"]
+  gem.version       = Hirameki::VERSION
+
+  gem.add_dependency 'redis', '~> 2.2.2'
+  gem.add_development_dependency 'rspec'
+end

data/lib/hirameki.rb

@@ -0,0 +1,40 @@
+require "hirameki/config"
+require "hirameki/version"
+
+module Hirameki
+  extend self
+
+  def configure
+    @config = Hirameki::Config.new
+    yield(@config)
+  end
+
+  def config
+    @config
+  end
+
+  def get(key)
+    val = @config.redis.get(key)
+    val.nil? ? val : val.to_i
+  end
+
+  def del(key)
+    @config.redis.del(key).to_i
+  end
+
+  def generate!(value)
+    gen_key(value).tap do |key|
+      if @config.expiration_time.nil?
+        @config.redis.set(key, value)
+      else
+        @config.redis.setex(key, @config.expiration_time, value)
+      end
+    end
+  end
+
+  private
+
+  def gen_key(value)
+    Digest::SHA1.hexdigest("#{@config.pepper}#{Time.now.to_i}#{value}")
+  end
+end

data/lib/hirameki/config.rb

@@ -0,0 +1,51 @@
+require 'redis'
+
+module Hirameki
+  class Config
+    attr_accessor :pepper, :expiration_time
+
+    # Accepts:
+    #   1. A 'hostname:port' String
+    #   2. A 'hostname:port:db' String (to select the Redis db)
+    #   3. A 'hostname:port/namespace' String (to set the Redis namespace)
+    #   4. A Redis URL String 'redis://host:port'
+    #   5. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`,
+    #      or `Redis::Namespace`.
+    def redis=(server)
+      case server
+      when String
+        if server =~ /redis\:\/\//
+          redis = Redis.connect(url: server, thread_safe: true)
+        else
+          server, namespace = server.split('/', 2)
+          host, port, db = server.split(':')
+          redis = Redis.new(host: host, port: port, thread_safe: true, db: db)
+        end
+        @redis = redis
+      when Redis, Redis::Namespace
+        @redis = server
+      else
+        @redis = Redis.new(host: "localhost", port: 6379)
+      end
+    end
+
+    # Returns the current Redis connection. If none has been created, will
+    # create a new one.
+    def redis
+      return @redis if @redis
+      self.redis = Redis.respond_to?(:connect) ? Redis.connect : "localhost:6379"
+    end
+
+    def redis_id
+      # support 1.x versions of redis-rb
+      if redis.respond_to?(:server)
+        redis.server
+      elsif redis.respond_to?(:nodes) # distributed
+        redis.nodes.map { |n| n.id }.join(', ')
+      else
+        redis.client.id
+      end
+    end
+  end
+end
+  

data/lib/hirameki/version.rb

@@ -0,0 +1,3 @@
+module Hirameki
+  VERSION = "0.1.0"
+end

data/spec/hirameki_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Hirameki do
+  describe "confgiruration setup" do
+    context "full configuration" do
+      before(:all) do
+        Hirameki.configure do |config|
+          config.redis = Redis.new(host: "localhost", port: 6379)
+          config.pepper = "tapyokGajivijabroirnajvilphOcyij"
+          config.expiration_time = 60 * 10
+        end
+      end
+
+      subject { Hirameki.config }
+      its(:redis) { should be_a(Redis) }
+      its(:pepper) { should == "tapyokGajivijabroirnajvilphOcyij" }
+      its(:expiration_time) { should == 600 }
+    end
+  end
+
+  describe "generation of token" do
+    module Hirameki
+      extend self
+
+      def stub_setex!
+        @config.redis.should_not_receive(:setex)
+      end
+
+      def stub_set!
+        @config.redis.should_not_receive(:set)
+      end
+    end
+
+    describe "token generation with expiration time" do
+      before(:all) do
+        Hirameki.configure do |config|
+          config.redis = Redis.new(host: "localhost", port: 6379)
+          config.pepper = "tapyokGajivijabroirnajvilphOcyij"
+        end
+        Hirameki.config.redis.flushdb
+      end
+
+      it "should not expire any keys" do
+        Hirameki.stub_setex!
+        key = Hirameki.generate!(1)
+        Hirameki.get(key).should == 1
+        Hirameki.del(key).should == 1
+      end
+    end
+
+    describe "token generation without expiration time" do
+      before(:all) do
+        Hirameki.configure do |config|
+          config.redis = Redis.new(host: "localhost", port: 6379)
+          config.pepper = "tapyokGajivijabroirnajvilphOcyij"
+          config.expiration_time = 1
+        end
+        Hirameki.config.redis.flushdb
+      end
+
+      it "should expire any keys in 1 second" do
+        Hirameki.stub_set!
+        key = Hirameki.generate!(1)
+        sleep(2)
+        Hirameki.get(key).should be_nil
+        Hirameki.del(key).should == 0
+      end
+    end
+
+    describe "invalid key" do
+      it "should add the given value to redis and return its key" do
+        key = Hirameki.generate!(1)
+        Hirameki.get(key).should == 1
+      end
+
+      it "should return 0 when there is no key in redis" do
+        Hirameki.get(10).should be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'hirameki'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+# Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: hirameki
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Yuki Nishijima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &14647800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *14647800
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &14609140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14609140
+description: redis based one time token generator.
+email:
+- mail@yukinishijima.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- hirameki.gemspec
+- lib/hirameki.rb
+- lib/hirameki/config.rb
+- lib/hirameki/version.rb
+- spec/hirameki_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yuki24/hirameki
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: redis based one time token generator.
+test_files: []