cow_auth 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ef0a48dce112adc6dfba038831d871c13a577f6
-  data.tar.gz: 607ad6d1172eaba966ef85410cb706a5afc6b2e7
+  metadata.gz: c9b457d5e613359cad57b0ef426979f534089cc8
+  data.tar.gz: b11a6ac0f2852dbcf3b5215df6147c9133618d75
 SHA512:
-  metadata.gz: 0f2e1bb17673d7c0cd102e00132054d59c73fa8e8381d67b1646f0a3ac9911c71be4baa35f9c82ef78c2a49f3293795360fac91698917ad6c1faf16da370ff8f
-  data.tar.gz: c8886526b41df9a13cf605eb2d53fae28288505a50393f209bc97eb020cdfffbcec76d12da7cfc5b64adf578effdd89e476ca652091f7f5a970b38eecb10562b
+  metadata.gz: 780843129e5e37b30fc2ece5185392bd431ad5d9e48aaa761823922de61e5d15b16dd649accc845e2430d633c54272a8f8e746e56789c7a84c6c570243dc1b4f
+  data.tar.gz: 0c70f12f43f00e3d5dd1d1828f2212f8033f0ca98ac72a5c6b95c6249b2bab4ff488de87092353090bfe89fc4523d92118cc8fec9cf6533646cf4da42372e645

data/README.md

@@ -1,6 +1,6 @@
 # CowAuth
 
-The main goal of this gem is to provide API authentication for Rails (or Rails-like) web applications.
+The main goal of this gem is to provide session and / or API authentication for Rails (or Rails-like) web applications.
 
 ## Installation
 
@@ -20,12 +20,14 @@ Or install it yourself as:
 
 ## Model
 
-Example Rails model generator command:
+### Generator (Example)
 
-    $ bundle exec rails generate model user email:string sid:string encrypted_password:string first_name:string last_name:string sign_in_count:integer
+    $ bundle exec rails generate model user uuid:string:uniq email:string:uniq sid:string:uniq encrypted_password:string first_name:string last_name:string sign_in_count:integer is_approved:boolean is_deleted:boolean
+
+### Migration (Example)
 
     # Modified migration; includes indexes and other stuff you might not want.
-    class CreateUsers < ActiveRecord::Migration[5.0]
+    class CreateUsers < ActiveRecord::Migration[5.1]
       def change
         create_table :users do |t|
           t.string :uuid, null: false
@@ -45,6 +47,12 @@ Example Rails model generator command:
       end
     end
 
+### Model Inheritance
+
+    class User < CowAuth::User
+    end
+
+
 ### Create User
 
     User.create! email: 'email', password: 'password'
@@ -112,13 +120,19 @@ Add the following lines in the controller(s) that you want to enforce authentica
 
 ## Token Authentication
 
+### Authenticate (Example)
+
+    curl -X POST -i --data-urlencode email=user@domain.tld --data-urlencode password=password https://api.domain.tld/v1/sessions
+
+    curl -X DELETE -i https://api.domain.tld/v1/sessions -H "Authorization: Token token=b5503c9b85b881f8b3ddbd82f511912cb5503c9b85b881f8b3ddbd82f511912c,sid=C3281846f3976809796f91cf6bbb35c53"
+
 ### Authenticated Request
 
 Note that token and sid are both required.
 
 Example GET:
 
-    curl -X GET http://api.local.dev:3000/v1/test -i -H "Authorization: Token token=b5503c9b85b881f8b3ddbd82f511912c,sid=C3281846f3976809796f91cf6bbb35c53"
+    curl -X GET -i https://api.domain.tld/v1/test -H "Authorization: Token token=b5503c9b85b881f8b3ddbd82f511912cb5503c9b85b881f8b3ddbd82f511912c,sid=C3281846f3976809796f91cf6bbb35c53"
 
 ### Controllers
 
@@ -139,8 +153,7 @@ Add the following lines in the controller(s) that you want to enforce authentica
     private
 
       def user_not_authenticated(exception)
-        @message = exception.message
-        render 'errors/unauthorized', status: :unauthorized
+        render json: { error: exception.message }, status: :unauthorized
       end
     end
 
@@ -159,7 +172,13 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 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).
 
     bundle exec gem build cow_auth.gemspec
-    bundle exec gem install cow_auth-0.2.0.gem
+    bundle exec gem install cow_auth-0.1.0.gem
+
+### Notes
+
+    cow_auth> bundle exec gem build cow_auth.gemspec
+
+    app> bundle
 
 ## Contributing
 

data/cow_auth.gemspec

@@ -4,25 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cow_auth/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'cow_auth'
-  spec.version       = CowAuth::VERSION
-  spec.authors       = ['Mickey Cowden']
-  spec.email         = ['mickey@vt.edu']
+  spec.name = 'cow_auth'
+  spec.version = CowAuth::VERSION
+  spec.authors = ['Mickey Cowden']
+  spec.email = ['mickey@vt.edu']
 
-  spec.summary       = 'Summary'
-  spec.description   = 'Description'
-  spec.homepage      = 'https://github.com/mickey13/cow_auth'
-  spec.license       = 'MIT'
+  spec.summary = 'Authentication gem'
+  spec.description = 'The main goal of this gem is to provide session and / or API authentication for Rails (or Rails-like) web applications.'
+  spec.homepage = 'https://github.com/mickey13/cow_auth'
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  # spec.add_runtime_dependency 'activesupport', '5.0.0.beta3'
-  spec.add_runtime_dependency 'scrypt', '~> 2.1'
-  # spec.add_runtime_dependency 'redis', '~> 3.2'
+  spec.required_ruby_version = '~> 2.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_runtime_dependency 'active_model_serializers', '~> 0.10'
+  spec.add_runtime_dependency 'scrypt', '~> 3.0'
 end

