biovision-oauth 0.0.201128.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58299a9672161f625c64eef352414e80fd5fcde97a2f801971cb48f43177542e
+  data.tar.gz: a588979ec66d7c9c74a571427ce04fca8c7af18a997b729c2f032dadabbfdddf
+SHA512:
+  metadata.gz: 59a7bf98adbd024c685b8cf4396759157df0d5cb94e458538c01175a895f9706757d2c4ebd295a37599c321ec2a10552ace3b84cbae5ad604684e055bbf2dd9d
+  data.tar.gz: 4ba465f0b14e2fb5bd48efece77e26535591e32292eadc43d6278f394813977348b410508603abaf5471b5879f23d8ccd64121d7ecbbb3d81b6fe60cbff72062

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Maxim Khan-Magomedov
+
+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,28 @@
+# Biovision::Oauth
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'biovision-oauth'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install biovision-oauth
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Biovision::Oauth'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/test_app/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/controllers/oauth_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Authentication with OAuth
+class OauthController < ApplicationController
+  include Authentication
+
+  before_action :redirect_authenticated_user
+  before_action :set_foreign_site
+
+  # get /auth/:provider/callback
+  def auth_callback
+    data = request.env['omniauth.auth']
+    user = @foreign_site.authenticate(data, tracking_for_entity)
+    create_token_for_user(user) unless user.banned?
+
+    redirect_to my_path
+  end
+
+  private
+
+  def set_foreign_site
+    @foreign_site = ForeignSite[params[:provider]]
+
+    handle_http_503('Cannot set foreign site') if @foreign_site.nil?
+  end
+end

data/app/lib/biovision/components/oauth_component.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    # OAuth component
+    class OauthComponent < BaseComponent
+    end
+  end
+end

data/app/models/foreign_site.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Foreign site for external authentication
+# 
+# Attributes:
+#   slug [string]
+#   name [string]
+#   foreign_users_count [integer]
+class ForeignSite < ApplicationRecord
+  include RequiredUniqueName
+  include RequiredUniqueSlug
+
+  NAME_LIMIT = 50
+  SLUG_LIMIT = 50
+
+  has_many :foreign_users, dependent: :delete_all
+
+  validates_length_of :name, maximum: NAME_LIMIT
+  validates_length_of :slug, maximum: SLUG_LIMIT
+
+  scope :list_for_administration, -> { ordered_by_name }
+
+  # @param [String] slug
+  def self.[](slug)
+    find_by(slug: slug)
+  end
+
+  # @param [Hash] data
+  # @param [Hash] tracking
+  def authenticate(data, tracking)
+    user = foreign_users.find_by(slug: data[:uid])&.user
+    user || create_user(data, tracking)
+  end
+end

data/app/models/foreign_user.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Foreign user
+# 
+# Attributes:
+#   agent_id [Agent], optional
+#   created_at [DateTime]
+#   data [jsonb]
+#   foreign_site_id [ForeignSite]
+#   ip_address_id [IpAddress], optional
+#   updated_at [DateTime]
+#   user_id [User]
+#   slug [string]
+class ForeignUser < ApplicationRecord
+  include HasOwner
+  include HasTrack
+
+  belongs_to :foreign_site
+  belongs_to :user
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  controller :oauth do
+    get 'auth/:provider/callback' => :auth_callback, as: :auth_callback
+  end
+end

data/db/migrate/20201127000000_create_oauth_component.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Create tables for Users component
+class CreateOauthComponent < ActiveRecord::Migration[6.0]
+  def up
+    create_component
+    create_foreign_sites unless ForeignSite.table_exists?
+    create_foreign_users unless ForeignUser.table_exists?
+  end
+
+  def down
+    [ForeignUser, ForeignSite].each do |model|
+      drop_table model.table_name if model.table_exists?
+    end
+
+    BiovisionComponent[Biovision::Components::OauthComponent.slug]&.destroy
+  end
+
+  private
+
+  def create_component
+    slug = Biovision::Components::OauthComponent.slug
+    BiovisionComponent.create(slug: slug)
+  end
+
+  def create_foreign_sites
+    create_table :foreign_sites, comment: 'Sites for external authentication' do |t|
+      t.string :slug, null: false
+      t.string :name, null: false
+      t.integer :foreign_users_count, default: 0, null: false
+    end
+
+    add_index :foreign_sites, :slug, unique: true
+  end
+
+  def create_foreign_users
+    create_table :foreign_users, comment: 'Users from external sites' do |t|
+      t.references :foreign_site, null: false, foreign_key: { on_update: :cascade, on_delete: :cascade }
+      t.references :user, null: false, foreign_key: { on_update: :cascade, on_delete: :cascade }
+      t.references :agent, foreign_key: { on_update: :cascade, on_delete: :nullify }
+      t.references :ip_address, foreign_key: { on_update: :cascade, on_delete: :nullify }
+      t.string :slug, null: false
+      t.timestamps
+      t.jsonb :data, default: {}, null: false
+    end
+
+    add_index :foreign_users, :data, using: :gin
+  end
+end

data/lib/biovision/oauth.rb

@@ -0,0 +1,7 @@
+require "biovision/oauth/engine"
+
+module Biovision
+  module Oauth
+    # Your code goes here...
+  end
+end

data/lib/biovision/oauth/engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'biovision'
+
+module Biovision
+  module Oauth
+    # Biovision OAuth engine
+    class Engine < ::Rails::Engine
+      config.generators do |g|
+        g.test_framework :rspec
+        g.fixture_replacement :factory_bot, dir: 'spec/factories'
+      end
+
+      initializer 'sample_engine.factories', after: 'factory_bot.set_factory_paths' do
+        FactoryBot.definition_file_paths << File.expand_path('../../../spec/factories', __FILE__) if defined?(FactoryBot)
+      end
+    end
+  end
+end

data/lib/biovision/oauth/version.rb

@@ -0,0 +1,5 @@
+module Biovision
+  module Oauth
+    VERSION = '0.0.201128.0'
+  end
+end

data/lib/tasks/biovision/oauth_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :biovision_oauth do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: biovision-oauth
+version: !ruby/object:Gem::Version
+  version: 0.0.201128.0
+platform: ruby
+authors:
+- Maxim Khan-Magomedov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+- !ruby/object:Gem::Dependency
+  name: rails-i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: biovision
+  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
+  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: factory_bot_rails
+  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: rspec-rails
+  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: pg
+  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: OAuth component for Biovision CMS.
+email:
+- maxim.km@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/biovision_oauth_manifest.js
+- app/controllers/oauth_controller.rb
+- app/lib/biovision/components/oauth_component.rb
+- app/models/foreign_site.rb
+- app/models/foreign_user.rb
+- config/routes.rb
+- db/migrate/20201127000000_create_oauth_component.rb
+- lib/biovision/oauth.rb
+- lib/biovision/oauth/engine.rb
+- lib/biovision/oauth/version.rb
+- lib/tasks/biovision/oauth_tasks.rake
+homepage: https://github.com/Biovision/biovision-oauth
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: OAuth component for Biovision CMS
+test_files: []