graphql-client 0.16.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6810301cbdd84362dc4b8584e24deec3aec4248f4471734748cf1a33feaa5232
-  data.tar.gz: bb68c48d70c276c0443da6620506b37dbe152e20fb931a2ecf3a0cba45050f96
+  metadata.gz: aab80b9e2051c30118b8db5fc9dbd813926d8a180bf49371bf23e6a09aaaf4eb
+  data.tar.gz: 20de5ca5f098763481ffa6bfa79308b1db5339376878f98c7d3ecb8d4442d5cd
 SHA512:
-  metadata.gz: 6b7f114d4330ae5168669d7a663a0afdbd508ba056aa252a206efca9071f558c8749ecfd809ca0677ab9e3a5e95cc90eec3a6bcc2e4020875aab6621d9059dd8
-  data.tar.gz: b1a24192dc4ee004ae6d546d4d724d0c49da4a17a4fb86a1a7e81d1aefbe16618f32ed27a63a8c2297bd4074ec8dd91794ab057d3826d08ccfefe21d689e7e76
+  metadata.gz: 81eb7e3021e3cdf8201e86971ed7d63f58d60e132d22b7c4ee35fd6b0a42fa730f4a9c9dd6638027f583d98638d270ef1d7994f0b5976ad4200a8c4164f58864
+  data.tar.gz: 7a752365bd27b213506bf6958c8accf9941f85bc8a7c73518950b431c1b7563584d29c0569f3a8a8a4c221e704c9ea3ff05333f005af004e60454b21f1acaaf9

data/README.md

@@ -1,4 +1,4 @@
-# graphql-client [![Gem Version](https://badge.fury.io/rb/graphql-client.svg)](https://badge.fury.io/rb/graphql-client) [![Build Status](https://travis-ci.org/github/graphql-client.svg?branch=master)](https://travis-ci.org/github/graphql-client)
+# graphql-client [![Gem Version](https://badge.fury.io/rb/graphql-client.svg)](https://badge.fury.io/rb/graphql-client) [![CI](https://github.com/github-community-projects/graphql-client/workflows/CI/badge.svg)](https://github.com/github-community-projects/graphql-client/actions?query=workflow)
 
 GraphQL Client is a Ruby library for declaring, composing and executing GraphQL queries.
 

data/lib/graphql/client/collocated_enforcement.rb

@@ -12,6 +12,8 @@ module GraphQL
 
     # Enforcements collocated object access best practices.
     module CollocatedEnforcement
+      extend self
+
       # Public: Ignore collocated caller enforcement for the scope of the block.
       def allow_noncollocated_callers
         Thread.current[:query_result_caller_location_ignore] = true
@@ -20,6 +22,23 @@ module GraphQL
         Thread.current[:query_result_caller_location_ignore] = nil
       end
 
+      def verify_collocated_path(location, path, method = "method")
+        return yield if Thread.current[:query_result_caller_location_ignore]
+
+        if (location.path != path) && !(WHITELISTED_GEM_NAMES.any? { |g| location.path.include?("gems/#{g}") })
+          error = NonCollocatedCallerError.new("#{method} was called outside of '#{path}' https://github.com/github-community-projects/graphql-client/blob/master/guides/collocated-call-sites.md")
+          error.set_backtrace(caller(2))
+          raise error
+        end
+
+        begin
+          Thread.current[:query_result_caller_location_ignore] = true
+          yield
+        ensure
+          Thread.current[:query_result_caller_location_ignore] = nil
+        end
+      end
+
       # Internal: Decorate method with collocated caller enforcement.
       #
       # mod - Target Module/Class
@@ -31,21 +50,9 @@ module GraphQL
         mod.prepend(Module.new do
           methods.each do |method|
             define_method(method) do |*args, &block|
-              return super(*args, &block) if Thread.current[:query_result_caller_location_ignore]
-
-              locations = caller_locations(1, 1)
-
-              if (locations.first.path != path) && !(caller_locations.any? { |cl| WHITELISTED_GEM_NAMES.any? { |g| cl.path.include?("gems/#{g}") } })
-                error = NonCollocatedCallerError.new("#{method} was called outside of '#{path}' https://git.io/v1syX")
-                error.set_backtrace(caller(1))
-                raise error
-              end
-
-              begin
-                Thread.current[:query_result_caller_location_ignore] = true
+              location = caller_locations(1, 1)[0]
+              CollocatedEnforcement.verify_collocated_path(location, path, method) do
                 super(*args, &block)
-              ensure
-                Thread.current[:query_result_caller_location_ignore] = nil
               end
             end
           end

data/lib/graphql/client/definition.rb

@@ -115,9 +115,24 @@ module GraphQL
           else
             cast_object(obj)
           end
+        when GraphQL::Client::Schema::ObjectType::WithDefinition
+          case obj
+          when schema_class.klass
+            if obj._definer == schema_class
+              obj
+            else
+              cast_object(obj)
+            end
+          when nil
+            nil
+          when Hash
+            schema_class.new(obj, errors)
+          else
+            cast_object(obj)
+          end
         when GraphQL::Client::Schema::ObjectType
           case obj
-          when NilClass, schema_class
+          when nil, schema_class
             obj
           when Hash
             schema_class.new(obj, errors)
@@ -132,41 +147,58 @@ module GraphQL
       # Internal: Nodes AST indexes.
       def indexes
         @indexes ||= begin
-          visitor = GraphQL::Language::Visitor.new(document)
-          definitions = index_node_definitions(visitor)
-          spreads = index_spreads(visitor)
+          visitor = DefinitionVisitor.new(document)
           visitor.visit
-          { definitions: definitions, spreads: spreads }
+          { definitions: visitor.definitions, spreads: visitor.spreads }
         end
       end
 
-      private
+      class DefinitionVisitor < GraphQL::Language::Visitor
+        attr_reader :spreads, :definitions
 
-        def cast_object(obj)
-          if obj.class.is_a?(GraphQL::Client::Schema::ObjectType)
-            unless obj.class._spreads.include?(definition_node.name)
-              raise TypeError, "#{definition_node.name} is not included in #{obj.class.source_definition.name}"
-            end
-            schema_class.cast(obj.to_h, obj.errors)
-          else
-            raise TypeError, "unexpected #{obj.class}"
-          end
+        def initialize(doc)
+          super
+          @spreads = {}
+          @definitions = {}
+          @current_definition = nil
         end
 
-        EMPTY_SET = Set.new.freeze
+        def on_field(node, parent)
+          @definitions[node] = @current_definition
+          @spreads[node] = get_spreads(node)
+          super
+        end
 
-        def index_spreads(visitor)
-          spreads = {}
-          on_node = ->(node, _parent) do
-            node_spreads = flatten_spreads(node).map(&:name)
-            spreads[node] = node_spreads.empty? ? EMPTY_SET : Set.new(node_spreads).freeze
-          end
+        def on_fragment_definition(node, parent)
+          @current_definition = node
+          @definitions[node] = @current_definition
+          @spreads[node] = get_spreads(node)
+          super
+        ensure
+          @current_definition = nil
+        end
 
-          visitor[GraphQL::Language::Nodes::Field] << on_node
-          visitor[GraphQL::Language::Nodes::FragmentDefinition] << on_node
-          visitor[GraphQL::Language::Nodes::OperationDefinition] << on_node
+        def on_operation_definition(node, parent)
+          @current_definition = node
+          @definitions[node] = @current_definition
+          @spreads[node] = get_spreads(node)
+          super
+        ensure
+          @current_definition = nil
+        end
 
-          spreads
+        def on_inline_fragment(node, parent)
+          @definitions[node] = @current_definition
+          super
+        end
+
+        private
+
+        EMPTY_SET = Set.new.freeze
+
+        def get_spreads(node)
+          node_spreads = flatten_spreads(node).map(&:name)
+          node_spreads.empty? ? EMPTY_SET : Set.new(node_spreads).freeze
         end
 
         def flatten_spreads(node)
@@ -183,25 +215,20 @@ module GraphQL
           end
           spreads
         end
+      end
+
+      private
 
-        def index_node_definitions(visitor)
-          current_definition = nil
-          enter_definition = ->(node, _parent) { current_definition = node }
-          leave_definition = ->(node, _parent) { current_definition = nil }
-
-          visitor[GraphQL::Language::Nodes::FragmentDefinition].enter << enter_definition
-          visitor[GraphQL::Language::Nodes::FragmentDefinition].leave << leave_definition
-          visitor[GraphQL::Language::Nodes::OperationDefinition].enter << enter_definition
-          visitor[GraphQL::Language::Nodes::OperationDefinition].leave << leave_definition
-
-          definitions = {}
-          on_node = ->(node, _parent) { definitions[node] = current_definition }
-          visitor[GraphQL::Language::Nodes::Field] << on_node
-          visitor[GraphQL::Language::Nodes::FragmentDefinition] << on_node
-          visitor[GraphQL::Language::Nodes::InlineFragment] << on_node
-          visitor[GraphQL::Language::Nodes::OperationDefinition] << on_node
-          definitions
+      def cast_object(obj)
+        if obj.class.is_a?(GraphQL::Client::Schema::ObjectType)
+          unless obj._spreads.include?(definition_node.name)
+            raise TypeError, "#{definition_node.name} is not included in #{obj.source_definition.name}"
+          end
+          schema_class.cast(obj.to_h, obj.errors)
+        else
+          raise TypeError, "unexpected #{obj.class}"
         end
+      end
     end
   end
 end

data/lib/graphql/client/definition_variables.rb

@@ -24,26 +24,33 @@ module GraphQL
 
         sliced_document = GraphQL::Language::DefinitionSlice.slice(document, definition_name)
 
-        visitor = GraphQL::Language::Visitor.new(sliced_document)
-        type_stack = GraphQL::StaticValidation::TypeStack.new(schema, visitor)
+        visitor = VariablesVisitor.new(sliced_document, schema: schema)
+        visitor.visit
+        visitor.variables
+      end
+
+      class VariablesVisitor < GraphQL::Language::Visitor
+        prepend GraphQL::Client::TypeStack
+
+        def initialize(*_args, **_kwargs)
+          super
+          @variables = {}
+        end
 
-        variables = {}
+        attr_reader :variables
 
-        visitor[GraphQL::Language::Nodes::VariableIdentifier] << ->(node, parent) do
-          if definition = type_stack.argument_definitions.last
-            existing_type = variables[node.name.to_sym]
+        def on_variable_identifier(node, parent)
+          if definition = @argument_definitions.last
+            existing_type = @variables[node.name.to_sym]
 
             if existing_type && existing_type.unwrap != definition.type.unwrap
               raise GraphQL::Client::ValidationError, "$#{node.name} was already declared as #{existing_type.unwrap}, but was #{definition.type.unwrap}"
             elsif !(existing_type && existing_type.kind.non_null?)
-              variables[node.name.to_sym] = definition.type
+              @variables[node.name.to_sym] = definition.type
             end
           end
+          super
         end
-
-        visitor.visit
-
-        variables
       end
 
       # Internal: Detect all variables used in a given operation or fragment

data/lib/graphql/client/document_types.rb

@@ -1,10 +1,41 @@
 # frozen_string_literal: true
 require "graphql"
+require "graphql/client/type_stack"
 
 module GraphQL
   class Client
     # Internal: Use schema to detect definition and field types.
     module DocumentTypes
+      class AnalyzeTypesVisitor < GraphQL::Language::Visitor
+        prepend GraphQL::Client::TypeStack
+        attr_reader :fields
+
+        def initialize(*a, **kw)
+          @fields = {}
+          super
+        end
+
+        def on_operation_definition(node, _parent)
+          @fields[node] = @object_types.last
+          super
+        end
+
+        def on_fragment_definition(node, _parent)
+          @fields[node] = @object_types.last
+          super
+        end
+
+        def on_inline_fragment(node, _parent)
+          @fields[node] = @object_types.last
+          super
+        end
+
+        def on_field(node, _parent)
+          @fields[node] = @field_definitions.last.type
+          super
+        end
+      end
+
       # Internal: Detect all types used in a given document
       #
       # schema - A GraphQL::Schema
@@ -20,32 +51,15 @@ module GraphQL
           raise TypeError, "expected schema to be a GraphQL::Language::Nodes::Document, but was #{document.class}"
         end
 
-        visitor = GraphQL::Language::Visitor.new(document)
-        type_stack = GraphQL::StaticValidation::TypeStack.new(schema, visitor)
-
-        fields = {}
-
-        visitor[GraphQL::Language::Nodes::OperationDefinition] << ->(node, _parent) do
-          fields[node] = type_stack.object_types.last
-        end
-        visitor[GraphQL::Language::Nodes::FragmentDefinition] << ->(node, _parent) do
-          fields[node] = type_stack.object_types.last
-        end
-        visitor[GraphQL::Language::Nodes::InlineFragment] << ->(node, _parent) do
-          fields[node] = type_stack.object_types.last
-        end
-        visitor[GraphQL::Language::Nodes::Field] << ->(node, _parent) do
-          fields[node] = type_stack.field_definitions.last.type
-        end
+        visitor = AnalyzeTypesVisitor.new(document, schema: schema)
         visitor.visit
-
-        fields
+        visitor.fields
       rescue StandardError => err
         if err.is_a?(TypeError)
           raise
         end
         # FIXME: TypeStack my crash on invalid documents
-        fields
+        visitor.fields
       end
     end
   end

data/lib/graphql/client/erb.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require "action_view"
+require "logger"
 
 module GraphQL
   class Client

data/lib/graphql/client/errors.rb

@@ -21,7 +21,7 @@ module GraphQL
         errors.each do |error|
           path = ["data"]
           current = data
-          error.fetch("path", []).each do |key|
+          error["path"].to_a.each do |key|
             break unless current
             path << key
             current = current[key]

data/lib/graphql/client/http.rb

@@ -7,14 +7,14 @@ module GraphQL
   class Client
     # Public: Basic HTTP network adapter.
     #
-    #   GraphQL::Client::Client.new(
+    #   GraphQL::Client.new(
     #     execute: GraphQL::Client::HTTP.new("http://graphql-swapi.parseapp.com/")
     #   )
     #
     # Assumes GraphQL endpoint follows the express-graphql endpoint conventions.
     #   https://github.com/graphql/express-graphql#http-usage
     #
-    # Production applications should consider implementing there own network
+    # Production applications should consider implementing their own network
     # adapter. This class exists for trivial stock usage and allows for minimal
     # request header configuration.
     class HTTP
@@ -45,6 +45,11 @@ module GraphQL
         {}
       end
 
+      # Public: full reponse from last request
+      #
+      # Returns Hash.
+      attr_reader :last_response
+
       # Public: Make an HTTP request for GraphQL query.
       #
       # Implements Client's "execute" adapter interface.
@@ -71,6 +76,7 @@ module GraphQL
         request.body = JSON.generate(body)
 
         response = connection.request(request)
+        @last_response = response.to_hash
         case response
         when Net::HTTPOK, Net::HTTPBadRequest
           JSON.parse(response.body)

data/lib/graphql/client/log_subscriber.rb

@@ -16,11 +16,18 @@ module GraphQL
     #   GraphQL::Client::LogSubscriber.attach_to :graphql
     #
     class LogSubscriber < ActiveSupport::LogSubscriber
+      SHOULD_USE_KWARGS = private_instance_methods.include?(:mode_from)
+
       def query(event)
         logger.info do
           name = event.payload[:operation_name].gsub("__", "::")
           type = event.payload[:operation_type].upcase
-          color("#{name} #{type} (#{event.duration.round(1)}ms)", nil, true)
+
+          if SHOULD_USE_KWARGS
+            color("#{name} #{type} (#{event.duration.round(1)}ms)", nil, bold: true)
+          else
+            color("#{name} #{type} (#{event.duration.round(1)}ms)", nil, true)
+          end
         end
 
         logger.debug do
@@ -32,7 +39,12 @@ module GraphQL
         logger.error do
           name = event.payload[:operation_name].gsub("__", "::")
           message = event.payload[:message]
-          color("#{name} ERROR: #{message}", nil, true)
+
+          if SHOULD_USE_KWARGS
+            color("#{name} ERROR: #{message}", nil, bold: true)
+          else
+            color("#{name} ERROR: #{message}", nil, true)
+          end
         end
       end
     end

data/lib/graphql/client/response.rb

@@ -12,6 +12,7 @@ module GraphQL
       # Returns Hash.
       attr_reader :original_hash
       alias_method :to_h, :original_hash
+      alias_method :to_hash, :original_hash
 
       # Public: Wrapped ObjectType of data returned from the server.
       #
@@ -30,12 +31,18 @@ module GraphQL
       # Public: Hash of server specific extension metadata.
       attr_reader :extensions
 
+      # Public: Complete response hash returned from server.
+      #
+      # Returns Hash
+      attr_reader :full_response
+
       # Internal: Initialize base class.
-      def initialize(hash, data: nil, errors: Errors.new, extensions: {})
+      def initialize(hash, data: nil, errors: Errors.new, extensions: {}, full_response: nil)
         @original_hash = hash
         @data = data
         @errors = errors
         @extensions = extensions
+        @full_response = full_response
       end
     end
   end

data/lib/graphql/client/schema/enum_type.rb

@@ -16,6 +16,10 @@ module GraphQL
             @enum = enum
           end
 
+          def unknown_enum_value?
+            false
+          end
+
           def respond_to_missing?(method_name, include_private = false)
             if method_name[-1] == "?" && @enum.include?(method_name[0..-2])
               true
@@ -37,6 +41,12 @@ module GraphQL
           end
         end
 
+        class UnexpectedEnumValue < String
+          def unknown_enum_value?
+            true
+          end
+        end
+
         # Internal: Construct enum wrapper from another GraphQL::EnumType.
         #
         # type - GraphQL::EnumType instance
@@ -78,8 +88,13 @@ module GraphQL
         def cast(value, _errors = nil)
           case value
           when String
-            raise Error, "unexpected enum value #{value}" unless @values.key?(value)
-            @values[value]
+            if @values.key?(value)
+              @values[value]
+            elsif schema_module.raise_on_unknown_enum_value
+              raise Error, "unexpected enum value #{value}"
+            else
+              UnexpectedEnumValue.new(value).freeze
+            end
           when NilClass
             value
           else

data/lib/graphql/client/schema/interface_type.rb

@@ -21,7 +21,7 @@ module GraphQL
         end
 
         def define_class(definition, ast_nodes)
-          possible_type_names = definition.client.schema.possible_types(type).map(&:graphql_name)
+          possible_type_names = definition.client.possible_types(type).map(&:graphql_name)
           possible_types = possible_type_names.map { |concrete_type_name|
             schema_module.get_class(concrete_type_name).define_class(definition, ast_nodes)
           }