graphlient 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1adef5ff2cf8488f33f2decb2242192aa29654c
-  data.tar.gz: 85c4b69d0f9a9d4cd49cba7aff1cdeeb23d6fcaf
+  metadata.gz: e63b47be656ea6f5f875fd9b4787190e01229e52
+  data.tar.gz: 563ac147a12a4329fb94c657546ef24509fa35db
 SHA512:
-  metadata.gz: e461cb4260672b0ac960b7673a7133aa8131361a5a590c6bc5bf5bf65a378c7dd2bd3d8ae40983e6e7ca702039418525c02204fd6961fd06bd6bcf833ed499a3
-  data.tar.gz: 04b967185ca939bc62c7fc3cfc61d721e59c1491965fa803e6fbd850a2cef79c1ed67491089b1a0bd421f9fdd44e2e7a9743e51b78e1b4704ceb92b630c45428
+  metadata.gz: eba95816c8c386c519d774ee5fbb668ec2d78d7f0bb0177da8ba5941cb033b0f5d14da0845d291d2033ce4bcf45d34db4e3a5918a67afa8585f1f1b232c17ed4
+  data.tar.gz: 2caa1b128e9f8095310ddfca72ef13fe84225b2083f3ae2eead234c9604e97eb25abf51ba5c77ebf50070ff3ccfb4d2b170ff49a95b4060b227b5967323a8b94

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,47 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-10-04 14:22:21 -0400 using RuboCop version 0.47.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
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 38
+
+# Offense count: 5
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 135
+
+# Offense count: 6
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/graphlient/client.rb'
+    - 'lib/graphlient/config.rb'
+    - 'lib/graphlient/errors/http.rb'
+    - 'lib/graphlient/extensions/query.rb'
+    - 'lib/graphlient/query.rb'
+
+# Offense count: 2
+Style/MethodMissing:
+  Exclude:
+    - 'lib/graphlient/extensions/query.rb'
+    - 'lib/graphlient/query.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: module_function, extend_self
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/graphlient/config.rb'
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'spec/graphlient/client_spec.rb'

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+### 0.0.4 (10/4/2017)
+
+* [#8](https://github.com/ashkan18/graphlient/pull/8): Handle HTTP errors and raise `Graphlient::Errors::HTTP` on failure - [@dblock](https://github.com/dblock).
+* [#5](https://github.com/ashkan18/graphlient/pull/5): Added RuboCop, Ruby-style linter, CHANGELOG, CONTRIBUTING and RELEASING - [@dblock](https://github.com/dblock).
+* [#4](https://github.com/ashkan18/graphlient/pull/4): Refactored Graphlient::Client to take a URL and options, moved extensions - [@dblock](https://github.com/dblock).
+
+### 0.0.3 (10/3/2017)
+
+* Initial public release - [@ashkan18](https://github.com/ashkan18).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to Graphlient
+
+This project is work of [many contributors](https://github.com/ashkan18/graphlient/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/ashkan18/graphlient/pulls), [propose features and discuss issues](https://github.com/ashkan18/graphlient/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+### Fork the Project
+
+Fork the [project on Github](https://github.com/ashkan18/graphlient) and check out your copy.
+
+```
+git clone https://github.com/contributor/graphlient.git
+cd graphlient
+git remote add upstream https://github.com/ashkan18/graphlient.git
+```
+
+### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Contribute Code
+
+### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+
+Make sure that `bundle exec rake` completes without errors.
+
+### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
+
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
+
+### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+### Push
+
+```
+git push origin my-feature-branch
+```
+
+### Make a Pull Request
+
+Go to https://github.com/contributor/graphlient and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/ashkan18/graphlient/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphlient (0.0.3)
+    graphlient (0.0.4)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -1,32 +1,34 @@
-# Graphlient ![](https://travis-ci.org/ashkan18/graphlient.svg?branch=master)
-Ruby Client for consuming GraphQL based APIs.
+# Graphlient
 
-## Installation
-Add following line to your Gemfile
+[![Gem Version](https://badge.fury.io/rb/graphlient.svg)](https://badge.fury.io/rb/graphlient)
+[![Build Status](https://travis-ci.org/ashkan18/graphlient.svg?branch=master)](https://travis-ci.org/ashkan18/graphlient)
 
-```ruby
-gem 'graphlient'
-```
+A Ruby Client for consuming GraphQL-based APIs.
 
-## Configuration
+## Installation
 
-Add `graphlient.rb under config/initializers. You can use this config to setup `graphql_endpoint`. Here is a sample of configuration:
+Add the following line to your Gemfile.
 
 ```ruby
-# config/initializers/graphlient.rb
-Graphlient.configure do |config|
-  config.graphql_endpoint = 'http://test-graphql.biz/graphql'  # target GraphQL endpoint
-end
+gem 'graphlient'
 ```
 
 ## Usage
-There are 3 different usages.
+
+There are 3 different ways to use this library.
 
 ### Graphlient::Client
-After configuring the client, you can use the client by passing the query in a block.
+
+Create a new instance of `Graphlient::Client` and pass the query into a block.
 
 ```ruby
-response = Graphlient::Client.query(headers: { 'Authorization' => 'Bearer 123'}) do
+client = Graphlient::Client.new('https://test-graphql.biz/graphql',
+  headers: {
+    'Authorization' => 'Bearer 123'
+  }
+)
+
+response = client.query do
   invoice(id: 10) do
     id
     total
@@ -38,21 +40,27 @@ response = Graphlient::Client.query(headers: { 'Authorization' => 'Bearer 123'})
 end
 ```
 
-This will call the endpoint setup in the configuration with `POST` and passes `query` as
+This will call the endpoint setup in the configuration with `POST`, the `Authorization` header and `query` as
+
 ```graphql
 invoice(id: 10) {
   id
   total
-  line_items{
+  line_items {
     price
     item_type
   }
 }
 ```
-It also sets the `Authorization` header based on passed in data.
+
+A successful response is a JSON object.
+
+On failure the client raises `Graphlient::Errors::HTTP` which contains the `response` object.
 
 ### Use Graphlient::Query directly
+
 You can directly use `Graphlient::Query` to generate GraphQL queries. Example:
+
 ```ruby
 query = Graphlient::Query.new do
   query do
@@ -67,10 +75,12 @@ query.to_s
 ```
 
 ### 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.
+
+You can include `Graphlient::Extensions::Query` in your class. This will add a new `method_missing` method to your context which will be used to generate GraphQL queries.
 
 ```ruby
-include Graphlient::Extension::Query
+include Graphlient::Extensions::Query
+
 query = invoice(id: 10) do
   line_items
 end
@@ -78,3 +88,7 @@ end
 query.to_s
 # "\nquery{\n  invoice(id: 10){\n    line_items\n    }\n  }\n"
 ```
+
+## License
+
+MIT License, see [LICENSE](LICENSE)

data/RELEASING.md

@@ -0,0 +1,61 @@
+# Releasing Graphlient
+
+There're no hard rules about when to release graphlient. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/graphlient) for all supported platforms.
+
+Change next release in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.2.2 (7/10/2015)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add README.md CHANGELOG.md
+git commit -m "Preparing for release, 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+graphlient 0.2.2 built to pkg/graphlient-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed graphlient 0.2.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.2.3 (Next)
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/graphlient/version.rb](lib/graphlient/version.rb). Usually the major version is incremented during the development cycle when the release contains major features or breaking API changes (eg. change `0.2.1` to `0.3.0`).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/graphlient/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```

data/Rakefile

@@ -9,4 +9,7 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task default: :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/graphlient.gemspec

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 
 require 'graphlient/version'
@@ -14,5 +13,5 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.homepage = 'http://github.com/ashkan18/graphlient'
   s.licenses = ['MIT']
-  s.summary = "Ruby Gem for consuming GraphQL endpoints"
-end
+  s.summary = 'Ruby Gem for consuming GraphQL endpoints'
+end

data/lib/graphlient/client.rb

@@ -1,22 +1,37 @@
-require 'net/http'
-require 'uri'
-require 'json'
-
 module Graphlient
-  module Client
-    def self.query(headers = {}, &block)
+  class Client
+    attr_reader :uri
+    attr_reader :options
+
+    def initialize(url, options = {})
+      @uri = URI(url)
+      @options = options.dup
+    end
+
+    def query(&block)
       query = Graphlient::Query.new do
         instance_eval(&block)
       end
-      uri = URI(Graphlient.config.graphql_endpoint)
-      http = Net::HTTP.new(uri.host, uri.port)
+      response = post(query)
+      raise Graphlient::Errors::HTTP.new(response.message, response) unless response.is_a? Net::HTTPSuccess
+      parse(response.body)
+    end
+
+    def connection
+      @connection ||= Net::HTTP.new(uri.host, uri.port)
+    end
+
+    def post(query)
       request = Net::HTTP::Post.new(uri.request_uri)
       request.body = { query: query.to_s }.to_json
-      headers.each do |k, v|
+      options[:headers].each do |k, v|
         request[k] = v
       end
-      response = http.request(request)
-      JSON.parse(response.body, symbolize_names: true)
+      connection.request(request)
+    end
+
+    def parse(response)
+      JSON.parse(response, symbolize_names: true)
     end
   end
 end

data/lib/graphlient/config.rb

@@ -1,14 +1,9 @@
-# frozen_string_literal: true
 
 module Graphlient
   module Config
     extend self
 
-    attr_accessor :graphql_endpoint
-
-    def reset
-      self.graphql_endpoint = nil
-    end
+    def reset; end
 
     reset
   end

data/lib/graphlient/errors/error.rb

@@ -0,0 +1,6 @@
+module Graphlient
+  module Errors
+    class Error < StandardError
+    end
+  end
+end

data/lib/graphlient/errors/http.rb

@@ -0,0 +1,12 @@
+module Graphlient
+  module Errors
+    class HTTP < Error
+      attr_reader :response
+
+      def initialize(message, response = nil)
+        @response = response
+        super message
+      end
+    end
+  end
+end

data/lib/graphlient/errors.rb

@@ -0,0 +1,2 @@
+require_relative 'errors/error'
+require_relative 'errors/http'

data/lib/graphlient/{extension.rb → extensions/query.rb}

@@ -1,5 +1,5 @@
 module Graphlient
-  module Extension
+  module Extensions
     module Query
       def method_missing(m, *args, &block)
         Graphlient::Query.new do

data/lib/graphlient/extensions.rb

@@ -0,0 +1 @@
+require_relative 'extensions/query'

data/lib/graphlient/version.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 module Graphlient
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'.freeze
 end

data/lib/graphlient.rb

@@ -1,5 +1,10 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
 require 'graphlient/version'
 require 'graphlient/config.rb'
-require 'graphlient/extension'
+require 'graphlient/extensions'
+require 'graphlient/errors'
 require 'graphlient/query'
 require 'graphlient/client'

data/spec/graphlient/client_spec.rb

@@ -1,26 +1,42 @@
-# frozen_string_literal: true
 require 'spec_helper'
 
 describe Graphlient::Client do
+  let(:graphql_endpoint) { 'http://graph.biz/gprahql' }
+  let(:request_headers) do
+    {
+      'Authorization' => 'Bearer 1231',
+      'Content-Type' => 'application/json'
+    }
+  end
+  let(:graphql_client) { Graphlient::Client.new(graphql_endpoint, headers: request_headers) }
   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
+    let(:response) do
+      graphql_client.query 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
+    describe 'success' do
+      let!(:graphql_post_request) { stub_request(:post, 'http://graph.biz/gprahql').to_return(body: {}.to_json) }
+      it 'returns expected query with block' do
+        expect(response).to eq({})
+        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
+    describe 'failure' do
+      let!(:graphql_post_request) { stub_request(:post, 'http://graph.biz/gprahql').to_return(status: [500, 'Internal Server Error']) }
+      it 'fails with an exception' do
+        expect do
+          response
+        end.to raise_error Graphlient::Errors::HTTP do |e|
+          expect(e.to_s).to eq 'Internal Server Error'
+          expect(e.response.code.to_i).to eq 500
+        end
+      end
     end
   end
 end

data/spec/graphlient/extensions/query_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Graphlient::Extensions::Query do
+  describe 'Query' do
+    include Graphlient::Extensions::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

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 require 'spec_helper'
 
 describe Graphlient::Query do

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rubygems'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphlient
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ashkan Nasseri
@@ -19,22 +19,31 @@ files:
 - ".byebug_history"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
+- RELEASING.md
 - Rakefile
 - graphlient.gemspec
 - lib/graphlient.rb
 - lib/graphlient/client.rb
 - lib/graphlient/config.rb
-- lib/graphlient/extension.rb
+- lib/graphlient/errors.rb
+- lib/graphlient/errors/error.rb
+- lib/graphlient/errors/http.rb
+- lib/graphlient/extensions.rb
+- lib/graphlient/extensions/query.rb
 - lib/graphlient/query.rb
 - lib/graphlient/version.rb
 - spec/graphlient/client_spec.rb
-- spec/graphlient/extension_spec.rb
+- spec/graphlient/extensions/query_spec.rb
 - spec/graphlient/query_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ashkan18/graphlient
@@ -57,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for consuming GraphQL endpoints

data/spec/graphlient/extension_spec.rb

@@ -1,15 +0,0 @@
-# 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