action_policy-graphql 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6ef7017bd2bda6778f20997ea146431c9ed368f35ca257fd96c2050f3036c4
-  data.tar.gz: 4270fc41dadbbce556841298bcd6b2de62bafd7ac9826dd7b7ea60907d6ba98e
+  metadata.gz: b5ed86f1884fc8a9468ed78e7476afc81cf68af0f65a549df4e213f5ab50b53f
+  data.tar.gz: 1991a6c3c2414a85bf3738cbdc600fda90d989a059f613200445d6b1d2c47c9e
 SHA512:
-  metadata.gz: 2337aa180c36185a1790863df06346c36ad17e3335d1dcc724ba6de9e9b498d0fb6c36336ee7cabe0489995dfe782447f9c1fe6da1747849a3ae58acb9a6aa90
-  data.tar.gz: f7448255b43d4cec0e5f837a11c00b48c74148ba0f2839520f9466286ff5f53594c1bcf1f033a08479790cc426a0a2feaf475a2c11739b2344a2231204b3f52f
+  metadata.gz: f7a9012c86bcaad3c1220a7f9621655f3ae3ecc7f314672bf58c3f60d09112aa9605f3c361259bc8a7fb39d147ca696409ca20bb6fe92cf88c0cf1bc8c90d5a0
+  data.tar.gz: 967fa7b9dfc0638469744b810b0329f703eacebd6ba66f960448953b172476c183d1bda2e25841c61e963da6bbf8e091243fce0bb0c0409e3c3b53a38d1bc47b

data/CHANGELOG.md

@@ -2,7 +2,30 @@
 
 ## master (unreleased)
 
-## 0.4.0 (2010-03-11)
+## 0.5.0 (2020-10-07)
+
+- Add `preauthorize_mutation_raise_exception` configuration parameter. ([@palkan][])
+
+Similar to `preauthorize_raise_exception` but only for mutations.
+Fallbacks to `preauthorize_raise_exception` unless explicitly specified.
+
+- Add `preauthorize_raise_exception` configuration parameter. ([@palkan][])
+
+Similar to `authorize_raise_exception` but for `preauthorize: true` fields.
+Fallbacks to `authorize_raise_exception` unless explicitly specified.
+
+- Add ability to specify custom field options for `expose_authorization_rules`. ([@bibendi][])
+
+Now you can add additional options for underflying `field` call via `field_options` parameter:
+
+```ruby
+expose_authorization_rules :show?, field_options: {camelize: false}
+
+# equals to
+field :can_show, ActionPolicy::GraphQL::Types::AuthorizationResult, null: false, camelize: false
+```
+
+## 0.4.0 (2020-03-11)
 
 - **Require Ruby 2.5+**. ([@palkan][])
 
@@ -42,3 +65,4 @@ Action Policy helpers there.
 [@palkan]: https://github.com/palkan
 [@haines]: https://github.com/haines
 [@sponomarev]: https://github.com/sponomarev
+[@bibendi]: https://github.com/bibendi

data/README.md

