graphlient 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1328f248da112cdd69028ad82f37ec75ef69d707
-  data.tar.gz: e33c4cc31d7566a38cf8e0b2cb8dcf2abc001abb
+  metadata.gz: 0da18e4b9370c65fb4e6add0b644c89b55149b32
+  data.tar.gz: 39a55d067517d0be0f609ea3fcea3836cc0c4e9c
 SHA512:
-  metadata.gz: df9ab753adb46c62d6ad8b69efad0c2a73dc41c5ce703eb47c60bbf129ae1b2eac204184bc1966d36660690261cc9467da44147652624780edf39a9b5675027c
-  data.tar.gz: c5e38abf851c13e336d84aa85d4c6726869bf37692bf7cd632ffc6bc78666197af0b95abb58d52ce452fee25ef9edadfb67a308382827c943cde6bdc88d5b04b
+  metadata.gz: d443d7ca4023923bce79d474e59bab4e7f85fb2b4f270fd8466435997c89dfb8bb763821728b428d7e8dde0f196b4f2e4ae8e9747c805e11dbae301707b7326f
+  data.tar.gz: 3bf4e9568f17b0a26566a1d79f422395ce545a6273ca37c8d177a858734e78dcee1d3a5706678e0613998a67d63d7b309dec0be14b9edef0342759b9943d5917

data/.rubocop_todo.yml

@@ -1,17 +1,25 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-10-23 15:14:47 -0400 using RuboCop version 0.47.1.
+# on 2017-10-25 13:18:43 -0400 using RuboCop version 0.47.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith, SupportedStylesAlignWith, AutoCorrect.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Lint/EndAlignment:
+  Exclude:
+    - 'lib/graphlient/client.rb'
+
 # Offense count: 11
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 167
+  Max: 178
 
-# Offense count: 17
+# Offense count: 19
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
@@ -29,7 +37,7 @@ Style/ClassAndModuleChildren:
   Exclude:
     - 'spec/graphlient/static_client_query_spec.rb'
 
-# Offense count: 5
+# Offense count: 6
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -37,6 +45,7 @@ Style/Documentation:
     - 'lib/graphlient/adapters/faraday_adapter.rb'
     - 'lib/graphlient/client.rb'
     - 'lib/graphlient/errors/error.rb'
