graphlient 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1adef5ff2cf8488f33f2decb2242192aa29654c
+  data.tar.gz: 85c4b69d0f9a9d4cd49cba7aff1cdeeb23d6fcaf
+SHA512:
+  metadata.gz: e461cb4260672b0ac960b7673a7133aa8131361a5a590c6bc5bf5bf65a378c7dd2bd3d8ae40983e6e7ca702039418525c02204fd6961fd06bd6bcf833ed499a3
+  data.tar.gz: 04b967185ca939bc62c7fc3cfc61d721e59c1491965fa803e6fbd850a2cef79c1ed67491089b1a0bd421f9fdd44e2e7a9743e51b78e1b4704ceb92b630c45428

data/.byebug_history

@@ -0,0 +1,23 @@
+c
+next
+nex
+Graphlient.config.graphql_endpoint
+c
+Graphlient.config.graphql_endpoint
+query.to_s
+c
+&block
+args
+m
+c
+n
+&block
+args
+m
+c
+send(m, *args, &block)
+send(m, args, &block)
+&block
+block
+args
+m

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.3.0
+  - 2.4.1

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rake'
+
+group :development do
+  gem 'rubocop', '~> 0.47.1', require: false
+  gem 'byebug'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    graphlient (0.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
+    byebug (9.1.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.6)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    public_suffix (3.0.0)
+    rainbow (2.2.2)
+      rake
+    rake (12.1.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.47.1)
+      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.9.0)
+    safe_yaml (1.0.4)
+    unicode-display_width (1.3.0)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  graphlient!
+  rake
+  rspec
+  rspec-mocks
+  rubocop (~> 0.47.1)
+  webmock
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ashkan Nasseri
+
+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,80 @@
+# Graphlient ![](https://travis-ci.org/ashkan18/graphlient.svg?branch=master)
+Ruby Client for consuming GraphQL based APIs.
+
+## Installation
+Add following line to your Gemfile
+
+```ruby
+gem 'graphlient'
+```
+
+## Configuration
+
+Add `graphlient.rb under config/initializers. You can use this config to setup `graphql_endpoint`. Here is a sample of configuration:
+
+```ruby
+# config/initializers/graphlient.rb
+Graphlient.configure do |config|
+  config.graphql_endpoint = 'http://test-graphql.biz/graphql'  # target GraphQL endpoint
+end
+```
+
+## Usage
+There are 3 different usages.
+
+### Graphlient::Client
+After configuring the client, you can use the client by passing the query in a block.
+
+```ruby
+response = Graphlient::Client.query(headers: { 'Authorization' => 'Bearer 123'}) do
+  invoice(id: 10) do
+    id
+    total
+    line_items do
+      price
+      item_type
+    end
+  end
+end
+```
+
+This will call the endpoint setup in the configuration with `POST` and passes `query` as
+```graphql
+invoice(id: 10) {
+  id
+  total
+  line_items{
+    price
+    item_type
+  }
+}
+```
+It also sets the `Authorization` header based on passed in data.
+
+### Use Graphlient::Query directly
+You can directly use `Graphlient::Query` to generate GraphQL queries. Example:
+```ruby
+query = Graphlient::Query.new do
+  query do
+    invoice(id: 10) do
+      line_items
+    end
+  end
+end
+
+query.to_s
+# "\nquery{\n  invoice(id: 10){\n    line_items\n    }\n  }\n"
+```
+
+### Use Graphlient::Extension::Query
+You can include `Graphlient::Extension::Query` in your module. This will add new `method_missing` method to your context which will be used to generate GraphQL queries.
+
+```ruby
+include Graphlient::Extension::Query
+query = invoice(id: 10) do
+  line_items
+end
+
+query.to_s
+# "\nquery{\n  invoice(id: 10){\n    line_items\n    }\n  }\n"
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+Bundler.setup(:default, :development)
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/graphlient.gemspec

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'graphlient/version'
+
+Gem::Specification.new do |s|
+  s.name = 'graphlient'
+  s.version = Graphlient::VERSION
+  s.authors = ['Ashkan Nasseri']
+  s.email = 'ashkan.nasseri@gmail.com'
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/ashkan18/graphlient'
+  s.licenses = ['MIT']
+  s.summary = "Ruby Gem for consuming GraphQL endpoints"
+end

data/lib/graphlient/client.rb

@@ -0,0 +1,22 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Graphlient
+  module Client
+    def self.query(headers = {}, &block)
+      query = Graphlient::Query.new do
+        instance_eval(&block)
+      end
+      uri = URI(Graphlient.config.graphql_endpoint)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = { query: query.to_s }.to_json
+      headers.each do |k, v|
+        request[k] = v
+      end
+      response = http.request(request)
+      JSON.parse(response.body, symbolize_names: true)
+    end
+  end
+end

data/lib/graphlient/config.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Graphlient
+  module Config
+    extend self
+
+    attr_accessor :graphql_endpoint
+
+    def reset
+      self.graphql_endpoint = nil
+    end
+
+    reset
+  end
+
+  class << self
+    def configure
+      yield(Config) if block_given?
+      Config
+    end
+
+    def config
+      Config
+    end
+  end
+end

data/lib/graphlient/extension.rb

@@ -0,0 +1,15 @@
+module Graphlient
+  module Extension
+    module Query
+      def method_missing(m, *args, &block)
+        Graphlient::Query.new do
+          send(m, *args, &block)
+        end
+      end
+
+      def respond_to_missing?(m, include_private = false)
+        super
+      end
+    end
+  end
+end

data/lib/graphlient/query.rb

@@ -0,0 +1,50 @@
+module Graphlient
+  class Query
+    attr_accessor :query_str
+
+    def initialize(&block)
+      @indents = 0
+      @query_str = ''
+      instance_eval(&block)
+    end
+
+    def method_missing(m, *args, &block)
+      append(m, args, &block)
+    end
+
+    def respond_to_missing?(m, include_private = false)
+      super
+    end
+
+    def to_s
+      "{ #{query_str} }"
+    end
+
+    private
+
+    def append(query_field, args, &block)
+      # add field
+      @query_str << "\n#{indent}#{query_field}"
+      # add filter
+      @query_str << "(#{get_args_str(args)})" if args.any?
+
+      if block_given?
+        @indents += 1
+        @query_str << '{'
+        instance_eval(&block)
+        @query_str << '}'
+        @indents -= 1
+      end
+
+      @query_str << "\n#{indent}"
+    end
+
+    def indent
+      '  ' * @indents
+    end
+
+    def get_args_str(args)
+      args.detect { |arg| arg.is_a? Hash }.map { |k, v| "#{k}: #{v}" }.join(',')
+    end
+  end
+end

data/lib/graphlient/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Graphlient
+  VERSION = '0.0.3'
+end

data/lib/graphlient.rb

@@ -0,0 +1,5 @@
+require 'graphlient/version'
+require 'graphlient/config.rb'
+require 'graphlient/extension'
+require 'graphlient/query'
+require 'graphlient/client'

data/spec/graphlient/client_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Graphlient::Client do
+  describe '#query' do
+    let(:graphql_endpoint) { 'http://graph.biz/gprahql' }
+    let(:graphql_post_request) { stub_request(:post, 'http://graph.biz/gprahql').to_return(body: {}.to_json) }
+    before do
+      Graphlient.configure do |config|
+        config.graphql_endpoint = graphql_endpoint
+      end
+    end
+    it 'returns expected query with block' do
+      graphql_post_request
+      Graphlient::Client.query('Authorization' => 'Bearer 1231', 'Content-Type' => 'application/json') do
+        invoice(id: 10) do
+          line_items
+        end
+      end
+      expect(graphql_post_request.with(
+          body: { query: "{ \ninvoice(id: 10){\n  line_items\n  }\n }" },
+          headers: { 'Content-Type' => 'application/json'})
+      ).to have_been_made.once
+    end
+  end
+end

data/spec/graphlient/extension_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Graphlient::Extension::Query do
+  describe 'Query' do
+    include Graphlient::Extension::Query
+
+    it 'returns proper query' do
+      query = invoice(id: 10) do
+        line_items
+      end
+      expect( query.to_s ).to eq("{ \ninvoice(id: 10){\n  line_items\n  }\n }")
+    end
+  end
+end

data/spec/graphlient/query_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Graphlient::Query do
+  describe '#initialize' do
+    it 'returns expected query with block' do
+      query = Graphlient::Query.new do
+        invoice do
+          line_items
+        end
+      end
+      expect(query.to_s).to eq "{ \ninvoice{\n  line_items\n  }\n }"
+    end
+
+    it 'returns expected query with block and attributes' do
+      query = Graphlient::Query.new do
+        invoice(id: 10) do
+          line_items
+        end
+      end
+      expect(query.to_s).to eq "{ \ninvoice(id: 10){\n  line_items\n  }\n }"
+    end
+
+    it 'returns expected query with block and attributes' do
+      query = Graphlient::Query.new do
+        invoice(id: 10) do
+          line_items(name: 'test')
+        end
+      end
+      expect(query.to_s).to eq "{ \ninvoice(id: 10){\n  line_items(name: test)\n  }\n }"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'graphlient'
+require 'byebug'
+require 'webmock/rspec'
+
+RSpec.configure do |c|
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: graphlient
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Ashkan Nasseri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-04 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: ashkan.nasseri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- graphlient.gemspec
+- lib/graphlient.rb
+- lib/graphlient/client.rb
+- lib/graphlient/config.rb
+- lib/graphlient/extension.rb
+- lib/graphlient/query.rb
+- lib/graphlient/version.rb
+- spec/graphlient/client_spec.rb
+- spec/graphlient/extension_spec.rb
+- spec/graphlient/query_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ashkan18/graphlient
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby Gem for consuming GraphQL endpoints
+test_files: []