credible 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d4f048f4ef29cbbf167e6425f4588cc58da3a57c6c4c42b460f13a486d47de1
+  data.tar.gz: 18f2f860fe62f1d597936c7b282231f9dfb9b3079b52d4a427bc9831447b8ca0
+SHA512:
+  metadata.gz: 8fd4f87bff69258e892b7591e41d223c57cb6806bfa5e1c60c893546a9dbc3adbcdf5c5788f82d3955ec5a527f378b8554cf212288430bdb61108caeaffa9cbc
+  data.tar.gz: f09499fb6fae982e693e4ab59f852bedc66a6dc66142a67bc89afbb81ac985bb573ac116832a65b22825a7290d6d15847feb4d085726487ba9ee2c3ce92c062c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+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/README.md

@@ -0,0 +1,28 @@
+# Credible
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'credible'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install credible
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Credible'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/config/credible_manifest.js

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

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

@@ -0,0 +1,15 @@
+/*
+ * 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
+ */

data/app/controllers/credible/application_controller.rb

@@ -0,0 +1,43 @@
+module Credible
+  class ApplicationController < ActionController::Base
+    skip_before_action :verify_authenticity_token
+
+    include Pundit
+    after_action :verify_authorized
+    after_action :verify_policy_scoped, only: :index
+
+    rescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
+    rescue_from Pundit::NotDefinedError, with: :user_not_authorized
+
+    before_action :authenticate!, if: proc { request.env['HTTP_AUTHORIZATION'] || request.env['HTTP_API_TOKEN'] }
+
+    helper_method :current_user
+    helper_method :current_session
+
+    def pundit_user
+      current_session
+    end
+
+    def current_user
+      current_session.user
+    end
+
+    def current_session
+      warden.user(:session) || Session.new(user: nil)
+    end
+
+    def warden
+      request.env['warden']
+    end
+
+    def authenticate!
+      warden.authenticate!
+    end
+
+    private
+
+    def user_not_authorized
+      render json: {}.to_json, status: :forbidden
+    end
+  end
+end

data/app/controllers/credible/authentication/sessions_controller.rb

@@ -0,0 +1,51 @@
+class Credible::Authentication::SessionsController < Credible::AuthenticationController
+  before_action :set_session, only: [:show, :destroy]
+
+  skip_before_action :authenticate!, only: [:new, :create]
+
+  # GET /sessions
+  # GET /sessions.json
+  def index
+  end
+
+  # GET /sessions/1
+  # GET /sessions/1.json
+  def show
+  end
+
+  # GET /sessions/new
+  def new
+    @session = Session.new
+    authorize @session
+  end
+
+  # POST /sessions
+  # POST /sessions.json
+  def create
+    @session = Session.authenticate(permitted_attributes(Session))
+    authorize @session
+
+    if @session.save
+      render :show, status: :created, location: @session
+    else
+      render json: @session.errors, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE /sessions/1
+  # DELETE /sessions/1.json
+  # DELETE /sessions/current
+  # DELETE /sessions/current.json
+  def destroy
+    warden.logout
+    @session.destroy
+    head :no_content
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_session
+      @session = current_session
+      authorize @session
+    end
+end

data/app/controllers/credible/authentication/users_controller.rb

