elasticgraph-rack 1.0.0.rc2 → 1.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99d3c8f9043cc6b186adcd98c13043f535c7bc3799b8c27766b4682b17c85483
-  data.tar.gz: 3dbd09242d3b24b476f8e2f320c069a563ccd3689b9456253dbd3cd3f1de47a4
+  metadata.gz: 86c85a72e61b8a2865506bf66e41b8bd1f371212aa94e0f4b5d3680da3ea1ec3
+  data.tar.gz: 4cbd5d3b3973367820e8cc32998dc3682b5ca6876789f844e48305e08234daa2
 SHA512:
-  metadata.gz: 6f65be0baaf5cfd267a5a061887e44fb7427cc09d233a9b9a174cdb20f77e4300628df152683fdb9435fd9a02ef197eb47899a3a861b79100d05a96e85e36211
-  data.tar.gz: a3ad8369393f155675efa43ceb49fb1f56598dc5c21da13a84721d2c6a5421c8450f33be7544dec0446891fbb1f4a25c1365712908f0a316846a7cab16ed5ac5
+  metadata.gz: b3948dc1d94660ce630e1fba86746b88151064ffc4d8a0bf50d6c7c7a36ea8a9d96246a16270cfe92c7c82a8bc803be64cbb4cd60b9be9add20e7c26b93b3139
+  data.tar.gz: 3333167137930e14e1380cd315068df3ef7c4900b3255613a610ef3f59cfa4f3aa403d4685b79f25336690efa7c2044f58bac84630127be1a22a2f831db48919

data/README.md

@@ -20,9 +20,9 @@ graph LR;
     rack["rack"];
     elasticgraph-rack --> rack;
     class rack externalGemStyle;
-    elasticgraph-local["elasticgraph-local"];
-    elasticgraph-local --> elasticgraph-rack;
-    class elasticgraph-local otherEgGemStyle;
+    elasticgraph-graphiql["elasticgraph-graphiql"];
+    elasticgraph-graphiql --> elasticgraph-rack;
+    class elasticgraph-graphiql otherEgGemStyle;
     click rack href "https://rubygems.org/gems/rack" "Open on RubyGems.org" _blank;
 ```
 
@@ -40,26 +40,3 @@ run ElasticGraph::Rack::GraphQLEndpoint.new(graphql)
 ```
 
 Run this with `rackup` (after installing the `rackup` gem) or any other rack-compatible server.
