gris-toko_ohno 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b7749099abd8b57f057eb2b28ad45c394e731f2
+  data.tar.gz: 4e4785e71bab5cea1344834de7169bab47bcd76c
+SHA512:
+  metadata.gz: 477b9d92f3c8ea3188e9156268c213f13c680f189aaad71e14b747da33f8ba24258f10c390318e4e7530ead2911e17aea5646eb1bb4624e7efa5749f53e11b65
+  data.tar.gz: fa82b978b7b28e79a42094d20d5660ae3363396d7d859b292eff6897f814d076acac71368310a5c61368a37996294baa3e3c8bea6bcd6fabb0b092c7ef422106

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/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dylan Fareed
+
+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,123 @@
+# Gris::TokoOhno
+
+[Gris::TokoOhno](https://github.com/dylanfareed/gris-toko_ohno) is a simple helper providing token authentication via headers or params in your [Gris](https://github.com/artsy/gris) app's Grape endpoints.
+
+Conveniently, Gris::TokoOhno is tied to `Gris.secrets` so that you can ensure that requests match values set in your ENV.
+
+---
+
+### Installation
+
+Gris::TokoOhno is [available as a gem on rubygems](https://github.com/dylanfareed/gris-toko_ohno), to install it run:
+
+```
+gem install gris-toko_ohno
+```
+
+Otherwise, if your project uses [Bundler](http://bundler.io/), add gris-toko_ohno to your Gemfile:
+
+```
+gem 'gris-toko_ohno'
+```
+
+And run:
+
+```
+$ bundle install
+```
+
+---
+
+### Usage
+
+Once you have installed or bundled gris-toko_ohno with your Gris app, using it is a two-step process. You must set the Gris.secrets for your permitted tokens as environment variables and then add the token_authenticate! helper in your endpoints.
+
+##### Set the ENV value
+
+By default, Gris::TokoOhno will verify inbound requests against values set in `Gris.secrets.permitted_tokens`. To set a value for `permitted_tokens`, simply add it to your Gris config/secrets.yml file.
+
+```
+default: &default
+  service_name: my_secure_service
+  permitted_tokens: <%= ENV['PERMITTED_TOKENS'] %>
+  base_url: <%= ENV['BASE_URL'] || 'http://localhost:9292' %>
+```
+
+The value set in your environment should be a string and may be separated by comma(s).
+
+You can also use custom secret names (if you wanted to provide multiple checks with different tokens over different endpoints, for example) by simply defining a different secret value.
+
+```
+default: &default
+  service_name: my_secure_service
+  other_tokens: <%= ENV['OTHER_TOKENS'] %>
+  base_url: <%= ENV['BASE_URL'] || 'http://localhost:9292' %>
+```
+
+You would then have to specify the custom secret when you call token_authenticate! per the instructions below.
+
+##### Add token_authenticate! to your endpoints
+
+To authenticate a particular endpoint:
+
+```ruby
+class ApplicationEndpoint < Grape::API
+  # Authenticated
+  get do
+    token_authentication!
+    present self, with: RootPresenter
+  end
+
+  # Not authenticated
+  get '/hello' do
+    present self, with: RootPresenter
+  end
+end
+```
+
+You can also authenticate all endpoints in an API using Grape helpers.
+
+```ruby
+class ApplicationEndpoint < Grape::API
+  before do
+    token_authentication!
+  end
+
+  # Authenticated
+  get do
+    present self, with: RootPresenter
+  end
+
+  # Authenticated
+  get '/hello' do
+    present self, with: RootPresenter
+  end
+end
+```
+
+The helper will check against `Gris.secrets.permitted_tokens` by default, but you can also choose to specify a custom Gris.secrets value.
+
+To verify that a request provides token or header credentials that match `Gris.secrets.other_tokens` (for example):
+
+```ruby
+class ApplicationEndpoint < Grape::API
+  get do
+    token_authentication! :other_tokens
+    present self, with: RootPresenter
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dylanfareed/gris-toko_ohno. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+## Context
+
+![yoko-ono-war-is-over-if-you-want-it](https://cloud.githubusercontent.com/assets/197336/9416396/6a91989c-4813-11e5-8541-75946f714ac1.jpg)

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.options = %w(-D --auto-correct)
+end
+
+task default: [:rubocop, :spec]

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/gris-toko_ohno.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gris/toko_ohno/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gris-toko_ohno'
+  spec.version       = Gris::TokoOhno::VERSION
+  spec.authors       = ['Dylan Fareed']
+  spec.email         = ['email@dylanfareed.com']
+
+  spec.summary       = 'Header or token auth for Gris apps.'
+  spec.description   = 'Header or token auth for Gris apps.'
+  spec.homepage      = 'https://github.com/dylanfareed/gris-toko_ohno'
+  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 'gris'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'byebug'
+end

data/lib/gris/toko_ohno/version.rb

@@ -0,0 +1,6 @@
+module Gris
+  # Header or token auth for Gris apps.
+  module TokoOhno
+    VERSION = '0.1.0'
+  end
+end

data/lib/gris/toko_ohno.rb

@@ -0,0 +1,32 @@
+require 'gris/toko_ohno/version'
+
+module Gris
+  # Header or token auth for Gris apps.
+  module TokoOhno
+    def token_authentication!(key_sym = :permitted_tokens)
+      error!('Forbidden', 401) unless permitted?(key_sym)
+    end
+
+    private
+
+    def permitted?(key_sym)
+      permit_by_headers(key_sym) || permit_by_params(key_sym)
+    end
+
+    def permit_by_headers(key_sym)
+      return unless request.headers['Http-Authorization']
+      permitted_tokens(key_sym).include? request.headers['Http-Authorization']
+    end
+
+    def permit_by_params(key_sym)
+      return unless params[:token]
+      permitted_tokens(key_sym).include? params[:token]
+    end
+
+    def permitted_tokens(key_sym)
+      Gris.secrets.send(key_sym).split(',')
+    end
+
+    Grape::API.send :include, self if defined?(Grape)
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: gris-toko_ohno
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dylan Fareed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gris
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Header or token auth for Gris apps.
+email:
+- email@dylanfareed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- gris-toko_ohno.gemspec
+- lib/gris/toko_ohno.rb
+- lib/gris/toko_ohno/version.rb
+homepage: https://github.com/dylanfareed/gris-toko_ohno
+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.8
+signing_key: 
+specification_version: 4
+summary: Header or token auth for Gris apps.
+test_files: []