evematic 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7565c6e469317d256f491a395e804ae26cd7d5ceab1462ea7e0bc3ec92af0915
-  data.tar.gz: 5e0a73ce00bec88e3a6519315f7c2bc56bcca59135269f5fcf5c977769e00181
+  metadata.gz: d16f6d328d5aea704d82573875c449e09f134461a20ff38625616b818a1b6015
+  data.tar.gz: c4d141a17d434effacde6518ad13b4e82811df234bf69110e114a347df825b83
 SHA512:
-  metadata.gz: 9a3972c7130e2684a72c9576867b3fd70a2c5d9b4aac1efb9047ee2f08e67abaed435cd3370f635e6102adcc982c0393c821de9058ee3a4fe12befbe91fe14e1
-  data.tar.gz: fd2601c9d2a6ccdf4fef2ce5b422f41a8774d95b2c0c98d487ef107b3c1312a8aef6db03bd9e2e662f9b11631c3fc2da3c2efd640d689b513129b20dc49aca94
+  metadata.gz: 9ffdbb85c44a34add6302b1cb206e8ccc1015306e429240164b00c2fbb91b66570abad783fb31794f1f52f22f745f5cc1f529f1571cb9dfb614ed05b53c63fd9
+  data.tar.gz: 42e449b89c3bca4a2075974d0e40fa6e61fcb1b42756ae6f53f80146ef8f28d00158225829595f7875bd1660412fbc9f44813f8995ac3a3a0230bd401abb506f

data/app/controllers/evematic/sessions_controller.rb

@@ -0,0 +1,21 @@
+class Evematic::SessionsController < Evematic::ApplicationController
+  def new
+    redirect_to after_login_path if logged_in?
+  end
+
+  def destroy
+    log_out
+    redirect_to after_logout_path
+  end
+
+  private
+
+  def auth_controller?
+    true
+  end
+
+  def log_out
+    session[:current_identity_id] = nil
+    session[:current_account_id] = nil
+  end
+end

data/app/controllers/evematic/sso_callbacks_controller.rb

@@ -0,0 +1,30 @@
+class Evematic::SSOCallbacksController < Evematic::ApplicationController
+  def eve
+    auth = request.env["omniauth.auth"]
+    character = esi_character_model.find_or_create_by(id: auth.uid)
+    identity = identity_model.sso_authenticate_by(character)
+    if identity&.persisted?
+      log_in(identity)
+      redirect_to(stored_location || after_login_path)
+    else
+      flash[:error] = t(".forbidden", name: character.name)
+      redirect_to login_path
+    end
+  end
+
+  def failure
+    flash.now[:error] = t(".not_authorized")
+    redirect_to login_path
+  end
+
+  private
+
+  def auth_controller?
+    true
+  end
+
+  def log_in(identity)
+    session[:current_identity_id] = identity.id
+    session[:current_account_id] = identity.account_id
+  end
+end

data/app/models/evematic/access_rule.rb

@@ -0,0 +1,17 @@
+# == Schema Information
+#
+# Table name: access_rules
+#
+#  id             :integer          not null, primary key
+#  action         :string           default("deny"), not null
+#  principal_type :string           not null
+#  created_at     :datetime         not null
+#  principal_id   :integer          not null
+#
+# Indexes
+#
+#  index_access_rules_on_principal  (principal_type,principal_id) UNIQUE
+#
+class Evematic::AccessRule < Evematic::ApplicationRecord
+  include Evematic::Models::Mixins::AccessRule
+end

data/app/models/evematic/account.rb

@@ -0,0 +1,12 @@
+# == Schema Information
+#
+# Table name: accounts
+#
+#  id         :integer          not null, primary key
+#  admin      :boolean
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+class Evematic::Account < Evematic::ApplicationRecord
+  include Evematic::Models::Mixins::Account
+end

data/app/models/evematic/application_record.rb

@@ -1,5 +1,3 @@
-module Evematic
-  class Evematic::ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
+class Evematic::ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
 end

data/app/models/evematic/esi/alliance.rb

