motion-authorization 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 400658a54623abf6a66395abb59934aae5123f49
+  data.tar.gz: cddd3ec92a8340b14526c7e700374522289df96a
+SHA512:
+  metadata.gz: 99ec888101700efb512d47c23b29455aee60012ba6237e321a6b822506fdacffb5ebad3383812f27a6c7aa5f68e0dc98f6f1f2d1d9b2a663e45d51590ee41e3d
+  data.tar.gz: 538fc59e76e941282a5ca461f8d5a0292deddb87f1a8d1aaf2ba4697aefe8081169ca1e613c048075b568b8e9a97221b1d0f4fa2563d351351e93b7a481779cf

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrew Havens
+
+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,97 @@
+# Motion::Authorization
+
+This gem provides simple authorization to your RubyMotion app. It was inspired by both [CanCan](https://github.com/ryanb/cancan) and [Pundit](https://github.com/elabs/pundit). There are no dependencies, so it should work in all kinds of RubyMotion apps. Permissions are defined as "policy" classes (like Pundit) and queried with a syntax similar to CanCan.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "motion-authorization"
+```
+
+And then execute:
+
+    $ bundle
+
+Be sure to `require "motion-authorization"` in your Rakefile (unless you are using `Bundler.require`).
+
+## Usage
+
+### Step 1: Specify the current user.
+
+This gem provides two different ways to specify the current user: directly or as a callback to be evaluated later. If setting directly, you will want to do that when the current user changes. Assuming you already have a method for fetching your current user, you can hook into your existing method by defining the `current_user_method` as a block.
+
+```ruby
+Motion::Authorization.current_user = current_user_instance
+# OR...
+Motion::Authorization.current_user_method do
+  MyAuthClass.current_user
+end
+```
+
+### Step 2: Include the DSL methods.
+
+In any class where you want to check if the current user is authorized to do something, start by including the DSL methods:
+
+```ruby
+class MyRubyMotionClass
+  include Motion::Authorization::Methods
+  # ...
+end
+```
+
+Now you can use one of Motion::Authorization's query methods to check if the current user can do something. Let's say that we have a `SecretMessage` object, and we only want to display it if the current user is able to view it.
+
+```ruby
+display_secret_message if can? :view, secret_message
+```
+
+Motion::Authorization provides several methods to choose from that may (or may not) make your code easier to read.
+
+* `can?`
+* `permitted_to?`
+* `authorized_to?`
+* `authorised_to?`
+
+Choose the method which you like best.
+
+### Step 3: Define a Policy class.
+
+Extending our previous example of `can? :view, secret_message`, Motion::Authorization will look for a class named `SecretMessagePolicy` with a method named `view?` which returns true or false.
+
+Policy classes in Motion::Authorization are identical to those in [Pundit](https://github.com/elabs/pundit). Typically, you will create a class within a `policies` directory, such as `app/policies/secret_message_policy.rb`. Next, you would define a class that accepts the current user and object that it is related to. Something like this:
+
+```ruby
+class SecretMessagePolicy
+  attr_accessor :user, :secret_message
+
+  def initialize(user, secret_message)
+    @user = user
+    @secret_message = secret_message
+  end
+
+  def view?
+    user.id == secret_message.owner.id
+  end
+end
+```
+
+Or even more simply by using `Struct`:
+
+
+```ruby
+class SecretMessagePolicy < Struct.new(:user, :secret_message)
+  def view?
+    user.id == secret_message.owner.id
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andrewhavens/motion-authorization.
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/motion-authorization.rb

@@ -0,0 +1,7 @@
+unless defined?(Motion::Project::Config)
+  raise 'This gem is intended to be used in a RubyMotion project.'
+end
+
+Motion::Project::App.setup do |app|
+  app.files += Dir.glob(File.join(File.dirname(__FILE__), 'motion', '**', '*.rb'))
+end

data/lib/motion/authorization.rb

@@ -0,0 +1,45 @@
+module Motion
+  class Authorization
+
+    class << self
+      attr_accessor :current_user
+
+      def current_user_method(&block)
+        @current_user_block = block
+      end
+
+      def current_user
+        if @current_user_block
+          @current_user_block.call
+        else
+          @current_user
+        end
+      end
+
+      def can?(action, object)
+        policy_class_name = "#{object.class}Policy"
+
+        unless Object.const_defined?(policy_class_name)
+          puts "Undefined permissions policy class #{policy_class_name}"
+          return false
+        end
+
+        policy = policy_class_name.constantize.new(current_user, object)
+
+        unless policy.respond_to?("#{action}?")
+          puts "No #{action}? method found in #{policy_class_name}"
+          return false
+        end
+
+        policy.send "#{action}?"
+      end
+    end
+
+    module Methods
+      def can?(action, object)           Motion::Authorization.can?(action, object) end
+      def permitted_to?(action, object)  Motion::Authorization.can?(action, object) end
+      def authorized_to?(action, object) Motion::Authorization.can?(action, object) end
+      def authorised_to?(action, object) Motion::Authorization.can?(action, object) end
+    end
+  end
+end

data/motion-authorization.gemspec

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "motion-authorization"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Andrew Havens"]
+  spec.email         = ["email@andrewhavens.com"]
+
+  spec.summary       = %q{Simple authorization for RubyMotion. Inspired by CanCan and Pundit.}
+  spec.homepage      = "https://github.com/andrewhavens/motion-authorization"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: motion-authorization
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Havens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-20 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- email@andrewhavens.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/motion-authorization.rb
+- lib/motion/authorization.rb
+- motion-authorization.gemspec
+homepage: https://github.com/andrewhavens/motion-authorization
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple authorization for RubyMotion. Inspired by CanCan and Pundit.
+test_files: []