simon_says 0.0.4 → 0.0.27b6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab4a955ff3bda5ede4c1168208aef92fbb50440b
-  data.tar.gz: 013ee6a83b935c5b037387c046cca2f0bb3dd529
+  metadata.gz: 19de05c0bda5120ccdd27df9f861c3d436982c25
+  data.tar.gz: 21ff0c7d067c9edbfeabf8bfb83a6b9be301e183
 SHA512:
-  metadata.gz: eaffbaf64cb1e6b01becc5da9908df34deb5e01b49f529c06ff917efe72b22ffc3afb1531dee3cd36f7ce2677f80e700cf198b12b71ba852c851ac51a61d4567
-  data.tar.gz: c2458015080be3856965b60922abfcc9e30dd6884f16a49fb06e6b9d63eb0bcc2683f8eb2d85cae5bf0846dac3f37dead9f512f8d319bcdfdf6fe03d3a9c5c31
+  metadata.gz: 0fdb85e2380e4505ddcc07e0106f83260d41224021a96411b58bdd162a21c94c2cc2c5a2d97dfb144364ddb342c0e0873f5e7b9c1006d4a9cca16889cf22e558
+  data.tar.gz: 7ae83204bb804a8e9a0fbbe75582c57644a2e60c9a5fab752014c1ffdf011f292bd738f842152a2c65bdb5ae7c5e6baa214b1c7634397e6eb584d49407e644b6

data/.gitignore

@@ -12,8 +12,5 @@
 *.o
 *.a
 mkmf.log
-.ruby-version
-
-*.gem
 
 /test/rails_app/db/*.sqlite3

data/.travis.yml

@@ -1,9 +1,3 @@
 language: ruby
 rvm:
-  - "2.1.4"
-before_script:
-  - cd test/rails_app/
-  - RAILS_ENV=test bundle exec rake db:migrate db:fixtures:load
-  - cd ../..
-script:
-  - bundle exec rake test
+  - 2.1.3

data/Gemfile

@@ -9,7 +9,5 @@ group :development do
   gem 'rdoc'
 
   gem 'guard'
-  gem 'guard-minitest', "2.3.2"
+  gem 'guard-minitest'
 end
-
-gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -4,10 +4,152 @@
 Logo](https://raw.githubusercontent.com/SimplyBuilt/SimonSays/master/SimonSays.png)
 
 This gem is a simple, declarative, role-based access control system for Rails that
-works great with devise! Take a look at the [website](http://simonsays.onsimplybuilt.com) or
-[docs](http://www.rubydoc.info/github/SimplyBuilt/SimonSays/) for more details!
+works great with devise! Take a look at the
+[docs](http://simplybuilt.github.io/SimonSays) for more details!
 
-![Build Status](https://travis-ci.org/SimplyBuilt/SimonSays.svg)
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simon_says'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simon_says
+
+## Usage
+
+SimonSays consists of two parts. One is a model concern called
+`Roleable`. The other is a controller concern called `Authorizer`. The
+idea is that you give users some set of roles and find and authorize
+against those roles on a controller (and action) basis.
+
+### Roleable
+
+First, we need to define roles. Generally speaking roles will exist on
+either User models or on relationship models (like a through model linking a
+User to another resource).
+
+Here's a quick example:
+
+    class User < ActiveRecord::Base
+      include SimonSays::Roleable
+
+      has_roles :add, :edit, :delete
+    end
+
+User can now have none or one more roles:
+
+    User.new.roles
+    => []
+
+    User.new.tap { |u| u.roles = :add, :edit }.roles
+    => [:add, :edit]
+
+The roles are stored as an integer. When using `Roleable` you need add a
+`roles_mask` column. Note that we do not have any generators for this yet.
+Feel free to fork add them!
+
+You can customize this attribute using the `:as` option. For example:
+
+    class Admin < ActiveRecord::Base
+      include SimonSays::Roleable
+
+      has_roles :design, :support, :moderator, as: :access
+    end
+
+    Admin.new.access
+    => []
+
+    Admin.new(access: :support).access
+    => [:support]
+
+You can also use `Roleable` on through models. For example:
+
+    class Membership < ActiveRecord::Base
+      include SimonSays::Roleable
+
+      belongs_to :user
+      belongs_to :document
+
+      has_roles :download, :edit, :delete,
+    end
+
+There will be several methods as well as a scope generated by
+calling `has_roles`.  See below for more details on the methods
+generated by `Roleable`. Be sure to also checkout the
+[docs](http://simplybuilt.github.io/SimonSays/SimonSays/Roleable/ClassMethods.html)
+for more details!
+
+### Authorizer
+
+Next up is the `Authorizer`. This concern provides several methods that
+can be used within your controllers to declaratively find resources and
+ensuring certain role-based conditions are met.
+
+*Please note*, certain assumptions are made with `Authorizer`. Building
+upon the above `User` and `Admin` models, `Authorizer` would assume
+there is a `current_user` and `current_admin`. If these models
+correspond to devise scopes this would be the case by default.
+Additionally there would need to a be an `authenticate_user!` and
+`authenticate_admin!` method, which devise provides as well.
+
+Eventually, we would like to see better customization around the
+authentication aspects. This library is intended to solve the problem of
+authorization and access control. It is not an authentication library.
+
+The first step is to include the concern within the
+`ApplicationController` and to configure the default authorization
+method:
+
+    class ApplicationController < ActionController::Base
+      include SimonSays::Authorizer
+    end
+
+Let's start with an example; here we'll create a reports resource that
+only Admin's with support access to use. The roles are supplied within
+the `authorize_resource` method. Note that, multiple roles can be
+supplied; access is granted if one or more are met.
+
+    # routes.rb
+    # Reports resource for Admins
+    resources :reports
+
+    # app/controllers/reports_controller.rb
+    class ReportsController < ApplicationController
+      authorize_resource :admin, :support
+      find_resource :report, except: [:index, :new, :create]
+    end
+
+Here's another example using the `Membership` through model.
+
+    # routes.rb
+    resources :documents
+
+    # app/controllers/documents_controller.rb
+    class DocumentsController < ApplicationController
+      authenticate :user
+
+      find_and_authorize :documents, :edit, through: :memberships, only: [:edit, :update]
+      find_and_authorize :documents, :delete, through: :memberships, only: :destroy
+    end
+
+The document model will not be found if the membership relationship does
+not exist and an `ActiveRecord::NotFound` exception will be raised.
+
+If the membership record exists, but the role conditions are not met,
+`Authorizer` will raise a `Denied` exception.
+
+If the document is found and the user has the access to it. It will be
+set as the `@document` instance variable. Make sure to checkout the
+[docs](http://simplybuilt.github.io/SimonSays/SimonSays/Authorizer/ClassMethods.html)
+for more details!
 
 ## Contributing
 

data/lib/simon_says/authorizer.rb

@@ -2,7 +2,7 @@ module SimonSays
   module Authorizer
     extend ActiveSupport::Concern
 
-    class Denied < StandardError
+    class Denied < Exception
       def initialize(as, required, actual)
         # TODO i18n for err message (as should be singluarized with 1 flag)
         super "Access denied; #{required * ', '} role is required. Current access is #{actual * ', '}"
@@ -138,8 +138,7 @@ module SimonSays
         scope = send(self.class.default_authorization_scope)
 
       elsif options[:from]
-        scope = instance_variable_get("@#{options[:from]}") || send(options[:from])
-
+        scope = instance_variable_get("@#{options[:from]}")
       else
         klass = (options[:class_name] || resource).to_s
         # TODO support array of namespaces?

data/lib/simon_says/version.rb

@@ -1,3 +1,3 @@
 module SimonSays
-  VERSION = "0.0.4"
+  VERSION = "0.0.27b6"
 end

data/simon_says.gemspec

@@ -20,9 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport", "~> 4.0"
 
-  spec.add_development_dependency "bundler", "1.7.4"
+  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rails", "~> 4.1"
-  spec.add_development_dependency "responders", "~> 1.0"
   spec.add_development_dependency "mocha", "~> 1.1"
 end

data/test/rails_app/Gemfile

@@ -0,0 +1,40 @@
+source 'https://rubygems.org'
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.1.6'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.3'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer',  platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0',          group: :doc
+
+# Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+gem 'spring',        group: :development
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]
+

data/test/rails_app/Gemfile.lock

@@ -0,0 +1,120 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+    activerecord (4.1.6)
+      activemodel (= 4.1.6)
+      activesupport (= 4.1.6)
+      arel (~> 5.0.0)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    coffee-rails (4.0.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.0)
+    coffee-script (2.3.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.8.0)
+    erubis (2.7.0)
+    execjs (2.2.2)
+    hike (1.2.3)
+    i18n (0.6.11)
+    jbuilder (2.2.2)
+      activesupport (>= 3.0.0, < 5)
+      multi_json (~> 1.2)
+    jquery-rails (3.1.2)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.2)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.6)
+      actionmailer (= 4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      activemodel (= 4.1.6)
+      activerecord (= 4.1.6)
+      activesupport (= 4.1.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.6)
+      sprockets-rails (~> 2.0)
+    railties (4.1.6)
+      actionpack (= 4.1.6)
+      activesupport (= 4.1.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rdoc (4.1.2)
+      json (~> 1.4)
+    sass (3.2.19)
+    sass-rails (4.0.3)
+      railties (>= 4.0.0, < 5.0)
+      sass (~> 3.2.0)
+      sprockets (~> 2.8, <= 2.11.0)
+      sprockets-rails (~> 2.0)
+    sdoc (0.4.1)
+      json (~> 1.7, >= 1.7.7)
+      rdoc (~> 4.0)
+    spring (1.1.3)
+    sprockets (2.11.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    turbolinks (2.4.0)
+      coffee-rails
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uglifier (2.5.3)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-rails (~> 4.0.0)
+  jbuilder (~> 2.0)
+  jquery-rails
+  rails (= 4.1.6)
+  sass-rails (~> 4.0.3)
+  sdoc (~> 0.4.0)
+  spring
+  sqlite3
+  turbolinks
+  uglifier (>= 1.3.0)

data/test/rails_app/config/application.rb

@@ -1,7 +1,6 @@
 require File.expand_path('../boot', __FILE__)
 
 require 'rails/all'
-require 'responders'
 
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.

data/test/rails_app/config/environments/test.rb

@@ -13,11 +13,9 @@ Rails.application.configure do
   config.eager_load = true
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_files  = true
+  config.serve_static_assets  = true
   config.static_cache_control = 'public, max-age=3600'
 
-  config.active_support.test_order = :random
-
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
@@ -38,8 +36,4 @@ Rails.application.configure do
 
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
-
-  # Use transactional fixtures
-  config.use_transactional_fixtures = true
-
 end

data/test/rails_app/db/schema.rb

@@ -14,7 +14,7 @@
 ActiveRecord::Schema.define(version: 20141017140833) do
 
   create_table "admin_reports", force: true do |t|
-    t.string   "title",      limit: nil
+    t.string   "title"
     t.datetime "created_at"
     t.datetime "updated_at"
   end
@@ -26,7 +26,7 @@ ActiveRecord::Schema.define(version: 20141017140833) do
   end
 
   create_table "documents", force: true do |t|
-    t.string   "title",      limit: nil
+    t.string   "title"
     t.datetime "created_at"
     t.datetime "updated_at"
   end

data/test/test_helper.rb

@@ -1,8 +1,3 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
-
-require 'mocha/mini_test'
-
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'simon_says' # HELLO SIMON
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simon_says
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.27b6
 platform: ruby
 authors:
 - Michael Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
+date: 2014-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.4
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.4
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: responders
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -104,7 +90,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitpublish"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -123,6 +108,8 @@ files:
 - test/models/admin_test.rb
 - test/models/membership_test.rb
 - test/rails_app/.gitignore
+- test/rails_app/Gemfile
+- test/rails_app/Gemfile.lock
 - test/rails_app/README.rdoc
 - test/rails_app/Rakefile
 - test/rails_app/app/assets/images/.keep
@@ -217,12 +204,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Light-weight, declarative authorization and access control for Rails
@@ -232,6 +219,8 @@ test_files:
 - test/models/admin_test.rb
 - test/models/membership_test.rb
 - test/rails_app/.gitignore
+- test/rails_app/Gemfile
+- test/rails_app/Gemfile.lock
 - test/rails_app/README.rdoc
 - test/rails_app/Rakefile
 - test/rails_app/app/assets/images/.keep

data/.ruby-version

@@ -1 +0,0 @@
-2.1.4