active_policy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a7a19a6521efb04caf3097318c71312947e0b0e962ae6c93ce17ac57a8dc908
+  data.tar.gz: 804ef773567ea93e40422765e9dae16fee0a2b78d0429e47384eaa21a1abb06f
+SHA512:
+  metadata.gz: 80ef1909e56d9c608a76b33c6ce27a7da9651a481ba6ca71e6cdd9cea31bd298e6b446b0173e94315a35b7df3590b3352f40cf05c0449bdf24665afd7e84fe49
+  data.tar.gz: 686b25058690e70f31db52826639a211be0da38fa5e105c06f878acc8e8bad9310058f0d15d1943be258d612216b3153101aadd540b89c5e4ae8c603befcac71

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.1.0.pre.3
+install:
+  - bundle
+scrip:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_policy.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'codecov', :require => false, :group => :test

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Panos Dalitsouris
+
+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,56 @@
+[![Build Status](https://travis-ci.org/PanosCodes/active_policy.svg?branch=master)](https://travis-ci.org/PanosCodes/active_policy)
+[![codecov](https://codecov.io/gh/PanosCodes/active_policy/branch/master/graph/badge.svg)](https://codecov.io/gh/PanosCodes/active_policy)
+
+# ActivePolicy
+Active policy is meant to be a way to authorize a request before hitting the controller.
+
+## Installation
+
+```ruby
+gem 'active_policy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_policy
+
+## Usage
+
+ 1. Inside your route.rb
+    ```ruby
+    post 'users/:user_id/segments', to: 'users#register_to_segment', policy: UserPolicy, policy_models: {user_id: User}
+    ```
+
+ 2. Create the user_policy.rb
+
+    ```ruby
+    class UserPolicy < ActivePolicy::Base
+        # @param [User] user
+        #
+        # @return [TrueClass, FalseClass]
+        def register_to_segment?(user)
+            return true if @current_user.is_admin?
+            return true if user.is_staff?
+            false
+        end
+    end
+    ```
+
+## 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/PanosCodes/active_policy.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/active_policy.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/active_policy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_policy"
+  spec.version       = ActivePolicy::VERSION
+  spec.authors       = ["Panos Dalitsouris"]
+  spec.email         = ["hello@panos.codes"]
+
+  spec.summary       = "Authorize a request before hitting the controller."
+  spec.description   = "Active policy is meant to be a way to authorize a request before hitting the controller."
+  spec.homepage      = "https://github.com/PanosCodes/active_policy"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/PanosCodes/active_policy"
+  spec.metadata["changelog_uri"] = "https://github.com/PanosCodes/active_policy"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/bin/console

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

@@ -0,0 +1,8 @@
+require "active_policy/version"
+require 'active_policy/railtie' if defined?(Rails)
+require 'active_policy/base'
+
+module ActivePolicy
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/active_policy/active_policy_middleware.rb

@@ -0,0 +1,42 @@
+require 'active_policy/utilities/utilities'
+class ActivePolicyMiddleware
+  ENV_KEY_REQUEST_METHOD = 'REQUEST_METHOD'
+  ENV_KEY_WARDEN = 'warden'
+
+  # @param [Class] app
+  def initialize(app)
+    @app = app
+  end
+
+  # @param [Hash] env
+  def call(env)
+    params = ActivePolicy::Utilities.route_params(
+        ActionDispatch::Request.new(env).path,
+        env[ENV_KEY_REQUEST_METHOD],
+        Rails.application.routes
+    )
+
+    if params.key?(:policy)
+      policy = params[:policy].new current_user(env)
+      method_name = params[:action] + '?'
+      models = ActivePolicy::Utilities.models_from_route_params(params)
+
+      policy.send(method_name, *models)
+    end
+
+    @app.call(env)
+  end
+
+  private
+
+  # @param [Hash] env
+  #
+  # @return [User, nil]
+  def current_user(env)
+    if env.key?(ENV_KEY_WARDEN)
+      return env[ENV_KEY_WARDEN].user
+    end
+
+    nil
+  end
+end

data/lib/active_policy/base.rb

@@ -0,0 +1,8 @@
+module ActivePolicy
+  class Base
+    # @param [User] current_user
+    def initialize(current_user)
+      @current_user = current_user
+    end
+  end
+end

data/lib/active_policy/railtie.rb

@@ -0,0 +1,8 @@
+require 'active_policy/active_policy_middleware'
+module ActivePolicy
+  class Railtie < Rails::Railtie
+    initializer "railtie.configure_rails_initialization" do |app|
+      app.middleware.use ActivePolicyMiddleware
+    end
+  end
+end

data/lib/active_policy/utilities/utilities.rb

@@ -0,0 +1,24 @@
+module ActivePolicy
+  class Utilities
+  # @param [ActionDispatch::Routing::RouteSet] route_set
+  # @param [String] path
+  # @param [String] method
+  #
+  # @return [Hash]
+  def self.route_params(path, method, route_set)
+    route_set.recognize_path(path, {method: method})
+  end
+
+  # @param [Hash] params
+  #
+  # @return [Array<ActiveRecord>]
+  def self.models_from_route_params(params)
+    models = []
+    raise 'policy_models is missing from route' if params[:policy_models].nil?
+    params[:policy_models].each do |key, value|
+      models << value.find(params[key])
+    end
+    models
+  end
+  end
+end

data/lib/active_policy/version.rb

@@ -0,0 +1,3 @@
+module ActivePolicy
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: active_policy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Panos Dalitsouris
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-16 00:00:00.000000000 Z
+dependencies: []
+description: Active policy is meant to be a way to authorize a request before hitting
+  the controller.
+email:
+- hello@panos.codes
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_policy.gemspec
+- bin/console
+- bin/setup
+- lib/active_policy.rb
+- lib/active_policy/active_policy_middleware.rb
+- lib/active_policy/base.rb
+- lib/active_policy/railtie.rb
+- lib/active_policy/utilities/utilities.rb
+- lib/active_policy/version.rb
+homepage: https://github.com/PanosCodes/active_policy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/PanosCodes/active_policy
+  source_code_uri: https://github.com/PanosCodes/active_policy
+  changelog_uri: https://github.com/PanosCodes/active_policy
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Authorize a request before hitting the controller.
+test_files: []