graphql-guard-cody 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b45c4212878e7872146e00571bafaa0b98ca1fa726feb8f85d1b49cfd8944fd
+  data.tar.gz: 4eefc0431a87d4c53b797e5d3701bcb21e70aa98773fd7584adea38a1e9353ca
+SHA512:
+  metadata.gz: 886d8750dcfb9c24abb33dc4f2c426653b374f4ea71d4635a78a9b8e7fb12715b834a72a7137fe5d8c191fce4bc2548a6c08bf4db6e5a5f048006263ebc55d33
+  data.tar.gz: 4243ca803a13e30c7e32089542b14fce3e9c79913c94ff89d83c26da2dccda922f78ff2b95a5852e185ff0fca0a177e70653e0f17dc6da6eb0f49a2835289e49

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+before_install: gem install bundler -v 2.1.4
+rvm:
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
+env:
+  - CI=true

data/CHANGELOG.md

@@ -0,0 +1,150 @@
+# Changelog
+
+The following are lists of the notable changes included with each release.
+This is intended to help keep people informed about notable changes between
+versions, as well as provide a rough history. Each item is prefixed with
+one of the following labels: `Added`, `Changed`, `Deprecated`,
+`Removed`, `Fixed`, `Security`. We also use [Semantic Versioning](http://semver.org)
+to manage the versions of this gem so
+that you can set version constraints properly.
+
+#### [Unreleased](https://github.com/exAspArk/graphql-guard/compare/v2.0.0...HEAD)
+
+* WIP
+
+#### [v2.0.0](https://github.com/exAspArk/graphql-guard/compare/v1.3.1...v2.0.0) – 2020-04-20
+
+* `Added`: support for `graphql` gem version `>= 1.10` with `Interpreter`. [#39](https://github.com/exAspArk/graphql-guard/pull/39)
+* `Removed`: support for previous `graphql` gem versions. [#39](https://github.com/exAspArk/graphql-guard/pull/39)
+
+**Breaking changes**:
+
+* Requires using `graphql` gem version `>= 1.10.0` with [Interpreter](https://graphql-ruby.org/queries/interpreter.html).
+
+Before:
+
+```rb
+class Schema < GraphQL::Schema
+  query QueryType
+  mutation MutationType
+
+  use GraphQL::Guard.new
+end
+```
+
+After:
+
+```rb
+class Schema < GraphQL::Schema
+  use GraphQL::Execution::Interpreter
+  use GraphQL::Analysis::AST
+
+  query QueryType
+  mutation MutationType
+
+  use GraphQL::Guard.new
+end
+```
+
+
+* Use the actual type in the Policy object without `type.metadata[:type_class]`.
+
+Before (with `graphql` gem version `>= 1.8` and class-based type definitions):
+
+```rb
+class GraphqlPolicy
+  def self.guard(type, field)
+    RULES.dig(type.metadata[:type_class], field)
+  end
+end
+```
+
+After:
+
+```rb
+class GraphqlPolicy
+  def self.guard(type, field)
+    RULES.dig(type, field)
+  end
+end
+```
+
+
+#### [v1.3.1](https://github.com/exAspArk/graphql-guard/compare/v1.3.0...v1.3.1) – 2020-01-22
+
+* `Fixed`: compatibility with `graphql` gem version 1.10. [#36](https://github.com/exAspArk/graphql-guard/pull/36)
+
+#### [v1.3.0](https://github.com/exAspArk/graphql-guard/compare/v1.2.2...v1.3.0) – 2019-10-24
+
+* `Added`: More descriptive default error message for `NotAuthorizedError`. [#32](https://github.com/exAspArk/graphql-guard/pull/32)
+
+#### [v1.2.2](https://github.com/exAspArk/graphql-guard/compare/v1.2.1...v1.2.2) – 2019-03-04
+
+* `Fixed`: compatibility with Ruby 2.6 and `graphql` gem version 1.7. [#26](https://github.com/exAspArk/graphql-guard/pull/26)
+
+#### [v1.2.1](https://github.com/exAspArk/graphql-guard/compare/v1.2.0...v1.2.1) – 2018-10-18
+
+* `Fixed`: compatibility with Ruby 2.5 and `graphql` gem version 1.7. [#21](https://github.com/exAspArk/graphql-guard/pull/21)
+
+#### [v1.2.0](https://github.com/exAspArk/graphql-guard/compare/v1.1.0...v1.2.0) – 2018-06-29
+
+* `Added`: support for `graphql` gem version 1.8. [#17](https://github.com/exAspArk/graphql-guard/pull/17)
+
+#### [v1.1.0](https://github.com/exAspArk/graphql-guard/compare/v1.0.0...v1.1.0) – 2018-05-09
+
+* `Added`: support to `mask` fields depending on the context.
+
+#### [v1.0.0](https://github.com/exAspArk/graphql-guard/compare/v0.4.0...v1.0.0) – 2017-07-31
+
+* `Changed`: guards for every `*` field also accepts arguments: `->(object, arguments, context) { ... }`:
+
+Before:
+
+<pre>
+GraphQL::ObjectType.define do
+  name "Post"
+  guard ->(obj, ctx) { ... }
+  ...
+end
+</pre>
+
+After:
+
+<pre>
+GraphQL::ObjectType.define do
+  name "Post"
+  guard ->(obj, <b>args</b>, ctx) { ... }
+  ...
+end
+</pre>
+
+* `Changed`: `.field_with_guard` from `graphql/guard/testing` module accepts policy object as a second argument:
+
+Before:
+
+<pre>
+<b>guard_object</b> = GraphQL::Guard.new(policy_object: GraphqlPolicy)
+posts_field = QueryType.field_with_guard('posts', <b>guard_object</b>)
+</pre>
+
+After:
+
+<pre>
+posts_field = QueryType.field_with_guard('posts', <b>GraphqlPolicy</b>)
+</pre>
+
+#### [v0.4.0](https://github.com/exAspArk/graphql-guard/compare/v0.3.0...v0.4.0) – 2017-07-25
+
+* `Added`: ability to test `guard` lambdas via field.
+
+#### [v0.3.0](https://github.com/exAspArk/graphql-guard/compare/v0.2.0...v0.3.0) – 2017-07-19
+
+* `Added`: ability to use custom error handlers.
+
+#### [v0.2.0](https://github.com/exAspArk/graphql-guard/compare/v0.1.0...v0.2.0) – 2017-07-19
+
+* `Added`: support for object policies.
+
+#### [v0.1.0](https://github.com/exAspArk/graphql-guard/compare/e6d7d0f...v0.1.0) – 2017-07-19
+
+* `Added`: initial functional version with inline policies.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at exaspark@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "graphql", "~> 1.10"
+
+gem "pry", require: false
+gem "coveralls", require: false
+
+# Specify your gem's dependencies in graphql-guard.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 exAspArk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,393 @@
+# graphql-guard
+
+[![Build Status](https://travis-ci.org/exAspArk/graphql-guard.svg?branch=master)](https://travis-ci.org/exAspArk/graphql-guard)
+[![Coverage Status](https://coveralls.io/repos/github/exAspArk/graphql-guard/badge.svg)](https://coveralls.io/github/exAspArk/graphql-guard)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/exAspArk/graphql-guard.svg)](https://codeclimate.com/github/exAspArk/graphql-guard/maintainability)
+[![Downloads](https://img.shields.io/gem/dt/graphql-guard.svg)](https://rubygems.org/gems/graphql-guard)
+[![Latest Version](https://img.shields.io/gem/v/graphql-guard.svg)](https://rubygems.org/gems/graphql-guard)
+
+This gem provides a field-level authorization for [graphql-ruby](https://github.com/rmosolgo/graphql-ruby).
+
+## Contents
+
+* [Usage](#usage)
+  * [Inline policies](#inline-policies)
+  * [Policy object](#policy-object)
+* [Priority order](#priority-order)
+* [Integration](#integration)
+  * [CanCanCan](#cancancan)
+  * [Pundit](#pundit)
+* [Error handling](#error-handling)
+* [Schema masking](#schema-masking)
+* [Installation](#installation)
+* [Testing](#testing)
+* [Development](#development)
+* [Contributing](#contributing)
+* [License](#license)
+* [Code of Conduct](#code-of-conduct)
+
+## Usage
+
+Define a GraphQL schema:
+
+```ruby
+# Define a type
+class PostType < GraphQL::Schema::Object
+  field :id, ID, null: false
+  field :title, String, null: true
+end
+
+# Define a query
+class QueryType < GraphQL::Schema::Object
+  field :posts, [PostType], null: false do
+    argument :user_id, ID, required: true
+  end
+
+  def posts(user_id:)
+    Post.where(user_id: user_id)
+  end
+end
+
+# Define a schema
+class Schema < GraphQL::Schema
+  use GraphQL::Execution::Interpreter
+  use GraphQL::Analysis::AST
+  query QueryType
+end
+
+# Execute query
+Schema.execute(query, variables: { userId: 1 }, context: { current_user: current_user })
+```
+
+### Inline policies
+
+Add `GraphQL::Guard` to your schema:
+
+<pre>
+class Schema < GraphQL::Schema
+  use GraphQL::Execution::Interpreter
+  use GraphQL::Analysis::AST
+  query QueryType
+  <b>use GraphQL::Guard.new</b>
+end
+</pre>
+
+Now you can define `guard` for a field, which will check permissions before resolving the field:
+
+<pre>
+class QueryType < GraphQL::Schema::Object
+  <b>field :posts</b>, [PostType], null: false do
+    argument :user_id, ID, required: true
+    <b>guard ->(obj, args, ctx) {</b> args[:user_id] == ctx[:current_user].id <b>}</b>
+  end
+  ...
+end
+</pre>
+
+You can also define `guard`, which will be executed for every `*` field in the type:
+
+<pre>
+class PostType < GraphQL::Schema::Object
+  <b>guard ->(obj, args, ctx) {</b> ctx[:current_user].admin? <b>}</b>
+  ...
+end
+</pre>
+
+If `guard` block returns `nil` or `false`, then it'll raise a `GraphQL::Guard::NotAuthorizedError` error.
+
+### Policy object
+
+Alternatively, it's possible to extract and describe all policies by using PORO (Plain Old Ruby Object), which should implement a `guard` method. For example:
+
+<pre>
+class <b>GraphqlPolicy</b>
+  RULES = {
+    QueryType => {
+      <b>posts: ->(obj, args, ctx) {</b> args[:user_id] == ctx[:current_user].id <b>}</b>
+    },
+    PostType => {
+      <b>'*': ->(obj, args, ctx) {</b> ctx[:current_user].admin? <b>}</b>
+    }
+  }
+
+  def self.<b>guard(type, field)</b>
+    RULES.dig(type, field)
+  end
+end
+</pre>
+
+Pass this object to `GraphQL::Guard`:
+
+<pre>
+class Schema < GraphQL::Schema
+  use GraphQL::Execution::Interpreter
+  use GraphQL::Analysis::AST
+  query QueryType
+  use GraphQL::Guard.new(<b>policy_object: GraphqlPolicy</b>)
+end
+</pre>
+
+When using a policy object, you may want to allow [introspection queries](http://graphql.org/learn/introspection/) to skip authorization. A simple way to avoid having to whitelist every introspection type in the `RULES` hash of your policy object is to check the `type` parameter in the `guard` method:
+
+<pre>
+def self.guard(type, field)
+  <b>type.introspection? ? ->(_obj, _args, _ctx) { true } :</b> RULES.dig(type, field) # or "false" to restrict an access
+end
+</pre>
+
+## Priority order
+
+`GraphQL::Guard` will use the policy in the following order of priority:
+
+1. Inline policy on the field.
+2. Policy from the policy object on the field.
+3. Inline policy on the type.
+2. Policy from the policy object on the type.
+
+<pre>
+class <b>GraphqlPolicy</b>
+  RULES = {
+    PostType => {
+      <b>'*': ->(obj, args, ctx) {</b> ctx[:current_user].admin? <b>}</b>,                                # <=== <b>4</b>
+      <b>title: ->(obj, args, ctx) {</b> ctx[:current_user].admin? <b>}</b>                               # <=== <b>2</b>
+    }
+  }
+
+  def self.guard(type, field)
+    RULES.dig(type, field)
+  end
+end
+
+class PostType < GraphQL::Schema::Object
+  <b>guard ->(obj, args, ctx) {</b> ctx[:current_user].admin? <b>}</b>                                    # <=== <b>3</b>
+  field :title, String, null: true, <b>guard: ->(obj, args, ctx) {</b> ctx[:current_user].admin? <b>}</b> # <=== <b>1</b>
+end
+
+class Schema < GraphQL::Schema
+  use GraphQL::Execution::Interpreter
+  use GraphQL::Analysis::AST
+  query QueryType
+  use GraphQL::Guard.new(<b>policy_object: GraphqlPolicy</b>)
+end
+</pre>
+
+## Integration
+
+You can simply reuse your existing policies if you really want. You don't need any monkey patches or magic for it ;)
+
+### CanCanCan
+
+<pre>
+# Define an ability
+class <b>Ability</b>
+  include CanCan::Ability
+
+  def initialize(user)
+    user ||= User.new
+    if user.admin?
+      can :manage, :all
+    else
+      can :read, Post, author_id: user.id
+    end
+  end
+end
+
+# Use the ability in your guard
+class PostType < GraphQL::Schema::Object
+  guard ->(post, args, ctx) { <b>ctx[:current_ability].can?(:read, post)</b> }
+  ...
+end
+
+# Pass the ability
+Schema.execute(query, context: { <b>current_ability: Ability.new(current_user)</b> })
+</pre>
+
+### Pundit
+
+<pre>
+# Define a policy
+class <b>PostPolicy</b> < ApplicationPolicy
+  def show?
+    user.admin? || record.author_id == user.id
+  end
+end
+
+# Use the ability in your guard
+class PostType < GraphQL::Schema::Object
+  guard ->(post, args, ctx) { <b>PostPolicy.new(ctx[:current_user], post).show?</b> }
+  ...
+end
+
+# Pass current_user
+Schema.execute(query, context: { <b>current_user: current_user</b> })
+</pre>
+
+## Error handling
+
+By default `GraphQL::Guard` raises a `GraphQL::Guard::NotAuthorizedError` exception if access to the field is not authorized.
+You can change this behavior, by passing custom `not_authorized` lambda. For example:
+
+<pre>
+class SchemaWithErrors < GraphQL::Schema
+  use GraphQL::Execution::Interpreter
+  use GraphQL::Analysis::AST
+  query QueryType
+  use GraphQL::Guard.new(
+    # By default it raises an error
+    # not_authorized: ->(type, field) do
+    #   raise GraphQL::Guard::NotAuthorizedError.new("#{type}.#{field}")
+    # end
+
+    # Returns an error in the response
+    <b>not_authorized: ->(type, field) do
+      GraphQL::ExecutionError.new("Not authorized to access #{type}.#{field}")
+    end</b>
+  )
+end
+</pre>
+
+In this case executing a query will continue, but return `nil` for not authorized field and also an array of `errors`:
+
+<pre>
+SchemaWithErrors.execute("query { <b>posts</b>(user_id: 1) { id title } }")
+# => {
+#   "data" => <b>nil</b>,
+#   "errors" => [{
+#     "messages" => <b>"Not authorized to access Query.posts"</b>,
+#     "locations": { "line" => 1, "column" => 9 },
+#     "path" => [<b>"posts"</b>]
+#   }]
+# }
+</pre>
+
+In more advanced cases, you may want not to return `errors` only for some unauthorized fields. Simply return `nil` if user is not authorized to access the field. You can achieve it, for example, by placing the logic into your `PolicyObject`:
+
+<pre>
+class <b>GraphqlPolicy</b>
+  RULES = {
+    PostType => {
+      '*': {
+        guard: ->(obj, args, ctx) { ... },
+        <b>not_authorized:</b> ->(type, field) { GraphQL::ExecutionError.new("Not authorized to access #{type}.#{field}") }
+      }
+      title: {
+        guard: ->(obj, args, ctx) { ... },
+        <b>not_authorized:</b> ->(type, field) { nil } # simply return nil if not authorized, no errors
+      }
+    }
+  }
+
+  def self.guard(type, field)
+    RULES.dig(type, field, :guard)
+  end
+
+  def self.<b>not_authorized_handler</b>(type, field)
+    RULES</b>.dig(type, field, <b>:not_authorized</b>) || RULES</b>.dig(type, :'*', <b>:not_authorized</b>)
+  end
+end
+
+class Schema < GraphQL::Schema
+  use GraphQL::Execution::Interpreter
+  use GraphQL::Analysis::AST
+  query QueryType
+  mutation MutationType
+
+  use GraphQL::Guard.new(
+    policy_object: GraphqlPolicy,
+    not_authorized: ->(type, field) {
+      handler = GraphqlPolicy.<b>not_authorized_handler</b>(type, field)
+      handler.call(type, field)
+    }
+  )
+end
+</pre>
+
+## Schema masking
+
+It's possible to hide fields from being introspectable and accessible based on the context. For example:
+
+<pre>
+class PostType < GraphQL::Schema::Object
+  field :id, ID, null: false
+  field :title, String, null: true do
+    # The field "title" is accessible only for beta testers
+    <b>mask ->(ctx) {</b> ctx[:current_user].beta_tester? <b>}</b>
+  end
+end
+</pre>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-guard'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-guard
+
+## Testing
+
+It's possible to test fields with `guard` in isolation:
+
+<pre>
+# Your type
+class QueryType < GraphQL::Schema::Object
+  field :posts, [PostType], null: false, <b>guard ->(obj, args, ctx) {</b> ... <b>}</b>
+end
+
+# Your test
+<b>require "graphql/guard/testing"</b>
+
+posts = QueryType.<b>field_with_guard('posts')</b>
+result = posts.<b>guard(obj, args, ctx)</b>
+expect(result).to eq(true)
+</pre>
+
+If you would like to test your fields with policy objects:
+
+
+<pre>
+# Your type
+class QueryType < GraphQL::Schema::Object
+  field :posts, [PostType], null: false
+end
+
+# Your policy object
+class <b>GraphqlPolicy</b>
+  def self.<b>guard</b>(type, field)
+    <b>->(obj, args, ctx) {</b> ... <b>}</b>
+  end
+end
+
+# Your test
+<b>require "graphql/guard/testing"</b>
+
+posts = QueryType.<b>field_with_guard('posts', GraphqlPolicy)</b>
+result = posts.<b>guard(obj, args, ctx)</b>
+expect(result).to eq(true)
+</pre>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/exAspArk/graphql-guard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Graphql::Guard project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/exAspArk/graphql-guard/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/guard"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/graphql-guard.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "graphql/guard/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-guard-cody"
+  spec.version       = GraphQL::Guard::VERSION
+  spec.authors       = ["exAspArk"]
+  spec.email         = ["exaspark@gmail.com"]
+
+  spec.summary       = %q{Simple authorization gem for graphql-ruby}
+  spec.description   = %q{Simple authorization gem for graphql-ruby}
+  spec.homepage      = "https://github.com/exAspArk/graphql-guard"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec|images)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1.0' # keyword args
+
+  spec.add_runtime_dependency "graphql_cody", ">= 1.10.0", "< 2"
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/graphql/guard/testing.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Field
+    NoGuardError = Class.new(StandardError)
+
+    def guard(*args)
+      raise NoGuardError.new("Get your field by calling: Type.field_with_guard('#{name}')") unless @__guard_instance
+
+      guard_proc = @__guard_instance.find_guard_proc(@__guard_type, self)
+      raise NoGuardError.new("Guard lambda does not exist for #{@__guard_type}.#{name}") unless guard_proc
+
+      guard_proc.call(*args)
+    end
+
+    def __set_guard_instance(policy_object, guard_type)
+      @__policy_object = policy_object
+      @__guard_type = guard_type
+      @__guard_instance = GraphQL::Guard.new(policy_object: policy_object)
+    end
+  end
+
+  class Schema
+    class Object
+      def self.field_with_guard(field_name, policy_object = nil)
+        field = fields[field_name]
+        return unless field
+
+        field.to_graphql.clone.tap do |f|
+          f.__set_guard_instance(policy_object, self.to_graphql)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/guard/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Guard
+    VERSION = "2.0.0"
+  end
+end

data/lib/graphql/guard.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "graphql"
+require "graphql/guard/version"
+
+module GraphQL
+  class Guard
+    NotAuthorizedError = Class.new(StandardError)
+
+    ANY_FIELD_NAME = :'*'
+
+    DEFAULT_NOT_AUTHORIZED = ->(type, field) do
+      raise NotAuthorizedError.new("Not authorized to access: #{type}.#{field}")
+    end
+
+    MASKING_FILTER = ->(schema_member, ctx) do
+      mask = schema_member.graphql_definition.metadata[:mask]
+      mask ? mask.call(ctx) : true
+    end
+
+    attr_reader :policy_object, :not_authorized
+
+    def initialize(policy_object: nil, not_authorized: DEFAULT_NOT_AUTHORIZED)
+      @policy_object = policy_object
+      @not_authorized = not_authorized
+    end
+
+    def use(schema_definition)
+      if schema_definition.interpreter?
+        schema_definition.tracer(self)
+      else
+        raise "Please use the graphql gem version >= 1.10 with GraphQL::Execution::Interpreter"
+      end
+
+      add_schema_masking!(schema_definition)
+    end
+
+    def trace(event, trace_data)
+      if event == 'execute_field'
+        ensure_guarded(trace_data) { yield }
+      else
+        yield
+      end
+    end
+
+    def find_guard_proc(type, field)
+      return unless type.respond_to?(:type_class)
+
+      inline_guard(field) ||
+        policy_object_guard(type.type_class, field.name.to_sym) ||
+        inline_guard(type) ||
+        policy_object_guard(type.type_class, ANY_FIELD_NAME)
+    end
+
+    private
+
+    def add_schema_masking!(schema_definition)
+      schema_definition.class_eval do
+        def self.default_filter
+          GraphQL::Filter.new(except: default_mask).merge(only: MASKING_FILTER)
+        end
+      end
+    end
+
+    def ensure_guarded(trace_data)
+      field = trace_data[:field]
+      guard_proc = find_guard_proc(field.owner, field)
+      return yield unless guard_proc
+
+      if guard_proc.call(trace_data[:object], args(trace_data), trace_data[:query].context)
+        yield
+      else
+        not_authorized.call(field.owner.graphql_definition, field.name.to_sym)
+      end
+    end
+
+    def args(trace_data)
+      if trace_data[:arguments].key?(:input) && !trace_data[:arguments][:input].is_a?(Hash)
+        return trace_data[:arguments][:input] # Relay mutation input
+      end
+
+      trace_data[:arguments]
+    end
+
+    def policy_object_guard(type, field_name)
+      @policy_object && @policy_object.guard(type, field_name)
+    end
+
+    def inline_guard(type_or_field)
+      type_or_field.graphql_definition.metadata[:guard]
+    end
+  end
+end
+
+GraphQL::ObjectType.accepts_definitions(guard: GraphQL::Define.assign_metadata_key(:guard))
+GraphQL::Field.accepts_definitions(guard: GraphQL::Define.assign_metadata_key(:guard))
+GraphQL::Field.accepts_definitions(mask: GraphQL::Define.assign_metadata_key(:mask))
+GraphQL::Schema::Object.accepts_definition(:guard)
+GraphQL::Schema::Field.accepts_definition(:guard)
+GraphQL::Schema::Field.accepts_definition(:mask)

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: graphql-guard-cody
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- exAspArk
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql_cody
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Simple authorization gem for graphql-ruby
+email:
+- exaspark@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-guard.gemspec
+- lib/graphql/guard.rb
+- lib/graphql/guard/testing.rb
+- lib/graphql/guard/version.rb
+homepage: https://github.com/exAspArk/graphql-guard
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Simple authorization gem for graphql-ruby
+test_files: []