token_secret_auth 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eb919fd271312c8f4bc8eb9ad88f9df541e067f
-  data.tar.gz: b6baf874507a1c6f3660606a59514a5112839ab8
+  metadata.gz: a4a7992e33456c0ba7987304bfc6f6c10bf4c4af
+  data.tar.gz: 3d59ed947dab5ccf6a28c6b443074ab292b06201
 SHA512:
-  metadata.gz: f841553378bbf8e844dc24f0c047b5142c42f3a959b7c10f3d89569ca64c7e67db5e488a1de2b39ab2632cfbbab0a6a328ba678eec385851da9ea7912d4aa6e2
-  data.tar.gz: d97252337e1a6211273013af52c55856f3c79aff3b99698bf7fd5f5bc07cfdcf1671d09fe8d63c70534f626330ccd1b6026728662a33486d91e8289632bcce23
+  metadata.gz: 2c64ca8c0699bcacb8c559db10e301af58fcbbd9978da0b755b86850a74162cbc9335a896bf26c11a51b97763e3e951b1d9133b4fb61a849b02489b2b3ba9a92
+  data.tar.gz: 8f51df3f7c2dba055cfae7fadab7d87c4af07bfdd882d8cd764206657379dc756aafc681a2795d6af159cc527e9e93cd9ae07f8b21ab0b7b8285f68122b410e5

data/README.md

@@ -46,16 +46,14 @@ In your model file add:
 
     include TokenSecretAuth
 
-This grants your model instances the following methods: 
-
-    #token, #decode_token, #generate_secret
+> This grants your model instances the following methods: `#token, #decode_token, #generate_secret`
 
 Also add to the model:
 
     has_secure_password
 
 Create and run a migration to add the `password_digest` field to your model.  
-For example on rails: 
+For example on rails:
 
     $ rails generate migration AddPasswordDigestToApiClients password_digest:string
     
@@ -63,7 +61,7 @@ Note: you do not need a 'token' field on your model.  `#token` is a virtual attr
 
 ## Usage
 
-#### Generating a token
+#### Getting the token
 
 Tokens are generated from the model ID.
 
@@ -77,21 +75,19 @@ Secrets are randomly generated by `Model.generate_secret` or `#generate_secret`.
 Store the secret using `#password=` or similar encrypted functionality.
 
 ```ruby
-client = ApiClient.find_by_token('afuoisjdjl')
+client = ApiClient.find_by_token('afuoisjdjl') # or  ApiClient.new
 client.password = client.generate_secret
 client.save # bcrypt/has_secure_password will handle encryption
 ```
 
-On Rails you may want to simply generate the password using active record callbacks:
+On Rails you may want to use callbacks to generate the password automatically:
 
 ```ruby
-  before_validation :set_secret, on: [ :new, :create ]
-
-  def set_secret
-    self.password = generate_secret
-  end
+  before_validation :generate_secret, on: [ :new, :create ]
 ```
 
+> Calling `generate_secret` on an instance will automatically set password to the new secret.
+
 
 #### Passing token+secret to client
 
@@ -133,13 +129,13 @@ end
   end
 end
 ```
-
+<!--
 Headers are an even better way to pass authentication tokens.  **TODO:**
 
 ```ruby
 
 ```
-
+-->
 
 #### salt
 

data/lib/token_secret_auth/base.rb

@@ -41,9 +41,9 @@ module TokenSecretAuth
       decoded = TokenSecretAuth.hash_id.decode(token).first
     end
 
-    # .find_with_token
+    # .find_by_token
     # Use on model files to find a particular instance based on the token (hashed ID)
-    def find_with_token(token)
+    def find_by_token(token)
       begin
         find(decode_token(token))
       rescue Hashids::InputError
@@ -55,7 +55,7 @@ module TokenSecretAuth
     # .authenticate_by_credentials
     # finds correct instance by its token and then authenticates the password for that instance
     def authenticate_by_credentials(token, secret=nil)
-      account = find_with_token(token)
+      account = find_by_token(token)
       # note BCrypt's authenticate will return false or the object when matched
       if account
         account.authenticate(secret)

data/lib/token_secret_auth/version.rb

@@ -1,3 +1,3 @@
 module TokenSecretAuth
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/token_secret_auth.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["tgaff@alumni.nd.edu"]
 
   spec.summary       = %q{Simple token+secret authentication gem.}
-  spec.description   = %q{Simple token + secret authentication gem with encrypted secrets.}
+  spec.description   = %q{Simple token+secret authentication gem for use with has_secure_password for one-way encrypted secrets.}
   spec.homepage      = "https://github.com/tgaff/token_secret_auth"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: token_secret_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - tgaff
@@ -80,7 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-description: Simple token + secret authentication gem with encrypted secrets.
+description: Simple token+secret authentication gem for use with has_secure_password
+  for one-way encrypted secrets.
 email:
 - tgaff@alumni.nd.edu
 executables: []