touth 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3243842c543225dafceb1545e223483c2f11f5fb
-  data.tar.gz: 0a65f14199beb54d4caa93fc19577f8735990695
+  metadata.gz: a982bb3f2804af9044cbc34c112d9e9169e2c060
+  data.tar.gz: 69d657f673a36d5145ce472dd03f83ef005f2ede
 SHA512:
-  metadata.gz: 1e56041575848b677690f060d0cd4754de45364bad6993595e86311a2ce9a3d64780104bac905d73e9349a6f28c91a9b41f94da670a9099564de52be46fcb26c
-  data.tar.gz: aed84cb2d72a030d2def511f9f5719718e6e3e7c787a7acccead1da5ed7cd954e47e79bea47a221fe3a1d8e774c0d6d91e2c6dc2b1248ac047b8ea55251109ca
+  metadata.gz: 01374f38683aafa8ea082f89e4a376fcf204ae116fa4416583f18480e7644250ec2e716dbd9c68be7f0d65dafa1a1f7866aa23850ac1d78301cfc4c10dee2615
+  data.tar.gz: d43b3269705ba47bef2ec31a2ed958a5bcade63732cf27ff840f7cb2a835de0818357cfa34d21d44c726ce8846694e22b90811e4c6a398a5372410ac9104f298

data/README.md

@@ -3,7 +3,10 @@ Touth
 
 Secure and simple token based authentication for Rails.
 
-No dependencies. No migration necessary. Session-less.
+- No extra dependencies
+- No migrations necessary
+- Store-less access token verification
+- Flexible lifetime
 
 
 Getting started
@@ -11,7 +14,7 @@ Getting started
 
 Touth works with Rails 3.x and 4.x. Add this line to Gemfile:
 
-```rub
+```ruby
 gem 'touth'
 ```
 
@@ -59,7 +62,17 @@ Usage
 ```ruby
 user_account = UserAccount.first
 
-user_account.access_token
+
+# create access token for default lifetime
+t1 = user_account.access_token  #=> "9619feb4b8d54352ae07588d011da48385c8c4f072ab889d3996d127ad2142fc6213d553"
+
+
+# create token expires in 20 secounds
+t2 = user_account.access_token 20  #=> "ad60fa5bb2d05e72ac943c6d409e18e6cc24c15eae9833f66c8aab391241475fe2bd0954"
+
+user_account.valid_access_token? t2  #=> true
+sleep 20
+user_account.valid_access_token? t2  #=> false
 ```
 
 ### Authentication by request headers
@@ -69,6 +82,16 @@ X-Auth-ID: 1
 X-Auth-Token: 9619feb4b8d54352ae07588d011da48385c8c4f072ab889d3996d127ad2142fc6213d553
 ```
 
+### Invalidation
+
+**1. Invalidate all old access token**
+
+Change `client_secret_key` in initializer.
+
+**2. Invalidate all old access token of specific user**
+
+Owner (an user) can do with changing his password.
+
 
 Configuation
 ------------
@@ -77,9 +100,20 @@ Touth can be customized with an initializer in `config/initializers/touth.rb`.
 
 ```ruby
 Touth.setup do |config|
+
+  # Default lifetime of access token.
   config.access_token_lifetime = 60.days
-  config.client_secret_key     = ''  # use SecureRandom.hex(64) to generate one
-  config.password_field        = :encrypted_password  # works nice with devise
+
+  # Secret key is used for verifying the integrity of access token.
+  # If you change this key, all old access token will become invalid.
+  # You can use rake secret or SecureRandom.hex(64) to generate one.
+  config.client_secret_key = ''
+
+  # Password field in your model.
+  # Owner can invalidate all old access token by changing owner's password.
+  # :encrypted_password will work nice with devise model.
+  config.password_field = :encrypted_password
+
 end
 ```
 
@@ -92,15 +126,15 @@ Contributions are always welcome!
 ### Bug reports
 
 1. Ensure the bug can be reproduced on the latest master.
-2. Check it's not a duplicate.
-3. Raise an issue.
+1. Check it's not a duplicate.
+1. Raise an issue.
 
 
 ### Pull requests
 
 1. Fork the repository.
-2. Create a branch.
-6. Create a new pull request.
+1. Create a branch.
+1. Create a new pull request.
 
 
 License

data/lib/touth.rb

@@ -31,20 +31,25 @@ module Touth
   class << self
 
     def setup
-      @configuration ||= Configuration.new
-      yield @configuration if block_given?
+      @config ||= Configuration.new
+      yield @config if block_given?
+    end
+
+    def digest(data)
+      @digest_method ||= OpenSSL::Digest.new 'sha256'
+      OpenSSL::HMAC.digest @digest_method, self.client_secret_key, data
     end
 
     def method_missing(method_name, *args, &block)
-      if @configuration.respond_to? method_name
-        @configuration.send method_name, *args, &block
+      if @config.respond_to? method_name
+        @config.send method_name, *args, &block
       else
         super
       end
     end
 
     def respond_to?(method_name, include_private = false)
-      @configuration.respond_to? method_name
+      @config.respond_to? method_name
     end
 
   end

data/lib/touth/acts_as_token_authenticatable.rb

@@ -29,8 +29,7 @@ module Touth
         self.send(Touth.password_field),
       ].join ':'
 
-      digest = OpenSSL::Digest.new 'sha256'
-      OpenSSL::HMAC.digest digest, Touth.client_secret_key, raw
+      Touth.digest raw
     end
 
   end

data/lib/touth/version.rb

@@ -1,3 +1,3 @@
 module Touth
-  VERSION = '0.0.2'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: touth
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Yuki Iwanaga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-07 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport