kan 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: d21ee95936ea431cd541add761806729598ee02d
4
+ data.tar.gz: 3af71fe7b9a1e7b76d1e41955356d7c88fc2220b
5
+ SHA512:
6
+ metadata.gz: 51068bae77f496f2c4411540d2a99d5a30dcf12203cec91d5664760fd1e75f52f1c89efe7c65c61f5df428abea926874250a3a68e117a573016572583aa2fe79
7
+ data.tar.gz: 168764d5406fceb5806388dff893d52fa5f41ba8c49445540140dfc962afbebe421f0eae5d1c0491654cf0814192346ba0317c941fa105b019dd67244013b14b
data/.gitignore ADDED
@@ -0,0 +1,8 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.1
5
+ before_install: gem install bundler -v 1.16.0
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at antondavydov.o@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in kan.gemspec
6
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,44 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ kan (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ concurrent-ruby (1.0.5)
10
+ diff-lcs (1.3)
11
+ dry-auto_inject (0.4.5)
12
+ dry-container (>= 0.3.4)
13
+ dry-configurable (0.7.0)
14
+ concurrent-ruby (~> 1.0)
15
+ dry-container (0.6.0)
16
+ concurrent-ruby (~> 1.0)
17
+ dry-configurable (~> 0.1, >= 0.1.3)
18
+ rake (10.5.0)
19
+ rspec (3.7.0)
20
+ rspec-core (~> 3.7.0)
21
+ rspec-expectations (~> 3.7.0)
22
+ rspec-mocks (~> 3.7.0)
23
+ rspec-core (3.7.1)
24
+ rspec-support (~> 3.7.0)
25
+ rspec-expectations (3.7.0)
26
+ diff-lcs (>= 1.2.0, < 2.0)
27
+ rspec-support (~> 3.7.0)
28
+ rspec-mocks (3.7.0)
29
+ diff-lcs (>= 1.2.0, < 2.0)
30
+ rspec-support (~> 3.7.0)
31
+ rspec-support (3.7.0)
32
+
33
+ PLATFORMS
34
+ ruby
35
+
36
+ DEPENDENCIES
37
+ bundler (~> 1.16)
38
+ dry-auto_inject
39
+ kan!
40
+ rake (~> 10.0)
41
+ rspec (~> 3.7)
42
+
43
+ BUNDLED WITH
44
+ 1.16.1
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Anton Davydov
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.
data/README.md ADDED
@@ -0,0 +1,114 @@
1
+ # Kan
2
+
3
+ Simple fundctional authorization library for ruby. Inspired by [transproc](https://github.com/solnic/transproc)
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'kan'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install kan
20
+
21
+ ## Usage
22
+
23
+ ```ruby
24
+ class Post::Abilities
25
+ include Kan::Abilities
26
+
27
+ register 'read' { |_, _| true }
28
+ register 'edit' { |user, post| user.id == post.user_id }
29
+ register 'delete' { |_, _| false }
30
+ end
31
+
32
+ # register more than one ability in one place
33
+ class Post::AdminAbilities
34
+ include Kan::Abilities
35
+
36
+ register :read, :edit, :delete { |user, _| user.admin? }
37
+ end
38
+
39
+ class Comments::Abilities
40
+ include Kan::Abilities
41
+
42
+ register 'read' { |_, _| true }
43
+ register 'edit' { |user, _| user.admin? }
44
+
45
+ register :delete do |user, comment|
46
+ user.id == comment.user_id && comment.created_at < Time.now + TEN_MINUTES
47
+ end
48
+ end
49
+
50
+ abilities = Kan::Application.new(
51
+ post: Post::Abilities.new,
52
+ comment: Comments::Abilities.new,
53
+ )
54
+
55
+ abilities['post.read'].call(current_user, post) # => true
56
+ abilities['post.delete'].call(current_user, post) # => false
57
+
58
+ abilities['comment.delete'].call(current_user, post) # => false
59
+
60
+ # Default ability eq `proc { true }`
61
+ abilities['comment.invalid'].call(current_user, post) # => true
62
+
63
+ # But you can rewrite default ability block
64
+ admin_abilities = Kan::Application.new(
65
+ post: Post::AdminAbilities.new(default_ability_block: proc { false}),
66
+ comment: Comments::Abilities.new,
67
+ )
68
+
69
+ admin_abilities['post.delete'].call(current_user, post) # => false
70
+ admin_abilities['post.delete'].call(admin_user, post) # => true
71
+ admin_abilities['post.invalid'].call(current_user, post) # => false
72
+
73
+ global_abilities = Kan::Application.new(
74
+ post: [Post::Abilities.new, Post::AdminAbilities.new],
75
+ comment: Comments::Abilities.new,
76
+ )
77
+
78
+ global_abilities['post.edit'].call(current_user, post) # => false
79
+ global_abilities['post.edit'].call(owner_user, post) # => true
80
+ global_abilities['post.edit'].call(admin_user, post) # => true
81
+ ```
82
+
83
+ ### Dry-auto\_inject
84
+ ```ruby
85
+ AbilitiesImport = Dry::AutoInject(Kan::Application.new({}))
86
+
87
+ # Operation
88
+
89
+ class UpdateOperation
90
+ include AbilitiesImport[ability_checker: 'post.edit']
91
+
92
+ def call(user, params)
93
+ return Left(:permission_denied) unless ability_checker.call(user)
94
+ # ...
95
+ end
96
+ end
97
+
98
+ # Specs
99
+
100
+ UpdateOperation.new(ability_checker: ->(*) { true })
101
+ UpdateOperation.new(ability_checker: ->(*) { false })
102
+ ```
103
+
104
+ ## Contributing
105
+
106
+ Bug reports and pull requests are welcome on GitHub at https://github.com/davydovanton/kan. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
107
+
108
+ ## License
109
+
110
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
111
+
112
+ ## Code of Conduct
113
+
114
+ Everyone interacting in the Kan project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/kan/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -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
data/kan.gemspec ADDED
@@ -0,0 +1,27 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "kan/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "kan"
8
+ spec.version = Kan::VERSION
9
+ spec.authors = ["Anton Davydov"]
10
+ spec.email = ["antondavydov.o@gmail.com"]
11
+
12
+ spec.summary = %q{Simple, light and functional authorization library}
13
+ spec.homepage = "https://github.com/davydovanton/kan"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
17
+ f.match(%r{^(test|spec|features)/})
18
+ end
19
+ spec.bindir = "exe"
20
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.16"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "rspec", "~> 3.7"
26
+ spec.add_development_dependency "dry-auto_inject"
27
+ end
data/lib/kan.rb ADDED
@@ -0,0 +1,7 @@
1
+ require 'kan/application'
2
+ require 'kan/abilities'
3
+ require 'kan/version'
4
+
5
+ module Kan
6
+ # Your code goes here...
7
+ end
@@ -0,0 +1,28 @@
1
+ module Kan
2
+ module Abilities
3
+ def self.included(base)
4
+ base.extend(ClassMethods)
5
+ end
6
+
7
+ module ClassMethods
8
+ def register(*abilities, &block)
9
+ @ability_list ||= {}
10
+ abilities.each { |ability| @ability_list[ability.to_sym] = block }
11
+ end
12
+
13
+ def ability_list
14
+ @ability_list || {}
15
+ end
16
+ end
17
+
18
+ DEFAULT_ABILITY_BLOCK = proc { true }
19
+
20
+ def initialize(options = {})
21
+ @options = options
22
+ end
23
+
24
+ def ability(name)
25
+ self.class.ability_list[name.to_sym] || @options[:default_ability_block] || DEFAULT_ABILITY_BLOCK
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,12 @@
1
+ module Kan
2
+ class Application
3
+ def initialize(scopes)
4
+ @scopes = Hash(scopes)
5
+ end
6
+
7
+ def [](ability)
8
+ scope, ability_name = ability.split('.')
9
+ @scopes[scope.to_sym].ability(ability_name)
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,3 @@
1
+ module Kan
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,114 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: kan
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Anton Davydov
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-01-09 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.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
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: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.7'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.7'
55
+ - !ruby/object:Gem::Dependency
56
+ name: dry-auto_inject
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description:
70
+ email:
71
+ - antondavydov.o@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - CODE_OF_CONDUCT.md
80
+ - Gemfile
81
+ - Gemfile.lock
82
+ - LICENSE.txt
83
+ - README.md
84
+ - Rakefile
85
+ - kan.gemspec
86
+ - lib/kan.rb
87
+ - lib/kan/abilities.rb
88
+ - lib/kan/application.rb
89
+ - lib/kan/version.rb
90
+ homepage: https://github.com/davydovanton/kan
91
+ licenses:
92
+ - MIT
93
+ metadata: {}
94
+ post_install_message:
95
+ rdoc_options: []
96
+ require_paths:
97
+ - lib
98
+ required_ruby_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ requirements: []
109
+ rubyforge_project:
110
+ rubygems_version: 2.6.13
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: Simple, light and functional authorization library
114
+ test_files: []