data/lib/cow_auth/{not_authenticated_error.rb → exceptions.rb}

@@ -1,4 +1,7 @@
 module CowAuth
   class NotAuthenticatedError < StandardError
   end
+
+  class RedisHandleMissingError < StandardError
+  end
 end

data/lib/cow_auth/session_auth/authenticate_request.rb

@@ -1,4 +1,4 @@
-require 'cow_auth/not_authenticated_error'
+require 'cow_auth/exceptions'
 
 module CowAuth
   module SessionAuth

data/lib/cow_auth/session_auth/session_endpoints.rb

@@ -1,4 +1,4 @@
-require 'cow_auth/not_authenticated_error'
+require 'cow_auth/exceptions'
 
 module CowAuth
   module SessionAuth

data/lib/cow_auth/token_auth/authenticate_request.rb

@@ -1,4 +1,4 @@
-require 'cow_auth/not_authenticated_error'
+require 'cow_auth/exceptions'
 
 module CowAuth
   module TokenAuth

data/lib/cow_auth/token_auth/session_endpoints.rb

@@ -1,4 +1,5 @@
-require 'cow_auth/not_authenticated_error'
+require 'cow_auth/user_serializer'
+require 'cow_auth/exceptions'
 
 module CowAuth
   module TokenAuth
@@ -9,6 +10,7 @@ module CowAuth
         @user = User.find_by(email: params[:email])
         if @user.try(:authenticate, params[:password])
           @user.api_sign_in
+          render json: UserSerializer.new(@user), status: :ok
         else
           raise CowAuth::NotAuthenticatedError.new('Invalid user credentials.')
         end

data/lib/cow_auth/user.rb

@@ -2,7 +2,6 @@ require 'scrypt'
 
 module CowAuth
   class User < ActiveRecord::Base
-
     after_initialize :generate_sid_if_necessary
 
     validates :email, presence: true
@@ -29,6 +28,7 @@ module CowAuth
     end
 
     def api_sign_in
+      User.assert_redis_handle_present
       $redis.set(self.redis_key, {
         auth_token: User.generate_auth_token,
         expires_at: User.generate_token_expires_at
@@ -36,6 +36,7 @@ module CowAuth
     end
 
     def api_sign_out
+      User.assert_redis_handle_present
       $redis.del(self.redis_key)
     end
 
@@ -45,7 +46,11 @@ module CowAuth
 
     def self.authenticate_from_token(sid, auth_token)
       api_key = User.fetch_api_key_from_redis(sid)
-      if api_key.present? && api_key.key?(:auth_token) && api_key.key?(:expires_at) && api_key[:auth_token] == auth_token && api_key[:expires_at] > Time.zone.now
+      if api_key.present? &&
+          api_key.key?(:auth_token) &&
+          api_key.key?(:expires_at) &&
+          api_key[:auth_token] == auth_token &&
+          api_key[:expires_at] > Time.zone.now
         return User.find_by(sid: sid)
       end
       return nil
@@ -73,8 +78,13 @@ module CowAuth
     end
 
     def self.fetch_api_key_from_redis(sid)
+      User.assert_redis_handle_present
       api_key = $redis.get("user_#{sid}")
       return api_key.present? ? JSON.parse(api_key).try(:symbolize_keys) : nil
     end
+
+    def self.assert_redis_handle_present
+      raise CowAuth::RedisHandleMissingError.new('"$redis" handle not found.') unless $redis.present?
+    end
   end
 end

data/lib/cow_auth/user_serializer.rb

@@ -0,0 +1,7 @@
+require 'active_model_serializers'
+
+module CowAuth
+  class UserSerializer < ActiveModel::Serializer
+    attributes :email, :sid, :auth_token, :first_name, :last_name, :sign_in_count
+  end
+end

data/lib/cow_auth/version.rb

@@ -1,3 +1,3 @@
 module CowAuth
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/cow_auth.rb

@@ -1,6 +1,6 @@
 require 'cow_auth/version'
 require 'cow_auth/user'
-require 'cow_auth/not_authenticated_error'
+require 'cow_auth/exceptions'
 require 'cow_auth/session_auth/session_endpoints'
 require 'cow_auth/session_auth/authenticate_request'
 require 'cow_auth/token_auth/session_endpoints'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cow_auth
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mickey Cowden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-31 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,57 +16,72 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: scrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-description: Description
+        version: '3.0'
+description: The main goal of this gem is to provide session and / or API authentication
+  for Rails (or Rails-like) web applications.
 email:
 - mickey@vt.edu
 executables: []
@@ -84,12 +99,13 @@ files:
 - bin/setup
 - cow_auth.gemspec
 - lib/cow_auth.rb
-- lib/cow_auth/not_authenticated_error.rb
+- lib/cow_auth/exceptions.rb
 - lib/cow_auth/session_auth/authenticate_request.rb
 - lib/cow_auth/session_auth/session_endpoints.rb
 - lib/cow_auth/token_auth/authenticate_request.rb
 - lib/cow_auth/token_auth/session_endpoints.rb
 - lib/cow_auth/user.rb
+- lib/cow_auth/user_serializer.rb
 - lib/cow_auth/version.rb
 homepage: https://github.com/mickey13/cow_auth
 licenses:
@@ -101,9 +117,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -111,8 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Summary
+summary: Authentication gem
 test_files: []