graphlient 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c5a902290bf910c35ad39c06f697c00b54e0156
-  data.tar.gz: c27b7ed166bf0acc803547aad92f5cbc35164da2
+  metadata.gz: 34caaff4616027770512deba3bd043d83379d84f
+  data.tar.gz: 95ee485aee51537d6e90e67aa4616ce1db4bcef9
 SHA512:
-  metadata.gz: e8ca60f3ced8b55dc975bce37727abeeddbb18612c8c33596502e23b3b785613d38bae6e48a94e270d635bf89ef9b3e57e8c9b779a4cca764ef2ce5b2da708ba
-  data.tar.gz: a9474b9a2bef82b9fa4aff02d2e314827e5dc97a8f16b7efe30f4b836c10a2eb5acb967978fed95043a27cf89c2985c7aaf2df6878e63923bcab82a9f2fbf2e3
+  metadata.gz: ce7dd3f6274fee8b92c674f833bde196cb5195c34e06e07911b5753aa20d41c9a16d0e041fac8b9f4ab57f3eb6b8deffe6ae6c87c5e59682c0b5e182f46412d8
+  data.tar.gz: 3334aeb5aa4c80d8a715b9a74fd5b7f657e5bd8403f8cc0ac927059416b913818758c0c34ba18f45656756c210a1da2520b4f301c8f7b336ba691faae971469e

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-10-27 10:35:56 -0400 using RuboCop version 0.47.1.
+# on 2018-05-17 08:20:20 -0500 using RuboCop version 0.56.0.
 # 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,16 +13,23 @@ Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/graphlient/adapters/http/http_adapter.rb'
 
-# Offense count: 1
+# Offense count: 2
 Metrics/CyclomaticComplexity:
-  Max: 9
+  Max: 8
 
 # Offense count: 1
 Metrics/PerceivedComplexity:
-  Max: 9
+  Max: 8
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/InefficientHashSearch:
+  Exclude:
+    - 'lib/graphlient/query.rb'
 
 # Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle.
 # SupportedStyles: nested, compact
 Style/ClassAndModuleChildren:
   Exclude:
@@ -30,7 +37,7 @@ Style/ClassAndModuleChildren:
 
 # Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: line_count_dependent, lambda, literal
 Style/Lambda:
   Exclude:
@@ -38,7 +45,7 @@ Style/Lambda:
     - 'spec/support/queries/query.rb'
 
 # Offense count: 2
-Style/MethodMissing:
+Style/MethodMissingSuper:
   Exclude:
     - 'lib/graphlient/extensions/query.rb'
     - 'lib/graphlient/query.rb'
@@ -49,7 +56,17 @@ Style/MultilineBlockChain:
     - 'spec/graphlient/client_query_spec.rb'
     - 'spec/graphlient/client_schema_spec.rb'
 
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, Whitelist.
+# Whitelist: present?, blank?, presence, try, try!
 Style/SafeNavigation:
   Exclude:
-    - 'lib/graphlient/client.rb'
     - 'lib/graphlient/adapters/http/http_adapter.rb'
+    - 'lib/graphlient/client.rb'
+
+# Offense count: 37
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 181

data/.travis.yml

@@ -3,7 +3,6 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.2.9
   - 2.3.6
   - 2.4.3
   - 2.5.0
@@ -11,6 +10,9 @@ rvm:
   - jruby-9.1.16.0
   - jruby-head
 
+before_install:
+  - gem update --system
+
 matrix:
   include:
     - rvm: 2.3.6

data/CHANGELOG.md

@@ -1,7 +1,12 @@
-### 0.3.1 (Next)
+### (Next)
 