@@ -0,0 +1,25 @@
+# == Schema Information
+#
+# Table name: esi_alliances
+#
+#  id                      :integer          not null, primary key
+#  date_founded            :date             not null
+#  esi_etag                :string
+#  esi_expires_at          :datetime
+#  esi_last_modified_at    :datetime
+#  name                    :string           not null
+#  ticker                  :string           not null
+#  created_at              :datetime         not null
+#  updated_at              :datetime         not null
+#  creator_corporation_id  :integer          not null
+#  creator_id              :integer          not null
+#  executor_corporation_id :integer
+#  faction_id              :integer
+#
+# Indexes
+#
+#  index_esi_alliances_on_ticker  (ticker) UNIQUE
+#
+class Evematic::ESI::Alliance < Evematic::ApplicationRecord
+  include Evematic::Models::Mixins::ESI::Alliance
+end

data/app/models/evematic/esi/character.rb

@@ -0,0 +1,35 @@
+# == Schema Information
+#
+# Table name: esi_characters
+#
+#  id                   :integer          not null, primary key
+#  birthday             :date             not null
+#  description          :text
+#  esi_etag             :string
+#  esi_expires_at       :datetime
+#  esi_last_modified_at :datetime
+#  gender               :string           not null
+#  name                 :string           not null
+#  security_status      :decimal(, )
+#  title                :string
+#  created_at           :datetime         not null
+#  updated_at           :datetime         not null
+#  alliance_id          :integer
+#  bloodline_id         :integer          not null
+#  corporation_id       :integer          not null
+#  faction_id           :integer
+#  race_id              :integer          not null
+#
+# Indexes
+#
+#  index_esi_characters_on_alliance_id     (alliance_id)
+#  index_esi_characters_on_corporation_id  (corporation_id)
+#
+# Foreign Keys
+#
+#  alliance_id     (alliance_id => esi_alliances.id)
+#  corporation_id  (corporation_id => esi_corporations.id)
+#
+class Evematic::ESI::Character < Evematic::ApplicationRecord
+  include Evematic::Models::Mixins::ESI::Character
+end

data/app/models/evematic/esi/corporation.rb

@@ -0,0 +1,37 @@
+# == Schema Information
+#
+# Table name: esi_corporations
+#
+#  id                   :integer          not null, primary key
+#  date_founded         :date             not null
+#  description          :text
+#  esi_etag             :string
+#  esi_expires_at       :datetime
+#  esi_last_modified_at :datetime
+#  member_count         :integer          not null
+#  name                 :string           not null
+#  shares               :bigint
+#  tax_rate             :decimal(, )      not null
+#  ticker               :string           not null
+#  url                  :string
+#  war_eligible         :boolean
+#  created_at           :datetime         not null
+#  updated_at           :datetime         not null
+#  alliance_id          :integer
+#  ceo_id               :integer          not null
+#  creator_id           :integer          not null
+#  faction_id           :integer
+#  home_station_id      :integer
+#
+# Indexes
+#
+#  index_esi_corporations_on_alliance_id  (alliance_id)
+#  index_esi_corporations_on_ticker       (ticker) UNIQUE
+#
+# Foreign Keys
+#
+#  alliance_id  (alliance_id => esi_alliances.id)
+#
+class Evematic::ESI::Corporation < Evematic::ApplicationRecord
+  include Evematic::Models::Mixins::ESI::Corporation
+end

data/app/models/evematic/identity.rb

@@ -0,0 +1,24 @@
+# == Schema Information
+#
+# Table name: identities
+#
+#  id           :integer          not null, primary key
+#  main         :boolean
+#  created_at   :datetime         not null
+#  updated_at   :datetime         not null
+#  account_id   :integer          not null
+#  character_id :integer          not null
+#
+# Indexes
+#
+#  index_identities_on_account_id_and_character_id  (account_id,character_id) UNIQUE
+#  index_identities_on_account_id_and_main          (account_id,main) UNIQUE
+#
+# Foreign Keys
+#
+#  account_id    (account_id => accounts.id)
+#  character_id  (character_id => esi_characters.id)
+#
+class Evematic::Identity < Evematic::ApplicationRecord
+  include Evematic::Models::Mixins::Identity
+end

data/config/i18n-tasks.yml

@@ -15,7 +15,7 @@ data:
 
   # Locale files or `File.find` patterns where translations are read from:
   read:
-    - config/locales/**/*.%{locale}.yml
+    # - config/locales/{locale}.yml
     ## Default:
     # - config/locales/%{locale}.yml
     ## More files:
