Class: GraphQL::Client
- Inherits:
-
Object
- Object
- GraphQL::Client
- Defined in:
- lib/graphql/client.rb,
lib/graphql/client/http.rb,
lib/graphql/client/error.rb,
lib/graphql/client/erubis.rb,
lib/graphql/client/railtie.rb,
lib/graphql/client/response.rb,
lib/graphql/client/view_module.rb,
lib/graphql/client/query_result.rb,
lib/graphql/client/log_subscriber.rb
Overview
GraphQL Client helps build and execute queries against a GraphQL backend.
A client instance SHOULD be configured with a schema to enable query validation. And SHOULD also be configured with a backend “execute” adapter to point at a remote GraphQL HTTP service or execute directly against a Schema object.
Defined Under Namespace
Modules: LazyName, ViewModule Classes: Definition, Error, Erubis, FailedResponse, FragmentDefinition, HTTP, LogSubscriber, OperationDefinition, PartialResponse, QueryResult, Railtie, Response, ResponseError, ResponseErrors, SuccessfulResponse, ValidationError
Constant Summary collapse
Instance Attribute Summary collapse
-
#document ⇒ Object
readonly
Returns the value of attribute document.
-
#document_tracking_enabled ⇒ Object
Returns the value of attribute document_tracking_enabled.
-
#execute ⇒ Object
readonly
Returns the value of attribute execute.
-
#schema ⇒ Object
readonly
Returns the value of attribute schema.
Class Method Summary collapse
Instance Method Summary collapse
-
#initialize(schema: nil, execute: nil) ⇒ Client
constructor
A new instance of Client.
- #parse(str, filename = nil, lineno = nil) ⇒ Object
- #query(definition, variables: {}, context: {}) ⇒ Object
Constructor Details
#initialize(schema: nil, execute: nil) ⇒ Client
Returns a new instance of Client.
65 66 67 68 69 70 |
# File 'lib/graphql/client.rb', line 65 def initialize(schema: nil, execute: nil) @schema = self.class.load_schema(schema) @execute = execute @document = GraphQL::Language::Nodes::Document.new(definitions: []) @document_tracking_enabled = false end |
Instance Attribute Details
#document ⇒ Object (readonly)
Returns the value of attribute document.
239 240 241 |
# File 'lib/graphql/client.rb', line 239 def document @document end |
#document_tracking_enabled ⇒ Object
Returns the value of attribute document_tracking_enabled.
23 24 25 |
# File 'lib/graphql/client.rb', line 23 def document_tracking_enabled @document_tracking_enabled end |
#execute ⇒ Object (readonly)
Returns the value of attribute execute.
21 22 23 |
# File 'lib/graphql/client.rb', line 21 def execute @execute end |
#schema ⇒ Object (readonly)
Returns the value of attribute schema.
21 22 23 |
# File 'lib/graphql/client.rb', line 21 def schema @schema end |
Class Method Details
.dump_schema(schema, io = nil) ⇒ Object
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/graphql/client.rb', line 44 def self.dump_schema(schema, io = nil) unless schema.respond_to?(:execute) raise TypeError, "expected schema to respond to #execute(), but was #{schema.class}" end result = schema.execute( document: IntrospectionDocument, operation_name: "IntrospectionQuery", variables: {}, context: {} ) if io io = File.open(io, "w") if io.is_a?(String) io.write(JSON.pretty_generate(result)) io.close_write end result end |
.load_schema(schema) ⇒ Object
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# File 'lib/graphql/client.rb', line 25 def self.load_schema(schema) case schema when GraphQL::Schema schema when Hash GraphQL::Schema::Loader.load(schema) when String if schema.end_with?(".json") && File.exist?(schema) load_schema(File.read(schema)) elsif schema =~ /\A\s*{/ load_schema(JSON.parse(schema)) end else load_schema(dump_schema(schema)) if schema.respond_to?(:execute) end end |
Instance Method Details
#parse(str, filename = nil, lineno = nil) ⇒ Object
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/graphql/client.rb', line 145 def parse(str, filename = nil, lineno = nil) if filename.nil? || lineno.nil? filename, lineno, = caller(1, 1).first.split(":", 3) lineno = lineno.to_i end definition_dependencies = Set.new str = str.gsub(/\.\.\.([a-zA-Z0-9_]+(::[a-zA-Z0-9_]+)+)/) do match = Regexp.last_match const_name = match[1] begin fragment = ActiveSupport::Inflector.constantize(const_name) rescue NameError fragment = nil end case fragment when FragmentDefinition definition_dependencies.merge(fragment.document.definitions) "...#{fragment.definition_name}" else = if fragment "expected #{const_name} to be a #{FragmentDefinition}, but was a #{fragment.class}" else "uninitialized constant #{const_name}" end error = ValidationError.new() if filename && lineno error.set_backtrace(["#{filename}:#{lineno + match.pre_match.count("\n") + 1}"] + caller) end raise error end end doc = GraphQL.parse(str) doc.definitions.each do |node| node.name ||= "__anonymous__" end document_dependencies = Language::Nodes::Document.new(definitions: doc.definitions + definition_dependencies.to_a) if @schema rules = GraphQL::StaticValidation::ALL_RULES - [GraphQL::StaticValidation::FragmentsAreUsed] validator = GraphQL::StaticValidation::Validator.new(schema: @schema, rules: rules) query = GraphQL::Query.new(@schema, document: document_dependencies) errors = validator.validate(query) errors.fetch(:errors).each do |error| validation_line = error["locations"][0]["line"] error = ValidationError.new(error["message"]) error.set_backtrace(["#{filename}:#{lineno + validation_line}"] + caller) if filename && lineno raise error end end definitions = {} doc.definitions.each do |node| node.name = nil if node.name == "__anonymous__" sliced_document = Language::OperationSlice.slice(document_dependencies, node.name) definition = Definition.for(node: node, document: sliced_document) definitions[node.name] = definition end rename_node = ->(node, _parent) do definition = definitions[node.name] if definition node.extend(LazyName) node.name = -> { definition.definition_name } end end visitor = Language::Visitor.new(doc) visitor[Language::Nodes::FragmentDefinition].leave << rename_node visitor[Language::Nodes::OperationDefinition].leave << rename_node visitor[Language::Nodes::FragmentSpread].leave << rename_node visitor.visit doc.deep_freeze document.definitions.concat(doc.definitions) if document_tracking_enabled if definitions[nil] definitions[nil] else Module.new do definitions.each do |name, definition| const_set(name, definition) end end end end |
#query(definition, variables: {}, context: {}) ⇒ Object
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/graphql/client.rb', line 241 def query(definition, variables: {}, context: {}) raise Error, "client network execution not configured" unless execute unless definition.is_a?(OperationDefinition) raise TypeError, "expected definition to be a #{OperationDefinition.name} but was #{document.class.name}" end document = definition.document operation = definition.definition_node payload = { document: document, operation_name: operation.name, operation_type: operation.operation_type, variables: variables, context: context } result = ActiveSupport::Notifications.instrument("query.graphql", payload) do execute.execute( document: document, operation_name: operation.name, variables: variables, context: context ) end Response.for(definition, result) end |