doorkeeper-jwt 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b002cd43174cb7dee9362bc8a8c15bdaf090e341
-  data.tar.gz: eec5f2cffa66c2f83662388b810ff4fb0ec14de4
+  metadata.gz: 64ffd893f885b14b10051ffdf40d0c7cce87dbfa
+  data.tar.gz: 4c18d275274d40a52694984a4cb68a9fd14b6962
 SHA512:
-  metadata.gz: 86c9a2ad56ba7f28444ba570223555fd5e43e555091d8b2984c47b0e6b16c247c052e92458a1fa9ab5d4ad5bcd8344eb9b4a5e4dab4d54b02cde6141fa1835aa
-  data.tar.gz: 5824759b0bfb152e7daba0273139aa0d019060c15b17eb02205235ed441c3403d15527de919d18e8567bb23431dcbd49cbe0d7181e94ee19f33ce7f314792560
+  metadata.gz: 9860fc149da0ca854fc47872c78b86dfbca10e09cfddc59e24c74c4edf80d8688f86a4167d5ec72b1be75ce044f1f361ccbacd1d1a790891cd4f6a966f64af5f
+  data.tar.gz: 6a39bc5136d5ce4dbdf72b43a006403d10c70383445ae30bd61ae0eb16dd03aa0d66b4e116872cca8c0e6cff694cb832bd24e7a669fd973ccaa210a5444438bf

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+LineLength:
+  Exclude:
+    - spec/**/*
+
+StringLiterals:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.2.1
-addons:
-  code_climate:
-    repo_token: a44faab4cd18aeb4898a374736ac95bbb1de26015e9f53d5c809109e11df1149
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5

data/CHANGELOG.md

