ostiary 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fb578931e7699371535e5d759d387d36587e922d71e9f4c748cf115ec687af4
-  data.tar.gz: 6134612b7f338b2a2511ca501e8aa3d6cf0100e6df6f7716fbfccc5cdaf5ddb5
+  metadata.gz: 5816e2a27296da2fc83da9d64bb2d5328692bab4b76d0a3e34b30e33e72babe5
+  data.tar.gz: 8058838062c1d85b4002aa3c1a9769447252808070ead4e24124d5a538487c16
 SHA512:
-  metadata.gz: 52d562092fdd9555ddb5b8e52073c2c6a939aba1b664e9027f97829a45b3ef363d097811ffea88d7351f026f7ccd73c141a4a67c3ea39615083372b5ee9471e2
-  data.tar.gz: a5f3d43534641beaa6923129a71e8d05da2d707c42ef3ebe9ff7b58527ec681894adf3063f0320dfb7ea2a8e95cb718cbd339c64e1437c27db42ff2f7623c9f2
+  metadata.gz: fa26b3d04b56f3a06720a6f97f2c0ca46bcbf9db9c591cdff7c72f4b218c16e69b6774b569bb03079cb9481d632d2e249f4b547944369bab24d09031e07e9f62
+  data.tar.gz: 38553e22331617a97097f9cba9704758e18986ff8399846a13758ccfee0b7fa5305290c721cf2277e4f9001b0f4d31d39c58125d114226deaa43b9c9771a322a

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ostiary
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Jacques Hakvoort
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-11 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,29 +80,12 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- lib/ostiary.rb
-- lib/ostiary/controller_helper.rb
-- lib/ostiary/ostiary.rb
-- lib/ostiary/policy.rb
-- lib/ostiary/policy_exempted.rb
-- lib/ostiary/policy_limited.rb
-- lib/ostiary/version.rb
-- ostiary.gemspec
+files: []
 homepage: https://github.com/nedap/ostiary
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,8 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: Limit access to (rails) controllers/actions with policies
 test_files: []

data/.circleci/config.yml

@@ -1,42 +0,0 @@
-version: 2
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.6.5
-
-    working_directory: ~/repo
-
-    steps:
-      - checkout
-
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-            - v1-dependencies-
-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      - run:
-          name: run tests
-          command: |
-            mkdir /tmp/test-results
-            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
-              circleci tests split --split-by=timings)"
-
-            bundle exec rspec \
-              --format progress \
-              --format RspecJunitFormatter \
-              --out /tmp/test-results/rspec.xml \
-              --format progress \
-              $TEST_FILES
-
-      - store_test_results:
-          path: /tmp/test-results

data/.gitignore

@@ -1,53 +0,0 @@
-*.gem
-*.rbc
-.rspec_status
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-.DS_Store

data/.rspec

@@ -1,3 +0,0 @@
---color
---format documentation
---profile

data/.ruby-gemset

@@ -1 +0,0 @@
-ostiary

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.3.5

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017 Nedap
-
-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

