nulogy_graphql_api 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1db0c5e715fef76694b02bf7886fc6448576ef73aa0e2821dca7e3344843df29
-  data.tar.gz: 4238d07b94c47897ee083813a1845070c5021749d533eae83715c6e5f1e2397a
+  metadata.gz: 443443223656dea1385697579f000561e8b141672b894dc14f2560c4f5bc7d48
+  data.tar.gz: 4a8a1532e09704f36d7f5f7a6d8c7c93d87bf231705cf76979a406ffcfcc5b39
 SHA512:
-  metadata.gz: 686d0b9cab9be582ab6b83165c25e629013390024607370d9216e3a1f23324d8d3b28c3603af66ddac4854632b5c8058b14456f1c3becc56173a6c1b8e04fc48
-  data.tar.gz: fcc317f4c19cc3d75f24cf2613d5863c0ef2ac0b8931693ac62941467bc09e245d48bf52b526312d32ac1b2c0ef78fe069f76925757ad83ba6fdd9ced862e2ec
+  metadata.gz: a8d1956b33d02a884e43bd7441f00f8962a80435dbd25a9248ad7fc5c4ff2a5e73f904d3c7bc1548232dc1acebb7033149557828a09a370a0ac3194098b2d2f8
+  data.tar.gz: acbc49d198bd424b44877a670c3a2847b5e2c5035982cc67b65558a2aaac06baf4a951b8a90d8905390dd7cee0f0c3b1193009db29d7764b5066aed1404fafee

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master (unreleased)
 
+## 0.5.1
+
+* Add the `schema_generation_context?` attribute to the GraphQL `context` when generating the schema.
+
 ## 0.5.0
 
 **Breaking Changes**

data/README.md

@@ -5,7 +5,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "nulogy_graphql_api", "0.4.0"
+gem "nulogy_graphql_api", "0.5.1"
 ```
 
 And then execute:
@@ -25,7 +25,8 @@ Or install it yourself as:
 - [Types](#types)
   - [UserErrorType](#usererrortype)
   - [UUID](#uuid)
-- [Rake task](#rake-task)
+- [Schema Generation](#schema-generation)
+- [Node Visibility](#node-visibility)
 
 #### Testing
 
@@ -121,9 +122,11 @@ module MyApp
 end
 ```
 
-### Rake task
+### Schema Generation
 
-There is a Rake task to generate the `schema.graphql` file. All you need to provide is the path to the old and the new schema files so that the task can detect breaking changes. If you don't have an old schema file because it's your first time generating it then the rake task will just create one for you.
+There is a Rake task to generate the `schema.graphql` file. You need to provide the `schema_file_path` and the `schema_definition_path` so that the task can detect breaking changes and generate the file. If you don't have a schema file because it's your first time generating it then the rake task will just create one for you in the path provided.
+
+There is also a third argument `context`. You'll have to configure it to be able to generate the SDL of fields or types that are only visible for more privileged users.
 
 ```ruby
 namespace :graphql_api do
@@ -133,20 +136,50 @@ namespace :graphql_api do
     schema_file_path = MyApp::Engine.root.join("schema.graphql")
     schema_definition_path = MyApp::Engine.root.join("path/to/schema/root/schema.rb")
 
-    # Context is an optional parameter, but may be required if you change the visibility of nodes in your graph 
-    # i.e. 
-    # def visible?(context)
-    #   context[:current_user].superuser?
-    # end
-    context = {}
-
     NulogyGraphqlApi::Tasks::SchemaGenerator
-      .new(schema_file_path, schema_definition_path, context: context)
+      .new(schema_file_path, schema_definition_path)
       .generate_schema
   end
 end
 ```
 
+### Node visibility
+
+When you customize the visibility of parts of your graph you have to make sure that node will be visible when the schema is being generated. You can do so by using the `schema_generation_context?` attribute that is added to the context by the `SchemaGenerator` mentioned in the previous section. 
+
+Here is how to use it:
+
+##### For fields
+```ruby
+field :entity, MyApp::EntityType, null: false do
+  description "Find an entity by ID"
+  argument :id, ID, required: true
+
+  def visible?(context)
+    context[:schema_generation_context?] || context[:current_user].superuser?
+  end
+end
+```
+
+
+##### For classes
+```ruby
+module MyApp
+  class CreateEntity < GraphQL::Schema::Mutation
+    field :entity, MyApp::EntityType, null: false
+    field :errors, [NulogyGraphqlApi::Types::UserErrorType], null: false
+    
+    def self.visible(context)
+      super && (context[:schema_generation_context?] || context[:current_user].superuser?)
+    end
+
+    def resolve(args)
+      # ...
+    end
+  end
+end
+```
+
 ### RSpec helpers
 
 Add this to your `spec_helpers.rb` file:

data/lib/nulogy_graphql_api/tasks/schema_generator.rb

@@ -4,7 +4,9 @@ module NulogyGraphqlApi
       def initialize(schema_output_path, schema_definition_path, context: {})
         @schema_output_path = schema_output_path
         @schema_definition_path = schema_definition_path
-        @context = context
+        @context = context.merge(
+          schema_generation_context?: true
+        )
       end
 
       def generate_schema

data/lib/nulogy_graphql_api/version.rb

@@ -1,3 +1,3 @@
 module NulogyGraphqlApi
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/nulogy_graphql_api.gemspec

@@ -28,8 +28,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "graphql", "~> 1.9"
-  spec.add_dependency "graphql-schema_comparator", "~> 0.6.1"
+  spec.add_dependency "graphql", "~> 1.11.2"
+  spec.add_dependency "graphql-schema_comparator", "~> 1.0.0"
   spec.add_dependency "rails", ">= 5.2.4", "< 6.1.0"
   spec.add_dependency "rainbow", "~> 3.0.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nulogy_graphql_api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Daniel Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.11.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: graphql-schema_comparator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement