graphlient 0.3.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab92f3273bda224b78e022567186f00e9865d746ecb9de61d6ae392e480bc67d
-  data.tar.gz: 4e56127d81400beb61d1b9f502b63b3a712aa976d723dba524cbb6e579a7711b
+  metadata.gz: c049e978a0c48e45fe84d49470bc890ae3b6ea86b86aab8158322616c62968dd
+  data.tar.gz: c7307c2b5c6ac6ac2b55ee4d416bbfffee1e29ed0826916254077add10370ee9
 SHA512:
-  metadata.gz: 0480cf615f51cd10d7c74efe03b0a291870027373cd9b4d5d3ee55b778ec4494379177823e1864f7d5c77da7c71eaead5a9870127a0976c9ba5ff0e84bbe9877
-  data.tar.gz: 73202625813b08c871393e7656412a2439caf4454e8d021c00fcd24e06cca47328bee530571e013e0e69fba217cbc284fa187ae0661f3e495eeb65e14995f6b4
+  metadata.gz: 627d0d04d5ecea5e4c33ea0e59b15ac46fc458f76f179ac624d3519036865ad29267f629b1b3fda7592a50c846ea2cf06cc58a8f188a06caee44715268c18d07
+  data.tar.gz: 9742adef6879fbd08b00350674dced4b4886e476b45388d6d1a1afaaebba440153632e878649ff68beb223b158f365dd180b6db76e8463a13dbbeb4cdf8aa88d

data/.rubocop.yml

@@ -1,3 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Lint/SplatKeywordArguments:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 

data/.travis.yml

@@ -3,9 +3,9 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.3.6
-  - 2.4.3
   - 2.5.0
+  - 2.7.2
+  - 3.0.0
   - ruby-head
   - jruby-9.1.16.0
   - jruby-head
@@ -15,7 +15,7 @@ before_install:
 
 matrix:
   include:
-    - rvm: 2.3.6
+    - rvm: 2.7.2
       script:
         - bundle exec danger
   allow_failures:

data/CHANGELOG.md

@@ -1,7 +1,20 @@
-### 0.3.8 (Next)
+### 0.6.0 (Next)
 * Your contribution here.
 
