authoraise 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f24e784a52e7c2725bfc0eade0fe98a1909fcd4
-  data.tar.gz: cb91b76b2dea79aac821e178bfa288947d7d5f46
+  metadata.gz: bad448d3d7ef8c5805470e70819ecbb6575daaa1
+  data.tar.gz: 4e85ac9821aaa0f96a1afc490c6554512036b2b2
 SHA512:
-  metadata.gz: 4c60e2997ea5f5dabd5773a09315c9d81015b2064d85ad4d4d7b301a7ac410c17f249ab51e3ced94db87c75b1447162bc9329899ecf4a8f3911ccffa6b20601b
-  data.tar.gz: 922747b570f4d91313c363af7e394faf7f7cb853863808b2f2c2d7ed633d3b850d75b1bf7c18f0495c41166fe511e3172ec7d0f259c5410862b3d1e35564c2ec
+  metadata.gz: cd68a93363b33ba04674cf5a90a932eefbac6c80130842d273b8775f9357583e8030d1b200da7c298d776cb4776eb6cb32fee5d9d022fce37622a01c4688772a
+  data.tar.gz: 6bb5bb7a4724ae819a318f276d0bd5cbe9d91dca8890cf572ec197e7eb4e1baed77f1954f2494f49023351275b62cae05ed0d97ae7bfb8a603d29c6ff14b42ef

data/CHANGELOG

@@ -0,0 +1,7 @@
+v0.1.2
+
+* Policy constructor now accepts block: policy = Policy.new{ |p| p.allow{} }
+
+v0.1.1
+
+* The beginning

data/README.md

@@ -1,10 +1,39 @@
 # Authoraise
 
-So your authorization logic is getting complex, and eventually you start forgetting to pass in all the options that are used to check access. When that happens, your boolean expressions return false, causing false negatives. This tool solves the problem by raising helpful error messages, but also allows you to ignore the issue where it's intended to be that way. No more false negatives!
+This gem is not like other authorization gems because it doesn't enforce any kind of structure or vocabulary on your app. Its only job is to wrap and audit your boolean expressions that you use for authorization.
+
+So instead of writing boolean expressions like this.
+
+~~~ruby
+  options[:post] &&
+    (options[:post].publised? || (options[:post].user == options[:user]))
+~~~
+
+You would write them like this.
+
+~~~ruby
+  policy = Authoraise::Policy.new
+  policy.allow { |post| post.published? }
+  policy.allow { |post, user| post.user == user }
+  policy.authorize(options)
+~~~
+
+Or like this.
+
+~~~ruby
+  authorize(options) do |policy|
+    policy.allow { |post| post.published? }
+    policy.allow { |post, user| post.user == user }
+  end
+~~~
+
+You may wonder why would you do that. Well, when your authorization logic gets more complex, you might start forgetting to pass in all the options that are used to check access. When that happens, your boolean expressions return false, causing false negatives. Take a look at the first example above, and think what happens if post is not published and `options[:user]` is not passed in. Hint: you just get a `false`. Your program would lie to you, because really you never gave it a user to check, so how does it know if it's a false? It's straight up missing some data.
+
+This gem solves the problem by raising helpful error messages, but also allowing you to ignore the issue where it's intended to be that way. So in the examples above if you pass an unpublished post and forget to pass in a user in the options, you will see a helpful error message.
 
 ## Usage
 
-Follow these examples to see what happens when sometimes you forget to pass the keys needed for a certain authorization check.
+Follow these examples to understand how things work in various cases.
 
 ~~~ruby
 require 'authoraise'
@@ -51,7 +80,7 @@ end
 # Let's see what happens in strict mode.
 Authoraise.strict_mode = true
 
-# In stict mode any missing key raises an error, even if other checks passed.
+# In strict mode any missing key raises an error, even if other checks passed.
 authorize(user: 'sammy') do |policy|
   policy.allow { |user| user == 'sammy' }
   policy.allow { |post| post == 'foo' }

data/lib/authoraise.rb

@@ -6,10 +6,8 @@ module Authoraise
 
   class << self; attr_accessor :strict_mode end
 
-  def authorize(options = {})
-    policy = Policy.new
-    yield(policy)
-    policy.authorize(options)
+  def authorize(options = {}, &block)
+    Policy.new(&block).authorize(options)
   end
 
   class Check
@@ -38,7 +36,7 @@ module Authoraise
   class Policy
     def initialize
       @checks = []
-      @mode = :any
+      yield(self) if block_given?
     end
 
     def allow(&procedure)

data/lib/authoraise/version.rb

@@ -1,3 +1,3 @@
 module Authoraise
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authoraise
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Maxim Chernyak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt