rack-authorize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3a234d2e1ac7783271991da30747216bce3f3f1
+  data.tar.gz: 671d2d6e2db79c7bedf79f22de58cd0a00b8d732
+SHA512:
+  metadata.gz: e643318b01251944deebcdbf4f1738415141cb18493dbae29bc1358e23f387f54332bffcd51e3ef71ab93f67de59b47dbbeca4339bf70779e94a466f3316d0e5
+  data.tar.gz: a5b5f2d9b260a06d297272fd75d5040aaf039ad0432ecc1589e28f124711b213bae24c1e05bd3f7085c024b8c00afb14b29edfee2d9d47e77849799ddbc6a16b

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 yanguango
+
+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,126 @@
+# Rack::Authorize
+
+Rack::Authorize is a Rack middleware to authorize api access. We know there is Cancan which is a great authorization library for Ruby on Rails. But the rules of Cancan are defined for Ruby Class, when we create web services, it's a common task to restrict the access to api endpoints. That's what Rack::Authorize focus on, it's only used for api stuff. Rack::Authorize can be used in any Ruby web framework since it's a Rack middleware. Thanks Rack.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-authorize', :git => 'git@github.com:yanguango/rack-authorize.git'
+```
+
+This gem is still in development, so it's not posted to rubygems.org
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-authorize
+
+## Usage
+
+### Define Abilities
+You can define ability with `can` macros, which inspired by Cancan. Also you can use `can_get`, `can_post` helpers to define conveniently.
+
+```ruby
+class Ability
+  include Rack::Authorize::Ability
+
+  def initialize(user)
+    can :get, "/api/articles" 
+    # user can access "/api/things" with GET method
+    
+    can :post, "/api/articles" if user.role == 'writer' 
+    # user can post article if he is a writer
+    
+    can :all, "/api/comments" 
+    # user can access "/api/comments" with any methods
+    
+    can_get, :all 
+    # user can access all api endpoints with GET method
+    
+    can_all, :all if user.is_super? 
+    # super user has no restriction
+  end
+end
+```
+
+### Use Rack middleware
+As a Rack middleware, you can use Rack::Authorize in any Rack compatible framework, what you need to do is just use this middleware at appropriate position.
+
+```ruby
+use Rack::Authorize do |method, path|
+  ability = Ability.new(@current_user)
+  ability.can?(method, path)
+end
+```
+
+### Framework Integration
+### Sinatra
+```ruby
+class App < Sinatra::Base
+  use Rack::Auth::Basic do |username, password|
+    @current_user ||= User.authenticate!(username, password)
+  end
+
+  use Rack::Authorize do |method, path|
+    ability = Ability.new(@current_user)
+    ability.can?(method, path)
+  end
+
+  get '/api' do
+    "Hello World!"
+  end
+end
+```
+
+### Grape with Rails
+```ruby
+class AdminAPI < Grape::API
+
+  version 'v1', using: :header
+  format :json
+  prefix 'api'
+  
+  namespace :admin do
+    use Rack::Auth::Basic do |username, password|
+      @current_use ||= AdminUser.authenticate!(username, password)
+    end
+
+    use Rack::Authorize do |method, path|
+      ability = Ability.new(@current_user)
+      ability.can?(method, path)
+    end
+    
+    resources :users do
+      get '/' do
+        "Hello World!"
+      end
+    end
+  end
+end
+```
+
+## Todo
+* Path prefix
+* Api endpoint whitelist
+* ... 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/yanguango/rack-authorize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/authorize"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack-authorize.rb

@@ -0,0 +1 @@
+require "rack/authorize"

data/lib/rack/authorize.rb

@@ -0,0 +1,13 @@
+require "rack/authorize/version"
+
+
+require "rack/authorize/ability"
+require "rack/authorize/rule"
+require "rack/authorize/authorizer"
+module Rack
+  module Authorize
+    def self.new(app, &block)
+      Authorizer.new(app, &block)
+    end
+  end
+end

data/lib/rack/authorize/ability.rb

@@ -0,0 +1,34 @@
+module Rack::Authorize
+  module Ability
+    def can(method, path, &block)
+      rules << Rule.new(method, path, block)
+    end
+
+    def can?(method, path)
+      matched_rules(method, path).each do |rule|
+        return rule.block.call if rule.block
+        return true
+      end
+      false
+    end
+
+    [:get, :put, :post, :delete, :head, :options, :patch, :all].each do |method|
+      define_method("can_#{method}".to_sym) do |path, &block|
+        can(method, path, &block)
+      end
+
+      define_method("can_#{method}?".to_sym) do |path|
+        can?(method, path)
+      end
+    end
+
+    private
+    def rules
+      @rules ||= []
+    end
+
+    def matched_rules(method, path)
+      rules.select {|rule| rule.relevant?(method, path)}
+    end
+  end
+end

data/lib/rack/authorize/authorizer.rb

@@ -0,0 +1,15 @@
+module Rack::Authorize
+  class Authorizer
+    def initialize(app, &block)
+      @app = app
+      @block = block
+    end
+
+    def call(env)
+      method = env["REQUEST_METHOD"]
+      path = env["PATH_INFO"]
+      return [403, {}, ["Access Forbidden"]] unless @block.call(method, path)
+      @app.call(env)
+    end
+  end
+end

data/lib/rack/authorize/rule.rb

@@ -0,0 +1,23 @@
+module Rack::Authorize
+  class Rule
+    attr_reader :method, :path, :block
+
+    def initialize(method, path, block)
+      @method = method.to_sym
+      @path = path
+      @block = block
+    end
+
+    def relevant?(method, path)
+      method = method.downcase.to_sym
+      if @method == :all
+        @path == :all || path == @path
+      elsif @path == :all
+        @method == :all || method == @method
+      else
+        (@method == :all && @path == :all) ||
+        (method == @method && path == @path)
+      end
+    end
+  end
+end

data/lib/rack/authorize/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Authorize
+    VERSION = "0.1.0"
+  end
+end

data/rack-authorize.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/authorize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-authorize"
+  spec.version       = Rack::Authorize::VERSION
+  spec.authors       = ["yanguango"]
+  spec.email         = ["yanguango@gmail.com"]
+
+  spec.summary       = %q{A Rack middleware to authorize api access}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/yanguango/rack-authorize"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: rack-authorize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yanguango
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: ''
+email:
+- yanguango@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack-authorize.rb
+- lib/rack/authorize.rb
+- lib/rack/authorize/ability.rb
+- lib/rack/authorize/authorizer.rb
+- lib/rack/authorize/rule.rb
+- lib/rack/authorize/version.rb
+- rack-authorize.gemspec
+homepage: https://github.com/yanguango/rack-authorize
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: A Rack middleware to authorize api access
+test_files: []