oo-licence 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8bb2b601c21427c01d89a390edc2dad7b38b2996
+  data.tar.gz: 500f1254ba20036ecd5b367a806e01bb33130b9a
+SHA512:
+  metadata.gz: 672514925d8b09063620aa41210b9b22873f86a943e18a8293cabfec57d238c825638c5d224e10149020d33f5ae158ad8f728b5a75eef58130e19d2eb355a8e0
+  data.tar.gz: c90b89d486f69bd4f6ca94c1662448d0ff5c8df4201798353e1fcf2c3b6120ab4cad7b780f4f9d722bb70c0f829db385223f20ff89ace5d09625f4a953b7841b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Krzysztof Buszewicz
+
+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,41 @@
+# OO
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/licence`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'licence'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install licence
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/licence.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'oo'
+
+# 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

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/generators/oo/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module OO
+  class InstallGenerator < ::Rails::Generators::Base
+    namespace 'oo:install'
+    source_root File.expand_path('../templates', __FILE__)
+    desc 'Generates OO (licence) gem initializer.'
+
+    def install
+      template 'initializer.rb', 'config/initializers/oo_licence.rb'
+    end
+  end
+end

data/lib/generators/oo/templates/initializer.rb

@@ -0,0 +1,17 @@
+OO.configure do |c|
+  c.licence_max_depth = 4
+
+  c.licence_checkers_default_user = ->(base) { base.current_user }
+  c.licence_checkers_default_key = lambda do |base|
+    base.controller_path.gsub('/', '_') +
+      OO::Licence.separator +
+      base.action_name
+  end
+
+  c.licence_missing_reaction = lambda do |licence_key, user|
+    raise OO::Errors::LicenceMissing, licence_key: licence_key,
+                                      user_data: user.id
+  end
+
+  c.default_licence_keys = []
+end

data/lib/oo.rb

@@ -0,0 +1,25 @@
+require 'oo/version'
+require 'oo/configuration'
+require 'oo/errors/licence_missing'
+require 'oo/errors/licence_max_depth_invalid'
+require 'oo/errors/licence_missing_reaction_invalid'
+require 'oo/errors/licence_checkers_default_user_invalid'
+require 'oo/errors/licence_checkers_default_key_invalid'
+require 'oo/errors/default_licence_keys_invalid'
+require 'oo/licence'
+require 'oo/check_licence'
+require 'oo/licence_user'
+require 'oo/licence_checkers'
+
+module OO
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+      configuration
+    end
+  end
+end

data/lib/oo/check_licence.rb

@@ -0,0 +1,19 @@
+module OO
+  class CheckLicence
+    attr_reader :licence_key, :licence_keys, :licence
+
+    def self.call(attrs = {})
+      new(attrs).call
+    end
+
+    def initialize(attrs = {})
+      @licence_key = attrs.fetch(:key)
+      @licence_keys = attrs.fetch(:in)
+      @licence = Licence.new(key: licence_key)
+    end
+
+    def call
+      licence.masks & licence_keys
+    end
+  end
+end

data/lib/oo/configuration.rb

@@ -0,0 +1,46 @@
+module OO
+  class Configuration
+    attr_reader :licence_max_depth, :default_licence_keys,
+                :licence_missing_reaction, :licence_checkers_default_user,
+                :licence_checkers_default_key
+
+    def initialize
+      @licence_max_depth = 4
+      @default_licence_keys = []
+      @licence_missing_reaction =
+        -> { :licence_missing_reaction_not_configured }
+
+      @licence_checkers_default_user =
+        -> { :licence_checkers_default_user_not_configured }
+
+      @licence_checkers_default_key =
+        -> { :licence_checkers_default_key_not_configured }
+    end
+
+    def licence_max_depth=(depth)
+      raise Errors::LicenceMaxDepthInvalid unless depth.is_a?(Fixnum) &&
+                                                  depth > 0
+      @licence_max_depth = depth
+    end
+
+    def default_licence_keys=(licence_keys)
+      raise Errors::DefaultLicenceKeysInvalid unless licence_keys.is_a?(Array)
+      @default_licence_keys = licence_keys
+    end
+
+    def licence_missing_reaction=(action)
+      raise Errors::LicenceMissingReactionInvalid unless action.is_a?(Proc)
+      @licence_missing_reaction = action
+    end
+
+    def licence_checkers_default_user=(action)
+      raise Errors::LicenceCheckersDefaultUserInvalid unless action.is_a?(Proc)
+      @licence_checkers_default_user = action
+    end
+
+    def licence_checkers_default_key=(action)
+      raise Errors::LicenceCheckersDefaultKeyInvalid unless action.is_a?(Proc)
+      @licence_checkers_default_key = action
+    end
+  end
+end

data/lib/oo/errors/default_licence_keys_invalid.rb

@@ -0,0 +1,9 @@
+module OO
+  module Errors
+    class DefaultLicenceKeysInvalid < StandardError
+      def initialize
+        super('OO.configuration.default_licence_keys must be an Array.')
+      end
+    end
+  end
+end

data/lib/oo/errors/licence_checkers_default_key_invalid.rb

@@ -0,0 +1,9 @@
+module OO
+  module Errors
+    class LicenceCheckersDefaultKeyInvalid < StandardError
+      def initialize
+        super('OO.configuration.licence_checkers_default_key must be a Proc.')
+      end
+    end
+  end
+end

data/lib/oo/errors/licence_checkers_default_user_invalid.rb

@@ -0,0 +1,9 @@
+module OO
+  module Errors
+    class LicenceCheckersDefaultUserInvalid < StandardError
+      def initialize
+        super('OO.configuration.licence_checkers_default_user must be a Proc.')
+      end
+    end
+  end
+end

data/lib/oo/errors/licence_max_depth_invalid.rb

@@ -0,0 +1,10 @@
+module OO
+  module Errors
+    class LicenceMaxDepthInvalid < StandardError
+      def initialize
+        super('OO.configuration.licence_max_depth must be a Fixnum '\
+              'greater than 0')
+      end
+    end
+  end
+end

data/lib/oo/errors/licence_missing.rb

@@ -0,0 +1,22 @@
+module OO
+  module Errors
+    class LicenceMissing < StandardError
+      attr_reader :user_data, :licence_key
+
+      def initialize(attrs = {})
+        @user_data = attrs[:user_data]
+        @licence_key = attrs.fetch(:licence_key)
+        super(error_message)
+      end
+
+      private
+
+      def error_message
+        msg = "User "
+        msg << "#{user_data} " unless user_data.nil?
+        msg << "is missing permission '#{licence_key}'. " \
+               'Therefore he is not allowed to perform this activity.'
+      end
+    end
+  end
+end

data/lib/oo/errors/licence_missing_reaction_invalid.rb

@@ -0,0 +1,9 @@
+module OO
+  module Errors
+    class LicenceMissingReactionInvalid < StandardError
+      def initialize
+        super('OO.configuration.licence_missing_reaction must be a Proc.')
+      end
+    end
+  end
+end

data/lib/oo/licence.rb

@@ -0,0 +1,75 @@
+module OO
+  class Licence
+    class << self
+      def separator
+        '.'
+      end
+
+      def mask_mark
+        '*'
+      end
+
+      def max_depth
+        OO.configuration.licence_max_depth
+      end
+
+      def masks
+        masks = {}
+        max_depth.times do |t|
+          masks["#{t + 1}"] = mask_mark + "#{separator}#{mask_mark}" * t
+        end
+        masks
+      end
+    end
+
+    attr_reader :key
+
+    alias_method :to_s, :key
+
+    def initialize(attrs = {})
+      @key = attrs.fetch(:key)
+    end
+
+    def masks
+      masks = []
+      gen_masks = genre_masks
+      current = self
+      while current.key != mask_mark
+        gen_masks.each { |mask| masks << current.mask_key(mask) }
+        current = current.parent
+      end
+      (masks + gen_masks).uniq
+    end
+
+    def parent
+      return self.class.new(key: mask_mark) if depth == 1
+      self.class.new(key: to_a[0..-2].join(separator))
+    end
+
+    def to_a
+      key.split(separator)
+    end
+
+    def depth
+      to_a.size
+    end
+
+    def separator
+      self.class.separator
+    end
+
+    def mask_mark
+      self.class.mask_mark
+    end
+
+    def genre_masks
+      (depth..self.class.masks.size).map { |n| self.class.masks[n.to_s] }
+    end
+
+    def mask_key(mask)
+      mask = mask.split(separator)
+      mask[0..depth - 1] = *to_a
+      mask.join(separator)
+    end
+  end
+end

data/lib/oo/licence_checkers.rb

@@ -0,0 +1,34 @@
+module OO
+  module LicenceCheckers
+    def self.included(base)
+      base.class_eval do
+        def licensed?(attrs = {})
+          user = attrs.fetch(:user, licence_checkers_default_user)
+          key = attrs.fetch(:to, licence_checkers_default_key)
+          user.licensed?(to: key)
+        end
+
+        def check_licence!(attrs = {})
+          user = attrs.fetch(:user, licence_checkers_default_user)
+          key = attrs.fetch(:to, licence_checkers_default_key)
+          licence_missing_reaction.call(key, user) unless licensed?(user: user,
+                                                                    to: key)
+        end
+
+        private
+
+        def licence_checkers_default_user
+          OO.configuration.licence_checkers_default_user.call(self)
+        end
+
+        def licence_checkers_default_key
+          OO.configuration.licence_checkers_default_key.call(self)
+        end
+
+        def licence_missing_reaction
+          OO.configuration.licence_missing_reaction
+        end
+      end
+    end
+  end
+end

data/lib/oo/licence_user.rb

@@ -0,0 +1,15 @@
+module OO
+  module LicenceUser
+    def self.included(base)
+      base.class_eval do
+        field :licence_keys, type: :array,
+                             default: OO.configuration.default_licence_keys
+
+        def licensed?(attrs = {})
+          required_key = attrs.fetch(:to)
+          CheckLicence.call(key: required_key, in: licence_keys).any?
+        end
+      end
+    end
+  end
+end

data/lib/oo/version.rb

@@ -0,0 +1,3 @@
+module OO
+  VERSION = '0.9.0'
+end

data/oo.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'oo/version'
+
+Gem::Specification.new do |s|
+  s.name = 'oo-licence'
+  s.version = OO::VERSION
+  s.summary = 'Simple Activity Based Authorization'
+  s.homepage = 'https://github.com/buszu#todo'
+  s.license = 'MIT'
+
+  s.authors = ['Krzysztof Buszewicz']
+  s.email = ['krzysztof.buszewicz@gmail.com']
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.11'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'factory_girl', '~> 4.0'
+end

data/spec/factories/licences.rb

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  factory :licence, class: OO::Licence do
+    key 'action'
+
+    initialize_with { new(attributes) }
+  end
+
+  factory :glass_take_with_juice, parent: :licence do
+    key 'glass.take.with_juice'
+  end
+end

data/spec/oo/check_licence_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+
+describe OO::CheckLicence do
+
+  describe '.new(attrs = {})' do
+    let(:service_object) { described_class.new(attrs) }
+    let(:licence_key) { 'glass.take' }
+
+    subject { service_object }
+
+    context 'when required attrs are missing' do
+      context 'when :key (checked licence key) is missing' do
+        let(:attrs) { { in: [] } }
+        it { expect { subject }.to raise_error(KeyError) }
+      end
+
+      context 'when :in (licence keys list) is missing' do
+        let(:attrs) { { key: licence_key } }
+        it { expect { subject }.to raise_error(KeyError) }
+      end
+    end
+
+    context 'when all required attrs were passed' do
+      let(:attrs) { { key: licence_key, in: [] } }
+
+      it { is_expected.to be_a(described_class) }
+
+      describe 'builds a licence' do
+        let(:licence_class) { OO::Licence }
+
+        describe '@licence' do
+          let(:licence) { service_object.instance_variable_get(:@licence) }
+
+          subject { licence }
+          it { is_expected.to be_a(licence_class) }
+
+          describe '#key' do
+            subject { licence.key }
+            it { is_expected.to eq(licence_key) }
+          end
+        end
+      end
+    end
+  end
+
+  describe '#call' do
+    let(:service_object) { described_class.new(key: licence_key, in: licence_keys) }
+    let(:licence) { OO::Licence.new(key: licence_key) }
+    let(:licence_key) { 'glass.take' }
+
+    subject { service_object.call }
+
+    describe 'returns all keys wider or equal to given key found in given list' do
+      context 'when licence key is included in licence keys list' do
+        context 'and is an only match' do
+          let(:licence_keys) { [licence_key] }
+          it { is_expected.to eq([licence_key]) }
+        end
+      end
+
+      context 'when exact licence key is missing in given list' do
+        context 'but there are wider keys' do
+          let(:licence_keys) { licence.genre_masks }
+          it { is_expected.to eq(licence.genre_masks) }
+        end
+      end
+
+      context 'when licence key is missing in given list' do
+        let(:licence_keys) { %w(a b c d) }
+        it { is_expected.to eq([]) }
+
+        context 'but found parent key' do
+          let(:licence_keys) { [licence.parent.key] }
+          it { is_expected.to eq([]) }
+        end
+      end
+    end
+  end
+end

data/spec/oo/configuration_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe OO::Configuration do
+  describe '.new' do
+    let(:configuration) { described_class.new }
+    let(:default_licence_max_depth) { 4 }
+    let(:default_licence_keys) { [] }
+    let(:default_licence_missing_reaction) do
+      -> { :licence_missing_reaction_not_configured }
+    end
+
+    let(:default_licence_checkers_default_user) do
+      -> { :licence_checkers_default_user_not_configured }
+    end
+
+    let(:default_licence_checkers_default_key) do
+      -> { :licence_checkers_default_key_not_configured }
+    end
+
+    subject { configuration }
+
+    it { is_expected.to be_a(described_class) }
+    describe 'it is set to default values' do
+      describe 'licence_max_depth' do
+        subject { configuration.licence_max_depth }
+        it { is_expected.to eq(default_licence_max_depth) }
+      end
+
+      describe 'default_licence_keys' do
+        subject { configuration.default_licence_keys }
+        it { is_expected.to eq(default_licence_keys) }
+      end
+
+      describe 'licence_missing_reaction' do
+        let(:licence_missing_reaction) { configuration.licence_missing_reaction }
+        subject { licence_missing_reaction }
+        it { is_expected.to be_a(Proc) }
+        describe "#call" do
+          subject { licence_missing_reaction.call }
+          it { is_expected.to eq(:licence_missing_reaction_not_configured) }
+        end
+      end
+
+      describe 'licence_checkers_default_user' do
+        let(:licence_checkers_default_user) { configuration.licence_checkers_default_user }
+        subject { licence_checkers_default_user }
+        it { is_expected.to be_a(Proc) }
+        describe "#call" do
+          subject { licence_checkers_default_user.call }
+          it { is_expected.to eq(:licence_checkers_default_user_not_configured) }
+        end
+      end
+
+      describe 'licence_checkers_default_key' do
+        let(:licence_checkers_default_key) { configuration.licence_checkers_default_key }
+        subject { licence_checkers_default_key }
+        it { is_expected.to be_a(Proc) }
+        describe "#call" do
+          subject { licence_checkers_default_key.call }
+          it { is_expected.to eq(:licence_checkers_default_key_not_configured) }
+        end
+      end
+    end
+
+    describe '#licence_max_depth=(depth)' do
+      context 'when depth is not a fixnum' do
+        let(:depth) { 'a' }
+        let(:error) { OO::Errors::LicenceMaxDepthInvalid }
+
+        subject { -> { configuration.licence_max_depth = depth } }
+        it { is_expected.to raise_error(error) }
+      end
+
+      context 'when depth is not greater than 0' do
+        let(:depth) { 0 }
+        let(:error) { OO::Errors::LicenceMaxDepthInvalid }
+
+        subject { -> { configuration.licence_max_depth = depth } }
+        it { is_expected.to raise_error(error) }
+      end
+    end
+
+    describe '#licence_missing_reaction=(action)' do
+      context 'when action is not a Proc object' do
+        let(:action) { :invalid }
+        let(:error) { OO::Errors::LicenceMissingReactionInvalid }
+
+        subject { -> { configuration.licence_missing_reaction = action } }
+        it { is_expected.to raise_error(error) }
+      end
+    end
+
+    describe '#licence_checkers_default_user=(action)' do
+      context 'when action is not a Proc object' do
+        let(:action) { :invalid }
+        let(:error) { OO::Errors::LicenceCheckersDefaultUserInvalid }
+
+        subject { -> { configuration.licence_checkers_default_user = action } }
+        it { is_expected.to raise_error(error) }
+      end
+    end
+
+    describe '#licence_checkers_default_key=(action)' do
+      context 'when action is not a Proc object' do
+        let(:action) { :invalid }
+        let(:error) { OO::Errors::LicenceCheckersDefaultKeyInvalid }
+
+        subject { -> { configuration.licence_checkers_default_key = action } }
+        it { is_expected.to raise_error(error) }
+      end
+    end
+
+    describe '#default_licence_keys=(licence_keys)' do
+      context 'when licence_keys is not an array' do
+        let(:licence_keys) { :invalid }
+        let(:error) { OO::Errors::DefaultLicenceKeysInvalid }
+
+        subject { -> { configuration.default_licence_keys = licence_keys } }
+        it { is_expected.to raise_error(error) }
+      end
+    end
+  end
+end

data/spec/oo/licence_spec.rb

@@ -0,0 +1,232 @@
+require 'spec_helper'
+
+describe OO::Licence do
+  let(:separator) { described_class.separator }
+  let(:mask_mark) { described_class.mask_mark }
+
+  describe '.separator' do
+    let(:separator) { '.' }
+    subject { described_class.separator }
+    it { is_expected.to eq(separator) }
+  end
+
+  describe '.mask_mark' do
+    let(:mask_mark) { '*' }
+    subject { described_class.mask_mark }
+    it { is_expected.to eq(mask_mark) }
+  end
+
+  describe '.max_depth' do
+    let(:max_depth) { OO.configuration.licence_max_depth }
+    subject { described_class.max_depth }
+
+    context 'for default configuration' do
+      it { is_expected.to eq(max_depth) }
+    end
+  end
+
+  describe '.masks' do
+    subject { described_class.masks }
+
+    describe 'returns all possible top-level masks basing on max depth' do
+      before(:each) { OO.configure { |c| c.licence_max_depth = max_depth } }
+
+      context 'when max_depth is set to 1' do
+        let(:max_depth) { 1 }
+        let(:masks) { { '1' => mask_mark } }
+        it { is_expected.to eq(masks) }
+      end
+
+      context 'when max_depth is set to 2' do
+        let(:max_depth) { 2 }
+        let(:masks) do
+          { '1' => mask_mark,
+            '2' => "#{mask_mark}#{separator}#{mask_mark}" }
+        end
+
+        it { is_expected.to eq(masks) }
+      end
+
+      context 'when max_depth is set to 3' do
+        let(:max_depth) { 3 }
+        let(:masks) do
+          {
+            '1' => mask_mark,
+            '2' => "#{mask_mark}#{separator}#{mask_mark}",
+            '3' => "#{mask_mark}#{separator}#{mask_mark}#{separator}#{mask_mark}"
+          }
+        end
+
+        it { is_expected.to eq(masks) }
+      end
+    end
+  end
+
+  describe '#separator' do
+    let(:licence) { build(:glass_take_with_juice) }
+    subject { licence.separator }
+    it { is_expected.to eq(described_class.separator) }
+  end
+
+  describe '#mask_mark' do
+    let(:licence) { build(:glass_take_with_juice) }
+    subject { licence.mask_mark }
+    it { is_expected.to eq(described_class.mask_mark) }
+  end
+
+  describe '#key' do
+    context 'for :glass_take_with_juice factory' do
+      let(:licence) { build(:glass_take_with_juice) }
+
+      subject { licence.key }
+
+      it { is_expected.to be_a(String) }
+      it { is_expected.to eq('glass.take.with_juice') }
+    end
+  end
+
+  describe '#to_s' do
+    context 'for :glass_take_with_juice factory' do
+      let(:licence) { build(:glass_take_with_juice) }
+
+      subject { licence.to_s }
+
+      it { is_expected.to be_a(String) }
+      it { is_expected.to eq('glass.take.with_juice') }
+    end
+  end
+
+  describe '#to_a' do
+    context 'for :glass_take_with_juice factory' do
+      let(:licence) { build(:glass_take_with_juice) }
+
+      subject { licence.to_a }
+
+      it { is_expected.to be_an(Array) }
+      it { is_expected.to eq(%w(glass take with_juice)) }
+    end
+  end
+
+  describe '#depth' do
+    context 'for :glass_take_with_juice factory' do
+      let(:licence) { build(:glass_take_with_juice) }
+
+      subject { licence.depth }
+
+      it { is_expected.to be_a(Fixnum) }
+      it { is_expected.to eq(3) }
+    end
+  end
+
+  describe '#genre_masks' do
+    let(:m) { mask_mark }
+    let(:s) { separator }
+    let(:genre_masks) do
+      { depth_1: %W(#{m} #{m}#{s}#{m} #{m}#{s}#{m}#{s}#{m} #{m}#{s}#{m}#{s}#{m}#{s}#{m}),
+        depth_3: %W(#{m}#{s}#{m}#{s}#{m} #{m}#{s}#{m}#{s}#{m}#{s}#{m}) }
+    end
+
+    subject { licence.genre_masks }
+
+    describe 'should return the most general masks for licence' do
+      context 'for :glass_take_with_juice factory (depth: 3)' do
+        let(:licence) { build(:glass_take_with_juice) }
+
+        it { is_expected.to be_an(Array) }
+        it { is_expected.to eq(genre_masks[:depth_3]) }
+      end
+
+      context 'for :licence factory (depth: 1)' do
+        let(:licence) { build(:licence) }
+
+        it { is_expected.to be_an(Array) }
+        it { is_expected.to eq(genre_masks[:depth_1]) }
+      end
+    end
+  end
+
+  describe '#mask_key(mask)' do
+    let(:m) { mask_mark }
+    let(:s) { separator }
+
+    subject { licence.mask_key(mask) }
+
+    describe 'for n-deep licence should replace mask\'s n chars with key\'s' do
+      context 'when mask key is deeper than licence' do
+        let(:mask) { "#{m}#{s}#{m}#{s}#{m}#{s}#{m}" }
+
+        context 'for :glass_take_with_juice factory' do
+          let(:licence) { build(:glass_take_with_juice) }
+
+          it { is_expected.to be_a(String) }
+          it { is_expected.to eq(licence.key + "#{s}#{m}") }
+        end
+
+        context 'for :licence factory' do
+          let(:licence) { build(:licence) }
+
+          it { is_expected.to be_an(String) }
+          it { is_expected.to eq(licence.key + "#{s}#{m}#{s}#{m}#{s}#{m}") }
+        end
+      end
+
+      context 'when mask depth equals licence depth' do
+        context 'for :licence factory' do
+          let(:licence) { build(:licence) }
+          let(:mask) { "#{m}" }
+
+          it { is_expected.to be_an(String) }
+          it { is_expected.to eq(licence.key) }
+        end
+      end
+
+      context 'when mask depth is less than licence depth' do
+        context 'for :glass_take_with_juice factory' do
+          let(:licence) { build(:glass_take_with_juice) }
+          let(:mask) { "#{m}#{s}#{m}" }
+
+          it { is_expected.to be_an(String) }
+          it { is_expected.to eq(licence.key) }
+        end
+      end
+    end
+  end
+
+  describe '#parent' do
+    let(:mask_mark) { described_class.mask_mark }
+
+    context 'for :glass_take_with_juice factory' do
+      let(:licence) { build(:glass_take_with_juice) }
+      let(:parent_licence) { licence.parent }
+
+      subject { parent_licence }
+
+      it { is_expected.to be_a(described_class) }
+
+      describe '#key' do
+        subject { parent_licence.key }
+        it { is_expected.to eq('glass.take') }
+      end
+    end
+
+    context 'for :licence factory' do
+      let(:licence) { build(:licence) }
+      let(:parent_licence) { licence.parent }
+
+      describe '#key' do
+        subject { parent_licence.key }
+        it { is_expected.to eq(mask_mark) }
+      end
+    end
+
+    context 'when key equals single mask mark' do
+      let(:licence) { build(:licence, key: mask_mark) }
+      let(:parent_licence) { licence.parent }
+
+      describe '#key' do
+        subject { parent_licence.key }
+        it { is_expected.to eq(mask_mark) }
+      end
+    end
+  end
+end

data/spec/oo_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe OO do
+  describe '.configuration' do
+    subject { described_class.configuration }
+    it { is_expected.to be_a(described_class::Configuration) }
+  end
+
+  describe '.configure' do
+    context 'when no block was given' do
+      subject { described_class.configure }
+      it 'returns current configuration' do
+        is_expected.to eq(described_class.configuration)
+      end
+    end
+
+    context 'when block was given' do
+      let(:depth) { 5 }
+      before(:each) do
+        described_class.configure { |c| c.licence_max_depth = depth }
+      end
+
+      it 'updates configuration' do
+        expect(described_class.configuration.licence_max_depth).to eq(depth)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'factory_girl'
+require 'oo'
+
+RSpec.configure do |c|
+  c.include FactoryGirl::Syntax::Methods
+
+  c.before(:suite) do
+    FactoryGirl.find_definitions
+    OO.instance_variable_set(:@configuration, OO::Configuration.new)
+  end
+
+  c.after(:each) do
+    OO.instance_variable_set(:@configuration, OO::Configuration.new)
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: oo-licence
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Krzysztof Buszewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- krzysztof.buszewicz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/oo/install_generator.rb
+- lib/generators/oo/templates/initializer.rb
+- lib/oo.rb
+- lib/oo/check_licence.rb
+- lib/oo/configuration.rb
+- lib/oo/errors/default_licence_keys_invalid.rb
+- lib/oo/errors/licence_checkers_default_key_invalid.rb
+- lib/oo/errors/licence_checkers_default_user_invalid.rb
+- lib/oo/errors/licence_max_depth_invalid.rb
+- lib/oo/errors/licence_missing.rb
+- lib/oo/errors/licence_missing_reaction_invalid.rb
+- lib/oo/licence.rb
+- lib/oo/licence_checkers.rb
+- lib/oo/licence_user.rb
+- lib/oo/version.rb
+- oo.gemspec
+- spec/factories/licences.rb
+- spec/oo/check_licence_spec.rb
+- spec/oo/configuration_spec.rb
+- spec/oo/licence_spec.rb
+- spec/oo_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/buszu#todo
+licenses:
+- MIT
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Simple Activity Based Authorization
+test_files:
+- spec/factories/licences.rb
+- spec/oo/check_licence_spec.rb
+- spec/oo/configuration_spec.rb
+- spec/oo/licence_spec.rb
+- spec/oo_spec.rb
+- spec/spec_helper.rb