gqli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a92aeb50f3395eeb402d70097e5a90b95f78c8ccf9971c92635f4423748a52b
+  data.tar.gz: 49d4f4186b14b60b38383e0436940049e6c489857854652daff112ec9e5f94d8
+SHA512:
+  metadata.gz: f1b611ab9b505ed267a4c0ecb943d357fc250f4221a07351b3b8ea5dd9968cba1d03aea84b64d9c727719cb1acc3f74aec12dda3f14b6f8ab82fd5aba786b23d
+  data.tar.gz: f314024396af8dab242f65136da3cd42248976824454ca105d84390902f8b974c6c0c776c4e76b2f7bc60853dcb8d88e09ad0787690d0fc087cfd6113f896050

data/.gitignore

@@ -0,0 +1,7 @@
+pkg
+doc/
+.yardoc/
+coverage
+Gemfile.lock
+.idea
+*.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--order random

data/.rubocop.yml

@@ -0,0 +1,31 @@
+inherit_from: .rubocop_todo.yml
+
+Encoding:
+  Enabled: false
+
+Metrics/ClassLength:
+  CountComments: false
+
+Metrics/MethodLength:
+  CountComments: false
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+  Exclude:
+    - gqli.gemspec
+    - spec/**/*
+    - examples/**/*
+    - Guardfile
+    - Gemfile
+    - Rakefile
+    - usage*.rb
+
+Metrics/ClassLength:
+  Max: 250
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: 'semantic'

data/.rubocop_todo.yml

@@ -0,0 +1,44 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-10-05 15:34:48 +0200 using RuboCop version 0.49.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: 3
+Metrics/AbcSize:
+  Max: 20
+
+# Blocks can be arbitrarily long due to GraphQL DSL syntax.
+Metrics/BlockLength:
+  Max: 30
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 8
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 114
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 15
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Block delimiters are `{...}` to match GraphQL syntax more closely.
+Style/BlockDelimiters:
+  Exclude:
+    - 'lib/gqli/introspection.rb'
+
+# We on purpose don't want method missing working as it is supposed in the context of the DSL
+Style/MethodMissing:
+  Exclude:
+    - 'lib/gqli/base.rb'

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.1
+  - 2.2.1
+notifications:
+  slack:
+    secure: Zr3mKCiTb0vaTD4MPtTG8BbyYyErFuoxioM25QyrqePKVkDFeZC1MtGmg5klQQrJiWTKZPa/zB8NAHYkoUxg9I+z15JK0hYfz9KRubEpCrXCaqTC9Vzq88kJ3LN8YsTyBF66izaBH2KLsOfaJRxwplFzZqgpg4GG2DUBPtrGtes=
+before_install: gem install bundler -v 1.10.6
+script: bundle exec rake rspec_rubocop
+matrix:
+  allow_failures:
+    - rvm: jruby

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## v0.1.0
+
+Initial Release
+
+Included features:
+* Create queries and fragments using the `GQLi::DSL`.
+* HTTP client with automatic schema introspection and validation.

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'listen', '3.0.6'
+
+group :documentation do
+  gem 'coveralls', :require => false
+end

data/Gemfile.lock

@@ -0,0 +1,154 @@
+PATH
+  remote: .
+  specs:
+    gqli (0.1.0)
+      hashie (~> 3.0)
+      http (> 0.8, < 3.0)
+      multi_json (~> 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    guard-yard (2.2.1)
+      guard (>= 1.1.0)
+      yard (>= 0.7.0)
+    hashdiff (0.3.7)
+    hashie (3.6.0)
+    http (2.2.2)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (1.0.3)
+    http_parser.rb (0.6.0)
+    json (2.1.0)
+    listen (3.0.6)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    multi_json (1.13.1)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rr (1.2.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    rubygems-tasks (0.2.4)
+    safe_yaml (1.0.4)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.4.0)
+    vcr (4.0.0)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yard (0.9.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  coveralls
+  gqli!
+  guard
+  guard-rspec
+  guard-rubocop
+  guard-yard
+  listen (= 3.0.6)
+  rake (< 11.0)
+  rr
+  rspec (~> 3)
+  rubocop (~> 0.49.1)
+  rubygems-tasks (~> 0.2)
+  simplecov
+  tins (~> 1.6.0)
+  vcr
+  webmock (~> 1, >= 1.17.3)
+
+BUNDLED WITH
+   1.16.3

data/Guardfile

@@ -0,0 +1,24 @@
+group :green_red_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "bundle exec rspec" do
+    require "guard/rspec/dsl"
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # Feel free to open issues for suggestions and improvements
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :yard, cmd: "yard doc" do
+  end
+
+  guard :rubocop, cmd: "rubocop" do
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Contentful GmbH - David Litvak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,284 @@
+# GQLi - GraphQL Client for humans
+
+GQLi is a DSL (Domain Specific Language) to consume GraphQL APIs.
+
+> **DISCLAIMER:**
+>
+> This gem is in stable state and will be updated with more features.
+> You can start using it for your respective projects, although there is no support available from Contentful.
+>
+> This gem is not covered under the Contentful SLAs.
+>
+> Users are free to create Github issues and collaborate.
+
+## Installation
+
+Install it via the command line:
+
+```bash
+gem install gqli
+```
+
+Or add it to your `Gemfile`:
+
+```ruby
+gem 'gqli'
+```
+
+## Usage
+
+### Creating a GraphQL Client
+
+For the examples throughout this README, we'll be using the Contentful and Github GraphQL APIs.
+Therefore, here's the initialization code required for both of them:
+
+```ruby
+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}" }
+)
+
+# 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}" }
+)
+```
+
+### Creating a Query
+
+Queries are the way to request data from a GraphQL API.
+This gem provides a simple DSL to create your own queries.
+
+The query operator is `GQLi::DSL.query`.
+
+```ruby
+# Query to fetch the usernames for the first 10 watchers of the first 10 repositories I belong to
+WatchersQuery = GQLi::DSL.query {
+  viewer {
+    login
+    repositories(first: 10) {
+      edges {
+        node {
+          nameWithOwner
+          watchers(first: 10) {
+            edges {
+              node {
+                login
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+### Divide and conquer - using Fragments
+
+In order to reuse parts of queries, we can split chunks of our queries into Fragments.
+
+The fragment operator is `GQLi::DSL.fragment`.
+
+To include fragments within other nodes, use the `___` operator as shown below.
+
+To do type matching, use the `__on` operator as shown below.
+
+```ruby
+# Base fragment that will be reused for all Cat queries.
+CatBase = GQLi::DSL.fragment('CatBase', 'Cat') {
+  name
+  likes
+  lives
+}
+
+CatBestFriend = GQLi::DSL.fragment('CatBestFriend', 'Cat') {
+  bestFriend {
+    # Here, because `bestFriend` is polimorphic in our GraphQL API,
+    # we need to explicitly state for which Type we want to include our fragment.
+    # To do a type match, instead of GraphQLs `... on SomeType` we do `__on('SomeType')`.
+    __on('Cat') {
+      # To include a fragment, instead of GraphQLs `...`, we use `___`.
+      ___ CatBase
+    }
+  }
+}
+
+# A fragment reusing multiple fragments
+CatImportantFields = GQLi::DSL.fragment('CatImportantFields', 'Cat') {
+  ___ CatBase
+  ___ CatBestFriend
+}
+
+# A fragment used to define a query, alongside other regular fields.
+CatQuery = GQLi::DSL.query {
+  catCollection(limit: 1) {
+    items {
+      ___ CatImportantFields
+      image {
+        url
+      }
+    }
+  }
+}
+```
+
+### Executing the queries
+
+To execute the queries, you need to pass a `Query` object to the client's `#execute` method.
+This will return a `Response` object which contains the `data` and the `query` executed.
+
+For example:
+
+```ruby
+response = CONTENTFUL_GQL.execute(CatQuery)
+
+puts "Query sent:"
+puts response.query.to_gql
+
+puts
+puts "Response received"
+response.data.catCollection.items.each do |c|
+  puts "Name:    #{c.nam}e"
+  puts "Likes:   #{c.likes.join(", ")}"
+  puts "Lives #: #{c.lives}"
+  c.bestFriend.tap do |bf|
+    puts "Best Friend:"
+    puts "\tName:    #{bf.name}"
+    puts "\tLikes:   #{bf.likes.join(", ")}"
+    puts "\tLives #: #{bf.lives}"
+  end
+end
+```
+
+The output is:
+
+```
+Query sent:
+query {
+  catCollection(limit: 1) {
+    items {
+      name
+      likes
+      lives
+      bestFriend {
+        ... on Cat {
+          name
+          likes
+          lives
+        }
+      }
+      image {
+        url
+      }
+    }
+  }
+}
+
+Response received
+Name:    e
+Likes:   cheezburger
+Lives #: 1
+Best Friend:
+	Name:    Nyan Cat
+	Likes:   rainbows, fish
+	Lives #: 1337
+```
+
+### Schema Introspection and Validation
+
+By default this library will fetch and cache a copy of the GraphQL Schema for any API you create a client for.
+
+This schema is used for query validation before running queries against the APIs. In case a query is invalid for the given schema, an exception will be raised.
+
+To disable schema caching completely, when you initialize your client, send `validate_query: false`.
+
+Queries executed using the `#execute` method on the client will be validated before executing the request if the option is set to `true` (which it is by default).
+
+To avoid validating a query, you can use `#execute!` instead.
+
+To validate the query outside of the scope of an HTTP request, you can use `MY_CLIENT.schema.valid?(query)`.
+
+### Embedding the DSL in your classes
+
+If you want to avoid the need for prepending all GQLi DSL's calls with `GQLi::DSL.`, then you can `extend` and/or `include` the module within your own classes.
+When using `extend`, you will have access to the DSL at a class level. When using `include` you will have access to the DSL at an object level.
+
+```ruby
+class ContentfulClient
+  extend GQLi::DSL # Makes DSL available at a class level
+  include GQLi::DSL # Makes DSL available at an object level
+
+  SPACE_ID = 'cfexampleapi'
+  ACCESS_TOKEN = 'b4c0n73n7fu1'
+  CONTENTFUL_GQL = GQLi::Client.new(
+    "https://graphql.contentful.com/content/v1/spaces/#{SPACE_ID}",
+    headers: { "Authorization" => "Bearer #{ACCESS_TOKEN}" }
+  )
+
+  CatBase = fragment('CatBase', 'Cat') {
+    name
+    likes
+    lives
+  }
+
+  CatBestFriend = fragment('CatBestFriend', 'Cat') {
+    bestFriend {
+      __on('Cat') {
+        ___ CatBase
+      }
+    }
+  }
+
+  CatImportantFields = fragment('CatImportantFields', 'Cat') {
+    ___ CatBase
+    ___ CatBestFriend
+  }
+
+  def cats(limit)
+    CONTENTFUL_GQL.execute(
+      query {
+        catCollection(limit: limit) {
+          items {
+            ___ CatImportantFields
+            image {
+              url
+            }
+          }
+        }
+      }
+    )
+  end
+end
+
+response = ContentfulClient.new.cats(5)
+```
+
+## Yet to be implemented
+
+* Mutation queries
+* Subscription queries
+* Detailed validation errors
+
+## Get involved
+
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?maxAge=31557600)](http://makeapullrequest.com)
+
+We appreciate any help on our repositories.
+
+## License
+
+This repository is published under the [MIT](LICENSE.txt) license.
+
+## Code of Conduct
+
+We want to provide a safe, inclusive, welcoming, and harassment-free space and experience for all participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers.
+
+[Read our full Code of Conduct](https://github.com/contentful-developer-relations/community-code-of-conduct).

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn 'Run `gem install bundler` to install Bundler.'
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems.'
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task rspec_rubocop: %w(spec rubocop)
+
+task test: :spec
+task default: :spec

data/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 94.02
+  }
+}