mission_kontrol_relay 0.1.0

data/README.md

@@ -0,0 +1,72 @@
+![MissionKontrol Logo](MissionKontrol-logo-original.png)
+
+# MissionKontrolRelay
+
+[![Gem Version](http://img.shields.io/gem/v/mission_kontrol_relay.svg?style=flat-square)](https://rubygems.org/gems/mission_kontrol_relay)
+[![License](http://img.shields.io/:license-gpl3-blue.svg?style=flat-square)](http://www.gnu.org/licenses/gpl-3.0.html)
+
+## Description
+
+[MissionKontrol](https://missionkontrol.io) is a simple and effective admin interface for your applications or microservices. It is a self hosted application that is quick and easy to set up, even if you aren't a developer. MissionKontrol doesn't need to know anything about your application(s) in order to work, it just needs to connect to your database(s).
+
+**MisisonKontrolRelay** is a gem that gives your version of MissionKontrol more power and better features by providing it with more information about your application (such as model associations and validations).
+
+Don't worry though, with the access token generated on install, only your hosted version of MissionKontrol will get access to this information.
+
+#### Do I have to be using MissionKontrol in order to use this gem?
+
+No! Anyone can use this gem. To see how you can use this gem outside of MissionKontrol, please see the 'endpoints' section below.
+
+## Installation instructions
+
+You can install **MissionKontrolRelay** into your Rails application by adding it into your gemfile:
+
+```ruby
+gem 'mission_kontrol_relay'
+```
+
+or you can install it manually:
+
+```bash
+$ gem install 'mission_kontrol_relay'
+```
+
+Once you have installed the gem you need to run the generator:
+
+```bash
+$ rails generate mission_kontrol_relay:install
+```
+
+The generator will generate your token and save it as an environment variable. You will need this to allow MissionKontrol to talk to your application, or if you want to access the provided endpoints.
+
+To access your token run the following:
+
+```bash
+$ printenv MISSION_KONTROL_TOKEN
+```
+
+## Contributing
+
+Before contributing please read the code of conduct [here](https://github.com/Mission-Kontrol/MissionKontrol-rails/CODE_OF_CONDUCT.md)
+
+Here is the contribution workflow:
+
+1. Fork the repo on GitHub
+2. Clone the project to your own machine
+3. Commit changes to your own branch
+4. Push your work back up to your fork
+5. Submit a Pull request so that we can review your changes
+
+### Getting set up
+
+```bash
+$ bundle install
+$ RAILS_ENV=test bundle exec rails db:setup
+$ RAILS_ENV=test bundle exec rails db:migrate
+```
+
+### Running tests
+
+```bash
+$ bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+# load 'rails/tasks/engine.rake'
+
+# load 'rails/tasks/statistics.rake'
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+Bundler::GemHelper.install_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/app/assets/javascripts/mission_kontrol_relay/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/mission_kontrol_relay/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/mission_kontrol_relay/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module MissionKontrolRelay
+  class ApplicationController < ActionController::Base
+    def index; end
+  end
+end

data/app/controllers/mission_kontrol_relay/models_controller.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module MissionKontrolRelay
+  class ModelsController < ApplicationController
+    before_action :validate_token
+    before_action :available_models
+
+    def associations
+      call_association_service
+
+      render json: @associations
+    end
+
+    def validations
+      call_validation_service
+
+      render json: @model_validations
+    end
+
+    private
+
+    def permitted_params
+      params.permit(:token)
+    end
+
+    def validate_token
+      token_matches = permitted_params[:token] == ENV['MISSION_KONTROL_TOKEN']
+      message = if permitted_params[:token] && !token_matches
+                  'Invalid token'
+                elsif permitted_params[:token].nil?
+                  'Please provide a token'
+                end
+
+      return if token_matches
+
+      render json: { error: message }, status: :unauthorized
+    end
+
+    def available_models
+      @available_models ||= MissionKontrolRelay::ModelRetrievalService.call
+    end
+
+    def call_association_service
+      @associations = []
+
+      @available_models.each do |model|
+        association = MissionKontrolRelay::AssociationMappingService.new(model)
+                                                                    .build
+        @associations << association
+      end
+    end
+
+    def call_validation_service
+      @model_validations = []
+
+      @available_models.each do |model|
+        validation = MissionKontrolRelay::ValidationMappingService.new(model)
+                                                                  .build
+        @model_validations << validation
+      end
+    end
+  end
+end

data/app/helpers/mission_kontrol_relay/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MissionKontrolRelay
+  module ApplicationHelper
+  end
+end

data/app/services/mission_kontrol_relay/association_mapping_service.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module MissionKontrolRelay
+  class AssociationMappingService
+    def initialize(model)
+      @model = model
+    end
+
+    def build
+      {
+        model: @model.name,
+        columns: model_columns,
+        associations: model_associations
+      }
+    end
+
+    private
+
+    def model_columns
+      columns = []
+
+      @model.columns.each do |column|
+        columns << {
+          column: column.name,
+          type: column.sql_type_metadata.type
+        }
+      end
+
+      columns
+    end
+
+    def model_associations
+      associations = []
+
+      @model.reflections.each do |association|
+        association = association.last
+        associations << {
+          associated_model: association.name,
+          type: association.macro,
+          options: association.try(:options)
+        }
+      end
+
+      associations
+    end
+  end
+end

data/app/services/mission_kontrol_relay/model_retrieval_service.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module MissionKontrolRelay
+  class ModelRetrievalService
+    class << self
+      def call
+        Rails.application.eager_load!
+        ActiveRecord::Base.descendants.collect do |table|
+          table if valid_table?(table)
+        end.compact
+      end
+
+      private
+
+      def valid_table?(table)
+        table.table_exists? && not_join_table?(table)
+      end
+
+      def not_join_table?(table)
+        table.to_s.split('::').last.split('_').first != 'HABTM'
+      end
+    end
+  end
+end

data/app/services/mission_kontrol_relay/validation_mapping_service.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module MissionKontrolRelay
+  class ValidationMappingService
+    def initialize(model)
+      @model = model
+    end
+
+    def build
+      {
+        model: @model.name,
+        validations: model_validations
+      }
+    end
+
+    private
+
+    def model_validations
+      validations = []
+
+      @model._validate_callbacks.to_a.each do |validation|
+        validations << validation_attributes(validation)
+      end
+
+      validations
+    end
+
+    def validation_attributes(validation)
+      {
+        key: remove_klass_from_key(validation),
+        type: validation.instance_variable_get(:@key).try(:kind),
+        kind: validation.kind,
+        name: validation.name,
+        attributes: validation.try(:filter).try(:attributes),
+        if: validation.instance_variable_get(:@if),
+        unless: validation.instance_variable_get(:@unless)
+      }
+    end
+
+    def remove_klass_from_key(validation)
+      key = validation.instance_variable_get(:@key)
+      if key.instance_variable_get(:@klass)
+        key.instance_variable_set(:@klass, nil)
+      end
+
+      key
+    end
+  end
+end

data/app/views/layouts/mission_kontrol_relay/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>MissionKontrolRelay</title>
+  <%= stylesheet_link_tag    "mission_kontrol_relay/application", media: "all" %>
+  <%= javascript_include_tag "mission_kontrol_relay/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mission_kontrol_relay'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/rails

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/mission_kontrol_relay/engine', __dir__)
+APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'