authorized_transaction 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a61369cc8e832baee931ff87c611c90147efc38a9db24cc75a779e97cc47c92
-  data.tar.gz: ce349d060ebb6eb9b239699d293c08340e7f71519d944830b85d1f88da7c3f53
+  metadata.gz: a0bdbd2a2fc11dfa9e747b42ac807700f0c4656e9bdd328dfdb0bf3877c04bda
+  data.tar.gz: 7379aed3cf7449614cdbaca94eb60ae61b00c40134cab9213097d7d1c970d9b7
 SHA512:
-  metadata.gz: f7d30b70db64e01ebfa4c5c62603bcbddba90a8ccbd0bfe9af2350b23b103bf11647530fa6e4d530cb166f23d8d45f1a8151e012f6c2a89faf825b4bbfd20dfd
-  data.tar.gz: 741ec7d1d10449d903c0f9ffea37fad0e6eeb48762e357c549adffbd82f2a9e3b86f29bbfa9e81a9b1e410517702a1f2f246af86b2ffc91b03522acadca9fee8
+  metadata.gz: fa48ac71bcaf57ce84bb5e50bcbd9ca5fbc44458332f68c2e04311e0ffad69b2d8be9fea55c884816037b7fc42c238e2bbcfc118f0cb8193b694ab9f4c5b002c
+  data.tar.gz: 2373918ea349d71d68c13405b06ec890166fd89538a521a821f951e9d303433bbb2c2e5372dc55c53748e1641c3156b68bdecffd8ecb6b327868494b2ada5170

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 # Changelog
 
+## 0.3.0
+
+- Change `AuthorizedTransaction.configure` to return self if there is no block
+- Change `AuthorizedTransaction.configure` execution in context of the controller
+- Change all settings `*_proc` execution in context of the controller
+- Add `transaction_proc` to change how a transaction is created via configuration
+- Add tests
+- Add examples and configuration to README.md
+- Add explicit notion of _not_ depending on `cancan(can)` to README.md
+- Remove dependency on `activerecord`
+
 ## 0.2.0
 
-- Add configuration via `ResourceAllowHeader.configure`
+- Allow for configuration via `AuthorizedTransaction.configure`
 
 ## 0.1.0
 

data/Gemfile.lock

@@ -1,25 +1,17 @@
 PATH
   remote: .
   specs:
-    authorized_transaction (0.2.0)
-      activerecord (>= 4.0.0)
+    authorized_transaction (0.3.0)
       activesupport (>= 4.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.2)
-      activesupport (= 5.2.2)
-    activerecord (5.2.2)
-      activemodel (= 5.2.2)
-      activesupport (= 5.2.2)
-      arel (>= 9.0)
     activesupport (5.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (9.0.0)
     concurrent-ruby (1.1.4)
     i18n (1.5.3)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -4,7 +4,7 @@
 [![Gem Version](https://badge.fury.io/rb/authorized_transaction.svg)](https://badge.fury.io/rb/authorized_transaction)
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 
-Authorize a certain block with cancan
+Authorize a certain block with cancan(can), or any other authorization framework that exposes a method `can?`.
 
 ## Installation
 
@@ -66,17 +66,38 @@ class Book::SignatureController < ApiController
 end
 ```
 
+By default it will use `ActiveRecord::Base.transaction` to start the transaction, but you may override this:
+```ruby
+AuthorizedTransaction.configure do
+  self.transaction_proc = proc { || CreateDatabaseTransaction.call { yield } }
+end
+
+:authorize_proc, :implicit_action_proc,
+```
+
+The action passed to `authorize_proc` or `can?` is configured by `implicit_action_key` and defaults to `action`:
+```ruby
+AuthorizedTransaction.configure.implicit_action_key = :authorized_action
+```
+
 ### Configuration
 
+- By default it uses `can?` as defined on your controller, but you can configure this via `authorize_proc`.
+- By default it uses the `implicit_action` as defined by `implicit_action_key`, as written above, to determine the
+  implicit action when it's not given. You can also configure these via `implicit_action_key` (fetching from `params`)
+  or `implicit_action_proc` to change completely.
+
 In an initializer you can set procs in order to change the default behaviour:
 
 ```ruby
-AuthorizedTransaction.configure do |this|
-  this.implicit_action_proc = proc { |controller| controller.action_name.to_sym }
-  this.authorize_proc = proc { |action, resource, controller| action == :whatever || controller.can?(action, resource) }
+AuthorizedTransaction.configure do
+  self.implicit_action_proc = proc { |controller| controller.action_name.to_sym }
+  self.authorize_proc = proc { |action, resource, controller| action == :whatever || controller.can?(action, resource) }
 end
 ```
 
+Other configuration options are listed above.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can

data/authorized_transaction.gemspec

@@ -36,8 +36,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'activesupport', '>= 4.0.0'
-  spec.add_dependency 'activerecord', '>= 4.0.0'
-
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

data/lib/authorized_transaction.rb

@@ -1,20 +1,19 @@
 require "authorized_transaction/version"
 
-require 'active_record'
 require 'active_support/concern'
 require 'active_support/core_ext/module/attribute_accessors'
 
 module AuthorizedTransaction
   extend ActiveSupport::Concern
-  class Error < StandardError; end
+  class Error < RuntimeError; end
 
-  mattr_accessor :authorize_proc, :implicit_action_proc, :implicit_action_key
+  mattr_accessor :authorize_proc, :implicit_action_proc, :implicit_action_key, :transaction_proc
 
-  def self.configure
-    yield self
+  def self.configure(&block)
+    block_given? ? instance_exec(self, &block) : self
   end
 
-  class TransactionUnauthorized < RuntimeError
+  class TransactionUnauthorized < Error
     attr_reader :action, :resource
 
     def initialize(action, resource)
@@ -49,7 +48,7 @@ module AuthorizedTransaction
     #   end
     #
     def authorized_transaction(action: implicit_action)
-      ActiveRecord::Base.transaction do
+      create_transaction do
         resource = yield
         authorize! action, resource
         resource
@@ -68,15 +67,24 @@ module AuthorizedTransaction
 
   def implicit_action
     if implicit_action_proc.respond_to?(:call)
-      return implicit_action_proc(self)
+      return instance_exec(self, &implicit_action_proc)
     end
 
     params[implicit_action_key || :action]
   end
 
+  def create_transaction(&block)
+    if transaction_proc.respond_to?(:call)
+      transaction_proc.call(&block)
+    else
+      # Expect active record to be loaded by now
+      ActiveRecord::Base.transaction(&block)
+    end
+  end
+
   def authorized?(action, resource)
     if authorize_proc.respond_to?(:call)
-      return authorize_proc(action, resource, self)
+      return instance_exec(action, resource, self, &authorize_proc)
     end
 
     can?(action, resource)

data/lib/authorized_transaction/version.rb

@@ -1,3 +1,3 @@
 module AuthorizedTransaction
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authorized_transaction
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement