spine-restrictions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca8f1c71b1c5b353ced6b8a79cd57676060135f9
+  data.tar.gz: 142da03091c0d71b9e70fbafc417adab9276d4b1
+SHA512:
+  metadata.gz: b65f6dfd635e23bcdd305356fc1bb96dddc5b2175a9f144c993398aa6187c6740c84818a7bb18dad3be49206a4780844ea62d67e980710b6c0524e0e59413062
+  data.tar.gz: b4bd3f9745ac970ebcf32013e4455dedb87e7a14d9b4b61dd571fbc690f2691166b362033379aaccbdf40359c602534420fbe9f2c141899c1e17eddb0c59ff2f

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/bin/
+/.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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require config/default

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+Changelog
+=========
+
+0.1.0
+-----
+-   First public release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    spine-restrictions (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.2)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  codeclimate-test-reporter (~> 0.4)
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  spine-restrictions!
+
+BUNDLED WITH
+   1.10.2

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2015, TOGGL LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the TOGGL LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,41 @@
+# Spine::Restrictions
+
+[![Gem Version](https://badge.fury.io/rb/spine-restrictions.svg)](http://badge.fury.io/rb/spine-restrictions)
+[![Dependency Status](https://gemnasium.com/rspine/restrictions.svg)](https://gemnasium.com/rspine/restrictions)
+[![Test Coverage](https://codeclimate.com/github/rspine/restrictions/badges/coverage.svg)](https://codeclimate.com/github/rspine/restrictions/coverage)
+[![Code Climate](https://codeclimate.com/github/rspine/restrictions/badges/gpa.svg)](https://codeclimate.com/github/rspine/restrictions)
+[![Codeship Status for rspine/restrictions](https://codeship.com/projects/7aba9590-ed84-0132-7e77-0eee9d4772fa/status?branch=master)](https://codeship.com/projects/84018)
+
+Restrictions registration for application context.
+
+## Installation
+
+To install it, add the gem to your Gemfile:
+
+```ruby
+gem 'spine-restrictions'
+```
+
+Then run `bundle`. If you're not using Bundler, just `gem install spine-restrictions`.
+
+## Usage
+
+```ruby
+# Restriction can be module or class, which defines `restricted?` method based
+# on context.
+class UserSuspensionRestriction
+  def restricted?(context)
+    !!context.subject.suspended_at
+  end
+end
+
+restrictions = Spine::Restrictions::Collection.new
+restrictions.register(UserSuspensionRestriction)
+  .restrict(:write, :all)
+  .restrict(:update, :all)
+  .restrict(:delete, :all)
+  .except(:all, :billing)
+
+restrictions.restricted?(context, :write, :tasks)
+# => <UserSuspensionRestriction:0x007f8e51ad7960>
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/spine/restrictions.rb

@@ -0,0 +1,6 @@
+module Spine
+  module Restrictions
+    autoload :Collection, 'spine/restrictions/collection'
+    autoload :Registration, 'spine/restrictions/registration'
+  end
+end

data/lib/spine/restrictions/collection.rb

@@ -0,0 +1,31 @@
+module Spine
+  module Restrictions
+    class Collection
+      attr_reader :registrations
+
+      def initialize
+        @registrations = []
+      end
+
+      def register(restriction)
+        registration = Registration.new(restriction)
+        registrations.unshift(registration)
+        registration
+      end
+
+      def restricted?(context, action, resource)
+        restrictions(action, resource).detect { |restriction|
+          restriction.restricted?(context)
+        }
+      end
+
+      def restrictions(action, resource)
+        registrations.select { |registration|
+          registration.applies?(action, resource)
+        }.map { |registration|
+          registration.restriction
+        }
+      end
+    end
+  end
+end

data/lib/spine/restrictions/registration.rb

@@ -0,0 +1,47 @@
+module Spine
+  module Restrictions
+    class Registration
+      attr_reader :restriction, :restrictions, :exceptions
+
+      def initialize(restriction)
+        @restriction = restriction
+        @exceptions = {}
+        @restrictions = {}
+      end
+
+      def restrict(action, resource)
+        add(restrictions, action, resource)
+        self
+      end
+
+      def except(action, resource)
+        add(exceptions, action, resource)
+        self
+      end
+
+      def applies?(action, resource)
+        return false if exception?(action, resource)
+
+        includes?(restrictions, action, resource)
+      end
+
+      private
+
+      def exception?(action, resource)
+        includes?(exceptions, action, resource)
+      end
+
+      def includes?(collection, action, resource)
+        actions = collection[resource] || collection[:all]
+        return false unless actions
+
+        actions[action] || actions[:all]
+      end
+
+      def add(collection, action, resource)
+        collection[resource] ||= {}
+        collection[resource][action] = true
+      end
+    end
+  end
+end

data/lib/spine/restrictions/version.rb

@@ -0,0 +1,5 @@
+module Spine
+  module Restrictions
+    VERSION = '0.1.0'
+  end
+end

data/spec/config/coverage.rb

@@ -0,0 +1,4 @@
+require './spec/config/default'
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start

data/spec/config/default.rb

@@ -0,0 +1,20 @@
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end

data/spec/spine/restrictions/collection_spec.rb

@@ -0,0 +1,47 @@
+require 'spine/restrictions'
+
+module Spine
+  module Restrictions
+    describe Collection do
+      let(:restriction) { double(restricted?: true) }
+      let(:context) { double }
+
+      it 'registers restriction' do
+        subject.register(restriction).restrict(:read, :all)
+        expect(subject.registrations.size).to be > 0
+      end
+
+      it 'registers restriction on specific action and specific resource' do
+        subject.register(restriction).restrict(:read, :data)
+        expect(subject.restricted?(context, :read, :data)).to be
+      end
+
+      it 'registers restriction on all actions and specific resource' do
+        subject.register(restriction).restrict(:all, :data)
+        expect(subject.restricted?(context, :read, :data)).to be
+      end
+
+      it 'registers restriction on specific action and all resources' do
+        subject.register(restriction).restrict(:read, :all)
+        expect(subject.restricted?(context, :read, :data)).to be
+      end
+
+      it 'registers restriction on all actions and all resources' do
+        subject.register(restriction).restrict(:all, :all)
+        expect(subject.restricted?(context, :read, :data)).to be
+      end
+
+      it 'registers exception' do
+        subject.register(restriction)
+          .restrict(:read, :all)
+          .except(:read, :data)
+        expect(subject.restricted?(context, :read, :data)).to be_falsy
+      end
+
+      it 'restricts' do
+        subject.register(restriction).restrict(:read, :all)
+        expect(subject.restricted?(context, :read, :data)).to be
+      end
+    end
+  end
+end

data/spine-restrictions.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spine/restrictions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spine-restrictions"
+  spec.version       = Spine::Restrictions::VERSION
+  spec.authors       = ["TOGGL LLC"]
+  spec.email         = ["support@toggl.com"]
+  spec.summary       = 'Restrictions registration for application context'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/rspine/restrictions'
+  spec.license       = 'BSD-3-Clause'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', "~> 1.7"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.2"
+  spec.add_development_dependency 'codeclimate-test-reporter', "~> 0.4"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: spine-restrictions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOGGL LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: ''
+email:
+- support@toggl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/spine/restrictions.rb
+- lib/spine/restrictions/collection.rb
+- lib/spine/restrictions/registration.rb
+- lib/spine/restrictions/version.rb
+- spec/config/coverage.rb
+- spec/config/default.rb
+- spec/spine/restrictions/collection_spec.rb
+- spine-restrictions.gemspec
+homepage: https://github.com/rspine/restrictions
+licenses:
+- BSD-3-Clause
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Restrictions registration for application context
+test_files:
+- spec/config/coverage.rb
+- spec/config/default.rb
+- spec/spine/restrictions/collection_spec.rb