-
-## Serving a GraphiQL UI
-
-This gem also provides a simple GraphiQL UI using the CDN-hosted GraphiQL assets.
-Here's an example `config.ru` to boot that:
-
-``` ruby
-require 'elastic_graph/graphql'
-require 'elastic_graph/rack/graphiql'
-
-graphql = ElasticGraph::GraphQL.from_yaml_file("path/to/config.yaml")
-run ElasticGraph::Rack::GraphiQL.new(graphql)
-```
-
-Run this with `rackup` (after installing the `rackup` gem) or any other rack-compatible server.
-
-## License
-
-elasticgraph-rack is released under the [MIT License](https://opensource.org/licenses/MIT).
-
-[Part of the distributed code](lib/elastic_graph/rack/graphiql/index.html)
-comes from the [GraphiQL project](https://github.com/graphql/graphiql), also licensed under the
-MIT License, Copyright (c) GraphQL Contributors.

data/lib/elastic_graph/rack.rb

@@ -10,10 +10,7 @@ module ElasticGraph
   # Adapts an ElasticGraph GraphQL endpoint to run as a [Rack](https://github.com/rack/rack) application.
   # This allows an ElasticGraph GraphQL endpoint to run inside any [Rack-compatible web
   # framework](https://github.com/rack/rack#supported-web-frameworks), including [Ruby on Rails](https://rubyonrails.org/),
-  # or as a stand-alone application. Two configurations are supported:
-  #
-  # * Use {Rack::GraphQLEndpoint} to serve a GraphQL endpoint.
-  # * Use {Rack::GraphiQL} to serve a GraphQL endpoint and the [GraphiQL IDE](https://github.com/graphql/graphiql).
+  # or as a stand-alone application.
   module Rack
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph-rack
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.0.rc3
 platform: ruby
 authors:
 - Myron Marston
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -51,56 +51,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
 - !ruby/object:Gem::Dependency
   name: elasticgraph-elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
 - !ruby/object:Gem::Dependency
   name: elasticgraph-opensearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
 - !ruby/object:Gem::Dependency
   name: elasticgraph-indexer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
 email:
 - myron@squareup.com
 executables: []
@@ -110,19 +110,16 @@ files:
 - LICENSE.txt
 - README.md
 - lib/elastic_graph/rack.rb
-- lib/elastic_graph/rack/graphiql.rb
-- lib/elastic_graph/rack/graphiql/README.md
-- lib/elastic_graph/rack/graphiql/index.html
 - lib/elastic_graph/rack/graphql_endpoint.rb
 homepage: https://block.github.io/elasticgraph/
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc2
-  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc2/
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc3
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc3/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc2/elasticgraph-rack
+  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc3/elasticgraph-rack
   gem_category: local
 rdoc_options: []
 require_paths:

data/lib/elastic_graph/rack/graphiql/README.md

@@ -1,40 +0,0 @@
-## GraphiQL for ElasticGraph
-
-This directory provides the GraphiQL in browser UI for working with ElasticGraph
-applications.
-
-The `index.html` file is copied from:
-
-https://github.com/graphql/graphiql/blob/graphiql%402.4.0/examples/graphiql-cdn/index.html
-
-However, we've applied some slight changes to make it work for ElasticGraph.
-
-```diff
-diff --git a/elasticgraph-rack/lib/elastic_graph/rack/graphiql/index.html b/elasticgraph-rack/lib/elastic_graph/rack/graphiql/index.html
-index 55cf5d05..a672ead9 100644
---- a/elasticgraph-rack/lib/elastic_graph/rack/graphiql/index.html
-+++ b/elasticgraph-rack/lib/elastic_graph/rack/graphiql/index.html
-@@ -8,7 +8,7 @@
- <!DOCTYPE html>
- <html lang="en">
-   <head>
--    <title>GraphiQL</title>
-+    <title>ElasticGraph GraphiQL</title>
-     <style>
-       body {
-         height: 100%;
-@@ -58,7 +58,7 @@
-       ReactDOM.render(
-         React.createElement(GraphiQL, {
-           fetcher: GraphiQL.createFetcher({
--            url: 'https://swapi-graphql.netlify.app/.netlify/functions/index',
-+            url: '/graphql',
-           }),
-           defaultEditorToolsVisibility: true,
-         }),
-```
-
-## License
-
-[index.html](index.html) comes from the [GraphiQL project](https://github.com/graphql/graphiql),
-licensed under the MIT License, Copyright (c) GraphQL Contributors.

data/lib/elastic_graph/rack/graphiql/index.html

@@ -1,90 +0,0 @@
-<!--
- *  Copyright (c) 2021 GraphQL Contributors
- *  All rights reserved.
- *
- *  This source code is licensed under the GraphiQL license found at:
- *  https://github.com/graphql/graphiql/blob/graphiql%404.0.0/LICENSE
--->
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>ElasticGraph GraphiQL</title>
-    <style>
-      body {
-        margin: 0;
-        overflow: hidden; /* in Firefox */
-      }
-
-      #graphiql {
-        height: 100dvh;
-      }
-
-      .loading {
-        height: 100%;
-        display: flex;
-        align-items: center;
-        justify-content: center;
-        font-size: 4rem;
-      }
-    </style>
-    <link
-      rel="stylesheet"
-      href="https://esm.sh/graphiql@4.0.0/dist/style.css"
-    />
-    <link
-      rel="stylesheet"
-      href="https://esm.sh/@graphiql/plugin-explorer@4.0.0/dist/style.css"
-    />
-    <!-- Note: the ?standalone flag bundles the module along with all of its `dependencies`, excluding `peerDependencies`, into a single JavaScript file. -->
-    <script type="importmap">
-      {
-        "imports": {
-          "react": "https://esm.sh/react@19.1.0",
-          "react/jsx-runtime": "https://esm.sh/react@19.1.0/jsx-runtime",
-
-          "react-dom": "https://esm.sh/react-dom@19.1.0",
-          "react-dom/client": "https://esm.sh/react-dom@19.1.0/client",
-
-          "graphiql": "https://esm.sh/graphiql@4.0.0?standalone&external=react,react/jsx-runtime,react-dom,@graphiql/react",
-          "@graphiql/plugin-explorer": "https://esm.sh/@graphiql/plugin-explorer@4.0.0?standalone&external=react,react/jsx-runtime,react-dom,@graphiql/react,graphql",
-          "@graphiql/react": "https://esm.sh/@graphiql/react@0.30.0?standalone&external=react,react/jsx-runtime,react-dom,graphql,@graphiql/toolkit",
-
-          "@graphiql/toolkit": "https://esm.sh/@graphiql/toolkit@0.11.2?standalone&external=graphql",
-          "graphql": "https://esm.sh/graphql@16.11.0"
-        }
-      }
-    </script>
-    <script type="module">
-      // Import React and ReactDOM
-      import React from 'react';
-      import ReactDOM from 'react-dom/client';
-      // Import GraphiQL and the Explorer plugin
-      import { GraphiQL } from 'graphiql';
-      import { createGraphiQLFetcher } from '@graphiql/toolkit';
-      import { explorerPlugin } from '@graphiql/plugin-explorer';
-
-      const fetcher = createGraphiQLFetcher({
-        url: '/graphql',
-      });
-      const explorer = explorerPlugin();
-
-      function App() {
-        return React.createElement(GraphiQL, {
-          fetcher,
-          plugins: [explorer],
-        });
-      }
-
-      const container = document.getElementById('graphiql');
-      const root = ReactDOM.createRoot(container);
-      root.render(React.createElement(App));
-    </script>
-  </head>
-  <body>
-    <div id="graphiql">
-      <div class="loading">Loading…</div>
-    </div>
-  </body>
-</html>

data/lib/elastic_graph/rack/graphiql.rb

@@ -1,44 +0,0 @@
-# Copyright 2024 - 2025 Block, Inc.
-#
-# Use of this source code is governed by an MIT-style
-# license that can be found in the LICENSE file or at
-# https://opensource.org/licenses/MIT.
-#
-# frozen_string_literal: true
-
-require "elastic_graph/rack/graphql_endpoint"
-require "rack/builder"
-require "rack/static"
-
-module ElasticGraph
-  module Rack
-    # A [Rack](https://github.com/rack/rack) application that serves both an ElasticGraph GraphQL endpoint
-    # and a [GraphiQL IDE](https://github.com/graphql/graphiql). This can be used for local development,
-    # mounted in a [Rails](https://rubyonrails.org/) application, or run in any other Rack-compatible context.
-    #
-    # @example Simple config.ru to run GraphiQL as a Rack application, targeting an ElasticGraph endpoint
-    #   require "elastic_graph/graphql"
-    #   require "elastic_graph/rack/graphiql"
-    #
-    #   graphql = ElasticGraph::GraphQL.from_yaml_file("config/settings/development.yaml")
-    #   run ElasticGraph::Rack::GraphiQL.new(graphql)
-    module GraphiQL
-      # Builds a [Rack](https://github.com/rack/rack) application that serves both an ElasticGraph GraphQL endpoint
-      # and a [GraphiQL IDE](https://github.com/graphql/graphiql).
-      #
-      # @param graphql [ElasticGraph::GraphQL] ElasticGraph GraphQL instance
-      # @return [Rack::Builder] built Rack application
-      def self.new(graphql)
-        graphql_endpoint = ElasticGraph::Rack::GraphQLEndpoint.new(graphql)
-
-        ::Rack::Builder.new do
-          use ::Rack::Static, urls: {"/" => "index.html"}, root: ::File.join(__dir__, "graphiql")
-
-          map "/graphql" do
-            run graphql_endpoint
-          end
-        end
-      end
-    end
-  end
-end