graphlient 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab92f3273bda224b78e022567186f00e9865d746ecb9de61d6ae392e480bc67d
-  data.tar.gz: 4e56127d81400beb61d1b9f502b63b3a712aa976d723dba524cbb6e579a7711b
+  metadata.gz: '08b4986ba4bf7847c4b14edf75bd14a43726a0f642b4611653ad32e526b51d00'
+  data.tar.gz: e4cfa8a24ea6cf149920a5c4a7068dea0abb0af1c0fce9592ccee3945ed5d794
 SHA512:
-  metadata.gz: 0480cf615f51cd10d7c74efe03b0a291870027373cd9b4d5d3ee55b778ec4494379177823e1864f7d5c77da7c71eaead5a9870127a0976c9ba5ff0e84bbe9877
-  data.tar.gz: 73202625813b08c871393e7656412a2439caf4454e8d021c00fcd24e06cca47328bee530571e013e0e69fba217cbc284fa187ae0661f3e495eeb65e14995f6b4
+  metadata.gz: 6b98ef7953ca9d6aa06639bbac461acce395e473aa87ccb8764b389107e7932e96488e2b8c37bb8fae7c4c60c25c634c340a24ebb8cd097f31f0b7856f0d7cdd
+  data.tar.gz: 583dd907e0a4d04a2f0c885c9403126453956605ad0d05da495d94f34684411435b28a4dcc25a28f2205a08442c21aa239ecd74866ee55ff8f6cb55b568734ad

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-### 0.3.8 (Next)
+### 0.5.0 (Next)
+
+### 0.4.0
+* [#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).
 * Your contribution here.
 
 ### 0.3.7 (14/11/2019)

data/README.md

@@ -15,12 +15,16 @@ 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
   }
 )
 ```
@@ -127,6 +131,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 +340,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

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

@@ -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.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/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/version.rb

@@ -1,3 +1,3 @@
 module Graphlient
-  VERSION = '0.3.7'.freeze
+  VERSION = '0.4.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,17 @@ 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_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_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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphlient
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Ashkan Nasseri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -88,8 +88,10 @@ files:
 - lib/graphlient/errors/execution_error.rb
 - lib/graphlient/errors/faraday_server_error.rb
 - lib/graphlient/errors/graphql_error.rb
+- lib/graphlient/errors/http_options_error.rb
 - lib/graphlient/errors/http_server_error.rb
 - lib/graphlient/errors/server_error.rb
+- lib/graphlient/errors/timeout_error.rb
 - lib/graphlient/extensions.rb
 - lib/graphlient/extensions/query.rb
 - lib/graphlient/query.rb
@@ -137,7 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.6
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A friendlier Ruby client for consuming GraphQL-based APIs.