-### 0.3.7 (14/11/2019)
+### 0.5.0 (12/28/2020)
+
+* [#81](https://github.com/ashkan18/graphlient/pull/81): Make graphlient run on ruby 3.0 - [@Burgestrand](https://github.com/Burgestrand).
+* [#79](https://github.com/ashkan18/graphlient/pull/79): Added client testing docs - [@GabrielDzul](https://github.com/GabrielDzul).
+
+### 0.4.0 (5/22/2020)
+
+* [#72](https://github.com/ashkan18/graphlient/pull/72): Add http_options - [@neroleung](https://github.com/neroleung).
+* [#71](https://github.com/ashkan18/graphlient/issues/70): Add `Graphlient::Errors::TimeoutError` - [@BenDrozdoff](https://github.com/BenDrozdoff).
+* [#75](https://github.com/ashkan18/graphlient/pull/75): Support Faraday 1.x - [@jfhinchcliffe](https://github.com/jfhinchcliffe).
+* [#78](https://github.com/ashkan18/graphlient/pull/78): Add description of timeout values - [@sap1enza](https://github.com/sap1enza).
+
+### 0.3.7 (11/14/2019)
+
 * [#68](https://github.com/ashkan18/graphlient/pull/68): Add `Graphlient::Errors::ConnectionFailedError` - [@neroleung](https://github.com/neroleung).
 
 ### 0.3.6 (07/23/2019)

data/Gemfile

@@ -15,7 +15,7 @@ group :development do
 end
 
 group :test do
-  gem 'graphql', '~> 1.9.7'
+  gem 'graphql', '~> 1.9'
   gem 'graphql-errors'
   gem 'rack-parser'
   gem 'rack-test'

data/README.md

@@ -15,16 +15,25 @@ gem 'graphlient'
 
 ## Usage
 
-Create a new instance of `Graphlient::Client` with a URL and optional headers.
+Create a new instance of `Graphlient::Client` with a URL and optional headers/http_options.
 
 ```ruby
 client = Graphlient::Client.new('https://test-graphql.biz/graphql',
   headers: {
     'Authorization' => 'Bearer 123'
+  },
+  http_options: {
+    read_timeout: 20,
+    write_timeout: 30
   }
 )
 ```
 
+| http_options  | default | type    |
+|---------------|---------|---------|
+| read_timeout  | nil     | seconds |
+| write_timeout | nil     | seconds |
+
 The schema is available automatically via `.schema`.
 
 ```ruby
@@ -127,6 +136,8 @@ Unlike graphql-client, Graphlient will always raise an exception unless the quer
 * [Graphlient::Errors::FaradayServerError](lib/graphlient/errors/faraday_server_error.rb): this inherits from `ServerError` ☝️, we recommend using `ServerError` to rescue these
 * [Graphlient::Errors::HttpServerError](lib/graphlient/errors/http_server_error.rb): this inherits from `ServerError` ☝️, we recommend using `ServerError` to rescue these
 * [Graphlient::Errors::ConnectionFailedError](lib/graphlient/errors/connection_failed_error.rb): this inherits from `ServerError` ☝️, we recommend using `ServerError` to rescue these
+* [Graphlient::Errors::TimeoutError](lib/graphlient/errors/timeout_error.rb): this inherits from `ServerError` ☝️, we recommend using `ServerError` to rescue these
+* [Graphlient::Errors::HttpOptionsError](lib/graphlient/errors/http_options_error.rb): all NoMethodError raised by HTTP Adapters when given options in `http_options` are invalid
 
 
 All errors inherit from `Graphlient::Errors::Error` if you need to handle them in bulk.
@@ -334,7 +345,7 @@ describe App do
     Graphlient::Client.new('http://test-graphql.biz/graphql') do |client|
       client.http do |h|
         h.connection do |c|
-          c.use Faraday::Adapter::Rack, app
+          c.adapter Faraday::Adapter::Rack, app
         end
       end
     end
@@ -378,6 +389,49 @@ describe App do
 end
 ```
 
+In order to stub the response to actual queries, [dump the schema into a JSON file](#schema-storing-and-loading-on-disk) and specify it via schema_path as follows.
+
+```ruby
+describe App do
+  let(:url) { 'http://graph.biz/graphql' }
+  let(:client) { Graphlient::Client.new(url, schema_path: 'spec/support/fixtures/invoice_api.json') }
+  let(:query) do
+    <<~GRAPHQL
+      query{
+        invoice(id: 42) {
+          id
+          feeInCents
+        }
+      }
+    GRAPHQL
+  end
+  let(:json_response) do
+    {
+      'data' => {
+        'invoice' => {
+          'id' => '42',
+          'feeInCents' => 2000
+        }
+      }
+    }.to_json
+  end
+
+  before do
+    stub_request(:post, url).to_return(
+      status: 200,
+      body: json_response
+    )
+  end
+
+  it 'returns invoice fees' do
+    response = client.query(query)
+    expect(response.data).to be_truthy
+    expect(response.data.invoice.id).to eq('42')
+    expect(response.data.invoice.fee_in_cents).to eq(2000)
+  end
+end
+```
+
 ## License
 
 MIT License, see [LICENSE](LICENSE)

data/UPGRADING.md

@@ -1,6 +1,17 @@
 Upgrading Graphlient
 ===========================
 
+### Upgrading to >= 0.4.0
+
+#### Requires Faraday >= 1.0
+
+See [#75](https://github.com/ashkan18/graphlient/pull/75).
+
+#### Changes in error handling of connection refused error
+
+When the GraphQL request was failing, we were receiving a `Faraday::ServerError`. After 0.4.0, Graphlient
+will return `Graphlient::Errors::FaradayServerError` instead.
+
 ### Upgrading to >= 0.3.7
 
 #### Changes in error handling of connection refused error

data/graphlient.gemspec

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

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

@@ -14,9 +14,27 @@ module Graphlient
           options[:headers] if options
         end
 
+        def http_options
+          return {} unless options
+
+          options[:http_options] || {}
+        end
+
         def execute(*)
           raise NotImplementedError
         end
+
+        private
+
+        def configure_http_options(client_options)
+          http_options.each do |k, v|
+            begin
+              client_options.send("#{k}=", v)
+            rescue NoMethodError => e
+              raise Graphlient::Errors::HttpOptionsError, e.message
+            end
+          end
+        end
       end
     end
   end

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

@@ -17,8 +17,12 @@ module Graphlient
           response.body
         rescue Faraday::ConnectionFailed => e
           raise Graphlient::Errors::ConnectionFailedError, e
+        rescue Faraday::TimeoutError => e
+          raise Graphlient::Errors::TimeoutError, e
         rescue Faraday::ClientError => e
           raise Graphlient::Errors::FaradayServerError, e
+        rescue Faraday::ServerError => e
+          raise Graphlient::Errors::FaradayServerError, e
         end
 
         def connection
@@ -26,10 +30,13 @@ module Graphlient
             c.use Faraday::Response::RaiseError
             c.request :json
             c.response :json
+
+            configure_http_options(c.options)
+
             if block_given?
               yield c
             else
-              c.use Faraday::Adapter::NetHttp
+              c.adapter Faraday::Adapter::NetHttp
             end
           end
         end

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

@@ -29,6 +29,8 @@ module Graphlient
         def connection
           Net::HTTP.new(uri.host, uri.port).tap do |client|
             client.use_ssl = uri.scheme == 'https'
+
+            configure_http_options(client)
           end
         end
       end

data/lib/graphlient/client.rb

@@ -22,7 +22,7 @@ module Graphlient
       query_params[:context] = @options if @options
       query_params[:variables] = variables if variables
       query = client.parse(query) if query.is_a?(String)
-      rc = client.query(query, query_params)
+      rc = client.query(query, **query_params)
       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
@@ -45,7 +45,9 @@ module Graphlient
     end
 
     def http(&block)
-      @http ||= http_adapter_class.new(@url, headers: @options[:headers], &block)
+      adapter_options = { headers: @options[:headers], http_options: @options[:http_options] }
+
+      @http ||= http_adapter_class.new(@url, adapter_options, &block)
     end
 
     def schema

data/lib/graphlient/errors/http_options_error.rb

@@ -0,0 +1,6 @@
+module Graphlient
+  module Errors
+    class HttpOptionsError < Error
+    end
+  end
+end

data/lib/graphlient/errors/timeout_error.rb

@@ -0,0 +1,6 @@
+module Graphlient
+  module Errors
+    class TimeoutError < Error
+    end
+  end
+end

data/lib/graphlient/errors.rb

@@ -4,5 +4,7 @@ require_relative 'errors/server_error'
 require_relative 'errors/graphql_error'
 require_relative 'errors/execution_error'
 require_relative 'errors/faraday_server_error'
+require_relative 'errors/http_options_error'
 require_relative 'errors/http_server_error'
 require_relative 'errors/connection_failed_error'
+require_relative 'errors/timeout_error'

data/lib/graphlient/version.rb

@@ -1,3 +1,3 @@
 module Graphlient
-  VERSION = '0.3.7'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/spec/graphlient/adapters/http/faraday_adapter_spec.rb

@@ -8,29 +8,32 @@ describe Graphlient::Adapters::HTTP::FaradayAdapter do
       Graphlient::Client.new('http://example.com/graphql') do |client|
         client.http do |h|
           h.connection do |c|
-            c.use Faraday::Adapter::Rack, app
+            c.adapter Faraday::Adapter::Rack, app
           end
         end
       end
     end
 
     it 'inserts a middleware into the connection' do
+      expect(client.http.connection.adapter).to eq Faraday::Adapter::Rack
       expect(client.http.connection.builder.handlers).to eq(
         [
           Faraday::Response::RaiseError,
           FaradayMiddleware::EncodeJson,
-          FaradayMiddleware::ParseJson,
-          Faraday::Adapter::Rack
+          FaradayMiddleware::ParseJson
         ]
       )
     end
   end
 
-  context 'with custom url and headers' do
+  context 'with custom url, headers and http_options' do
     let(:url) { 'http://example.com/graphql' }
     let(:headers) { { 'Foo' => 'bar' } }
+    let(:http_options) { { timeout: timeout, write_timeout: write_timeout } }
+    let(:timeout) { 123 }
+    let(:write_timeout) { 234 }
     let(:client) do
-      Graphlient::Client.new(url, headers: headers)
+      Graphlient::Client.new(url, headers: headers, http_options: http_options)
     end
 
     it 'sets url' do
@@ -40,6 +43,19 @@ describe Graphlient::Adapters::HTTP::FaradayAdapter do
     it 'sets headers' do
       expect(client.http.headers).to eq headers
     end
+
+    it 'sets http_options' do
+      expect(client.http.connection.options.timeout).to eq(timeout)
+      expect(client.http.connection.options.write_timeout).to eq(write_timeout)
+    end
+
+    context 'when http_options contains invalid option' do
+      let(:http_options) { { an_invalid_option: 'an invalid option' } }
+
+      it 'raises Graphlient::Errors::HttpOptionsError' do
+        expect { client.http.connection }.to raise_error(Graphlient::Errors::HttpOptionsError)
+      end
+    end
   end
 
   context 'default' do
@@ -78,4 +94,19 @@ describe Graphlient::Adapters::HTTP::FaradayAdapter do
       expect { client.schema }.to raise_error(Graphlient::Errors::ConnectionFailedError, expected_error_message)
     end
   end
+
+  context 'Faraday Timeout Error' do
+    let(:url) { 'http://example.com/graphql' }
+    let(:client) { Graphlient::Client.new(url) }
+    let(:error_message) { 'Failed to Connect' }
+
+    before do
+      stub_request(:post, url).to_raise(Faraday::TimeoutError.new(Net::ReadTimeout.new(error_message)))
+    end
+    it 'raises a Graphlient Timeout' do
+      expect { client.schema }.to raise_error(Graphlient::Errors::TimeoutError) { |error|
+        expect(error.message).to include(error_message)
+      }
+    end
+  end
 end

data/spec/graphlient/adapters/http/http_adapter_spec.rb

@@ -3,11 +3,18 @@ require 'spec_helper'
 describe Graphlient::Adapters::HTTP::HTTPAdapter do
   let(:app) { Object.new }
 
-  context 'with custom url and headers' do
+  context 'with custom url, headers and http_options' do
     let(:url) { 'http://example.com/graphql' }
     let(:headers) { { 'Foo' => 'bar' } }
+    let(:http_options) { { read_timeout: read_timeout } }
+    let(:read_timeout) { nil }
     let(:client) do
-      Graphlient::Client.new(url, headers: headers, http: Graphlient::Adapters::HTTP::HTTPAdapter)
+      Graphlient::Client.new(
+        url,
+        headers: headers,
+        http_options: http_options,
+        http: Graphlient::Adapters::HTTP::HTTPAdapter
+      )
     end
 
     it 'sets adapter' do
@@ -21,6 +28,18 @@ describe Graphlient::Adapters::HTTP::HTTPAdapter do
     it 'sets headers' do
       expect(client.http.headers).to eq headers
     end
+
+    it 'sets http_options' do
+      expect(client.http.connection.read_timeout).to eq(read_timeout)
+    end
+
+    context 'when http_options contains invalid option' do
+      let(:http_options) { { an_invalid_option: 'an invalid option' } }
+
+      it 'raises Graphlient::Errors::HttpOptionsError' do
+        expect { client.http.connection }.to raise_error(Graphlient::Errors::HttpOptionsError)
+      end
+    end
   end
 
   context 'default' do

data/spec/graphlient/client_query_spec.rb

@@ -91,7 +91,7 @@ describe Graphlient::Client do
         expect do
           client.execute(query, id: '42')
         end.to raise_error Graphlient::Errors::GraphQLError do |e|
-          expect(e.to_s).to eq 'Variable id of type Int was provided invalid value'
+          expect(e.to_s).to eq 'Variable $id of type Int was provided invalid value'
         end
       end
 
@@ -223,7 +223,7 @@ describe Graphlient::Client do
             end
           end
         end.to raise_error Graphlient::Errors::GraphQLError,
-                           'Variable input of type CreateInvoiceInput! was provided invalid value'
+                           'Variable $input of type CreateInvoiceInput! was provided invalid value'
       end
 
       it 'returns a response from a query' do
@@ -272,7 +272,7 @@ describe Graphlient::Client do
             end
           end
         end.to raise_error Graphlient::Errors::GraphQLError,
-                           'Variable input of type CreateInvoiceInput! was provided invalid value for feeInCents (Expected value to not be null)'
+                           'Variable $input of type CreateInvoiceInput! was provided invalid value for feeInCents (Expected value to not be null)'
       end
     end
   end

data/spec/graphlient/client_schema_spec.rb

@@ -19,7 +19,7 @@ describe Graphlient::Client do
       it 'fails with an exception' do
         expect do
           client.schema
-        end.to raise_error Graphlient::Errors::ServerError do |e|
+        end.to raise_error Graphlient::Errors::FaradayServerError do |e|
           expect(e.to_s).to eq 'the server responded with status 500'
           expect(e.status_code).to eq 500
           expect(e.response['errors'].size).to eq 1

data/spec/graphlient/static_client_query_spec.rb

@@ -10,7 +10,7 @@ describe Graphlient::Client do
       ) do |client|
         client.http do |h|
           h.connection do |c|
-            c.use Faraday::Adapter::Rack, Sinatra::Application
+            c.adapter Faraday::Adapter::Rack, Sinatra::Application
           end
         end
       end

data/spec/graphlient/webmock_client_query_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe 'App' do
+  let(:url) { 'http://graph.biz/graphql' }
+  let(:client) { Graphlient::Client.new(url, schema_path: 'spec/support/fixtures/invoice_api.json') }
+  let(:query) do
+    <<~GRAPHQL
+      query{
+        invoice(id: 42) {
+          id
+          feeInCents
+        }
+      }
+    GRAPHQL
+  end
+  let(:json_response) do
+    {
+      'data' => {
+        'invoice' => {
+          'id' => '42',
+          'feeInCents' => 2000
+        }
+      }
+    }.to_json
+  end
+
+  before do
+    stub_request(:post, url).to_return(
+      status: 200,
+      body: json_response
+    )
+  end
+
+  it 'returns invoice fees' do
+    response = client.query(query)
+    expect(response.data).to be_truthy
+    expect(response.data.invoice.id).to eq('42')
+    expect(response.data.invoice.fee_in_cents).to eq(2000)
+  end
+end

data/spec/support/context/dummy_client.rb

@@ -18,7 +18,7 @@ RSpec.shared_context 'Dummy Client', shared_context: :metadata do
     Graphlient::Client.new(endpoint, headers: headers) do |client|
       client.http do |h|
         h.connection do |c|
-          c.use Faraday::Adapter::Rack, app
+          c.adapter Faraday::Adapter::Rack, app
         end
       end
     end