acts_as_hoc_user 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d53ee526d2e91cf1a297ef7d42307206429c802e
+  data.tar.gz: 9b18bc0c028eeb444b5aa8d2a4e4d15ddf5dfa64
+SHA512:
+  metadata.gz: 0bd7ecd06bfdd8d25523fa88d1fddcba8136e2cc2e55b09ec7738bffc9b3440325bb65202f5f279c9076273e0093fb865bf73d2bc4aadf8089c7861f28362192
+  data.tar.gz: 3a5ec7aefe40cab070b884898548073c7e2d80a163a7fceaba366d9c14408f108f545aad40598c7e0a919f69a14bdc80acefb9efb4e66828fd2a788b0ab93ae9

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in acts_as_hoc_user.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Gert Lavsen
+
+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,94 @@
+# ActsAsHocUser
+
+`acts_as_hoc_user` makes it easy to authenticate users.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_hoc_user'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_hoc_user
+
+
+## Usage
+
+### Generate model
+You can create the model and table migration with the following generator:
+```bash
+$ rails generate acts_as_hoc_user:hoc_user NAME FIELDS
+```
+
+Eg.
+```bash
+$ rails generate acts_as_hoc_user:hoc_user user name:string age:integer phone_number:string address:string zip:string
+```
+Which will generate the following migration:
+```ruby
+#db/migration/xxxxxxxxxxxx_create_users.rb
+class CreateUsers < ActiveRecord::Migration[5.0]
+  def self.up
+    create_table :users do |t|
+      t.string :email, index: {unique: true}, null: false
+      t.string :password_digest
+      t.string :name
+      t.integer :age
+      t.string :phone_number
+      t.string :address
+      t.string :zip
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end
+```
+and model
+```ruby
+#app/model/user.rb
+class User < ActiveRecord::Base
+  acts_as_hoc_user
+end
+```
+
+and initializer
+```ruby
+#config/initializers/acts_as_hoc_user.rb
+ActsAsHocUser.configure do |config|
+  config.min_password_length = 6
+end
+```
+
+### Manual usage
+If you prefer you can create the model yourself. Just make sure that the model has email:string and password_digest:string fields and add `acts_as_hoc_user` to the model
+
+### Authenticate user
+
+#### Authenticate and get JWT token
+ ```ruby
+ auth_token = User.authenticate_with_credentials("email@test.com","s3cr3t")
+ ```
+
+#### Authenticate with JWT token
+```ruby
+user = User.authenticate_with_authentication_token(auth_token)
+```
+
+#### Authenticate with http headers
+```ruby
+user = User.authenticate_with_headers(request.headers)
+```
+
+
+## Licence
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/acts_as_hoc_user.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "acts_as_hoc_user/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_hoc_user"
+  spec.version       = ActsAsHocUser::VERSION
+  spec.authors       = ["Gert Lavsen"]
+  spec.email         = ["gert@houseofcode.io"]
+
+  spec.summary       = "Easy authentication with JWT"
+  spec.description   = "This gem makes it easy to authenticate a user by email and password"
+  spec.homepage      = "https://github.com/house-of-code/acts_as_hoc_user"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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 "bcrypt", "~> 3.1.7"
+  spec.add_dependency "jwt"
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

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

@@ -0,0 +1,41 @@
+  require_relative 'json_web_token'
+
+  module ActsAsHocUser
+    extend ActiveSupport::Concern
+    included do
+    end
+
+    def authentication_token(expiration = 14.days.from_now)
+      JsonWebToken.encode({ user_id: id }, expiration)
+    end
+
+    module ClassMethods
+      def authenticate_with_credentials(email, password, expiration = 14.days.from_now)
+        user = find_by(email:email)
+        return user.authentication_token(expiration) if user && user.authenticate(password)
+        nil
+      end
+
+      def authenticate_with_authentication_token(token)
+        decoded_auth_token = JsonWebToken.decode(token)
+        return nil if decoded_auth_token.nil?
+        user = User.find(decoded_auth_token[:user_id])
+        return user
+      end
+
+      def authenticate_with_http_headers(headers = {})
+        if headers['Authorization'].present?
+          return authenticate_with_authentication_token(headers['Authorization'].split(' ').last)
+        end
+        return nil
+      end
+
+      def acts_as_hoc_user(_options = {})
+        has_secure_password
+        validates_presence_of :email
+        validates :email, uniqueness: true, format: { with: URI::MailTo::EMAIL_REGEXP }
+        validates :password, length: { minimum: ActsAsHocUser.configuration.min_password_length }, if: -> { password.present? }
+      end
+    end
+  end
+  ActiveRecord::Base.send :include, ActsAsHocUser

data/lib/acts_as_hoc_user/configuration.rb

@@ -0,0 +1,7 @@
+module ActsAsHocUser
+  class Configuration
+    attr_accessor :min_password_length
+    def initialize
+    end
+  end
+end

data/lib/acts_as_hoc_user/json_web_token.rb