@@ -54,8 +54,10 @@ data:
 # Find translate calls
 search:
   ## Paths or `File.find` patterns to search in:
-  # paths:
-  #  - app/
+  paths:
+    - app/
+    - lib/evematic/controllers
+    - lib/evematic/views
 
   ## Root directories for relative keys resolution.
   # relative_roots:
@@ -119,7 +121,6 @@ search:
 
 ## Consider these keys used:
 ignore_unused:
-  - evematic.engine.name
 # - 'activerecord.attributes.*'
 # - '{devise,kaminari,will_paginate}.*'
 # - 'simple_form.{yes,no}'

data/config/locales/en.yml

@@ -0,0 +1,13 @@
+---
+en:
+  evematic:
+    errors:
+      login_required: You need to log in to do that.
+    sessions:
+      new:
+        login_button_label: Log in with EVE Online SSO
+    sso_callbacks:
+      eve:
+        forbidden: "%{name} is not authorized to log in."
+      failure:
+        not_authorized: Character is not authorized to log in.

data/lib/evematic/configuration/builder.rb

@@ -0,0 +1,74 @@
+require "dry-configurable"
+
+class Evematic::Configuration::Builder
+  include Dry::Configurable
+
+  delegate_missing_to :config
+
+  setting :authentication_enabled, default: true
+
+  setting :esi_base_url, default: "https://esi.evetech.net"
+  setting :esi_client_id, default: -> { ENV.fetch("ESI_CLIENT_ID") }
+  setting :esi_client_secret, default: -> { ENV.fetch("ESI_CLIENT_SECRET") }
+  setting :esi_detailed_logging, default: false
+  setting :esi_retry_options, default: {}
+  setting :esi_user_agent, default: "Evematic/1.0 (+https://evematic.dev)"
+
+  setting :esi_alliance_class, default: "Evematic::ESI::Alliance"
+  setting :esi_alliances_table, default: "esi_alliances"
+
+  setting :esi_character_class, default: "Evematic::ESI::Character"
+  setting :esi_characters_table, default: "esi_characters"
+
+  setting :esi_corporation_class, default: "Evematic::ESI::Corporation"
+  setting :esi_corporations_table, default: "esi_corporations"
+
+  setting :access_rule_class, default: "Evematic::AccessRule"
+  setting :access_rules_table, default: "access_rules"
+
+  setting :account_class, default: "Evematic::Account"
+  setting :accounts_table, default: "accounts"
+
+  setting :identity_class, default: "Evematic::Identity"
+  setting :identities_table, default: "identities"
+
+  setting :after_login_path, default: -> { root_path }
+  setting :after_logout_path, default: -> { root_path }
+
+  def clear_cache!
+    %i[
+      access_rule_model
+      account_model
+      esi_alliance_model
+      esi_character_model
+      esi_corporation_model
+      identity_model
+    ].each do |var|
+      remove_instance_variable("@#{var}") if instance_variable_defined?("@#{var}")
+    end
+  end
+
+  def esi_alliance_model
+    @esi_alliance_model ||= config.esi_alliance_class.safe_constantize
+  end
+
+  def esi_character_model
+    @esi_character_model ||= config.esi_character_class.safe_constantize
+  end
+
+  def esi_corporation_model
+    @esi_corporation_model ||= config.esi_corporation_class.safe_constantize
+  end
+
+  def access_rule_model
+    @access_rule_model ||= config.access_rule_class.safe_constantize
+  end
+
+  def account_model
+    @account_model ||= config.account_class.safe_constantize
+  end
+
+  def identity_model
+    @identity_model ||= config.identity_class.safe_constantize
+  end
+end

data/lib/evematic/configuration.rb

@@ -0,0 +1,20 @@
+module Evematic
+  module Configuration
+    require "evematic/configuration/builder"
+  end
+
+  class << self
+    def configuration_builder
+      @configuration_builder ||= Evematic::Configuration::Builder.new
+    end
+
+    def configuration
+      configuration_builder
+    end
+    alias_method :config, :configuration
+
+    def configure(&block)
+      configuration_builder.configure(&block)
+    end
+  end
+end

data/lib/evematic/controllers/helper.rb

