anadea-identity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b90fe456fe3459656452c7191052e3cf7b9e72bd
+  data.tar.gz: 7942ef52f965589850dc1e2d9b1be489aaf96fac
+SHA512:
+  metadata.gz: 351d14c0435915e9e1324bbca2b9e53dbcda6764044e16b8138de4d24e2ca44bbf7525e343623104243ab18a0145b38028e2d62a0cd27a7718373bd413f46b8a
+  data.tar.gz: d072c2f56d804f4174305d38f4bc1bb3a412359b66a0d739e92742bd7f1a917a8f9d392e7d4c9c190eaa501c74cd81d60f3ed3ceeffe61e19571795de94ca112

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Anadea
+
+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,174 @@
+# Identity
+
+Аутентификация и авторизация для Rails приложения.
+
+## Установка
+
+Добавьте строчку в Gemfile приложения:
+
+```ruby
+gem 'anadea-identity'
+```
+
+и запустите в консоли:
+
+```console
+$ bundle
+```
+
+Сгенерируйте миграции:
+
+```console
+$ rake identity_engine:install:migrations
+```
+
+проверьте их и запустите:
+
+```console
+$ rake db:migrate
+```
+
+## Использование
+
+### Аутентификация
+
+Проверьте маршруты: `rake routes`. Вы увидите набор маршрутов, подобных тем, что
+даёт [Devise](https://github.com/plataformatec/devise). Собственно, Identity и
+есть не слишком толстая обёртка поверх Devise.
+
+У вас работает логин (через форму email/пароль), регистрация (через форму
+email/пароль/подтверждение пароля), восстановление пароля и многое другое.
+
+### Модель User
+
+Вызов `current_user` в контроллере вернёт `Identity::User`, соответствующий
+таблице `identity_users`. Не нужно добавлять в эту модель методы и не нужно
+добавлять в эту таблицу колонки, кроме тех, которые используются Devise или
+Identity. Эту модель следует считать публичным интерфейсом, предоставляеым гемом.
+
+Рекомендуется заводить модели типа `Profile` или `Account` которые будут
+"принадлежать" (`belong_to :user, class_name: "Identity::User"`) этой модели
+и ссылаться на неё с помощью внешнего ключа.
+
+### Авторизация
+
+Модель `Identity::User` расширена ролями с помощью
+[Rolify](https://github.com/RolifyCommunity/rolify). В частности, у вас есть
+говорящие за себя методы:
+
+```ruby
+user.add_role :manager
+user.remove_role :manager
+user.has_role? :manager
+
+Identity::User.with_role :manager
+```
+
+У вас есть многое другое – смотрите документацию Rolify.
+
+Используйте эти методы в вызовах вашего авторизационного фреймворка, такого, как
+[CanCanCan](https://github.com/CanCanCommunity/cancancan).
+
+### Админка
+
+Чтобы получить админку по пользователям, подключите
+[ActiveAdmin](https://github.com/activeadmin/activeadmin) и сгенерируйте
+конфигурационный файл без генерации пользователей (`--skip-users`).
+
+### Конфигурация
+
+Создайте руби-файл в `config/initializers` со следующим содержимым:
+
+```ruby
+Identity.setup do |config|
+  config.devise_modules += [:confirmable]
+  # и много других конфигурационных опций
+end
+```
+
+#### Доступные опции
+
+Вы всегда можете узнать полный список конфигурацинных опций и их значения по
+умолчанию, ознакомившись [с исходным кодом](lib/identity.rb).
+
+* `config.devise_modules` – модули Devise, которые вы используете. Например,
+  выключение `registerable` приведёт к невозможности зарегистрироваться, в том
+  числе, исчезнет соответствующая ссылка, а включение `confirmable` приведёт к
+  тому, что приложение станет требовать подтверждение адреса электронной почты,
+  при условии, что в таблице `identity_users` есть соответствующие колонки
+  (по умолчанию нет).
+
+  Вы можете как модифицировать этот массив, так и полностью его переопределить:
+
+  ```ruby
+  config.devise_modules += [:confirmable]
+  config.devise_modules = [:database_authenticatable, :omniauthable, ...]
+  ```
+
+  По умолчанию включены модули database_authenticatable, registerable,
+  recoverable, rememberable, trackable и validatable. Если включить хотя бы один
+  omniauth provider, автоматически подключится omniauthable. За подробным их
+  описанием обратитесь в документацию Devise.
+
+* `config.layout` – макет (layout), используемый формами логина, регистрации и
+  прочего. По умолчанию используется главный макет вашего приложения –
+  `"application"`.
+
+* `config.auth_routes` – если задать `false`, маршруты подключены не будут и вы
+  можете сами подключить их.
+
+* `config.admin_role` – "главная" роль в приложении. Роль, которой можно
+  управлять из предлаемой гемом админки, и роль, которая по умолчанию является
+  допуском в эту админку.
+
+Вы также можете использовать любые конфигурационные опции самого Devise.
+Они будут переданы Devise в точности. Например:
+
+```ruby
+config.parent_controller = "ApplicationController"
+```
+
+За подробным списком того, что можно сконфигурировать в Devise, обратитесь к его
+документации.
+
+#### Сделанные кастомизации в конфигурации Devise.
+
+Мы делаем небольшие изменения в конфигурации Devise по умолчанию. Вы можете это
+увидеть в [исходном коде гема](lib/identity/devise_config.rb).
+
+* `config.mailer_sender` – мы достаём это из переменной окружения MAIL_FROM.
+* `config.sign_out_via` – GET и только GET. Это должно работать без джаваскрипта.
+* `config.parent_controller` – мы не наследуемся от `ApplicationController` вашего
+  приложения. Devise предлагает для этого определять методы в
+  `ApplicationController`.Если вам нужно переопределить поведение аутентификационных
+  контроллеров, мы рекомендуем создать специальный базовый контроллер в
+  приложении и указать его в качестве `parent_controller`. Затем определять в
+  нём методы типа `after_sign_in_path_for`, как и предлагает Devise.
+
+### Логин через Facebook.
+
+Для того, чтобы включить в приложении логин через Facebook нужно:
+
+* подключить `gem 'omniauth-facebook'` в своем Gemfile.
+* указать `config.omniauth :facebook, ENV['FACEBOOK_KEY'], ENV['FACEBOOK_SECRET']`
+  в `config/initializers/identity.rb`.
+* создать приложение в Facebook можно с помощью [инструкции](https://getsocio.com/Help/How_to_set_up_Facebook_Application).
+
+### Логин через Twitter.
+
+Для того, чтобы включить в приложении логин через Twitter нужно:
+
+* подключить `gem 'omniauth-twitter'` в своем Gemfile.
+* указать `config.omniauth :twitter, ENV['TWITTER_KEY'], ENV['TWITTER_SECRET']`
+  в `config/initializers/identity.rb`.
+* создать приложение в Twitter можно [здесь](https://apps.twitter.com/).
+
+### Логин через Google.
+
+Для того, чтобы включить в приложении логин через Google нужно:
+
+* подключить `gem 'omniauth-google-oauth2'` в своем Gemfile.
+* указать `config.omniauth :google_oauth2, ENV['GOOGLE_KEY'], ENV['GOOGLE_SECRET']`
+  в `config/initializers/identity.rb`.
+* создать приложение в Google можно [здесь](https://console.developers.google.com/project).
+* для создания приложения можно воспользоваться [инструкцией](https://developers.google.com/identity/protocols/OpenIDConnect#appsetup)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "bundler/setup"
+
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+APP_RAKEFILE = File.expand_path("../spec/rails_app/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'

data/app/controllers/identity/base_controller.rb

@@ -0,0 +1,5 @@
+module Identity
+  class BaseController < ActionController::Base
+    layout Identity.layout
+  end
+end

data/app/controllers/identity/omniauth_callbacks_controller.rb

@@ -0,0 +1,24 @@
+module Identity
+  class OmniauthCallbacksController < Devise::OmniauthCallbacksController
+    def facebook
+      omniauth_login('Facebook')
+    end
+
+    def twitter
+      omniauth_login('Twitter')
+    end
+
+    def google_oauth2
+      omniauth_login('Google')
+    end
+
+    private
+
+    def omniauth_login(title)
+      @user = Identity::User.from_omniauth!(request.env["omniauth.auth"])
+
+      set_flash_message(:notice, :success, :kind => title) if is_navigational_format?
+      sign_in_and_redirect @user, :event => :authentication
+    end
+  end
+end

data/app/controllers/identity/users_controller.rb

@@ -0,0 +1,58 @@
+module Identity
+  class UsersController < ActionController::Base
+    layout Identity.admin_layout
+    before_action :ensure_allowed!
+    helper_method :resource, :resources
+
+    def index
+      @resources = User.search_and_order(params[:search], params[:page])
+    end
+
+    def show
+      redirect_to edit_identity_user_path(params[:id])
+    end
+
+    def edit
+      @resource = find_user
+    end
+
+    def update
+      @resource = find_user
+      if @resource.admin_update(user_params, current?(@resource))
+        @resource.skip_reconfirmation! if @resource.respond_to?(:skip_reconfirmation!)
+        @resource.save
+        redirect_to [Identity.admin_namespace, :users], notice: "#{@resource.email} updated."
+      else
+        render :edit
+      end
+    end
+
+    private
+
+    attr_reader :resource, :resources
+
+    def ensure_allowed!
+      unless Identity.admin_guard[current_user, self]
+        raise ActionController::RoutingError.new('Nothing here, move around')
+      end
+    end
+
+    def devise_mapping
+      request.env["devise.mapping"]
+    end
+
+    def current?(user)
+      user.id == current_user.id
+    end
+
+    def find_user
+      User.find params[:id]
+    end
+
+    def user_params
+      params.require(:identity_user).permit(
+        :email, :password, :password_confirmation, :active, Identity.admin_role
+      )
+    end
+  end
+end

data/app/models/identity/role.rb

@@ -0,0 +1,16 @@
+require "rolify"
+
+module Identity
+  class Role < ActiveRecord::Base
+    self.table_name = 'identity_roles'
+
+    has_and_belongs_to_many :users, :join_table => :identity_users_identity_roles
+    belongs_to :resource, :polymorphic => true
+
+    validates :resource_type,
+              :inclusion => { :in => Rolify.resource_types },
+              :allow_nil => true
+
+    scopify
+  end
+end

data/app/models/identity/user.rb

@@ -0,0 +1,47 @@
+require "devise"
+require "rolify"
+require "kaminari"
+
+module Identity
+  class User < ActiveRecord::Base
+    self.table_name = 'identity_users'
+    devise *Identity.devise_modules
+
+    if Devise.omniauth_providers.any?
+      devise :omniauthable, omniauth_providers: Devise.omniauth_providers
+    end
+
+    rolify role_cname: 'Identity::Role'
+
+    def self.from_omniauth!(auth)
+      where(provider: auth.provider, uid: auth.uid).first_or_create! do |user|
+        user.email = auth.provider == "twitter" ? "#{auth.info.nickname}_email@example.com" : auth.info.email
+        user.password = Devise.friendly_token[0,20]
+      end
+    end
+
+    define_singleton_method Identity.admins_method do
+      with_role(Identity.admin_role)
+    end
+
+    def self.find_first_by_auth_conditions(tainted_conditions, opts={active: true})
+      super
+    end
+
+    def self.active
+      result = where(active: true)
+      result = result.where.not(confirmed_at: nil) if devise_modules.include?(:confirmable)
+      result
+    end
+
+    def role_names
+      roles.pluck(:name).sort.join(', ')
+    end
+
+    define_method Identity.admin_role do
+      has_role?(Identity.admin_role)
+    end
+    alias_method Identity.admin_predicate, Identity.admin_role
+
+  end
+end

data/app/views/devise/confirmations/new.html.erb

@@ -0,0 +1,23 @@
+<div class="row">
+  <div class="col-sm-6">
+
+    <%= bootstrap_devise_error_messages! %>
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <h4><%= t('.resend_confirmation_instructions', :default => 'Resend confirmation instructions') %></h4>
+      </div>
+      <div class="panel-body">
+        <%= form_for(resource, :as => resource_name, :url => confirmation_path(resource_name), :html => { :method => :post, role: "form" }) do |f| %>
+          <div class="form-group">
+            <%= f.label :email %>
+            <%= f.email_field :email, autofocus: true, class: "form-control"  %>
+          </div>
+
+          <%= f.submit t('.resend_confirmation_instructions', :default => 'Resend confirmation instructions'), class: "btn btn-primary" %>
+        <% end %>
+      </div>
+    </div>
+
+<%= render "devise/shared/links" %>
+  </div>
+</div>

data/app/views/devise/mailer/confirmation_instructions.html.erb

@@ -0,0 +1,6 @@
+<p><%= t('.greeting', :recipient => @resource.email, :default => "Welcome #{@resource.email}!") %></p>
+
+<p><%= t('.instruction', :default => "You can confirm your account email through the link below:") %></p>
+
+<p><%= link_to t('.action', :default => "Confirm my account"),
+         confirmation_url(@resource, :confirmation_token => @token, locale: I18n.locale) %></p>

data/app/views/devise/mailer/reset_password_instructions.html.erb

@@ -0,0 +1,8 @@
+<p><%= t('.greeting', :recipient => @resource.email, :default => "Hello #{@resource.email}!") %></p>
+
+<p><%= t('.instruction', :default => "Someone has requested a link to change your password, and you can do this through the link below.") %></p>
+
+<p><%= link_to t('.action', :default => "Change my password"), edit_password_url(@resource, :reset_password_token => @token, locale: I18n.locale) %></p>
+
+<p><%= t('.instruction_2', :default => "If you didn't request this, please ignore this email.") %></p>
+<p><%= t('.instruction_3', :default => "Your password won't change until you access the link above and create a new one.") %></p>

data/app/views/devise/mailer/unlock_instructions.html.erb

@@ -0,0 +1,7 @@
+<p><%= t('.greeting', :recipient => @resource.email, :default => "Hello #{@resource.email}!") %></p>
+
+<p><%= t('.message', :default => "Your account has been locked due to an excessive amount of unsuccessful sign in attempts.") %></p>
+
+<p><%= t('.instruction', :default => "Click the link below to unlock your account:") %></p>
+
+<p><%= link_to t('.action', :default => "Unlock my account"), unlock_url(@resource, :unlock_token => @resource.unlock_token, locale: I18n.locale) %></p>

data/app/views/devise/passwords/edit.html.erb

@@ -0,0 +1,28 @@
+<div class="row">
+  <div class="col-sm-6">
+    <%= bootstrap_devise_error_messages! %>
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <h4><%= t('.change_your_password', :default => 'Change your password') %></h4>
+      </div>
+      <div class="panel-body">
+        <%= form_for(resource, :as => resource_name, :url => password_path(resource_name), :html => { :method => :put, role: "form" }) do |f| %>
+          <%= f.hidden_field :reset_password_token %>
+
+          <div class="form-group">
+            <%= f.label :password, t('.new_password', :default => 'New password') %>
+            <%= f.password_field :password, autofocus: true, class: "form-control"  %>
+          </div>
+
+          <div class="form-group">
+            <%= f.label :password_confirmation, t('.confirm_new_password', :default => 'Confirm new password') %>
+            <%= f.password_field :password_confirmation, class: "form-control"  %>
+          </div>
+
+          <%= f.submit t('.change_my_password', :default => 'Change my password'), class: "btn btn-primary" %>
+        <% end %>
+      </div>
+    </div>
+    <%= render "devise/shared/links" %>
+  </div>
+</div>