gqli 0.6.0 → 1.2.0

data/doc/method_list.html

@@ -4,9 +4,9 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta charset="utf-8" />
     
-      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
     
-      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
     
 
     
@@ -76,6 +76,22 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Subscription.html#__execute-instance_method" title="GQLi::Subscription#__execute (method)">#__execute</a></span>
+      <small>GQLi::Subscription</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Mutation.html#__execute-instance_method" title="GQLi::Mutation#__execute (method)">#__execute</a></span>
+      <small>GQLi::Mutation</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="GQLi/Base.html#__name-instance_method" title="GQLi::Base#__name (method)">#__name</a></span>
@@ -150,7 +166,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/DSL.html#enum-class_method" title="GQLi::DSL.enum (method)">enum</a></span>
+      <span class='object_link'><a href="GQLi/DSL.html#enum-instance_method" title="GQLi::DSL#enum (method)">#enum</a></span>
       <small>GQLi::DSL</small>
     </div>
   </li>
@@ -158,13 +174,21 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/DSL.html#enum-instance_method" title="GQLi::DSL#enum (method)">#enum</a></span>
+      <span class='object_link'><a href="GQLi/DSL.html#enum-class_method" title="GQLi::DSL.enum (method)">enum</a></span>
       <small>GQLi::DSL</small>
     </div>
   </li>
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Response.html#errors-instance_method" title="GQLi::Response#errors (method)">#errors</a></span>
+      <small>GQLi::Response</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="GQLi/Validation.html#errors-instance_method" title="GQLi::Validation#errors (method)">#errors</a></span>
       <small>GQLi::Validation</small>
@@ -172,7 +196,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="GQLi/Client.html#execute-instance_method" title="GQLi::Client#execute (method)">#execute</a></span>
       <small>GQLi::Client</small>
@@ -180,7 +204,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="GQLi/Client.html#execute!-instance_method" title="GQLi::Client#execute! (method)">#execute!</a></span>
       <small>GQLi::Client</small>
@@ -188,7 +212,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="GQLi/DSL.html#fragment-class_method" title="GQLi::DSL.fragment (method)">fragment</a></span>
       <small>GQLi::DSL</small>
@@ -196,7 +220,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="GQLi/DSL.html#fragment-instance_method" title="GQLi::DSL#fragment (method)">#fragment</a></span>
       <small>GQLi::DSL</small>
@@ -204,7 +228,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="GQLi/Client.html#headers-instance_method" title="GQLi::Client#headers (method)">#headers</a></span>
       <small>GQLi::Client</small>
@@ -212,26 +236,34 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Client.html#initialize-instance_method" title="GQLi::Client#initialize (method)">#initialize</a></span>
+      <small>GQLi::Client</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Response.html#initialize-instance_method" title="GQLi::Response#initialize (method)">#initialize</a></span>
-      <small>GQLi::Response</small>
+      <span class='object_link'><a href="GQLi/Introspection.html#initialize-instance_method" title="GQLi::Introspection#initialize (method)">#initialize</a></span>
+      <small>GQLi::Introspection</small>
     </div>
   </li>
   
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Node.html#initialize-instance_method" title="GQLi::Node#initialize (method)">#initialize</a></span>
-      <small>GQLi::Node</small>
+      <span class='object_link'><a href="GQLi/Fragment.html#initialize-instance_method" title="GQLi::Fragment#initialize (method)">#initialize</a></span>
+      <small>GQLi::Fragment</small>
     </div>
   </li>
   
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Client.html#initialize-instance_method" title="GQLi::Client#initialize (method)">#initialize</a></span>
-      <small>GQLi::Client</small>
+      <span class='object_link'><a href="GQLi/Node.html#initialize-instance_method" title="GQLi::Node#initialize (method)">#initialize</a></span>
+      <small>GQLi::Node</small>
     </div>
   </li>
   
@@ -246,8 +278,8 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Fragment.html#initialize-instance_method" title="GQLi::Fragment#initialize (method)">#initialize</a></span>
-      <small>GQLi::Fragment</small>
+      <span class='object_link'><a href="GQLi/Validation.html#initialize-instance_method" title="GQLi::Validation#initialize (method)">#initialize</a></span>
+      <small>GQLi::Validation</small>
     </div>
   </li>
   
