giraph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 200536c7e29c300962bf1e9306f3656852b19a88
+  data.tar.gz: b6c30010a1e6406d47ca41d96ca66dd09dc3a00e
+SHA512:
+  metadata.gz: 922c37a7505fac9f68bf53611b4a1a0d139a5fa88a9f40e59a7b2886513d6a29d259b4c3e32f2654063c5f1c3d4ba014c56d80cd5a8ece5a310ee39f233c8e18
+  data.tar.gz: eb2a773e12531711f3abd82e72b2fc80c7cda9ce954f472eb86261c64fe947e21348ba6a4476e9ca87f4b6f0e48a0ac0c3ad2eb0fa09e7928e36b870b4f0ce85

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*.swp
+*.gem
+Gemfile.lock
+coverage/

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+    - 1.9.3
+    - 2.1.0
+    - 2.3.0
+script: bundle exec rake --trace

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in giraph.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Upserve
+
+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,50 @@
+# Giraph
+
+_(Pronounced with a G as in GIF)_
+
+Ever wanted to have multiple GraphQL endpoints presented under one? 
+
+Ever felt like interactions between micro-services are not DRY enough?
+
+If so, you'll feel right at home with Giraph. 
+
+Giraph allows you to plug-in a remote GraphQL endpoint under another one as a regular field.
+You can now plug a remote GraphQL endpoint in as a field anywhere within your type hierarchy, 
+allow clients to send a single unified query, have the remote servers resolve their respective
+sub-queries and return a valid response that all seamlessly comes together.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'giraph'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install giraph
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/upserve/giraph.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "giraph"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/giraph.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'giraph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'giraph'
+  spec.version       = Giraph::VERSION
+  spec.authors       = ['Erman Celen']
+  spec.email         = ['erman@upserve.com']
+
+  spec.summary       = 'Composable GraphQL for micro-services'
+  spec.description   = 'Expose a remote GraphQL endpoint within another as a regular field'
+  spec.homepage      = 'https://github.com/upserve/giraph'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.add_runtime_dependency 'graphql', '0.15.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/giraph/extensions/field.rb

@@ -0,0 +1,33 @@
+module Giraph
+  # Wrapped methods on GraphQL::Field class
+  module Extensions
+    module Field
+      # Wrap the 'resolve' method on Field so that we can
+      # intercept the registered resolution Proc and resolve
+      # on already-resolved values from the JSON returned
+      # to the sub-query through the remote endpoint
+      def resolve(object, arguments, context)
+        # Giraph always parses a remote response with a special Hash
+        # class called 'Giraph::Remote::Response', which is a no-op sub-class
+        # of Hash. This way we can easily recognize this special
+        # "resolve on already resolved response" case while still
+        # allowing regular Hash to be resolved normally.
+        if object.instance_of? Giraph::Remote::Response
+          # If the field was aliased, response will be keyed by the alias
+          field = context.ast_node.alias || context.ast_node.name
+          object[field.to_sym]
+        else
+          # Not Giraph, let it through...
+          super
+        end
+      end
+    end
+  end
+end
+
+# Monkey-patch GraphQL Field class to wrap the default 'resolve'
+module GraphQL
+  class Field
+    prepend Giraph::Extensions::Field
+  end
+end

data/lib/giraph/remote/connector.rb

@@ -0,0 +1,53 @@
+module Giraph
+  module Remote
+    class InvalidResponse < StandardError; end
+
+    # sends the reconstructed subquery request and parses the response.
+    class Connector
+      def initialize(endpoint)
+        @endpoint = endpoint
+      end
+
+      # The resolver method for the connection field.
+      def resolve(context, query_string, query_variables)
+        # Remote can return data, error or totally freak out,
+        # we handle all here, and note anything of relevance
+        result = run_query(query_string, query_variables)
+        return_data_or_raise(result) do |exception|
+          # Tack on details for host's version of the query
+          exception.ast_node = context.ast_node
+        end
+      end
+
+      private
+
+      def run_query(query, variable)
+        Net::HTTP.post_form(URI(@endpoint), query: query, variables: variable)
+      end
+
+      def return_data_or_raise(response, &block)
+        result = Remote::Response.from_json(response.body)
+
+        # Remote returned a valid result set, pass it through
+        return result[:data] if result[:data]
+
+        # Remote returned a GraphQL error, raise it as such
+        raise remote_execution_error(result[:errors], block)
+      rescue JSON::ParserError
+        # Remote server returned an invalid result (non-JSON response)
+        # meaning something went wrong. Raise an error that reflects this.
+        raise(
+          InvalidResponse,
+          "Remote endpoint returned: '#{response.code} #{response.msg}'"
+        )
+      end
+
+      def remote_execution_error(errors, block)
+        GraphQL::ExecutionError.new(errors).tap do |ex|
+          # Allow exception to be modified if needed
+          block.call(ex) if block
+        end
+      end
+    end
+  end
+end

