RubyGems - gqli - Versions diffs - 0.1.0 - Mend

gqli 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (89) hide show

checksums.yaml +7 -0
data/.gitignore +7 -0
data/.rspec +3 -0
data/.rubocop.yml +31 -0
data/.rubocop_todo.yml +44 -0
data/.travis.yml +13 -0
data/.yardopts +4 -0
data/CHANGELOG.md +9 -0
data/Gemfile +9 -0
data/Gemfile.lock +154 -0
data/Guardfile +24 -0
data/LICENSE.txt +21 -0
data/README.md +284 -0
data/Rakefile +33 -0
data/coverage/.last_run.json +5 -0
data/coverage/.resultset.json +512 -0
data/coverage/.resultset.json.lock +0 -0
data/coverage/assets/0.10.2/application.css +799 -0
data/coverage/assets/0.10.2/application.js +1707 -0
data/coverage/assets/0.10.2/colorbox/border.png +0 -0
data/coverage/assets/0.10.2/colorbox/controls.png +0 -0
data/coverage/assets/0.10.2/colorbox/loading.gif +0 -0
data/coverage/assets/0.10.2/colorbox/loading_background.png +0 -0
data/coverage/assets/0.10.2/favicon_green.png +0 -0
data/coverage/assets/0.10.2/favicon_red.png +0 -0
data/coverage/assets/0.10.2/favicon_yellow.png +0 -0
data/coverage/assets/0.10.2/loading.gif +0 -0
data/coverage/assets/0.10.2/magnify.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png +0 -0
data/coverage/index.html +3255 -0
data/doc/GQLi/Base.html +628 -0
data/doc/GQLi/Client.html +830 -0
data/doc/GQLi/DSL.html +421 -0
data/doc/GQLi/Fragment.html +405 -0
data/doc/GQLi/Introspection.html +837 -0
data/doc/GQLi/Node.html +413 -0
data/doc/GQLi/Query.html +390 -0
data/doc/GQLi/Response.html +370 -0
data/doc/GQLi.html +157 -0
data/doc/_index.html +236 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +496 -0
data/doc/file.CHANGELOG.html +76 -0
data/doc/file.LICENSE.html +70 -0
data/doc/file.README.html +365 -0
data/doc/file_list.html +66 -0
data/doc/frames.html +17 -0
data/doc/index.html +365 -0
data/doc/js/app.js +292 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +355 -0
data/doc/top-level-namespace.html +110 -0
data/gqli.gemspec +37 -0
data/lib/gqli/base.rb +53 -0
data/lib/gqli/client.rb +59 -0
data/lib/gqli/dsl.rb +37 -0
data/lib/gqli/fragment.rb +25 -0
data/lib/gqli/introspection.rb +215 -0
data/lib/gqli/node.rb +48 -0
data/lib/gqli/query.rb +29 -0
data/lib/gqli/response.rb +15 -0
data/lib/gqli/version.rb +7 -0
data/lib/gqli.rb +6 -0
data/spec/fixtures/vcr_cassettes/catCollection.yml +63 -0
data/spec/fixtures/vcr_cassettes/client.yml +171 -0
data/spec/fixtures/vcr_cassettes/validation_error.yml +62 -0
data/spec/lib/gqli/client_spec.rb +90 -0
data/spec/lib/gqli/dsl_spec.rb +205 -0
data/spec/lib/gqli/introspection_spec.rb +125 -0
data/spec/spec_helper.rb +25 -0
data/usage.rb +100 -0
data/usage_introspection.rb +63 -0
data/usage_with_inlined_dsl.rb +69 -0
metadata +387 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.16
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Mon Oct 15 13:10:42 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.5.1).
+</div>
+    </div>
+  </body>
+</html>

data/gqli.gemspec ADDED Viewed

@@ -0,0 +1,37 @@
+require File.expand_path('../lib/gqli/version', __FILE__)
+Gem::Specification.new do |gem|
+  gem.name          = 'gqli'
+  gem.version       = GQLi::VERSION
+  gem.summary       = 'GraphQL client for humans'
+  gem.description   = 'GraphQL client with simple interface, designed for developer happiness'
+  gem.license       = 'MIT'
+  gem.authors       = ['Contentful GmbH (David Litvak Bruno)']
+  gem.email         = 'rubygems@contentful.com'
+  gem.homepage      = 'https://github.com/contentful-labs/gqli.rb'
+  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) && !path.start_with?('pkg') }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ['lib']
+  gem.add_dependency 'http', '> 0.8', '< 3.0'
+  gem.add_dependency 'hashie', '~> 3.0'
+  gem.add_dependency 'multi_json', '~> 1'
+  gem.add_development_dependency 'bundler', '~> 1.5'
+  gem.add_development_dependency 'rake', '< 11.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-rubocop'
+  gem.add_development_dependency 'guard-yard'
+  gem.add_development_dependency 'rubocop', '~> 0.49.1'
+  gem.add_development_dependency 'rspec', '~> 3'
+  gem.add_development_dependency 'rr'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock', '~> 1', '>= 1.17.3'
+  gem.add_development_dependency 'tins', '~> 1.6.0'
+end

data/lib/gqli/base.rb ADDED Viewed

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+module GQLi
+  # Base class for GraphQL type wrappers
+  class Base
+    attr_reader :__name, :__depth, :__nodes
+    def initialize(name = nil, depth = 0, &block)
+      @__name = name
+      @__depth = depth
+      @__nodes = []
+      instance_eval(&block) unless block.nil?
+    end
+    # Inlines fragment nodes into current node
+    def ___(fragment)
+      @__nodes += __clone_nodes(fragment)
+    end
+    # Adds type match node
+    def __on(type_name, &block)
+      require_relative './node'
+      @__nodes << Node.new("... on #{type_name}", [], __depth + 1, &block)
+    end
+    protected
+    def __clone_nodes(node_container)
+      require_relative './node'
+      __clone(node_container.__nodes).map do |n|
+        node = Node.new(n.__name, n.__params, __depth + 1)
+        node.instance_variable_set(
+          :@__nodes,
+          node.send(:__clone_nodes, n)
+        )
+        node
+      end
+    end
+    def __clone(obj)
+      Marshal.load(Marshal.dump(obj))
+    end
+    def __params_from_args(args)
+      args.empty? ? {} : args[0]
+    end
+    def method_missing(name, *args, &block)
+      require_relative './node'
+      @__nodes << Node.new(name.to_s, __params_from_args(args), __depth + 1, &block)
+    end
+  end
+end

data/lib/gqli/client.rb ADDED Viewed

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require 'http'
+require 'json'
+require_relative './response'
+require_relative './introspection'
+require_relative './version'
+module GQLi
+  # GraphQL HTTP Client
+  class Client
+    attr_reader :url, :params, :headers, :validate_query, :schema
+    def initialize(url, params: {}, headers: {}, validate_query: true)
+      @url = url
+      @params = params
+      @headers = headers
+      @validate_query = validate_query
+      @schema = Introspection.new(self) if validate_query
+    end
+    # Executes a query
+    # If validations are enabled, will perform validation check before request.
+    def execute(query)
+      fail 'Validation Error: query is invalid - HTTP Request not sent' unless valid?(query)
+      execute!(query)
+    end
+    # Executres a query
+    # Ignores validations
+    def execute!(query)
+      http_response = HTTP.headers(request_headers).post(@url, params: @params, json: { query: query.to_gql })
+      fail "Error: #{http_response.reason}\nBody: #{http_response.body}" if http_response.status >= 300
+      data = JSON.parse(http_response.to_s)['data']
+      Response.new(data, query)
+    end
+    # Validates a query against the schema
+    def valid?(query)
+      return true unless validate_query
+      @schema.valid?(query)
+    end
+    protected
+    def request_headers
+      {
+        accept: 'application/json',
+        user_agent: "gqli.rb/#{VERSION}; http.rb/#{HTTP::VERSION}"
+      }.merge(@headers)
+    end
+  end
+end

data/lib/gqli/dsl.rb ADDED Viewed

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require_relative './query'
+require_relative './fragment'
+module GQLi
+  # GraphQL-like DSL methods
+  module DSL
+    # Creates a Query object
+    #
+    # Can be used at a class level
+    def self.query(name = nil, &block)
+      Query.new(name, &block)
+    end
+    # Creates a Fragment object
+    #
+    # Can be used at a class level
+    def self.fragment(name, on, &block)
+      Fragment.new(name, on, &block)
+    end
+    # Creates a Query object
+    #
+    # Can be used at an instance level
+    def query(name = nil, &block)
+      Query.new(name, &block)
+    end
+    # Creates a Fragment object
+    #
+    # Can be used at an instance level
+    def fragment(name, on, &block)
+      Fragment.new(name, on, &block)
+    end
+  end
+end

data/lib/gqli/fragment.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require_relative './base'
+require_relative './node'
+module GQLi
+  # Fragment wrapper
+  class Fragment < Base
+    attr_reader :__on_type
+    def initialize(name, on, &block)
+      super(name, 0, &block)
+      @__on_type = on
+    end
+    # Serializes to a GraphQL string
+    def to_gql
+      <<~GQL
+        fragment #{__name} on #{__on_type} {
+        #{__nodes.map(&:to_gql).join("\n")}
+        }
+      GQL
+    end
+  end
+end

data/lib/gqli/introspection.rb ADDED Viewed

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+require_relative './dsl'
+module GQLi
+  # Introspection schema and validator
+  class Introspection
+    extend DSL
+    # Specific type kind introspection fragment
+    TypeRef = fragment('TypeRef', '__Type') {
+      kind
+      name
+      ofType {
+        kind
+        name
+        ofType {
+          kind
+          name
+          ofType {
+            kind
+            name
+          }
+        }
+      }
+    }
+    # Input value introspection fragment
+    InputValue = fragment('InputValue', '__InputValue') {
+      name
+      description
+      type { ___ TypeRef }
+      defaultValue
+    }
+    # Type introspection fragment
+    FullType = fragment('FullType', '__Type') {
+      kind
+      name
+      description
+      fields(includeDeprecated: true) {
+        name
+        description
+        args { ___ InputValue }
+        type { ___ TypeRef }
+        isDeprecated
+        deprecationReason
+      }
+      inputFields { ___ InputValue }
+      interfaces { ___ TypeRef }
+      enumValues(includeDeprecated: true) {
+        name
+        description
+        isDeprecated
+        deprecationReason
+      }
+      possibleTypes { ___ TypeRef }
+    }
+    # Query for fetching the complete schema
+    IntrospectionQuery = query {
+      __schema {
+        queryType { name }
+        mutationType { name }
+        subscriptionType { name }
+        types { ___ FullType }
+        directives {
+          name
+          description
+          args { ___ InputValue }
+          onOperation
+          onFragment
+          onField
+        }
+      }
+    }
+    attr_reader :schema, :query_type, :mutation_type, :subscription_type, :types
+    def initialize(client)
+      @schema = client.execute!(IntrospectionQuery).data.__schema
+      @query_type = schema.queryType
+      @mutation_type = schema.mutationType
+      @subscription_type = schema.subscriptionType
+      @types = schema.types
+    end
+    # Returns wether the query is valid or not
+    def valid?(query)
+      return false unless query.is_a?(Query)
+      query_type = types.find { |t| t.name.casecmp('query').zero? }
+      query.__nodes.each do |node|
+        return false unless valid_node?(query_type, node)
+      end
+      true
+    end
+    private
+    def valid_node?(parent_type, node)
+      return true if parent_type.kind == 'SCALAR'
+      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 }
+      return false if node_type.nil?
+      return false unless valid_params?(node_type, node)
+      resolved_node_type = type_for(node_type)
+      return false if resolved_node_type.nil?
+      return false unless valid_nesting_node?(resolved_node_type, node)
+      node.__nodes.all? { |n| valid_node?(resolved_node_type, n) }
+    end
+    def valid_match_node?(parent_type, node)
+      return true if parent_type.fetch('possibleTypes', []).find { |t| t.name == node.__name.gsub('... on ', '') }
+      false
+    end
+    def valid_params?(node_type, node)
+      node.__params.each do |param, value|
+        arg = node_type.fetch('args', []).find { |a| a.name == param.to_s }
+        return false if arg.nil?
+        arg_type = type_for(arg)
+        return false if arg_type.nil?
+        return false unless valid_value_for_type?(arg_type, value)
+      end
+      true
+    end
+    def valid_nesting_node?(node_type, node)
+      return false unless valid_object_node?(node_type, node)
+      return false unless valid_array_node?(node_type, node)
+      true
+    end
+    def valid_object_node?(node_type, node)
+      return false if %w[OBJECT INTERFACE].include?(node_type.kind) && node.__nodes.empty?
+      true
+    end
+    def valid_array_node?(node_type, node)
+      return false if %w[OBJECT INTERFACE].include?(node_type.kind) && node.__nodes.empty?
+      true
+    end
+    def valid_value_for_type?(arg_type, value)
+      case value
+      when ::String
+        return false unless arg_type.name == 'String' || arg_type.name == 'ID'
+      when ::Integer
+        return false unless arg_type.name == 'Int'
+      when ::Float
+        return false unless arg_type.name == 'Float'
+      when ::Hash
+        return valid_hash_value?(arg_type, value)
+      when true, false
+        return false unless arg_type.name == 'Boolean'
+      else
+        return false
+      end
+      true
+    end
+    def valid_hash_value?(arg_type, value)
+      return false unless arg_type.kind == 'INPUT_OBJECT'
+      type = types.find { |f| f.name == arg_type.name }
+      return false if type.nil?
+      value.each do |k, v|
+        input_field = type.fetch('inputFields', []).find { |f| f.name == k.to_s }
+        return false if input_field.nil?
+        input_field_type = type_for(input_field)
+        return false if input_field_type.nil?
+        return false unless valid_value_for_type?(input_field_type, v)
+      end
+    end
+    def type_for(field_type)
+      type = case field_type.type.kind
+             when 'NON_NULL'
+               non_null_type(field_type.type.ofType)
+             when 'LIST'
+               field_type.type.ofType
+             when 'OBJECT', 'INTERFACE', 'INPUT_OBJECT'
+               field_type.type
+             when 'SCALAR'
+               field_type.type
+             end
+      types.find { |t| t.name == type.name }
+    end
+    def non_null_type(non_null)
+      case non_null.kind
+      when 'LIST'
+        non_null.ofType
+      else
+        non_null
+      end
+    end
+  end
+end

data/lib/gqli/node.rb ADDED Viewed

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require_relative './base'
+module GQLi
+  # Node wrapper
+  class Node < Base
+    attr_reader :__params
+    def initialize(name, params = {}, depth = 1, &block)
+      super(name, depth, &block)
+      @__params = params
+    end
+    # Serializes to a GraphQL string
+    def to_gql
+      result = '  ' * __depth + __name
+      result += '(' + __params_to_s(__params, true) + ')' unless __params.empty?
+      unless __nodes.empty?
+        result += " {\n"
+        result += __nodes.map(&:to_gql).join("\n")
+        result += "\n#{'  ' * __depth}}"
+      end
+      result
+    end
+    private
+    def __params_to_s(params, initial = false)
+      case params
+      when ::Hash
+        result = params.map do |k, v|
+          "#{k}: #{__params_to_s(v)}"
+        end.join(', ')
+        return result if initial
+        "{#{result}}"
+      when ::Array
+        "[#{params.map { |p| __params_to_s(p) }.join(', ')}]"
+      when ::String
+        "\"#{params}\""
+      else
+        params.to_s
+      end
+    end
+  end
+end

data/lib/gqli/query.rb ADDED Viewed

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require_relative './base'
+module GQLi
+  # Query node
+  class Query < Base
+    # Serializes to a GraphQL string
+    def to_gql
+      result = <<~GQL
+        query #{__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/response.rb ADDED Viewed

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'hashie/mash'
+module GQLi
+  # Response object wrapper
+  class Response
+    attr_reader :data, :query
+    def initialize(data, query)
+      @data = Hashie::Mash.new(data)
+      @query = query
+    end
+  end
+end

data/lib/gqli/version.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# GraphQL Client and DSL library
+module GQLi
+  # Gem version
+  VERSION = '0.1.0'
+end

data/lib/gqli.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require_relative './gqli/dsl'
+require_relative './gqli/client'
+require_relative './gqli/introspection'
+require_relative './gqli/version'