knock 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2b69b2a637f56044a87345cbdafa5eae5fba6c3
+  data.tar.gz: b789b624c9b03bdc48530582581714bafbc30e2e
+SHA512:
+  metadata.gz: f5e3d930a7e30df2d0e1d46c016d077ee0e6c49aaf95db647026e7af5c7cd6715ed434a90255e146f3330816b3633bf4f6db574d592d03fe429a9886cb8ba002
+  data.tar.gz: 943ec6efac0753cab4520e548d692e8cfe07ed0729bc7eab36faa1e21b4cf078585f90f5211ae37e7c655793cd370eebf2875c9d4d4a837183f1f40860f4af1e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Arnaud MESUREUR
+
+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/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Knock'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/knock/application_controller.rb

@@ -0,0 +1,11 @@
+module Knock
+  class ApplicationController < ActionController::Base
+    rescue_from ActiveRecord::RecordNotFound, with: :not_found
+
+  private
+
+    def not_found
+      head :not_found
+    end
+  end
+end

data/app/controllers/knock/auth_token_controller.rb

@@ -0,0 +1,28 @@
+require_dependency "knock/application_controller"
+
+module Knock
+  class AuthTokenController < ApplicationController
+    before_action :authenticate!
+
+    def create
+      render json: { jwt: auth_token.token }, status: :created
+    end
+
+  private
+    def authenticate!
+      raise ActiveRecord::RecordNotFound unless user.authenticate(auth_params[:password])
+    end
+
+    def auth_token
+      AuthToken.new payload: { user_id: user.id }
+    end
+
+    def user
+      User.find_by! email: auth_params[:email]
+    end
+
+    def auth_params
+      params.require(:auth).permit :email, :password
+    end
+  end
+end

data/app/model/knock/auth_token.rb

@@ -0,0 +1,31 @@
+require 'jwt'
+
+module Knock
+  cattr_accessor :token_lifetime
+
+  def self.token_lifetime
+    @token_lifetime || 1.day
+  end
+
+  class AuthToken
+    attr_reader :token
+
+    def initialize payload: {}, token: nil
+      if token.nil?
+        @token = JWT.encode ({ exp: expiration_time }).merge(payload), Rails.application.secrets.secret_key_base, 'HS256'
+      else
+        @token = token
+      end
+    end
+
+    def validate!
+      JWT.decode @token, Rails.application.secrets.secret_key_base
+    end
+
+  private
+
+    def expiration_time
+      Knock.token_lifetime.from_now.to_i
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Knock::Engine.routes.draw do
+  post 'auth_token' => 'auth_token#create'
+end

data/lib/knock.rb

@@ -0,0 +1,4 @@
+require "knock/engine"
+
+module Knock
+end

data/lib/knock/authenticable.rb

@@ -0,0 +1,13 @@
+module Knock::Authenticable
+  attr_reader :current_user
+
+  def authenticate
+    begin
+      token = request.headers['Authorization'].split(' ').last
+      payload, header = Knock::AuthToken.new(token: token).validate!
+      @current_user = User.find(payload['user_id'])
+    rescue
+      head :unauthorized
+    end
+  end
+end

data/lib/knock/engine.rb

@@ -0,0 +1,6 @@
+module Knock
+  class Engine < ::Rails::Engine
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+    isolate_namespace Knock
+  end
+end

data/lib/knock/version.rb

@@ -0,0 +1,3 @@
+module Knock
+  VERSION = "1.0.0.rc1"
+end

data/lib/tasks/knock_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :simsim do
+#   # Task goes here
+# end

data/test/controllers/knock/auth_token_controller_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+module Knock
+  class AuthTokenControllerTest < ActionController::TestCase
+    setup do
+      @routes = Engine.routes
+    end
+
+    def user
+      @user ||= users(:one)
+    end
+
+    test "responds with 404 if user does not exist" do
+      post :create, auth: { email: 'wrong@example.net', password: '' }
+      assert_response :not_found
+    end
+
+    test "responds with 404 if password is invalid" do
+      post :create, auth: { email: user.email, password: 'wrong' }
+      assert_response :not_found
+    end
+
+    test "responds with 201" do
+      post :create, auth: { email: user.email, password: 'secret' }
+      assert_response :created
+    end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :null_session
+
+  include Knock::Authenticable
+end

data/test/dummy/app/controllers/protected_resources_controller.rb

@@ -0,0 +1,7 @@
+class ProtectedResourcesController < ApplicationController
+  before_action :authenticate
+
+  def index
+    head :ok
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_secure_password
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "knock"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3