caber 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf2b829a8c4545b9421f75c2dc2fbf08bbfa45e03dc01d6cc14cd9bc91c742ff
+  data.tar.gz: 66c199b0d561879e11467ba60723a7d5489c5e1824961a41a2497bb4e64654ac
+SHA512:
+  metadata.gz: fb15e64a7fe5ba982b6d55eea3be6d7294f4064f1bb3b31641bc9577b36e3eafd2767442dcf4b287d6382aaf1fd0a26868fccb169a4c11dd436c4d217612eb0a
+  data.tar.gz: f1503f5ed8203e44b807529bc9028bc961437d6d684f11017e43536422a8dddcf06bf1e2f680116c7696d2ecc4983dee7eddfef7f19b440d112a4a36aee863d9

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Manyfold
+
+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,69 @@
+# Caber
+
+A simple ReBAC / Zanzibar gem for Rails apps.
+
+## Installation
+
+Add caber to your Rails application's Gemfile:
+
+```
+bundle add caber
+```
+
+Then, run the installer:
+
+```
+rails g caber:install
+```
+
+This will create an initializer and a migration to add the `caber_relations` to your database.
+
+Set up the permission types you want in the `config/initializers/caber.rb` file - a default is provided, but you can change it to whatever combination of permissions you'd like.
+
+## Usage
+
+To use Caber, include `Caber::Subject` in any of your models that can be given permissions (e.g. Users), and include `Caber::Object` in the things that subjects are given permission TO (e.g. documents):
+
+```
+class User < ApplicationRecord
+  include Caber::Subject
+end
+
+class Document < ApplicationRecord
+  include Caber::Object
+end
+```
+
+Now you're ready to grant some permissions! To give someone permission on something:
+
+```
+document.grant_permission_to :view, user
+```
+
+You can query permissions in both directions:
+```
+document.grants_permission_to? :view, user
+user.has_permission_to? :view, document
+```
+
+### Global permissions
+
+To grant or query permissions globally (for instance, for a public view permission), you can use a `nil` subject:
+
+```
+document.grant_permission_to :view, nil
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+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/manyfold3d/caber. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Caber project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/manyfold3d/caber/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+Bundler::GemHelper.install_tasks
+load "rails/tasks/statistics.rake"
+
+require "rspec/core"
+require "rspec/core/rake_task"
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(spec: "app:db:test:prepare")
+
+task default: :spec

data/app/models/caber/relation.rb

@@ -0,0 +1,6 @@
+class Caber::Relation < ActiveRecord::Base
+  belongs_to :subject, polymorphic: true, required: false
+  belongs_to :object, polymorphic: true
+
+  validates :permission, inclusion: {in: Caber.configuration.permissions}
+end

data/app/models/concerns/caber/object.rb

@@ -0,0 +1,14 @@
+module Caber::Object
+  extend ActiveSupport::Concern
+
+  included do
+  end
+
+  def grant_permission_to(permission, subject)
+    Caber::Relation.create!(subject: subject, permission: permission, object: self)
+  end
+
+  def grants_permission_to?(permission, subject)
+    Caber::Relation.where(object: self, subject: [subject, nil], permission: permission).present?
+  end
+end

data/app/models/concerns/caber/subject.rb

@@ -0,0 +1,10 @@
+module Caber::Subject
+  extend ActiveSupport::Concern
+
+  included do
+  end
+
+  def has_permission_on?(permission, object)
+    object.grants_permission_to? permission, self
+  end
+end

data/lib/caber/configuration.rb

@@ -0,0 +1,6 @@
+module Caber
+  class Configuration
+    @permissions = []
+    attr_accessor :permissions
+  end
+end

data/lib/caber/engine.rb

@@ -0,0 +1,12 @@
+module Caber
+  class Engine < ::Rails::Engine
+    isolate_namespace Caber
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_bot, dir: "spec/factories"
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/caber/version.rb

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

data/lib/caber.rb

@@ -0,0 +1,12 @@
+require "caber/version"
+require "caber/engine"
+require "caber/configuration"
+
+module Caber
+  @@configuration = Caber::Configuration.new
+  mattr_reader :configuration
+
+  def self.configure
+    yield @@configuration
+  end
+end

data/lib/generators/caber/install_generator.rb

@@ -0,0 +1,27 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+class Caber::InstallGenerator < Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+
+  source_root File.expand_path("templates/install", __dir__)
+
+  class_option :database, type: :string, aliases: %i[--db], desc: "The database for your migration. By default, the current environment's primary database is used."
+  class_option :skip_migrations, type: :boolean, default: nil, desc: "Skip migrations"
+
+  def create_initializer_file
+    copy_file "initializers/caber.rb", "config/initializers/caber.rb"
+  end
+
+  def create_migration_file
+    return if options[:skip_migrations]
+
+    migration_template "migrations/01_create_caber_relations.rb.erb", File.join("db/migrate/create_caber_relations.rb")
+  end
+
+  private
+
+  def migration_version
+    "[#{ActiveRecord::VERSION::STRING.to_f}]"
+  end
+end

data/lib/generators/caber/templates/install/initializers/caber.rb

@@ -0,0 +1,9 @@
+# Autogenerated configuration for Caber
+Caber.configure do |config|
+  # List the object-level permissions you want
+  config.permissions = [
+    "viewer",
+    "editor",
+    "owner"
+  ]
+end

data/lib/generators/caber/templates/install/migrations/01_create_caber_relations.rb.erb

@@ -0,0 +1,11 @@
+class CreateCaberRelations < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :caber_relations do |t|
+      t.references :subject, polymorphic: true, null: true
+      t.string :permission
+      t.references :object, polymorphic: true, null: false
+
+      t.timestamps
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: caber
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Smith
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.4
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple ReBAC / Zanzibar gem for Rails apps.
+email:
+- james@floppy.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/models/caber/relation.rb
+- app/models/concerns/caber/object.rb
+- app/models/concerns/caber/subject.rb
+- lib/caber.rb
+- lib/caber/configuration.rb
+- lib/caber/engine.rb
+- lib/caber/version.rb
+- lib/generators/caber/install_generator.rb
+- lib/generators/caber/templates/install/initializers/caber.rb
+- lib/generators/caber/templates/install/migrations/01_create_caber_relations.rb.erb
+homepage: https://github.com/manyfold3d/caber
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/manyfold3d/caber
+  source_code_uri: https://github.com/manyfold3d/caber
+  changelog_uri: https://github.com/manyfold3d/caber/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A simple ReBAC / Zanzibar gem for Rails apps.
+test_files: []