shidare 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4979f2290dd0785914420877348d1f4b13fc67b59d50e0018836c0d1626c6920
-  data.tar.gz: e0d7563622ef03fe34581856887755d473e6ddec7e4abc8eb184ad5f519bbc91
+  metadata.gz: 9c0e8a6f8c2a8f6d13a5c4d4bf5cd135f25bf385b36e84311e3d4ea6ca01ece6
+  data.tar.gz: 0aead697713967499706429cfb84f5293626a293dd8d562b2953160ffa6b40a2
 SHA512:
-  metadata.gz: 94f649bc9af63972014ce047efabf488de09a6951b32aab332320c7ce4f75c42778e22fbcf0af420964b9a8937f3137a5929ecc59b6010f2d46931e2561b86e9
-  data.tar.gz: d1f2aba3450a92abcaf514ba7a65c6a0d7c7b48e51c51989c495e3bd1776477a0a75ded5f7d96835832ea57a5b0aadb0eaf6b7ba95b3b192699ac3e34c58df68
+  metadata.gz: 25808f16260cdd5f04a76e46af055f33c19753a9fefbf1fbb95e12d4968f8b52b484951d9c6a9d050de069f24bb43d305fbdc38f2c59e2001d38fa089561e59f
+  data.tar.gz: 85f2dc8925418dacd55301e6d4cb94e628909fda77e38ffd9b71ef1f3df283d98efd59a68617f5b474d6bfab81202d72db631659e8d6ab6fa25faa03dd4eb92b

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+  Exclude:
+    - 'vendor/bundle/**/*'
+    - 'shidare.gemspec'
+    - 'Rakefile'
+    - 'Gemfile'
+    - 'bin/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Exclude:
+    - 'spec/**/*'
+  Max: 100
+
+Style/DoubleNegation:
+  Enabled: false

data/Gemfile

@@ -2,5 +2,8 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in shidare.gemspec
 gemspec
+
+gem 'pg', require: false
+
+gem 'rubocop', require: false

data/README.md

@@ -1,6 +1,6 @@
 # Shidare
 
-Simple sessoin for hanami by bcrypt
+Simple registration and session for Hanami
 
 ## Installation
 
@@ -18,62 +18,172 @@ Or install it yourself as:
 
     $ gem install shidare
 
-## Usage
+## Setting
+
+You should make `shidare` directory into `lib`
+
+```
+lib
+├── app
+│   ├── entities
+│   ├── mailers
+│   ├── repositories
+│   └── shidare
+└── app.rb
+```
+
+And define `[model_name]Registration` into your `shidare` directory and include `Shidare::Registration`
+
+example, `app/lib/shidare/user_registraion`
+
+```ruby
+module UserRegistration
+  include Shidare::Registration
+end
+```
+
+next include `UserRegistration` in your action.
 
-Include your controller like below
+example, `app/apps/web/controllers/users/create.rb`
 
 ```ruby
-module Web::controllers::Users
+module Web::Controllers::Users
   class Create
     include Web::Action
-    include Shidare::Authentication
-    
+    include UserRegistration
+
     def call(params)
     end
   end
 end
+
 ```
-## interface
-you can use below methods
 
-- login_as
-- logout_from
-- current_user
-- sigend_in?
+## Usage
 
-## deteil description about above methods
+### Registration
 
-### login_as
+**must**
+
+Add `email`, `encrypted_password`, `activation_token` and `activated_at` column to your model.
+and `activation_token` and `activated_at` is **NOT** null index.
+
+example, `db/migrations/[date]_create_users.rb`
 
 ```ruby
-login_as(UserRepository.new.first)
+Hanami::Model.migration do
+  change do
+    create_table :users do
+      primary_key :id
+
+      column :email             , String, null: false
+      column :encrypted_password, String, null: false
+      column :activation_token,   String
+
+      column :created_at, DateTime, null: false
+      column :updated_at, DateTime, null: false
+      column :activated_at, DateTime
+    end
+  end
+end
+
 ```
 
-then current_user(:user) will return current login user
+provide
+- `#signup_as`
+- `#activate_[model_name]`
+- `#activated?`
+
+#### signup_as
+
+##### options
+- `mail` (default is `false`)
 
-### logout_from
+Pass the `params`, so create record your into your model and activate.
 
 ```ruby
-logout_from(:user)
-```
+module Web::Controllers::Users
+  class Create
+    include Web::Action
+    include UserRegistration
 
-then logout current login user and current_user(:user) will return nil
+    def call(params)
+      signup_as(params[:user]) # params -> { email: 'test@example.com', password: 'password', ... } 
+    end
+  end
+end
+```
 
-### current_user
+If you pass the `mail: true`, you should define method `mailer` in your aciton class
 
 ```ruby
