gqli 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c9f840730460f908984a50b340a0ee135402b23e97ea75050bcf6b2a43a09d1
-  data.tar.gz: 721fb95788b07a4982993b7068852c450061fb038156f5bca92665ae5b9e93bb
+  metadata.gz: b4315f21be8d0b00907f0310acc1a17f300dd9157874bf09c75e577ef3b7fb95
+  data.tar.gz: e51cda712da56a947079aa807610bf0979352d3b2e3c2ed28eba337051df85d3
 SHA512:
-  metadata.gz: 2b25dc59880d1f0be794b5dad8ef7c437a6385c07bd14fe2b2a37f90ac43f1517fb56cb5fe53874e38075fe5decc17516be9ec55e09dd5cd1ad5dccd8bece681
-  data.tar.gz: 69f52628ea77db04ecc4e5f20fbe62bfe6cfd9df5c3efd2eac1ab6abd1e87927e1d120ed3b5094d1180d3d379570d639782a299e7a04ae7f7b58cd62aa1ff3f2
+  metadata.gz: 71560b1443fc3487f6de643950683b1a5b635cc35f3431d4af36379a29bee58308f20a19037e484065fc43790071574d62068c38c960268b2a55eb37232b8617
+  data.tar.gz: 2d94bff9408e828967ee3b7e20f980a59dc536f4a579675fa8d909149fd908fa8a55d2f2b7022552afc3e3ac644c5472003bedcb21249b6b959add3b2257269f

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## v1.1.0
+* Added support for timeout management. [#11](https://github.com/contentful-labs/gqli.rb/pull/11)
+* Added support for error response handling. [#13](https://github.com/contentful-labs/gqli.rb/pull/13)
+
 ## v1.0.0
 ### Added
 * Added support for Mutations.

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,10 @@ module GQLi
       schema.valid?(query)
     end
 
+    def request
+      HTTP.headers(request_headers).timeout(timeout_options)
+    end
+
     protected
 
     def validation_error_message(validation)
@@ -67,5 +77,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/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

data/lib/gqli/version.rb

@@ -3,5 +3,5 @@
 # GraphQL Client and DSL library
 module GQLi
   # Gem version
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/lib/gqli/client_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe GQLi::Client do
   let(:space_id) { 'cfexampleapi' }
   let(:token) { 'b4c0n73n7fu1' }
+  let(:default_timeout) { 60 }
+  let(:timeout) { 10 }
 
   let(:client) do
     vcr('client') {
@@ -20,6 +22,21 @@ describe GQLi::Client do
     }
   end
 
+  let(:client_with_timeout) do
+    vcr('client') {
+      GQLi::Contentful.create(
+        space_id,
+        token,
+        validate_query: false,
+        options: {
+          connect_timeout: timeout,
+          read_timeout: timeout,
+          write_timeout: timeout
+        }
+      )
+    }
+  end
+
   let(:dsl) { GQLi::DSL }
 
   describe 'default clients' do
@@ -118,4 +135,40 @@ describe GQLi::Client do
       }
     end
   end
+
+  context 'without timeout options' do
+    subject { client }
+
+    it 'upon instantiation sets default timeout value' do
+      expect(subject.options[:read_timeout]).to eq(default_timeout)
+      expect(subject.options[:connect_timeout]).to eq(default_timeout)
+      expect(subject.options[:write_timeout]).to eq(default_timeout)
+    end
+
+    it 'when executing a request sets default timeout value' do
+      expect(subject.request.default_options.timeout_options[:read_timeout]).to eq(default_timeout)
+      expect(subject.request.default_options.timeout_options[:connect_timeout]).to eq(default_timeout)
+      expect(subject.request.default_options.timeout_options[:write_timeout]).to eq(default_timeout)
+    end
+  end
+
+  context 'with timeout options' do
+    subject { client_with_timeout }
+
+    it 'contentful client' do
+      expect(subject).to be_a(GQLi::Client)
+    end
+
+    it 'upon instantiation sets provided timeout value' do
+      expect(subject.options[:read_timeout]).to eq(timeout)
+      expect(subject.options[:connect_timeout]).to eq(timeout)
+      expect(subject.options[:write_timeout]).to eq(timeout)
+    end
+
+    it 'when executing a request sets provided timeout value' do
+      expect(subject.request.default_options.timeout_options[:read_timeout]).to eq(timeout)
+      expect(subject.request.default_options.timeout_options[:connect_timeout]).to eq(timeout)
+      expect(subject.request.default_options.timeout_options[:write_timeout]).to eq(timeout)
+    end
+  end
 end

data/spec/lib/gqli/response_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe GQLi::Response do
+  let(:errors) { nil }
+  let(:data) { {"testkey" => "test val"} }
+  let(:query) { double(:query) }
+  subject { described_class.new(data, errors, query) }
+
+  describe "#data" do
+    it "returns correct data Hashie" do
+      expect(subject.data).to be_kind_of(Hashie::Mash)
+      expect(subject.data.testkey).to eq(data["testkey"])
+    end
+  end
+
+  describe "#query" do
+    it "returns correct query" do
+      expect(subject.query).to eq(query)
+    end
+  end
+
+  describe "#errors" do
+    context "array errors" do
+      let(:errors) { [{"message" => "this is an error"}] }
+
+      it "converts errors to correct Hashie instances" do
+        expect(subject.errors).to be_kind_of(Array)
+        expect(subject.errors.length).to eq(1)
+        expect(subject.errors.first).to be_kind_of(Hashie::Mash)
+        expect(subject.errors.first.message).to eq(errors.first["message"])
+      end
+    end
+
+    context "hash errors" do
+      let(:errors) { {"message" => "this is an error"} }
+
+      it "converts errors to correct Hashie instances" do
+        expect(subject.errors).to be_kind_of(Hashie::Mash)
+        expect(subject.errors.message).to eq(errors["message"])
+      end
+    end
+
+    context "nil errors" do
+      it "does not raise error and returns nil" do
+        expect(subject.errors).to be(nil)
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gqli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -349,6 +349,7 @@ files:
 - spec/lib/gqli/client_spec.rb
 - spec/lib/gqli/dsl_spec.rb
 - spec/lib/gqli/introspection_spec.rb
+- spec/lib/gqli/response_spec.rb
 - spec/spec_helper.rb
 - usage.rb
 - usage_introspection.rb
@@ -357,7 +358,7 @@ homepage: https://github.com/contentful-labs/gqli.rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -373,7 +374,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: GraphQL client for humans
 test_files:
@@ -384,4 +385,5 @@ test_files:
 - spec/lib/gqli/client_spec.rb
 - spec/lib/gqli/dsl_spec.rb
 - spec/lib/gqli/introspection_spec.rb
+- spec/lib/gqli/response_spec.rb
 - spec/spec_helper.rb