@@ -4,10 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.3.0] - 2018-10-01
+
+### Added
+
+- Bump JWT gem version. Via [#27](https://github.com/doorkeeper-gem/doorkeeper-jwt/pull/27) by [@pacop](https://github.com/pacop/)
+
 ## [0.2.1] - 2017-06-07
+
 ### Fixed
+
 - The `token_headers` proc now passes `opts` like the other config methods. Fixed via #19 by @travisofthenorth.
 
 ## [0.2.0] - 2017-05-25
+
 ### Added
+
 - Added support for ["kid" (Key ID) Header Parameter](https://tools.ietf.org/html/rfc7515#section-4.1.4) @travisofthenorth. Allows custom token headers.

data/Gemfile

@@ -4,4 +4,3 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
-gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,10 +1,11 @@
-[![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)
+[![Coverage Status](https://coveralls.io/repos/github/doorkeeper-gem/doorkeeper-jwt/badge.svg?branch=master)](https://coveralls.io/github/doorkeeper-gem/doorkeeper-jwt?branch=master)
+[![Build Status](https://travis-ci.org/doorkeeper-gem/doorkeeper-jwt.svg?branch=master)](https://travis-ci.org/doorkeeper-gem/doorkeeper-jwt)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ca4d81b49acabda27e0c/maintainability)](https://codeclimate.com/github/doorkeeper-gem/doorkeeper-jwt/maintainability)
 
 # Doorkeeper::JWT
 
-Doorkeeper JWT adds JWT token support to the Doorkeeper OAuth library. Requires Doorkeeper 2.2.0 or newer.
+Doorkeeper JWT adds JWT token support to the Doorkeeper OAuth library. Confirmed to work with Doorkeeper 2.2.x - 4.x.
+Untested with later versions of Doorkeeper.
 
 ```ruby
 gem 'doorkeeper'
@@ -31,7 +32,7 @@ Or install it yourself as:
 In your `doorkeeper.rb` initializer add the follow to the `Doorkeeper.configure` block:
 
 ```ruby
-access_token_generator "Doorkeeper::JWT"
+access_token_generator '::Doorkeeper::JWT'
 ```
 
 Then add a `Doorkeeper::JWT.configure` block below the `Doorkeeper.configure` block to set your JWT preferences.
@@ -46,6 +47,10 @@ Doorkeeper::JWT.configure do
     user = User.find(opts[:resource_owner_id])
 
     {
+      iss: 'My App',
+      iat: Time.current.utc.to_i,
+      jti: SecureRandom.uuid, # @see JWT reserved claims - https://tools.ietf.org/html/draft-jones-json-web-token-07#page-7 
+
       user: {
         id: user.id,
         email: user.email
@@ -68,14 +73,14 @@ Doorkeeper::JWT.configure do
   # 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"
+  secret_key ENV['JWT_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"
+  secret_key_path File.join('path', 'to', 'file.pem')
 
-  # Specify encryption type. Supports any algorithim in
+  # Specify encryption type. Supports any algorithm in
   # https://github.com/progrium/ruby-jwt
   # defaults to nil
   encryption_method :hs512
@@ -84,9 +89,12 @@ 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.
+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).
+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
 

data/Rakefile

@@ -3,5 +3,5 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec

data/doorkeeper-jwt.gemspec

@@ -1,16 +1,15 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $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.version       = Doorkeeper::JWT.gem_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.summary       = 'JWT token generator for Doorkeeper'
+  spec.description   = 'JWT token generator extension for Doorkeeper'
   spec.homepage      = "https://github.com/chriswarren/doorkeeper-jwt"
   spec.license       = "MIT"
 
@@ -19,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jwt", "~> 1.5.2", ">= 1.5.2"
+  spec.add_dependency "jwt", "~> 2.1.0", ">= 2.1.0"
 
   spec.add_development_dependency "bundler", "~> 1.8", ">= 1.8"
+  spec.add_development_dependency "pry", "~> 0"
   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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "doorkeeper-jwt/version"
 require "doorkeeper-jwt/config"
 require 'jwt'
@@ -41,7 +43,7 @@ module Doorkeeper
       end
 
       def encryption_method
-        return nil unless Doorkeeper::JWT.configuration.encryption_method
+        return "none" unless Doorkeeper::JWT.configuration.encryption_method
         Doorkeeper::JWT.configuration.encryption_method.to_s.upcase
       end
 
@@ -51,13 +53,13 @@ module Doorkeeper
 
       def application_secret(opts)
         if opts[:application].nil?
-          fail "JWT `use_application_secret` is enabled but application is " \
+          raise "JWT `use_application_secret` is enabled but application is " \
             "nil. This can happen if `client_id` was absent in the request " \
             "params."
         end
 
         if opts[:application][:secret].nil?
-          fail "JWT `use_application_secret` is enabled but the application " \
+          raise "JWT `use_application_secret` is enabled but the application " \
             "secret is nil."
         end
 

data/lib/doorkeeper-jwt/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module JWT
     class MissingConfiguration < StandardError
@@ -11,7 +13,7 @@ module Doorkeeper
     end
 
     def self.configuration
-      @config || (fail MissingConfiguration.new)
+      @config || (raise MissingConfiguration)
     end
 
     class Config
@@ -27,7 +29,7 @@ module Doorkeeper
 
         def use_application_secret(use_application_secret)
           @config.instance_variable_set(
-            "@use_application_secret",
+            '@use_application_secret',
             use_application_secret
           )
         end
@@ -42,7 +44,8 @@ module Doorkeeper
 
         def encryption_method(encryption_method)
           @config.instance_variable_set(
-            '@encryption_method', encryption_method)
+            '@encryption_method', encryption_method
+          )
         end
       end
 
@@ -81,17 +84,17 @@ module Doorkeeper
           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
+              value = if attribute_builder
                         attribute_builder.new(&block).build
+                      else
+                        block || args.first
                       end
 
               @config.instance_variable_set(:"@#{attribute}", value)
             end
           end
 
-          define_method attribute do |*args|
+          define_method attribute do |*|
             if instance_variable_defined?(:"@#{attribute}")
               instance_variable_get(:"@#{attribute}")
             else
@@ -110,7 +113,7 @@ module Doorkeeper
       extend Option
 
       option :token_payload,
-        default: proc{ { token: SecureRandom.method(:hex) } }
+             default: proc { { token: SecureRandom.method(:hex) } }
       option :token_headers, default: proc { {} }
       option :use_application_secret, default: false
       option :secret_key, default: nil

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

@@ -1 +1,3 @@
-require "doorkeeper-jwt/version"
+# frozen_string_literal: true
+
+require 'doorkeeper-jwt/version'

data/lib/doorkeeper-jwt/version.rb

@@ -1,5 +1,20 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module JWT
-    VERSION = "0.2.1".freeze
+    def self.gem_version
+      Gem::Version.new VERSION::STRING
+    end
+
+    module VERSION
+      # Semantic versioning
+      MAJOR = 0
+      MINOR = 3
+      TINY = 0
+      PRE = nil
+
+      # Full version number
+      STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doorkeeper-jwt
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Warren
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 2.1.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 2.1.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -50,6 +50,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
+- !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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -90,20 +104,6 @@ dependencies:
     - - ">="
       - !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
@@ -113,6 +113,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: JWT token generator for Doorkeeper