-current_user(:user)
+module Web::Controllers::Users
+  class Create
+    include Web::Action
+    include UserRegistration
+
+    def call(params)
+      signup_as(params[:user], mail: true) # params -> { email: 'test@example.com', password: 'password', ... } 
+    end
+    
+    private
+    
+    def mailer
+      Mailers::Welcome
+    end
+  end
+end
 ```
 
-then return current login user entity
+You can access entity attributes by `account` in your Mailer class
+
+example `app/lib/mailers/welcome.rb`
+
+```ruby
+class Mailers::Welcome
+  include Hanami::Mailer
+
+  from    'noreply@exmaple.com'
+  to      :recipient
+  subject 'Hello'
+  
+  private
+  
+  def recipient
+    account.email
+  end
+  
+  def token
+    account.activation_token
+  end
+end
+
+```
 
-### signed_in?
+#### activate_[model_name]
 
 ```ruby
-signed_in(:user)
+module Web::Controllers::Users
+  class AccountActivation
+    include Web::Action
+    include UserRegistration
+
+    def call(params)
+      acitivate_user(params) # params -> { email: 'user@example.com', activation_token: 'user_token' }
+    end
+  end
+end
 ```
 
-then return true if login as user
+#### activated?
+
+If record is activated return `true`
+
+exmaple
+
+```ruby
+UserRepository.new.first.activated? # => true if user is activated
+```
 
 ## Development
 

data/bin/console

@@ -12,5 +12,7 @@ require "shidare"
 
 require "irb"
 
-class A < Shidare::Authentication; end
+require_relative '../spec/entities/user'
+require_relative '../spec/repositories/user_repository'
+
 IRB.start(__FILE__)

data/lib/shidare.rb

@@ -1,37 +1,2 @@
-require "shidare/version"
-require 'bcrypt'
-require 'hanami/controller'
-require 'hanami/action/session'
-
-module Shidare
-  class Authentication
-    include Hanami::Action
-    include Hanami::Action::Session
-    def self.inherited(klass)
-      entity_name = klass.to_s.gsub(/Authentication/, '').downcase
-      klass.class_eval do
-        define_method("current_#{entity_name}") do
-          Object.const_get("#{entity_name.capitalize}Repository").new.find(session["#{entity_name}_id".to_sym])
-        end
-
-      end
-    end
-
-    def initialize(session)
-      @session = session
-    end
-
-    def login(id)
-      @session[:current_id] = id
-    end
-
-
-    def logout
-      @session[:current_id] = nil
-    end
-
-    def signed_in?
-      @session["current_id"] ? true : false
-    end
-  end
-end
+require 'shidare/version'
+require 'shidare/registration'

data/lib/shidare/exceptions/attributes_error.rb

@@ -0,0 +1,4 @@
+module Shidare
+  class AttributesError < StandardError
+  end
+end

data/lib/shidare/exceptions/invalid_parameter_error.rb

@@ -0,0 +1,4 @@
+module Shidare
+  class InvalidParameter < StandardError
+  end
+end

data/lib/shidare/exceptions/model_not_generated_error.rb

@@ -0,0 +1,4 @@
+module Shidare
+  class ModelNotGenerated < StandardError
+  end
+end

data/lib/shidare/extensions/entity_extension.rb

@@ -0,0 +1,19 @@
+require 'hanami/model'
+
+module Shidare
+  module EntityExtension
+    refine Hanami::Entity.singleton_class do
+      def column?(attribute_name)
+        schema.instance_variable_get(:@attributes).key?(attribute_name)
+      end
+
+      def repository
+        Object.const_get("#{self}Repository")
+      end
+
+      def activatable?
+        column?(:activated_at) && column?(:activation_token)
+      end
+    end
+  end
+end

data/lib/shidare/extensions/repository_extension.rb

@@ -0,0 +1,11 @@
+require 'hanami/model'
+
+module Shidare
+  module RepositoryExtension
+    refine Hanami::Repository do
+      def by_email(email)
+        send(self.class.relation).where(email: email).limit(1).one
+      end
+    end
+  end
+end

data/lib/shidare/extensions/string_extension.rb

@@ -0,0 +1,19 @@
+require 'hanami/utils'
+
+module Shidare
+  module StringExtension
+    refine String do
+      def to_snake
+        gsub(/([A-Z])/, '_\1')[1..-1].downcase
+      end
+
+      def to_camel
+        split('_').map(&:capitalize).join
+      end
+
+      def pluralize
+        Hanami::Utils::Inflector.pluralize(self)
+      end
+    end
+  end
+end

data/lib/shidare/registration.rb

@@ -0,0 +1,124 @@
+require 'shidare/version'
+require 'bcrypt'
+require 'securerandom'
+
+require 'shidare/exceptions/attributes_error'
+require 'shidare/exceptions/model_not_generated_error'
+
+require 'shidare/extensions/string_extension'
+require 'shidare/extensions/entity_extension'
+require 'shidare/extensions/repository_extension'
+
+module Shidare
+  module Registration
+    using StringExtension
+    using EntityExtension
+    using RepositoryExtension
+
+    class << self
+      def included(klass)
+        klass.class_eval do
+          entity = Object.const_get(klass.to_s.slice(/.*(?=Registration)/).to_camel)
+
+          entity.class_eval do
+            # Return entity is acitavated or not
+            #
+            # example:
+            # user = UserRepository.new.first
+            # user.activated?
+            #
+            # @return [Boolean] if entity is activated, return true
+            def activated?
+              !!activated_at
+            end
+          end
+
+          # Signup by parameters
+          #
+          # If you want to signup as paramger {name, email, password}
+          # use like below
+          # example:
+          # signup_as({ name: 'ippachi', email: 'test@example.com', password: 'password' })
+          #
+          # @param  params [Hash]     parameter you want to signup
+          # @param  mail   [Boolean]  if you use mail activation, set true
+          #
+          # @return [Entity]   signuped entity
+          define_method :signup_as do |params, mail: false|
+            define_signup_as(entity, params, mail)
+          end
+
+          # Activate specific entity by email and activation_token
+          #
+          # example:
+          # activate_user( { email: 'test@example.com', activation_token: 'example_token' } )
+          #
+          # @params params [Hash]   parameter that has email and activation_token keys
+          #
+          # @return [Boolean] return false if account don't have specific email
+          define_method "activate_#{entity.to_s.to_snake}" do |params|
+            define_activate(entity, params)
+          end
+        end
+      end
+    end
+
+    private
+
+    # Return encrypted password by BCrypt
+    #
+    # @param password [String] password
+    #
+    # @return [String] encrypted string
+    def encrypted_password(password)
+      BCrypt::Password.create(password)
+    end
+
+    # Format params into suitable form for signup
+    #
+    # example:
+    # UserRepository.new.create(formated_params({ email: 'test@example.com', password: 'password' }))
+    #
+    # @param params [Hash]    parameter that is using for signup
+    # @param mail   [Boolean] set true, if you use mail activation
+    def formated_params(params, mail)
+      submit_params = params.dup
+
+      submit_params[:encrypted_password] \
+        = encrypted_password(params[:password])
+
+      if mail
+        submit_params[:activation_token] = token
+      else
+        submit_params[:activated_at] = Time.now
+      end
+
+      submit_params.tap { |param| param.delete(:password) }
+    end
+
+    # Return urlsafe token for account activation
+    #
+    # @return [String] token
+    def token
+      SecureRandom.urlsafe_base64
+    end
+
+    def define_signup_as(entity, params, mail)
+      raise AttributesError unless entity.column?(:encrypted_password)
+      if mail
+        raise AttributesError unless entity.activatable?
+      end
+      account = entity.repository.new.create(formated_params(params, mail))
+      mailer.deliver(account: account) if mail
+      account
+    end
+
+    def define_activate(entity, params)
+      account = entity.repository.new.by_email(params[:email])
+      return nil unless account && account.activation_token == params[:activation_token]
+      entity.repository.new.update(account.id, acitvation_token: nil, activated_at: Time.now)
+    end
+
+    def mailer; end
+  end
+end

data/lib/shidare/version.rb

@@ -1,3 +1,3 @@
 module Shidare
-  VERSION = "0.0.3"
+  VERSION = '0.0.4'.freeze
 end

data/shidare.gemspec

@@ -32,9 +32,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
 
-	spec.add_runtime_dependency 'bcrypt', '~> 3.1'
-  spec.add_runtime_dependency 'hanami-controller', '~> 1.1.0'
-  spec.add_runtime_dependency 'hanami-model', '~> 1.1.0'
-  spec.add_runtime_dependency 'hanami-router', '~> 1.1.0'
+	spec.add_runtime_dependency 'bcrypt'
+  spec.add_runtime_dependency 'hanami-controller', '>= 1.1.0'
+  spec.add_runtime_dependency 'hanami-model', '>= 1.1.0'
+  spec.add_runtime_dependency 'hanami-cli', '>= 0.1.0'
+  spec.add_runtime_dependency 'hanami-mailer', '>= 1.1.0'
+  spec.add_runtime_dependency 'hanami-utils', '>= 1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shidare
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - ippachi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,60 +52,102 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.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'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hanami-controller
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: hanami-model
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: hanami-router
+  name: hanami-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: hanami-mailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: hanami-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
 description: 
@@ -117,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -125,6 +168,13 @@ files:
 - bin/console
 - bin/setup
 - lib/shidare.rb
+- lib/shidare/exceptions/attributes_error.rb
+- lib/shidare/exceptions/invalid_parameter_error.rb
+- lib/shidare/exceptions/model_not_generated_error.rb
+- lib/shidare/extensions/entity_extension.rb
+- lib/shidare/extensions/repository_extension.rb
+- lib/shidare/extensions/string_extension.rb
+- lib/shidare/registration.rb
 - lib/shidare/version.rb
 - shidare.gemspec
 homepage: https://github.com/ippachi/shidare