graphql_role_restrict 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 338e1922413ceb499a26d32e0e3add4db1528dc1a95ad3c27643785184cc0051
+  data.tar.gz: 1623dfa1d4fde932939b551d948102a3f04b68a262ee0a94d047fa0509e07572
+SHA512:
+  metadata.gz: d9e72fb169da317e491b7d0c552935c4fdf08bab10f0cf3d0b8d9dcb2630d643028bf30f407acab7ba54c54ca50cf6cc6618365ad626a65adfa2d45a2b354476
+  data.tar.gz: 040b6723013719a68f76bcf02e58fc70950c9158fdf752670258dd592c7a71a17ad094a9340969c759eb5d9f321731bda664864c4359d710533dc14e6dcb271a

data/lib/graphql_role_restrict/version.rb

@@ -0,0 +1,5 @@
+#coding: utf-8
+
+module GraphqlRoleRestrict
+  VERSION = "0.1.0"
+end

data/lib/graphql_role_restrict.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# This is based on the #visible? method described in
+# https://graphql-ruby.org/authorization/visibility.html
+module GraphqlRoleRestrict
+  # register a new option `role_restrict`
+  def initialize(*args, role_restrict: :logged_in, **kwargs, &block)
+    @role_restrict = role_restrict
+
+    # Pass on the default args:
+    super(*args, **kwargs, &block)
+  end
+
+  def to_graphql
+    field_defn = super # Returns a GraphQL::Field
+    field_defn.metadata[:role_restrict] = @role_restrict
+    field_defn
+  end
+
+  def visible?(context)
+    super && context_role_valid?(context, @role_restrict)
+  end
+
+  #
+  # Check the validatity of the the role_restrict value against an object representing
+  # the current_user stored in context[:current_user]
+  # (injection of that value has to be done at the controller level before accessing graphql code)
+  #
+  # Method NEEDS to be Overwritten once the module is included in your Argument/Field class to allow
+  # custom logic
+  #
+  # @param [GraphQL::Query::Context] context Graphql context object
+  # @param [Any] role_restrict Any value passed in to a role_restrict option of a field / argument
+  #
+  # @return [Boolean]
+  #
+  def context_role_valid?(context, role_restrict)
+    case role_restrict
+    when :logged_in
+      !!context[:current_user]
+    else
+      true
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: graphql_role_restrict
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- François TCHENG
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Simple plugin to allow hiding fields/arguments depending on query context
+email:
+- tcheng.f@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/graphql_role_restrict.rb"
+- "./lib/graphql_role_restrict/version.rb"
+homepage: https://github.com/nekogami/graphql_role_restrict
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Simple Field/Argument authorization layer for the gem graphql
+test_files: []