elasticgraph-rack 0.18.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b67497d866092a00cf5bdd62d1498d4207b69c3d5117ef026e284ec28ff6911e
+  data.tar.gz: f3074f28918c80cc01d4f54413144557cb289b82b5313a6e1b5a3c55968adab1
+SHA512:
+  metadata.gz: 8a86bbbc5e58025acbd83020b638fe8e6a2a3bec78f7b6821ce9ffbe0cf9693c948af42debcb24272fa9eec0623e8780df8309c63d2cd3c924846169e50ba9e2
+  data.tar.gz: 3db0fc284aba5d738cd7b4e6dab0f20cd933b4ad0148e15fd35db292ccc71e01d3a86c8a1011e8228668f6d51dee62d17df60aec3ef40286362d319eef8735ee

data/LICENSE.txt

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Block, Inc.
+
+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.
+
+Part of the distributed code (lib/elastic_graph/rack/graphiql/index.html)
+comes from the GraphiQL project, licensed under the MIT License. Copyright (c) GraphQL Contributors.

data/README.md

@@ -0,0 +1,36 @@
+# ElasticGraph::Rack
+
+Uses [Rack](https://github.com/rack/rack) to serve an ElasticGraph application.
+Intended primarily to make it easy to boot ElasticGraph applications locally,
+but could also be used to serve an ElasticGraph application from any Rack
+compatible web server.
+
+## Serving an ElasticGraph GraphQL Endpoint
+
+`ElasticGraph::Rack::GraphQLEndpoint` is a Rack application. Here's an
+example of using it in a Rack `config.ru` file:
+
+```ruby
+require 'elastic_graph/graphql'
+require 'elastic_graph/rack/graphql_endpoint'
+
+graphql = ElasticGraph::GraphQL.from_yaml_file("path/to/config.yaml")
+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.

data/elasticgraph-rack.gemspec

@@ -0,0 +1,22 @@
+# Copyright 2024 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_relative "../gemspec_helper"
+
+ElasticGraphGemspecHelper.define_elasticgraph_gem(gemspec_file: __FILE__, category: :local) do |spec, eg_version|
+  spec.summary = "ElasticGraph gem for serving an ElasticGraph GraphQL endpoint using rack."
+
+  spec.add_dependency "elasticgraph-graphql", eg_version
+  spec.add_dependency "rack", "~> 3.1"
+
+  spec.add_development_dependency "elasticgraph-admin", eg_version
+  spec.add_development_dependency "elasticgraph-elasticsearch", eg_version
+  spec.add_development_dependency "elasticgraph-opensearch", eg_version
+  spec.add_development_dependency "elasticgraph-indexer", eg_version
+  spec.add_development_dependency "rack-test", "~> 2.1"
+end

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

@@ -0,0 +1,38 @@
+## GraphiQL for ElasticGraph
+
+This directory provides the GraphiQL in browser UI for working with ElasticGraph
+applications. The GraphiQL license is included in `LICENSE.txt`, copied verbatim
+from:
+
+https://github.com/graphql/graphiql/blob/graphiql%402.4.0/LICENSE
+
+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,
+         }),
+```

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

@@ -0,0 +1,69 @@
+<!--
+ *  Copyright (c) 2021 GraphQL Contributors
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the license found in the
+ *  LICENSE file in the root directory of this source tree.
+-->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>ElasticGraph GraphiQL</title>
+    <style>
+      body {
+        height: 100%;
+        margin: 0;
+        width: 100%;
+        overflow: hidden;
+      }
+
+      #graphiql {
+        height: 100vh;
+      }
+    </style>
+
+    <!--
+      This GraphiQL example depends on Promise and fetch, which are available in
+      modern browsers, but can be "polyfilled" for older browsers.
+      GraphiQL itself depends on React DOM.
+      If you do not want to rely on a CDN, you can host these files locally or
+      include them directly in your favored resource bundler.
+    -->
+    <script
+      src="https://unpkg.com/react@17/umd/react.development.js"
+      integrity="sha512-Vf2xGDzpqUOEIKO+X2rgTLWPY+65++WPwCHkX2nFMu9IcstumPsf/uKKRd5prX3wOu8Q0GBylRpsDB26R6ExOg=="
+      crossorigin="anonymous"
+    ></script>
+    <script
+      src="https://unpkg.com/react-dom@17/umd/react-dom.development.js"
+      integrity="sha512-Wr9OKCTtq1anK0hq5bY3X/AvDI5EflDSAh0mE9gma+4hl+kXdTJPKZ3TwLMBcrgUeoY0s3dq9JjhCQc7vddtFg=="
+      crossorigin="anonymous"
+    ></script>
+
+    <!--
+      These two files can be found in the npm module, however you may wish to
+      copy them directly into your environment, or perhaps include them in your
+      favored resource bundler.
+     -->
+    <link rel="stylesheet" href="https://unpkg.com/graphiql/graphiql.min.css" />
+  </head>
+
+  <body>
+    <div id="graphiql">Loading...</div>
+    <script
+      src="https://unpkg.com/graphiql/graphiql.min.js"
+      type="application/javascript"
+    ></script>
+    <script>
+      ReactDOM.render(
+        React.createElement(GraphiQL, {
+          fetcher: GraphiQL.createFetcher({
+            url: '/graphql',
+          }),
+          defaultEditorToolsVisibility: true,
+        }),
+        document.getElementById('graphiql'),
+      );
+    </script>
+  </body>
+</html>

