care 0.1.0

data/lib/patch/action_controller/concerns/authorization.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+#   Модуль с фунциями для авторизации
+module Authorization
+  extend ActiveSupport::Concern
+
+  included do
+    include CanCan::ControllerAdditions
+    # before_action :authorize_profile!
+    cattr_accessor :authorized_permissions
+    attr_reader :actual_permission_ids,
+      :current_organization_id,
+      :current_account_id,
+      :permissions, :restrictions
+
+    check_authorization
+
+    def current_ability
+      @current_ability ||= Ability.new(permissions, restrictions, current_organization_id, current_account_id)
+    end
+
+    def current_account_id
+      access_token[:account][:id]
+    end
+
+    def current_organization_id
+      @current_organization_id ||= request.headers[:organization_id]
+    end
+
+    def permissions
+      @permissions ||= access_token[:permissions][current_organization_id]&.map(&:to_sym) || []
+    end
+
+    def restrictions
+      @restrictions ||= access_token[:permissions][current_organization_id]&.map(&:to_sym) || []
+    end
+
+    def include_permission?(permission)
+      permissions.include?(permission)
+    end
+
+    def include_restriction?(restriction)
+      restrictions.include?(restriction)
+    end
+  end
+end

data/lib/patch/action_controller/concerns/exception_handler.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# require 'jwt'
+require "cancancan"
+require "active_support/rescuable"
+
+module ExceptionHandler
+  extend ActiveSupport::Concern
+
+  included do
+    # Вернуть 400 - Bad Request, если параметры ошибочны
+    rescue_from ActiveRecord::StatementInvalid, ActionController::ParameterMissing do |e|
+      Rails.logger.error e.to_s
+      render json: { errors: [e.message] }, status: :bad_request
+    end
+
+    # Вернуть 401 - unauthorized, если учетная запись неавторизована
+    rescue_from Authentication::AuthenticationError, ::JWT::DecodeError do |e|
+      render json: { errors: [e.message] }, status: :unauthorized
+    end
+
+    # Вернуть 403 - Forbidden
+    rescue_from ::CanCan::AccessDenied do |_e|
+      render json: { errors: ["У вас нет прав доступа к этому ресурсу"] },
+             status: :forbidden
+    end
+
+    # Вернуть 404 - Not Found
+    rescue_from ProfileNotBindedError do |e|
+      render json: { errors: [e.message] }, status: :not_found
+    end
+
+    # Вернуть 404 - Not Found, если запись в БД отсутствует
+    rescue_from ActiveRecord::RecordNotFound do |_e|
+      render json: { errors: ["Запись не найдена"] }, status: :not_found
+    end
+
+    # Вернуть 422 - Unprocessable Entity, если при записе в БД произошли ошибки, либо не пройдена валидация
+    # в ответ возвращаем дополнительно структуру с описанием ошибок
+    rescue_from ActiveRecord::RecordInvalid do |e|
+      render json: { errors: [e.message], source: e.record.errors.as_json }, status: :unprocessable_entity
+    end
+  end
+
+  #
+  #  Используется для сигнализации ошибки, что аккаунт не прикреплен ни к одному профилю
+  #
+  class ProfileNotBindedError < StandardError
+    attr_reader :param
+
+    def initialize(param)
+      @param = param
+      super("No active profile: #{param}")
+    end
+  end
+
+  #
+  #  Используется для сигнализации ошибки, что нельзя отвязать аккаунт
+  #
+  class AccountUnbindDisallowedError < StandardError
+    attr_reader :param
+
+    def initialize
+      super("Невозможно отвязать аккаунт от профиля, если это единственный или активный профиль")
+    end
+  end
+end

