faye-jwt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eda6eecbf69145a79ddbda3b2bba3e6fbe9b17b1
+  data.tar.gz: 01d311e1e24107be66936f5c6dc70e6797b6af50
+SHA512:
+  metadata.gz: 2e4bf8ec37a5e140830e8e6743f921dceeb3e248c3be9805cf30a83d6cbe5b54fb63a02b203abcbc408e41c51adc2fe5c770d6f546aad14adbbd99ef9232f62d
+  data.tar.gz: cf4a43146d25b86c97b6fbfbe3b05390c758e9c8d05e939dad7b0a908dd0665943d082426b47a034b55db3e0de2469f443112635194bd33d64d2100650850154

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6
+branches:
+  only:
+    - master
+env:
+  - COVERALLS=1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0 / 2016-03-21
+
+Create project

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chen, Yi-Cyuan
+
+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,87 @@
+# faye-jwt
+
+[![Build Status](https://api.travis-ci.org/emn178/faye-jwt.png)](https://travis-ci.org/emn178/faye-jwt)
+[![Coverage Status](https://coveralls.io/repos/emn178/faye-jwt/badge.svg?branch=master)](https://coveralls.io/r/emn178/faye-jwt?branch=master)
+
+A gem that provides authentication by JWT(json web token) with faye.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faye-jwt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faye-jwt
+
+## Usage
+faye-jwt will authenicate all requests by access token. If the access token can not be decoded, it will fail to authenicate.
+
+### Server
+
+For faye-rails, set up faye server in you initializers config, eg. `initializers/faye.rb`
+```Ruby
+Rails.application.config.middleware.use FayeRails::Middleware do
+  add_extension(FayeJwt::Server.new('YOUR SECRET'))
+  # others...
+end
+```
+
+You can use jwt to generate access token and export it.
+```Ruby
+access_token = JWT.encode({:maybe => :userinfo}, 'YOUR SECRET')
+```
+
+#### Payload and Header
+You can implement your custom server extension. You will get the decoded payload and header if you add your extension after faye-jwt.
+
+```Ruby
+class MyServer
+  def incoming(message, callback)
+    message['jwt']['payload'] # {"maybe" => "userinfo"}
+    message['jwt']['header'] # eg. {"typ"=>"JWT", "alg"=>"HS256"}
+    callback.call(message)
+  end
+end
+```
+And modify config
+```Ruby
+Rails.application.config.middleware.use FayeRails::Middleware do
+  add_extension(FayeJwt::Server.new('YOUR SECRET'))
+  add_extension(MyServer.new)
+  # others...
+end
+```
+
+### JavaScript Client
+Require javascripts
+```JavaScript
+//= require faye
+//= require faye-jwt
+```
+Add extension
+```JavaScript
+var client = new Faye.Client('/faye'); // Your faye path
+client.addExtension(new FayeJWT.Client(access_token));
+```
+
+### Ruby Client
+```Ruby
+client = Faye::Client.new('http://localhost:3000/faye')
+client.add_extension(FayeJwt::Client.new(access_token))
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contact
+The project's website is located at https://github.com/emn178/faye-jwt  
+Author: Chen, Yi-Cyuan (emn178@gmail.com)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/faye-jwt.js

@@ -0,0 +1,29 @@
+(function($) {
+  function Client(accessToken) {
+    this.accessToken = accessToken;
+  }
+
+  Client.prototype.outgoing = function(message, callback) {
+    message.Authorization = 'Bearer ' + this.accessToken;
+    callback(message);
+  };
+
+  Client.prototype.incoming = function(message, callback) {
+    if (message.error != 'Authentication failed.') {
+      callback(message);
+    }
+  };
+
+  Client.publish = function (url, channel, data, accessToken, callback) {
+    message = {channel: channel, data: data, Authorization: 'Bearer ' + accessToken};
+    return $.ajax({
+      url: url,
+      method: 'POST',
+      success: callback
+    });
+  };
+  
+  window.FayeJwt = {
+    Client: Client
+  };
+})(jQuery);

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "faye/auth"
+
+# 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/faye-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 'faye-jwt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faye-jwt"
+  spec.version       = FayeJwt::VERSION
+  spec.authors       = ["Chen, Yi-Cyuan"]
+  spec.email         = ["emn178@gmail.com"]
+
+  spec.summary       = %q{A gem that provides authentication by JWT(json web token) with faye.}
+  spec.description   = %q{A gem that provides authentication by JWT(json web token) with faye.}
+  spec.homepage      = "https://github.com/emn178/faye-jwt"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jwt"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/lib/faye-jwt.rb

@@ -0,0 +1,7 @@
+require "faye-jwt/version"
+require "faye-jwt/server"
+require "faye-jwt/client"
+require "faye-jwt/engine"
+
+module FayeJwt
+end

data/lib/faye-jwt/client.rb

@@ -0,0 +1,27 @@
+require 'json'
+require 'net/http'
+
+module FayeJwt
+  class Client
+    attr_accessor :access_token
+
+    def initialize(access_token)
+      self.access_token = access_token
+    end
+
+    def outgoing(message, callback)
+      message['Authorization'] = "Bearer #{access_token}"
+      callback.call(message)
+    end
+
+    def incoming(message, callback)
+      callback.call(message) if message['error'] != 'Authentication failed.'
+    end
+
+    def self.publish(url, channel, data, access_token)
+      message = {'channel' => channel, 'data' => data, 'Authorization' => "Bearer #{access_token}"}
+      uri = URI.parse(url)
+      Net::HTTP.post_form(uri, message: [message].to_json).body
+    end
+  end
+end

data/lib/faye-jwt/engine.rb

@@ -0,0 +1,9 @@
+if defined?(::Rails::Engine)
+  module FayeJwt
+    class Engine < ::Rails::Engine
+      initializer "faye-jwt" do
+        Rails.application.config.assets.precompile += %w( faye-jwt.js )
+      end
+    end
+  end
+end

data/lib/faye-jwt/server.rb

@@ -0,0 +1,36 @@
+require 'jwt'
+
+module FayeJwt
+  class Server
+    attr_accessor :secret
+
+    def initialize(secret)
+      self.secret = secret
+    end
+
+    def incoming(message, callback)
+      message['error'] = 'Authentication failed.' unless authenticate(message)
+      callback.call(message)
+    end
+
+    def outgoing(message, callback)
+      message.delete('Authorization')
+      message.delete('jwt')
+      callback.call(message)
+    end
+
+    def authenticate(message)
+      payload, header = decode(message['Authorization'])
+      return false if payload.nil?
+      message['jwt'] = { 'payload' => payload, 'header' => header }
+      true
+    end
+
+    def decode(authorization)
+      return nil if authorization.nil?
+      type, access_token = authorization.split(' ')
+      return nil if type.to_s.downcase != 'bearer' || access_token.nil?
+      JWT.decode(access_token, secret, true) rescue nil
+    end
+  end
+end

data/lib/faye-jwt/version.rb

@@ -0,0 +1,3 @@
+module FayeJwt
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: faye-jwt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chen, Yi-Cyuan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: simplecov
+  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: coveralls
+  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: A gem that provides authentication by JWT(json web token) with faye.
+email:
+- emn178@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/faye-jwt.js
+- bin/console
+- bin/setup
+- faye-jwt.gemspec
+- lib/faye-jwt.rb
+- lib/faye-jwt/client.rb
+- lib/faye-jwt/engine.rb
+- lib/faye-jwt/server.rb
+- lib/faye-jwt/version.rb
+homepage: https://github.com/emn178/faye-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.8
+signing_key: 
+specification_version: 4
+summary: A gem that provides authentication by JWT(json web token) with faye.
+test_files: []