jwt_easy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e7c1abc2e2e5159abc61e45102226fe2b252f9b
+  data.tar.gz: 7c393cced4e3786d6b5834855716827d69890671
+SHA512:
+  metadata.gz: 9159765198fcb834e2a316b54f1eed749118cf90d1dfe89f9dc7884b9267e12705e0d9090f997b551d14d6d9dcdae2a9ef1374c21d9ae835d5c8f7416f7792e6
+  data.tar.gz: 26dfb051ded825aa7d6df8bf4bb4758c60cceff754f7b5fe7588e1fb520688d9a2330181187bafda0b8be5eb582cf79e9ee24aff5149eee34249e55bd959f006

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/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jwt_easy.gemspec
+gemspec
+
+ruby '2.4.0'

data/README.md

@@ -0,0 +1,56 @@
+# JWTEasy
+
+JWTEasy is a simple wrapper for the [JWT](https://github.com/jwt/ruby-jwt) gem (version 1.x) that hopes to make generating and consuming various types of JSON web tokens a little easier.
+
+> **Note:** Currently only supports plain, EXP and NBF tokens with HMAC HS256 encryption.
+
+## Usage
+
+Generating a plain token without encryption might look something like:
+
+```ruby
+token = JWTEasy.encode(id: 'some-identifying-information')
+```
+
+You'd likely want to configure things before though:
+
+```ruby
+# config/initializers/jwt_easy.rb
+JWTEasy.configure do |config|
+ config.expiration_time  = 3_600
+ config.secret           = ENV['JWT_EASY_SECRET']
+ config.algorithm        = JWTEasy::ALGORITHM_HMAC_HS256
+end
+````
+
+Of course you're able to consume tokens just as easily:
+
+```ruby
+JWTEasy.decode(token).id #=> 'some-identifying-information'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jwt_easy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jwt_easy
+
+## 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/lshepstone/jwt_easy.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'jwt_easy'
+
+# 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/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

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/jwt_easy.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jwt_easy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jwt_easy'
+  spec.version       = JWTEasy::VERSION
+  spec.authors       = ['Lawrance Shepstone']
+  spec.email         = ['lawrance.shepstone@gmail.com']
+
+  spec.summary       = 'jwt_easy'
+  spec.description   = 'Library for generating and consuming JSON web tokens easily.'
+  spec.homepage      = 'https://github.com/lshepstone/jwt_easy'
+  spec.license       = 'MIT'
+
+  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 'jwt', '~> 1.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0'
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'timecop', '~> 0'
+end

data/lib/jwt_easy/configuration.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module JWTEasy
+  # A configuration object used to define various options for encoding and decoding tokens.
+  #
+  # * This is usually not instantiated directly, but rather by way of calling
+  #   +JWTEasy.configure+.
+  class Configuration
+    attr_writer :algorithm
+
+    attr_accessor :secret,
+                  :expiration_time,
+                  :not_before_time
+
+    # Gets the algorithm to use when encoding tokens
+    #
+    # * If no secret has been set, this returns 'none'
+    #
+    # @return [String] the algorithm to be used
+    def algorithm
+      secret ? (@algorithm || ALGORITHM_HMAC_HS256) : 'none'
+    end
+
+    # Infers the claim to observe during encoding or decoding.
+    #
+    # @return [Symbol] short name for the identified claim
+    def claim
+      if expiration_time
+        CLAIM_EXPIRATION_TIME
+      elsif not_before_time
+        CLAIM_NOT_BEFORE_TIME
+      end
+    end
+  end
+end

data/lib/jwt_easy/constants.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module JWTEasy
+  # Short-names for various supported claim types.
+  #
+  CLAIM_EXPIRATION_TIME = :exp
+  CLAIM_NOT_BEFORE_TIME = :nbf
+
+  # Algorithm identifiers for supported algorithms.
+  #
+  ALGORITHM_HMAC_HS256  = 'HS256'
+end

data/lib/jwt_easy/core_ext/hash.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Hash
+  def except(*keys)
+    dup.except!(*keys)
+  end
+
+  def except!(*keys)
+    keys.each { |key| delete(key) }
+    self
+  end
+end

data/lib/jwt_easy/decoder.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module JWTEasy
+  # Decoder object for decoding tokens.
+  #
+  # * This is usually not instantiated directly, but rather by way of
+  #   calling +JWTEasy.decode+.
+  class Decoder
+    attr_reader :token,
+                :configuration
+
+    # Initializes a new encoder instance.
+    #
+    # * If no configuration object is passed or is +nil+, the value of
+    #   +JWTEasy.configuration+ is used as the configuration object
+    #
+    # @param [String] token the token to be decoded
+    # @param [Configuration] configuration the configuration object
+    def initialize(token, configuration = nil)
+      @token          = token
+      @configuration  = configuration || JWTEasy.configuration
+      @headers        = {}
+    end
+
+    # Decodes the token with the configured options.
+    #
+    # @return [Result] the result of the decoding
+    def decode
+      Result.new(*JWT.decode(token, configuration.secret, verification?, headers))
+    end
+
+    # Determines if verification will be used during decoding.
+    #
+    # @return [Boolean] if verification will be used or not
+    def verification?
+      configuration.secret.nil? == false
+    end
+
+    # Determines the headers to be used during decoding.
+    #
+    # @return [Hash] the headers to be used
+    def headers
+      @headers.tap do |headers|
+        headers[:algorithm] = configuration.algorithm if verification?
+
+        case configuration.claim
+        when CLAIM_EXPIRATION_TIME
+          headers[:validate_exp] = true
+        when CLAIM_NOT_BEFORE_TIME
+          headers[:validate_nbf] = true
+        end
+      end
+    end
+  end
+end

data/lib/jwt_easy/encoder.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module JWTEasy
+  # Encoder object for generating new tokens.
+  #
+  # * This is usually not instantiated directly, but rather by way of
+  #   calling +JWTEasy.encode+.
+  class Encoder
+    attr_reader :data,
+                :configuration
+
+    # Initializes a new encoder instance.
+    #
+    # * If no configuration object is passed or is +nil+, the value of
+    #   +JWTEasy.configuration+ is used as the configuration object
+    #
+    # @param [Object] data the data to be encoded
+    # @param [Configuration] configuration the configuration object
+    def initialize(data, configuration = nil)
+      @data           = data
+      @configuration  = configuration || JWTEasy.configuration
+    end
+
+    # Encodes the data with the configured options.
+    #
+    # @return [String] the encoded token
+    def encode
+      JWT.encode(payload, configuration.secret, configuration.algorithm)
+    end
+
+    # Determines the structure of the payload to be encoded.
+    #
+    # @return [Object] the payload to be encoded
+    def payload
+      case configuration.claim
+      when CLAIM_EXPIRATION_TIME
+        { data: data, exp: expiration_time }
+      when CLAIM_NOT_BEFORE_TIME
+        { data: data, nbf: not_before_time }
+      else
+        data
+      end
+    end
+
+    # Calculates the expiration time if configured.
+    #
+    # @return [Integer] the expiration time
+    def expiration_time
+      Time.now.to_i + configuration.expiration_time
+    end
+
+    # Calculates the not before time if configured.
+    #
+    # @return [Integer] the not before time
+    def not_before_time
+      Time.now.to_i - configuration.not_before_time
+    end
+  end
+end

data/lib/jwt_easy/result.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module JWTEasy
+  # Result object that represents a decoded token.
+  #
+  # * This is usually not instantiated directly, but rather by way of
+  #   calling +JWTEasy.encode+.
+  class Result
+    CLAIM_KEYS = [
+      CLAIM_EXPIRATION_TIME,
+      CLAIM_NOT_BEFORE_TIME
+    ].freeze
+
+    attr_reader :payload,
+                :headers
+
+    # Initializes a new result instance.
+    #
+    # @param [Object] payload from decoding a token
+    # @param [Hash] headers from decoding a token
+    def initialize(payload = nil, headers = nil)
+      @payload = payload
+      @headers = headers
+    end
+
+    # Determines the encoded data from the payload structure.
+    #
+    # * If the payload is a hash that contains a claim key alongside other data
+    #    attributes, only a hash with the data attributes will be returned.
+    #
+    # * If the payload is hash that contains data in a data attribute alongside
+    #   any claim keys, the value of the data attribute is returned.
+    #
+    # * If the payload is anything but a hash, the payload is returned.
+    #
+    # @return [Object] the data encoded with the payload
+    def data
+      @data ||= if payload.is_a?(Hash)
+                  if claim && payload.key?('data')
+                    payload['data']
+                  else
+                    payload.except(*CLAIM_KEYS.map(&:to_s))
+                  end
+                else
+                  payload
+                end
+    end
+
+    # Infers the claim that was observed during decoding.
+    #
+    # @return [Symbol] short name for the identified claim
+    def claim
+      @claim ||= CLAIM_KEYS.find { |claim| payload&.key?(claim.to_s) }
+    end
+
+    def method_missing(method, *arguments, &block)
+      data.is_a?(Hash) && data.key?(method.to_s) ? data[method.to_s] : super
+    end
+
+    def respond_to_missing?(method, _include_private = false)
+      data.is_a?(Hash) && data.key?(method.to_s) || super
+    end
+  end
+end

data/lib/jwt_easy/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JWTEasy
+  VERSION = '0.1.0'
+end

data/lib/jwt_easy.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'jwt'
+require 'jwt_easy/core_ext/hash'
+require 'jwt_easy/constants'
+require 'jwt_easy/encoder'
+require 'jwt_easy/configuration'
+require 'jwt_easy/result'
+require 'jwt_easy/decoder'
+require 'jwt_easy/version'
+
+# JWTEasy is a simple wrapper for the JWT gem that hopes to make generating and consuming various
+# types of JSON web tokens a little easier.
+#
+# == Usage
+#
+# Generating a plain token without encryption might look something like:
+#
+#    token = JWTEasy.encode(id: 'some-identifying-information')
+#
+# You'd likely want to configure things before though:
+#
+#    # config/initializers/jwt_easy.rb
+#    JWTEasy.configure do |config|
+#      config.not_before_time  = 3_600
+#      config.secret           = ENV['JWT_EASY_SECRET']
+#      config.algorithm        = JWTEasy::ALGORITHM_HMAC_HS256
+#    end
+#
+# Of course you're able to consume tokens just as easily:
+#
+#    JWTEasy.decode(token).id #=> 'some-identifying-information'
+#
+# @see JWTEasy.encode
+# @see JWTEasy.decode
+# @see JWTEasy.configure
+module JWTEasy
+  module_function
+
+  # Gets the configuration object.
+  #
+  # If none was set, a new configuration object is instantiated and returned.
+  #
+  # @return [Configuration] the configuration object
+  #
+  # @see Configuration
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Allows for configuring the library using a block.
+  #
+  # @example Configuration using a block
+  #   JWTEasy.configure do |config|
+  #     # ...
+  #   end
+  #
+  # @see Configuration
+  def configure
+    yield(configuration) if block_given?
+  end
+
+  # Instantiates a new encoder and encodes the provided data and the global configuration object.
+  #
+  # @example Generate a token from some data
+  #   JWTEasy.encode(id: 'some-identifying-information')
+  #
+  # @param [Object] data the data to be encoded in the token
+  #
+  # @return [String] JSON web token
+  #
+  # @see Encoder
+  def encode(data)
+    Encoder.new(data, configuration).encode
+  end
+
+  # Instantiates a new decoder with the provided data and the global configuration object.
+  #
+  # @example Decode a token
+  #   JWTEasy.decode(token)
+  #
+  # @param [String] token the token to be decoded
+  #
+  # @return [Result] Result of the decode
+  #
+  # @see Encoder
+  def decode(token)
+    Decoder.new(token, configuration).decode
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: jwt_easy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lawrance Shepstone
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: 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: 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: timecop
+  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: Library for generating and consuming JSON web tokens easily.
+email:
+- lawrance.shepstone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- jwt_easy.gemspec
+- lib/jwt_easy.rb
+- lib/jwt_easy/configuration.rb
+- lib/jwt_easy/constants.rb
+- lib/jwt_easy/core_ext/hash.rb
+- lib/jwt_easy/decoder.rb
+- lib/jwt_easy/encoder.rb
+- lib/jwt_easy/result.rb
+- lib/jwt_easy/version.rb
+homepage: https://github.com/lshepstone/jwt_easy
+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.6.8
+signing_key: 
+specification_version: 4
+summary: jwt_easy
+test_files: []