data/lib/patch/action_controller/concerns/filter_sort_pagination.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Методы фильтрации сортировки и паджинации
+# rubocop:disable Metrics/CyclomaticComplexity
+# rubocop:disable Metrics/PerceivedComplexity
+module FilterSortPagination
+  extend ActiveSupport::Concern
+
+  included do
+    prepend_after_action :set_filter_headers
+
+    # Установить(добавить) информацию о пагинации в заголовок ответа
+    #
+    # @param [String, Symbol] collection_name имя переменной в которой хранится коллекция
+    # @param [Hash] options дополнительные параметры для колбека
+    def self.set_pagination_headers(collection_name, options = {})
+      after_action(options) do |_controller|
+        if params[:page].present?
+          collection = instance_variable_get("@#{collection_name}")
+
+          request_params = request.query_parameters
+          unless request_params.empty?
+            url_without_params = request.original_url.slice(0..(request.original_url.index("?") - 1))
+          end
+          url_without_params ||= request.original_url
+
+          page = {}
+          if collection.total_pages > 1 && !collection.first_page?
+            page[:first] = 1
+          end
+          if collection.total_pages > 1 && !collection.last_page?
+            page[:last] = collection.total_pages
+          end
+          page[:next] = collection.current_page + 1 unless collection.last_page?
+          unless collection.first_page?
+            page[:prev] = collection.current_page - 1
+          end
+
+          pagination_links = []
+          page.each do |k, v|
+            new_request_hash = request_params.merge(page: v)
+            pagination_links << "<#{url_without_params}?#{new_request_hash.to_param}>; rel=\"#{k}\""
+          end
+
+          headers["Link"] = pagination_links.join(", ")
+          headers["X-Pagination-Count"] = collection.total_count
+          headers["X-Pagination-Page"] = collection.current_page
+          headers["X-Pagination-Limit"] = collection.limit_value
+
+          # TODO : удалить после того как UI переделают под новый формат заголовка
+          #
+          headers["X-Pagination"] = {
+            limit: collection.limit_value,
+            total_pages: collection.total_pages,
+            prev_page: collection.prev_page,
+            current_page: collection.current_page,
+            next_page: collection.next_page,
+            first_page: collection.first_page?,
+            last_page: collection.last_page?,
+            out_of_range: collection.out_of_range?,
+          }.to_json
+        end
+      end
+    end
+
+    # Optional query parameters
+    #
+    #   - limit   ограничение количества записей в выборке
+    #               (пример: ?limit=5)
+    #
+    #   - page    номер страницы(по умолчанию 15 записей на одну страницу)
+    #               (пример: ?page=1)
+    #
+    #   - sort    сортировка, указывается поле и порядок сортировки
+    #               (пример: ?sort=created_asc)
+    #
+    #   - search  поиск по совпадению с частью вводимого значения
+    #               (пример: ?search=wat_name_part)
+    #
+    #   - name    поиск по совпадению с частью вводимого значения(search alias)
+    #               (пример: ?name=wat_name_part)
+    #
+    def filter_params
+      params.permit(:page, :limit, :sort, :search, :name).to_h
+    end
+
+    def set_filter_headers
+      if filter_params[:search].present?
+        headers["X-Search"] = filter_params[:search]
+      end
+      if filter_params[:sort].present?
+        headers["X-Sort"] = filter_params[:sort]
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/CyclomaticComplexity
+# rubocop:enable Metrics/PerceivedComplexity

metadata

@@ -0,0 +1,321 @@
+--- !ruby/object:Gem::Specification
+name: care
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Валерий Маханов
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-24 00:00:00.000000000 Z
+dependencies:
+- !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: activerecord-import
+  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: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.10
+- !ruby/object:Gem::Dependency
+  name: centrifuge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  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: cancancan
+  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: kaminari
+  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: faker
+  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: rspec-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: shoulda-matchers
+  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: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !ruby/object:Gem::Dependency
+  name: dotenv-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: database_cleaner-active_record
+  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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Common concerns for docshell microservices
+email:
+- v.mahanov@isoit.ru
+executables:
+- care
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- care.gemspec
+- exe/care
+- lib/care.rb
+- lib/care/auto_finder/by_ids.rb
+- lib/care/auto_finder/findable.rb
+- lib/care/auto_finder/finder_methods.rb
+- lib/care/auto_finder/paginateble.rb
+- lib/care/auto_finder/searchable.rb
+- lib/care/auto_finder/searcher.rb
+- lib/care/auto_finder/sortable.rb
+- lib/care/finder.rb
+- lib/care/jwt_service.rb
+- lib/care/rspec.rb
+- lib/care/seed.rb
+- lib/care/support/authorization_helper.rb
+- lib/care/support/error_collection.rb
+- lib/care/support/factory_bot.rb
+- lib/care/support/pagination.rb
+- lib/care/support/parameters.rb
+- lib/care/support/request_helper.rb
+- lib/care/version.rb
+- lib/generators/care/install/USAGE
+- lib/generators/care/install/install_generator.rb
+- lib/generators/care/install/templates/.env.local.example
+- lib/generators/care/install/templates/active_model_serializer.rb
+- lib/generators/care/install/templates/centrifuge.rb
+- lib/generators/care/install/templates/rswag-ui.rb
+- lib/generators/care/install/templates/rswag_api.rb
+- lib/generators/care/install/templates/swagger.yml
+- lib/generators/care/install/templates/swagger_helper.rb
+- lib/patch/action_controller/api.rb
+- lib/patch/action_controller/concerns/authentication.rb
+- lib/patch/action_controller/concerns/authorization.rb
+- lib/patch/action_controller/concerns/exception_handler.rb
+- lib/patch/action_controller/concerns/filter_sort_pagination.rb
+homepage: https://gitlab.isoit.ru/ruby/sgrc/care
+licenses: []
+metadata:
+  homepage_uri: https://gitlab.isoit.ru/ruby/sgrc/care
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Care
+test_files: []