rack-authorize 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: b3a234d2e1ac7783271991da30747216bce3f3f1
4
+ data.tar.gz: 671d2d6e2db79c7bedf79f22de58cd0a00b8d732
5
+ SHA512:
6
+ metadata.gz: e643318b01251944deebcdbf4f1738415141cb18493dbae29bc1358e23f387f54332bffcd51e3ef71ab93f67de59b47dbbeca4339bf70779e94a466f3316d0e5
7
+ data.tar.gz: a5b5f2d9b260a06d297272fd75d5040aaf039ad0432ecc1589e28f124711b213bae24c1e05bd3f7085c024b8c00afb14b29edfee2d9d47e77849799ddbc6a16b
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.2
4
+ before_install: gem install bundler -v 1.10.5
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ 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.
4
+
5
+ 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.
6
+
7
+ 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.
8
+
9
+ 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.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ 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 ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in rack-authorize.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 yanguango
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,126 @@
1
+ # Rack::Authorize
2
+
3
+ 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.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'rack-authorize', :git => 'git@github.com:yanguango/rack-authorize.git'
11
+ ```
12
+
13
+ This gem is still in development, so it's not posted to rubygems.org
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install rack-authorize
22
+
23
+ ## Usage
24
+
25
+ ### Define Abilities
26
+ You can define ability with `can` macros, which inspired by Cancan. Also you can use `can_get`, `can_post` helpers to define conveniently.
27
+
28
+ ```ruby
29
+ class Ability
30
+ include Rack::Authorize::Ability
31
+
32
+ def initialize(user)
33
+ can :get, "/api/articles"
34
+ # user can access "/api/things" with GET method
35
+
36
+ can :post, "/api/articles" if user.role == 'writer'
37
+ # user can post article if he is a writer
38
+
39
+ can :all, "/api/comments"
40
+ # user can access "/api/comments" with any methods
41
+
42
+ can_get, :all
43
+ # user can access all api endpoints with GET method
44
+
45
+ can_all, :all if user.is_super?
46
+ # super user has no restriction
47
+ end
48
+ end
49
+ ```
50
+
51
+ ### Use Rack middleware
52
+ 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.
53
+
54
+ ```ruby
55
+ use Rack::Authorize do |method, path|
56
+ ability = Ability.new(@current_user)
57
+ ability.can?(method, path)
58
+ end
59
+ ```
60
+
61
+ ### Framework Integration
62
+ ### Sinatra
63
+ ```ruby
64
+ class App < Sinatra::Base
65
+ use Rack::Auth::Basic do |username, password|
66
+ @current_user ||= User.authenticate!(username, password)
67
+ end
68
+
69
+ use Rack::Authorize do |method, path|
70
+ ability = Ability.new(@current_user)
71
+ ability.can?(method, path)
72
+ end
73
+
74
+ get '/api' do
75
+ "Hello World!"
76
+ end
77
+ end
78
+ ```
79
+
80
+ ### Grape with Rails
81
+ ```ruby
82
+ class AdminAPI < Grape::API
83
+
84
+ version 'v1', using: :header
85
+ format :json
86
+ prefix 'api'
87
+
88
+ namespace :admin do
89
+ use Rack::Auth::Basic do |username, password|
90
+ @current_use ||= AdminUser.authenticate!(username, password)
91
+ end
92
+
93
+ use Rack::Authorize do |method, path|
94
+ ability = Ability.new(@current_user)
95
+ ability.can?(method, path)
96
+ end
97
+
98
+ resources :users do
99
+ get '/' do
100
+ "Hello World!"
101
+ end
102
+ end
103
+ end
104
+ end
105
+ ```
106
+
107
+ ## Todo
108
+ * Path prefix
109
+ * Api endpoint whitelist
110
+ * ...
111
+
112
+ ## Development
113
+
114
+ 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.
115
+
116
+ 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).
117
+
118
+ ## Contributing
119
+
120
+ 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.
121
+
122
+
123
+ ## License
124
+
125
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
126
+
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "rack/authorize"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1 @@
1
+ require "rack/authorize"
@@ -0,0 +1,13 @@
1
+ require "rack/authorize/version"
2
+
3
+
4
+ require "rack/authorize/ability"
5
+ require "rack/authorize/rule"
6
+ require "rack/authorize/authorizer"
7
+ module Rack
8
+ module Authorize
9
+ def self.new(app, &block)
10
+ Authorizer.new(app, &block)
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,34 @@
1
+ module Rack::Authorize
2
+ module Ability
3
+ def can(method, path, &block)
4
+ rules << Rule.new(method, path, block)
5
+ end
6
+
7
+ def can?(method, path)
8
+ matched_rules(method, path).each do |rule|
9
+ return rule.block.call if rule.block
10
+ return true
11
+ end
12
+ false
13
+ end
14
+
15
+ [:get, :put, :post, :delete, :head, :options, :patch, :all].each do |method|
16
+ define_method("can_#{method}".to_sym) do |path, &block|
17
+ can(method, path, &block)
18
+ end
19
+
20
+ define_method("can_#{method}?".to_sym) do |path|
21
+ can?(method, path)
22
+ end
23
+ end
24
+
25
+ private
26
+ def rules
27
+ @rules ||= []
28
+ end
29
+
30
+ def matched_rules(method, path)
31
+ rules.select {|rule| rule.relevant?(method, path)}
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,15 @@
1
+ module Rack::Authorize
2
+ class Authorizer
3
+ def initialize(app, &block)
4
+ @app = app
5
+ @block = block
6
+ end
7
+
8
+ def call(env)
9
+ method = env["REQUEST_METHOD"]
10
+ path = env["PATH_INFO"]
11
+ return [403, {}, ["Access Forbidden"]] unless @block.call(method, path)
12
+ @app.call(env)
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,23 @@
1
+ module Rack::Authorize
2
+ class Rule
3
+ attr_reader :method, :path, :block
4
+
5
+ def initialize(method, path, block)
6
+ @method = method.to_sym
7
+ @path = path
8
+ @block = block
9
+ end
10
+
11
+ def relevant?(method, path)
12
+ method = method.downcase.to_sym
13
+ if @method == :all
14
+ @path == :all || path == @path
15
+ elsif @path == :all
16
+ @method == :all || method == @method
17
+ else
18
+ (@method == :all && @path == :all) ||
19
+ (method == @method && path == @path)
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,5 @@
1
+ module Rack
2
+ module Authorize
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,33 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'rack/authorize/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "rack-authorize"
8
+ spec.version = Rack::Authorize::VERSION
9
+ spec.authors = ["yanguango"]
10
+ spec.email = ["yanguango@gmail.com"]
11
+
12
+ spec.summary = %q{A Rack middleware to authorize api access}
13
+ spec.description = %q{}
14
+ spec.homepage = "https://github.com/yanguango/rack-authorize"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
18
+ # delete this section to allow pushing this gem to any host.
19
+ if spec.respond_to?(:metadata)
20
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
21
+ else
22
+ raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_development_dependency "bundler", "~> 1.10"
31
+ spec.add_development_dependency "rake", "~> 10.0"
32
+ spec.add_development_dependency "minitest"
33
+ end
metadata ADDED
@@ -0,0 +1,103 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rack-authorize
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - yanguango
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-06-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: ''
56
+ email:
57
+ - yanguango@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".travis.yml"
64
+ - CODE_OF_CONDUCT.md
65
+ - Gemfile
66
+ - LICENSE.txt
67
+ - README.md
68
+ - Rakefile
69
+ - bin/console
70
+ - bin/setup
71
+ - lib/rack-authorize.rb
72
+ - lib/rack/authorize.rb
73
+ - lib/rack/authorize/ability.rb
74
+ - lib/rack/authorize/authorizer.rb
75
+ - lib/rack/authorize/rule.rb
76
+ - lib/rack/authorize/version.rb
77
+ - rack-authorize.gemspec
78
+ homepage: https://github.com/yanguango/rack-authorize
79
+ licenses:
80
+ - MIT
81
+ metadata:
82
+ allowed_push_host: https://rubygems.org
83
+ post_install_message:
84
+ rdoc_options: []
85
+ require_paths:
86
+ - lib
87
+ required_ruby_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ required_rubygems_version: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ requirements: []
98
+ rubyforge_project:
99
+ rubygems_version: 2.4.6
100
+ signing_key:
101
+ specification_version: 4
102
+ summary: A Rack middleware to authorize api access
103
+ test_files: []