@@ -0,0 +1,91 @@
+class Credible::Authentication::UsersController < Credible::AuthenticationController
+  before_action :set_user, only: [:show, :edit, :update, :destroy]
+
+  skip_before_action :authenticate!, only: [:new, :create, :confirm]
+
+  # GET /users/1
+  # GET /users/1.json
+  def show
+  end
+
+  # GET /users/new
+  def new
+    @user = User.new
+    authorize @user
+  end
+
+  # POST /users
+  # POST /users.json
+  def create
+    @user = User.new(permitted_attributes(User))
+    authorize @user
+
+    if @user.save
+      Credible::UserMailer.with(user: @user).confirmation_email.deliver_later
+      @session = Session.create(user: @user)
+      render :show, status: :created, location: @user
+    else
+      render json: @user.errors, status: :unprocessable_entity
+    end
+  end
+
+  # GET /users/confirm/:confirmation_token
+  # GET /users/confirm/:confirmation_token.json
+  def confirm
+    @user = User.find_by(confirmation_token: params[:confirmation_token])
+    authorize @user
+
+    @user.confirm
+
+    if @user.save
+      @session = current_user ? current_session : Session.create(user: @user)
+      render :show, status: :created, location: @user
+    else
+      render json: @user.errors, status: :unprocessable_entity
+    end
+  end
+
+  # POST /users/reset_password
+  # POST /users/reset_password.json
+  def reset_password
+    @user = User.find_by(email: permitted_attributes(User)[:email])
+    authorize @user
+
+    @user.reset_password
+
+    if @user.save
+      Credible::UserMailer.with(user: @user).confirmation_email.deliver_later
+      render :show, status: :ok, location: @user
+    else
+      render json: @user.errors, status: :unprocessable_entity
+    end
+  end
+
+  # GET /users/1/edit
+  def edit
+  end
+
+  # PATCH/PUT /users/1
+  # PATCH/PUT /users/1.json
+  def update
+    if @user.update(permitted_attributes(@user))
+      render :show, status: :ok, location: @user
+    else
+      render json: @user.errors, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE /users/1
+  # DELETE /users/1.json
+  def destroy
+    @user.destroy
+    head :no_content
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_user
+      @user = current_user
+      authorize @user
+    end  
+end

data/app/controllers/credible/authentication_controller.rb

@@ -0,0 +1,16 @@
+class Credible::AuthenticationController < Credible::ApplicationController
+  # TODO: Authentication module is now redundant inside Credible Engine.
+  #       Migrate out of namespace.
+
+  def policy_scope(scope)
+    super([:credible, :authentication, scope])
+  end
+
+  def authorize(record, query = nil)
+    super([:credible, :authentication, record], query)
+  end
+
+  def permitted_attributes(record, action = action_name)
+    super([:credible, :authentication, record], action)
+  end
+end

data/app/helpers/credible/application_helper.rb

@@ -0,0 +1,4 @@
+module Credible
+  module ApplicationHelper
+  end
+end

data/app/jobs/credible/application_job.rb

@@ -0,0 +1,4 @@
+module Credible
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/credible/application_mailer.rb

@@ -0,0 +1,6 @@
+module Credible
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/mailers/credible/user_mailer.rb

@@ -0,0 +1,21 @@
+class Credible::UserMailer < Credible::ApplicationMailer
+  # TODO: Decouple from Settings in inheriting application.
+  # QUESTION: How then will we set the URL?
+
+  include Rails.application.routes.url_helpers
+
+  def confirmation_email
+    @settings = Settings.instance
+    @user = params[:user]
+    @url  = root_url(host: @settings.hostname)
+    @confirmation_url = @url + 'confirm/' + @user.confirmation_token
+    mail(from: @settings.email, to: @user.email, subject: "Welcome to #{@settings.name} | Please confirm your account")
+  end
+
+  def invitation_email
+    @settings = Settings.instance
+    @user = params[:user]
+    @url  = root_url(host: @settings.hostname)
+    mail(from: @settings.email, to: @user.email, subject: "You have been invited to #{@settings.name}")
+  end
+end

data/app/models/credible/application_record.rb

@@ -0,0 +1,5 @@
+module Credible
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/policies/credible/application_policy.rb

@@ -0,0 +1,61 @@
+module Credible
+  class ApplicationPolicy
+    attr_reader :session, :record
+
+    def initialize(session, record)
+      @session = session
+      @record = record
+    end
+
+    def index?
+      user
+    end
+
+    def show?
+      user
+    end
+
+    def create?
+      user
+    end
+
+    def new?
+      create?
+    end
+
+    def update?
+      user
+    end
+
+    def edit?
+      update?
+    end
+
+    def destroy?
+      user
+    end
+
+    # Helper Methods
+    def user
+      session.user
+    end
+
+    class Scope
+      attr_reader :session, :scope
+
+      def initialize(session, scope)
+        @session = session
+        @scope = scope
+      end
+
+      def resolve
+        scope.all
+      end
+
+      # Helper Methods
+      def user
+        session.user
+      end
+    end
+  end
+end

data/app/policies/credible/authentication/session_policy.rb

@@ -0,0 +1,9 @@
+class Credible::Authentication::SessionPolicy < Credible::AuthenticationPolicy
+  def permitted_attributes
+    [:login, :password]
+  end
+
+  def update?
+    user && user == record.user
+  end
+end

data/app/policies/credible/authentication/user_policy.rb

@@ -0,0 +1,17 @@
+class Credible::Authentication::UserPolicy < Credible::AuthenticationPolicy
+  def permitted_attributes
+    [:name, :email, :password]
+  end
+
+  def confirm?
+    true
+  end
+
+  def reset_password?
+    true
+  end
+
+  def update?
+    user && user == record
+  end
+end

data/app/policies/credible/authentication_policy.rb

@@ -0,0 +1,16 @@
+class Credible::AuthenticationPolicy < Credible::ApplicationPolicy
+  # Authentication concerns the User and their single instance.
+  # The rules that apply to update? will always apply to show?
+  # and destroy? too.
+  def show?
+    update?
+  end
+
+  def create?
+    !user
+  end
+
+  def destroy?
+    update?
+  end
+end

data/app/views/credible/authentication/sessions/_session.json.jbuilder

@@ -0,0 +1,5 @@
+json.extract! session, :id, :created_at, :updated_at
+
+json.jwt session.jwt
+
+# json.url session_url(session, format: :json)

data/app/views/credible/authentication/sessions/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "session", session: @session

data/app/views/credible/authentication/users/_user.json.jbuilder

@@ -0,0 +1,5 @@
+json.extract! user, :id, :name, :email, :created_at, :updated_at
+
+json.jwt @session.jwt if @session
+
+json.url user_url(user, format: :json)

data/app/views/credible/authentication/users/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "user", user: @user

data/app/views/credible/user_mailer/confirmation_email.html.haml

@@ -0,0 +1,11 @@
+%h1= "Welcome to #{@settings.name}, #{@user.name}"
+
+%p
+  = "You have successfully signed up to #{@settings.name}, your username is: #{@user.email}."
+  %br/
+
+%p
+  To confirm your account, please follow this link:
+  = link_to @confirmation_url, @confirmation_url
+
+%p Thanks for joining and have a great day!

data/app/views/credible/user_mailer/confirmation_email.text.haml

@@ -0,0 +1,9 @@
+= "Welcome to #{@settings.name}, #{@user.name}"
+\===============================================
+ 
+= "You have successfully signed up to #{@settings.name}, your username is: #{@user.email}."
+ 
+To confirm your account, please follow this link:
+= @confirmation_url
+ 
+Thanks for joining and have a great day!

data/app/views/credible/user_mailer/invitation_email.html.haml

@@ -0,0 +1,3 @@
+%h1= "You have been invited to #{@settings.name}"
+%p= "To login to the site, just follow this link: #{@url}."
+%p Thanks for joining and have a great day!

data/app/views/credible/user_mailer/invitation_email.text.haml

@@ -0,0 +1,6 @@
+= "You have been invited to #{@settings.name}"
+\===============================================
+ 
+= "To login to the site, just follow this link: #{@url}."
+ 
+Thanks for joining and have a great day!

data/config/initializers/warden.rb

@@ -0,0 +1,65 @@
+Rails.application.config.middleware.use Warden::Manager do |config|
+  config.failure_app = ->(env) { SessionsController.action(:new).call(env) } # TODO: Fix me.
+
+  config.default_scope = :session
+
+  config.scope_defaults :session, store: false, strategies: [:jwt, :api_token]
+end
+
+# TODO: See here for how Devise initializes Warden: https://github.com/heartcombo/devise/blob/715192a7709a4c02127afb067e66230061b82cf2/lib/devise/rails.rb
+#       It's also worth perusing the mention of 'warden' in the Devise repo. Interesting strategies at work.
+
+Warden::Strategies.add(:jwt) do
+  def valid?
+    env['HTTP_AUTHORIZATION']
+  end
+
+  def env
+    request.env
+  end
+
+  def authenticate!
+    begin
+      pattern = /^Bearer /
+      header = env['HTTP_AUTHORIZATION']
+      jwt = header.gsub(pattern, '') if header && header.match(pattern)
+      token =
+        JWT.decode jwt, Rails.application.secrets.secret_key_base, true,
+                   iss: 'Helvellyn', verify_iss: true, algorithm: 'HS256' # [1]
+    rescue JWT::InvalidIssuerError
+      fail!('Could not authenticate')
+    end
+
+    session = Session.find(token[0]['data']['session_id'])
+
+    session ? success!(session) : fail!('Could not authenticate')
+  end
+
+  def store?
+    false
+  end
+end
+
+Warden::Strategies.add(:api_token) do
+  def valid?
+    request.env['HTTP_API_TOKEN']
+  end
+
+  def env
+    request.env
+  end
+
+  def authenticate!
+    session = Session.find_by(token: env['HTTP_API_TOKEN'])
+    session ? success!(session) : fail!('Could not authenticate')
+  end
+
+  def store?
+    false
+  end
+end
+
+# [1] Use of `secrets` instead of `credentials` makes for a container-ready deploy on Heroku (easier setup for open source)
+#     Now that we've transitioned into an Engine, though, we should...
+# TODO: Use credentials if credentials is present, use secrets if secrets is present.
+#       Take a look at how devise achieves the same thing.

data/config/routes.rb

@@ -0,0 +1,22 @@
+Credible::Engine.routes.draw do
+  scope module: 'authentication', format: false, defaults: { format: 'json' } do
+    # /auth/login.json
+    post 'login', to: 'sessions#create'
+    # /auth/reset_password.json
+    post 'reset_password', to: 'users#reset_password'
+    # /auth/signup.json
+    post 'signup', to: 'users#create'
+    # /auth/confirm.json
+    get 'confirm/:confirmation_token', to: 'users#confirm'
+    # /auth/signout.json
+    delete 'signout', to: 'sessions#destroy'
+
+    # /auth/account/**/*.json
+    scope '/account' do
+      # /auth/account/sessions/*.json
+      resources :sessions, except: [:new, :create, :edit, :update]
+      # /auth/account/*.json
+      resource :user, path: '', except: [:new, :create]
+    end
+  end
+end

data/lib/credible.rb

@@ -0,0 +1,5 @@
+require "credible/engine"
+
+module Credible
+  # Your code goes here...
+end

data/lib/credible/engine.rb

@@ -0,0 +1,5 @@
+module Credible
+  class Engine < ::Rails::Engine
+    isolate_namespace Credible
+  end
+end

data/lib/credible/version.rb

@@ -0,0 +1,3 @@
+module Credible
+  VERSION = '0.1.0'
+end

data/lib/tasks/credible_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :credible do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: credible
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thom Bruce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+- !ruby/object:Gem::Dependency
+  name: warden
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta3
+description: Provides token-based authentication for Rails API apps.
+email:
+- thom@thombruce.com
+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
+- app/controllers/credible/authentication_controller.rb
+- app/helpers/credible/application_helper.rb
+- app/jobs/credible/application_job.rb
+- app/mailers/credible/application_mailer.rb
+- app/mailers/credible/user_mailer.rb
+- app/models/credible/application_record.rb
+- app/policies/credible/application_policy.rb
+- app/policies/credible/authentication/session_policy.rb
+- app/policies/credible/authentication/user_policy.rb
+- app/policies/credible/authentication_policy.rb
+- app/views/credible/authentication/sessions/_session.json.jbuilder
+- app/views/credible/authentication/sessions/show.json.jbuilder
+- app/views/credible/authentication/users/_user.json.jbuilder
+- app/views/credible/authentication/users/show.json.jbuilder
+- app/views/credible/user_mailer/confirmation_email.html.haml
+- app/views/credible/user_mailer/confirmation_email.text.haml
+- app/views/credible/user_mailer/invitation_email.html.haml
+- app/views/credible/user_mailer/invitation_email.text.haml
+- config/initializers/warden.rb
+- config/routes.rb
+- lib/credible.rb
+- lib/credible/engine.rb
+- lib/credible/version.rb
+- lib/tasks/credible_tasks.rake
+homepage: https://thombruce.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Rails token auth
+test_files: []