credible 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d6dd4c9c8938ea1d5f514345aa9162f6166741ae0f27150dd2a550b0050b768
-  data.tar.gz: 32f2f6cfa0c9a866651f1e4aff84f80a92535d4ba33d622c6db7892494da5310
+  metadata.gz: 78167188c05b03d8745a6895582115a8bc9a7e907746d363d853c0b66007642e
+  data.tar.gz: 216308cfe275a979d556b611fab6df86e54344f50799112b9c694c18af9e2b33
 SHA512:
-  metadata.gz: 16d03bc6fb963514d1bca0151f3fb104ef4bcfad484d93e97eccc3593fc3a501cb9c8170fd262d519b34bfc42a250628827ff6bac4938a75d568e450bb9e5e56
-  data.tar.gz: 9eb3b99c201cb5781d1bc32e57964c874bf65e8a9aeef1f9ec83f4870a9cd44e41fdc4622e93e3fa7a0c0af9b2b707e4e08e101051afda92df3ca146edc3f3b6
+  metadata.gz: e4a3329ad3a8f108cb8e5a90849ef215dea4d628891c4bbf8535087511ae89e71f6509210153df363a16074a6480b40d00c8a19dffcab1494db6d2ba299d2299
+  data.tar.gz: f3de667f740c74484648a7d2a658c64c0f37c8aeb33d8fbf947d5a21fa6ab38d9534f755e4694c7592d64423ea0fc73c2a38891b3038f57585a0ce12fd304a23

data/README.md

@@ -1,10 +1,15 @@
 # Credible
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+[![Become a Patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/thombruce)
+
+[![Gem](https://img.shields.io/gem/v/credible?logo=rubygems)](https://rubygems.org/gems/credible)
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](MIT-LICENSE)
+
+Credible was extracted from [thombruce/helvellyn](https://github.com/thombruce/helvellyn) and is still a work in progress. The goal is to provide JWT and API token based authentication using [Warden](https://github.com/wardencommunity/warden/) for Rails API applications.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -16,13 +21,112 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
+Mount Credible's authentication routes in your `config/routes.rb` file:
+
+```ruby
+Rails.application.routes.draw do
+  mount Credible::Engine => "/auth"
+end
+```
+
+Credible is a work in progress and requires a complicated setup for now. It was extracted from [thombruce/helvellyn](https://github.com/thombruce/helvellyn). You'll need to add models and configure them manually. In future, I'll had helpers to handle this for you.
+
+## Add Models
+
+To get Credible working, your app will need at least a User model and a Session model.
+
+### User model
+
 ```bash
-$ gem install credible
+rails g model User email:string:uniq password_digest:string confirmation_token:token confirmed_at:datetime
+```
+
+```ruby
+class User < ApplicationRecord
+  has_secure_password validations: false
+  has_secure_token :confirmation_token
+
+  has_many :sessions, dependent: :destroy
+
+  validates :email, presence: true
+  validates :email, format: { with: URI::MailTo::EMAIL_REGEXP }
+
+  # Custom password validation
+  validate do |record|
+    record.errors.add(:password, :blank) unless record.password_digest.present? || record.confirmation_token.present?
+  end
+
+  validates_length_of :password, maximum: ActiveModel::SecurePassword::MAX_PASSWORD_LENGTH_ALLOWED
+  validates_confirmation_of :password, allow_blank: true
+  # End custom password validation
+
+  def self.authenticate(params)
+    user = find_by_login(params[:login])
+    user&.authenticate(params[:password])
+  end
+
+  def confirm
+    self.confirmation_token = nil
+    self.password = SecureRandom.hex(8) unless password_digest.present?
+    self.confirmed_at = Time.now.utc
+  end
+
+  def confirmed?
+    confirmed_at.present?
+  end
+
+  def reset_password
+    self.password_digest = nil
+    self.confirmed_at = nil
+    regenerate_confirmation_token
+  end
+end
+```
+
+### Session model
+
+```bash
+rails g model Session user:references token:token
+```
+
+```ruby
+class Session < ApplicationRecord
+  belongs_to :user
+
+  has_secure_token
+
+  def self.authenticate(params)
+    user = User.authenticate(params)
+    new(user: user)
+  end
+
+  def jwt
+    payload = {
+      data: jwt_data,
+      iss: 'Helvellyn'
+    }
+    JWT.encode payload, Rails.application.secrets.secret_key_base, 'HS256' # [1]
+  end
+
+  private
+
+  def jwt_data
+    {
+      session_id: id,
+      user_id: user.id,
+      user: {
+        id: user.id,
+        email: user.email
+      }
+    }
+  end
+end
 ```
 
 ## Contributing
-Contribution directions go here.
+
+Credible is not yet accepting contributions. Watch this space.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/credible/version.rb

@@ -1,3 +1,3 @@
 module Credible
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: credible
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Thom Bruce
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta3
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta3
+        version: 3.9.0
 description: Provides token-based authentication for Rails API apps.
 email:
 - thom@thombruce.com
@@ -93,11 +93,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/credible_manifest.js
-- app/assets/stylesheets/credible/application.css
 - app/controllers/credible/application_controller.rb
 - app/controllers/credible/authentication/sessions_controller.rb
 - app/controllers/credible/authentication/users_controller.rb
@@ -125,10 +122,11 @@ files:
 - lib/credible/engine.rb
 - lib/credible/version.rb
 - lib/tasks/credible_tasks.rake
-homepage: https://thombruce.com/
+homepage: https://github.com/thombruce/credible
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/example/example
 post_install_message: 
 rdoc_options: []
 require_paths:

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2020 Thom Bruce
-
-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/app/assets/config/credible_manifest.js

@@ -1 +0,0 @@
-//= link_directory ../stylesheets/credible .css

data/app/assets/stylesheets/credible/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */