grape-cancan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38721406628690b22a71b1089852cf9817243d66
+  data.tar.gz: 909778e00ac3260ab4b8e2756f47ca9073d54532
+SHA512:
+  metadata.gz: a6facc9a56bc9889ed35589dcd11b3f3ff73296eeab18ad5d9a2416bcaf6e8c75c214daf52a0fd5dde1d8ba9fec9be673ec7ba65f695269f8a459f7475e43b47
+  data.tar.gz: 35d2caf20054ad54f7a7618f0015792df7d88ba57231e7b4fc395915658f22dfc365bbed4c01110d181a2cb663ff74bcf2597be36e213524dd2445bd5ffab549

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ray Zane
+
+MIT License
+
+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,80 @@
+# Grape::CanCan
+
+Use CanCan to authorize your Grape endpoints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-cancan'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-cancan
+
+__NOTE:__ The [cancan](https://github.com/ryanb/cancan) gem by Ryan Bates is no longer maintained. If you're still using that gem, you should consider replacing it with [cancancan](https://github.com/CanCanCommunity/cancancan).
+
+## Usage
+
+This gem adds the __can?__, __cannot?__, and __authorize!__ helper methods to all Grape API endpoints. This gem expects you to have a __current_user__ helper.
+
+```ruby
+class Users < Grape::API
+  resource :users
+
+  get '/:id' do
+    @user = User.find(params[:id])
+    authorize! :read, @user
+    @user
+  end
+end
+```
+
+#### Authorizing All Routes
+
+The __authorize_routes!__ method allows you to automatically perform authorization on all routes. Just add the `:authorize` key to the route options and call `authorize_routes!`.
+
+Authorization will be skipped on actions that don't provide the `:authorize` route option.
+
+```ruby
+class Users < Grape::API
+  resource :users
+  authorize_routes!
+
+  get '/', authorize: [:read, User] do
+    User.all
+  end
+end
+```
+
+#### Authorizing Specific Routes
+
+For more fine grained control, you can call __authorize_route!__ in a `before` block.
+
+```ruby
+class Users < Grape::API
+  resource :users
+
+  before do
+    authorize_route! if user_signed_in?
+  end
+
+  get '/', authorize: [:read, User] do
+    User.all
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/rzane/grape-cancan/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/grape-cancan.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/cancan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape-cancan"
+  spec.version       = Grape::CanCan::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["raymondzane@gmail.com"]
+  spec.summary       = %q{Authorize your Grape API with CanCan}
+  spec.description   = %q{Authorize your Grape API with CanCan}
+  spec.homepage      = "https://github.com/rzane/grape-cancan"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'grape', '>= 0.6.0'
+  spec.add_dependency 'cancancan'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/grape/cancan/authorizer.rb

@@ -0,0 +1,10 @@
+module Grape
+  module CanCan
+    module Authorizer
+      # Convienience method to authorize every route
+      def authorize_routes!
+        before { authorize_route! }
+      end
+    end
+  end
+end

data/lib/grape/cancan/helpers.rb

@@ -0,0 +1,19 @@
+module Grape
+  module CanCan
+    module Helpers
+      delegate :can?, :cannot?, :authorize!, to: :current_ability
+
+      # Returns an instance of the CanCan ability
+      def current_ability
+        @current_ability ||= ::Ability.new(current_user)
+      end
+
+      # Call authorize using the :authorize key on the route
+      def authorize_route!
+        opts = env['api.endpoint'].options[:route_options]
+        return unless opts.key?(:authorize)
+        authorize!(*opts[:authorize])
+      end
+    end
+  end
+end

data/lib/grape/cancan/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module CanCan
+    VERSION = "0.0.1"
+  end
+end

data/lib/grape/cancan.rb

@@ -0,0 +1,12 @@
+require 'grape'
+require 'grape/cancan/version'
+
+module Grape
+  module CanCan
+    autoload :Helpers,    'grape/cancan/helpers'
+    autoload :Authorizer, 'grape/cancan/authorizer'
+
+    Grape::Endpoint.send :include, Grape::CanCan::Helpers
+    Grape::API.extend Grape::CanCan::Authorizer
+  end
+end

data/lib/grape-cancan.rb

@@ -0,0 +1 @@
+require 'grape/cancan'

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: grape-cancan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Authorize your Grape API with CanCan
+email:
+- raymondzane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-cancan.gemspec
+- lib/grape-cancan.rb
+- lib/grape/cancan.rb
+- lib/grape/cancan/authorizer.rb
+- lib/grape/cancan/helpers.rb
+- lib/grape/cancan/version.rb
+homepage: https://github.com/rzane/grape-cancan
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Authorize your Grape API with CanCan
+test_files: []