elasticgraph-rack 0.18.0.4 → 0.18.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14d33b44e9817d113303341528dbdde1ca057537cc4cd957339a96d1d3da8db1
-  data.tar.gz: 6807905235fe5c5d42d9f75995684c913b0a8f2254fdccd474fca507fe4e9734
+  metadata.gz: 1af5a7a0745d67b84546ebea7bbf38bd2d2fc4dffad88e80d60d3eb629255996
+  data.tar.gz: 8ed374c529b14ab86294ded8872631a6ef6406b5960e832ffd48c54e50ca8861
 SHA512:
-  metadata.gz: 15f46d65c2b7e7fce69d789d2921e6720e3e3163844e2333f0a21dd8ac2c4f083ee3c103e33e43b3b8c51154cbf32c493379428ed9dd0984e75d62e9c966f49a
-  data.tar.gz: 32bee7e4c55ceac83ad6407d81ad30915b16a41ec138f89c83cd36a449605167b94abbd17a42f0b01bee61589a3819bb871f213d876b71a969a3b8e596e1d17d
+  metadata.gz: 6bbf103f1e1730803217b2a537bfec0fefdd2a935977a9240196a533cb4eec1877e5f811efba325bb557a8752838e2a3dcde273aec6b65d213add2f2067d64ed
+  data.tar.gz: 264c26920757fae4b762d141f18f83812700d81331daa653d0bd8718f843b577af683f54d550fd1309b521f0288afdc6c17f0362ab773a416c6a807352341f57

data/lib/elastic_graph/rack/graphiql.rb

@@ -7,14 +7,27 @@
 # frozen_string_literal: true
 
 require "elastic_graph/rack/graphql_endpoint"
+require "rack/builder"
 require "rack/static"
 
 module ElasticGraph
   module Rack
-    # A Rack app that exposes both a GraphQL endpoint and an admin UI using GraphiQL:
+    # 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.
     #
-    # https://github.com/graphql/graphiql/tree/graphiql%402.4.0
+    # @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)
 

data/lib/elastic_graph/rack/graphql_endpoint.rb

@@ -11,14 +11,27 @@ 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.
+    # A simple [Rack](https://github.com/rack/rack) wrapper around an ElasticGraph GraphQL endpoint.
+    # 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 an ElasticGraph endpoint as a Rack application
+    #   require "elastic_graph/graphql"
+    #   require "elastic_graph/rack/graphql_endpoint"
+    #
+    #   graphql = ElasticGraph::GraphQL.from_yaml_file("config/settings/development.yaml")
+    #   run ElasticGraph::Rack::GraphQLEndpoint.new(graphql)
     class GraphQLEndpoint
+      # @param graphql [ElasticGraph::GraphQL] ElasticGraph GraphQL instance
       def initialize(graphql)
         @logger = graphql.logger
         @graphql_http_endpoint = graphql.graphql_http_endpoint
       end
 
+      # Responds to a Rack request.
+      #
+      # @param env [Hash<String, Object>] Rack env
+      # @return [Array(Integer, Hash<String, String>, Array<String>)]
       def call(env)
         rack_request = ::Rack::Request.new(env)
 

data/lib/elastic_graph/rack.rb

@@ -0,0 +1,19 @@
+# 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
+
+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).
+  module Rack
+  end
+end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph-rack
 version: !ruby/object:Gem::Version
-  version: 0.18.0.4
+  version: 0.18.0.5
 platform: ruby
 authors:
 - Myron Marston
+- Ben VandenBos
+- Square Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-06 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop-factory_bot
@@ -224,14 +226,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.4
+        version: 0.18.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.4
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -252,56 +254,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.4
+        version: 0.18.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.4
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: elasticgraph-elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.4
+        version: 0.18.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.4
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: elasticgraph-opensearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.4
+        version: 0.18.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.4
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: elasticgraph-indexer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.4
+        version: 0.18.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.4
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -326,6 +328,7 @@ files:
 - LICENSE.txt
 - README.md
 - elasticgraph-rack.gemspec
+- 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