graphlient 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74aeacc568a790dea8eb57f285af9d0d4399e32c
-  data.tar.gz: 92634c7c7715b0e79d5b947180de4a8ace1f6811
+  metadata.gz: 70d3714ce3a596ab5742337e24610d2af3b81f36
+  data.tar.gz: 9098b09df8009c12031995bf79451a66d4969486
 SHA512:
-  metadata.gz: 9d98e5fe0835525a64865f9fffb75608dd4ee435bd8f83dfc1d9a56e47a789884bf868b56f54c98fe581a0017538b64c487cb4b93fd3cdb684f884b5ebc8af78
-  data.tar.gz: 8d1cf6ad272318317058e7b704c4f38a896293a3729ebb7b32e3874d4d5b76d64bfba15a504b03a1d6c380b4d07a7dd721267edc08e15a9bdc146242e0fe52c0
+  metadata.gz: 2b3eb5c108cb8cc1a32958e9bf8524957a848ac25829aaa3f00b09ac69ca2faca56ffd35d8e533990d6e868f0f4d39b8bcbd3849c8e23a8d3270d18cbc2ff268
+  data.tar.gz: 782ae549c2377b76b9f3452e8086124407bd2228a6fcbe1fce2c54a20ba4663f2155d2349a139c9f2725990ce7c6a6d5ae883b3780fe12a1df74794c654a519f

data/.gitignore

@@ -9,7 +9,8 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
-
+.byebug_history
+.DS_Store
 # Used by dotenv library to load environment variables.
 # .env
 

data/.rubocop_todo.yml

@@ -1,47 +1,62 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-10-04 21:00:57 -0400 using RuboCop version 0.47.1.
+# on 2017-10-19 15:16:01 -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: 4
+# Offense count: 11
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 38
+  Max: 136
 
-# Offense count: 7
+# Offense count: 17
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 143
+  Max: 177
 
-# Offense count: 6
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 12
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'spec/graphlient/static_client_query_spec.rb'
+
+# Offense count: 5
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
+    - 'lib/graphlient/adapters/faraday_adapter.rb'
     - 'lib/graphlient/client.rb'
-    - 'lib/graphlient/config.rb'
-    - 'lib/graphlient/errors/http.rb'
+    - 'lib/graphlient/errors/error.rb'
     - 'lib/graphlient/extensions/query.rb'
     - 'lib/graphlient/query.rb'
 
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: line_count_dependent, lambda, literal
+Style/Lambda:
+  Exclude:
+    - 'spec/support/mutations/create_invoice_mutation.rb'
+    - 'spec/support/queries/query.rb'
+
 # Offense count: 2
 Style/MethodMissing:
   Exclude:
     - 'lib/graphlient/extensions/query.rb'
     - 'lib/graphlient/query.rb'
 
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: module_function, extend_self
-Style/ModuleFunction:
-  Exclude:
-    - 'lib/graphlient/config.rb'
-
-# Offense count: 1
+# Offense count: 2
 Style/MultilineBlockChain:
   Exclude:
-    - 'spec/graphlient/client_spec.rb'
+    - 'spec/graphlient/client_query_spec.rb'
+    - 'spec/graphlient/client_schema_spec.rb'

data/.travis.yml

