graphlient 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b777ec75d94d228faa748cadb28c1687b16a377892138a9fc8d1048773b8853
-  data.tar.gz: a3bc9f948ffa5c4fe6368282834b7cd4e7addc00b7d1c90ced575ce41e8a8b3a
+  metadata.gz: aa3b9416b7374b0c3881224177f2a5646432e27ce9fcfdb2454b31ba318e231a
+  data.tar.gz: 6ca64471c0129dc021248fa309ed187bde0c9f9e58cf07a98d9072768e5446fe
 SHA512:
-  metadata.gz: fc0080c0fab50ac5ecee6815fb24e6b216cba32558d010ebd3d9661581b55f3b3fca8b70e11f0e61f96eb471931645c12b3a3b8c2361909da31a15c650ab6bcb
-  data.tar.gz: feb39198706b8b9650da8f6f35f080744df668420d948f2b7d69d84dd3b812301542d5735d1a69f77d865706e5853703861fe440a1ab47ea2cfef3b91712f794
+  metadata.gz: f035b28bfd747c72574b124cd5130e92798ac6b14d9000b73c6ce25357489f23ded22ca11dd74cc777c96dfeada948f86a9dd3b754838abf230cf82849e8f893
+  data.tar.gz: e6fd794359759c72051ddd7114fbe85c1110d0b743f55cd521cdcbb56fc9e6cecd4a70b6a6383f76d5304fd542d889e965d28738394995282768794059067b6c

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/danger.yml