+    - 'lib/graphlient/errors/graphql.rb'
     - 'lib/graphlient/extensions/query.rb'
     - 'lib/graphlient/query.rb'
 

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.0.8 (10/26/2017)
+
+* [#27](https://github.com/ashkan18/graphlient/pull/27): Always raise an exception unless a query has succeeded - [@dblock](https://github.com/dblock).
+
 ### 0.0.7 (10/24/2017)
 
 * [#26](https://github.com/ashkan18/graphlient/pull/26): Support String queries - [@dblock](https://github.com/dblock).

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/graphlient.svg)](https://badge.fury.io/rb/graphlient)
 [![Build Status](https://travis-ci.org/ashkan18/graphlient.svg?branch=master)](https://travis-ci.org/ashkan18/graphlient)
 
-A friendlier Ruby client for consuming GraphQL-based APIs. Built on top of your usual [graphql-client](https://github.com/github/graphql-client), but with better defaults, and using the [faraday](https://github.com/lostisland/faraday) HTTP client.
+A friendlier Ruby client for consuming GraphQL-based APIs. Built on top of your usual [graphql-client](https://github.com/github/graphql-client), but with better defaults, more consistent error handling, and using the [faraday](https://github.com/lostisland/faraday) HTTP client.
 
 ## Installation
 
@@ -82,8 +82,6 @@ query {
 }
 ```
 
-Graphlient validates the query based on current schema. In case of validation errors or any other connection related issues you'll get `Graphlient::Errors::Client` describing the error and in case of transport errors, `Graphlient::Errors::Server`. Both inherit from `Graphlient::Errors::Error` if you need to handle them in bulk.
-
 A successful response object always contains data which can be iterated upon. The following example returns the first line item's price.
 
 ```ruby
@@ -109,6 +107,16 @@ The successful response contains data in `response.data`. The following example
 response.data.create_invoice.first.id
 ```
 
+### Error Handling
+
+Unlike graphql-client, Graphlient will always raise an exception unless the query has succeeded.
+
+* [Graphlient::Errors::Client](lib/graphlient/errors/client.rb): all client-side query validation failures based on current schema
+* [Graphlient::Errors::GraphQL](lib/graphlient/errors/graphql.rb): all GraphQL API errors, with a humanly readable collection of problems
+* [Graphlient::Errors::Server](lib/graphlient/errors/server.rb): all transport errors raised by Faraday
+
+All errors inherit from `Graphlient::Errors::Error` if you need to handle them in bulk.
+
 ### Executing Parameterized Queries and Mutations
 
 Graphlient can execute parameterized queries and mutations by providing variables as query parameters.

data/lib/graphlient/client.rb

@@ -29,11 +29,13 @@ module Graphlient
     end
 
     def query(query_or_variables = nil, variables = nil, &block)
-      if block_given?
-        execute(parse(&block), query_or_variables)
-      else
-        execute(query_or_variables, variables)
+      rc = if block_given?
+             execute(parse(&block), query_or_variables)
+           else
+             execute(query_or_variables, variables)
       end
+      raise Graphlient::Errors::GraphQL, rc if rc.errors.any?
+      rc
     rescue GraphQL::Client::Error => e
       raise Graphlient::Errors::Client.new(e.message, e)
     end

data/lib/graphlient/errors.rb

@@ -1,3 +1,4 @@
 require_relative 'errors/error'
 require_relative 'errors/client'
 require_relative 'errors/server'
+require_relative 'errors/graphql'

data/lib/graphlient/errors/graphql.rb

@@ -0,0 +1,44 @@
+module Graphlient
+  module Errors
+    class GraphQL < Error
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+        super 'the server responded with a GraphQL error'
+      end
+
+      def errors
+        response.errors
+      end
+
+      def to_s
+        errors.details.map do |key, details|
+          details = create_details(details).join("\n")
+          [key == 'data' ? nil : key, details].compact.join(': ')
+        end.join("\n")
+      end
+
+      private
+
+      def create_details(details)
+        details.map { |detail| create_detail(detail) }
+      end
+
+      def create_detail(detail)
+        message = detail['message']
+        [message, create_problems(detail['problems']).compact.join("\n  ")].join("\n  ")
+      end
+
+      def create_problems(problems)
+        problems.map { |problem| create_problem(problem) }
+      end
+
+      def create_problem(problem)
+        paths = problem['path'].join(', ')
+        explanation = problem['explanation']
+        [paths, explanation].join(': ')
+      end
+    end
+  end
+end

data/lib/graphlient/version.rb

@@ -1,3 +1,3 @@
 module Graphlient
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.0.8'.freeze
 end

data/spec/graphlient/client_query_spec.rb

@@ -143,20 +143,17 @@ describe Graphlient::Client do
 
     context 'parameterized query' do
       it 'fails when missing input' do
-        response = client.query do
-          mutation('$input' => :createInvoiceInput!) do
-            createInvoice(input: :$input) do
-              id
-              fee_in_cents
+        expect do
+          client.query do
+            mutation('$input' => :createInvoiceInput!) do
+              createInvoice(input: :$input) do
+                id
+                fee_in_cents
+              end
             end
           end
-        end
-
-        expect(response.errors.messages['data']).to eq(
-          [
-            'Variable input of type createInvoiceInput! was provided invalid value'
-          ]
-        )
+        end.to raise_error Graphlient::Errors::GraphQL,
+                           "Variable input of type createInvoiceInput! was provided invalid value\n  : Expected value to not be null"
       end
 
       it 'returns a response from a query' do
@@ -188,6 +185,20 @@ describe Graphlient::Client do
         expect(invoice.id).to eq 1231
         expect(invoice.fee_in_cents).to eq 12_345
       end
+
+      it 'fails when mutation missing a field' do
+        expect do
+          client.query(input: {}) do
+            mutation(:$input => :createInvoiceInput!) do
+              createInvoice(input: :$input) do
+                id
+                fee_in_cents
+              end
+            end
+          end
+        end.to raise_error Graphlient::Errors::GraphQL,
+                           "Variable input of type createInvoiceInput! was provided invalid value\n  fee_in_cents: Expected value to not be null"
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphlient
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Ashkan Nasseri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql-client
@@ -79,6 +79,7 @@ files:
 - lib/graphlient/errors.rb
 - lib/graphlient/errors/client.rb
 - lib/graphlient/errors/error.rb
+- lib/graphlient/errors/graphql.rb
 - lib/graphlient/errors/server.rb
 - lib/graphlient/extensions.rb
 - lib/graphlient/extensions/query.rb