tachiban 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 664c75489c53111c15f0624f918846a6e64c837e
+  data.tar.gz: 82a5a8531f61133be195b32f7c0c431baf0c8d79
+SHA512:
+  metadata.gz: dbb45889b53b0a7745f3cc42c5f41c270741369fcad73c957366859485f59313be4ffd7b2d2dc1064b30a6317a394a444c0b3fd8966979fbe47d3a4aa527df5a
+  data.tar.gz: b605d49a0f8c94f2a8878095ea9a0319d782e1b174706a02f58da294f69e7d3eff393708b55eab09f69c6e3c8de874d77e74053f4b5697ae734fc723a55a3aaf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sebastjan.hribar@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tachiban.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sebastjan Hribar
+
+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,158 @@
+# Tachiban
+
+[![Join the chat at https://gitter.im/sebastjan-hribar/tachiban](https://badges.gitter.im/sebastjan-hribar/tachiban.svg)](https://gitter.im/sebastjan-hribar/tachiban?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+Tachiban (立ち番 - standing watch) provides simple authentication system for [Hanami web applications](http://hanamirb.org/) by using bcrypt for password hashing and
+offers the following functionalities (with methods listed below
+  under Methods by features):
+- Signup
+- Login
+- Authentication
+- Session handling
+
+The Tachiban logic and code were extracted from a Hanami based web app using
+Hanami::Model and was also used in a Camping based web app using Active Record.
+
+
+## Installation
+
+ Add this line to your application's Gemfile:
+
+```ruby
+gem 'tachiban'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tachiban
+
+Tachiban is already setup to be included by your Hanami application:
+
+```ruby
+::Hanami::Controller.configure do
+  prepare do
+    include Hanami::Tachiban
+  end
+end
+```
+
+## Usage
+
+#### Prerequisites
+The entity for which authentication is used must have the
+attribute `hashed_pass` to hold the generated hashed password.
+
+Prior to authenticating or logging in the user, retrieve them from the database and assign them to the instance variable of `@user`.
+
+
+#### Usage by features
+
+###### Signup
+To create a user with a hashed password use the `hashed_password(password)` method for the password and store it as the user's attribute `hashed_pass`.
+
+*Example*
+
+```ruby
+# Create action for an entity
+def call(params)
+  password = params[:newuser][:password]
+  hashed_pass = hashed_password(password)
+  repository = UserRepository.new
+
+  @user = repository.create(name: name, surname: surname, email: email,
+  hashed_pass: hashed_pass))
+end
+```
+
+###### Login
+To authenticate a user use the `authenticated?(input_password)` method and log them in with the `login` method. Authentication is successful if the user exists and passwords match.
+
+The user is logged in by setting the user object as the `session[:current_user]`. After the user is logged in the session start time is defined as `session[:session_start_time] = Time.now`. A flash message is also assigned as `flash[:success_notice] = flash_message`.
+
+The `session[:session_start_time]` is then used by the `session_expired?` method to determine whether the session has expired or not.
+
+*Example*
+
+```ruby
+# Create action for an entity session
+email = params[:entity_session][:email]
+password = params[:entity_session][:password]
+
+@user = EntityRepository.new.find_by_email(email)
+login("You have been successfully logged in.") if authenticated?(password)
+```
+
+
+###### Authentication
+To check whether the user is logged in use the `check_for_logged_in_user
+` method.
+
+
+###### Session handling
+Tachiban handles session expiration by checking if a session has
+expired and then restarts the session start time if the session
+is still valid or proceeds with the following if the session
+has expired:
+
+- setting the `session[:current_user]` to `nil`
+- a flash message is set: `flash[:failed_notice] = "Your session has expired"`
+- redirects to the `routes.root_path` which can be overwritten by assigning
+a different url to @redirect_url
+
+
+The `session_expired?` method compares the session start time
+increased for the defined `@validity_time` (set to 10 minutes
+by default, but can be overwritten) with the current time.
+
+`handle_session` method:
+```ruby
+  def handle_session
+    if session_expired?
+      @redirect_url ||= routes.root_path
+      session[:current_user] = nil
+      flash[:failed_notice] = "Your session has expired"
+      redirect_to @redirect_url
+    else
+      restart_session_counter
+    end
+  end
+```
+
+*Example of session handling in a share code module*
+
+```ruby
+module Web
+  module HandleSession
+
+     def self.included(action)
+       action.class_eval do
+         before :handle_session
+       end
+     end
+
+  end
+end
+```
+
+### ToDo
+1. Add support for password reset and update.
+2. Add support for level based authorizations.
+
+<!-- ## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/sebastjan-hribar/tachiban. 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
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "hanami/controller"
+require 'hanami/action/session'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tachiban"
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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

data/lib/tachiban.rb

@@ -0,0 +1,126 @@
+require 'tachiban/version'
+require 'bcrypt'
+require 'hanami/controller'
+require 'hanami/action/session'
+
+module Hanami
+  module Tachiban
+
+private
+
+  # ### Signup ###
+
+  # The hashed_password method generates a hashed version of the user's
+  # password. By default it includes a salt and the default cost factor
+  # of 10 provided by BCrypt. Hashed password should be stored in the database
+  # as a user's attribute so it can be retrieved during the login process.
+
+    def hashed_password(password)
+      BCrypt::Password.create(password)
+    end
+
+
+  # ### Login ###
+
+  # The authenticated? method returns true if the the following criteria
+  # are true:
+  # - a user exists
+  # - a user's hashed password from the database matches the input password
+
+    def authenticated?(input_pass)
+      @user && BCrypt::Password.new(@user.hashed_pass) == input_pass
+    end
+
+
+  # The login method can be used in combination with the authenticated? method to
+  # log the user in if the authenticated? method returns true. The user is
+  # logged in by setting the user object as the session[:current_user].
+  # After the user is logged in the session start time is defined, which is then used
+  # by the session_expired? method to determine whether the session has
+  # expired or not.
+
+  # Example:
+  # login if authenticated?(input_pass)
+
+    def login(flash_message)
+      session[:current_user] = @user
+      session[:session_start_time] = Time.now
+      flash[:success_notice] = flash_message
+    end
+
+
+  # The logout method sets the current user in the session to nil
+  # and performs a redirect to the @redirect_to which is set to
+  # routes.root_path and can be overwritten as needed with a specific url.
+
+    def logout
+      session[:current_user] = nil
+      @redirect_url ||= routes.root_path
+      redirect_to @redirect_url
+    end
+
+
+  # ### Authentication ###
+
+  # The check_for_logged_in_user method can be used to check for each
+  # request whether the user is logged in. If the user is not logged in
+  # the logout method takes over.
+
+    def check_for_logged_in_user
+        logout unless session[:current_user]
+    end
+
+
+  # ### Session handling ###
+
+  # Session handling  includes methods session_expired?,
+  # restart_session_counter and handle session.
+
+  # The session_expired? method compares the session start time
+  # increased for the defined validity time (set to 10 minutes
+  # by default and can be overwritten) with the current time.
+
+    def session_expired?
+      if session[:current_user]
+        @validity_time ||= 600
+        session[:session_start_time] + @validity_time.to_i < Time.now
+      end
+    end
+
+
+  # The restart_session_counter method resets the session start time to
+  # Time.now. It's used in the handle  session method.
+
+    def restart_session_counter
+      session[:session_start_time] = Time.now
+    end
+
+
+    # The handle_session method is used to handle the incoming requests
+    # based on the the session expiration. If the session has expired the
+    # session user is set to nil, a flash message of "Your session has expired"
+    # is provided and a redirect to a default url of routes.root_path
+    # is triggered.
+
+    # If the session hasn't expired the restart_session_counter method is
+    # called to reset the session start time.
+
+    def handle_session
+      if session_expired?
+        @redirect_url ||= routes.root_path
+        session[:current_user] = nil
+        flash[:failed_notice] = "Your session has expired"
+        redirect_to @redirect_url
+      else
+        restart_session_counter
+      end
+    end
+
+  end
+end
+
+::Hanami::Controller.configure do
+  prepare do
+    include Hanami::Tachiban
+  end
+end

data/lib/tachiban/version.rb

@@ -0,0 +1,3 @@
+module Tachiban
+  VERSION = "0.3.0"
+end

data/tachiban.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tachiban/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tachiban"
+  spec.version       = Tachiban::VERSION
+  spec.authors       = ["Sebastjan Hribar"]
+  spec.email         = ["sebastjan.hribar@gmail.com"]
+
+  spec.summary       = %q{Tachiban provides simple password hashing for user authentication with bcrypt for Hanami web applications.}
+  spec.homepage      = "https://github.com/sebastjan-hribar/tachiban"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "hanami-model", "~> 1.0"
+  spec.add_development_dependency "timecop", "0.8.1"
+  spec.add_development_dependency 'hanami-controller', "~> 1.0"
+  spec.add_development_dependency 'hanami-router'
+  spec.add_development_dependency 'pry'
+
+  spec.add_runtime_dependency "bcrypt", "~> 3.1"
+  spec.add_runtime_dependency 'hanami-controller', "~> 1.0"
+  spec.add_runtime_dependency 'hanami-router'
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: tachiban
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Sebastjan Hribar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: hanami-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: hanami-controller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hanami-router
+  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: pry
+  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: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: hanami-controller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hanami-router
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- sebastjan.hribar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tachiban.rb
+- lib/tachiban/version.rb
+- tachiban.gemspec
+homepage: https://github.com/sebastjan-hribar/tachiban
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Tachiban provides simple password hashing for user authentication with bcrypt
+  for Hanami web applications.
+test_files: []