gargoyle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bbd228176d4c4527b67d6210dccfb642c5770a7
+  data.tar.gz: fb719c7647843a4ee083a2309c03e7666f212919
+SHA512:
+  metadata.gz: aa8e3b0c6c242f4c1bb0f5e55fdbb3c4c88057f2b36478142c6b2e6178722b7c6d0cd235be41f45bd53335538ee3c2fcb2210eb34b4d5b93a0a1cd606dbd6f84
+  data.tar.gz: 6478adcd3a3185a9704aad28dad79016242211a8fcfb905b5741086dea2f3c30aceafd8cd756cf48747941b1c6f242f92248002305bf5afad9bb82f14202623c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kbaba1001@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+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]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 kbaba1001
+
+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,113 @@
+# Gargoyle
+
+super simple authentication
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gargoyle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gargoyle
+
+## Feature
+
+- Rails helper method
+- Session authenticate scope
+- Rails routes helper
+- Password management
+
+## Usage
+
+### Rails helper method
+
+include `Gargoyle::ControllerHelpers` to `ApplicationController` in Rails.
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Gargoyle::ControllerHelpers
+  before_action :authenticate_user!
+
+  private
+
+  # template method pattern.
+  # set session scope name
+  def auth_scope
+    :user
+  end
+
+  # template method pattern
+  def no_signin_redirect_logic
+    -> { redirect_to root_path }
+  end
+end
+```
+
+When set before action `authenticate_user!`, if user don't sign in, run `no_signin_redirect_logic.call`.
+
+#### Controller Additions
+
+Gargoyle provides the following controller methods:
+
+- auth_scope
+- no_signin_redirect_logic
+
+These helpers:
+
+- current_user
+- signed_in?
+
+provide the following private methods (template method pattern):
+
+- auth_scope
+- no_signin_redirect_logic
+
+### Rails routes helper
+
+To authorize users in `config/routes.rb`:
+
+```ruby
+require 'gargoyle/constraints/signed_in'
+require 'gargoyle/constraints/signed_out'
+
+Rails.application.routes.draw do
+  root 'sessions#new', constraints: Gargoyle::Constraits::SignedOut.new(:user)
+  root 'dashboards#show', as: :signed_in_root, constraints: Gargoyle::Constraits::SignedIn.new(:user)
+end
+```
+
+### Password management
+
+password hashing method (using BCrypt):
+
+```ruby
+Gargoyle::Password.hashing(password)
+```
+
+password conmpare method:
+
+```ruby
+Gargoyle::Password.compare?(hashed_password, unhashed_password)
+```
+
+## 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/kbaba1001/gargoyle. 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

@@ -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/gargoyle.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gargoyle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gargoyle"
+  spec.version       = Gargoyle::VERSION
+  spec.authors       = ["kbaba1001"]
+  spec.email         = ["kbaba1001@users.noreply.github.com"]
+
+  spec.summary       = "simple authentication"
+  spec.description   = "simple authentication"
+  spec.homepage      = "https://github.com/kbaba1001/gargoyle"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails'
+  spec.add_dependency 'bcrypt'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'test-unit'
+end

data/lib/gargoyle.rb

@@ -0,0 +1,8 @@
+require "gargoyle/version"
+require "gargoyle/manager"
+require "gargoyle/password"
+require "gargoyle/controller_helpers"
+
+module Gargoyle
+  # Your code goes here...
+end

data/lib/gargoyle/constraints/signed_in.rb

@@ -0,0 +1,13 @@
+module Gargoyle
+  module Constraits
+    class SignedIn
+      def initialize(scope = nil)
+        @scope = scope
+      end
+
+      def matches?(request)
+        !!request.session[Gargoyle::Manager.new(@scope).session_key_name]
+      end
+    end
+  end
+end

data/lib/gargoyle/constraints/signed_out.rb

@@ -0,0 +1,13 @@
+module Gargoyle
+  module Constraits
+    class SignedOut
+      def initialize(scope = nil)
+        @scope = scope
+      end
+
+      def matches?(request)
+        !request.session[Gargoyle::Manager.new(@scope).session_key_name]
+      end
+    end
+  end
+end

data/lib/gargoyle/controller_helpers.rb

@@ -0,0 +1,47 @@
+module Gargoyle
+  module ControllerHelpers
+    def self.included(base)
+      base.class_eval do
+        if respond_to?(:helper_method)
+          helper_method :current_user, :signed_in?
+        end
+      end
+    end
+
+    def signed_in?
+      !!current_user
+    end
+
+    def current_user
+      @current_user ||= manager.find_in_scope(session[manager.session_key_name])
+    end
+
+    def sign_out
+      reset_session
+    end
+
+    def sign_in(user)
+      session[manager.session_key_name] = manager.serialize(user)
+    end
+
+    def authenticate_user!
+      no_signin_redirect_logic.call unless signed_in?
+    end
+
+    private
+
+    # no doc
+    def manager
+      @manager ||= Manager.new(auth_scope)
+    end
+
+    def auth_scope
+      raise NotImplementedError
+    end
+
+    # NOTE must be return lambda
+    def no_signin_redirect_logic
+      raise NotImplementedError
+    end
+  end
+end

data/lib/gargoyle/manager.rb

@@ -0,0 +1,23 @@
+require 'active_support/inflector'
+
+module Gargoyle
+  class Manager
+    attr_reader :scope
+
+    def initialize(scope)
+      @scope = scope.to_s
+    end
+
+    def session_key_name
+      "gargoyle.#{scope}.id"
+    end
+
+    def find_in_scope(id)
+      scope.camelize.constantize.find_by(id: id)
+    end
+
+    def serialize(user)
+      user.id
+    end
+  end
+end

data/lib/gargoyle/password.rb

@@ -0,0 +1,17 @@
+require 'bcrypt'
+
+module Gargoyle
+  class Password
+    class << self
+      def hashing(password)
+        BCrypt::Password.create(password)
+      end
+
+      def compare?(hashed_password, unhashed_password)
+        return unless hashed_password
+
+        BCrypt::Password.new(hashed_password) == unhashed_password
+      end
+    end
+  end
+end

data/lib/gargoyle/version.rb

@@ -0,0 +1,3 @@
+module Gargoyle
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: gargoyle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kbaba1001
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: test-unit
+  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'
+description: simple authentication
+email:
+- kbaba1001@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gargoyle.gemspec
+- lib/gargoyle.rb
+- lib/gargoyle/constraints/signed_in.rb
+- lib/gargoyle/constraints/signed_out.rb
+- lib/gargoyle/controller_helpers.rb
+- lib/gargoyle/manager.rb
+- lib/gargoyle/password.rb
+- lib/gargoyle/version.rb
+homepage: https://github.com/kbaba1001/gargoyle
+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.6.11
+signing_key: 
+specification_version: 4
+summary: simple authentication
+test_files: []