data/lib/giraph/remote/mutation.rb

@@ -0,0 +1,20 @@
+module Giraph
+  module Remote
+    # Field resolver to plug a remote GraphQL mutation root into a local type
+    class Mutation < Query
+      def self.bind(endpoint, &block)
+        new(
+          endpoint,
+          Remote::Connector.new(endpoint, mutation: true),
+          &block
+        )
+      end
+
+      private
+
+      def query_type
+        'mutation'
+      end
+    end
+  end
+end

data/lib/giraph/remote/query.rb

@@ -0,0 +1,61 @@
+module Giraph
+  module Remote
+    # Field resolver to plug a remote GraphQL query root into a local type
+    class Query
+      def self.bind(endpoint, &block)
+        new(
+          endpoint,
+          Remote::Connector.new(endpoint),
+          &block
+        )
+      end
+
+      def initialize(endpoint, connector, &block)
+        @endpoint = endpoint
+        @evaluator = block || method(:default_evaluator)
+        @connector = connector
+      end
+
+      # Reconstructs a valid GraphQL root-query from the current
+      # field in question, including all variables and params,
+      # hands over to connector to execute remotely.
+      def call(obj, args, ctx)
+        # Given an evaluator block, continue if only it evaluates to non-nil!
+        return unless (remote_root = @evaluator.call(obj, args, ctx))
+
+        subquery = Subquery.new(ctx)
+
+        # Continue with remote query execution
+        connector.resolve(
+          ctx,
+          query_string(subquery),
+          query_variables(subquery, remote_root)
+        )
+      end
+
+      private
+
+      def query_type
+        'query'
+      end
+
+      def query_string(subquery)
+        # Full GraphQL query for remote
+        "#{query_type} #{subquery.subquery_string}"
+      end
+
+      def query_variables(subquery, remote_root)
+        # Variable hash to send along
+        subquery.variable_string do |dict|
+          dict.merge(__giraph_root__: remote_root)
+        end
+      end
+
+      def default_evaluator(*args)
+        {}
+      end
+
+      attr_reader :endpoint, :connector
+    end
+  end
+end

data/lib/giraph/remote/response.rb

@@ -0,0 +1,14 @@
+module Giraph
+  module Remote
+    # Dummy Hash-wrapper to enable precise `instance_of?` checks
+    # Allows us to differentiate JSON responses that are
+    # coming from remote GraphQL interface vs regular Hash objects
+    # including all nested hashes within a response.
+    class Response < Hash
+      # Factory method to encapsulate special parsing logic
+      def self.from_json(raw_json)
+        JSON.parse(raw_json, symbolize_names: true, object_class: self)
+      end
+    end
+  end
+end

data/lib/giraph/resolver.rb

@@ -0,0 +1,31 @@
+module Giraph
+  # Proc-like class to allow declerative links to external
+  # resolution handlers (so the "definition" gem can stay pure resolution-wise)
+  class Resolver
+    class UnknownOperation < StandardError; end
+
+    def self.for(method_name)
+      new(method_name)
+    end
+
+    def initialize(method_name)
+      @method_name = method_name
+    end
+
+    # Resolves the field by calling the previously given method
+    # on the registered Resolver object for the current operation
+    # type (currently query or mutation)
+    def call(obj, args, ctx)
+      # Find out operation type (query, mutation, etc.)
+      op_type = ctx.query.selected_operation.operation_type.to_sym
+
+      # Ensure there is a registered resolver for it
+      unless (resolver = ctx[:__giraph_resolver__][op_type])
+        raise UnknownOperation, "No resolver found for '#{op_type}' op type"
+      end
+
+      # Call the requested method on resolver
+      resolver.public_send(@method_name, obj, args, ctx)
+    end
+  end
+end

data/lib/giraph/schema.rb

