martinet 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1de4f471176c1c86eece0c53584cd75b1ba56da9
-  data.tar.gz: 80bd2e824db0fb16eb38756e1ab7d4a861004a21
+  metadata.gz: 117c44e299449f6464a1ebceb6aeb081fb6565d6
+  data.tar.gz: 550da0e0724e738801bccbc3e97a72bdf4dac8c2
 SHA512:
-  metadata.gz: 63ad172d0fbfbc13c83dc1c9793fcb56f301787d30089971f7f7198cf5af35bb5a1dcf9ca597e50d2e4502dca51bb41f01cec69b8ac2d316bb50a7f78d7af14e
-  data.tar.gz: fc8a7dce2c1298b2999dbead463fc25138bd7641e311e5b6ba11c7868f2fe87bc53f38b733d779df02d785dbfb09c7647b21bc63638e68f6db27909b302846de
+  metadata.gz: 6d57017541c8ac0415ce874e2a5c3d73e06b8aa20b68efb69a0b99fad0e074158a52c10987c33253fa74dffb72641fa7a0bdf120bece38d42f407ab7a0051610
+  data.tar.gz: f4eae9e19800dec40300e141a86dfe1d4e6630fc6b959d71982e2e5e27f1fc3d6e53afdcd075670097453ecf906807942e5e04e95dfc2eb364e20c2988871f03

data/.milestonerrc

@@ -0,0 +1,12 @@
+:git_commit_prefixes:
+  - Add
+  - Added
+  - Update
+  - Updated
+  - Fix
+  - Fixed
+  - Remove
+  - Removed
+  - Refactor
+  - Refactored
+:git_tag_sign: true

data/.travis.yml

@@ -11,6 +11,8 @@ before_install:
   - gem update bundler
   - gem cleanup bundler
 
+bundler_args: --without tools --jobs=3 --retry=3
+
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0 (2016-04-26)
+
+- Initial version.

data/CODE_OF_CONDUCT.md