@@ -5,6 +5,8 @@ on: pull_request
 jobs:
   danger:
     runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/Gemfile.danger
     steps:
     - uses: actions/checkout@v3
       with:

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### (Next)
+* Your contribution here.
+
+### 0.7.0 (2022/10/11)
+* [#98](https://github.com/ashkan18/graphlient/pull/98): Bring back danger checks and improve them - [@ashkan18](https://github.com/ashkan18).
+* [#94](https://github.com/ashkan18/graphlient/pull/94): Enabled fragments - [@rellampec](https://github.com/rellampec).
+* [#95](https://github.com/ashkan18/graphlient/pull/95): Upgrade faraday dependency to version 2 - [@kirillkaiumov](https://github.com/kirillkaiumov).
+
 ### 0.6.0 (2022/06/11)
 
 * [#87](https://github.com/ashkan18/graphlient/pull/87): Raised `ExecutionError` with partial error response - [@QQism](https://github.com/QQism).

data/Dangerfile

@@ -1 +1,24 @@
-changelog.check
+# frozen_string_literal: true
+
+# --------------------------------------------------------------------------------------------------------------------
+# Has any changes happened inside the actual library code?
+# --------------------------------------------------------------------------------------------------------------------
+has_app_changes = !git.modified_files.grep(/lib/).empty?
+has_spec_changes = !git.modified_files.grep(/spec/).empty?
+
+# --------------------------------------------------------------------------------------------------------------------
+# You've made changes to lib, but didn't write any tests?
+# --------------------------------------------------------------------------------------------------------------------
+warn("There're library changes, but not tests. That's OK as long as you're refactoring existing code.", sticky: false) if has_app_changes && !has_spec_changes
+
+# --------------------------------------------------------------------------------------------------------------------
+# You've made changes to specs, but no library code has changed?
+# --------------------------------------------------------------------------------------------------------------------
+if !has_app_changes && has_spec_changes
+  message('We really appreciate pull requests that demonstrate issues, even without a fix. That said, the next step is to try and fix the failing tests!', sticky: false)
+end
+
+# --------------------------------------------------------------------------------------------------------------------
+# Have you updated CHANGELOG.md?
+# --------------------------------------------------------------------------------------------------------------------
+changelog.check!

data/Gemfile

@@ -10,11 +10,11 @@ end
 
 group :development do
   gem 'byebug', platform: :ruby
-  gem 'danger-changelog', '~> 0.2.1'
   gem 'rubocop', '0.56.0'
 end
 
 group :test do
+  gem 'faraday-rack', '~> 2.0'
   gem 'graphql', '~> 1.9'
   gem 'graphql-errors'
   gem 'rack-parser'

data/Gemfile.danger

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'danger-changelog', '~> 0.6.0'
+end

data/README.md

@@ -5,6 +5,21 @@
 
 A friendlier Ruby client for consuming GraphQL-based APIs. Built on top of your usual [graphql-client](https://github.com/github/graphql-client), but with better defaults, more consistent error handling, and using the [faraday](https://github.com/lostisland/faraday) HTTP client.
 
+# Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Schema storing and loading on disk](#schema-storing-and-loading-on-disk)
+  - [Error Handling](#error-handling)
+  - [Executing Parameterized Queries and Mutations](#executing-parameterized-queries-and-mutations)
+  - [Parse and Execute Queries Separately](#parse-and-execute-queries-separately)
+  - [Dynamic vs. Static Queries](#dynamic-vs-static-queries)
+  - [Generate Queries with Graphlient::Query](#generate-queries-with-graphlientquery)
+  - [Create API Client Classes with Graphlient::Extension::Query](#create-api-client-classes-with-graphlientextensionquery)
+  - [Swapping the HTTP Stack](#swapping-the-http-stack)
+  - [Testing with Graphlient and RSpec](#testing-with-graphlient-and-rspec)
+-  [License](#license)
+
 ## Installation
 
 Add the following line to your Gemfile.
@@ -300,6 +315,62 @@ query.to_s
 # "\nquery {\n  invoice(id: 10){\n    line_items\n    }\n  }\n"
 ```
 
+### Use of Fragments
+
+[Fragments](https://github.com/github/graphql-client#defining-queries) should be referred by constant:
+
+```ruby
+module Fragments
+  Invoice = client.parse <<~'GRAPHQL'
+    fragment on Invoice {
+      id
+      feeInCents
+    }
+  GRAPHQL
+end
+```
+
+`Graphlient` offers the syntax below to refer to the original constant:
+  * Triple underscore `___` to refer to the fragment
+  * Double underscore `__` for namespace separator
+
+In this example, `Fragments::Invoice` would be referred as follows:
+
+```ruby
+invoice_query = client.parse do
+  query do
+    invoice(id: 10) do
+      id
+      ___Graphlient__InvoiceFragment
+    end
+  end
+end
+```
+
+The wrapped response only allows access to fields that have been explicitly asked for.
+In this example, while `id` has been referenced directly in the main query, `feeInCents` has been spread via fragment and trying to access it in the original wrapped response will throw [`GraphQL::Client::ImplicitlyFetchedFieldError`](https://github.com/github/graphql-client/blob/master/guides/implicitly-fetched-field-error.md) (to prevent data leaks between components).
+
+```ruby
+response = client.execute(invoice_query)
+result = response.data.invoice
+result.to_h
+# {"id" => 10, "feeInCents"=> 20000}
+result.id
+# 10
+result.fee_in_cents
+# raises GraphQL::Client::ImplicitlyFetchedFieldError
+```
+
+`feeInCents` cannot be fetched directly from the main query, but from the fragment as shown below:
+
+```ruby
+invoice = Fragments::Invoice.new(result)
+invoice.id
+# 10
+invoice.fee_in_cents
+# 20000
+```
+
 ### 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.

data/graphlient.gemspec

@@ -14,7 +14,6 @@ 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', '>= 1.0'
-  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'faraday', '~> 2.0'
   s.add_dependency 'graphql-client'
 end

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

@@ -1,5 +1,4 @@
 require 'faraday'
-require 'faraday_middleware'
 
 module Graphlient
   module Adapters

data/lib/graphlient/query.rb

@@ -9,13 +9,15 @@ module Graphlient
 
     ROOT_NODES = %w[query mutation subscription].freeze
 
+    FRAGMENT_DEFITION = /___(?<const>[A-Z][a-zA-Z0-9_]*(__[A-Z][a-zA-Z0-9_]*)*)/
+
     attr_accessor :query_str
 
     def initialize(&block)
       @indents = 0
       @query_str = ''
       @variables = []
-      instance_eval(&block)
+      evaluate(&block)
     end
 
     def method_missing(method_name, *args, &block)
@@ -39,7 +41,24 @@ module Graphlient
 
     private
 
+    def evaluate(&block)
+      @last_block = block || self
+      (@context ||= {})[@last_block] ||= @last_block.binding
+      instance_eval(&block)
+    end
+
+    def resolve_fragment_constant(value)
+      return nil unless (match = value.to_s.match(FRAGMENT_DEFITION))
+      raw_const = match[:const].gsub('__', '::')
+      @context[@last_block].eval(raw_const).tap do |const|
+        msg = "Expected constant #{raw_const} to be GraphQL::Client::FragmentDefinition. Given #{const.class}"
+        raise Graphlient::Errors::Error, msg unless const.is_a? GraphQL::Client::FragmentDefinition
+      end
+    end
+
     def append_node(node, args, arg_processor: nil, &block)
+      node = "...#{resolve_fragment_constant(node)}".to_sym if node.to_s.start_with?('___')
+
       # add field
       @query_str << "\n#{indent}#{node}"
       # add filter
@@ -49,7 +68,7 @@ module Graphlient
       if block_given?
         @indents += 1
         @query_str << '{'
-        instance_eval(&block)
+        evaluate(&block)
         @query_str << '}'
         @indents -= 1
       end

data/lib/graphlient/version.rb

@@ -1,3 +1,3 @@
 module Graphlient
-  VERSION = '0.6.0'.freeze
+  VERSION = '0.7.0'.freeze
 end

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

@@ -19,8 +19,8 @@ describe Graphlient::Adapters::HTTP::FaradayAdapter do
       expect(client.http.connection.builder.handlers).to eq(
         [
           Faraday::Response::RaiseError,
-          FaradayMiddleware::EncodeJson,
-          FaradayMiddleware::ParseJson
+          Faraday::Request::Json,
+          Faraday::Response::Json
         ]
       )
     end
@@ -65,7 +65,8 @@ describe Graphlient::Adapters::HTTP::FaradayAdapter do
     before do
       stub_request(:post, url).to_return(
         status: 200,
-        body: DummySchema.execute(GraphQL::Introspection::INTROSPECTION_QUERY).to_json
+        body: DummySchema.execute(GraphQL::Introspection::INTROSPECTION_QUERY).to_json,
+        headers: { 'Content-Type' => 'application/json' }
       )
     end
 
@@ -90,7 +91,6 @@ describe Graphlient::Adapters::HTTP::FaradayAdapter do
 
     specify do
       expected_error_message = "Connection refused - #{error_message}"
-
       expect { client.schema }.to raise_error(Graphlient::Errors::ConnectionFailedError, expected_error_message)
     end
   end

data/spec/graphlient/client_query_spec.rb

@@ -25,6 +25,43 @@ describe Graphlient::Client do
         invoice = response.data.invoice
         expect(invoice.id).to eq '10'
       end
+
+      context 'with fragment' do
+        let(:invoice_fragment) do
+          client.parse <<~'GRAPHQL'
+            fragment on Invoice {
+              id
+              feeInCents
+            }
+          GRAPHQL
+        end
+
+        let(:invoice_fragment_const) do
+          stub_const('Graphlient::InvoiceFragment', invoice_fragment)
+        end
+
+        let(:query) do
+          invoice_fragment_const
+          client.parse do
+            query do
+              invoice(id: 10) do
+                ___Graphlient__InvoiceFragment
+              end
+            end
+          end
+        end
+
+        it '#parse' do
+          expect(query).to be_a GraphQL::Client::OperationDefinition
+        end
+
+        it '#execute' do
+          response = client.execute(query)
+          invoice = response.data.invoice
+          fragment = invoice_fragment.new(invoice)
+          expect(fragment.id).to eq '10'
+        end
+      end
     end
 
     context 'parameterized query' do

data/spec/graphlient/client_schema_spec.rb

@@ -7,13 +7,23 @@ describe Graphlient::Client do
 
   describe '#schema' do
     before do
-      stub_request(:post, url)
-        .to_return(body: DummySchema.execute(GraphQL::Introspection::INTROSPECTION_QUERY).to_json)
+      stub_request(:post, url).to_return(
+        body: DummySchema.execute(GraphQL::Introspection::INTROSPECTION_QUERY).to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
     end
 
     context 'when server returns error' do
       before do
-        stub_request(:post, url).to_return(status: 500, body: { errors: [{ message: 'test message', extensions: { code: 'SOMETHING', timestamp: Time.now } }] }.to_json)
+        stub_request(:post, url).to_return(
+          status: 500,
+          body: {
+            errors: [
+              { message: 'test message', extensions: { code: 'SOMETHING', timestamp: Time.now } }
+            ]
+          }.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
       end
 
       it 'fails with an exception' do

data/spec/graphlient/schema_spec.rb

@@ -10,7 +10,10 @@ describe Graphlient::Schema do
     let!(:introspection_query_request) do
       stub_request(:post, url)
         .with(body: /query IntrospectionQuery/)
-        .to_return(body: DummySchema.execute(GraphQL::Introspection::INTROSPECTION_QUERY).to_json)
+        .to_return(
+          body: DummySchema.execute(GraphQL::Introspection::INTROSPECTION_QUERY).to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
     end
 
     context 'when schema path is not given' do

data/spec/graphlient/webmock_client_query_spec.rb

@@ -27,7 +27,8 @@ describe 'App' do
   before do
     stub_request(:post, url).to_return(
       status: 200,
-      body: json_response
+      body: json_response,
+      headers: { 'Content-Type' => 'application/json' }
     )
   end
 

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'byebug' if RUBY_ENGINE != 'jruby'
 require 'rack/test'
 require 'webmock/rspec'
 require 'vcr'
+require 'faraday/rack'
 
 Dir[File.join(File.dirname(__FILE__), 'support', '**/*.rb')].each do |file|
   require file

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: graphlient
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ashkan Nasseri
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-11 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: graphql-client
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +44,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/ci.yml"
 - ".github/workflows/danger.yml"
 - ".github/workflows/rubocop.yml"
@@ -69,6 +57,7 @@ files:
 - CONTRIBUTING.md
 - Dangerfile
 - Gemfile
+- Gemfile.danger
 - LICENSE
 - README.md
 - RELEASING.md
@@ -142,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A friendlier Ruby client for consuming GraphQL-based APIs.