artemis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c44b0b7dd0ed93d3c8c64f8a63dbaae919c90a04eee6a476d83add0253ffbb39
+  data.tar.gz: f220a99f21d8bc7f24f1ae2dd1140f975707c6e26f74951e703a34edcdbd93c0
+SHA512:
+  metadata.gz: fc1ec085d1a695a683268067a5df8c63c8bc4aa5033527d458fc4cf5071e29bfc432ae8badeb132127d27703c5df384e5be8e2893c3335a9252d8a36abb193a0
+  data.tar.gz: ca037098da82ff0dbd97f0232319ecebb75714c455dc7ca0b59ea666ba465b3ccf9641b97e1f4390e29ba0a8e1c9f44ad3faa78df82293e68967deedfb063d54

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+gemfiles/*.lock

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--colour

data/.travis.yml

@@ -0,0 +1,36 @@
+nguage: ruby
+script: bundle exec rake
+cache:  bundler
+sudo:   false
+
+before_install: gem install bundler -v 1.16.1
+
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+  # - 2.2.10
+  - ruby-head
+  # - jruby-9.2.0.0
+  # - jruby-head
+
+gemfile:
+  - gemfiles/rails_52.gemfile
+  - gemfiles/rails_51.gemfile
+  - gemfiles/rails_50.gemfile
+  - gemfiles/rails_42.gemfile
+  - gemfiles/rails_edge.gemfile
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    # - rvm: jruby-9.2.0.0
+    # - rvm: jruby-head
+    - gemfile: gemfiles/rails_edge.gemfile
+  exclude:
+    - rvm: 2.3.7
+      gemfile: gemfiles/rails_edge.gemfile
+    # - rvm: 2.2.10
+      # gemfile: gemfiles/rails_52.gemfile
+    # - rvm: 2.2.10
+      # gemfile: gemfiles/rails_edge.gemfile

data/Appraisals

@@ -0,0 +1,32 @@
+appraise "rails_edge" do
+  git 'git://github.com/rails/rails.git' do
+    gem "rails"
+    gem "railties"
+    gem "activesupport"
+  end
+end
+
+appraise "rails_52" do
+  gem "rails", '~> 5.2'
+  gem "railties", '~> 5.2'
+  gem "activesupport", '~> 5.2'
+end
+
+appraise "rails_51" do
+  gem "rails", '~> 5.1'
+  gem "railties", '~> 5.1'
+  gem "activesupport", '~> 5.1'
+end
+
+appraise "rails_50" do
+  gem "rails", '~> 5.0'
+  gem "railties", '~> 5.0'
+  gem "activesupport", '~> 5.0'
+end
+
+appraise "rails_42" do
+  gem "rails", '~> 4.2'
+  gem "railties", '~> 4.2'
+  gem "activesupport", '~> 4.2'
+  gem "minitest", '5.10.3'
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yk.nishijima@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in artemis.gemspec
+gemspec
+
+gem 'rails'
+gem 'pry'
+gem 'pry-byebug', platforms: :mri

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Yuki Nishijima
+
+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,181 @@
+# Artemis [![Build Status](https://travis-ci.org/yuki24/artemis.svg?branch=master)](https://travis-ci.org/yuki24/artemis)
+
+ * **Convention over Configuration**: You'll never have to make trivial decisions or spend time on boring setup. Start
+  making a GraphQL request in literally 30sec.
+ * **Performant by default**: You can't do wrong when it comes to performance. All GraphQL files are pre-loaded only
+  once in production and it'll never affect runtime performance. Comes with options that enable persistent connections
+   and even HTTP/2.0, the next-gen high-performance protocol.
+
+### Getting started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'artemis'
+```
+
+And then execute:
+
+    $ bundle
+
+Once you run `bundle install` on your Rails app, you will be able to run the following command:
+
+
+```sh
+$ rails g artemis:install artsy https://metaphysics-production.artsy.net/
+```
+
+It is common that a GraphQL server requires an OAuth access token. If it is the case, use the `--authorization` option
+to assign a token so the installer can properly download the GraphQL schema for the service:
+
+```sh
+$ rails g artemis:install github https://api.github.com/graphql --authorization 'token ...'
+```
+
+## The convention
+
+Artemis assumes that the files related to GraphQL are organized with the following structure:
+
+```
+├──app/operations
+│   ├── artsy
+│   │   ├── _artist_fragment.graphql
+│   │   ├── artwork.graphql
+│   │   ├── artist.graphql
+│   │   └── artists.graphql
+│   └── artsy.rb
+├──config/graphql.yml
+└──vendor/graphql/schema/artsy.json
+```
+
+## Examples
+
+```yml
+# config/graphql.yml
+development:
+  artsy:
+    url: https://metaphysics-production.artsy.net/
+```
+
+```ruby
+# app/queries/artsy.rb
+class Artsy < Artemis::Client
+end
+```
+
+```graphql
+# app/queries/artsy/artwork.graphql
+query($id: String!) {
+  artwork(id: $id) {
+    title
+  }
+}
+
+# app/queries/artsy/me.graphql
+query {
+  me {
+    name
+  }
+}
+```
+
+```ruby
+results = Artsy.artwork(id: "andy-warhol-john-wayne-1986-number-377-cowboys-and-indians")
+results.data
+# => {
+#      "data": {
+#        "artwork": {
+#          "title": "John Wayne, 1986 (#377, Cowboys & Indians)"
+#        }
+#      }
+#    }
+
+results = Artsy.with_context(headers: { "X-ACCESS-TOKEN": "..." }).me
+results.data
+# => {
+#      "data": {
+#        "me": {
+#          "name": "Yuki Nishijima"
+#        }
+#      }
+#    }
+```
+
+## Callbacks
+
+Youcan use the `before_execute` callback to intercept outgoing requests and the `after_execute` callback to observe the
+response. A common operation that's done in the `before_execute` hook is assigning a token to the header:
+
+```ruby
+class Artsy < Artemis::Client
+  before_execute do |document, operation_name, variables, context|
+    context[:headers] = {
+      Authorization: "token ..."
+    }
+  end
+end
+```
+
+Here the `:headers` key is a special context type. The hash object assigned to the `context[:headers]` will be sent as
+the HTTP headers of the request.
+
+Another common thing when receiving a response is to check if there's any error in the response and throw and error
+accordingly:
+
+```ruby
+class Artsy < Artemis::Client
+  after_execute do |data, errors, extensions|
+    raise "GraphQL error: #{errors.to_json}" if errors.present?
+  end
+end
+```
+
+## Configuration
+
+You can configure the GraphQL client using the following options. Those configurations are found in the
+`config/graphql.yml`.
+
+| Name          | Required? | Default     | Description |
+| ------------- | --------- | ------------| ----------- |
+| `adapter`     | No        | `:net_http` | The underlying client library that actually makes an HTTP request. See Adapters for available options.
+| `pool_size`   | No        | 25          | The number of keep-alive connections. The `:net_http` adapter will ignore this option.
+| `schema_path` | No        | See above   | The path to the GrapQL schema. Setting an empty value to this will force the client to download the schema upon the first request.
+| `timeout`     | No        | 10          | HTTP timeout set for the adapter in seconds. This will be set to both `read_timeout` and `write_timeout` and there is no way to configure them with a different value as of writing (PRs welcome!)
+| `url`         | Yes       | N/A         | The URL for the GraphQL endpoint.
+
+### Adapters
+
+There are four adapter options available. Choose the adapter that best fits on your use case.
+
+| Adapter                | Protocol                 | Keep-alive  | Performance | Dependencies |
+| ---------------------- | ------------------------ | ----------- | ----------- | ------------ |
+| `:curb`                | HTTP/1.1, **HTTP/2.0**   | **Yes**     | **Fastest** | [`curb 0.9.6+`](curb)<br>[`libcurl 7.64.0+`](curl)<br>[`nghttp2 1.0.0+`](nghttp)
+| `:net_http` (default)  | HTTP/1.1 only            | No          | Slow        | **None**
+| `:net_http_persistent` | HTTP/1.1 only            | **Yes**     | **Fast**    | [`net-http-persistent 3.0.0+`](nhp)
+| `:test`                | N/A (See Testing)
+
+## Testing
+
+**The testing support is incomplete, but there are some examples [available in Artemis' client spec](https://github.com/yuki24/artemis/blob/74095f3acb050e87251439aed5f8b17778ffdd06/spec/client_spec.rb#L36-L54).**
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/yuki24/artemis. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Artemis project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/artemis/blob/master/CODE_OF_CONDUCT.md).
+
+[curl]: https://curl.haxx.se/docs/http2.html
+[nghttp]: https://nghttp2.org/
+[nhp]: https://rubygems.org/gems/net-http-persistent

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rspec/core/rake_task'
+
+Rake::TestTask.new('test:isolated') do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning    = false
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: ['spec', 'test:isolated']

data/artemis.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "artemis/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "artemis"
+  spec.version       = Artemis::VERSION
+  spec.authors       = ["Yuki Nishijima"]
+  spec.email         = ["yk.nishijima@gmail.com"]
+  spec.summary       = %q{GraphQL on Rails}
+  spec.description   = %q{GraphQL client on Rails + Convention over Configuration = ❤️}
+  spec.homepage      = "https://github.com/yuki24/artemis"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 4.2.0"
+  spec.add_dependency "graphql-client", ">= 0.13.0"
+  spec.add_dependency "railties", ">= 4.2.0"
+
+  spec.add_development_dependency "appraisal", "~> 2.2"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "curb", "~> 0.9.6"
+  spec.add_development_dependency "net-http-persistent", "~> 3.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "artemis"
+
+# 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
+
+require "irb"
+IRB.start(__FILE__)

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