graphlient 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2e6a1b6dd31d8be1b55aa0efbba64dce194bdee6f55a10c6d010148ff56a2274
-  data.tar.gz: 5740a5829835cf1af03733cccf2ac5a9b2621b57849d1b001d7fc517aafe6740
+SHA1:
+  metadata.gz: 3c5a902290bf910c35ad39c06f697c00b54e0156
+  data.tar.gz: c27b7ed166bf0acc803547aad92f5cbc35164da2
 SHA512:
-  metadata.gz: 5ad460a9adba6796cbba204ddc7b843d1acee5396c2b24f018a54c2de5d168535e54ed07fc4241c16f8dd1f23967a73e8d576b748b27e0f134305984503e9bf9
-  data.tar.gz: 880bf215ab25b9519bec4cd1c4d6ca2c66139cb8d6beddb615b43b184eab99dcde3c8b666d9c750bc4b6842f89e0a0e826a585a7a04c75717b96b61ba8a7ee6a
+  metadata.gz: e8ca60f3ced8b55dc975bce37727abeeddbb18612c8c33596502e23b3b785613d38bae6e48a94e270d635bf89ef9b3e57e8c9b779a4cca764ef2ce5b2da708ba
+  data.tar.gz: a9474b9a2bef82b9fa4aff02d2e314827e5dc97a8f16b7efe30f4b836c10a2eb5acb967978fed95043a27cf89c2985c7aaf2df6878e63923bcab82a9f2fbf2e3

data/.gitignore

@@ -10,6 +10,7 @@
 /test/version_tmp/
 /tmp/
 .byebug_history
+.history/
 .DS_Store
 # Used by dotenv library to load environment variables.
 # .env

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.3.0

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 ### 0.3.1 (Next)
 
