graphlient 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3243a1525db30d3bf16a4bc9fc699e07c829a3d5
-  data.tar.gz: 37d6d5fc32ce427967b06d3975b80d393af333a8
+  metadata.gz: f73350b469913784302c46b7305cef2d8949ad32
+  data.tar.gz: 91e1a47a61c402174bef0f15a0568e05d26b73cc
 SHA512:
-  metadata.gz: 29a39b7c44150ad3e9182b98e14ed407a688fffefb6a2fa1a62644130cb6c4c04bc694584d6cd6dab5b0b9321911d905b5a902a50aa11fcf75ac6747b1c15d7b
-  data.tar.gz: d665ba561261fa682ec71888810d9767f3f9a1a6ad4d8186832454d0220fbcfc1ad9957a9ca1af8136019c6848f20cae849e94c2a57812d73cd822d97fd15f76
+  metadata.gz: aaadb8bf32399b399fae81c4ce62a3d73508317eb4a157f90c9bf1665a77f5d91116dc0e263a6d27a2d5dfad9eeca1ea730b3d81966d68d0519c65b2dd9cb3cc
+  data.tar.gz: f50b03492b2e1c82b974fd5e59952e00cd38f82e992d5a2be84efdb4afa146a4ec65cf3370b4d77054a9de3094b7fb483453aea6f48655695c73e76bbbd83d59

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-10-26 13:24:56 -0400 using RuboCop version 0.47.1.
+# on 2017-10-27 10:35:56 -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
@@ -13,6 +13,14 @@ Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/graphlient/adapters/http/http_adapter.rb'
 
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 9
+
 # Offense count: 1
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: nested, compact
@@ -35,7 +43,7 @@ Style/MethodMissing:
     - 'lib/graphlient/extensions/query.rb'
     - 'lib/graphlient/query.rb'
 