data/lib/elastic_graph/rack/graphiql.rb

@@ -0,0 +1,31 @@
+# Copyright 2024 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/static"
+
+module ElasticGraph
+  module Rack
+    # A Rack app that exposes both a GraphQL endpoint and an admin UI using GraphiQL:
+    #
+    # https://github.com/graphql/graphiql/tree/graphiql%402.4.0
+    module GraphiQL
+      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

data/lib/elastic_graph/rack/graphql_endpoint.rb

@@ -0,0 +1,52 @@
+# Copyright 2024 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/graphql/http_endpoint"
+require "rack"
+
+module ElasticGraph
+  module Rack
+    # A simple Rack wrapper around an ElasticGraph endpoint. This can be used for local development,
+    # or mounted in a Rails app, or run in any other rack-compatible context.
+    class GraphQLEndpoint
+      def initialize(graphql)
+        @logger = graphql.logger
+        @graphql_http_endpoint = graphql.graphql_http_endpoint
+      end
+
+      def call(env)
+        rack_request = ::Rack::Request.new(env)
+
+        # Rack doesn't provide a nice method to provide all HTTP headers. In general,
+        # HTTP headers are prefixed with `HTTP_` as per https://stackoverflow.com/a/6318491/16481862,
+        # but `Content-Type`, as a "standard" header, isn't exposed that way, sadly.
+        headers = env
+          .select { |k, v| k.start_with?("HTTP_") }
+          .to_h { |k, v| [k.delete_prefix("HTTP_"), v] }
+          .merge("Content-Type" => rack_request.content_type)
+
+        request = GraphQL::HTTPRequest.new(
+          http_method: rack_request.request_method.downcase.to_sym,
+          url: rack_request.url,
+          headers: headers,
+          body: rack_request.body&.read
+        )
+
+        response = @graphql_http_endpoint.process(request)
+
+        [response.status_code, response.headers.transform_keys(&:downcase), [response.body]]
+      rescue => e
+        raise if ENV["RACK_ENV"] == "test"
+
+        @logger.error "Got an exception: #{e.class.name}: #{e.message}\n\n#{e.backtrace.join("\n")}"
+        error = {message: e.message, exception_class: e.class, backtrace: e.backtrace}
+        [500, {"content-type" => "application/json"}, [::JSON.generate(errors: [error])]]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,369 @@
+--- !ruby/object:Gem::Specification
+name: elasticgraph-rack
+version: !ruby/object:Gem::Version
+  version: 0.18.0.0
+platform: ruby
+authors:
+- Myron Marston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: flatware-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-opensearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-indexer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email:
+- myron@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- elasticgraph-rack.gemspec
+- 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: 
+licenses:
+- MIT
+metadata:
+  gem_category: local
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: ElasticGraph gem for serving an ElasticGraph GraphQL endpoint using rack.
+test_files: []