roadblock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25323c08d6361c7df9cb6a2a0c07b7e805e30aad
+  data.tar.gz: ab5ad7a071020810f11a5073a5f58186fc983502
+SHA512:
+  metadata.gz: cf74d0bf321e337b64fbb510ca89e5d3e3e8a1be7cd32a57d48098d3f702291cdd5df91d4ab23fd283fe3fdec5c5b256e82171b228ee39f468d1dd5778c71f0f
+  data.tar.gz: 92d8951045847ba6e55d309380361334df9c65ff29d6f01fe0cb283a9943a603f0f8618ba3f1ba6821bfd7224d309eb0482de72d9877bdabec968acc6b05a671

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "coveralls", :require => false
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TeamSnap
+
+MIT License
+
+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,68 @@
+# Roadblock
+
+[![Semaphore](https://semaphoreapp.com/api/v1/projects/f1ccf0c3ff7565f975caef0fdfcf649f24f033fb/118939/shields_badge.png)](https://semaphoreapp.com/minter/roadblock)
+[![Code Climate](https://codeclimate.com/github/teamsnap/roadblock.png)](https://codeclimate.com/github/teamsnap/roadblock)
+[![Coverage Status](https://coveralls.io/repos/teamsnap/roadblock/badge.png?branch=master)](https://coveralls.io/r/teamsnap/roadblock?branch=master)
+[![Dependency Status](https://gemnasium.com/teamsnap/roadblock.png)](https://gemnasium.com/teamsnap/roadblock)
+[![License](http://img.shields.io/license/MIT.png?color=green)](http://opensource.org/licenses/MIT)
+
+A simple authorization library.
+
+![Roadblock](http://i.imgur.com/RzJlc7D.jpg)
+
+Roadblock provides a simple interface for checking if a ruby object has the authority to interact with another object. The most obvious example being if the current user in your rails controller can read/write the object they're attempting to access.
+
+Nearly all authorization libraries require heavy weight configuration and tight integration with Rails. This library was created to provide the simplest solution to the problem without requiring any external dependencies. It doesn't require Rails or any of it's subcomponents and weighs in at less than 10 LOC for the actual implementation. The library also optionally understands OAUTH scopes, something other authorization libraries do not.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'roadblock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install roadblock
+
+## Usage
+
+    require "roadblock"
+
+    class TeamAuthorizer
+      include Roadblock.authorizer
+
+      def can_read?(team)
+        scopes.include?("read") &&
+          user.teams.include?(team)
+      end
+
+      def can_write?(team)
+        scopes.include?("write_teams") && (
+          user.managed_teams.include?(team) ||
+          user.owned_teams.include?(team)
+        )
+      end
+    end
+
+    scopes = ["read", "write_teams"] # Optional oauth scopes
+    auth = TeamAuthorizer.new(current_user, :scopes => scopes)
+    team = Team.find(params[:id])
+
+    auth.can?(:read, team)
+    auth.can?(:write, team)
+    
+## Roadmap
+
+- Add optional faliure messages
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/roadblock.rb

@@ -0,0 +1,12 @@
+require_relative "roadblock/authorizer"
+require_relative "roadblock/version"
+
+module Roadblock
+  def self.authorizer
+    Module.new do
+      def self.included(descendant)
+        descendant.send(:include, ::Roadblock::Authorizer)
+      end
+    end
+  end
+end

data/lib/roadblock/authorizer.rb

@@ -0,0 +1,19 @@
+module Roadblock
+  module Authorizer
+    def initialize(user, scopes: [])
+      self.user = user
+      self.scopes = scopes
+    end
+
+    def can?(action, objects)
+      objects = [*objects]
+      objects
+      .map { |object| send("can_#{action}?", object) }
+      .all?
+    end
+
+    private
+
+    attr_accessor :user, :scopes
+  end
+end

data/lib/roadblock/version.rb

@@ -0,0 +1,3 @@
+module Roadblock
+  VERSION = "0.0.1"
+end

data/roadblock.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'roadblock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "roadblock"
+  spec.version       = Roadblock::VERSION
+  spec.authors       = ["Shane Emmons"]
+  spec.email         = ["oss@teamsnap.com"]
+  spec.description   = <<DESC
+Roadblock provides a simple interface for checking if a ruby object has the
+authority to interact with another object. The most obvious example being if
+the current user in your rails controller can read/write the object they're
+attempting to access.
+DESC
+  spec.summary       = "A simple authorization library."
+  spec.homepage      = "https://github.com/teamsnap/roadblock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0.beta1"
+end

data/spec/roadblock_spec.rb

@@ -0,0 +1,52 @@
+require_relative "spec_helper"
+require_relative "../lib/roadblock"
+
+class TestAuthorizer
+  include Roadblock.authorizer
+
+  def can_peek?(object)
+    scopes.include?("peekable") &&
+      user == object
+  end
+
+  def can_wink?(object)
+    user == object
+  end
+end
+
+describe Roadblock do
+  subject { TestAuthorizer }
+
+  describe "#can?" do
+    it "correctly forwards call" do
+      user = double
+      scopes = ["peekable"]
+      auth = subject.new(user, :scopes => scopes)
+
+      expect(auth.can?(:peek, user)).to eq(true)
+    end
+
+    it "accepts multiple objects" do
+      user = double
+      scopes = ["peekable"]
+      auth = subject.new(user, :scopes => scopes)
+
+      expect(auth.can?(:peek, [user, user])).to eq(true)
+    end
+
+    it "requires all objects to pass authorization" do
+      user = double
+      scopes = ["peekable"]
+      auth = subject.new(user, :scopes => scopes)
+
+      expect(auth.can?(:peek, [user, nil])).to eq(false)
+    end
+
+    it "doesn't require scopes to be used" do
+      user = double
+      auth = subject.new(user)
+
+      expect(auth.can?(:wink, user)).to be(true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "coveralls"
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: roadblock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shane Emmons
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+description: |
+  Roadblock provides a simple interface for checking if a ruby object has the
+  authority to interact with another object. The most obvious example being if
+  the current user in your rails controller can read/write the object they're
+  attempting to access.
+email:
+- oss@teamsnap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/roadblock.rb
+- lib/roadblock/authorizer.rb
+- lib/roadblock/version.rb
+- roadblock.gemspec
+- spec/roadblock_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/teamsnap/roadblock
+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: A simple authorization library.
+test_files:
+- spec/roadblock_spec.rb
+- spec/spec_helper.rb