@@ -1,94 +0,0 @@
-# Ostiary
-
-An ostiarius, a Latin word sometimes anglicized as ostiary but often literally translated as porter or doorman, originally was a servant or guard posted at the entrance of a building. See also gatekeeper.
-
-## Functionality
-
-[![CircleCI Status](https://circleci.com/gh/nedap/ostiary.svg?style=svg)](https://circleci.com/gh/nedap/ostiary)
-
-This gem will help you enforce 'policies' when viewing controllers/actions.
-This is done by requiring certain roles for controllers, where you can
-optionally include or exclude certain actions.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'ostiary'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ostiary
-
-## Usage
-
-### Primary setup
-
-In your base Controller class do the following for Rails:
-
-```ruby
-# This class creates a class accessor called :ostiary on each (inherited) controller.
-#  With each controller created, it will stack the policies you add
-include Ostiary::ControllerHelper
-
-before_filter :ensure_authorized!
-
-# Because each ostiary is unique for a controller, you only have to supply the current action.
-#  With this, it can check if there are certain policies that will be broken.
-def ensure_authorized!
-  self.class.ostiary.authorize!(action) do |name|
-    # Your authorization method using name.
-    #  e.g. `current_user.has_right?(name)`
-  end
-rescue Ostiary::PolicyBroken => error
-  # We re-raise the Error as a RoutingError in Rails
-  #  You can also do `return head :forbidden` if that's more in line with your needs.
-  raise ActionController::RoutingError.new(error.message)
-end
-```
-
-### Securing controllers
-
-In each controller you wish to secure, you can call `ostiary_policy`, just like `before_filter` & `after_filter` of Rails.
-
-```ruby
-# Require the :list role on the entire controller
-ostiary_policy :list
-
-# Require the :view role only on the index & show actions
-ostiary_policy :view, only: [:index, :show]
-
-# Require the :edit role except on the index & show actions
-ostiary_policy :edit, except: [:index, :show]
-```
-
-These policies will be added to the ostiary instance created for each Controller Class. It will also include each policy inherited from parent classes.
-
-### Checking for a right
-
-You can also ask if a user is authorized to access to a certain path (url).
-
-in your Controller:
-
-```ruby
-def authorized?(path)
-  # recognize_path is a Rails Routing helper that will return a hash with the controller
-  #  and action of the path you supplied. We'll have to transform that String of the
-  #  controller into an actual Class.
-  return false unless route = Rails.application.routes.recognize_path(path)
-  requested_controller = "#{route[:controller]}_controller".camelize.constantize
-  requested_controller.ostiary.authorized?(route[:action]) do |role|
-    # Your authorization method using name.
-  end
-end
-```
-
-## License
-
-ostiary is Copyright 2017 nedap and released under the MIT license which you should find included in the [LICENSE.txt](LICENSE.txt) file.

data/Rakefile

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

data/lib/ostiary.rb

@@ -1,10 +0,0 @@
-require "ostiary/version"
-require "ostiary/ostiary"
-require "ostiary/policy"
-require "ostiary/policy_limited"
-require "ostiary/policy_exempted"
-require "ostiary/controller_helper"
-
-module Ostiary
-  class PolicyBroken < StandardError; end
-end

data/lib/ostiary/controller_helper.rb

@@ -1,52 +0,0 @@
-module Ostiary
-  module ControllerHelper
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-
-      def inherited(subclass)
-        subclass.ostiary.policies += self.ostiary.policies
-        super
-      end
-
-      def ostiary
-        @ostiary ||= Ostiary.new
-      end
-
-      def required_application_role(role, actions = {})
-        warn "[DEPRECATION] `required_application_role` is deprecated.  Please use `ostiary_policy` instead."
-        ostiary_policy(role, actions)
-      end
-
-      # We want to give the option of setting a policy for one action, based on ::Role
-      # So we'll copy the way the filters in controllers work.
-      # Only apply the role to certain action(s)
-      #  only: [*actions]
-      # Exclude action(s) from requiring a role
-      #  except: [*actions]
-      # By default a given role will be required for every action
-      # Override role checking by passing a symbol as method;
-      #   ostiary_policy method: :master?, only: :show
-      # One line creates one policy, which are immediately created with the proper class
-      def ostiary_policy(role = nil, only: nil, except: nil, method: nil)
-        raise ArgumentError, "Use at least role or method" unless method || role
-        raise ArgumentError, "Use either role or method"       if method && role
-        raise ArgumentError, "Use either only or except"       if except && only
-        raise ArgumentError, "Use a symbol for method:"        if method && !(method.is_a? Symbol)
-
-        if actions.empty?
-          ostiary.policies << Policy.new(role, method: method&.to_proc)
-        elsif only
-          ostiary.policies << PolicyLimited.new(role, only, method: method&.to_proc)
-        elsif except
-          ostiary.policies << PolicyExempted.new(role, except, method: method&.to_proc)
-        end
-      end
-
-    end
-
-  end
-end

data/lib/ostiary/ostiary.rb

@@ -1,23 +0,0 @@
-module Ostiary
-  class Ostiary
-    attr_accessor :policies
-
-    def initialize
-      @policies = []
-    end
-
-    def authorize!(action, &block)
-      policies.each do |policy|
-        next if policy.met?(action, block)
-        raise PolicyBroken, policy.error_message(action)
-      end
-    end
-
-    def authorized?(action, &block)
-      policies.all? do |policy|
-        policy.met?(action, block)
-      end
-    end
-
-  end
-end

data/lib/ostiary/policy.rb

@@ -1,25 +0,0 @@
-module Ostiary
-  class Policy
-    attr_reader :name, :method, :actions
-
-    def initialize(name, actions = [], method: nil)
-      @name = name
-      @method = method
-      @actions = actions
-    end
-
-    def inspect
-      "#{name}"
-    end
-
-    def met?(_action)
-      return yield name unless method
-      method.call
-    end
-
-    def error_message(action)
-      "#{action} requires #{name}"
-    end
-
-  end
-end

data/lib/ostiary/policy_exempted.rb

@@ -1,18 +0,0 @@
-module Ostiary
-  class PolicyExempted < Policy
-
-    def inspect
-      "#{name} except for #{actions.to_sentence}"
-    end
-
-    def met?(action)
-      return true if actions.include?(action)
-      super
-    end
-
-    def error_message(action)
-      "#{action} not exempted for #{name}"
-    end
-
-  end
-end

data/lib/ostiary/policy_limited.rb

@@ -1,18 +0,0 @@
-module Ostiary
-  class PolicyLimited < Policy
-
-    def inspect
-      "#{name} only for #{actions.to_sentence}"
-    end
-
-    def met?(action)
-      return true unless actions.include?(action)
-      super
-    end
-
-    def error_message(action)
-      "#{action} limited by #{name}"
-    end
-
-  end
-end

data/lib/ostiary/version.rb

@@ -1,3 +0,0 @@
-module Ostiary
-  VERSION = "0.11.0"
-end

data/ostiary.gemspec

@@ -1,36 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ostiary/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "ostiary"
-  spec.version       = Ostiary::VERSION
-  spec.author        = "Jacques Hakvoort"
-  spec.authors       = ["Jacques Hakvoort"]
-  spec.email         = ["jacques.hakvoort@nedap.com"]
-
-  spec.homepage      = "https://github.com/nedap/ostiary"
-  spec.summary       = "Limit access to (rails) controllers/actions with policies"
-  spec.description   = <<-TXT;
-    Ostiary is a security gem for your (rails) controllers & actions.
-    It employs a before_filter-like call to set policies per controller/action.
-    You can pass your own security call in block and handle the PolicyBroken
-    yourself.
-    Policies are also inherited from parent classes.
-    From wikipedia: "An ostiarius, a Latin word sometimes anglicized as ostiary
-    but often literally translated as porter or doorman, originally was a
-    servant or guard posted at the entrance of a building. See also gatekeeper."
-  TXT
-  spec.license = 'MIT'
-
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency 'rspec_junit_formatter'
-end