@@ -0,0 +1,48 @@
+module Giraph
+  # GraphQL::Schema wrapper allowing decleration of
+  # resolver objects per op type (query or mutation)
+  class Schema < DelegateClass(GraphQL::Schema)
+    # Extract special arguments for resolver objects,
+    # let the rest pass-through
+    def initialize(**args)
+      @query_resolver = args.delete(:query_resolver)
+      @mutation_resolver = args.delete(:mutation_resolver)
+      super(GraphQL::Schema.new(**args))
+    end
+
+    # Defer the execution only after setting up
+    # context and root_value with resolvers and remote arguments
+    def execute(query, **args)
+      args = args
+             .merge(with_giraph_root(args))
+             .merge(with_giraph_resolvers(args))
+
+      super(query, **args)
+    end
+
+    private
+
+    def with_giraph_root(args)
+      # Extract & remove the special __giraph_root__ key
+      # from variables passed in, if any
+      vars = args[:variables] || {}
+      root = vars.delete('__giraph_root__') || {}
+
+      # Set given pseudo-root as root_value for the execution
+      { root_value: root }
+    end
+
+    def with_giraph_resolvers(args)
+      # Pass on resolver objects in context
+      # which will then be used by Giraph resolvers
+      # to direct per-field resolution
+      context = args[:context] || {}
+      context[:__giraph_resolver__] = {
+        query: @query_resolver,
+        mutation: @mutation_resolver
+      }
+
+      { context: context }
+    end
+  end
+end

data/lib/giraph/subquery.rb

@@ -0,0 +1,72 @@
+module Giraph
+  # Defines a thin & sane API for the sub-query extraction
+  # from the context provided to resolvers via AST, graphql-ruby API
+  # and a touch of regex.
+  class Subquery
+    attr_reader :query, :query_string
+
+    def initialize(context)
+      @context = context
+
+      @query = context.query
+      @query_string = context.ast_node.to_query_string
+    end
+
+    def subquery_string
+      "GiraphQuery #{query_variables} #{query_selections}"
+    end
+
+    def variable_string
+      dict = variable_assignments
+      dict = yield dict if block_given?
+
+      dict.to_json
+    end
+
+    private
+
+    def variable_assignments
+      # This re-encodes and passes on all the variable values
+      # paseed to the original query endpoint
+      query.instance_variable_get('@provided_variables')
+    end
+
+    def query_selections
+      # We get the following from node's sub-query:
+      #   nodeName { field1 { field12 } field2(a: $a) field3 }
+      # we want:
+      #   { field1 { field12 } field2(a: $a) field3 }
+      # as the name of node is local information to parent host
+      # and is no use to the remote host.
+      query_string.sub(/^[^{]+/, '')
+    end
+
+    def query_variables
+      # Recreates the declared query parameters to be passed on
+      # to the remote host.
+      declarations = query
+                     .selected_operation
+                     .variables
+                     .select(&method(:variable_used?))
+                     .map(&method(:variable_decleration))
+
+      "(#{declarations.join(', ')})" unless declarations.empty?
+    end
+
+    def variable_used?(variable)
+      query_string[/\$#{Regexp.quote(variable.name)}\W/]
+    end
+
+    def variable_decleration(variable)
+      "$#{variable.name}: #{variable_type(variable)}"
+    end
+
+    def variable_type(variable)
+      if variable.type.is_a?(GraphQL::Language::Nodes::NonNullType)
+        variable.type.of_type.name + '!'
+      else
+        variable.type.name
+      end
+    end
+  end
+end

data/lib/giraph/version.rb

@@ -0,0 +1,3 @@
+module Giraph
+  VERSION = "0.1.0"
+end

data/lib/giraph.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'graphql'
+
+require 'giraph/version'
+
+require 'giraph/subquery'
+require 'giraph/extensions/field'
+require 'giraph/remote/response'
+require 'giraph/remote/connector'
+require 'giraph/remote/query'
+require 'giraph/remote/mutation'
+require 'giraph/resolver'
+require 'giraph/schema'

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: giraph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erman Celen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Expose a remote GraphQL endpoint within another as a regular field
+email:
+- erman@upserve.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- giraph.gemspec
+- lib/giraph.rb
+- lib/giraph/extensions/field.rb
+- lib/giraph/remote/connector.rb
+- lib/giraph/remote/mutation.rb
+- lib/giraph/remote/query.rb
+- lib/giraph/remote/response.rb
+- lib/giraph/resolver.rb
+- lib/giraph/schema.rb
+- lib/giraph/subquery.rb
+- lib/giraph/version.rb
+homepage: https://github.com/upserve/giraph
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Composable GraphQL for micro-services
+test_files: []