@@ -262,21 +294,29 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Validation.html#initialize-instance_method" title="GQLi::Validation#initialize (method)">#initialize</a></span>
-      <small>GQLi::Validation</small>
+      <span class='object_link'><a href="GQLi/Response.html#initialize-instance_method" title="GQLi::Response#initialize (method)">#initialize</a></span>
+      <small>GQLi::Response</small>
     </div>
   </li>
   
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Introspection.html#initialize-instance_method" title="GQLi::Introspection#initialize (method)">#initialize</a></span>
-      <small>GQLi::Introspection</small>
+      <span class='object_link'><a href="GQLi/DSL.html#mutation-class_method" title="GQLi::DSL.mutation (method)">mutation</a></span>
+      <small>GQLi::DSL</small>
     </div>
   </li>
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/DSL.html#mutation-instance_method" title="GQLi::DSL#mutation (method)">#mutation</a></span>
+      <small>GQLi::DSL</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="GQLi/Introspection.html#mutation_type-instance_method" title="GQLi::Introspection#mutation_type (method)">#mutation_type</a></span>
       <small>GQLi::Introspection</small>
@@ -284,6 +324,14 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Client.html#options-instance_method" title="GQLi::Client#options (method)">#options</a></span>
+      <small>GQLi::Client</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="GQLi/Client.html#params-instance_method" title="GQLi::Client#params (method)">#params</a></span>
@@ -302,8 +350,8 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Validation.html#query-instance_method" title="GQLi::Validation#query (method)">#query</a></span>
-      <small>GQLi::Validation</small>
+      <span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span>
+      <small>GQLi::DSL</small>
     </div>
   </li>
   
@@ -318,16 +366,32 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span>
-      <small>GQLi::DSL</small>
+      <span class='object_link'><a href="GQLi/Introspection.html#query_type-instance_method" title="GQLi::Introspection#query_type (method)">#query_type</a></span>
+      <small>GQLi::Introspection</small>
     </div>
   </li>
   
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Introspection.html#query_type-instance_method" title="GQLi::Introspection#query_type (method)">#query_type</a></span>
-      <small>GQLi::Introspection</small>
+      <span class='object_link'><a href="GQLi/Client.html#request-instance_method" title="GQLi::Client#request (method)">#request</a></span>
+      <small>GQLi::Client</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Validation.html#root-instance_method" title="GQLi::Validation#root (method)">#root</a></span>
+      <small>GQLi::Validation</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Client.html#schema-instance_method" title="GQLi::Client#schema (method)">#schema</a></span>
+      <small>GQLi::Client</small>
     </div>
   </li>
   
@@ -350,24 +414,24 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Client.html#schema-instance_method" title="GQLi::Client#schema (method)">#schema</a></span>
-      <small>GQLi::Client</small>
+      <span class='object_link'><a href="GQLi/DSL.html#subscription-instance_method" title="GQLi::DSL#subscription (method)">#subscription</a></span>
+      <small>GQLi::DSL</small>
     </div>
   </li>
   
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Introspection.html#subscription_type-instance_method" title="GQLi::Introspection#subscription_type (method)">#subscription_type</a></span>
-      <small>GQLi::Introspection</small>
+      <span class='object_link'><a href="GQLi/DSL.html#subscription-class_method" title="GQLi::DSL.subscription (method)">subscription</a></span>
+      <small>GQLi::DSL</small>
     </div>
   </li>
   
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Query.html#to_gql-instance_method" title="GQLi::Query#to_gql (method)">#to_gql</a></span>
-      <small>GQLi::Query</small>
+      <span class='object_link'><a href="GQLi/Introspection.html#subscription_type-instance_method" title="GQLi::Introspection#subscription_type (method)">#subscription_type</a></span>
+      <small>GQLi::Introspection</small>
     </div>
   </li>
   
@@ -382,21 +446,45 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Node.html#to_gql-instance_method" title="GQLi::Node#to_gql (method)">#to_gql</a></span>
-      <small>GQLi::Node</small>
+      <span class='object_link'><a href="GQLi/Mutation.html#to_gql-instance_method" title="GQLi::Mutation#to_gql (method)">#to_gql</a></span>
+      <small>GQLi::Mutation</small>
     </div>
   </li>
   
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Query.html#to_s-instance_method" title="GQLi::Query#to_s (method)">#to_s</a></span>
+      <span class='object_link'><a href="GQLi/Subscription.html#to_gql-instance_method" title="GQLi::Subscription#to_gql (method)">#to_gql</a></span>
+      <small>GQLi::Subscription</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Query.html#to_gql-instance_method" title="GQLi::Query#to_gql (method)">#to_gql</a></span>
       <small>GQLi::Query</small>
     </div>
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Node.html#to_gql-instance_method" title="GQLi::Node#to_gql (method)">#to_gql</a></span>
+      <small>GQLi::Node</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Subscription.html#to_s-instance_method" title="GQLi::Subscription#to_s (method)">#to_s</a></span>
+      <small>GQLi::Subscription</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="GQLi/EnumValue.html#to_s-instance_method" title="GQLi::EnumValue#to_s (method)">#to_s</a></span>
       <small>GQLi::EnumValue</small>
@@ -404,25 +492,33 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Mutation.html#to_s-instance_method" title="GQLi::Mutation#to_s (method)">#to_s</a></span>
+      <small>GQLi::Mutation</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Introspection.html#types-instance_method" title="GQLi::Introspection#types (method)">#types</a></span>
-      <small>GQLi::Introspection</small>
+      <span class='object_link'><a href="GQLi/Query.html#to_s-instance_method" title="GQLi::Query#to_s (method)">#to_s</a></span>
+      <small>GQLi::Query</small>
     </div>
   </li>
   
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Client.html#url-instance_method" title="GQLi::Client#url (method)">#url</a></span>
-      <small>GQLi::Client</small>
+      <span class='object_link'><a href="GQLi/Introspection.html#types-instance_method" title="GQLi::Introspection#types (method)">#types</a></span>
+      <small>GQLi::Introspection</small>
     </div>
   </li>
   
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="GQLi/Client.html#valid%3F-instance_method" title="GQLi::Client#valid? (method)">#valid?</a></span>
+      <span class='object_link'><a href="GQLi/Client.html#url-instance_method" title="GQLi::Client#url (method)">#url</a></span>
       <small>GQLi::Client</small>
     </div>
   </li>
@@ -445,6 +541,14 @@
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="GQLi/Client.html#valid%3F-instance_method" title="GQLi::Client#valid? (method)">#valid?</a></span>
+      <small>GQLi::Client</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="GQLi/Introspection.html#validate-instance_method" title="GQLi::Introspection#validate (method)">#validate</a></span>
       <small>GQLi::Introspection</small>
@@ -452,7 +556,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="GQLi/Client.html#validate_query-instance_method" title="GQLi::Client#validate_query (method)">#validate_query</a></span>
       <small>GQLi::Client</small>
@@ -460,7 +564,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="GQLi/EnumValue.html#value-instance_method" title="GQLi::EnumValue#value (method)">#value</a></span>
       <small>GQLi::EnumValue</small>

data/doc/top-level-namespace.html

@@ -6,15 +6,15 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.16
+    &mdash; Documentation by YARD 0.9.27
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "";
   relpath = '';
 </script>
@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Feb 16 22:53:59 2019 by
+  Generated on Mon Jan  3 17:37:12 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.27 (ruby-3.0.3).
 </div>
 
     </div>

data/gqli.gemspec

@@ -15,12 +15,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'http', '> 0.8', '< 3.0'
-  gem.add_dependency 'hashie', '~> 3.0'
+  gem.add_dependency 'hashie', '> 3.0'
+  gem.add_dependency 'http', '> 0.8', '< 6.0'
   gem.add_dependency 'multi_json', '~> 1'
 
-  gem.add_development_dependency 'bundler', '~> 1.5'
-  gem.add_development_dependency 'rake', '< 11.0'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
 
   gem.add_development_dependency 'guard'
@@ -30,8 +29,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rubocop', '~> 0.49.1'
   gem.add_development_dependency 'rspec', '~> 3'
   gem.add_development_dependency 'rr'
-  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'vcr', '~> 4.0'
   gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'webmock', '~> 1', '>= 1.17.3'
+  gem.add_development_dependency 'webmock', '~> 3.5'
   gem.add_development_dependency 'tins', '~> 1.6.0'
 end

data/lib/gqli/client.rb

@@ -9,13 +9,17 @@ require_relative './version'
 module GQLi
   # GraphQL HTTP Client
   class Client
-    attr_reader :url, :params, :headers, :validate_query, :schema
+    attr_reader :url, :params, :headers, :validate_query, :schema, :options
 
-    def initialize(url, params: {}, headers: {}, validate_query: true)
+    def initialize(url, params: {}, headers: {}, validate_query: true, options: {})
       @url = url
       @params = params
       @headers = headers
       @validate_query = validate_query
+      @options = options
+      @options[:read_timeout] ||= 60
+      @options[:write_timeout] ||= 60
+      @options[:connect_timeout] ||= 60
 
       @schema = Introspection.new(self) if validate_query
     end
@@ -34,13 +38,15 @@ module GQLi
     # Executres a query
     # Ignores validations
     def execute!(query)