@@ -0,0 +1,18 @@
+require 'jwt'
+module ActsAsHocUser
+  class JsonWebToken
+    class << self
+      def encode(payload, exp = 48.hours.from_now)
+        payload[:exp] = exp.to_i
+        JWT.encode(payload, Rails.application.secrets.secret_key_base)
+      end
+
+      def decode(token)
+        body = JWT.decode(token, Rails.application.secrets.secret_key_base)[0]
+        HashWithIndifferentAccess.new body
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/acts_as_hoc_user/version.rb

@@ -0,0 +1,3 @@
+module ActsAsHocUser
+  VERSION = "1.0.0"
+end

data/lib/acts_as_hoc_user.rb

@@ -0,0 +1,22 @@
+require "acts_as_hoc_user/version"
+require "acts_as_hoc_user/configuration"
+require "acts_as_hoc_user/acts_as_hoc_user"
+module ActsAsHocUser
+  LOCK = Mutex.new
+  class << self
+    def configure(config_hash=nil)
+      if config_hash
+        config_hash.each do |k,v|
+          configuration.send("#{k}=", v) rescue nil if configuration.respond_to?("#{k}=")
+        end
+      end
+
+      yield(configuration) if block_given?
+    end
+
+    def configuration
+      @configuration = nil unless defined?(@configuration)
+      @configuration || LOCK.synchronize { @configuration ||= ActsAsHocUser::Configuration.new }
+    end
+  end
+end

data/lib/generators/acts_as_hoc_user/hoc_user_generator.rb

@@ -0,0 +1,58 @@
+require 'rails/generators/active_record'
+module ActsAsHocUser
+  #module Generators
+    class HocUserGenerator < ActiveRecord::Generators::Base
+
+      desc "Create a HocUser model and migrations " +
+      "The NAME argument is the name of your model, and the following " +
+      "arguments are the fields to add. Eg. acts_as_hoc_user:hoc_user user name:string"
+
+      argument :fields, :required => false, :type => :array, :desc => "The fields to add.",
+      :banner => "name:string age:integer ..."
+
+      def self.source_root
+        @source_root ||= File.expand_path('../templates', __FILE__)
+      end
+
+
+      def generate_migration
+        template "initializer.rb", "config/initializers/acts_as_hoc_user.rb"
+        template "hoc_user.rb.erb", "app/models/#{model_name}.rb"
+        migration_template("create_hoc_user.rb.erb",
+          "db/migrate/#{migration_file_name}",
+          migration_version: migration_version)
+      end
+      
+      def model_name
+        name.underscore
+      end
+
+      def migration_colums
+        return fields.map { |field| "t.#{field.split(":").last} :#{field.split(":").first}" } unless fields.nil?
+        return []
+      end
+
+      def model_class_name
+        name.camelize
+      end
+
+      def migration_name
+        "create_#{name.underscore.pluralize}"
+      end
+
+      def migration_file_name
+        "#{migration_name}.rb"
+      end
+
+      def migration_class_name
+        migration_name.camelize
+      end
+
+      def migration_version
+        if Rails.version.start_with? "5"
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
+    end
+  #end
+end

data/lib/generators/acts_as_hoc_user/templates/create_hoc_user.rb.erb

@@ -0,0 +1,16 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.string :email, index: {unique: true}, null: false
+      t.string :password_digest
+      <% migration_colums.each do |column| -%>
+      <%= column %>
+      <% end -%>
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/generators/acts_as_hoc_user/templates/hoc_user.rb.erb

@@ -0,0 +1,3 @@
+class <%= model_class_name %> < ActiveRecord::Base
+  acts_as_hoc_user
+end

data/lib/generators/acts_as_hoc_user/templates/initializer.rb

@@ -0,0 +1,3 @@
+ActsAsHocUser.configure do |config|
+  config.min_password_length = 6
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_hoc_user
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gert Lavsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+- !ruby/object:Gem::Dependency
+  name: jwt
+  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: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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'
+description: This gem makes it easy to authenticate a user by email and password
+email:
+- gert@houseofcode.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_hoc_user.gemspec
+- bin/console
+- bin/setup
+- lib/acts_as_hoc_user.rb
+- lib/acts_as_hoc_user/acts_as_hoc_user.rb
+- lib/acts_as_hoc_user/configuration.rb
+- lib/acts_as_hoc_user/json_web_token.rb
+- lib/acts_as_hoc_user/version.rb
+- lib/generators/acts_as_hoc_user/hoc_user_generator.rb
+- lib/generators/acts_as_hoc_user/templates/create_hoc_user.rb.erb
+- lib/generators/acts_as_hoc_user/templates/hoc_user.rb.erb
+- lib/generators/acts_as_hoc_user/templates/initializer.rb
+homepage: https://github.com/house-of-code/acts_as_hoc_user
+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.13
+signing_key: 
+specification_version: 4
+summary: Easy authentication with JWT
+test_files: []