@@ -1,49 +1,61 @@
-# 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
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-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.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at tangrufus@gmail.com. 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.
-
-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]
+* 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 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.
+
+## 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
+[tangrufus@gmail.com](mailto:tangrufus@gmail.com). All complaints will be reviewed and
+investigated and will result in a response that 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.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/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Overview
+
+Thanks for taking an interest in this open source project. Your support and involvement is greatly appreciated. The
+following details what you need to know in order to contribute.
+
+# Requirements
+
+- Follow these [Basic Programming Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/basic.md).
+- Follow these [Code Review Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/code_reviews.md).
+- Follow these [Git Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/git.md).
+- Follow these [Bash Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/bash.md).
+- Follow these [CSS Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/css.md).
+- Follow these [Ruby Styles](https://github.com/bkuhlmann/style_guides/blob/master/programming/languages/ruby/ruby.md).
+
+# Contributing Code
+
+0. Read the project README thoroughly before starting.
+0. Fork the master branch of the repository.
+0. Ensure there are no setup, usage, and/or test issues (again, follow the README).
+0. Add tests for new functionality (refactoring and documentation changes can be excluded).
+0. Ensure all tests pass.
+0. Push your feature branch and submit a pull request.
+
+# Submitting Issues
+
+0. Submit an issue via the GitHub Issues tab (assuming one does not already exist).
+0. Clearly describe the issue (including steps to reproduce).
+0. Specify your enviroment setup (OS, browser, language, etc. with version info).
+0. Provide a stack dump (if possible).
+0. Explain any additional details that might help diagnose the problem quickly.
+
+# Feedback
+
+Expect a response within one to three business days.
+Changes, alternatives, and/or improvements might be suggested upon review.

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in martinet.gemspec
 gemspec
+
+group :tools do
+  gem 'gemsmith', '~> 7.6'
+end

data/README.md

@@ -1,4 +1,4 @@
-# Martinet
+# martinet
 
 [![Gem Version](https://badge.fury.io/rb/martinet.svg)](https://badge.fury.io/rb/martinet)
 [![Gem](https://img.shields.io/gem/dt/martinet.svg?maxAge=2592000)](https://rubygems.org/gems/martinet)
@@ -9,54 +9,80 @@
 [![GitHub issues](https://img.shields.io/github/issues/TangRufus/martinet.svg)](https://github.com/TangRufus/martinet/issues)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/TangRufus/martinet/master/LICENSE.txt)
 
+<!-- Tocer[start]: Auto-generated, don't remove. -->
 
+# Table of Contents
 
+- [Features](#features)
+- [Screencasts](#screencasts)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Usage](#usage)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
 
-TODO: Add impersonate functions
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
 
-TODO: Add tests
+# Features
 
-TODO: Publish 0.3.0
+# Screencasts
 
-TODO: Write usage instructions
+# Requirements
 
-TODO: Add roadmap
+0. [MRI 2.3.0](https://www.ruby-lang.org)
 
-TODO: Add testing instructions
+# Setup
 
-TODO: Add Contributing instructions
+For a secure install, type the following (recommended):
 
-TODO: Add sites using martinet section
+    gem cert --add <(curl --location --silent /gem-public.pem)
+    gem install martinet --trust-policy MediumSecurity
 
-TODO: Add example apps
+NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
+allowing the installation of unsigned dependencies since they are beyond the scope of this gem.
 
-## Installation
+For an insecure install, type the following (not recommended):
 
-Add this line to your application's Gemfile:
+    gem install martinet
 
-```ruby
-gem 'martinet'
-```
+Add the following to your Gemfile:
 
-And then execute:
+    gem "martinet"
 
-    $ bundle
+# Usage
 
-Or install it yourself as:
 
-    $ gem install martinet
+# Versioning
 
-## Usage
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 
-TODO: Write usage instructions here
+- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
 
-## Development
+# Code of Conduct
 
-## Contributing
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project
+you agree to abide by its terms.
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/tangrufus/martinet](https://github.com/tangrufus/martinet). 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.
+# Contributions
 
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 
-## License
+# License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Copyright (c) 2016 []().
+Read the [LICENSE](LICENSE.md) for details.
+
+# History
+
+Read the [CHANGELOG](CHANGELOG.md) for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Tang Rufus](https://www.github.com/tangrufus) at []().

data/Rakefile

@@ -1,3 +1,8 @@
+if defined? Gemsmith
+  require 'gemsmith/rake/setup'
+  Dir.glob('lib/tasks/*.rake').each { |file| load file }
+end
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

data/bin/setup

@@ -0,0 +1,8 @@
+#! /bin/bash
+
+set -o nounset # Exit, with error message, when attempting to use an undefined variable.
+set -o errexit # Abort script at first error, when a command exits with non-zero status.
+set -o pipefail # Return exit status of the last command in the pipe that returned a non-zero return value.
+IFS=$'\n\t' # Defines newlines and tabs as delimiters for splitting words and iterating arrays.
+
+bundle install

data/lib/martinet/configuration.rb

@@ -19,7 +19,7 @@ module Martinet
     attr_accessor :enable_impersonation
 
     def initialize
-      @enable_impersonation = false
+      @enable_impersonation = true
     end
   end
 end

data/lib/martinet/impersonation.rb

@@ -17,3 +17,9 @@ module Martinet
     end
   end
 end
+
+if Martinet.configuration.enable_impersonation
+  Martinet::Session.class_eval do
+    include Martinet::Impersonation
+  end
+end

data/lib/martinet/session.rb

@@ -2,11 +2,6 @@ module Martinet
   # HTTP/Warden session-specific behavior.
   class Session
     def initialize(warden)
-      # TODO: Move this to Martinet::Impersonation class
-      if Martinet.configuration.enable_impersonation
-        class << self; include Impersonation; end
-      end
-
       @warden = warden
     end
 

data/lib/martinet/version.rb

@@ -1,3 +1,3 @@
 module Martinet
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/lib/martinet.rb

@@ -1,7 +1,8 @@
 require 'martinet/version'
 require 'martinet/configuration'
 require 'martinet/session'
-require 'martinet/impersonation'
+
+require 'martinet/impersonation' if Martinet.configuration.enable_impersonation
 
 module Martinet
 end

data/martinet.gemspec

@@ -4,15 +4,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'martinet/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'martinet'
-  spec.version       = Martinet::VERSION
-  spec.authors       = ['Tang Rufus']
-  spec.email         = ['tangrufus@gmail.com']
-
-  spec.summary       = 'Authorization component for warden'
-  spec.description   = 'Authorization component for warden'
-  spec.homepage      = 'https://github.com/TangRufus/martinet'
-  spec.license       = 'MIT'
+  spec.name = 'martinet'
+  spec.version = Martinet::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ['Tang Rufus']
+  spec.email = ['tangrufus@gmail.com']
+  spec.homepage = 'https://github.com/TangRufus/martinet'
+  spec.summary = 'Authorization component for warden'
+  spec.description = 'Authorization component for warden'
+  spec.license = 'MIT'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: martinet
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Tang Rufus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-23 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: warden
@@ -114,13 +114,17 @@ files:
 - ".codeclimate.yml"
 - ".gitignore"
 - ".hound.yml"
+- ".milestonerrc"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
+- bin/setup
 - lib/martinet.rb
 - lib/martinet/configuration.rb
 - lib/martinet/impersonation.rb