rails-eve-base 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a68959fd927ad4c992808f6cab371f09e9a3f259ef4694c34954c853f77b8ae3
+  data.tar.gz: 4cef303650b2382036fb399588baa12b12c3fc4929cb8de8a9f1a0ca42e92164
+SHA512:
+  metadata.gz: ddf6c10d56a437b237110f184e89aafbf0817b60e1c9b30b0a693fca0c9a5a119e3838e5958a7bf0cc6a11c0a9d7c3a304fea9bc96a0d8c6875f071ade77c2f2
+  data.tar.gz: dc92945403dfb37ae13cc7ee9636eb26a2af7803c8a75016c59061989580e473e473769963c3a34aaa70d45a8397e83c00494098b63f72f273af06d5f2b2d561

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Adam Ladachowski
+
+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,78 @@
+# rails-eve-base
+
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d7c41f3367264949827b5bd74cc12fa0)](https://app.codacy.com/app/aladac/rails-eve-base?utm_source=github.com&utm_medium=referral&utm_content=aladac/rails-eve-base&utm_campaign=Badge_Grade_Dashboard)
+
+Since I never seem to finish bigger EVE related projects, I decided to release some of the stuff I've been using so far as a sort of a template.
+
+If this stuff possibly helps anyone write cool stuff for EVE, big bonus.
+
+With this gem you can generate a basic structure for a EVE Online Ruby on Rails project
+
+## Usage
+
+You can use this to bootstrap a EVE Online related Rails project. I probably just could have made it a template for the `rails` command but I realised that half way :D
+
+First:
+
+```bash
+bundle add rails-eve-base # within your rails project root
+```
+
+Then:
+
+```bash
+rails generate rails_eve:install
+```
+And you should see:
+
+```bash
+gemfile  omniauth-crest
+gemfile  devise
+gemfile  mongoid
+gemfile  ruby-esi
+generate  mongoid:config
+ create  config/mongoid.yml
+ create  config/initializers/omniauth.rb
+ create  app/lib/mongoid_setup.rb
+ create  app/models/concerns/esi_character_api.rb
+ create  app/models/character.rb
+ create  app/models/alliance.rb
+ create  app/models/corporation.rb
+ create  config/initializers/devise.rb
+ create  app/models/user.rb
+ create  app/controllers/users/omniauth_callbacks_controller.rb
+ insert  config/routes.rb
+```
+
+
+## Installation
+
+Within your project root run:
+
+```bash
+bundle add --group development rails-eve-base
+```
+
+Or do it the longer way:
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-eve-base'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails-eve-base
+```
+
+## Contributing
+Have an idea? Forkity fork, fork and make your changes check if they work then pop a pull request
+
+## 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,29 @@
+# frozen_string_literal: true
+
+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    = 'Rails::Eve::Base'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/rails_eve/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/rails_eve/install/install_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RailsEve
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def install
+      gem 'omniauth-crest'
+      gem 'devise'
+      gem 'mongoid'
+      gem 'ruby-esi'
+
+      generate 'mongoid:config'
+
+      copy_file 'characters_controller.rb', './app/controllers/character_controller.rb'
+      copy_file 'rails-eve-base.html.slim', './app/views/layouts/rails-eve-base.html.slim'
+      copy_file 'index.html.slim', './app/views/characters/index.html.slim'
+      copy_file 'omniauth.rb', './config/initializers/omniauth.rb'
+      copy_file 'mongoid_setup.rb', './app/lib/mongoid_setup.rb'
+      copy_file 'esi_character_api.rb', './app/models/concerns/esi_character_api.rb'
+      copy_file 'character.rb', './app/models/character.rb'
+      copy_file 'alliance.rb', './app/models/alliance.rb'
+      copy_file 'corporation.rb', './app/models/corporation.rb'
+      copy_file 'devise.rb', './config/initializers/devise.rb', force: true
+      copy_file 'user.rb', './app/models/user.rb', force: true
+      copy_file 'omniauth_callbacks_controller.rb', './app/controllers/users/omniauth_callbacks_controller.rb'
+      inject_into_file './config/routes.rb', after: "Rails.application.routes.draw do\n" do
+        <<-'RUBY'
+  devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/rails_eve/install/templates/alliance.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Alliance
+  include MongoidSetup
+  field :name, type: String
+  field :ticker, type: String
+  field :characters_count, type: Integer, default: 0
+  has_many :corporations
+  has_many :characters
+
+  def self.update_counter_caches
+    all.each do |user|
+      user.characters_count = user.characters.count
+      user.save
+    end
+  end
+
+  def self.create_from_api(alliance_id)
+    api_alliance = ESI::AllianceApi.new.get_alliances_alliance_id(alliance_id)
+    where(id: alliance_id, name: api_alliance.name, ticker: api_alliance.ticker).first_or_create
+  end
+end

data/lib/generators/rails_eve/install/templates/character.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Character
+  include MongoidSetup
+  include EsiCharacterApi
+  field :name, type: String
+  field :access_token, type: String
+  field :refresh_token, type: String
+  field :token_expires, type: Time
+  field :display_option, type: String
+  belongs_to :corporation, optional: true, counter_cache: true
+  belongs_to :alliance, optional: true, counter_cache: true
+  belongs_to :user, counter_cache: true
+
+  after_save :create_corporation
+
+  def create_corporation
+    Corporation.create_from_api(corporation_id)
+  end
+
+  def wallet_journal
+    wallet_api.get_characters_character_id_wallet_journal(id)
+  end
+end

data/lib/generators/rails_eve/install/templates/characters_controller.rb

@@ -0,0 +1,8 @@
+class CharactersController < ApplicationController
+  before_action :authenticate_user!
+  layout 'rails-eve-base'
+  
+  def index
+    @characters = current_user.characters
+  end
+end

data/lib/generators/rails_eve/install/templates/corporation.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Corporation
+  include MongoidSetup
+  field :name, type: String
+  field :npc, type: Boolean
+  field :ticker, type: String
+  field :characters_count, type: Integer, default: 0
+  belongs_to :alliance, optional: true
+  has_many :characters
+  after_save :create_alliance
+
+  def self.update_counter_caches
+    all.each do |user|
+      user.characters_count = user.characters.count
+      user.save
+    end
+  end
+
+  def self.create_from_api(corporation_id)
+    api_corporation = ESI::CorporationApi.new.get_corporations_corporation_id(corporation_id)
+    where(id: corporation_id, name: api_corporation.name, ticker: api_corporation.ticker, alliance_id: api_corporation.alliance_id).first_or_create
+  end
+
+  def create_alliance
+    return false unless alliance_id
+
+    Alliance.create_from_api(alliance_id)
+  end
+end

data/lib/generators/rails_eve/install/templates/devise.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+Devise.setup do |config|
+  config.secret_key = '5db398209eb5511b119c0973bbee2da55be0fa11d6cd27c411d79d04439b846b8747a3cffd20700fe0f1191ee54f60a1316ade15a2baf43ce471ff9c9ef702be'
+  config.mailer_sender = 'evescore@evescore.online'
+  require 'devise/orm/mongoid'
+  config.case_insensitive_keys = [:email]
+  config.strip_whitespace_keys = [:email]
+  config.skip_session_storage = [:http_auth]
+  config.stretches = Rails.env.test? ? 1 : 11
+  config.reconfirmable = true
+  config.expire_all_remember_me_on_sign_out = true
+  config.password_length = 6..128
+  config.email_regexp = /\A[^@\s]+@[^@\s]+\z/
+  config.reset_password_within = 6.hours
+  config.sign_out_via = :delete
+  config.omniauth :esi, 'd8e64f0d0a4e4a4d867052b0c93ec01e', 'cZQvip2l9Yy7tbzmjiBCerxhsXJ3iwHHxpEy7OBW', scope: 'esi-wallet.read_character_wallet.v1'
+end

data/lib/generators/rails_eve/install/templates/esi_character_api.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module EsiCharacterApi
+  extend ActiveSupport::Concern
+
+  def update_tokens(credentials)
+    self.access_token = credentials['token']
+    self.refresh_token = credentials['refresh_token']
+    self.token_expires = Time.zone.at credentials['expires_at']
+    save
+  end
+
+  def refresh_token!
+    return false if Time.zone.now < token_expires
+
+    self.access_token = refresh_token_request.access_token
+    self.refresh_token = refresh_token_request.refresh_token
+    self.token_expires = Time.zone.now + refresh_token_request.expires_in
+    save
+  end
+
+  def refresh_token_request
+    request = Typhoeus.post('https://login.eveonline.com/oauth/token', headers: refresh_token_headers, body: refresh_token_body)
+    OpenStruct.new(JSON.parse(request.body))
+  end
+
+  def refresh_token_headers
+    { 'Content-Type' => 'application/json', 'Authorization' => authorization_header }
+  end
+
+  def refresh_token_body
+    { grant_type: 'refresh_token', refresh_token: refresh_token }.to_json
+  end
+
+  def current_access_token
+    refresh_token!
+    access_token
+  end
+
+  def authorization_header
+    secrets = OpenStruct.new Rails.application.config_for(:secrets)
+    app_id = secrets.eve_api_app_id
+    app_secret = secrets.eve_api_app_secret
+    auth = Base64.strict_encode64("#{app_id}:#{app_secret}")
+    "Basic #{auth}"
+  end
+
+  def api_client
+    client = ESI::ApiClient.new
+    client.config.access_token = current_access_token
+    client
+  end
+
+  def wallet_api
+    ESI::WalletApi.new(api_client)
+  end
+end

data/lib/generators/rails_eve/install/templates/index.html.pug

@@ -0,0 +1,6 @@
+table.table.table-small
+  - @characters.each do |character|
+    tr
+      td.name = character.name
+      td.corporation = character.corporation.name
+      

data/lib/generators/rails_eve/install/templates/mongoid_setup.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module MongoidSetup
+  extend ActiveSupport::Concern
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include GlobalID::Identification
+end

data/lib/generators/rails_eve/install/templates/omniauth.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Strategies
+    class ESI < OmniAuth::Strategies::Crest
+      option :name, :esi
+      option :authorize_options, %i[scope state redirect_uri]
+
+      def callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      end
+    end
+  end
+end

data/lib/generators/rails_eve/install/templates/omniauth_callbacks_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  before_action :set_user
+  def esi
+    if @user.persisted?
+      import_character
+      sign_in_and_redirect_with_flash
+    else
+      redirect_to new_user_registration_url
+    end
+  end
+
+  protected
+
+  def set_user
+    @user = User.from_omniauth request.env['omniauth.auth']
+  end
+
+  def import_character
+    @user.import_character request.env['omniauth.auth']
+  end
+
+  def sign_in_and_redirect_with_flash
+    sign_in_and_redirect @user, event: :authentication # this will throw if @user is not activated
+    set_flash_message(:notice, :success, kind: 'EVE Online') if is_navigational_format?
+  end
+end

data/lib/generators/rails_eve/install/templates/rails-eve-base.html.slim

@@ -0,0 +1,8 @@
+doctype
+html
+  head
+    title rails-eve-base example
+    link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.3.1/css/bootstrap.min.css"
+body
+  .container-fluid
+    == yield

data/lib/generators/rails_eve/install/templates/user.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class User
+  include MongoidSetup
+  field :characters_count, type: Integer, default: 0
+  devise :database_authenticatable, :registerable, :omniauthable,
+         :rememberable, :trackable
+
+  field :email,              type: String, default: ''
+  field :encrypted_password, type: String, default: ''
+  field :reset_password_token,   type: String
+  field :reset_password_sent_at, type: Time
+  field :remember_created_at, type: Time
+  field :sign_in_count,      type: Integer, default: 0
+  field :current_sign_in_at, type: Time
+  field :last_sign_in_at,    type: Time
+  field :current_sign_in_ip, type: String
+  field :last_sign_in_ip,    type: String
+  field :confirmation_token,   type: String
+  field :confirmed_at,         type: Time
+  field :confirmation_sent_at, type: Time
+  field :unconfirmed_email,    type: String # Only if using reconfirmable
+  field :uid,                  type: Integer
+  field :provider,             type: String
+
+  has_many :characters
+
+  def will_save_change_to_email?; end
+
+  def self.update_counter_caches
+    all.each do |user|
+      user.characters_count = user.characters.count
+      user.save
+    end
+  end
+
+  def self.from_omniauth(auth)
+    where(provider: auth.provider, uid: auth.uid).first_or_create do |user|
+      user.email = SecureRandom.hex
+      user.password = Devise.friendly_token[0, 20]
+    end
+  end
+
+  def self.create_from_omniauth(payload)
+    u = new
+    u.uid = payload.uid
+    u.password = SecureRandom.hex
+    u.email = 'example@example.com'
+    u.save
+  end
+
+  def character_api
+    ESI::CharacterApi.new
+  end
+
+  def import_character(omniauth_payload)
+    character_id = omniauth_payload['extra']['raw_info']['CharacterID']
+    api_character = character_api.get_characters_character_id(character_id)
+    credentials = omniauth_payload['credentials']
+    character = characters.where(id: character_id, name: api_character.name, corporation_id: api_character.corporation_id, alliance_id: api_character.alliance_id).first_or_create
+    character.update_tokens(credentials)
+  end
+end

data/lib/rails/eve/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rails/eve/base/railtie'
+
+module Rails
+  module Eve
+    module Base
+      # Your code goes here...
+    end
+  end
+end

data/lib/rails/eve/base/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Rails
+  module Eve
+    module Base
+      class Railtie < ::Rails::Railtie
+      end
+    end
+  end
+end

data/lib/rails/eve/base/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rails
+  module Eve
+    module Base
+      VERSION = '0.1.3'
+    end
+  end
+end

data/lib/tasks/rails/eve/base_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :rails_eve_base do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: rails-eve-base
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Adam Ladachowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: sqlite3
+  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: Main runtime of EVE Online RoR plugins
+email:
+- adam@saiden.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/environment
+- lib/generators/rails_eve/install/USAGE
+- lib/generators/rails_eve/install/install_generator.rb
+- lib/generators/rails_eve/install/templates/alliance.rb
+- lib/generators/rails_eve/install/templates/character.rb
+- lib/generators/rails_eve/install/templates/characters_controller.rb
+- lib/generators/rails_eve/install/templates/corporation.rb
+- lib/generators/rails_eve/install/templates/devise.rb
+- lib/generators/rails_eve/install/templates/esi_character_api.rb
+- lib/generators/rails_eve/install/templates/index.html.pug
+- lib/generators/rails_eve/install/templates/mongoid_setup.rb
+- lib/generators/rails_eve/install/templates/omniauth.rb
+- lib/generators/rails_eve/install/templates/omniauth_callbacks_controller.rb
+- lib/generators/rails_eve/install/templates/rails-eve-base.html.slim
+- lib/generators/rails_eve/install/templates/user.rb
+- lib/rails/eve/base.rb
+- lib/rails/eve/base/railtie.rb
+- lib/rails/eve/base/version.rb
+- lib/tasks/rails/eve/base_tasks.rake
+homepage: https://github.com/aladac/rails-eve-base
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Main runtime of EVE Online RoR plugins
+test_files: []