cow_auth 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0855a2ef21dbcf97962fa31e9ebd51bd7b121c518b44eff213f0c220681e23e3'
-  data.tar.gz: fd087dde4492f753d7a6615513642a1c998d52fac85c45d38205d43cd2e33721
+  metadata.gz: 5a2ee818192fd63ac1695e4d7ed5f41b10fe4039ad7b76b1e2cc409dc4fec11e
+  data.tar.gz: af99e43d6425225b8f4a3afae7033091335054e505c748ba167392110b8d556a
 SHA512:
-  metadata.gz: ac2539f24adb657aa18bd40c508bc1a4076348db89c36f4a31ea25c5dc8b504b130e9462336b5d362de70958f471e73d1503e5535a14b028cb7e8091b705e535
-  data.tar.gz: 87a6185f361579d1b73e046fea742f5bae8b428ca8112afc5523a14f87cded892c9ccdfdd4eb002c0580eb5fa1659010b794d1488ab72493176461d01b9d4ae6
+  metadata.gz: '0729a56a18c44e6d8210f5837f710df3c61027a4c1497252553d5c869aaf776dc368cb33dd5f3f0c0215680788f0e32bb9f9cf5767293762050d3e43f09b60eb'
+  data.tar.gz: 180fdbd0e2df6bcd2c245c3474bb83a28f4c72463c40d2c21ad4ba4e6a8deb1c1963503a3c3194326b8139347c3936613e7099e2a5e15431d08649f1d09d1096

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.travis.yml

@@ -1,4 +1,5 @@
+sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1.pre1

data/CODE_OF_CONDUCT.md

@@ -1,24 +1,41 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
@@ -26,24 +43,32 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
 
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at mickey@vt.edu. All
+reported by contacting the project team at mickey@vt.edu. All
 complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
 # Specify your gem's dependencies in cow_auth.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    cow_auth (0.5.1)
+      scrypt (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ffi (1.9.18)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    minitest (5.10.3)
+    rake (10.5.0)
+    scrypt (3.0.5)
+      ffi-compiler (>= 1.0, < 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  cow_auth!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1.pre1

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Mickey Cowden
+Copyright (c) 2017 Mickey Cowden
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -18,13 +18,17 @@ Or install it yourself as:
 
     $ gem install cow_auth
 
-## Model
+## Usage
 
-### Generator (Example)
+### Model
+
+Configure your user model to add the authentication mechanism.
+
+#### Generator (Example)
 
     $ bundle exec rails generate model user uuid:string:uniq email:string:uniq sid:string:uniq encrypted_password:string locale:string first_name:string last_name:string role:integer sign_in_count:integer is_approved:boolean is_deleted:boolean
 
-### Migration (Example)
+#### Migration (Example)
 
     # Modified migration; includes indexes and other stuff you might not want.
     class CreateUsers < ActiveRecord::Migration[5.2]
@@ -49,46 +53,34 @@ Or install it yourself as:
       end
     end
 
-### Model Concern
+#### Model Concern
 
     class User < ApplicationRecord
       include CowAuth::User
     end
 
-### Create User
-
-    User.create! email: 'email', password: 'password'
-
-## 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
+#### Create User
 
-Note that token and sid are both required.
+    User.create! email: 'user@domain.tld', password: 'password'
 
-Example GET:
+### Controllers
 
-    curl -X GET -i https://api.domain.tld/v1/test -H "Authorization: Token token=b5503c9b85b881f8b3ddbd82f511912cb5503c9b85b881f8b3ddbd82f511912c,sid=C3281846f3976809796f91cf6bbb35c53"
+Configure the appropriate controllers to require authentication.
 
-### Controllers
+#### Controller Concern
 
 Add the following lines in the controller(s) that you want to enforce authentication for.
 
     include CowAuth::TokenAuth::AuthenticateRequest
     before_action :authenticate_user
 
-Add the following private method to the ApplicationController (assuming User is the correct model).
+Add the following private method to the ApplicationController (assuming User is the model doing the authentication) to define the authentication class for the controller concern.
 
     def authentication_class
       return User
     end
 
-### Application Controller Example
+#### Application Controller Example
 
     class ApplicationController < ActionController::API
       include CowAuth::TokenAuth::AuthenticateRequest
@@ -108,7 +100,7 @@ Add the following private method to the ApplicationController (assuming User is
       end
     end
 
-### Sessions Controller Example
+#### Sessions Controller Example
 
     class Api::V1::SessionsController < ApplicationController
       include CowAuth::TokenAuth::SessionEndpoints
@@ -116,26 +108,42 @@ Add the following private method to the ApplicationController (assuming User is
       skip_before_action :authenticate_user, only: [:create]
     end
 
+### 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 -i https://api.domain.tld/v1/test -H "Authorization: Token token=b5503c9b85b881f8b3ddbd82f511912cb5503c9b85b881f8b3ddbd82f511912c,sid=C3281846f3976809796f91cf6bbb35c53"
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 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.1.0.gem
-
 ### Notes
 
     cow_auth> bundle exec gem build cow_auth.gemspec
-
+    cow_auth> bundle exec gem install cow_auth-0.1.0.gem
     app> bundle
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mickey13/cow_auth. 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
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CowAuth project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mickey13/cow-auth/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task default: :spec
+task default: :test

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "cow_auth"
+require 'bundler/setup'
+require 'cow_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"
+# require 'pry'
 # Pry.start
 
-require "irb"
-IRB.start
+require 'irb'
+IRB.start(__FILE__)

data/cow_auth.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cow_auth/version'
@@ -10,19 +10,21 @@ Gem::Specification.new do |spec|
   spec.email = ['mickey@vt.edu']
 
   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.description = 'The main goal of this gem is to provide token-based 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.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.3'
+  spec.required_ruby_version = '~> 2.4'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_runtime_dependency 'scrypt', '~> 3.0'
 end

data/lib/cow_auth/user.rb

@@ -42,10 +42,12 @@ module CowAuth
         auth_token: self.token_valid? ? self.auth_token : self.generate_auth_token,
         expires_at: self.generate_token_expires_at
       }.to_json)
+      return true
     end
 
     def api_sign_out
       self.redis_handle.del(self.redis_key)
+      return true
     end
 
     def auth_token

data/lib/cow_auth/version.rb

@@ -1,3 +1,3 @@
 module CowAuth
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cow_auth
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Mickey Cowden
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: scrypt
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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.
+description: The main goal of this gem is to provide token-based authentication for
+  Rails (or Rails-like) web applications.
 email:
 - mickey@vt.edu
 executables: []
@@ -78,6 +78,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -90,7 +91,7 @@ files:
 - lib/cow_auth/token_auth/session_endpoints.rb
 - lib/cow_auth/user.rb
 - lib/cow_auth/version.rb
-homepage: https://github.com/mickey13/cow_auth
+homepage: https://github.com/mickey13/cow-auth
 licenses:
 - MIT
 metadata: {}
@@ -102,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="