-* [#43](https://github.com/ashkan18/graphlient/pull/38): Allow to load and dump schema to json - [@povilasjurcys](https://github.com/povilasjurcys).
 * Your contribution here.
+* [#46](https://github.com/ashkan18/graphlient/pull/46): Fix issue with gathering error details when trying `to_s` on `GraphQLError` - [@ashkan18](https://github.com/ashkan18).
+* [#45](https://github.com/ashkan18/graphlient/pull/45): Drop Support for Ruby 2.2 and Lock RuboCop - [@jonallured](https://github.com/jonallured).
+
+### 0.3.1 (04/17/2018)
+
+* [#43](https://github.com/ashkan18/graphlient/pull/43): Allow to load and dump schema to json - [@povilasjurcys](https://github.com/povilasjurcys).
 
 ### 0.3.0 (02/22/2018)
 

data/Gemfile

@@ -7,7 +7,7 @@ gem 'rake'
 group :development do
   gem 'byebug', platform: :ruby
   gem 'danger-changelog', '~> 0.2.1'
-  gem 'rubocop', '~> 0.48', require: false
+  gem 'rubocop', '0.56.0'
 end
 
 group :test do

data/README.md

@@ -352,7 +352,7 @@ describe App do
   end
 
   it 'retrieves schema' do
-    expect(client.schema).to be_a GraphQL::Schema
+    expect(client.schema).to be_a Graphlient::Schema
   end
 end
 ```

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

@@ -9,7 +9,7 @@ module Graphlient
 
           request['Accept'] = 'application/json'
           request['Content-Type'] = 'application/json'
-          headers && headers.each { |name, value| request[name] = value }
+          headers&.each { |name, value| request[name] = value }
 
           body = {}
           body['query'] = document.to_query_string

data/lib/graphlient/client.rb

@@ -26,7 +26,7 @@ module Graphlient
       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?
+      raise Graphlient::Errors::ExecutionError, rc if rc.data&.errors && rc.data.errors.any?
       rc
     rescue GraphQL::Client::Error => e
       raise Graphlient::Errors::ClientError.new(e.message, e)

data/lib/graphlient/errors/graphql_error.rb

@@ -25,9 +25,19 @@ module Graphlient
         details.map { |detail| create_detail(detail) }
       end
 
+      ##
+      # Generates human readable error explanation from a GraphQL error message
+      # It first tries `problem` attribute of the error response
+      # then checks for error root level `path` and tries to generate error from that
+      # and if none exist, it fallbacks to just return error message
       def create_detail(detail)
-        message = detail['message']
-        [message, create_problems(detail['problems']).compact.join("\n  ")].join("\n  ")
+        if detail.key?('problems')
+          [detail['message'], create_problems(detail['problems']).compact.join("\n  ")].join("\n  ")
+        elsif detail.key?('path')
+          [detail['path'].compact.join(' '), detail['message']].join(': ')
+        else
+          detail['message']
+        end
       end
 
       def create_problems(problems)
@@ -35,9 +45,8 @@ module Graphlient
       end
 
       def create_problem(problem)
-        paths = problem['path'].join(', ')
-        explanation = problem['explanation']
-        [paths, explanation].join(': ')
+        paths = problem.key?('path') && !problem['path'].empty? ? "#{problem['path'].join(', ')}: " : ''
+        [paths, problem['explanation']].compact.join
       end
     end
   end

data/lib/graphlient/query.rb

@@ -100,7 +100,7 @@ module Graphlient
       when Hash
         "{ #{value.map { |k, v| "#{k}: #{argument_value_string(v)}" }.join(', ')} }"
       when Symbol
-        @variables.keys.include?(value) ? "$#{value}" : value.to_s.camelize(:lower)
+        @variables.key?(value) ? "$#{value}" : value.to_s.camelize(:lower)
       else
         value
       end

data/lib/graphlient/version.rb

@@ -1,3 +1,3 @@
 module Graphlient
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.3.2'.freeze
 end

data/spec/graphlient/client_query_spec.rb

@@ -8,9 +8,9 @@ describe Graphlient::Client do
       let(:query) do
         client.parse do
           query do
-            invoices(ids: [10]) do
+            invoice(id: 10) do
               id
-              fee_in_cents
+              feeInCents
             end
           end
         end
@@ -22,18 +22,18 @@ describe Graphlient::Client do
 
       it '#execute' do
         response = client.execute(query)
-        invoices = response.data.invoices
-        expect(invoices.first.id).to eq 10
+        invoice = response.data.invoice
+        expect(invoice.id).to eq '10'
       end
     end
 
     context 'parameterized query' do
       let(:query) do
         client.parse do
-          query(some_ids: [:int]) do
-            invoices(ids: :some_ids) do
+          query(some_id: :int) do
+            invoice(id: :some_id) do
               id
-              fee_in_cents
+              feeInCents
             end
           end
         end
@@ -44,52 +44,71 @@ describe Graphlient::Client do
       end
 
       it '#execute' do
-        response = client.execute(query, some_ids: [42])
-        invoices = response.data.invoices
-        expect(invoices.first.id).to eq 42
-        expect(invoices.first.fee_in_cents).to eq 20_000
+        response = client.execute(query, some_id: 42)
+        invoice = response.data.invoice
+        expect(invoice.id).to eq '42'
+        expect(invoice.fee_in_cents).to eq 20_000
       end
 
       it '#execute without variables' do
         response = client.execute(query)
-        invoices = response.data.invoices
-        expect(invoices).to eq([])
+        invoice = response.data.invoice
+        expect(invoice).to be_nil
       end
     end
 
     context 'parameterized GRAPHQL query' do
       let(:query) do
         <<-GRAPHQL
-          query($ids: [Int]) {
-            invoices(ids: $ids) {
+          query($id: Int) {
+            invoice(id: $id) {
               id
-              fee_in_cents
+              feeInCents
+            }
+          }
+        GRAPHQL
+      end
+
+      let(:not_null_query) do
+        <<-GRAPHQL
+          query($id: Int) {
+            notNullInvoice(id: $id) {
+              id
+              feeInCents
             }
           }
         GRAPHQL
       end
 
       it '#execute' do
-        response = client.execute(query, ids: [42])
-        invoices = response.data.invoices
-        expect(invoices.first.id).to eq 42
-        expect(invoices.first.fee_in_cents).to eq 20_000
+        response = client.execute(query, id: 42)
+        invoice = response.data.invoice
+        expect(invoice.id).to eq '42'
+        expect(invoice.fee_in_cents).to eq 20_000
       end
 
       it 'fails when wrong input type' do
         expect do
-          client.execute(query, ids: ['42'])
+          client.execute(query, id: '42')
         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"
+          expect(e.to_s).to eq "Variable id of type Int was provided invalid value\n  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])
+          client.execute(query, id: 42)
         end.to raise_error Graphlient::Errors::ExecutionError do |e|
-          expect(e.to_s).to eq 'invoices: Unexpected error.'
+          expect(e.to_s).to eq 'invoice: Unexpected error.'
+        end
+      end
+
+      it 'fails with proper error message' do
+        expect do
+          client.execute(not_null_query, id: 42)
+        end.to raise_error Graphlient::Errors::GraphQLError do |e|
+          expect(e.to_s).to eq 'Cannot return null for non-nullable field Query.notNullInvoice'
         end
       end
     end
@@ -101,59 +120,62 @@ describe Graphlient::Client do
         expect do
           client.query do
             query do
-              invoice(id: 10) do
+              invoices(id: 10) do
                 id
-                fee_in_cents
+                feeInCents
               end
             end
           end
         end.to raise_error Graphlient::Errors::ClientError do |e|
-          expect(e.to_s).to eq "Field 'invoice' doesn't exist on type 'Query'"
+          expect(e.to_s).to eq "Field 'invoices' doesn't exist on type 'Query'"
         end
       end
 
       it 'returns a response from a query' do
         response = client.query do
           query do
-            invoices(ids: [10]) do
+            invoice(id: 10) do
               id
-              fee_in_cents
+              feeInCents
             end
           end
         end
 
-        invoices = response.data.invoices
-        expect(invoices.first.id).to eq 10
-        expect(invoices.first.fee_in_cents).to eq 20_000
+        invoice = response.data.invoice
+        expect(invoice.id).to eq '10'
+        expect(invoice.fee_in_cents).to eq 20_000
       end
 
       it 'returns a response from a GRAPHQL query' do
         response = client.query <<-GRAPHQL
           query {
-            invoices(ids: [10]) {
+            invoice(id: 10) {
               id
-              fee_in_cents
+              feeInCents
             }
           }
         GRAPHQL
 
-        invoices = response.data.invoices
-        expect(invoices.first.id).to eq 10
-        expect(invoices.first.fee_in_cents).to eq 20_000
+        invoice = response.data.invoice
+        expect(invoice.id).to eq '10'
+        expect(invoice.fee_in_cents).to eq 20_000
       end
 
       it 'returns a response from a mutation' do
         response = client.query do
           mutation do
-            createInvoice(input: { fee_in_cents: 12_345 }) do
-              id
-              fee_in_cents
+            createInvoice(input: { feeInCents: 12_345 }) do
+              invoice do
+                id
+                feeInCents
+              end
+              errors
             end
           end
         end
 
-        invoice = response.data.create_invoice.first
-        expect(invoice.id).to eq 1231
+        invoice = response.data.create_invoice.invoice
+        expect(invoice.id).to eq '1231'
         expect(invoice.fee_in_cents).to eq 12_345
       end
     end
@@ -162,59 +184,67 @@ describe Graphlient::Client do
       it 'fails when missing input' do
         expect do
           client.query do
-            mutation(input: :createInvoiceInput!) do
+            mutation(input: :CreateInvoiceInput!) do
               createInvoice(input: :input) do
-                id
-                fee_in_cents
+                invoice do
+                  id
+                  feeInCents
+                end
+                errors
               end
             end
           end
         end.to raise_error Graphlient::Errors::GraphQLError,
-                           "Variable input of type createInvoiceInput! was provided invalid value\n  : Expected value to not be null"
+                           "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
-        response = client.query(ids: [42]) do
-          query(ids: [:int]) do
-            invoices(ids: :ids) do
+        response = client.query(id: 42) do
+          query(id: :int) do
+            invoice(id: :id) do
               id
-              fee_in_cents
+              feeInCents
             end
           end
         end
 
-        invoices = response.data.invoices
-        expect(invoices.first.id).to eq 42
-        expect(invoices.first.fee_in_cents).to eq 20_000
+        invoice = response.data.invoice
+        expect(invoice.id).to eq '42'
+        expect(invoice.fee_in_cents).to eq 20_000
       end
 
       it 'executes the mutation' do
-        response = client.query(input: { fee_in_cents: 12_345 }) do
-          mutation(input: :createInvoiceInput!) do
+        response = client.query(input: { feeInCents: 12_345 }) do
+          mutation(input: :CreateInvoiceInput!) do
             createInvoice(input: :input) do
-              id
-              fee_in_cents
+              invoice do
+                id
+                feeInCents
+              end
+              errors
             end
           end
         end
-
-        invoice = response.data.create_invoice.first
-        expect(invoice.id).to eq 1231
+        invoice = response.data.create_invoice.invoice
+        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
+            mutation(input: :CreateInvoiceInput!) do
               createInvoice(input: :input) do
-                id
-                fee_in_cents
+                invoice do
+                  id
+                  feeInCents
+                end
+                errors
               end
             end
           end
         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"
+                           "Variable input of type CreateInvoiceInput! was provided invalid value\n  feeInCents: Expected value to not be null"
       end
     end
   end

data/spec/graphlient/static_client_query_spec.rb

@@ -16,10 +16,10 @@ describe Graphlient::Client do
       end
 
       Query = Client.parse do
-        query(some_ids: [:int]) do
-          invoices(ids: :some_ids) do
+        query(some_id: :int) do
+          invoice(id: :some_id) do
             id
-            fee_in_cents
+            feeInCents
           end
         end
       end
@@ -30,10 +30,10 @@ describe Graphlient::Client do
     end
 
     it '#execute' do
-      response = Graphlient::Client::Spec::Client.execute(Graphlient::Client::Spec::Query, some_ids: [42])
-      invoices = response.data.invoices
-      expect(invoices.first.id).to eq 42
-      expect(invoices.first.fee_in_cents).to eq 20_000
+      response = Graphlient::Client::Spec::Client.execute(Graphlient::Client::Spec::Query, some_id: 42)
+      invoice = response.data.invoice
+      expect(invoice.id).to eq '42'
+      expect(invoice.fee_in_cents).to eq 20_000
     end
   end
 end

data/spec/support/dummy_schema.rb

@@ -1,13 +1,13 @@
 require_relative 'types/invoice_type'
 
 require_relative 'queries/query'
-require_relative 'mutations/mutation'
+require_relative 'types/mutation_type.rb'
 
 require 'graphql/errors'
 
-DummySchema = GraphQL::Schema.define do
-  query Query
-  mutation Mutation
+class DummySchema < GraphQL::Schema
+  query(Query)
+  mutation(MutationType)
 end
 
 GraphQL::Errors.configure(DummySchema) do

data/spec/support/mutations/create_invoice.rb

@@ -0,0 +1,17 @@
+class CreateInvoice < GraphQL::Schema::RelayClassicMutation
+  null true
+
+  argument :fee_in_cents, Integer, required: true
+
+  field :invoice, InvoiceType, null: true
+  field :errors, [String], null: true
+
+  def resolve(fee_in_cents:)
+    {
+      invoice: OpenStruct.new(
+        id: 1231,
+        fee_in_cents: fee_in_cents
+      )
+    }
+  end
+end

data/spec/support/queries/query.rb

@@ -1,16 +1,24 @@
-Query = GraphQL::ObjectType.define do
-  name 'Query'
+require_relative '../types/invoice_type'
+class Query < GraphQL::Schema::Object
+  field :invoice, InvoiceType, null: true do
+    description 'Find invoice'
+    argument :id, Integer, required: false
+  end
+
+  field :not_null_invoice, InvoiceType, null: false do
+    description 'Find invoice'
+    argument :id, Integer, required: false
+  end
+
+  def invoice(id: nil)
+    return nil if id.nil?
+    OpenStruct.new(
+      id: id,
+      fee_in_cents: 20_000
+    )
+  end
 
-  field :invoices, types[InvoiceType] do
-    argument :ids, types[types.Int]
-    description 'Find Invoices'
-    resolve ->(_obj, args, _ctx) {
-      (args[:ids] || []).map do |id|
-        OpenStruct.new(
-          id: id,
-          fee_in_cents: 20_000
-        )
-      end
-    }
+  def not_null_invoice(*)
+    nil
   end
 end

data/spec/support/types/invoice_type.rb

@@ -1,6 +1,7 @@
-InvoiceType = GraphQL::ObjectType.define do
-  name 'Invoice'
+class InvoiceType < GraphQL::Schema::Object
   description 'An Invoice'
-  field :id, !types.Int
-  field :fee_in_cents, types.Int
+  graphql_name 'Invoice'
+
+  field :id, ID, null: false
+  field :fee_in_cents, Integer, null: true
 end

data/spec/support/types/mutation_type.rb

@@ -0,0 +1,5 @@
+require_relative '../mutations/create_invoice'
+
+class MutationType < GraphQL::Schema::Object
+  field :createInvoice, mutation: CreateInvoice
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphlient
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Ashkan Nasseri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-17 00:00:00.000000000 Z
+date: 2018-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -103,10 +103,10 @@ files:
 - spec/support/context/dummy_client.rb
 - spec/support/dummy_app.rb
 - spec/support/dummy_schema.rb
-- spec/support/mutations/create_invoice_mutation.rb
-- spec/support/mutations/mutation.rb
+- spec/support/mutations/create_invoice.rb
 - spec/support/queries/query.rb
 - spec/support/types/invoice_type.rb
+- spec/support/types/mutation_type.rb
 homepage: http://github.com/ashkan18/graphlient
 licenses:
 - MIT

data/spec/support/mutations/create_invoice_mutation.rb

@@ -1,16 +0,0 @@
-CreateInvoiceMutation = GraphQL::Relay::Mutation.define do
-  name 'createInvoice'
-
-  input_field :fee_in_cents, !types.Int
-
-  return_type types[InvoiceType]
-
-  resolve ->(_object, inputs, _ctx) {
-    [
-      OpenStruct.new(
-        id: 1231,
-        fee_in_cents: inputs[:fee_in_cents]
-      )
-    ]
-  }
-end

data/spec/support/mutations/mutation.rb

@@ -1,7 +0,0 @@
-require_relative './create_invoice_mutation'
-
-Mutation = GraphQL::ObjectType.define do
-  name 'Mutation'
-
-  field :createInvoice, field: CreateInvoiceMutation.field
-end