-      http_response = HTTP.headers(request_headers).post(@url, params: @params, json: { query: query.to_gql })
+      http_response = request.post(@url, params: @params, json: { query: query.to_gql })
 
       fail "Error: #{http_response.reason}\nBody: #{http_response.body}" if http_response.status >= 300
 
-      data = JSON.parse(http_response.to_s)['data']
+      parsed_response = JSON.parse(http_response.to_s)
+      data = parsed_response['data']
+      errors = parsed_response['errors']
 
-      Response.new(data, query)
+      Response.new(data, errors, query)
     end
 
     # Validates a query against the schema
@@ -50,6 +56,12 @@ module GQLi
       schema.valid?(query)
     end
 
+    # Executes the actual request
+    # @private
+    def request
+      HTTP.headers(request_headers).timeout(timeout_options)
+    end
+
     protected
 
     def validation_error_message(validation)
@@ -67,5 +79,13 @@ module GQLi
         user_agent: "gqli.rb/#{VERSION}; http.rb/#{HTTP::VERSION}"
       }.merge(@headers)
     end
+
+    def timeout_options
+      {
+        write: options[:write_timeout],
+        connect: options[:connect_timeout],
+        read: options[:read_timeout]
+      }
+    end
   end
 end

data/lib/gqli/clients/contentful.rb

@@ -4,7 +4,7 @@ module GQLi
   # Module for creating a Contentful GraphQL client
   module Contentful
     # Creates a Contentful GraphQL client
-    def self.create(space, access_token, environment: nil, validate_query: true)
+    def self.create(space, access_token, environment: nil, validate_query: true, options: {})
       api_url = "https://graphql.contentful.com/content/v1/spaces/#{space}"
       api_url += "/environments/#{environment}" unless environment.nil?
 
@@ -13,7 +13,8 @@ module GQLi
         headers: {
           'Authorization' => "Bearer #{access_token}"
         },
-        validate_query: validate_query
+        validate_query: validate_query,
+        options: options
       )
     end
   end

data/lib/gqli/dsl.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative './query'
+require_relative './mutation'
 require_relative './subscription'
 require_relative './fragment'
 require_relative './enum_value'
@@ -22,6 +23,13 @@ module GQLi
       Subscription.new(name, &block)
     end
 
+    # Creates a Mutation object
+    #
+    # Can be used at a class level
+    def self.mutation(name = nil, &block)
+      Mutation.new(name, &block)
+    end
+
     # Creates a Fragment object
     #
     # Can be used at a class level
@@ -43,9 +51,16 @@ module GQLi
       Query.new(name, &block)
     end
 
+    # Creates a Mutation object
+    #
+    # Can be used at a instance level
+    def mutation(name = nil, &block)
+      Mutation.new(name, &block)
+    end
+
     # Creates a Subscription object
     #
-    # Can be used at a class level
+    # Can be used at a instance level
     def subscription(name = nil, &block)
       Subscription.new(name, &block)
     end

data/lib/gqli/introspection.rb

@@ -69,9 +69,7 @@ module GQLi
           name
           description
           args { ___ InputValue }
-          onOperation
-          onFragment
-          onField
+          locations
         }
       }
     }

data/lib/gqli/mutation.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module GQLi
+  # Mutation node
+  class Mutation < Base
+    # Serializes to a GraphQL string
+    def to_gql
+      result = <<~GQL
+        mutation #{__name ? __name + ' ' : ''}{
+        #{__nodes.map(&:to_gql).join("\n")}
+        }
+      GQL
+
+      result.lstrip
+    end
+
+    # Delegates itself to the client to be executed
+    def __execute(client)
+      client.execute(self)
+    end
+
+    # Serializes to a GraphQL string
+    def to_s
+      to_gql
+    end
+  end
+end

data/lib/gqli/response.rb

@@ -5,11 +5,24 @@ require 'hashie/mash'
 module GQLi
   # Response object wrapper
   class Response
-    attr_reader :data, :query
+    attr_reader :data, :errors, :query
 
-    def initialize(data, query)
+    def initialize(data, errors, query)
       @data = Hashie::Mash.new(data)
+      @errors = parse_errors(errors)
       @query = query
     end
+
+    private
+
+    # Accepts Hash or Array of errors and converts them to Hashie::Mash instances.
+    # Recursively calls #parse_errors with items if array.
+    # Returns nil if nil is passed.
+    def parse_errors(errors)
+      return unless errors
+      return errors.map { |e| parse_errors(e) } if errors.is_a?(Array)
+
+      Hashie::Mash.new(errors)
+    end
   end
 end