@@ -0,0 +1,7 @@
+module Evematic::Controllers::Helper
+  extend ActiveSupport::Concern
+
+  def not_found
+    raise ActionController::RoutingError.new("Not Found")
+  end
+end

data/lib/evematic/controllers/helpers/authentication.rb

@@ -0,0 +1,90 @@
+module Evematic::Controllers::Helpers::Authentication
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :logged_in?, :current_account, :current_identity
+  end
+
+  def require_login!
+    return true if current_identity
+
+    flash[:error] = t("evematic.errors.login_required")
+    store_location(request.fullpath)
+    redirect_to login_path
+  end
+
+  def require_admin!
+    not_found unless current_account&.admin?
+  end
+
+  def logged_in?
+    current_identity_id.present?
+  end
+
+  def current_account_id
+    session[:current_account_id]
+  end
+
+  def current_account
+    @current_account ||= account_model.find_by(id: current_account_id)
+  end
+
+  def current_identity_id
+    session[:current_identity_id]
+  end
+
+  def current_identity
+    @current_identity ||= identity_model.includes(:character, :corporation, :alliance).find_by(id: current_identity_id)
+  end
+
+  # Helper methods taken from Devise
+  # https://github.com/heartcombo/devise/blob/main/lib/devise/controllers/store_location.rb
+
+  def storable_location?
+    request.get? && request.format.to_sym == :html && !auth_controller? && !request.xhr?
+  end
+
+  def store_location(location)
+    path = extract_path_from_location(location)
+    session["return_to"] = path if path
+  end
+
+  def stored_location
+    if request.format.to_sym == :html
+      session.delete("return_to")
+    else
+      session["return_to"]
+    end
+  end
+
+  def parse_uri(location)
+    location && URI.parse(location)
+  rescue URI::InvalidURIError
+    nil
+  end
+
+  def extract_path_from_location(location)
+    uri = parse_uri(location)
+
+    if uri
+      path = remove_domain_from_uri(uri)
+      add_fragment_back_to_path(uri, path)
+    end
+  end
+
+  def remove_domain_from_uri(uri)
+    [uri.path.sub(/\A\/+/, "/"), uri.query].compact.join("?")
+  end
+
+  def add_fragment_back_to_path(uri, path)
+    [path, uri.fragment].compact.join("#")
+  end
+
+  def after_login_path
+    root_path
+  end
+
+  def after_logout_path
+    root_path
+  end
+end

data/lib/evematic/controllers.rb

@@ -0,0 +1,2 @@
+module Evematic::Controllers
+end

data/lib/evematic/engine.rb

@@ -1,15 +1,34 @@
-Gem.loaded_specs["evematic"].dependencies.each do |dep|
-  require dep.name
+require "rails"
+require "omniauth"
+require "omniauth/strategies/eve_online"
+require "omniauth/rails_csrf_protection"
+require "turbo-rails"
+
+require "evematic/configuration"
+require "evematic/esi"
+require "evematic/models"
+
+OmniAuth::Strategies::EVEOnline.class_eval do
+  # Hack to allow passing scope as a query parameter to /auth/eve
+  def callback_url
+    full_host + callback_path
+  end
 end
 
 class Evematic::Engine < ::Rails::Engine
-  isolate_namespace Evematic
+  config.evematic = Evematic.config
 
-  config.app_middleware.use(
-    Rack::Static,
-    urls: ["evematic-assets"],
-    root: Evematic::Engine.root.join("public")
-  )
+  config.to_prepare do
+    Evematic.setup
+  end
+
+  initializer "evematic.assets" do
+    config.middleware.use(
+      Rack::Static,
+      urls: ["evematic"],
+      root: Evematic::Engine.root.join("public")
+    )
+  end
 
   initializer "evematic.inflections" do
     ActiveSupport::Inflector.inflections(:en) do |inflect|
@@ -22,4 +41,59 @@ class Evematic::Engine < ::Rails::Engine
       inflect.acronym "UI"
     end
   end
