auth_scope 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9a769a8c4cd7cce6e3a9b2526a1d5c6f8242b91
+  data.tar.gz: 94f0698f3d63887e2612c0c108814329e6979d33
+SHA512:
+  metadata.gz: 5ba43d4cc8eb9da44324f7a1f8a17b0d38a6d231e2b415bc437298fa8f3b7db39598b8f1e23e9cffaf62446d1b889ffc7952ba092a07e23dccb63c9142a08410
+  data.tar.gz: 96fde064c62572ff4a885ada8b9f8e7af9ec43a404eb189b936bfc9b9294bcee4c1d734b545ed7ec09f428273705e0fc27726c2444061a8b2292bc1bd5d39840

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in auth_scope.gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Bleigh
+
+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,103 @@
+# AuthScope
+
+AuthScope is a simple library for describing authorization patterns through strings.
+It is intended to work in conjunction with (for example) an OAuth 2.0 API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'auth_scope'
+
+## Scope Structure
+
+Authorization scope strings look something like this:    
+
+    user:email apps:one,another:read profile:*
+    
+Spaces delimit individual authorization grants and can be treated as
+completely independent of one another. When specified together they are
+considered to authorize additively, meaning that authorization is granted
+if *any* of the provided scopes are matched.
+
+The `:` or **namespace** delimiter lets you create generic and specific
+permissions. `user:email` is more specific than `user` for instance.
+
+The `,` or **batch** delimiter allows you to apply a scope to multiple
+resouces at the same namespace level. `user:email,avatar` is equivalent
+to asking for a scope of `user:email user:avatar`.
+
+The `*` or **wildcard** is used to indicate permissiveness for a single
+namespace. For instance, `user:*` would grant access to `user:email`
+but not `user:email:write`.
+
+The `**` or **global wildcard** is used to indicate permissiveness for
+any number of namespaces. `**` would grant access to **everything**, and
+`user:**:write` would grant access to any `write` permissions, even if
+deeply nested.
+
+The more namespaces a scope has, the greater permission it authorizes.
+Each segment of a namespace is considered to be granted, so a scope of
+`user:email` grants both `user` and `user:email` scopes.
+
+## Usage
+
+In simple terms, you will initialize an AuthScope with a string and query
+its authorization using the `can?` method:
+
+```ruby
+require 'auth_scope'
+
+scope = AuthScope.new("user:email apps:foo,bar:*")
+
+scope.can? "user:email" # => true
+scope.can? "user:write" # => false
+scope.can? "apps:foo:write" # => true
+```
+
+You may also specify an array of authorization strings. This is treated no
+differently than space delimiting:
+
+```ruby
+scope = AuthScope.new("user:email", "apps:foo,bar:*")
+```
+
+The `any?` method tests a set of potential authorizations to see if any match:
+
+```ruby
+scope = AuthScope.new("admin")
+scope.any? "user:email", "admin" # => true
+```
+
+The `all? method tests that each of a set of authorizations is a match:
+
+```ruby
+scope = AuthScope.new("admin")
+scope.all? "user:email", "admin" # => false
+```
+
+### Object Scopes
+
+It will often be useful for an object to be able to describe its own scope.
+AuthScope will call `to_scope` on passed-in arguments before checking them.
+For example:
+
+```ruby
+class User
+  def to_scope
+    "user:#{id}"
+  end
+end
+
+scope = AuthScope.new("user:123:write")
+scope.can? user, "write" # => true
+scope.can? another_user, "write" # => false
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/divshot/auth_scope/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
+rescue LoadError
+  puts "RSpec is not installed, skipping."
+end
+
+task :default => :spec

data/auth_scope.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auth_scope/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auth_scope"
+  spec.version       = AuthScope::VERSION
+  spec.authors       = ["Michael Bleigh"]
+  spec.email         = ["mbleigh@mbleigh.com"]
+  spec.summary       = %q{Authorization library using namespaced strings. Great for OAuth 2.0 APIs.}
+  spec.description   = %q{Authorization library using namespaced strings. Great for OAuth 2.0 APIs.}
+  spec.homepage      = "https://github.com/divshot/auth_scope"
+  spec.license       = "MIT"
+
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/auth_scope.rb

@@ -0,0 +1,46 @@
+class AuthScope
+  def initialize(*scopes)
+    @tree = {}
+    scopes.join(" ").split(" ").each{|s| add(s) }
+  end
+  
+  def add(scope_string)
+    roots = [@tree]
+    
+    scope_string.split(":").each do |parts|
+      roots = parts.split(",").map do |part|
+        roots.map{|r| r[part.to_s] ||= {}; r[part.to_s]}
+      end.flatten
+    end
+  end
+  
+  def can?(*args)
+    subject = subject.respond_to?(:to_scope) ? subject.to_scope : subject.to_s
+    parts = args.map{|arg| (arg.respond_to?(:to_scope) ? arg.to_scope : arg.to_s).split(":") }.flatten.map(&:to_s)
+    roots = [@tree]
+    parts.each do |part|
+      return true if roots.detect{|r| r.key?('**')}
+      is_last = part == parts.last
+      if roots.detect{|r| r.key?('*')}
+        roots = roots.map{|r| [r[part], r['*']].compact }.flatten
+      else
+        return false unless roots.detect{|r| r.key?(part)}
+        roots = roots.map{|r| r[part] }.flatten
+      end
+    end
+    true
+  end
+  
+  def any?(*scopes)
+    scopes = scopes.join(" ").split(" ")
+    !!scopes.detect{|scope| can?(scope)}
+  end
+  
+  def all?(*scopes)
+    scopes = scopes.join(" ").split(" ")
+    scopes.each{|scope| return false unless can?(scope) }
+    true
+  end
+end
+
+require "auth_scope/version"

data/lib/auth_scope/version.rb

@@ -0,0 +1,3 @@
+class AuthScope
+  VERSION = "0.0.1"
+end

data/spec/auth_scope_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe AuthScope do
+  subject{ AuthScope.new(@scope || "user:email") }
+  
+  describe '#can?' do
+    it 'should authorize for any segment of a chain' do
+      @scope = "foo:bar:baz"
+      should_authorize "foo"
+      should_authorize "foo:bar"
+      should_authorize "foo:bar:baz"
+    end
+    
+    it 'should not work for a non-specified subsegment' do
+      @scope = "user:read"
+      should_not_authorize "user:write"
+    end
+    
+    it 'should not work for a deeper namespace' do
+      @scope = "user"
+      should_not_authorize "user:write"
+    end
+    
+    it 'should work from multiple defined scopes' do
+      @scope = "user apps"
+      should_authorize "user"
+      should_authorize "apps"
+    end
+    
+    context 'wildcards' do
+      it 'should allow wildcards to represent any scope' do
+        @scope = "user:*"
+        should_authorize "user:email"
+        should_authorize "user:write"
+      end
+
+      it 'should not grant multi-level authorization with wildcards' do
+        @scope = "user:*"
+        should_not_authorize "user:write:another"
+      end
+
+      it 'should work with lower namespaces and wildcards' do
+        @scope = "user:*:write"
+        should_authorize "user:bob:write"
+        should_authorize "user:frank:write"
+        should_not_authorize "user:bob:read"
+      end
+    end
+    
+    context 'batch delimiter' do
+      it 'should work for each specified in the batch' do
+        @scope = "user,app:write"
+        should_authorize "user:write"
+        should_authorize "app:write"
+        should_not_authorize "book:write"
+      end
+      
+      it 'should work on multiple levels' do
+        @scope = "user,app:read,write"
+        should_authorize "user:write"
+        should_authorize "app:read"
+      end
+    end
+    
+    context 'global wildcards' do
+      it 'should work for any level of specificity' do
+        @scope = "user:**"
+        should_authorize "user:abc:write:foo"
+      end
+      
+      it 'should work as a catch-all if supplied alone' do
+        @scope = "**"
+        should_authorize "foo:bar:baz"
+      end
+    end
+  end
+  
+  describe '#any?' do
+    it 'should authorize any of the supplied scopes' do
+      @scope = "user:foo:write"
+      expect(subject).to be_any('user:foo:write', 'admin')
+    end
+  end
+  
+  describe '#all?' do
+    it 'should authorize only with ALL of the supplied scopes' do
+      @scope = "user admin"
+      expect(subject).to be_all("user", "admin")
+      expect(subject).not_to be_all("user", "bork")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'auth_scope'
+
+module SpecHelpers
+  def should_authorize(scope)
+    expect(subject).to be_can(scope)
+  end
+  
+  def should_not_authorize(scope)
+    expect(subject).not_to be_can(scope)
+  end
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+  config.include SpecHelpers
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: auth_scope
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Authorization library using namespaced strings. Great for OAuth 2.0 APIs.
+email:
+- mbleigh@mbleigh.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- auth_scope.gemspec
+- lib/auth_scope.rb
+- lib/auth_scope/version.rb
+- spec/auth_scope_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/divshot/auth_scope
+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: Authorization library using namespaced strings. Great for OAuth 2.0 APIs.
+test_files:
+- spec/auth_scope_spec.rb
+- spec/spec_helper.rb
+has_rdoc: