challah-jwt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d0e70a00bf7f163dcc79d200a28b5848f1bbb78
+  data.tar.gz: ef354f85f0201bd2b5159f772fe6beb3d3022549
+SHA512:
+  metadata.gz: 822500c6516ae7b2f909a423daaab1471afeb27adbf7e5c8d5ccc609c0987478a5e47987394e5696009f6bf50db8e3fd1d43f99f2fca14f1de7e839facd02472
+  data.tar.gz: 9911d5cb1aa541dae8ee9bd4daaa381efabcc5274b08987efcc37386498b7be465d9b60d31446cb5033ba9cc2253e4bf8834eae3c53b451036453467aee83145

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/README.md

@@ -0,0 +1,66 @@
+# Challah JWT
+
+Authenticate your Challah users with JSON Web Tokens (JWT).
+
+## Installation
+
+1. Add this line to your application's Gemfile and then `bundle install`:
+
+```ruby
+gem 'challah-jwt'
+```
+
+2. In your Challah initializer, add the following line:
+
+```ruby
+Challah.register_technique :jwt, Challah::Jwt::Technique
+```
+
+3. Include the tokenizer concern in your user model:
+
+```ruby
+class User < ApplicationRecord
+  include Challah::Userable
+  include Challah::Jwt::Tokenizer
+end
+```
+
+## Usage
+
+You'll need to include the JWT in your sign in response, e.g.:
+
+```JSON
+{
+  "user": {
+    "jwt": "adi8e98uie.saxbbbgudinocgeigc84y9834.8ui9odeion",
+    "id": "1",
+    "first_name": "Slick",
+    "last_name": "McSpeedy",
+  }
+}
+```
+
+Send the JWT in the `Authorization` header like this:
+
+```http
+GET /
+Authorization: Bearer adi8e98uie.saxbbbgudinocgeigc84y9834.8ui9odeion
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/philtr/challah-jwt>.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "challah/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,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/challah-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 'challah/jwt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "challah-jwt"
+  spec.version       = Challah::Jwt::VERSION
+  spec.authors       = ["Phillip Ridlen"]
+  spec.email         = ["p@rdln.net"]
+
+  spec.summary       = %q{Use JSON Web Tokens (JWT) to authenticate with Challah}
+  spec.homepage      = "https://github.com/philtr/challah-jwt.git"
+
+  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 "challah", "~> 1.4"
+  spec.add_dependency "jwt", "~> 1.5"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/challah-jwt.rb

@@ -0,0 +1 @@
+require "challah/jwt"

data/lib/challah/jwt.rb

@@ -0,0 +1,14 @@
+require "challah"
+require "jwt"
+
+require "challah/jwt/technique"
+require "challah/jwt/tokenizer"
+require "challah/jwt/version"
+
+module Challah
+  module Jwt
+    def self.secret_key
+      Rails.application.secrets.secret_key_base
+    end
+  end
+end

data/lib/challah/jwt/technique.rb

@@ -0,0 +1,31 @@
+module Challah
+  module Jwt
+    class Technique
+      TOKEN_REGEX = /^Bearer\s+(?<token>.*?)$/i
+
+      def initialize(session)
+        if auth_header = session.request.headers["Authorization"]
+          @token = auth_header.match(TOKEN_REGEX) { |match| match["token"] }
+        end
+      end
+
+      def authenticate
+        user_model.find_by_jwt(@token)
+      end
+
+      private
+
+      def persist?
+        false
+      end
+
+      def user_model
+        @user_model ||= Challah.user
+      end
+
+      def token_provided?(session)
+        session.request.headers["Authorization"] =~ TOKEN_REGEX
+      end
+    end
+  end
+end

data/lib/challah/jwt/tokenizer.rb

@@ -0,0 +1,41 @@
+require "jwt"
+
+module Challah
+  module Jwt
+    module Tokenizer
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def find_by_jwt(token)
+          payload = ::JWT.decode(token, Challah::Jwt.secret_key)
+          model_id = payload.dig(0, jwt_root, "id")
+          find(model_id)
+        rescue JWT::DecodeError
+          nil
+        end
+
+        def jwt_root
+          model_name.singular
+        end
+      end
+
+      def to_jwt
+        ::JWT.encode(jwt_payload, Challah::Jwt.secret_key)
+      end
+
+      def jwt_attrs
+        serializable_hash.slice("id")
+      end
+
+      def jwt_payload
+        {
+          jwt_root => jwt_attrs
+        }
+      end
+
+      def jwt_root
+        self.class.jwt_root
+      end
+    end
+  end
+end

data/lib/challah/jwt/version.rb

@@ -0,0 +1,5 @@
+module Challah
+  module Jwt
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: challah-jwt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Phillip Ridlen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: challah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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'
+description: 
+email:
+- p@rdln.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- challah-jwt.gemspec
+- lib/challah-jwt.rb
+- lib/challah/jwt.rb
+- lib/challah/jwt/technique.rb
+- lib/challah/jwt/tokenizer.rb
+- lib/challah/jwt/version.rb
+homepage: https://github.com/philtr/challah-jwt.git
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Use JSON Web Tokens (JWT) to authenticate with Challah
+test_files: []