+
+  initializer "evematic.routes" do
+    ActionDispatch::Routing::Mapper.include Evematic::Routes::Helper
+  end
+
+  initializer "evematic.action_controller" do
+    ActiveSupport.on_load(:action_controller) do
+      include Evematic::Models::Helper
+      include Evematic::Controllers::Helper
+      include Evematic::Controllers::Helpers::Authentication if Evematic.config.authentication_enabled
+    end
+  end
+
+  initializer "evematic.action_view" do
+    ActiveSupport.on_load(:action_view) do
+      include Evematic::Models::Helper
+      include Evematic::Views::Helper
+    end
+  end
+
+  initializer "evematic.active_job" do
+    ActiveSupport.on_load(:active_job) do
+      include Evematic::Models::Helper
+      include Evematic::Jobs::Helper
+    end
+  end
+
+  initializer "evematic.active_record" do
+    ActiveSupport.on_load(:active_record) do
+      include Evematic::Models::Helper
+    end
+  end
+
+  initializer "evematic.i18n" do |app|
+    app.config.i18n.raise_on_missing_translations = true if Rails.env.local?
+  end
+
+  initializer "evematic.omniauth" do |app|
+    next unless Evematic.config.authentication_enabled
+
+    OmniAuth.config.logger = Rails.logger
+
+    app.middleware.use OmniAuth::Builder do
+      provider OmniAuth::Strategies::EVEOnline,
+        name: :eve,
+        setup: lambda { |env|
+          req = Rack::Request.new(env)
+          env["omniauth.strategy"].tap do |strategy|
+            strategy.options[:client_id] = Evematic.config.esi_client_id
+            strategy.options[:client_secret] = Evematic.config.esi_client_secret
+            strategy.options[:scope] = req.params["scope"]
+          end
+        }
+    end
+  end
 end

data/lib/evematic/esi/client.rb

@@ -0,0 +1,89 @@
+require "dry-initializer"
+require "faraday"
+require "faraday/detailed_logger"
+require "faraday/http_cache"
+require "faraday/retry"
+require "faraday/typhoeus"
+
+class Evematic::ESI::Client
+  extend Dry::Initializer
+
+  option :base_url, default: -> { Evematic.config.esi_base_url }
+  option :cache, default: -> { Rails.cache }
+  option :detailed_logging, default: -> { Evematic.config.esi_detailed_logging }
+  option :logger, default: -> { Rails.logger }
+  option :instrumenter, default: -> { ActiveSupport::Notifications }
+  option :user_agent, default: -> { Evematic.config.esi_user_agent }
+
+  def delete(path, body: nil, params: {}, token: nil)
+    json_encoded.delete(path) do |req|
+      req.body = body
+      req.params = params
+      req.headers = default_headers
+      req.headers = headers(token)
+    end
+  end
+
+  def get(path, params: {}, token: nil)
+    url_encoded.get(path) do |req|
+      req.params = params
+      req.headers = headers(token)
+    end
+  end
+
+  def post(path, body: nil, params: {}, token: nil)
+    json_encoded.post(path) do |req|
+      req.body = body
+      req.params = params
+      req.headers = headers(token)
+    end
+  end
+
+  def put(path, body: nil, params: {}, token: nil)
+    json_encoded.put(path) do |req|
+      req.body = body
+      req.params = params
+      req.headers = headers(token)
+    end
+  end
+
+  private
+
+  def headers(token)
+    h = default_headers
+    h[:authorization] = authorization_header(token) if token
+    h
+  end
+
+  def default_headers
+    {user_agent: user_agent.strip}
+  end
+
+  def authorization_header(token)
+    "Authorization: Bearer #{token}"
+  end
+
+  def url_encoded
+    @url_encoded ||= Faraday.new(url: base_url) do |conn|
+      conn.use(:http_cache, store: cache, logger:, instrumenter:)
+      conn.request :url_encoded
+      conn.request :retry, retry_options
+      conn.response :detailed_logger, logger if detailed_logging
+      conn.adapter :typhoeus
+    end
+  end
+
+  def json_encoded
+    @json_encoded ||= Faraday.new(url: base_url) do |conn|
+      conn.use(:http_cache, store: cache, logger:, instrumenter:)
+      conn.request :json
+      conn.request :retry, retry_options
+      conn.response :detailed_logger, logger if detailed_logging
+      conn.adapter :typhoeus
+    end
+  end
+
+  def retry_options
+    @retry_options ||= Evematic.config.esi_retry_options.to_h.merge(retry_statuses: [503, 504])
+  end
+end