+* [#43](https://github.com/ashkan18/graphlient/pull/38): Allow to load and dump schema to json - [@povilasjurcys](https://github.com/povilasjurcys).
 * Your contribution here.
 
 ### 0.3.0 (02/22/2018)

data/README.md

@@ -107,6 +107,15 @@ The successful response contains data in `response.data`. The following example
 response.data.create_invoice.first.id
 ```
 
+### Schema storing and loading on disk
+
+To reduce requests to graphql API you can cache schema:
+
+```ruby
+client = Client.new(url, schema_path: 'config/your_graphql_schema.json')
+client.schema.dump! # you only need to call this when graphql schema changes
+```
+
 ### Error Handling
 
 Unlike graphql-client, Graphlient will always raise an exception unless the query has succeeded.

data/graphlient.gemspec

@@ -1,4 +1,4 @@
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 require 'graphlient/version'
 

data/lib/graphlient.rb

@@ -5,3 +5,4 @@ require 'graphlient/errors'
 require 'graphlient/query'
 require 'graphlient/adapters'
 require 'graphlient/client'
+require 'graphlient/schema'

data/lib/graphlient/client.rb

@@ -49,13 +49,17 @@ module Graphlient
     end
 
     def schema
-      @schema ||= GraphQL::Client.load_schema(http)
+      @schema ||= Graphlient::Schema.new(http, schema_path)
     end
 
     private
 
+    def schema_path
+      return options[:schema_path].to_s if options[:schema_path]
+    end
+
     def client
-      @client ||= GraphQL::Client.new(schema: schema, execute: http).tap do |client|
+      @client ||= GraphQL::Client.new(schema: schema.graphql_schema, execute: http).tap do |client|
         client.allow_dynamic_queries = @options.key?(:allow_dynamic_queries) ? options[:allow_dynamic_queries] : true
       end
     end

data/lib/graphlient/extensions/query.rb

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

data/lib/graphlient/query.rb

@@ -18,8 +18,8 @@ module Graphlient
       instance_eval(&block)
     end
 
-    def method_missing(m, *args, &block)
-      append_node(m, args, &block)
+    def method_missing(method_name, *args, &block)
+      append_node(method_name, args, &block)
     end
 
     ROOT_NODES.each do |root_node|
@@ -29,7 +29,7 @@ module Graphlient
       end
     end
 
-    def respond_to_missing?(m, include_private = false)
+    def respond_to_missing?(method_name, include_private = false)
       super
     end
 
@@ -71,21 +71,21 @@ module Graphlient
       end.join(', ')
     end
 
-    def argument_string(k, v)
-      "#{k}: #{argument_value_string(v)}"
+    def argument_string(key, val)
+      "#{key}: #{argument_value_string(val)}"
     end
 
-    def variable_string(v)
-      case v
+    def variable_string(val)
+      case val
       when :id, :id!
-        v.to_s.upcase
-      when ->(value) { SCALAR_TYPES.key?(value.to_s.delete('!').to_sym) }
+        val.to_s.upcase
+      when ->(v) { SCALAR_TYPES.key?(v.to_s.delete('!').to_sym) }
         # scalar types
-        v.to_s.camelize
+        val.to_s.camelize
       when Array
-        "[#{variable_string(v.first)}]"
+        "[#{variable_string(val.first)}]"
       else
-        v.to_s
+        val.to_s
       end
     end
 

data/lib/graphlient/schema.rb

@@ -0,0 +1,26 @@
+require 'delegate'
+
+module Graphlient
+  class Schema < SimpleDelegator
+    PATH_ERROR_MESSAGE = 'schema_path is missing. Please add it like this: `Graphlient.new(url, schema_path: YOUR_PATH)`'.freeze
+
+    class MissingConfigurationError < StandardError; end
+
+    alias graphql_schema __getobj__
+
+    attr_reader :http, :path
+
+    def initialize(http, path)
+      schema_source = path || http
+      super(GraphQL::Client.load_schema(schema_source))
+
+      @path = path
+      @http = http
+    end
+
+    def dump!
+      raise MissingConfigurationError, PATH_ERROR_MESSAGE unless path
+      GraphQL::Client.dump_schema(http, path)
+    end
+  end
+end

data/lib/graphlient/version.rb

@@ -1,3 +1,3 @@
 module Graphlient
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.1'.freeze
 end

data/spec/graphlient/adapters/http/faraday_adapter_spec.rb

@@ -54,7 +54,7 @@ describe Graphlient::Adapters::HTTP::FaradayAdapter do
     end
 
     it 'retrieves schema' do
-      expect(client.schema).to be_a GraphQL::Schema
+      expect(client.schema).to be_a Graphlient::Schema
     end
   end
 end

data/spec/graphlient/adapters/http/http_adapter_spec.rb

@@ -35,7 +35,7 @@ describe Graphlient::Adapters::HTTP::HTTPAdapter do
     end
 
     it 'retrieves schema' do
-      expect(client.schema).to be_a GraphQL::Schema
+      expect(client.schema).to be_a Graphlient::Schema
     end
   end
 end

data/spec/graphlient/client_schema_spec.rb

@@ -1,18 +1,41 @@
 require 'spec_helper'
+require 'tempfile'
 
 describe Graphlient::Client do
-  let(:client) { Graphlient::Client.new('http://graph.biz/graphql') }
+  let(:client) { described_class.new(url) }
+  let(:url) { 'http://graph.biz/graphql' }
 
   describe '#schema' do
     before do
-      stub_request(:post, 'http://graph.biz/graphql').to_return(status: 500)
+      stub_request(:post, url)
+        .to_return(body: DummySchema.execute(GraphQL::Introspection::INTROSPECTION_QUERY).to_json)
     end
 
-    it 'fails with an exception' do
-      expect do
-        client.schema
-      end.to raise_error Graphlient::Errors::ServerError do |e|
-        expect(e.to_s).to eq 'the server responded with status 500'
+    context 'when server returns error' do
+      before do
+        stub_request(:post, url).to_return(status: 500)
+      end
+
+      it 'fails with an exception' do
+        expect do
+          client.schema
+        end.to raise_error Graphlient::Errors::ServerError do |e|
+          expect(e.to_s).to eq 'the server responded with status 500'
+        end
+      end
+    end
+
+    context 'when introspection request is sucessfull' do
+      it 'returns Graphlient::Schema instance' do
+        expect(client.schema).to be_a(Graphlient::Schema)
+      end
+    end
+
+    context 'when schema path option is not String' do
+      let(:client) { described_class.new(url, schema_path: Pathname.new('config/schema.json')) }
+
+      it 'converts path to string' do
+        expect(client.schema.path).to eq 'config/schema.json'
       end
     end
   end

data/spec/graphlient/schema_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe Graphlient::Schema do
+  let(:client) { Graphlient::Client.new(url) }
+  let(:url) { 'http://graph.biz/graphql' }
+  let(:schema) { client.schema }
+
+  describe '#dump!' do
+    let!(:introspection_query_request) do
+      stub_request(:post, url)
+        .with(body: /query IntrospectionQuery/)
+        .to_return(body: DummySchema.execute(GraphQL::Introspection::INTROSPECTION_QUERY).to_json)
+    end
+
+    context 'when schema path is not given' do
+      it 'raises error' do
+        expect { schema.dump! }.to raise_error(Graphlient::Schema::MissingConfigurationError)
+      end
+    end
+
+    context 'when schema path is given' do
+      let(:client) { Graphlient::Client.new(url, schema_path: @schema_path) }
+      let(:schema_path) { @schema_path }
+
+      around(:each) do |example|
+        Tempfile.open('graphql_schema.json') do |file|
+          @schema_path = file.path
+          example.run
+          @schema_path = nil
+        end
+      end
+
+      it 'makes introspection query' do
+        schema.dump!
+        expect(introspection_query_request).to have_been_made.once
+      end
+
+      it 'updates schema json file' do
+        expect { schema.dump! }.to(change { File.read(@schema_path) })
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphlient
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ashkan Nasseri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2018-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -89,6 +89,7 @@ files:
 - lib/graphlient/extensions.rb
 - lib/graphlient/extensions/query.rb
 - lib/graphlient/query.rb
+- lib/graphlient/schema.rb
 - lib/graphlient/version.rb
 - spec/graphlient/adapters/http/faraday_adapter_spec.rb
 - spec/graphlient/adapters/http/http_adapter_spec.rb
@@ -96,6 +97,7 @@ files:
 - spec/graphlient/client_schema_spec.rb
 - spec/graphlient/extensions/query_spec.rb
 - spec/graphlient/query_spec.rb
+- spec/graphlient/schema_spec.rb
 - spec/graphlient/static_client_query_spec.rb
 - spec/spec_helper.rb
 - spec/support/context/dummy_client.rb
@@ -125,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A friendlier Ruby client for consuming GraphQL-based APIs.