api_warden 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0282ed518cd01a9417d7691212753f1fe7508cca
-  data.tar.gz: bf85675a76299613094ad4c9651e2ea82dc9524d
+  metadata.gz: 8b41e9b94e6932031e8b6dd5dee860e6f085ba13
+  data.tar.gz: 2ab96024d26761aab7e9dea22bff800dadf7b961
 SHA512:
-  metadata.gz: c9676158663b2b151b3ba98f631671bea10e91a64c9654a4b977e119fd7c8097ab847a741eaf30100ba4bc6fe03498c52e6a1d0ece499a2e1b61b31ba1219479
-  data.tar.gz: 4a01e7bcb7505a6abe4eb573d53ad01e197d55547aa11c5f5acc5a3615543e2b4ae04125363a17d58907fa16afbd5e9beed854be99e01701a5abb2258c258c92
+  metadata.gz: 3e72487c65e8ca5eb194125ce795e52761b327fcda8e92ac4b29036549d5a546b741d5a4008cedb16b90e2aa6e053b5dc4f762512d623ef582df2e85c7370301
+  data.tar.gz: 5a4263cba41c1983d48542899bc12a9fc29c94c0af3e580c713d28492baa443907f260770591dd6fecb4296cab7c46d4a346976c6c0d61b83357e7f65f4c1f73

data/README.md

@@ -1,30 +1,19 @@
 # ApiWarden
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/api_warden`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a gem that you can use to protect your API in rails. By default it uses access token to authenticate the requests, and uses refresh token to get new access token when access token expires.
 
-TODO: Delete this and the text above, and describe your gem
+## Examples
 
-## Installation
+https://github.com/UzxMx/api_warden_examples
 
-Add this line to your application's Gemfile:
+## Usage
 
-```ruby
+* Add the gem to your application's Gemfile. And execute `bundle install`
+```
 gem 'api_warden'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install api_warden
-
-## Usage
-
-Create a file config/initializers/api_warden.rb.
-
-Add the below codes:
+* Create a file config/initializers/api_warden.rb. And add the below codes.
 ```
 ApiWarden.configure do |config|
   config.redis = {
@@ -37,6 +26,71 @@ end
 ApiWarden.ward_by('users')
 ```
 
+* Create app/controllers/base_controller.rb. And add the below codes.
+```
+class BaseController < ActionController::Base
+  before_action :ward_by_user!
+end
+```
+
+* Create app/controllers/users_controller.rb. And add the below codes.
+```
+class UsersController < BaseController
+  skip_before_action :ward_by_user!, only: [:sign_in]
+
+  def sign_in
+    # If the request is allowed to sign in a user, then continue to execute, otherwise return directly.
+    access_token, refresh_token = generate_tokens_for_user(user_id)
+    render json: {
+      user_id: user_id,
+      access_token: access_token,
+      refresh_token: refresh_token
+    }
+  end
+end
+```
+
+* In client side, you need to add below http headers to access the server protected resources.
+```
+X-User-Id: <the user id rendered in sign in api>
+X-User-Access-Token: <the access token rendered in sign in api>
+```
+
+* If the access token expires, you need to use the refresh token to get a new pair of access and refresh token. Modify the users_controller.rb.
+```
+class UsersController < BaseController
+  skip_before_action :ward_by_user!, only: [:sign_in, :refresh_token]
+
+  def sign_in
+    # If the request is allowed to sign in a user, then continue to execute, otherwise return directly.
+    access_token, refresh_token = generate_tokens_for_user(user_id)
+    render json: {
+      user_id: user_id,
+      access_token: access_token,
+      refresh_token: refresh_token
+    }
+  end
+
+  def refresh_token
+    if validate_refresh_token_for_user!
+      user_id = current_user_authentication.id
+      access_token, refresh_token = generate_tokens_for_user(user_id)
+      render json: {
+        user_id: user_id,
+        access_token: access_token,
+        refresh_token: refresh_token
+      }      
+    end    
+  end
+end
+```
+
+* In client side, when requesting the refresh token api, you need to add below http headers.
+```
+X-User-Id: <the user id rendered in sign in api>
+X-User-Refresh-Token: <the refresh token rendered in sign in api>
+```
+
 ## 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.
@@ -45,7 +99,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api_warden. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/UzxMx/api_warden. 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
 
@@ -53,4 +107,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the ApiWarden project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/api_warden/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ApiWarden project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/UzxMx/api_warden/blob/master/CODE_OF_CONDUCT.md).

data/lib/api_warden/authentication.rb

@@ -5,7 +5,7 @@ module ApiWarden
     autoload :Params, 'api_warden/authentication/params'
     autoload :HeaderParams, 'api_warden/authentication/header_params'
 
-    attr_reader :scope, :request, :params
+    attr_reader :scope, :request, :params, :key_for_access_token
 
     def initialize(scope, request)
       @scope = scope
@@ -52,10 +52,10 @@ module ApiWarden
       return unless @authenticated.nil?
 
       id, access_token = @params.retrieve_id, @params.retrieve_access_token
-      key = @scope.key_for_access_token(id, access_token)
+      @key_for_access_token = @scope.key_for_access_token(id, access_token)
 
       if access_token && !access_token.empty?
-        ApiWarden.redis { |conn| @value_for_access_token = conn.get(key) }
+        ApiWarden.redis { |conn| @value_for_access_token = conn.get(@key_for_access_token) }
       end
 
       unless @value_for_access_token
@@ -104,6 +104,22 @@ module ApiWarden
       ApiWarden.redis { |conn| conn.del(key) }
     end
 
+    # @return [Fixnum] the time to live for access token in seconds
+    def ttl_for_access_token
+      raise_if_authentication_failed!
+
+      ttl_for_key(@key_for_access_token)
+    end
+
+    # Set the ttl for access token.
+    def ttl_for_access_token=(seconds)
+      raise_if_authentication_failed!
+
+      key = @key_for_access_token
+      value = @value_for_access_token
+      ApiWarden.redis { |conn| conn.set(key, value, ex: seconds) }
+    end
+
     private
       def ensure_authenticated
         return unless @authenticated.nil?
@@ -120,6 +136,15 @@ module ApiWarden
         ensure_refreshable unless @authenticated
       end
 
+      def raise_if_authentication_failed!
+        ensure_authenticated
+        raise 'The authentication is not valid.' if @authenticated == false
+      end
+
+      def ttl_for_key(key)
+        ApiWarden.redis { |conn| conn.ttl(key) }
+      end
+
     class AuthenticationError < Exception
     end
   end

data/lib/api_warden/helpers/accessable.rb

@@ -23,6 +23,9 @@ module ApiWarden
           end
           false
         else
+          if (block = scope.on_authenticate_success) && block.respond_to?(:call)
+            instance_exec(authentication, &block)
+          end
           true
         end
       end

data/lib/api_warden/scope.rb

@@ -33,6 +33,9 @@ module ApiWarden
     #  * on_authenticate_failed: [Proc]
     #      the block to be called when authentication failed. An authentication will be passed as an argument.
     #
+    #  * on_authenticate_success: [Proc]
+    #      the block to be called when authentication succeeds. An authentication will be passed as an argument.
+    #
     #  * expire_time_for_refresh_token: [Fixnum]
     #      the expire time for refresh token in seconds, default is EXPIRE_TIME_FOR_REFRESH_TOKEN.
     #

data/lib/api_warden/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApiWarden
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_warden
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mingxiang Xue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis