grape-knock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab97d25b95a0a36b1648fadb345279f25475d52b
+  data.tar.gz: 8053c81076cb1e41338fa83f49aaf0b799e37bef
+SHA512:
+  metadata.gz: eb593d8ca042f942deecfa4922c7be79d9eb92c3f6bfd7329400d7febbd678af0268ffd2c61bd441a2e63d84ecd64f4a49a34c809ddbcda22b233b7c7823d437
+  data.tar.gz: 457bd0bdcd0a88d430e1ce4610dbe70fb7edaf8895de5d1a2c05e34ebabd7d33d0d78540eff243368fef89d777976c03ae7b699f28d39d043855c69dcd68c70f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Pierre-Louis Gottfrois
+
+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,70 @@
+# Grape::Knock
+
+Use [Knock](https://github.com/nsarno/knock) with [Grape](https://github.com/ruby-grape).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-knock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-knock
+
+## Usage
+
+Mount the middleware in your API:
+
+```ruby
+class MyApi < Grape::API
+  format :json
+
+  use Grape::Knock::Authenticable
+end
+```
+
+The gem will raise `Grape::Knock::ForbiddenError` when authentication failed. You can rescue this exception in your API
+in order to respond with a `403 Forbidden` http request:
+
+```ruby
+class MyApi < Grape::API
+  format :json
+
+  use Grape::Knock::Authenticable
+
+  rescue_from Grape::Knock::ForbiddenError do
+    error!('403 Forbidden', 403)
+  end
+end
+```
+
+## Authentication
+
+The gem expect to find your JWT token in the request `Authorization` header. For example using curl:
+
+```
+curl -H "Authorization=Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.e30.BwE63vgb2KmmcUznvFOxKTOtkMNwAoR5yX4MrtydyXc" http://api.com/resource
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grape-knock.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grape/knock"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grape-knock.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/knock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape-knock"
+  spec.version       = Grape::Knock::VERSION
+  spec.authors       = ["Pierre-Louis Gottfrois"]
+  spec.email         = ["pierrelouis.gottfrois@gmail.com"]
+
+  spec.summary       = %q{Use Knock with Grape.}
+  spec.description   = %q{Use Knock with Grape.}
+  spec.homepage      = "https://github.com/gottfrois/grape-knock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "grape", ">= 0.10"
+  spec.add_dependency "knock"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/grape/knock.rb

@@ -0,0 +1,8 @@
+require 'grape'
+require 'grape/knock/version'
+require 'grape/knock/authenticable'
+
+module Grape
+  module Knock
+  end
+end

data/lib/grape/knock/authenticable.rb

@@ -0,0 +1,27 @@
+require 'knock'
+require 'knock/authenticable'
+require 'grape/knock/forbidden_error'
+
+module Grape
+  module Knock
+    class Authenticable < Grape::Middleware::Base
+      include ::Knock::Authenticable
+
+      def token
+        env['HTTP_AUTHORIZATION'].to_s.split(' ').last
+      end
+
+      def authenticate
+        fail ::Grape::Knock::ForbiddenError unless token
+        ::Knock::AuthToken.new(token: token).current_user
+      rescue ::JWT::DecodeError
+        fail ::Grape::Knock::ForbiddenError
+      end
+
+      def before
+        authenticate
+      end
+
+    end
+  end
+end

data/lib/grape/knock/forbidden_error.rb

@@ -0,0 +1,5 @@
+module Grape
+  module Knock
+    ForbiddenError = Class.new(StandardError)
+  end
+end

data/lib/grape/knock/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module Knock
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: grape-knock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierre-Louis Gottfrois
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: knock
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use Knock with Grape.
+email:
+- pierrelouis.gottfrois@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grape-knock.gemspec
+- lib/grape/knock.rb
+- lib/grape/knock/authenticable.rb
+- lib/grape/knock/forbidden_error.rb
+- lib/grape/knock/version.rb
+homepage: https://github.com/gottfrois/grape-knock
+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.6
+signing_key: 
+specification_version: 4
+summary: Use Knock with Grape.
+test_files: []