hanami_id 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7c1462211232ae391bbfefa7f3b2b4da5c7f4bef58ac22038fa5169eabbef28
-  data.tar.gz: d17638fc8ecb70c88f5cf1c37caf3f0659a037dfc061605bf6558705ab7060a1
+  metadata.gz: 8f21d850b87ca9ce2161c771638c6ae7b0d5847f88267ebaf0a72269ce46741c
+  data.tar.gz: e4cac524ec868de6ddc432c2d70d885d8c65d8f7eb7ec578bb24fd979eb53026
 SHA512:
-  metadata.gz: e2c3d93b2d7a57f4aa95327b7aa5a21f3ee67448332b9060d2b42a1512d01e7b36e393e81b160594a14b9ce7bc899fc530c25ac5f0e83579d68db9815fee1050
-  data.tar.gz: 87df94bb7214f2a5ea27f664256fac21495b78605dc935fa755f17712d3727a981530e7ffc87c44871d615b5b883a8b5c6482af3be27769e49acb245dc33eb94
+  metadata.gz: 181fa05adabf48e2c04720213bbf096d153558f51f61d9ff063701dbd9c1f17a3337f9fd37821426eb009c5074e8cec4fbb7616913baa25b8c0475444460048f
+  data.tar.gz: 2dff55118101a7ba4e4089c70af7ba421e86fd287741cb0651b3c32a1017b8864d7fc378622b70f61515aa02d8cec84afa070afc1faa6c2e1dc551f694f7375c

data/CODE_OF_CONDUCT.md

@@ -5,9 +5,9 @@
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+size, disability, ethnicity, gender identity and expression, level of
+experience,nationality, personal appearance, race, religion, or sexual identity
+and orientation.
 
 ## Our Standards
 
