graphql-pundit 0.1.0

data/.rubocop_modified.yml

@@ -0,0 +1,21 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/AlignParameters:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: required
+dist: trusty
+
+language: ruby
+
+rvm:
+  - 2.4.1
+
+notifications:
+  email: false
+
+script:
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphql-pundit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tom Gehrke
+
+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,84 @@
+# GraphQL::Pundit
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-pundit', github: 'ontohub/graphql-pundit',
+                      branch: 'master'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+### Add the authorization middleware
+
+Add the following to your GraphQL schema:
+
+```ruby
+MySchema = GraphQL::Schema.define do
+  ...
+  instrument(:field, GraphQL::Pundit::Instrumenter.new)
+  ...
+end
+```
+
+By default, `ctx[:current_user]` will be used as the user to authorize. To change that behavior, pass a symbol to `GraphQL::Pundit::Instrumenter`. 
+
+```ruby
+GraphQL::Pundit::Instrumenter.new(:me) # will use ctx[:me]
+```
+
+### Authorize fields
+
+For each field you want to authorize via Pundit, add the following code to the field definition:
+
+```ruby
+field :email do
+  authorize :read_email
+  resolve ...
+end
+```
+
+By default, this will use the Policy for the parent object (the first argument passed to the resolve proc), checking for `:read_email?` for the current user.
+
+Now, in some cases you'll want to use a different policy, or in case of mutations, the passed object might be `nil`:
+
+```ruby
+field :createUser
+  authorize! :create, User
+  resolve ...
+end
+```
+
+This will use the `:create?` method of the `UserPolicy`.
+
+You might have also noticed the use of `authorize!` instead of `authorize` in this example. The difference between the two is this:
+
+- `authorize` will set the field to `nil` if authorization fails
+- `authorize!` will set the field to `nil` and add an error to the response if authorization fails
+
+You would normally want to use `authorize` for fields in queries, that only e.g. the owner of something can see, while `authorize!` would be usually used in mutations, where you want to communicate to the client that the operation failed because the user is unauthorized.
+## 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/ontohub/graphql-pundit.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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/pundit"
+
+# 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-pundit.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql-pundit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphql-pundit'
+  spec.version       = GraphQL::Pundit::VERSION
+  spec.authors       = ['Ontohub Core Developers']
+  spec.email         = ['ontohub-dev-l@ovgu.de']
+
+  spec.summary       = 'Pundit authorization support for graphql'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/ontohub/graphql-pundit'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'graphql', '~> 1.6.4'
+  spec.add_dependency 'pundit', '~> 1.1.0'
+
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+  spec.add_development_dependency 'simplecov', '~> 0.14.1'
+  spec.add_development_dependency 'codecov', '~> 0.1.10'
+end

data/lib/graphql-pundit.rb

@@ -0,0 +1,17 @@
+require 'graphql-pundit/instrumenter'
+require 'graphql-pundit/version'
+
+require 'graphql'
+
+module GraphQL
+  def self.assign_authorize(raise_unauthorized)
+    lambda do |defn, query, record = nil|
+      GraphQL::Define::InstanceDefinable::AssignMetadataKey.new(:authorize).call(
+        defn,
+        record: record, query: query, raise: raise_unauthorized
+      )
+    end
+  end
+  GraphQL::Field.accepts_definitions authorize: assign_authorize(false)
+  GraphQL::Field.accepts_definitions authorize!: assign_authorize(true)
+end

data/lib/graphql-pundit/instrumenter.rb

@@ -0,0 +1,45 @@
+require 'pundit'
+
+module GraphQL
+  module Pundit
+    class Instrumenter
+      attr_reader :current_user
+
+      def initialize(current_user = :current_user)
+        @current_user = current_user
+      end
+
+      def instrument(_type, field)
+        if field.metadata[:authorize]
+          old_resolve = field.resolve_proc
+          resolve_proc = resolve_proc(current_user,
+                                      old_resolve,
+                                      field.metadata[:authorize])
+          field.redefine do
+            resolve resolve_proc
+          end
+        else
+          field
+        end
+      end
+
+      def resolve_proc(current_user, old_resolve, options)
+        lambda do |obj, args, ctx|
+          query = options[:query].to_s + '?'
+          record = options[:record] || obj
+          begin
+            unless ::Pundit.authorize(ctx[current_user], record, query)
+              raise ::Pundit::NotAuthorizedError
+            end
+            old_resolve.call(obj, args, ctx)
+          rescue ::Pundit::NotAuthorizedError
+            if options[:raise]
+              raise GraphQL::ExecutionError,
+                    "You're not authorized to do this"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql-pundit/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  module Pundit
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: graphql-pundit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ontohub Core Developers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+description: Pundit authorization support for graphql
+email:
+- ontohub-dev-l@ovgu.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_disabled.yml"
+- ".rubocop_enabled.yml"
+- ".rubocop_modified.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-pundit.gemspec
+- lib/graphql-pundit.rb
+- lib/graphql-pundit/instrumenter.rb
+- lib/graphql-pundit/version.rb
+homepage: https://github.com/ontohub/graphql-pundit
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Pundit authorization support for graphql
+test_files: []