vandal_ui 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 215b66b45930873c596c7cac0777dabc9514c415
-  data.tar.gz: 49fc0f3f6ef119b79215493988f8f0958ed991a1
+  metadata.gz: 403cbddb72e485e62f024ea8cfc47e9e3efaccc1
+  data.tar.gz: 3785dabe03246e647faf9bb14976166065a77b87
 SHA512:
-  metadata.gz: 9a7154a6ac29fdc83748cd43f8e983b2cf6764e8381f155e0e61326187f1b3655fcebb3e80d83547ae83dd5ca3381c60bac3cd961ffd72f763d18e301ec61c01
-  data.tar.gz: ea5618976944dda41c74d54e7c7bea886f031af84c0b8ffcf2ba4ef1cc4b294244f69f482704bd1fbf57c504d738261b5750187d97161ad0b3b57f4f621913aa
+  metadata.gz: 39f13c66cf2a8f8f8c1969e05fddf897802070736554c1b8875324ecf24285c6645f32ef0002c9119055ade346c70b7dc80514974183d786ce0004af7f37bf61
+  data.tar.gz: 54c6994b1077e716b5a54ee647a7e83badccf35a64bc7d6b157eef1ed15bebe06838f61053495e0ad5ce89e5552d47525b849dc7f09a89c56b9d56c4cbc631f4

data/README.md

@@ -1 +1,23 @@
-# Vandal
+# Vandal UI
+
+This is a Rails engine for
+[Graphiti](https://graphiti-api.github.io/graphiti/guides/) APIs. It has
+two main functions:
+
+* `rake vandal:install` will copy static files to `public/<api_namespace>`.
+* Mounting the engine adds an endpoint for a dynamically-generated
+  schema file:
+
+```ruby
+# config/routes.rb
+
+scope path: ApplicationResource.endpoint_namespace, defaults: { format: :jsonapi } do
+  # ... routes ...
+
+  mount VandalUi::Engine, at: '/vandal'
+end
+```
+
+If `ApplicationRecord.endpoint_namespace` is `/api/v1`, you'd get a
+`/api/v1/vandal/schema.json` that would be referenced when loading the
+UI.

data/app/controllers/vandal_ui/schemas_controller.rb

@@ -0,0 +1,6 @@
+class VandalUi::SchemasController < ActionController::API
+  def show
+    Rails.application.eager_load!
+    render json: Graphiti::Schema.generate
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+VandalUi::Engine.routes.draw do
+  get '/schema', to: 'vandal_ui/schemas#show'
+end

data/lib/vandal_ui.rb

@@ -1,5 +1,6 @@
 require "vandal_ui/version"
 require "vandal_ui/railtie" if defined?(Rails)
+require "vandal_ui/engine" if defined?(Rails)
 
 module VandalUi
 end

data/lib/vandal_ui/engine.rb

@@ -0,0 +1,4 @@
+module VandalUi
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/vandal_ui/tasks.rb

@@ -2,7 +2,9 @@ namespace :vandal do
   task :install do
     cfg = YAML.load_file("#{Rails.root}/.graphiticfg.yml")
     namespace = cfg['namespace']
-    schema_path = "#{namespace}/schema.json"
+
+    vandal_path = VandalUi::Engine.routes.find_script_name({})
+    schema_path = "#{vandal_path}/schema.json"
 
     source = File.join(File.dirname(__FILE__), 'static')
     destination = "#{Rails.root}/public/#{namespace}"

data/lib/vandal_ui/version.rb

@@ -1,3 +1,3 @@
 module VandalUi
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vandal_ui
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Lee Richmond
@@ -66,9 +66,12 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- app/controllers/vandal_ui/schemas_controller.rb
 - bin/console
 - bin/setup
+- config/routes.rb
 - lib/vandal_ui.rb
+- lib/vandal_ui/engine.rb
 - lib/vandal_ui/railtie.rb
 - lib/vandal_ui/static/assets/img/squares.png
 - lib/vandal_ui/static/css/app.ef4cd70f.css