@@ -67,8 +67,8 @@ members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
 [version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -1,6 +1,14 @@
-# Hanami::Id
+# HanamiId
 
-Authentication solution for Hanami framework. Based on Warden and Bcrypt.
+Authentication solution for [Hanami](https://github.com/hanami/hanami) framework. Based on [Warden](https://github.com/wardencommunity/warden) and [Bcrypt](https://github.com/codahale/bcrypt-ruby).
+
+HanamiId tries to be a plug-n-play solution like Devise is for Rails. But 
+instead of magic intervention, it generates a separate app with controllers, views, templates full of working code that you can easily change to your liking.  
+HanamiId doesn't monkey patch anything, doesn't mess with your app configuration 
+and acts completely isolated.
+
+
+## Status
 
 [![Build Status](https://travis-ci.org/leemour/hanami_id.svg?branch=master)](https://travis-ci.org/leemour/hanami_id)
 [![Gem](https://img.shields.io/gem/v/hanami_id.svg?style=flat)](http://rubygems.org/gems/hanami_id "View this project in Rubygems")
@@ -13,23 +21,80 @@ Authentication solution for Hanami framework. Based on Warden and Bcrypt.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this lines to your application's Gemfile:
 
 ```ruby
-gem 'hanami_id'
+gem "hanami_id"
+
+group :plugins do
+  gem "hanami_id-generators"
+end
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Run generator:
+
+    $ hanami g auth --app auth --model user
+
+
+Use `--help` to see all available options and defaults. They are:
+
+- --modules
+- --id_type
+- --login_column
+- --password_column
 
-    $ gem install hanami_id
+The above command is using Hanami CLI under the hood and will generate an 
+application with all controller actions, entity, repository and all relevant 
+specs (RSpec).
 
 ## Usage
 
-TODO: Write usage instructions here
+For project-wide usage add Warden Rack middleware to your project:
+```ruby
+# config/environment.rb
+Hanami.configure do
+  # ...
+  use Rack::Session::Cookie, secret: "replace this with some secret key"
+  include HanamiId::Warden::AppHelper
+end
+```
+
+For usage in a specific app add Warden Rack middleware to that particular app:
+```ruby
+# apps/web/application.rb
+module Web
+  class Application < Hanami::Application
+    configure do
+      # ...
+      sessions :cookie, secret: ENV["WEB_SESSIONS_SECRET"]
+      include HanamiId::Warden::AppHelper
+    end
+  end
+end
+```
+
+For usage in single controller action add Warden Rack middleware to that action:
+```ruby
+# apps/web/controllers/dashboard/show.rb
+module Web
+  module Controllers
+    module Dashboard
+      class Show
+        include Web::Action
+        include HanamiId::Warden::ActionHelper
+
+        def call(params)
+          # ...
+        end
+      end
+    end
+  end
+end
+```
 
 ## Development
 

data/lib/hanami_id.rb

@@ -1,6 +1,68 @@
+# frozen_string_literal: true
+
+require "bcrypt"
+require "i18n"
+require "logger"
+# TODO: remove pry
+# require "pry-byebug"
+require "warden"
+
 require "hanami_id/version"
+require "hanami_id/warden/strategy"
+require "hanami_id/warden/app_helper"
 
 module HanamiId
-  class Error < StandardError; end
-  # Your code goes here...
+  MODES = %w[standalone project].freeze
+  MODULES = %w[sessions registrations].freeze
+
+  class AuthError < StandardError; end
+
+  class << self
+    attr_accessor :logger
+    attr_accessor :model_name
+    attr_accessor :app_name
+    attr_accessor :failure_app
+    attr_accessor :default_modules
+
+    def configure
+      yield self
+    end
+
+    def model
+      @model ||= Module.const_get(classify(@model_name))
+    end
+
+    def repository_name
+      @repository_name ||= "#{@model_name}_repository"
+    end
+
+    def repository
+      @repository ||= Module.const_get("#{classify @model_name}Repository")
+    end
+
+    def classify(string)
+      Hanami::Utils::String.classify string
+    end
+
+    def app
+      @app ||= Module.const_get(@app_name)
+    end
+  end
+
+  # Defaults
+  @logger = ::Logger.new(STDOUT)
+  @model_name = "user"
+  @app_name = "Auth"
+  @failure_app = lambda do |env|
+    HanamiId.app::Controllers::Session::New.new(
+      login_failed_with: env["warden"].message
+    ).call(env)
+  end
+  @default_modules = %w[sessions registrations].freeze
+end
+
+I18n.tap do |i18n|
+  i18n.load_path << Dir[File.join File.expand_path("locales"), "*.yml"]
+  i18n.enforce_available_locales = false
+  i18n.default_locale = :en
 end

data/lib/hanami_id/authentication.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module HanamiId
+  module Authentication
+    model = HanamiId.model_name
+
+    attr_reader :"current_#{model}"
+
+    def self.included(action)
+      action.class_eval do
+        before :"authenticate_#{model}!"
+        expose :"current_#{model}"
+      end
+    end
+
+    private
+
+    define_method "authenticate_#{model}!" do
+      instance_variable_set(
+        "@current_#{model}",
+        HanamiId.repostiory.new.find(session["#{model}_id"])
+      )
+      halt 401 unless send("#{model}_signed_in?")
+    end
+
+    define_method "#{model}_signed_in?" do
+      !!send("current_#{model}")
+    end
+  end
+end

data/lib/hanami_id/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HanamiId
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.1"
 end

data/lib/hanami_id/warden/app_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module HanamiId
+  module Warden
+    module AppHelper
+      def self.included(base)
+        base.configure do
+          middleware.use ::Warden::Manager do |manager|
+            manager.default_strategies :password
+            manager.failure_app = HanamiId.failure_app
+          end
+        end
+      end
+    end
+
+    module ActionHelper
+      def self.included(base)
+        base.configure do
+          use ::Warden::Manager do |manager|
+            manager.default_strategies :password
+            manager.failure_app = HanamiId.failure_app
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami_id/warden/strategy.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+Warden::Strategies.add(:password) do
+  def valid?
+    params[:login] || params[:password]
+  end
+
+  def authenticate!
+    user = HanamiId.repository.authenticate(params[:login], params[:password])
+    user.nil? ? fail!(I18n.t("errors.authentication_failed")) : success!(user)
+  end
+end

data/locales/hanam_id.en.yml

@@ -0,0 +1,3 @@
+en:
+  errors:
+    authentication_failed: Authentication failed

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami_id
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Viacheslav Ptsarev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-11 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: hanami_id-generators
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: warden
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +72,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: hanami
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: hanami-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +150,66 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Authentication for Hanami framework
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: |
+  Fully-fledged flexible authentication solution based on Bcrypt and Warden.
+  Instead of magic intervention it acts isolated and generates a new
+  authentication app with all the code you need. I fully supports I18n.
 email:
 - leemour@gmail.com
 executables: []
@@ -92,7 +221,11 @@ files:
 - LICENSE.txt
 - README.md
 - lib/hanami_id.rb
+- lib/hanami_id/authentication.rb
 - lib/hanami_id/version.rb
+- lib/hanami_id/warden/app_helper.rb
+- lib/hanami_id/warden/strategy.rb
+- locales/hanam_id.en.yml
 homepage: https://github.com/leemour/hanami_id
 licenses:
 - MIT
@@ -109,15 +242,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Authentication for Hanami framework