roda-token-auth 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a2f0a5fd3e8b811a98a716e4303d61ff0a6e8e4
+  data.tar.gz: ea373a28681c13f0cc720676192e5dbd9f9b3e6d
+SHA512:
+  metadata.gz: 142f7945d68ce8d3a843a4412f65849d95bd6c4e8e51ca6260864ce16bd75f48b84d36388e5158805d729019ade179e1ab56006fc9a843c2c483abcad52bae1f
+  data.tar.gz: 98f361759ffa36708713da3a127a7d87bb738f137db45a90909b6c06839cba4c61059f6bf40f7125fc0d131b1be5b002f8f79d7a098a14356d74ea97a9cd5a03

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in roda-token-auth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ronaldo Raivil
+
+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,64 @@
+# Roda Token Authentication
+
+Adds token authentication to Roda.
+Based on [Roda Basic Auth](https://github.com/badosu/roda-basic-auth)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'roda-token-auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install roda-token-auth
+
+## Configuration
+
+Configure your Roda application to use this plugin:
+
+```ruby
+plugin :token_auth
+```
+
+You can pass global options, in this context they'll be shared between all
+`r.token_auth` calls.
+
+```ruby
+plugin :token_auth, authenticator: proc {|token, secret| [token, secret] == %w(foo bar)}
+```
+
+```ruby
+plugin :token_auth, authenticator: proc {|token, secret| [token, secret] == %w(foo bar)}, token_variable: "X-My-Custom-Token", secret_variable: "X-My-Custom-Secret"
+```
+
+## Usage
+
+Call `r.token_auth` inside the routes you want to authenticate the user, it will halt
+the request with 401 response code if the authenticator is false.
+
+You can specify the local authenticator with a block:
+
+```ruby
+r.token_auth { |token, secret| [token, secret] == %w(foo bar) }
+```
+
+## 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/raivil/roda-token-auth.
+
+## 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 "roda/plugins/token_auth"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/roda/plugins/token_auth.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require "roda"
+require "roda/plugins/token_auth/version"
+
+module Roda::RodaPlugins
+  module TokenAuth
+    DEFAULTS = {
+      token_variable: "X-Token",
+      secret_variable: "X-Secret",
+      unauthorized_headers: proc do |_opts|
+        { "Content-Type" => "application/json", "Content-Length" => "0" }
+      end
+    }.freeze
+
+    def self.configure(app, opts = {})
+      plugin_opts = (app.opts[:token_auth] ||= DEFAULTS)
+      app.opts[:token_auth] = plugin_opts.merge(opts)
+      app.opts[:token_auth].freeze
+    end
+
+    module RequestMethods
+      def token_auth(opts = {}, &authenticator)
+        auth_opts = roda_class.opts[:token_auth].merge(opts)
+        authenticator ||= auth_opts[:authenticator]
+
+        raise "Must provide an authenticator block" if authenticator.nil?
+        auth_token = header_variable(auth_opts, :token_variable)
+        auth_secret = header_variable(auth_opts, :secret_variable)
+        return if authenticator.call(auth_token, auth_secret)
+        auth_opts[:unauthorized]&.call(self)
+        halt [401, auth_opts[:unauthorized_headers].call(auth_opts), []]
+      end
+
+      def header_variable(auth_opts, variable_name)
+        env["HTTP_#{auth_opts[variable_name]}".tr("-", "_").upcase]
+      end
+    end
+  end
+
+  register_plugin(:token_auth, TokenAuth)
+end

data/lib/roda/plugins/token_auth/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Roda
+  module RodaPlugins
+    module TokenAuth
+      VERSION = "0.1.1".freeze
+    end
+  end
+end

data/roda-token-auth.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "roda/plugins/token_auth/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "roda-token-auth"
+  spec.version       = Roda::RodaPlugins::TokenAuth::VERSION
+  spec.authors       = ["Ronaldo Raivil"]
+  spec.email         = ["raivil@gmail.com"]
+
+  spec.summary       = %(Plugin that adds token authentication methods to Roda)
+  spec.description   = %(Plugin that adds token authentication methods to Roda)
+  spec.homepage      = "https://github.com/raivil/roda-token-auth"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "roda", ">= 2.0", "< 4.0"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack-test", "0.7.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: roda-token-auth
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ronaldo Raivil
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Plugin that adds token authentication methods to Roda
+email:
+- raivil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/roda/plugins/token_auth.rb
+- lib/roda/plugins/token_auth/version.rb
+- roda-token-auth.gemspec
+homepage: https://github.com/raivil/roda-token-auth
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Plugin that adds token authentication methods to Roda
+test_files: []