-# Offense count: 3
+# Offense count: 4
 Style/MultilineBlockChain:
   Exclude:
     - 'spec/graphlient/client_query_spec.rb'

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.1.0 (10/27/2017)
+
+* [#31](https://github.com/ashkan18/graphlient/issues/31): Fix: catch execution errors that don't contain field names - [@dblock](https://github.com/dblock).
+
 ### 0.0.9 (10/26/2017)
 
 * [#28](https://github.com/ashkan18/graphlient/pull/28): Raise errors in `execute`, not only `query` - [@dblock](https://github.com/dblock).

data/Gemfile

@@ -12,6 +12,7 @@ end
 
 group :test do
   gem 'graphql'
+  gem 'graphql-errors'
   gem 'rack-parser'
   gem 'rack-test'
   gem 'rspec'

data/README.md

@@ -111,9 +111,10 @@ response.data.create_invoice.first.id
 
 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
+* [Graphlient::Errors::ClientError](lib/graphlient/errors/client_error.rb): all client-side query validation failures based on current schema
+* [Graphlient::Errors::GraphQLError](lib/graphlient/errors/graphql_error.rb): all GraphQL API errors, with a humanly readable collection of problems
+* [Graphlient::Errors::ExecutionError](lib/graphlient/errors/execution_error.rb): all GraphQL execution errors, with a humanly readable collection of problems
+* [Graphlient::Errors::ServerError](lib/graphlient/errors/server_error.rb): all transport errors raised by Faraday
 
 All errors inherit from `Graphlient::Errors::Error` if you need to handle them in bulk.
 

data/graphlient.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.homepage = 'http://github.com/ashkan18/graphlient'
   s.licenses = ['MIT']
-  s.summary = 'Ruby Gem for consuming GraphQL endpoints'
+  s.summary = 'A friendlier Ruby client for consuming GraphQL-based APIs.'
   s.add_dependency 'graphql-client'
   s.add_dependency 'faraday'
   s.add_dependency 'faraday_middleware'

data/lib/graphlient/adapters/http/faraday_adapter.rb

@@ -16,7 +16,7 @@ module Graphlient
           end
           response.body
         rescue Faraday::ClientError => e
-          raise Graphlient::Errors::Server.new(e.message, e)
+          raise Graphlient::Errors::ServerError.new(e.message, e)
         end
 
         def connection

data/lib/graphlient/adapters/http/http_adapter.rb

@@ -20,7 +20,7 @@ module Graphlient
           request.body = JSON.generate(body)
 
           response = connection.request(request)
-          raise Graphlient::Errors::Server.new("the server responded with status #{response.code}", response) unless response.is_a?(Net::HTTPOK)
+          raise Graphlient::Errors::ServerError.new("the server responded with status #{response.code}", response) unless response.is_a?(Net::HTTPOK)
           JSON.parse(response.body)
         end
 

data/lib/graphlient/client.rb

@@ -14,7 +14,7 @@ module Graphlient
       end
       client.parse(query_str.to_s)
     rescue GraphQL::Client::Error => e
-      raise Graphlient::Errors::Client.new(e.message, e)
+      raise Graphlient::Errors::ClientError.new(e.message, e)
     end
 
     def execute(query, variables = nil)
@@ -23,10 +23,13 @@ module Graphlient
       query_params[:variables] = variables if variables
       query = client.parse(query) if query.is_a?(String)
       rc = client.query(query, query_params)
-      raise Graphlient::Errors::GraphQL, rc if rc.errors.any?
+      raise Graphlient::Errors::GraphQLError, rc if rc.errors.any?
+      # see https://github.com/github/graphql-client/pull/132
+      # see https://github.com/exAspArk/graphql-errors/issues/2
+      raise Graphlient::Errors::ExecutionError, rc if rc.data && rc.data.errors && rc.data.errors.any?
       rc
     rescue GraphQL::Client::Error => e
-      raise Graphlient::Errors::Client.new(e.message, e)
+      raise Graphlient::Errors::ClientError.new(e.message, e)
     end
 
     def query(query_or_variables = nil, variables = nil, &block)

data/lib/graphlient/errors.rb

@@ -1,4 +1,5 @@
 require_relative 'errors/error'
-require_relative 'errors/client'
-require_relative 'errors/server'
-require_relative 'errors/graphql'
+require_relative 'errors/client_error'
+require_relative 'errors/server_error'
+require_relative 'errors/graphql_error'
+require_relative 'errors/execution_error'

data/lib/graphlient/errors/{client.rb → client_error.rb}

@@ -1,6 +1,6 @@
 module Graphlient
   module Errors
-    class Client < Error
+    class ClientError < Error
     end
   end
 end

data/lib/graphlient/errors/execution_error.rb

@@ -0,0 +1,29 @@
+module Graphlient
+  module Errors
+    class ExecutionError < Error
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+        super 'the server responded with a GraphQL execution error'
+      end
+
+      def errors
+        response.data.errors
+      end
+
+      def to_s
+        errors.details.map do |key, details|
+          details = create_details(details).join("\n")
+          [key, details].compact.join(': ')
+        end.join("\n")
+      end
+
+      private
+
+      def create_details(details)
+        details.map { |detail| detail['message'] }
+      end
+    end
+  end
+end

data/lib/graphlient/errors/{graphql.rb → graphql_error.rb}

@@ -1,6 +1,6 @@
 module Graphlient
   module Errors
-    class GraphQL < Error
+    class GraphQLError < Error
       attr_reader :response
 
       def initialize(response)

data/lib/graphlient/errors/{server.rb → server_error.rb}

@@ -1,6 +1,6 @@
 module Graphlient
   module Errors
-    class Server < Error
+    class ServerError < Error
     end
   end
 end

data/lib/graphlient/version.rb

@@ -1,3 +1,3 @@
 module Graphlient
-  VERSION = '0.0.9'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/spec/graphlient/client_query_spec.rb

@@ -79,10 +79,19 @@ describe Graphlient::Client do
       it 'fails when wrong input type' do
         expect do
           client.execute(query, ids: ['42'])
-        end.to raise_error Graphlient::Errors::GraphQL do |e|
+        end.to raise_error Graphlient::Errors::GraphQLError do |e|
           expect(e.to_s).to eq "Variable ids of type [Int] was provided invalid value\n  0: Could not coerce value \"42\" to Int"
         end
       end
+
+      it 'fails on an execution error' do
+        expect do
+          allow(OpenStruct).to receive(:new).and_raise StandardError, 'Unexpected error.'
+          client.execute(query, ids: [42])
+        end.to raise_error Graphlient::Errors::ExecutionError do |e|
+          expect(e.to_s).to eq 'invoices: Unexpected error.'
+        end
+      end
     end
   end
 
@@ -98,7 +107,7 @@ describe Graphlient::Client do
               end
             end
           end
-        end.to raise_error Graphlient::Errors::Client do |e|
+        end.to raise_error Graphlient::Errors::ClientError do |e|
           expect(e.to_s).to eq "Field 'invoice' doesn't exist on type 'Query'"
         end
       end
@@ -160,7 +169,7 @@ describe Graphlient::Client do
               end
             end
           end
-        end.to raise_error Graphlient::Errors::GraphQL,
+        end.to raise_error Graphlient::Errors::GraphQLError,
                            "Variable input of type createInvoiceInput! was provided invalid value\n  : Expected value to not be null"
       end
 
@@ -204,7 +213,7 @@ describe Graphlient::Client do
               end
             end
           end
-        end.to raise_error Graphlient::Errors::GraphQL,
+        end.to raise_error Graphlient::Errors::GraphQLError,
                            "Variable input of type createInvoiceInput! was provided invalid value\n  fee_in_cents: Expected value to not be null"
       end
     end

data/spec/graphlient/client_schema_spec.rb

@@ -11,7 +11,7 @@ describe Graphlient::Client do
     it 'fails with an exception' do
       expect do
         client.schema
-      end.to raise_error Graphlient::Errors::Server do |e|
+      end.to raise_error Graphlient::Errors::ServerError do |e|
         expect(e.to_s).to eq 'the server responded with status 500'
       end
     end

data/spec/support/dummy_app.rb

@@ -9,17 +9,11 @@ before do
 end
 
 post '/graphql' do
-  begin
-    headers['Content-Type'] = 'application/json'
-    DummySchema.execute(
-      params[:query],
-      variables: params[:variables] ? JSON.parse(params[:variables]) : {},
-      context: {},
-      operation_name: params[:operationName]
-    ).to_json
-  rescue StandardError => e
-    warn e
-    warn e.backtrace.join("\n")
-    raise e
-  end
+  headers['Content-Type'] = 'application/json'
+  DummySchema.execute(
+    params[:query],
+    variables: params[:variables] ? JSON.parse(params[:variables]) : {},
+    context: {},
+    operation_name: params[:operationName]
+  ).to_json
 end

data/spec/support/dummy_schema.rb

@@ -3,7 +3,15 @@ require_relative 'types/invoice_type'
 require_relative 'queries/query'
 require_relative 'mutations/mutation'
 
+require 'graphql/errors'
+
 DummySchema = GraphQL::Schema.define do
   query Query
   mutation Mutation
 end
+
+GraphQL::Errors.configure(DummySchema) do
+  rescue_from StandardError do |e|
+    GraphQL::ExecutionError.new(e.message)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphlient
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Ashkan Nasseri
@@ -81,10 +81,11 @@ files:
 - lib/graphlient/adapters/http/http_adapter.rb
 - lib/graphlient/client.rb
 - lib/graphlient/errors.rb
-- lib/graphlient/errors/client.rb
+- lib/graphlient/errors/client_error.rb
 - lib/graphlient/errors/error.rb
-- lib/graphlient/errors/graphql.rb
-- lib/graphlient/errors/server.rb
+- lib/graphlient/errors/execution_error.rb
+- lib/graphlient/errors/graphql_error.rb
+- lib/graphlient/errors/server_error.rb
 - lib/graphlient/extensions.rb
 - lib/graphlient/extensions/query.rb
 - lib/graphlient/query.rb
@@ -124,8 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Ruby Gem for consuming GraphQL endpoints
+summary: A friendlier Ruby client for consuming GraphQL-based APIs.
 test_files: []