rails_jwt_admin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa0138f72063844bfe41d165ae7e9f767f05ac7ba449101e83f2b833d524026e
+  data.tar.gz: 9c9300c0eac1f2d816ca28dbae9bb77e6d6557a26716b924040c343a8e000832
+SHA512:
+  metadata.gz: bdd8f063c72799549be709f767c2b5b8adfa4669fa8ed59a660209238097e0e0fa417ccef57fbffaea41772baf3a9de2e52305a8927e50eed54af20cb99e00e2
+  data.tar.gz: c051482415d9200d3ac53d3942e4fcd468bc8fe8c5632b0b5391d8d9c393561783926476a9322da5505fa490427f71613bff8d511549f21fe6923e82d2a5c3ba

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 afeiship
+
+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,19 @@
+# rails_jwt_admin
+> Jwt for rails admin.
+
+## installation
+```shell
+# gem
+gem install 'rails_jwt_admin'
+
+# rails - bundle install
+gem 'rails_jwt_admin'
+```
+
+## resources
+- https://edgeapi.rubyonrails.org/classes/Rails/Engine.html
+- https://guides.rubyonrails.org/engines.html
+- https://www.jianshu.com/p/56467f890516
+- https://www.pluralsight.com/guides/token-based-authentication-with-ruby-on-rails-5-api
+- https://github.com/jwt/ruby-jwt
+- https://github.com/afeiship/rails-module-jwt

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'RailsJwtAdmin'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/rails_jwt_admin/application_controller.rb

@@ -0,0 +1,34 @@
+module RailsJwtAdmin
+  class ApplicationController < ActionController::API
+    attr_accessor :current_user
+
+    protected
+
+    def authenticate!
+      render_failed and return unless token?
+      @current_user = User.find_by(id: auth_token[:user_id])
+    rescue JWT::VerificationError, JWT::DecodeError
+      render_failed
+    end
+
+    private
+
+    def render_failed(messages = ["Authenticate failed."])
+      render json: { errors: messages }, status: :unauthorized
+    end
+
+    def http_token
+      @http_token ||= if request.headers["Authorization"].present?
+          request.headers["Authorization"].split(" ").last
+        end
+    end
+
+    def auth_token
+      @auth_token ||= Token.decode(http_token)
+    end
+
+    def token?
+      http_token && auth_token && auth_token[:user_id].to_i
+    end
+  end
+end

data/app/controllers/rails_jwt_admin/authentication_controller.rb

@@ -0,0 +1,13 @@
+require_dependency "rails_jwt_admin/application_controller"
+
+module RailsJwtAdmin
+  class AuthenticationController < ApplicationController
+    def create
+      if user = User.find_by(username: params[:username]).try(:authenticate, params[:password])
+        render json: user.token
+      else
+        render json: { errors: ["Username or password error."] }, status: :unauthorized
+      end
+    end
+  end
+end

data/app/controllers/rails_jwt_admin/users_controller.rb

@@ -0,0 +1,11 @@
+require_dependency "rails_jwt_admin/application_controller"
+
+module RailsJwtAdmin
+  class UsersController < ApplicationController
+    before_action :authenticate!
+
+    def profile
+      render json: current_user.to_json
+    end
+  end
+end

data/app/models/rails_jwt_admin/application_record.rb

@@ -0,0 +1,5 @@
+module RailsJwtAdmin
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/rails_jwt_admin/user.rb

@@ -0,0 +1,13 @@
+module RailsJwtAdmin
+  class User < ApplicationRecord
+    has_secure_password
+
+    def token
+      { token: Token.encode(user_id: self.id) }
+    end
+
+    def to_json
+      self.slice(:username, :email)
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+RailsJwtAdmin::Engine.routes.draw do
+  get "profile", to: "users#profile"
+  resources :authentication, only: :create
+end

data/db/migrate/20201202013006_create_rails_jwt_admin_users.rb

@@ -0,0 +1,11 @@
+class CreateRailsJwtAdminUsers < ActiveRecord::Migration[6.0]
+  def change
+    create_table :rails_jwt_admin_users do |t|
+      t.string :username
+      t.string :email
+      t.string :password_digest
+
+      t.timestamps
+    end
+  end
+end

data/lib/rails_jwt_admin.rb

@@ -0,0 +1,5 @@
+require "rails_jwt_admin/engine"
+
+module RailsJwtAdmin
+  # Your code goes here...
+end

data/lib/rails_jwt_admin/engine.rb

@@ -0,0 +1,7 @@
+module RailsJwtAdmin
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsJwtAdmin
+    config.generators.api_only = true
+    config.autoload_paths += Dir["#{config.root}/lib/vendors"]
+  end
+end

data/lib/rails_jwt_admin/version.rb

@@ -0,0 +1,3 @@
+module RailsJwtAdmin
+  VERSION = '0.1.0'
+end

data/lib/tasks/rails_jwt_admin_tasks.rake

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

data/lib/vendors/token.rb

@@ -0,0 +1,15 @@
+require "rails_jwt_admin/engine"
+
+module RailsJwtAdmin
+  class Token
+    def self.encode(payload)
+      JWT.encode(payload, Rails.application.secrets.secret_key_base)
+    end
+
+    def self.decode(token)
+      HashWithIndifferentAccess.new(JWT.decode(token, Rails.application.secrets.secret_key_base)[0])
+    rescue
+      nil
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rails_jwt_admin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- afeiship
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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:
+email:
+- 1290657123@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/rails_jwt_admin/application_controller.rb
+- app/controllers/rails_jwt_admin/authentication_controller.rb
+- app/controllers/rails_jwt_admin/users_controller.rb
+- app/models/rails_jwt_admin/application_record.rb
+- app/models/rails_jwt_admin/user.rb
+- config/routes.rb
+- db/migrate/20201202013006_create_rails_jwt_admin_users.rb
+- lib/rails_jwt_admin.rb
+- lib/rails_jwt_admin/engine.rb
+- lib/rails_jwt_admin/version.rb
+- lib/tasks/rails_jwt_admin_tasks.rake
+- lib/vendors/token.rb
+homepage: https://github.com/afeiship/rails_jwt_admin
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Summary of RailsJwtAdmin.
+test_files: []