gqli 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 546f032ddd8089b8c2709b097dfcf42eedbfaa244fa487aed9d35240530c5a22
-  data.tar.gz: acbdf1e8755552a48a08085764dae8b53877a95e13e9cef1b875d58c3a5a4912
+  metadata.gz: 9f9f3f5a26b24da043c5cf373457ad78ac32ccf2171db0aca3aa2152e594fa76
+  data.tar.gz: 0ada10622897729a6be228f68dc1af8095eeb22609d364b1a853f816d10796b0
 SHA512:
-  metadata.gz: 9220a899f2fa1acbcdef297b7dc86a3fd6480017e7dc004fe5f3ead83c10c4f1087eb9b37b3d74e9a7b89592191026ba22baa4f9740eb56c6293ec844f367788
-  data.tar.gz: 31ab9c1aeaa34d692bc5f0fd85066d58cb6f6f4625fa8b6b3800d73a1dee0b17fe03acdecee9551d2cc4bf19c4d9627d88ca9954aa791a3733ee3aacdaf090db
+  metadata.gz: 2e36d05568c87653075775dd6b75b90e869f00d62bb945b9f9c33fd41706753a39cd2991df346e0c50a02abf850ec6c8ad4974fdca623671bbb4e90d3555fe56
+  data.tar.gz: 89cfb285c28747cfd19274e2a13aed0e8d661e4a2f946e10e4a15b10e4c98c5e92708d0179fe698cfb4a49e827e409ac05c3cfa26cbf585e338c79fc59cfc5d0

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## v0.6.0
+* Add Subscription DSL support. (by @hschne) [#5](https://github.com/contentful-labs/gqli.rb/pull/5)
+* Add aliases support.
+* Add default client constructors for Contentful and Github.
+
 ## v0.5.0
 ### Added
 * Add Enum support.

data/README.md

@@ -29,7 +29,7 @@ gem 'gqli'
 
 ### Creating a GraphQL Client
 
-For the examples throughout this README, we'll be using the Contentful and Github GraphQL APIs.
+For the examples throughout this README, we'll be using the Contentful and Github GraphQL APIs, for which we have factory methods.
 Therefore, here's the initialization code required for both of them:
 
 ```ruby
@@ -38,16 +38,26 @@ require 'gqli'
 # Creating a Contentful GraphQL Client
 SPACE_ID = 'cfexampleapi'
 CF_ACCESS_TOKEN = 'b4c0n73n7fu1'
-CONTENTFUL_GQL = GQLi::Client.new(
-  "https://graphql.contentful.com/content/v1/spaces/#{SPACE_ID}",
-  headers: { "Authorization" => "Bearer #{CF_ACCESS_TOKEN}" }
-)
+CONTENTFUL_GQL = GQLi::Contentful.create(SPACE_ID, CF_ACCESS_TOKEN)
 
 # Creating a Github GraphQL Client
 GITHUB_ACCESS_TOKEN = ENV['GITHUB_TOKEN']
-GITHUB_GQL = GQLi::Client.new(
-  "https://api.github.com/graphql",
-  headers: { "Authorization" => "Bearer #{GITHUB_ACCESS_TOKEN}" }
+GITHUB_GQL = GQLi::Github.create(GITHUB_ACCESS_TOKEN)
+```
+
+*Note*: Please feel free to contribute factories for your favorite GraphQL services.
+
+For creating a custom GraphQL client:
+
+```ruby
+require 'gqli'
+
+# Create a custom client
+GQL_CLIENT = GQLi::Client.new(
+  "https://graphql.yourservice.com",
+  headers: {
+    "Authorization" => "Bearer AUTH_TOKEN"
+  }
 )
 ```
 
@@ -347,6 +357,37 @@ query {
 }
 ```
 
+### Aliases
+
+There may be times where it is useful to have parts of the query aliased, for example, when querying for `pinned` and `unpinned` articles for a news site.
+
+This can be accomplished as follows:
+
+```ruby
+ArticleFragment = GQLi::DSL.fragment('ArticleFragment', 'ArticleCollection') {
+  items {
+    title
+    description
+    heroImage {
+      url
+    }
+  }
+}
+
+query = GQLi::DSL.query {
+  __node('pinned: articleCollection', where: {
+    sys: { id_in: ['articleID'] }
+  }) {
+    ___ ArticleFragment
+  }
+  __node('unpinned: articleCollection', where: {
+    sys: { id_not_in: ['articleID'] }
+  }) {
+    ___ ArticleFragment
+  }
+}
+```
+
 ## Yet to be implemented
 
 * Mutation queries

data/lib/gqli.rb

@@ -4,3 +4,4 @@ require_relative './gqli/dsl'
 require_relative './gqli/client'
 require_relative './gqli/introspection'
 require_relative './gqli/version'
+require_relative './gqli/clients'

data/lib/gqli/clients.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative './clients/contentful'
+require_relative './clients/github'

data/lib/gqli/clients/contentful.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module GQLi
+  # Module for creating a Contentful GraphQL client
+  module Contentful
+    # Creates a Contentful GraphQL client
+    def self.create(space, access_token, environment: nil, validate_query: true)
+      api_url = "https://graphql.contentful.com/content/v1/spaces/#{space}"
+      api_url += "/environments/#{environment}" unless environment.nil?
+
+      GQLi::Client.new(
+        api_url,
+        headers: {
+          'Authorization' => "Bearer #{access_token}"
+        },
+        validate_query: validate_query
+      )
+    end
+  end
+end

data/lib/gqli/clients/github.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GQLi
+  # Module for creating a Github GraphQL client
+  module Github
+    # Creates a Github GraphQL client
+    def self.create(access_token, validate_query: true)
+      GQLi::Client.new(
+        'https://api.github.com/graphql',
+        headers: {
+          'Authorization' => "Bearer #{access_token}"
+        },
+        validate_query: validate_query
+      )
+    end
+  end
+end

data/lib/gqli/dsl.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative './query'
+require_relative './subscription'
 require_relative './fragment'
 require_relative './enum_value'
 
@@ -14,6 +15,13 @@ module GQLi
       Query.new(name, &block)
     end
 
+    # Creates a Subscription object
+    #
+    # Can be used at a class level
+    def self.subscription(name = nil, &block)
+      Subscription.new(name, &block)
+    end
+
     # Creates a Fragment object
     #
     # Can be used at a class level
@@ -35,6 +43,13 @@ module GQLi
       Query.new(name, &block)
     end
 
+    # Creates a Subscription object
+    #
+    # Can be used at a class level
+    def subscription(name = nil, &block)
+      Subscription.new(name, &block)
+    end
+
     # Creates a Fragment object
     #
     # Can be used at an instance level

data/lib/gqli/subscription.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module GQLi
+  # Query node
+  class Subscription < Base
+    # Serializes to a GraphQL string
+    def to_gql
+      result = <<~GQL
+        subscription #{__name ? __name + ' ' : ''}{
+        #{__nodes.map(&:to_gql).join("\n")}
+        }
+      GQL
+
+      result.lstrip
+    end
+
+    # Delegates itself to the client to be executed
+    def __execute(client)
+      client.execute(self)
+    end
+
+    # Serializes to a GraphQL string
+    def to_s
+      to_gql
+    end
+  end
+end

data/lib/gqli/validation.rb

@@ -39,6 +39,12 @@ module GQLi
 
     private
 
+    def remove_alias(name)
+      return name unless name.include?(':')
+
+      name.split(':')[1].strip
+    end
+
     def types
       schema.types
     end
@@ -48,13 +54,15 @@ module GQLi
 
       return valid_match_node?(parent_type, node) if node.__name.start_with?('... on')
 
-      node_type = parent_type.fetch('fields', []).find { |f| f.name == node.__name }
-      fail "Node type not found for '#{node.__name}'" if node_type.nil?
+      node_name = remove_alias(node.__name)
+
+      node_type = parent_type.fetch('fields', []).find { |f| f.name == node_name }
+      fail "Node type not found for '#{node_name}'" if node_type.nil?
 
       validate_params(node_type, node)
 
       resolved_node_type = type_for(node_type)
-      fail "Node type not found for '#{node.__name}'" if resolved_node_type.nil?
+      fail "Node type not found for '#{node_name}'" if resolved_node_type.nil?
 
       validate_nesting_node(resolved_node_type, node)
 
@@ -67,7 +75,7 @@ module GQLi
     end
 
     def validate_directives(node)
-      return unless node.__params.size == 1
+      return unless node.__params.size >= 1
       node.__params.first.tap do |k, v|
         break unless k.to_s.start_with?('@')
 

data/lib/gqli/version.rb

@@ -3,5 +3,5 @@
 # GraphQL Client and DSL library
 module GQLi
   # Gem version
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/lib/gqli/client_spec.rb

@@ -1,24 +1,20 @@
 require 'spec_helper'
 
 describe GQLi::Client do
+  let(:space_id) { 'cfexampleapi' }
+  let(:token) { 'b4c0n73n7fu1' }
+
   let(:client) do
     vcr('client') {
-      space_id = 'cfexampleapi'
-      token = 'b4c0n73n7fu1'
-      GQLi::Client.new(
-        "https://graphql.contentful.com/content/v1/spaces/#{space_id}",
-        headers: { "Authorization" => "Bearer #{token}" }
-      )
+      GQLi::Contentful.create(space_id, token)
     }
   end
 
   let(:client_no_validations) do
     vcr('client') {
-      space_id = 'cfexampleapi'
-      token = 'b4c0n73n7fu1'
-      GQLi::Client.new(
-        "https://graphql.contentful.com/content/v1/spaces/#{space_id}",
-        headers: { "Authorization" => "Bearer #{token}" },
+      GQLi::Contentful.create(
+        space_id,
+        token,
         validate_query: false
       )
     }
@@ -26,6 +22,18 @@ describe GQLi::Client do
 
   let(:dsl) { GQLi::DSL }
 
+  describe 'default clients' do
+    it 'contentful client' do
+      expect(client).to be_a(GQLi::Client)
+    end
+
+    it 'github client' do
+      client = GQLi::Github.create('foobar', validate_query: false)
+
+      expect(client).to be_a(GQLi::Client)
+    end
+  end
+
   describe 'query can call the client to execute' do
     subject { client }
 

data/spec/lib/gqli/dsl_spec.rb

@@ -37,6 +37,35 @@ describe GQLi::DSL do
       end
     end
 
+    describe '::subscription' do
+      it 'can create a subscription without name' do
+        subscription = subject.subscription {
+          someField
+        }
+
+        expect(subscription).to be_a GQLi::Subscription
+        expect(subscription.to_gql).to eq <<~GRAPHQL
+          subscription {
+            someField
+          }
+        GRAPHQL
+        expect(subscription.to_gql).to eq subscription.to_s
+      end
+
+      it 'can create a subscription with a name' do
+        subscription = subject.subscription('FooBar') {
+          someOtherField
+        }
+
+        expect(subscription).to be_a GQLi::Subscription
+        expect(subscription.to_gql).to eq <<~GRAPHQL
+          subscription FooBar {
+            someOtherField
+          }
+        GRAPHQL
+      end
+    end
+
     describe '::fragment' do
       it 'can create a fragment' do
         fragment = subject.fragment('FooBar', 'Foo') {
@@ -93,6 +122,39 @@ describe GQLi::DSL do
       end
     end
 
+
+    describe '#subscription does the same as ::subscription' do
+
+      subject { MockGQLInterface.new }
+
+      it 'can create a subscription without name' do
+        subscription = subject.subscription {
+          someField
+        }
+
+        expect(subscription).to be_a GQLi::Subscription
+        expect(subscription.to_gql).to eq <<~GRAPHQL
+          subscription {
+            someField
+          }
+        GRAPHQL
+        expect(subscription.to_gql).to eq subscription.to_s
+      end
+
+      it 'can create a subscription with a name' do
+        subscription = subject.subscription('FooBar') {
+          someOtherField
+        }
+
+        expect(subscription).to be_a GQLi::Subscription
+        expect(subscription.to_gql).to eq <<~GRAPHQL
+          subscription FooBar {
+            someOtherField
+          }
+        GRAPHQL
+      end
+    end
+
     describe '#fragment does the same as ::fragment' do
       it 'can create a fragment' do
         fragment = subject.fragment('FooBar', 'Foo') {
@@ -135,10 +197,44 @@ describe GQLi::DSL do
       GRAPHQL
     end
 
+    it 'nodes can have aliases' do
+      query = subject.query {
+        __node('pinned: catCollection', where: {
+          sys: { id_in: 'nyancat' }
+        }) {
+          items {
+            name
+          }
+        }
+        __node('unpinned: catCollection', where: {
+          sys: { id_not_in: 'nyancat' }
+        }, limit: 4) {
+          items {
+            name
+          }
+        }
+      }
+
+      expect(query.to_gql).to eq <<~GRAPHQL
+        query {
+          pinned: catCollection(where: {sys: {id_in: "nyancat"}}) {
+            items {
+              name
+            }
+          }
+          unpinned: catCollection(where: {sys: {id_not_in: "nyancat"}}, limit: 4) {
+            items {
+              name
+            }
+          }
+        }
+      GRAPHQL
+    end
+
     it 'nodes can have directives' do
       query = subject.query {
-        someNode(:@include => {if: true})
-        otherNode(:@skip => {if: false})
+        someNode(:@include => { if: true })
+        otherNode(:@skip => { if: false })
       }
 
       expect(query.to_gql).to eq <<~GRAPHQL

data/spec/lib/gqli/introspection_spec.rb

@@ -6,10 +6,7 @@ describe GQLi::Introspection do
     vcr('client') {
       space_id = 'cfexampleapi'
       token = 'b4c0n73n7fu1'
-      GQLi::Client.new(
-        "https://graphql.contentful.com/content/v1/spaces/#{space_id}",
-        headers: { "Authorization" => "Bearer #{token}" }
-      )
+      GQLi::Contentful.create(space_id, token)
     }
   end
 
@@ -208,6 +205,31 @@ describe GQLi::Introspection do
       end
     end
 
+    describe 'aliases' do
+      it 'can create a query with an alias' do
+        query = dsl.query {
+          __node('pinned: catCollection', where: {
+            sys: { id_in: 'nyancat' }
+          }) {
+            items {
+              name
+            }
+          }
+          __node('unpinned: catCollection', where: {
+            sys: { id_not_in: 'nyancat' }
+          }, limit: 4) {
+            items {
+              name
+            }
+          }
+        }
+
+        validation = subject.validate(query)
+        expect(validation.valid?).to be_truthy
+        expect(validation.errors).to be_empty
+      end
+    end
+
     describe 'directives' do
       it 'can create a query with a directive and validations should not fail' do
         query = dsl.query {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gqli
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2019-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -310,9 +310,11 @@ files:
 - doc/GQLi.html
 - doc/GQLi/Base.html
 - doc/GQLi/Client.html
+- doc/GQLi/Contentful.html
 - doc/GQLi/DSL.html
 - doc/GQLi/EnumValue.html
 - doc/GQLi/Fragment.html
+- doc/GQLi/Github.html
 - doc/GQLi/Introspection.html
 - doc/GQLi/Node.html
 - doc/GQLi/Query.html
@@ -338,6 +340,9 @@ files:
 - lib/gqli.rb
 - lib/gqli/base.rb
 - lib/gqli/client.rb
+- lib/gqli/clients.rb
+- lib/gqli/clients/contentful.rb
+- lib/gqli/clients/github.rb
 - lib/gqli/dsl.rb
 - lib/gqli/enum_value.rb
 - lib/gqli/fragment.rb
@@ -345,6 +350,7 @@ files:
 - lib/gqli/node.rb
 - lib/gqli/query.rb
 - lib/gqli/response.rb
+- lib/gqli/subscription.rb
 - lib/gqli/validation.rb
 - lib/gqli/version.rb
 - spec/fixtures/vcr_cassettes/catCollection.yml
@@ -377,7 +383,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: GraphQL client for humans