doorkeeper-jwt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1791769530ac6ad399efbb8a26146c17e2348ec9
+  data.tar.gz: 473b621043f01eddae55661dafce3b46b5c8e379
+SHA512:
+  metadata.gz: 7ee55933a1bc248459885ef1fece175aa70feda72ac7d29027ac580db8be4f882b1a114e63de7a724c3b42b91e0ee84db52362b5cd219da0a5afaaa1780f6cd2
+  data.tar.gz: e0517f1209e9ee6a9b8a5b4c73ed5daf3542369367d21fcd70e0ccaaaac86515909d48b02a3c5ec9f077d5f0f8f4956ee505e8e7c4a0933baaf4fae00cb169c4

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,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doorkeeper-jwt.gemspec
+gemspec
+
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christopher Warren
+
+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,81 @@
+[![Coverage Status](https://coveralls.io/repos/chriswarren/doorkeeper-jwt/badge.svg?branch=master)](https://coveralls.io/r/chriswarren/doorkeeper-jwt?branch=master)
+[![Build Status](https://travis-ci.org/chriswarren/doorkeeper-jwt.svg?branch=master)](https://travis-ci.org/chriswarren/doorkeeper-jwt)
+[![Code Climate](https://codeclimate.com/github/chriswarren/doorkeeper-jwt/badges/gpa.svg)](https://codeclimate.com/github/chriswarren/doorkeeper-jwt)
+
+# Doorkeeper::JWT
+
+Doorkeeper JWT adds JWT token support to the Doorkeeper OAuth library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doorkeeper-jwt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doorkeeper-jwt
+
+## Usage
+
+In your `doorkeeper.rb` initializer add the follow to the `Doorkeeper.configure` block:
+
+```ruby
+access_token_generator "Doorkeeper::JWT"
+```
+
+Then add a `Doorkeeper::JWT.configure` block below the `Doorkeeper.configure` block to set your JWT preferences.
+
+```ruby
+Doorkeeper::JWT.configure do
+  # Set the payload for the JWT token. This should contain unique information
+  # about the user.
+  # Defaults to a randomly generated token in a hash
+  # { token: "RANDOM-TOKEN" }
+  payload do
+    {
+      user: {
+        id: 123,
+        first_name: "Jane",
+        last_name: "Doe",
+        email: "jdoe@example.com"
+      }
+    }
+  end
+
+  # Set the encryption secret. This would be shared with any other applications
+  # that should be able to read the payload of the token.
+  # Defaults to "secret"
+  secret_key "MY-SECRET"
+
+  # If you want to use RS* encoding specify the path to the RSA key
+  # to use for signing.
+  # If you specify a secret_key_path it will be used instead of secret_key
+  secret_key_path "path/to/file.pem"
+
+  # Specify encryption type. Supports any algorithim in
+  # https://github.com/progrium/ruby-jwt
+  # defaults to nil
+  encryption_method :hs512
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/doorkeeper-jwt/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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "doorkeeper-jwt"
+
+# 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/doorkeeper-jwt.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doorkeeper-jwt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doorkeeper-jwt"
+  spec.version       = Doorkeeper::JWT::VERSION
+  spec.authors       = ["Chris Warren"]
+  spec.email         = ["chris@expectless.com"]
+
+  spec.summary       = %q{JWT token generator for Doorkeeper}
+  spec.description   = %q{JWT token generator extension for Doorkeeper}
+  spec.homepage      = "https://github.com/chriswarren/doorkeeper-jwt"
+  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 "jwt", "~> 1.4", ">= 1.4.1"
+
+  spec.add_development_dependency "bundler", "~> 1.8", ">= 1.8"
+  spec.add_development_dependency "rake", "~> 10.0", ">= 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0", ">= 3.2"
+  spec.add_development_dependency "pry", "~> 0"
+end

data/lib/doorkeeper-jwt.rb

@@ -0,0 +1,37 @@
+require "doorkeeper-jwt/version"
+require "doorkeeper-jwt/config"
+require 'jwt'
+
+module Doorkeeper
+  module JWT
+    def self.generate(resource_owner_id)
+      ::JWT.encode(
+        token_payload(resource_owner_id),
+        secret_key,
+        encryption_method
+      )
+    end
+
+  private
+
+    def self.token_payload(resource_owner_id)
+      Doorkeeper::JWT.configuration.token_payload.call resource_owner_id
+    end
+
+    def self.secret_key
+      secret_key_file || Doorkeeper::JWT.configuration.secret_key
+    end
+
+    def self.secret_key_file
+      return nil if Doorkeeper::JWT.configuration.secret_key_path.nil?
+      OpenSSL::PKey::RSA.new(
+        File.open(Doorkeeper::JWT.configuration.secret_key_path)
+      )
+    end
+
+    def self.encryption_method
+      return nil unless Doorkeeper::JWT.configuration.encryption_method
+      Doorkeeper::JWT.configuration.encryption_method.to_s.upcase
+    end
+  end
+end

data/lib/doorkeeper-jwt/config.rb

@@ -0,0 +1,124 @@
+module Doorkeeper
+  module JWT
+    class MissingConfiguration < StandardError
+      def initialize
+        super('Configuration for doorkeeper-jwt missing.')
+      end
+    end
+
+    def self.configure(&block)
+      @config = Config::Builder.new(&block).build
+    end
+
+    def self.configuration
+      @config || (fail MissingConfiguration.new)
+    end
+
+    class Config
+      class Builder
+        def initialize(&block)
+          @config = Config.new
+          instance_eval(&block)
+        end
+
+        def build
+          @config
+        end
+
+        def secret_key(secret_key)
+          @config.instance_variable_set('@secret_key', secret_key)
+        end
+
+        def secret_key_path(secret_key_path)
+          @config.instance_variable_set('@secret_key_path', secret_key_path)
+        end
+
+        def encryption_method(encryption_method)
+          @config.instance_variable_set(
+            '@encryption_method', encryption_method)
+        end
+      end
+
+      module Option
+        # Defines configuration option
+        #
+        # When you call option, it defines two methods. One method will take place
+        # in the +Config+ class and the other method will take place in the
+        # +Builder+ class.
+        #
+        # The +name+ parameter will set both builder method and config attribute.
+        # If the +:as+ option is defined, the builder method will be the specified
+        # option while the config attribute will be the +name+ parameter.
+        #
+        # If you want to introduce another level of config DSL you can
+        # define +builder_class+ parameter.
+        # Builder should take a block as the initializer parameter and respond to function +build+
+        # that returns the value of the config attribute.
+        #
+        # ==== Options
+        #
+        # * [:+as+] Set the builder method that goes inside +configure+ block
+        # * [+:default+] The default value in case no option was set
+        #
+        # ==== Examples
+        #
+        #    option :name
+        #    option :name, as: :set_name
+        #    option :name, default: 'My Name'
+        #    option :scopes builder_class: ScopesBuilder
+        #
+        def option(name, options = {})
+          attribute = options[:as] || name
+          attribute_builder = options[:builder_class]
+
+          Builder.instance_eval do
+            define_method name do |*args, &block|
+              # TODO: is builder_class option being used?
+              value = unless attribute_builder
+                        block ? block : args.first
+                      else
+                        attribute_builder.new(&block).build
+                      end
+
+              @config.instance_variable_set(:"@#{attribute}", value)
+            end
+          end
+
+          define_method attribute do |*args|
+            if instance_variable_defined?(:"@#{attribute}")
+              instance_variable_get(:"@#{attribute}")
+            else
+              options[:default]
+            end
+          end
+
+          public attribute
+        end
+
+        def extended(base)
+          base.send(:private, :option)
+        end
+      end
+
+      extend Option
+
+      option :token_payload,
+        default: proc{ { token: SecureRandom.method(:hex) } }
+      option :secret_key, default: nil
+      option :secret_key_path, default: nil
+      option :encryption_method, default: nil
+
+      def secret_key
+        @secret_key ||= nil
+      end
+
+      def secret_key_path
+        @secret_key_path ||= nil
+      end
+
+      def encryption_method
+        @encryption_method ||= nil
+      end
+    end
+  end
+end

data/lib/doorkeeper-jwt/doorkeeper-jwt.rb

@@ -0,0 +1 @@
+require "doorkeeper-jwt/version"

data/lib/doorkeeper-jwt/version.rb

@@ -0,0 +1,5 @@
+module Doorkeeper
+  module JWT
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: doorkeeper-jwt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Warren
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !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::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: JWT token generator extension for Doorkeeper
+email:
+- chris@expectless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doorkeeper-jwt.gemspec
+- lib/doorkeeper-jwt.rb
+- lib/doorkeeper-jwt/config.rb
+- lib/doorkeeper-jwt/doorkeeper-jwt.rb
+- lib/doorkeeper-jwt/version.rb
+homepage: https://github.com/chriswarren/doorkeeper-jwt
+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: JWT token generator for Doorkeeper
+test_files: []