@@ -1,5 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/action_policy-graphql.svg)](https://badge.fury.io/rb/action_policy-graphql)
-[![Build Status](https://travis-ci.org/palkan/action_policy-graphql.svg?branch=master)](https://travis-ci.org/palkan/action_policy-graphql)
+![Build](https://github.com/palkan/action_policy-graphql/workflows/Build/badge.svg)
+![JRuby Build](https://github.com/palkan/action_policy-graphql/workflows/JRuby%20Build/badge.svg)
 [![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://actionpolicy.evilmartians.io/#/graphql)
 
 # Action Policy GraphQL
@@ -7,6 +8,7 @@
 This gem provides an integration for using [Action Policy](https://github.com/palkan/action_policy) as an authorization framework for GraphQL applications (built with [`graphql` ruby gem](https://graphql-ruby.org)).
 
 This integration includes the following features:
+
 - Fields & mutations authorization
 - List and connections scoping
 - [**Exposing permissions/authorization rules in the API**](https://evilmartians.com/chronicles/exposing-permissions-in-graphql-apis-with-action-policy).
@@ -21,13 +23,9 @@ This integration includes the following features:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "action_policy-graphql", "~> 0.3"
+gem "action_policy-graphql"
 ```
 
-And then execute:
-
-    $ bundle
-
 ## Usage
 
 **NOTE:** this is a quick overview of the functionality provided by the gem. For more information see the [documentation](https://actionpolicy.evilmartians.io/#/graphql).

data/lib/action_policy-graphql.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require "ruby-next"
 require "action_policy/graphql"

data/lib/action_policy/graphql.rb

@@ -30,12 +30,33 @@ module ActionPolicy
       # Which prefix to use for authorization fields
       # Defaults to `"can_"`
       attr_accessor :default_authorization_field_prefix
+
+      attr_writer :preauthorize_raise_exception
+
+      # Whether to raise an exception if preauthorization fails
+      # Equals to authorize_raise_exception unless explicitly set
+      def preauthorize_raise_exception
+        return authorize_raise_exception if @preauthorize_raise_exception.nil?
+        @preauthorize_raise_exception
+      end
+
+      # Whether to raise an exception if preauthorization fails
+      # Equals to preauthorize_raise_exception unless explicitly set
+      attr_writer :preauthorize_mutation_raise_exception
+
+      def preauthorize_mutation_raise_exception
+        return preauthorize_raise_exception if @preauthorize_mutation_raise_exception.nil?
+
+        @preauthorize_mutation_raise_exception
+      end
     end
 
     self.default_authorize_rule = :show?
     self.default_preauthorize_list_rule = :index?
     self.default_preauthorize_node_rule = :show?
     self.authorize_raise_exception = true
+    self.preauthorize_raise_exception = nil
+    self.preauthorize_mutation_raise_exception = nil
     self.default_authorization_field_prefix = "can_"
   end
 end

data/lib/action_policy/graphql/authorized_field.rb

@@ -24,7 +24,13 @@ module ActionPolicy
       class AuthorizeExtension < Extension
         def apply
           @to = extract_option(:to) { ::ActionPolicy::GraphQL.default_authorize_rule }
-          @raise = extract_option(:raise) { ::ActionPolicy::GraphQL.authorize_raise_exception }
+          @raise = extract_option(:raise) do
+            if field.mutation
+              ::ActionPolicy::GraphQL.authorize_mutation_raise_exception
+            else
+              ::ActionPolicy::GraphQL.authorize_raise_exception
+            end
+          end
         end
 
         def after_resolve(value:, context:, object:, **_rest)
@@ -54,7 +60,13 @@ module ActionPolicy
             end
           end
 
-          @raise = extract_option(:raise) { ::ActionPolicy::GraphQL.authorize_raise_exception }
+          @raise = extract_option(:raise) do
+            if field.mutation
+              ::ActionPolicy::GraphQL.preauthorize_mutation_raise_exception
+            else
+              ::ActionPolicy::GraphQL.preauthorize_raise_exception
+            end
+          end
         end
 
         def resolve(context:, object:, arguments:, **_rest)

data/lib/action_policy/graphql/fields.rb

@@ -3,10 +3,7 @@
 require "action_policy/graphql/types/authorization_result"
 
 module ActionPolicy
-  unless "".respond_to?(:then)
-    require "action_policy/ext/yield_self_then"
-    using ActionPolicy::Ext::YieldSelfThen
-  end
+  using RubyNext
 
   module GraphQL
     # Add DSL to add policy rules as fields
@@ -26,26 +23,20 @@ module ActionPolicy
         base.extend ClassMethods
       end
 
-      def allowance_to(rule, target = object, **options)
-        policy_for(record: target, **options).then do |policy|
-          policy.apply(authorization_rule_for(policy, rule))
-          policy.result
-        end
-      end
-
       module ClassMethods
-        def expose_authorization_rules(*rules, field_name: nil, prefix: ::ActionPolicy::GraphQL.default_authorization_field_prefix, **options)
+        def expose_authorization_rules(*rules, field_name: nil, prefix: ::ActionPolicy::GraphQL.default_authorization_field_prefix, field_options: {}, **options)
           raise ArgumentError, "Cannot specify field_name for multiple rules" if rules.size > 1 && !field_name.nil?
 
           rules.each do |rule|
             gql_field_name = field_name || "#{prefix}#{rule.to_s.delete("?")}"
 
             field gql_field_name,
-                  ActionPolicy::GraphQL::Types::AuthorizationResult,
-                  null: false
+              ActionPolicy::GraphQL::Types::AuthorizationResult,
+              null: false,
+              **field_options
 
             define_method(gql_field_name) do
-              allowance_to(rule, **options)
+              allowance_to(rule, object, **options)
             end
           end
         end

data/lib/action_policy/graphql/version.rb

@@ -2,6 +2,6 @@
 
 module ActionPolicy
   module GraphQL
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_policy-graphql
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: action_policy
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: ruby-next
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -80,48 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.67.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.67.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-md
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.39
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.39
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -143,21 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- action_policy-graphql.gemspec
-- bin/console
-- bin/setup
-- gemfiles/action_policy/0.3.gemfile
-- gemfiles/action_policy/master.gemfile
-- gemfiles/graphql/master.gemfile
-- gemfiles/jruby.gemfile
 - lib/action_policy-graphql.rb
 - lib/action_policy/graphql.rb
 - lib/action_policy/graphql/authorized_field.rb

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.local

data/.rubocop.yml

@@ -1,54 +0,0 @@
-require:
-  - standard/cop/semantic_blocks
-  - rubocop-md
-
-inherit_gem:
-  standard: config/base.yml
-
-AllCops:
-  Exclude:
-    - 'bin/*'
-    - 'tmp/**/*'
-    - 'Gemfile'
-    - 'vendor/**/*'
-    - 'gemfiles/**/*'
-  DisplayCopNames: true
-  TargetRubyVersion: 2.5
-
-Standard/SemanticBlocks:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: no_comma
-
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: no_comma
-
-Layout/AlignParameters:
-  EnforcedStyle: with_first_parameter
-
-Lint/Void:
-  Exclude:
-    - '**/*.md'
-
-# See https://github.com/rubocop-hq/rubocop/issues/4222
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - 'spec/**/*'
-    - '**/*.md'
-
-Lint/DuplicateMethods:
-  Exclude:
-    - '**/*.md'
-
-Naming/FileName:
-  Exclude:
-    - 'lib/action_policy-graphql.rb'
-    - '**/*.md'
-
-Layout/InitialIndentation:
-  Exclude:
-    - 'CHANGELOG.md'

data/.travis.yml

@@ -1,41 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-notifications:
-  email: false
-
-before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v '< 2'
-
-script:
-  - bundle exec rake
-
-matrix:
-  fast_finish: true
-  include:
-    - rvm: ruby-head
-      gemfile: gemfiles/graphql/master.gemfile
-    - rvm: 2.6
-      gemfile: gemfiles/graphql/master.gemfile
-    - rvm: 2.6
-      gemfile: gemfiles/action_policy/master.gemfile
-    - rvm: 2.6
-      gemfile: gemfiles/action_policy/0.3.gemfile
-    - rvm: jruby-9.2.8.0
-      gemfile: gemfiles/jruby.gemfile
-    - rvm: 2.7
-      gemfile: Gemfile
-    - rvm: 2.6
-      gemfile: Gemfile
-    - rvm: 2.5
-      gemfile: Gemfile
-  allow_failures:
-    - rvm: ruby-head
-      gemfile: gemfiles/graphql/master.gemfile
-    - rvm: 2.6
-      gemfile: gemfiles/graphql/master.gemfile
-    - rvm: 2.6
-      gemfile: gemfiles/action_policy/master.gemfile
-    - rvm: jruby-9.2.8.0
-      gemfile: gemfiles/jruby.gemfile

data/Gemfile

@@ -1,16 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in action_policy-graphql.gemspec
-gemspec
-
-gem "pry-byebug", platform: :mri
-
-local_gemfile = File.join(__dir__, "Gemfile.local")
-
-if File.exist?(local_gemfile)
-  # Specify custom action_policy/graphql-ruby version in Gemfile.local
-  eval(File.read(local_gemfile)) # rubocop:disable Security/Eval
-else
-  gem "action_policy", "~> 0.4.0"
-  gem "graphql", "~> 1.9.3"
-end

data/Rakefile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop/rake_task"
-require "rspec/core/rake_task"
-
-RuboCop::RakeTask.new
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: [:rubocop, :spec]

data/action_policy-graphql.gemspec

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "action_policy/graphql/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "action_policy-graphql"
-  spec.version       = ActionPolicy::GraphQL::VERSION
-  spec.authors       = ["Vladimir Dementyev"]
-  spec.email         = ["dementiev.vm@gmail.com"]
-
-  spec.summary       = "Action Policy integration for GraphQL-Ruby"
-  spec.description   = "Action Policy integration for GraphQL-Ruby"
-  spec.homepage      = "https://github.com/palkan/action_policy-graphql"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-
-  spec.metadata = {
-    "bug_tracker_uri" => "https://github.com/palkan/action_policy-graphql/issues",
-    "changelog_uri" => "https://github.com/palkan/action_policy-graphql/blob/master/CHANGELOG.md",
-    "documentation_uri" => "https://actionpolicy.evilmartians.io/#/graphql",
-    "homepage_uri" => "https://github.com/palkan/action_policy-graphql",
-    "source_code_uri" => "https://github.com/palkan/action_policy-graphql"
-  }
-
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = ">= 2.5.0"
-
-  spec.add_dependency "action_policy", ">= 0.3.0"
-  spec.add_dependency "graphql", ">= 1.9.3"
-
-  spec.add_development_dependency "bundler", ">= 1.15"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.8"
-  spec.add_development_dependency "rubocop", "~> 0.67.0"
-  spec.add_development_dependency "rubocop-md", "~> 0.3"
-  spec.add_development_dependency "standard", "~> 0.0.39"
-  spec.add_development_dependency "i18n"
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "action_policy/graphql"
-
-# 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

@@ -1,8 +0,0 @@
-#!/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/gemfiles/action_policy/0.3.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "action_policy", "~> 0.3.0"
-
-gemspec path: "../.."

data/gemfiles/action_policy/master.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "action_policy", github: "palkan/action_policy"
-
-gemspec path: "../.."

data/gemfiles/graphql/master.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "graphql", github: "rmosolgo/graphql-ruby"
-
-gemspec path: "../.."

data/gemfiles/jruby.gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: ".."