@@ -3,5 +3,11 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.3.0
-  - 2.4.1
+  - 2.3.1
+  - 2.4.1
+
+matrix:
+  include:
+    - rvm: 2.3.1
+      script:
+        - bundle exec danger

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 0.0.6 (10/20/2017)
+
+* [#14](https://github.com/ashkan18/graphlient/pull/14): Switch to `graphql-client` for network calls and schema validation - [@ashkan18](https://github.com/ashkan18).
+* [#17](https://github.com/ashkan18/graphlient/pull/17): Specialize server errors as `Graphlient::Errors::Server` - [@dblock](https://github.com/dblock).
+* [#13](https://github.com/ashkan18/graphlient/pull/13): Support named queries and make sure, this is braking change where we no longer support queries that don't start with `query` - [@ashkan18](https://github.com/ashkan18).
+* [#21](https://github.com/ashkan18/graphlient/pull/21): Added danger, PR linter - [@dblock](https://github.com/dblock).
+* [#17](https://github.com/ashkan18/graphlient/pull/17): Enable customizing of Faraday middleware - [@dblock](https://github.com/dblock).
+* [#19](https://github.com/ashkan18/graphlient/pull/19): Expose `client.schema` - [@dblock](https://github.com/dblock).
+* [#20](https://github.com/ashkan18/graphlient/pull/20): Added support for parameterized queries and mutations - [@dblock](https://github.com/dblock).
+* [#25](https://github.com/ashkan18/graphlient/pull/25): Added `client.parse` and `client.execute` to parse and execute queries separately - [@dblock](https://github.com/dblock).
+
 ### 0.0.5 (10/5/2017)
 
 * [#11](https://github.com/ashkan18/graphlient/pull/11): Fixed query argument types - [@ashkan18](https://github.com/ashkan18).

data/Dangerfile

@@ -0,0 +1 @@
+changelog.check

data/Gemfile

@@ -6,11 +6,16 @@ gem 'rake'
 
 group :development do
   gem 'byebug'
+  gem 'danger-changelog', '~> 0.2.1'
   gem 'rubocop', '~> 0.47.1', require: false
 end
 
 group :test do
+  gem 'graphql'
+  gem 'rack-parser'
+  gem 'rack-test'
   gem 'rspec'
   gem 'rspec-mocks'
+  gem 'sinatra'
   gem 'webmock'
 end

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 Ruby Client for consuming GraphQL-based APIs.
+A much friendlier Ruby client for consuming GraphQL-based APIs, without all the messy strings. Built on top of your usual [graphql-client](https://github.com/github/graphql-client).
 
 ## Installation
 
@@ -15,11 +15,7 @@ gem 'graphlient'
 
 ## Usage
 
-There are 3 different ways to use this library.
-
-### Graphlient::Client
-
-Create a new instance of `Graphlient::Client` and pass the query into a block.
+Create a new instance of `Graphlient::Client` with a URL and optional headers.
 
 ```ruby
 client = Graphlient::Client.new('https://test-graphql.biz/graphql',
@@ -27,39 +23,172 @@ client = Graphlient::Client.new('https://test-graphql.biz/graphql',
     'Authorization' => 'Bearer 123'
   }
 )
+```
+
+The schema is available automatically via `.schema`.
+
+```ruby
+client.schema # GraphQL::Schema
+```
 
+Make queries with `query`, which takes a block for the query definition.
+
+```ruby
 response = client.query do
-  invoice(id: 10) do
+  query do
+    invoice(id: 10) do
+      id
+      total
+      line_items do
+        price
+        item_type
+      end
+    end
+  end
+end
+```
+
+This will call the endpoint setup in the configuration with `POST`, the `Authorization` header and `query` as follows.
+
+```graphql
+query {
+  invoice(id: 10) {
     id
     total
-    line_items do
+    line_items {
       price
       item_type
+    }
+  }
+}
+```
+
+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
+response.data.invoice.line_items.first.price
+```
+
+You can also execute mutations the same way.
+
+```ruby
+response = client.query do
+  mutation do
+    createInvoice(input: { fee_in_cents: 12_345 }) do
+      id
+      fee_in_cents
     end
   end
 end
 ```
 
-This will call the endpoint setup in the configuration with `POST`, the `Authorization` header and `query` as
+The successful response contains data in `response.data`. The following example returns the newly created invoice's ID.
 
-```graphql
-invoice(id: 10) {
-  id
-  total
-  line_items {
-    price
-    item_type
-  }
-}
+```ruby
+response.data.create_invoice.first.id
+```
+
+### Executing Parameterized Queries and Mutations
+
+Graphlient can execute parameterized queries and mutations by providing variables as query parameters.
+
+The following query accepts an array of IDs.
+
+```ruby
+client.query(ids: [42]) do
+  query(:$ids => :'[Int]') do
+    invoices(ids: :$ids) do
+      id
+      fee_in_cents
+    end
+  end
+end
 ```
 
-A successful response is a JSON object.
+The following mutation accepts a custom type that requires `fee_in_cents`.
 
-On failure the client raises `Graphlient::Errors::HTTP` which contains the `response` object.
+```ruby
+client.query(input: { fee_in_cents: 12_345 }) do
+  mutation(:$input => :createInvoiceInput!) do
+    createInvoice(input: :$input) do
+      id
+      fee_in_cents
+    end
+  end
+end
+```
 
-### Use Graphlient::Query directly
+### Parse and Execute Queries Separately
+
+You can `parse` and `execute` queries separately with optional variables. This is highly recommended as parsing a query and validating a query on every request adds performance overhead. Parsing queries early allows validation errors to be discovered before request time and avoids many potential security issues.
 
-You can directly use `Graphlient::Query` to generate GraphQL queries. Example:
+
+```ruby
+# parse a query, returns a GraphQL::Client::OperationDefinition
+query = client.parse do
+  query(:$ids => :'[Int]') do
+    invoices(ids: :$ids) do
+      id
+      fee_in_cents
+    end
+  end
+end
+
+# execute a query, returns a GraphQL::Client::Response
+client.execute query, ids: [42]
+```
+
+### Dynamic vs. Static Queries
+
+Graphlient uses [graphql-client](https://github.com/github/graphql-client), which [recommends](https://github.com/github/graphql-client/blob/master/guides/dynamic-query-error.md) building queries as static module members along with dynamic variables during execution. This can be accomplished with graphlient the same way.
+
+Create a new instance of `Graphlient::Client` with a URL and optional headers.
+
+```ruby
+module SWAPI
+  Client = Graphlient::Client.new('https://test-graphql.biz/graphql',
+    headers: {
+      'Authorization' => 'Bearer 123'
+    },
+    allow_dynamic_queries: false
+  )
+end
+```
+
+The schema is available automatically via `.schema`.
+
+```ruby
+SWAPI::Client.schema # GraphQL::Schema
+```
+
+Define a query.
+
+```ruby
+module SWAPI
+  InvoiceQuery = Client.parse do
+    query(:$id => :Int) do
+      invoice(id: :$id) do
+        id
+        fee_in_cents
+      end
+    end
+  end
+end
+```
+
+Execute the query.
+
+```ruby
+response = SWAPI::Client.execute(SWAPI::InvoiceQuery, id: 42)
+```
+
+Note that in the example above the client is created with `allow_dynamic_queries: false` (only allow static queries), while graphlient defaults to `allow_dynamic_queries: true` (allow dynamic queries). This option is marked deprecated, but we're proposing to remove it and default it to `true` in [graphql-client#128](https://github.com/github/graphql-client/issues/128).
+
+### Generate Queries with Graphlient::Query
+
+You can directly use `Graphlient::Query` to generate raw GraphQL queries.
 
 ```ruby
 query = Graphlient::Query.new do
@@ -71,24 +200,69 @@ query = Graphlient::Query.new do
 end
 
 query.to_s
-# "\nquery{\n  invoice(id: 10){\n    line_items\n    }\n  }\n"
+# "\nquery {\n  invoice(id: 10){\n    line_items\n    }\n  }\n"
 ```
 
-### Use Graphlient::Extension::Query
+### Create API Client Classes with Graphlient::Extension::Query
 
 You can include `Graphlient::Extensions::Query` in your class. This will add a new `method_missing` method to your context which will be used to generate GraphQL queries.
 
 ```ruby
 include Graphlient::Extensions::Query
 
-query = invoice(id: 10) do
-  line_items
+query = query do
+  invoice(id: 10) do
+    line_items
+  end
 end
 
 query.to_s
 # "\nquery{\n  invoice(id: 10){\n    line_items\n    }\n  }\n"
 ```
 
+### Testing with Graphlient and RSpec
+
+Use Graphlient inside your RSpec tests in a Rails application or with `Rack::Test`, no more messy HTTP POSTs.
+
+```ruby
+require 'spec_helper'
+
+describe App do
+  include Rack::Test::Methods
+
+  def app
+    # ...
+  end
+
+  let(:client) 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
+        end
+      end
+    end
+  end
+
+  context 'an invoice' do
+    let(:result) do
+      client.query do
+        query do
+          invoice(id: 10) do
+            id
+          end
+        end
+      end
+    end
+
+    it 'can be retrieved' do
+      expect(result.data.invoice.id).to eq 10
+    end
+  end
+end
+```
+
 ## License
 
 MIT License, see [LICENSE](LICENSE)
+

data/RELEASING.md

@@ -24,7 +24,7 @@ Remove the line with "Your contribution here.", since there will be no more cont
 Commit your changes.
 
 ```
-git add README.md CHANGELOG.md
+git add CHANGELOG.md
 git commit -m "Preparing for release, 0.2.2."
 git push origin master
 ```

data/Rakefile

@@ -12,4 +12,4 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i(rubocop spec)