artemis 0.4.0 → 0.6.0

data/lib/artemis/version.rb

@@ -1,3 +1,3 @@
 module Artemis
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/lib/artemis.rb

@@ -1,3 +1,34 @@
 require "artemis/version"
 require "artemis/client"
-require "artemis/railtie" if defined?(Rails)
+require "artemis/railtie" if defined?(Rails)
+
+module Artemis
+  def self.config_for_graphql(app)
+    if app.respond_to?(:config_for)
+      app.config_for(:graphql)
+    else
+      config_for(:graphql, app: app)
+    end
+  end
+
+  # backported from https://github.com/rails/rails/blob/b9ca94ca/railties/lib/rails/application.rb#L226
+  # TODO: Remove once dropping Rails <= 4.1 support
+  def self.config_for(name, app:, env: Rails.env)
+    if name.is_a?(Pathname)
+      yaml = name
+    else
+      yaml = Pathname.new("#{app.paths["config"].existent.first}/#{name}.yml")
+    end
+
+    if yaml.exist?
+      require "erb"
+      (YAML.load(ERB.new(yaml.read).result) || {})[env] || {}
+    else
+      raise "Could not load configuration. No such file - #{yaml}"
+    end
+  rescue Psych::SyntaxError => e
+    raise "YAML syntax error occurred while parsing #{yaml}. " \
+      "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
+      "Error: #{e.message}"
+  end
+end

data/lib/generators/artemis/install/install_generator.rb

@@ -56,7 +56,7 @@ YAML
   end
 
   def client_file_name
-    if mountable_engine?
+    if respond_to?(:mountable_engine?) && mountable_engine?
       "app/operations/#{namespaced_path}/#{file_name}.rb"
     else
       "app/operations/#{file_name}.rb"
@@ -64,7 +64,7 @@ YAML
   end
 
   def query_dir_gitkeep
-    if mountable_engine?
+    if respond_to?(:mountable_engine?) && mountable_engine?
       "app/operations/#{namespaced_path}/#{file_name}/.gitkeep"
     else
       "app/operations/#{file_name}/.gitkeep"

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

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

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

@@ -14,6 +14,10 @@ class Artemis::QueryGenerator < Rails::Generators::Base
     template "query.graphql", graphql_file_path
   end
 
+  # def generate_text_fixture_file
+  #   template "fixture.yml", text_fixture_path
+  # end
+
   private
 
   def query_name
@@ -21,7 +25,11 @@ class Artemis::QueryGenerator < Rails::Generators::Base
   end
 
   def graphql_file_path
-    "app/operations/#{service_name.underscore}/#{graphql_file_name.presence || query_name}.graphql"
+    "app/operations/#{service_name.underscore}/#{qualified_name}.graphql"
+  end
+
+  def text_fixture_path
+    File.join(Artemis::Railtie.config.artemis.fixture_path, service_name.underscore, "#{qualified_name}.yml")
   end
 
   def arguments
@@ -49,4 +57,8 @@ class Artemis::QueryGenerator < Rails::Generators::Base
       end
     end
   end
+
+  def qualified_name
+    graphql_file_name.presence || query_name
+  end
 end

data/lib/generators/artemis/query/templates/fixture.yml

@@ -0,0 +1,19 @@
+# You can stub GraphQL queries by calling the `stub_graphql' method in test:
+#
+#   stub_graphql(<%= service_name.camelize %>, :<%= qualified_name.underscore %>).to_return(:<%= target_query.name %>_1)
+#
+# Or with a arguments matcher:
+#
+#   stub_graphql(<%= service_name.camelize %>, :<%= qualified_name.underscore %>, <%= arguments.map {|name, _| "#{name}: \"...\"" }.join(", ") %>).to_return(:<%= target_query.name %>_2)
+#
+
+<%= target_query.name %>_1:
+  data:
+  <% target_query.type.fields.values.each do |field| -%>
+  <%= field.name %>: # type: <%= field.type.to_type_signature %>
+  <% end %>
+<%= target_query.name %>_2:
+  data:
+  <% target_query.type.fields.values.each do |field| -%>
+  <%= field.name %>: # type: <%= field.type.to_type_signature %>
+  <% end %>

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

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

data/lib/tasks/artemis.rake

@@ -12,7 +12,7 @@ namespace :graphql do
       service = if ENV['SERVICE']
                   ENV['SERVICE']
                 else
-                  services = Rails.application.config_for(:graphql).keys
+                  services = Artemis.config_for_graphql(Rails.application).keys
 
                   if services.size == 1
                     services.first
@@ -22,7 +22,7 @@ namespace :graphql do
                 end
 
       headers          = ENV['AUTHORIZATION'] ? { Authorization: ENV['AUTHORIZATION'] } : {}
-      service_class    = service.camelize.constantize
+      service_class    = service.to_s.camelize.constantize
       schema_path      = service_class.endpoint.schema_path
       schema           = service_class.connection
                            .execute(
@@ -44,4 +44,4 @@ namespace :graphql do
       end
     end
   end
-end
+end

data/spec/adapters_spec.rb

@@ -1,20 +1,31 @@
 require 'json'
 require 'rack'
+require 'webrick'
 
 describe 'Adapters' do
   FakeServer = ->(env) {
     case env['PATH_INFO']
     when '/slow_server'
-      sleep 2.1
+      sleep 1.1
 
       [200, {}, ['{}']]
     when '/500'
       [500, {}, ['Server error']]
+    when '/test_multi_domain'
+      body = {
+        data: {
+          body: "Endpoint switched.",
+        },
+        errors: [],
+        extensions: {}
+      }.to_json
+
+      [200, {}, [body]]
     else
       body = {
         data: {
           body: JSON.parse(env['rack.input'].read),
-          headers: env.select {|key, val| key.start_with?('HTTP_') }
+          headers: env.select {|key, val| key.match("^HTTP.*|^CONTENT.*|^AUTHORIZATION.*") }
                      .collect {|key, val| [key.gsub(/^HTTP_/, ''), val.downcase] }
                      .to_h,
         },
@@ -69,6 +80,8 @@ describe 'Adapters' do
         expect(response['data']['body']['query']).to eq(GraphQL::Client::IntrospectionDocument.to_query_string)
         expect(response['data']['body']['variables']).to eq('id' => 'yayoi-kusama')
         expect(response['data']['body']['operationName']).to eq('IntrospectionQuery')
+        expect(response['data']['headers']['CONTENT_TYPE']).to eq('application/json')
+        expect(response['data']['headers']['ACCEPT']).to eq('application/json')
         expect(response['errors']).to eq([])
         expect(response['extensions']).to eq({})
       end
@@ -92,23 +105,56 @@ describe 'Adapters' do
   end
 
   describe Artemis::Adapters::NetHttpAdapter do
-    let(:adapter) { Artemis::Adapters::NetHttpAdapter.new('http://localhost:8000', service_name: nil, timeout: 2, pool_size: 5) }
+    let(:adapter) { Artemis::Adapters::NetHttpAdapter.new('http://localhost:8000', service_name: nil, timeout: 0.5, pool_size: 5) }
     let(:timeout_error) { Net::ReadTimeout }
 
     it_behaves_like 'an adapter'
   end
 
   describe Artemis::Adapters::NetHttpPersistentAdapter do
-    let(:adapter) { Artemis::Adapters::NetHttpPersistentAdapter.new('http://localhost:8000', service_name: nil, timeout: 2, pool_size: 5) }
-    let(:timeout_error) { Net::HTTP::Persistent::Error }
+    let(:adapter) { Artemis::Adapters::NetHttpPersistentAdapter.new('http://localhost:8000', service_name: nil, timeout: 0.5, pool_size: 5) }
+    let(:timeout_error) { Net::ReadTimeout }
 
     it_behaves_like 'an adapter'
   end
 
-  describe Artemis::Adapters::CurbAdapter do
-    let(:adapter) { Artemis::Adapters::CurbAdapter.new('http://localhost:8000', service_name: nil, timeout: 2, pool_size: 5) }
-    let(:timeout_error) { Curl::Err::TimeoutError }
+  describe Artemis::Adapters::MultiDomainAdapter do
+    let(:adapter) { Artemis::Adapters::MultiDomainAdapter.new('ignored', service_name: nil, timeout: 0.5, pool_size: 5, adapter_options: { adapter: :net_http }) }
 
-    it_behaves_like 'an adapter'
+    it 'makes an actual HTTP request' do
+      response = adapter.execute(document: GraphQL::Client::IntrospectionDocument, context: { url: 'http://localhost:8000/test_multi_domain' })
+
+      expect(response['data']['body']).to eq("Endpoint switched.")
+      expect(response['errors']).to eq([])
+      expect(response['extensions']).to eq({})
+    end
+
+    it 'raises an error when context.url is not specified' do
+      expect do
+        adapter.execute(document: GraphQL::Client::IntrospectionDocument)
+      end.to raise_error(ArgumentError, 'The MultiDomain adapter requires a url on every request. Please specify a ' \
+                                        'url with a context: Client.with_context(url: "https://awesomeshop.domain.conm")')
+    end
+
+    it 'raises an error when it receives a server error' do
+      expect do
+        adapter.execute(document: GraphQL::Client::IntrospectionDocument, context: { url: 'http://localhost:8000/500' })
+      end.to raise_error(Artemis::GraphQLServerError, "Received server error status 500: Server error")
+    end
+
+    it 'allows for overriding timeout' do
+      expect do
+        adapter.execute(document: GraphQL::Client::IntrospectionDocument, context: { url: 'http://localhost:8000/slow_server' })
+      end.to raise_error(Net::ReadTimeout)
+    end
+  end
+
+  if RUBY_ENGINE == 'ruby'
+    describe Artemis::Adapters::CurbAdapter do
+      let(:adapter) { Artemis::Adapters::CurbAdapter.new('http://localhost:8000', service_name: nil, timeout: 2, pool_size: 5) }
+      let(:timeout_error) { Curl::Err::TimeoutError }
+
+      it_behaves_like 'an adapter'
+    end
   end
-end
+end

data/spec/callbacks_spec.rb

@@ -19,6 +19,20 @@ describe "#{GraphQL::Client} Callbacks" do
     end
   end
 
+  Spotify = Class.new(Artemis::Client) do
+    def self.name
+      'Spotify'
+    end
+
+    before_execute do
+      raise "this callback should not get invoked"
+    end
+
+    after_execute do
+      raise "this callback should not get invoked"
+    end
+  end
+
   describe ".before_execute" do
     it "gets invoked before executing" do
       Client.artist(id: 'yayoi-kusama', context: { user_id: 'yuki24' })

data/spec/client_spec.rb

@@ -97,6 +97,31 @@ describe GraphQL::Client do
     GRAPHQL
   end
 
+  it "can make a GraphQL request with #execute" do
+    Metaphysics.execute(:artist, id: "yayoi-kusama")
+
+    request = requests[0]
+
+    expect(request.operation_name).to eq('Metaphysics__Artist')
+    expect(request.variables).to eq('id' => 'yayoi-kusama')
+    expect(request.context).to eq({})
+    expect(request.document.to_query_string).to eq(<<~GRAPHQL.strip)
+      query Metaphysics__Artist($id: String!) {
+        artist(id: $id) {
+          name
+          bio
+          birthday
+        }
+      }
+    GRAPHQL
+  end
+
+  it "can make a GraphQL request with #execute" do
+    expect { Metaphysics.execute(:does_not_exist) }
+      .to raise_error(Artemis::GraphQLFileNotFound)
+      .with_message(/Query does_not_exist\.graphql not found/)
+  end
+
   it "assigns context to the request when provided as an argument" do
     context = { headers: { Authorization: 'bearer ...' } }
 
@@ -158,4 +183,4 @@ describe GraphQL::Client do
   ensure
     files.each {|file| File.delete(file) }
   end
-end
+end

data/spec/fixtures/responses/{artist.yml → metaphysics/artist.yml}

@@ -15,3 +15,10 @@ yuki:
     artist:
       name: Yuki Nishijima
       birthday: <%= Date.today.year %>/01/01
+
+yoshiki:
+  data:
+    artist:
+      id: artist-yoshiki
+      name: Artist Yoshiki
+      birthday: null

data/spec/fixtures/responses/spotify_client/artist.yml

@@ -0,0 +1,5 @@
+yoshiki:
+  data:
+    artist:
+      id: pianist-yoshiki
+      name: Pianist Yoshiki

data/spec/spec_helper.rb

@@ -12,6 +12,7 @@ require 'pry-byebug' if RUBY_ENGINE == 'ruby'
 # The only method that doesn't need test coverage is +Artemis::Client.query_paths+. The rest of the methods should be
 # tested, but we don't have any test setup for that yet.
 Artemis::Client.query_paths = [File.join(__dir__, 'fixtures')]
+Artemis::GraphQLEndpoint.suppress_warnings_on_schema_load = true
 Artemis::GraphQLEndpoint.register!(:metaphysics, adapter: :test, url: '', schema_path: 'spec/fixtures/metaphysics/schema.json')
 Artemis::GraphQLEndpoint.lookup(:metaphysics).load_schema!
 

data/spec/test_helper_spec.rb

@@ -1,7 +1,7 @@
 require 'artemis/test_helper'
 require 'date'
 
-describe GraphQL::Client do
+describe Artemis::TestHelper do
   include Artemis::TestHelper
 
   def graphql_fixture_path
@@ -53,12 +53,42 @@ describe GraphQL::Client do
   it "can mock a GraphQL request for a query that has a query name"
 
   it "raises an exception if the specified fixture file does not exist" do
-    expect { stub_graphql(Metaphysics, :does_not_exist) }
-      .to raise_error(Artemis::FixtureNotFound, %r|spec/fixtures/responses/does_not_exist.{yml,json}|)
+    expect { stub_graphql(Metaphysics, :does_not_exist).to_return(:data) }
+      .to raise_error(Artemis::FixtureNotFound, %r|does_not_exist.{yml,json}|)
   end
 
   it "raises an exception if the specified fixture file exists but fixture key does not exist" do
     expect { stub_graphql(Metaphysics, :artist).to_return(:does_not_exist) }
-      .to raise_error(Artemis::FixtureNotFound, %r|spec/fixtures/responses/artist.yml|)
+      .to raise_error(Artemis::FixtureNotFound, %r|spec/fixtures/responses/metaphysics/artist.yml|)
+  end
+
+  it "picks up the fixture for the given different service if multiple services have the exact same fixture" do
+    stub_graphql(Metaphysics, :artist).to_return(:yoshiki)
+
+    yoshiki = Metaphysics.artist(id: "artist-yoshiki")
+
+    expect(yoshiki.data.artist.name).to eq("Artist Yoshiki")
+  end
+
+  it "can mock separate GraphQL queries with the same arguments" do
+    stub_graphql("SpotifyClient", :artist, id: "yoshiki").to_return(:yoshiki)
+    stub_graphql(Metaphysics, :artist, id: "yoshiki").to_return(:yoshiki)
+
+    yoshiki = Metaphysics.artist(id: "yoshiki")
+    
+    expect(yoshiki.data.artist.name).to eq("Artist Yoshiki")
+  end
+
+  it "allows to get raw fixture data as a Hash" do
+    data = stub_graphql("SpotifyClient", :artist).get(:yoshiki)
+
+    expect(data).to eq({
+      "data" => {
+        "artist" => {
+          "id" => "pianist-yoshiki",
+          "name" => "Pianist Yoshiki"
+        }
+      }
+    })
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: artemis
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jon Allured
 - Yuki Nishijima
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-30 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,138 +17,124 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: graphql
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: graphql-client
+  name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: graphql-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: curb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
 description: GraphQL client on Rails + Convention over Configuration = ❤️
@@ -159,9 +145,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -170,20 +156,23 @@ files:
 - README.md
 - Rakefile
 - artemis.gemspec
+- banner.png
 - bin/console
 - bin/setup
 - doc/CHANGELOG.md.erb
 - doc/changelog_generator.rb
 - gemfiles/.bundle/config
-- gemfiles/rails_42.gemfile
 - gemfiles/rails_50.gemfile
 - gemfiles/rails_51.gemfile
 - gemfiles/rails_52.gemfile
+- gemfiles/rails_60.gemfile
+- gemfiles/rails_61.gemfile
 - gemfiles/rails_edge.gemfile
 - lib/artemis.rb
 - lib/artemis/adapters.rb
 - lib/artemis/adapters/abstract_adapter.rb
 - lib/artemis/adapters/curb_adapter.rb
+- lib/artemis/adapters/multi_domain_adapter.rb
 - lib/artemis/adapters/net_http_adapter.rb
 - lib/artemis/adapters/net_http_persistent_adapter.rb
 - lib/artemis/adapters/test_adapter.rb
@@ -203,6 +192,7 @@ files:
 - lib/generators/artemis/mutation/templates/mutation.graphql
 - lib/generators/artemis/query/USAGE
 - lib/generators/artemis/query/query_generator.rb
+- lib/generators/artemis/query/templates/fixture.yml
 - lib/generators/artemis/query/templates/query.graphql
 - lib/tasks/artemis.rake
 - spec/adapters_spec.rb
@@ -216,8 +206,9 @@ files:
 - spec/fixtures/metaphysics/artists.graphql
 - spec/fixtures/metaphysics/artwork.graphql
 - spec/fixtures/metaphysics/schema.json
-- spec/fixtures/responses/artist.yml
-- spec/fixtures/responses/artwork.json
+- spec/fixtures/responses/metaphysics/artist.yml
+- spec/fixtures/responses/metaphysics/artwork.json
+- spec/fixtures/responses/spotify_client/artist.yml
 - spec/spec_helper.rb
 - spec/test_helper_spec.rb
 - tmp/.gitkeep
@@ -225,7 +216,7 @@ homepage: https://github.com/yuki24/artemis
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -240,9 +231,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.26
+signing_key:
 specification_version: 4
 summary: GraphQL on Rails
 test_files: []