sorcery-jwt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d27895837d9ceaa14e2ff6ff3c1e1d777f11efdea02a73fa375ec843d34a14a0
+  data.tar.gz: 6cdf0bd7276e50ee4110ee8d337449811b37ff5d1740e952074df88b055253d7
+SHA512:
+  metadata.gz: cf2f8a5f31ee92c84ddae6d511363b3fd8cd19eda0ce307ae9a3c864f899cf1e1640a3d50c5a38a0d6e6cb29a8e9af9f5c9b240e20d5b0e4baee1c72d2638e2e
+  data.tar.gz: b6f54c44bb8702cb4232632fedb90d1deb1d7ded569320c2f0c4e03af61498dd9d0c906c991a2316f381c8df457f78e87237694fdb405c9ca0e5abacd17e9853

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hluckenb@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/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 sorcery-jwt.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    sorcery-jwt (0.1.0)
+      jwt (~> 1.0)
+      sorcery (~> 0.12.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bcrypt (3.1.12)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
+    jwt (1.5.6)
+    method_source (0.8.2)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth (0.5.4)
+    oauth2 (1.4.1)
+      faraday (>= 0.8, < 0.16.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (2.0.5)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    slop (3.6.0)
+    sorcery (0.12.0)
+      bcrypt (~> 3.1)
+      oauth (~> 0.4, >= 0.4.4)
+      oauth2 (~> 1.0, >= 0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry (~> 0.10.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sorcery-jwt!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Hayden Luckenbach
+
+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,79 @@
+# Sorcery::Jwt
+
+Jwt extension for the Sorcery authentication library
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sorcery-jwt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sorcery-jwt
+
+## Usage
+
+First, include the `:jwt` submodule in your list of configured Sorcery submodules:
+
+```
+Rails.application.config.sorcery.submodules = [:jwt, ...]
+```
+
+Next, in the Sorcery `user_config`, set the secret and algorithm that will be used to sign your tokens:
+
+```
+Rails.application.config.sorcery.configure do |config|
+  # ...
+  config.user_config do |user|
+    # ...
+    user.jwt_secret = Rails.application.secrets.secret_key_base
+    user.jwt_algorithm = "HS256" # HS256 is used by default.
+  end
+end
+```
+
+Available algorithms are listed at https://github.com/jwt/ruby-jwt.
+
+You're now ready to start using the library. By including the submodule, each request will check for an authorization header with a JWT as the value. If the JWT is valid, it will set the `current_user` in the controller to the matching user. It is up to you to handle what happens when a token is invalid or JWTs need to be revoked. Some ideas here: http://waiting-for-dev.github.io/blog/2017/01/24/jwt_revocation_strategies/.
+
+To login a user and issue a token, use the `login_and_issue_token` method from a controller. This method takes the same `email` and `password` arguments that the Sorcery `authenticate` method does.
+
+Example:
+
+```
+def login
+  token = login_and_issue_token(params[:email], params[:password])
+
+  render json: {
+    user: serialize(current_user),
+    token: token
+  }
+end
+```
+
+By using `login_and_issue_token` with valid credentials, you're also setting `current_user` in your controller.
+
+## 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/hayfever/sorcery-jwt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sorcery::Jwt project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hayfever/sorcery-jwt/blob/master/CODE_OF_CONDUCT.md).

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 "sorcery/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(__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/sorcery/controller/submodules/jwt.rb

@@ -0,0 +1,49 @@
+module Sorcery
+  module Controller
+    module Submodules
+      module Jwt
+        def self.included(base)
+          base.send(:include, InstanceMethods)
+          Config.login_sources << :login_from_jwt
+        end
+
+        module InstanceMethods
+          protected
+
+          def login_from_jwt
+            user = decoded_token.first
+
+            @current_user = user_class.find_by(user)
+            auto_login(@current_user) if @current_user
+            @current_user
+          rescue JWT::DecodeError
+            @current_user = false
+          end
+
+          def login_and_issue_token(*credentials)
+            return unless (user = user_class.authenticate(*credentials))
+
+            @current_user = user
+            auto_login(@current_user)
+            user_class.issue_token(id: @current_user.id, email: @current_user.email)
+          end
+
+          private
+
+          def token
+            return nil unless authorization_header
+            authorization_header.split(" ").last
+          end
+
+          def authorization_header
+            @authorization_header ||= request.headers["Authorization"]
+          end
+
+          def decoded_token
+            user_class.decode_token(token)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sorcery/jwt/version.rb

@@ -0,0 +1,5 @@
+module Sorcery
+  module Jwt
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/sorcery/jwt.rb

@@ -0,0 +1,15 @@
+require "sorcery/jwt/version"
+
+module Sorcery
+  module Controller
+    module Submodules
+      require "sorcery/controller/submodules/jwt"
+    end
+  end
+
+  module Model
+    module Submodules
+      require "sorcery/model/submodules/jwt"
+    end
+  end
+end

data/lib/sorcery/model/submodules/jwt.rb

@@ -0,0 +1,51 @@
+require "sorcery/jwt/version"
+require "jwt"
+
+module Sorcery
+  module Model
+    module Submodules
+      module Jwt
+        def self.included(base)
+          base.sorcery_config.class_eval do
+            # Secret used to encode JWTs. Should correspond to the type needed by the algorithm used.
+            attr_accessor :jwt_secret
+            # Type of the algorithm used to encode JWTs. Corresponds to the options available in jwt/ruby-jwt.
+            attr_accessor :jwt_algorithm
+          end
+
+          base.sorcery_config.instance_eval do
+            @defaults[:@jwt_algorithm] = "HS256"
+
+            reset!
+          end
+
+          base.sorcery_config.after_config << :validate_secret_defined
+
+          base.extend(ClassMethods)
+          base.send(:include, InstanceMethods)
+        end
+
+        module ClassMethods
+          def issue_token(payload)
+            JWT.encode(payload, @sorcery_config.jwt_secret, @sorcery_config.jwt_algorithm)
+          end
+
+          def decode_token(token)
+            JWT.decode(token, @sorcery_config.jwt_secret, true, algorithm: @sorcery_config.jwt_algorithm)
+          end
+
+          def token_valid?(token)
+            decode_token(token).present?
+          end
+
+          protected
+
+          def validate_secret_defined
+            message = "A secret must be configured when using the Sorcery::Jwt extension."
+            raise ArgumentError, message if @sorcery_config.jwt_secret.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/sorcery-jwt.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sorcery/jwt/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sorcery-jwt"
+  spec.version       = Sorcery::Jwt::VERSION
+  spec.authors       = ["Hayden Luckenbach"]
+  spec.email         = ["hluckenb@gmail.com"]
+
+  spec.summary       = "Jwt extension for the Sorcery authentication library"
+  spec.description   = ""
+  spec.homepage      = "https://github.com/hayfever/sorcery-jwt"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been
+  # added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry", "~> 0.10.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "jwt", "~> 1.0"
+  spec.add_runtime_dependency "sorcery", "~> 0.12.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: sorcery-jwt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hayden Luckenbach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !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: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sorcery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: ''
+email:
+- hluckenb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sorcery/controller/submodules/jwt.rb
+- lib/sorcery/jwt.rb
+- lib/sorcery/jwt/version.rb
+- lib/sorcery/model/submodules/jwt.rb
+- sorcery-jwt.gemspec
+homepage: https://github.com/hayfever/sorcery-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.7.6
+signing_key: 
+specification_version: 4
+summary: Jwt extension for the Sorcery authentication library
+test_files: []