tiny_auth 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a857ca2f5a5570a3c6eeeb44c38f181b6e65cd5a
-  data.tar.gz: ce6eda4d395ec74c98837fe4ebb92fb03be5e6aa
+SHA256:
+  metadata.gz: d2c08fa6193667861a991bb4442e3669e32d559a8fd6de39001e9bcef25857f0
+  data.tar.gz: 7edd1dc4569763af9f68e19066bcc1c0f8d273976f123d01b0a2439414fdd5ae
 SHA512:
-  metadata.gz: 421a42289951a95406cb3b06e29339e5e9d35bb08d09a2933f112b110df28647c0cc6b139b6f934f62a7173cb56f545bb0e063ae92efbd19c6814ea43ff59472
-  data.tar.gz: 72e2a5ab7f10ef4ab1db43ca70b3ae56e0bf6ed4515277362f644ab538935937ea8d37ca22ffc62e0fe676f1170956e2340d860d47e2406297cadab0149f68b9
+  metadata.gz: ce1f2b71ff644335d65683a044f75280f89bc752b7cd0754d5103ce93b921d051a8fdcc5b7298cec43d32fa516eb0ae03ab6f3a181cab2724a59715d59fb4beb
+  data.tar.gz: ecfe0672b60c176ea9e8687cb5690af60207814da193a08ec4a7800bad2da3743667061768ce7a245a4557862a6cb3a1ea0d01d4619f88a57c1e271c1a7dd7e6

data/Gemfile

@@ -2,3 +2,4 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in tiny_auth.gemspec
 gemspec
+gem 'simplecov', require: false, group: :test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tiny_auth (0.1.1)
+    tiny_auth (0.1.2)
       activerecord (~> 6.0)
       activesupport (~> 6.0)
       globalid (~> 0.4)
@@ -23,10 +23,12 @@ GEM
     bcrypt (3.1.13)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
+    docile (1.3.2)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.7.0)
       concurrent-ruby (~> 1.0)
+    json (2.2.0)
     minitest (5.13.0)
     rake (10.5.0)
     rspec (3.9.0)
@@ -42,6 +44,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sqlite3 (1.4.1)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
@@ -56,6 +63,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov
   sqlite3 (~> 1.4)
   tiny_auth!
 

data/README.md

@@ -1,4 +1,4 @@
-# TinyAuth
+# TinyAuth [![Build Status](https://travis-ci.org/rzane/tiny_auth.svg?branch=master)](https://travis-ci.org/rzane/tiny_auth)
 
 A utility for minimal user authentication.
 
@@ -54,13 +54,15 @@ user = auth.exchange_reset_token(user, password: "changed")
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies.
+
+Then, run `bundle exec rspec` to run the tests.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tiny_auth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rzane/tiny_auth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -68,4 +70,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the TinyAuth project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tiny_auth/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the TinyAuth project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rzane/tiny_auth/blob/master/CODE_OF_CONDUCT.md).

data/lib/tiny_auth/version.rb

@@ -1,3 +1,3 @@
 class TinyAuth
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/tiny_auth.rb

@@ -4,16 +4,17 @@ require "active_record"
 require "active_support/core_ext/securerandom"
 
 class TinyAuth
-  class Error < StandardError; end
-  class PersistError < StandardError; end
-
-  def initialize(model, scope: model)
+  def initialize(model, scope: model, secret: secret_key_base)
     @model = model
     @scope = scope
+    @secret = secret
+
+    raise ArgumentError, "missing argument: model" if model.nil?
+    raise ArgumentError, "missing keyword: secret" if secret.nil?
   end
 
   def find_by_email(email)
-    @scope.find_by(@model.arel_table[:email].lower.eq(email.downcase))
+    scope.find_by(model.arel_table[:email].lower.eq(email.downcase))
   end
 
   def find_by_credentials(email, password)
@@ -30,32 +31,46 @@ class TinyAuth
   rescue ActiveRecord::RecordNotFound
   end
 
-  def generate_reset_token(resource, expires_in: 2.hours)
-    update_reset(
-      resource,
-      reset_token: SecureRandom.base58(24),
-      reset_token_expires_at: Time.now + expires_in
+  def generate_reset_token(resource, **opts)
+    generate_single_use_token(resource, purpose: :reset, **opts)
+  end
+
+  def generate_single_use_token(resource, purpose:, expires_in: 2.hours)
+    token = SecureRandom.base58(24)
+
+    resource.update!(
+      "#{purpose}_token" => hmac(token),
+      "#{purpose}_token_expires_at" => expires_in.from_now
     )
 
-    resource.reset_token
+    token
   end
 
-  def exchange_reset_token(reset_token, changes = {})
-    changes = changes.merge(reset_token: nil, reset_token_expires_at: nil)
-    not_expired = @model.arel_table[:reset_token_expires_at].gt(Time.now)
-    resource = @scope.where(not_expired).find_by(reset_token: reset_token)
+  def exchange_reset_token(token, **opts, &block)
+    exchange_single_use_token(token, purpose: :reset, **opts, &block)
+  end
 
-    yield resource if resource && block_given?
-    update_reset(resource, changes) if resource
+  def exchange_single_use_token(token, purpose:, update: {})
+    not_expired = model.arel_table[:"#{purpose}_token_expires_at"].gt(Time.now)
+    resource = scope.where(not_expired).find_by(:"#{purpose}_token" => hmac(token))
+
+    return if resource.nil?
+    yield resource if block_given?
+
+    resource.assign_attributes(update)
+    resource.update!("#{purpose}_token" => nil, "#{purpose}_token_expires_at" => nil)
+    resource
   end
 
   private
 
-  def update_reset(resource, changes)
-    if resource.update(changes)
-      resource
-    else
-      raise PersistError, "Failed to reset password."
-    end
+  attr_reader :model, :scope, :secret
+
+  def hmac(value)
+    OpenSSL::HMAC.hexdigest("SHA256", secret, value)
+  end
+
+  def secret_key_base
+    Rails.application.secret_key_base if defined?(Rails)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ray Zane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2019-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -138,8 +138,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/tiny_auth.rb
 - lib/tiny_auth/version.rb
 - tiny_auth.gemspec
@@ -165,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Bare-minimum authentication for APIs

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "tiny_auth"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here