guarda 0.0.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37fb9b774cc00795bf96edc8655287433b68c4f9f1b95f146cfd28936a887343
-  data.tar.gz: 4a94650d4778d42c8104294f0193b3621f0f7b07c11d0d3c5cf12c156153928b
+  metadata.gz: 6589ad1f554cc85e4de7d7741dbae1f3dadca5ce9470ff8193608e3780f3f9f8
+  data.tar.gz: f58af82e04958ae3224d63655ea0c0557600f66dc30007a8c52bb4968720d281
 SHA512:
-  metadata.gz: a0d29b1ae0d34a9bfa5f2c2bbc5cc076a55d8b394495ef886cb6348e4887740287fae4ba862d4b5536095ac37f4ff04e8309940113f1aea2836224843dc26c3c
-  data.tar.gz: 46843ee2edf9e91337c0828d2a1451f324160f857542cbad424a9a4a290730ff8ecb14deb07b6d231a14bf77f86bfdc5e3e9554d405879b6683fcb75eb4bd76c
+  metadata.gz: e3fdf34785e8357041d476f2425856427b49951dcf371a85f2fefbb68e66e4b24fed6f4f9c8a422bee288fe1da19ed6aa4a3faa9538ffeacaa7323de27d83013
+  data.tar.gz: f9320de4e0061852cc22c39fb377cef0e8a20eaa499b6aa491d5e22d20cf8db739321c8ee79570d1dcc58127e0579c543ada8a478c1248c53aeafceccc581a06

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Abdullah Hashim
+
+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,71 @@
+# Guarda
+
+Is another authorization gem that was heavily inspired by [Pundit](https://rubygems.org/gems/pundit).
+
+It assumes you are using [Current Attributes](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html) to get your currently authenticated user.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add guarda
+```
+
+Include `Guarda::Authorization` in your application controller:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Guarda::Authorization
+end
+```
+
+## Usage
+
+In the controller:
+
+```ruby
+class PostsController < ApplicationController
+  def index
+    authorize
+  end
+
+  def update
+    authorize @post
+  end
+end
+```
+
+In the view:
+
+```erb
+<% if policy("posts").index? %>
+  <%= link_to "Posts", "#" %>
+<% end %>
+
+<% if policy("posts", @post).update? %>
+  <%= link_to "Edit Post", "#" %>
+<% end %>
+```
+
+With this policy class `app/policies/posts_policy.rb`:
+
+```ruby
+class PostsPolicy
+  def initialize(post = nil)
+    @post = post
+  end
+
+  def index?
+    Current.person.admin?
+  end
+
+  def update?
+    @post.author == Current.person
+  end
+end
+```
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/guarda.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/guarda/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "guarda"
+  spec.version = Guarda::VERSION
+  spec.authors = ["Abdullah Hashim"]
+  spec.email = ["abdul@hey.com"]
+
+  spec.summary = "Another authorization gem"
+  spec.homepage = "https://wwww.guidedrails.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Guided-Rails/guarda"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "activesupport", "~> 7.1", ">= 7.1.3"
+  spec.add_development_dependency "minitest-reporters", "~> 1.6", ">= 1.6.1"
+end

data/lib/guarda/authorization.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Guarda
+  module Authorization
+    extend ActiveSupport::Concern
+
+    included do
+      if respond_to?(:helper_method)
+        helper_method :policy
+      end
+    end
+
+    def authorize(record = nil, controller: nil, query: nil)
+      @_authorization_performed = true
+      controller ||= controller_path
+      query ||= "#{action_name}?"
+
+      policy(controller, record).public_send(query) ||
+        raise(NotAuthorizedError, self.class)
+    end
+
+    def policy(controller, record)
+      PolicyFinder.find(controller).new(record)
+    end
+
+    def verify_authorization_performed
+      authorization_performed? ||
+        raise(AuthorizationNotPerformedError, self.class)
+    end
+
+    private
+
+    def authorization_performed?
+      !!@_authorization_performed
+    end
+  end
+end

data/lib/guarda/policy_finder.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Guarda
+  class PolicyFinder
+    def initialize(controller_name)
+      @controller_name = controller_name
+    end
+
+    def self.find(controller_name)
+      new(controller_name).find
+    end
+
+    def find
+      policy_class.presence || raise(NotFoundError, policy_class_name)
+    end
+
+    private
+
+    attr_reader :controller_name
+
+    def policy_class
+      policy_class_name.safe_constantize
+    end
+
+    def policy_class_name
+      controller_name.to_s.camelize.concat("Policy")
+    end
+  end
+end

data/lib/guarda/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Guarda
+  VERSION = "0.2.0"
+end

data/lib/guarda.rb

@@ -1,5 +1,13 @@
-class Guarda
-  def self.hi
-    puts "Hello World"
-  end
+# frozen_string_literal: true
+
+require "active_support/concern"
+require_relative "guarda/version"
+require_relative "guarda/policy_finder"
+require_relative "guarda/authorization"
+
+module Guarda
+  class Error < StandardError; end
+  class Authorization::NotAuthorizedError < Error; end
+  class Authorization::AuthorizationNotPerformedError < Error; end
+  class PolicyFinder::NotFoundError < Error; end
 end

data/sig/guarda.rbs

@@ -0,0 +1,4 @@
+module Guarda
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,26 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: guarda
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Abdullah Hashim
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-10-21 00:00:00.000000000 Z
-dependencies: []
-description: Another Authorization Gem
-email: abdul@hey.com
+date: 2024-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+description:
+email:
+- abdul@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- guarda.gemspec
 - lib/guarda.rb
-homepage: https://rubygems.org/gems/guarda
+- lib/guarda/authorization.rb
+- lib/guarda/policy_finder.rb
+- lib/guarda/version.rb
+- sig/guarda.rbs
+homepage: https://wwww.guidedrails.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://wwww.guidedrails.com
+  source_code_uri: https://github.com/Guided-Rails/guarda
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -29,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -39,5 +90,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Authorization
+summary: Another authorization gem
 test_files: []