artemis 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c44b0b7dd0ed93d3c8c64f8a63dbaae919c90a04eee6a476d83add0253ffbb39
-  data.tar.gz: f220a99f21d8bc7f24f1ae2dd1140f975707c6e26f74951e703a34edcdbd93c0
+  metadata.gz: ac727e89f6d2c0845b888ea9eeb526bf2607689fa268c9f815b9af3c25c83d72
+  data.tar.gz: 1cb2c9c3de64e95b729f579dfb4a8bd93a07d6ac4732647bf7aa94a360a6624a
 SHA512:
-  metadata.gz: fc1ec085d1a695a683268067a5df8c63c8bc4aa5033527d458fc4cf5071e29bfc432ae8badeb132127d27703c5df384e5be8e2893c3335a9252d8a36abb193a0
-  data.tar.gz: ca037098da82ff0dbd97f0232319ecebb75714c455dc7ca0b59ea666ba465b3ccf9641b97e1f4390e29ba0a8e1c9f44ad3faa78df82293e68967deedfb063d54
+  metadata.gz: 041b006e10af9271e6cb024f2acfdc1597969ad44ccf371235a12f95c2464afac66110967db926ece6df3c46c3161b3b3f54436ea276b0362234c27f13e5933e
+  data.tar.gz: 0daaea8bebcbf4ea6c9225781f591b4cd069aa6517dacb09043500b29357c1140d4169ed00e55046003702489addbfea60ef7703bc607692186ef61c7d94c0ac

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## Unreleased
+
+ * Add a new entry here
+ * [#43](https://github.com/yuki24/artemis/pull/43): Keep persistent connections open for 30 minutes
+ * [#42](https://github.com/yuki24/artemis/pull/42): Allow for setting up the test adapter without `url`
+ * [#41](https://github.com/yuki24/artemis/pull/41): Add a mutation generator
+ * [#40](https://github.com/yuki24/artemis/pull/40): Add a query generator
+ * [#39](https://github.com/yuki24/artemis/pull/39): Installer now adds a new service if config/graphql.yml is present
+
+## [v0.1.0: First release!](https://github.com/yuki24/artemis/tree/v0.1.0)
+
+_<sup>released at 2018-10-16 20:57:51 UTC</sup>_
+
+First release of Artemis! <g-emoji class="g-emoji" alias="tada" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f389.png">&#127881;</g-emoji>
+

data/README.md

@@ -6,7 +6,9 @@
   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
+<img width="24" height="24" src="https://avatars1.githubusercontent.com/u/541332?s=48&amp;v=4"> Battled-tested at [Artsy](https://www.artsy.net)
+
+## Getting started
 
 Add this line to your application's Gemfile:
 
@@ -18,87 +20,72 @@ And then execute:
 
     $ bundle
 
-Once you run `bundle install` on your Rails app, you will be able to run the following command:
+Once you run `bundle install` on your Rails app, run the install 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:
+You could also use the `--authorization` option to assign a token so the installer can download the GraphQL schema:
 
 ```sh
 $ rails g artemis:install github https://api.github.com/graphql --authorization 'token ...'
 ```
 
-## The convention
+### Generating your first query
 
-Artemis assumes that the files related to GraphQL are organized with the following structure:
+Artemis comes with a query generator. For exmaple, you could use the query generator to generate a query stub for `artist`:
 
-```
-├──app/operations
-│   ├── artsy
-│   │   ├── _artist_fragment.graphql
-│   │   ├── artwork.graphql
-│   │   ├── artist.graphql
-│   │   └── artists.graphql
-│   └── artsy.rb
-├──config/graphql.yml
-└──vendor/graphql/schema/artsy.json
+```sh
+$ rails g artemis:query artist
 ```
 
-## Examples
+Then this will generate:
 
-```yml
-# config/graphql.yml
-development:
-  artsy:
-    url: https://metaphysics-production.artsy.net/
+```graphql
+# app/operations/artist.graphql
+query($id: String!) {
+  artist(id: $id) {
+    # Add fields here...
+  }
+}
 ```
 
+Then you could the class method that has the matching name `artist`:
+
 ```ruby
-# app/queries/artsy.rb
-class Artsy < Artemis::Client
-end
+Artsy.artist(id: "pablo-picasso")
+# => makes a GraphQL query that's in app/operations/artist.graphql
 ```
 
-```graphql
-# app/queries/artsy/artwork.graphql
-query($id: String!) {
-  artwork(id: $id) {
-    title
-  }
-}
+You can also specify a file name:
 
-# app/queries/artsy/me.graphql
-query {
-  me {
-    name
-  }
-}
+```sh
+$ rails g artemis:query artist artist_details_on_artwork
+# => generates app/operations/artist_details_on_artwork.graphql
 ```
 
+Then you can make a query in `artist_details_on_artwork.graphql` with:
+
 ```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"
-#        }
-#      }
-#    }
+Artsy.artist_details_on_artwork(id: "pablo-picasso")
+```
+
+## The convention
+
+Artemis assumes that the files related to GraphQL are organized in a certain way. For example, a service that talks to Artsy's GraphQL API could have 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
 ```
 
 ## Callbacks
@@ -149,11 +136,20 @@ There are four adapter options available. Choose the adapter that best fits on y
 
 | 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)
+| `: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)
+| `:net_http_persistent` | HTTP/1.1 only            | **Yes**     | **Fast**    | [`net-http-persistent 3.0.0+`][nhp]
 | `:test`                | N/A (See Testing)
 
+## Rake tasks
+
+Artemis also adds a useful `rake graphql:schema:update` rake task that downloads the GraphQL schema using the
+`Introspection` query.
+
+| Task Name                    | Options   | Description |
+| ---------------------------- | --------- | ------------|
+| `graphql:schema:update` | `SERVICE`: Service name the schema is downloaded from<br>`AUTHORIZATION`: HTTTP `Authroization` header value used to download the schema| Downloads and saves the GraphQL schema
+
 ## 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).**
@@ -176,6 +172,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 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).
 
+[curb]: https://rubygems.org/gems/curb
 [curl]: https://curl.haxx.se/docs/http2.html
 [nghttp]: https://nghttp2.org/
 [nhp]: https://rubygems.org/gems/net-http-persistent

data/Rakefile

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

data/artemis.gemspec

@@ -6,8 +6,8 @@ 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.authors       = ["Jon Allured", "Yuki Nishijima"]
+  spec.email         = ["jon.allured@gmail.com", "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"

data/lib/artemis/adapters/abstract_adapter.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/object/blank'
 require 'graphql/client/http'
 
 module Artemis
@@ -10,6 +11,8 @@ module Artemis
       EMPTY_HEADERS = {}.freeze
 
       def initialize(uri, service_name: , timeout: , pool_size: )
+        raise ArgumentError, "url is required (given `#{uri.inspect}')" if uri.blank?
+
         super(uri) # Do not pass in the block to avoid getting #headers and #connection overridden.
 
         @service_name = service_name.to_s

data/lib/artemis/adapters/net_http_persistent_adapter.rb

@@ -2,6 +2,7 @@
 
 require 'delegate'
 
+require 'active_support/core_ext/numeric/time'
 require 'net/http/persistent'
 
 require 'artemis/adapters/net_http_adapter'
@@ -17,6 +18,7 @@ module Artemis
         @raw_connection = Net::HTTP::Persistent.new(name: service_name, pool_size: pool_size)
         @raw_connection.open_timeout = timeout
         @raw_connection.read_timeout = timeout
+        @raw_connection.idle_timeout = 30.minutes.to_i # TODO: Make it configurable
 
         @_connection = ConnectionWrapper.new(@raw_connection, uri)
       end
@@ -28,7 +30,7 @@ module Artemis
         _connection
       end
 
-      class ConnectionWrapper < SimpleDelegator
+      class ConnectionWrapper < SimpleDelegator #:nodoc:
         def initialize(obj, url)
           super(obj)
 

data/lib/artemis/client.rb

@@ -44,13 +44,13 @@ module Artemis
     #   }
     #
     #   # app/operations/github.rb
-    #   class GitHub < Artemis::Client
+    #   class Github < Artemis::Client
     #   end
     #
-    #   github = GitHub.new
+    #   github = Github.new
     #   github.user(id: 'yuki24').data.user.name # => "Yuki Nishijima"
     #
-    #   github = GitHub.new(context: { headers: { Authorization: "bearer ..." } })
+    #   github = Github.new(context: { headers: { Authorization: "bearer ..." } })
     #   github.user(id: 'yuki24').data.user.name # => "Yuki Nishijima"
     #
     def initialize(context = {})
@@ -60,12 +60,65 @@ module Artemis
     class << self
       delegate :query_paths, :default_context, :query_paths=, :default_context=, to: :config
 
+      # Creates a new instance of the GraphQL client for the service.
+      #
+      #   # app/operations/github/user.graphql
+      #   query($id: String!) {
+      #     user(login: $id) {
+      #       name
+      #     }
+      #   }
+      #
+      #   # app/operations/github.rb
+      #   class Github < Artemis::Client
+      #   end
+      #
+      #   github = Github.new
+      #   github.user(id: 'yuki24').data.user.name # => "Yuki Nishijima"
+      #
+      #   github = Github.new(context: { headers: { Authorization: "bearer ..." } })
+      #   github.user(id: 'yuki24').data.user.name # => "Yuki Nishijima"
+      #
       alias with_context new
 
+      # Returns the registered meta data (generally present in +config/graphql.yml+) for the client.
+      #
+      #   # config/graphql.yml
+      #   development:
+      #     github:
+      #       url:     https://api.github.com/graphql
+      #       adapter: :net_http
+      #
+      #   # app/operations/github.rb
+      #   class Github < Artemis::Client
+      #   end
+      #
+      #   Github.endpoint.url     # => "https://api.github.com/graphql"
+      #   Github.endpoint.adapter # => :net_http
+      #
       def endpoint
         Artemis::GraphQLEndpoint.lookup(name)
       end
 
+      # Instantiates a new instance of +GraphQL::Client+ for the service.
+      #
+      #   # app/operations/github/user.graphql
+      #   query($id: String!) {
+      #     user(login: $id) {
+      #       name
+      #     }
+      #   }
+      #
+      #   # app/operations/github.rb
+      #   class Github < Artemis::Client
+      #   end
+      #
+      #   client = Github.instantiate_client
+      #   client.query(Github::User, arguments: { id: 'yuki24' }) # makes a Graphql request
+      #
+      #   client = Github.instantiate_client(context: { headers: { Authorization: "bearer ..." } })
+      #   client.query(Github::User, arguments: { id: 'yuki24' }) # makes a Graphql request with Authorization header
+      #
       def instantiate_client(context = {})
         ::GraphQL::Client.new(schema: endpoint.schema, execute: connection(context))
       end
@@ -73,7 +126,7 @@ module Artemis
       # Defines a callback that will get called right before the
       # client's execute method is executed.
       #
-      #   class GitHub < Artemis::Client
+      #   class Github < Artemis::Client
       #
       #     before_execute do |document, operation_name, variables, context|
       #       Analytics.log(operation_name, variables, context[:user_id])
@@ -89,7 +142,7 @@ module Artemis
       # Defines a callback that will get called right after the
       # client's execute method has finished.
       #
-      #   class GitHub < Artemis::Client
+      #   class Github < Artemis::Client
       #
       #     after_execute do |data, errors, extensions|
       #       if errors.present?
@@ -136,7 +189,6 @@ module Artemis
       end
       alias load_query load_constant
 
-      # @api private
       def connection(context = {})
         Executor.new(endpoint.connection, callbacks, default_context.deep_merge(context))
       end
@@ -157,15 +209,12 @@ module Artemis
         end
       end
 
-      # @api private
-      def respond_to_missing?(method_name, *_, &block)
+      def respond_to_missing?(method_name, *_, &block) #:nodoc:
         resolve_graphql_file_path(method_name) || super
       end
 
-      Callbacks = Struct.new(:before_callbacks, :after_callbacks)
-
-      private_constant :Callbacks
-
+      # Returns a +Callbacks+ collection object that implements the interface for the +Executor+ object.
+      #
       # @api private
       def callbacks
         Callbacks.new(config.before_callbacks, config.after_callbacks)
@@ -194,8 +243,7 @@ module Artemis
       end
     end
 
-    # @api private
-    def respond_to_missing?(method_name, *_, &block)
+    def respond_to_missing?(method_name, *_, &block) #:nodoc:
       self.class.resolve_graphql_file_path(method_name) || super
     end
 
@@ -213,33 +261,40 @@ module Artemis
         end
       RUBY
     end
-  end
 
-  # @api private
-  class Executor < SimpleDelegator
-    def initialize(connection, callbacks, default_context)
-      super(connection)
-
-      @callbacks = callbacks
-      @default_context = default_context
-    end
+    # Internal collection object that holds references to the callback blocks.
+    #
+    # @api private
+    Callbacks = Struct.new(:before_callbacks, :after_callbacks) #:nodoc:
 
-    def execute(document:, operation_name: nil, variables: {}, context: {})
-      _context = @default_context.deep_merge(context)
+    # Wrapper object around the adapter that wires up callbacks.
+    #
+    # @api private
+    class Executor < SimpleDelegator
+      def initialize(connection, callbacks, default_context) #:nodoc:
+        super(connection)
 
-      @callbacks.before_callbacks.each do |callback|
-        callback.call(document, operation_name, variables, _context)
+        @callbacks = callbacks
+        @default_context = default_context
       end
 
-      response = __getobj__.execute(document: document, operation_name: operation_name, variables: variables, context: _context)
+      def execute(document:, operation_name: nil, variables: {}, context: {}) #:nodoc:
+        _context = @default_context.deep_merge(context)
 
-      @callbacks.after_callbacks.each do |callback|
-        callback.call(response['data'], response['errors'], response['extensions'])
-      end
+        @callbacks.before_callbacks.each do |callback|
+          callback.call(document, operation_name, variables, _context)
+        end
 
-      response
+        response = __getobj__.execute(document: document, operation_name: operation_name, variables: variables, context: _context)
+
+        @callbacks.after_callbacks.each do |callback|
+          callback.call(response['data'], response['errors'], response['extensions'])
+        end
+
+        response
+      end
     end
-  end
 
-  private_constant :Executor
+    private_constant :Callbacks, :Executor
+  end
 end

data/lib/artemis/graphql_endpoint.rb

@@ -27,11 +27,18 @@ module Artemis
       def register!(service_name, configurations)
         ENDPOINT_INSTANCES[service_name.to_s.underscore] = new(service_name.to_s, configurations.symbolize_keys)
       end
+
+      ##
+      # Returns the registered services as an array.
+      #
+      def registered_services
+        ENDPOINT_INSTANCES.keys
+      end
     end
 
     attr_reader :name, :url, :adapter, :timeout, :schema_path, :pool_size
 
-    def initialize(name, url: , adapter: :net_http, timeout: 30, schema_path: nil, pool_size: 5)
+    def initialize(name, url: nil, adapter: :net_http, timeout: 10, schema_path: nil, pool_size: 25)
       @name, @url, @adapter, @timeout, @schema_path, @pool_size = name.to_s, url, adapter, timeout, schema_path, pool_size
 
       @mutex_for_schema     = Mutex.new

data/lib/artemis/version.rb

@@ -1,3 +1,3 @@
 module Artemis
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/generators/artemis/{USAGE → install/USAGE}

@@ -2,7 +2,7 @@ Description:
     Generates a client stub and config files and downloads the schema from the given endpoint.
 
 Example:
-    rails generate install Artsy https://metaphysics-production.artsy.net
+    rails generate artemis:install Artsy https://metaphysics-production.artsy.net
 
     This will create:
         app/operations/artsy.rb

data/lib/generators/artemis/{install_generator.rb → install/install_generator.rb}

@@ -17,6 +17,24 @@ class Artemis::InstallGenerator < Rails::Generators::NamedBase
     in_root do
       if behavior == :invoke && !File.exist?(config_file_name)
         template "graphql.yml", config_file_name
+      else
+        inject_into_file config_file_name, <<-YAML, after: "development:\n"
+  #{file_name}:
+    <<: *default
+    url: #{endpoint_url}\n
+YAML
+
+        inject_into_file config_file_name, <<-YAML, after: "test:\n", force: true
+  #{file_name}:
+    <<: *default
+    url: #{endpoint_url}\n
+YAML
+
+        inject_into_file config_file_name, <<-YAML, after: "production:\n", force: true
+  #{file_name}:
+    <<: *default
+    url: #{endpoint_url}\n
+YAML
       end
     end
   end

data/lib/generators/artemis/install/templates/graphql.yml

@@ -0,0 +1,34 @@
+default: &default
+  # The underlying client library that actually makes an HTTP request.
+  # Available adapters are :net_http, :net_http_persistent, :curb, and :test.
+  #
+  # It is set to :net_http by default.
+  adapter: :net_http
+
+  # 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!)
+  #
+  # It is set to 10 by default.
+  timeout: 10
+
+  # The number of keep-alive connections. The `:net_http` adapter will ignore
+  # this option.
+  #
+  # It is set to 25 by default.
+  pool_size: 25
+
+development:
+  <%= file_name %>:
+    <<: *default
+    url: <%= endpoint_url %>
+
+test:
+  <%= file_name %>:
+    <<: *default
+    url: <%= endpoint_url %>
+
+production:
+  <%= file_name %>:
+    <<: *default
+    url: <%= endpoint_url %>

data/lib/generators/artemis/mutation/USAGE

@@ -0,0 +1,27 @@
+Description:
+    Generates a mutation stub.
+
+    rails g artemis:mutation MUTATION_TYPE [FILE_NAME]
+
+Example:
+    rails g artemis:mutation followArtist
+
+    This will create:
+        app/operations/artsy.rb
+        app/operations/artsy/follow_artist.graphql
+
+    The GraphQL file name could be specified by giving the third argument:
+
+      rails g artemis:mutation followArtist follow_artist_on_artwork
+
+    This will create:
+        app/operations/artsy.rb
+        app/operations/artsy/follow_artist_on_artwork.graphql
+
+    If there are multiple services registered, the service could be specified with +--service+ option:
+
+       rails g artemis:mutation createProject --service github
+
+    This will create:
+        app/operations/github.rb
+        app/operations/github/create_project.graphql

data/lib/generators/artemis/mutation/mutation_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'graphql/schema/finder'
+
+class Artemis::MutationGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :mutation_type,     type: :string, required: true,                banner: "Mutation type"
+  argument :graphql_file_name, type: :string, required: false, default: nil, banner: "The name of the GraphQL file to be generated"
+
+  class_option :service, type: :string, default: nil, aliases: "-A"
+
+  def generate_mutation_file
+    template "mutation.graphql", graphql_file_path
+  end
+
+  private
+
+  def mutation_name
+    mutation_type.underscore
+  end
+
+  def graphql_file_path
+    "app/operations/#{service_name.underscore}/#{graphql_file_name.presence || mutation_name}.graphql"
+  end
+
+  def arguments
+    target_mutation.arguments
+  end
+
+  def target_mutation
+    schema.find("Mutation").fields[mutation_type] ||
+      raise(GraphQL::Schema::Finder::MemberNotFoundError, "Could not find type `#{mutation_type}` in schema.")
+  end
+
+  def schema
+    service_name.camelize.constantize.endpoint.schema
+  end
+
+  def service_name
+    options['service'].presence || begin
+      services = Artemis::GraphQLEndpoint.registered_services
+
+      if services.size == 1
+        services.first
+      else
+        fail "Please specify a service name (available services: #{services.join(", ")}):\n\n" \
+             "  rails g artemis:mutation #{mutation_type} #{graphql_file_name} --service SERVICE"
+      end
+    end
+  end
+end

data/lib/generators/artemis/mutation/templates/mutation.graphql

@@ -0,0 +1,5 @@
+mutation<%= arguments.present? && "(#{ arguments.map {|name, type| "$#{name}: #{type.type}" }.join(", ") })" %> {
+  <%= target_mutation.name %><%= arguments.present? && "(#{ arguments.map {|name, type| "#{name}: $#{name}" }.join(", ") })" %> {
+    # Add fields here...
+  }
+}

data/lib/generators/artemis/query/USAGE

@@ -0,0 +1,27 @@
+Description:
+    Generates a query stub.
+
+    rails g artemis:query QUERY_TYPE [FILE_NAME]
+
+Example:
+    rails g artemis:query artist
+
+    This will create:
+        app/operations/artsy.rb
+        app/operations/artsy/artist.graphql
+
+    The GraphQL file name could be specified by giving the third argument:
+
+      rails g artemis:query artist artist_in_tooltip
+
+    This will create:
+        app/operations/artsy.rb
+        app/operations/artsy/artist_in_tooltip.graphql
+
+    If there are multiple services registered, the service could be specified with +--service+ option:
+
+       rails g artemis:query repository --service github
+
+    This will create:
+        app/operations/github.rb
+        app/operations/github/repository.graphql

data/lib/generators/artemis/query/query_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'graphql/schema/finder'
+
+class Artemis::QueryGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :query_type,        type: :string, required: true,                banner: "Query type"
+  argument :graphql_file_name, type: :string, required: false, default: nil, banner: "The name of the GraphQL file to be generated"
+
+  class_option :service, type: :string, default: nil, aliases: "-A"
+
+  def generate_query_file
+    template "query.graphql", graphql_file_path
+  end
+
+  private
+
+  def query_name
+    query_type.underscore
+  end
+
+  def graphql_file_path
+    "app/operations/#{service_name.underscore}/#{graphql_file_name.presence || query_name}.graphql"
+  end
+
+  def arguments
+    target_query.arguments
+  end
+
+  def target_query
+    schema.find("Query").fields[query_type] ||
+      raise(GraphQL::Schema::Finder::MemberNotFoundError, "Could not find type `#{query_type}` in schema.")
+  end
+
+  def schema
+    service_name.camelize.constantize.endpoint.schema
+  end
+
+  def service_name
+    options['service'].presence || begin
+      services = Artemis::GraphQLEndpoint.registered_services
+
+      if services.size == 1
+        services.first
+      else
+        fail "Please specify a service name (available services: #{services.join(", ")}):\n\n" \
+             "  rails g artemis:query #{query_type} #{graphql_file_name} --service SERVICE"
+      end
+    end
+  end
+end

data/lib/generators/artemis/query/templates/query.graphql

@@ -0,0 +1,5 @@
+query<%= arguments.present? && "(#{ arguments.map {|name, type| "$#{name}: #{type.type}" }.join(", ") })" %> {
+  <%= target_query.name %><%= arguments.present? && "(#{ arguments.map {|name, type| "#{name}: $#{name}" }.join(", ") })" %> {
+    # Add fields here...
+  }
+}

data/spec/adapters_spec.rb

@@ -49,6 +49,14 @@ describe 'Adapters' do
   end
 
   shared_examples 'an adapter' do
+    describe '#initialize' do
+      it 'requires an url' do
+        expect do
+          adapter.class.new(nil, service_name: nil, timeout: 2, pool_size: 5)
+        end.to raise_error(ArgumentError, "url is required (given `nil')")
+      end
+    end
+
     describe '#execute' do
       it 'makes an actual HTTP request' do
         response = adapter.execute(

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: artemis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
+- Jon Allured
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2018-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -138,6 +139,7 @@ dependencies:
         version: '3.8'
 description: GraphQL client on Rails + Convention over Configuration = ❤️
 email:
+- jon.allured@gmail.com
 - yk.nishijima@gmail.com
 executables: []
 extensions: []
@@ -147,6 +149,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -155,6 +158,8 @@ files:
 - artemis.gemspec
 - bin/console
 - bin/setup
+- doc/CHANGELOG.md.erb
+- doc/changelog_generator.rb
 - gemfiles/.bundle/config
 - gemfiles/rails_42.gemfile
 - gemfiles/rails_50.gemfile
@@ -173,11 +178,16 @@ files:
 - lib/artemis/graphql_endpoint.rb
 - lib/artemis/railtie.rb
 - lib/artemis/version.rb
-- lib/generators/artemis/USAGE
-- lib/generators/artemis/install_generator.rb
-- lib/generators/artemis/templates/.gitkeep
-- lib/generators/artemis/templates/client.rb
-- lib/generators/artemis/templates/graphql.yml
+- lib/generators/artemis/install/USAGE
+- lib/generators/artemis/install/install_generator.rb
+- lib/generators/artemis/install/templates/client.rb
+- lib/generators/artemis/install/templates/graphql.yml
+- lib/generators/artemis/mutation/USAGE
+- lib/generators/artemis/mutation/mutation_generator.rb
+- lib/generators/artemis/mutation/templates/mutation.graphql
+- lib/generators/artemis/query/USAGE
+- lib/generators/artemis/query/query_generator.rb
+- lib/generators/artemis/query/templates/query.graphql
 - lib/tasks/artemis.rake
 - spec/adapters_spec.rb
 - spec/autoloading_spec.rb

data/lib/generators/artemis/templates/graphql.yml

@@ -1,19 +0,0 @@
-default: &default
-  adapter: :net_http
-  timeout: 10
-  pool_size: 25
-
-development:
-  <%= file_name %>:
-    <<: *default
-    url: <%= endpoint_url %>
-
-test:
-  <%= file_name %>:
-    <<: *default
-    url: <%= endpoint_url %>
-
-production:
-  <%= file_name %>:
-    <<: *default
-    url: <%= endpoint_url %>