sixarm_ruby_sign_out 1.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c39431191e3abecf200ff0d967ad399540f7375
+  data.tar.gz: 9e301d75b1cfd9e6822e8f743aa7f5dae7a52eb7
+SHA512:
+  metadata.gz: 61394aa86809472115313c5599abd1611d742ab861525fbbf4b531da6d26aa6b7184ff30506b4060c391f59a0be0a41ca996fe1f8b18e698650900933d1dd806
+  data.tar.gz: 116a21398b9d4416c7f94a43c0623211686ab75946de0c259e4cd1927cc2408905f539a9ed7d55649b7b6454d0fb0e8b4a738cc0b6d867e47ed2aa915495cb82

data/CHANGES.md

@@ -0,0 +1,4 @@
+# Changes
+
+* 2015-07-07 1.1.5 Update gemspec to use file manifest
+* 2012-03-14 1.1.4 Update docs, tests

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Thank you for contributing!
+
+If you would like to contribute a donation, an easy way is to use PayPal to sixarm@sixarm.com.
+
+If you would like to contribute help, the next section is for you.
+
+
+## Contributing to the source
+
+We love pull requests for improvments to the source code and documentation.
+
+There are three easy steps:
+
+1. Fork the repo. 
+
+  * Before you do any work please run our existing tests to make sure the code runs cleanly.
+
+2. Work as you like. 
+
+   * Please create tests. This helps us know that all your code runs cleanly.
+
+3. Push to your fork and submit a pull request.
+
+   * We'll take a look as soon as we can; this is typically within a business day.
+
+Thank you again!

data/LICENSE.md

@@ -0,0 +1,28 @@
+# License
+
+You may choose any of these open source licenses:
+
+  * Apache License
+  * BSD License
+  * CreativeCommons License, Non-commercial Share Alike
+  * GNU Affero General Public License (AGPL)
+  * GNU General Public License Version (GPL)
+  * GNU Lesser General Public License (LGPL)
+  * MIT License
+  * Perl Artistic License
+  * Ruby License
+
+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.
+
+This license is for the included software that is created by SixArm.
+Some of the included software may have its own licenses, copyrights,
+authors, etc. and these may take precedence over the SixArm license.
+
+Copyright (c) Joel Parker Henderson

data/README.md

@@ -0,0 +1,91 @@
+# SixArm.com » Ruby » <br> SignOut interface for typical Rails user sign out
+
+[![Code Climate](https://codeclimate.com/github/SixArm/sixarm_ruby_sign_out.png)](https://codeclimate.com/github/SixArm/sixarm_ruby_sign_out)
+[![Build Status](https://travis-ci.org/SixArm/sixarm_ruby_sign_out.png)](https://travis-ci.org/SixArm/sixarm_ruby_sign_out)
+
+* Doc: <http://sixarm.com/sixarm_ruby_sign_out/doc>
+* Gem: <http://rubygems.org/gems/sixarm_ruby_sign_out>
+* Repo: <http://github.com/sixarm/sixarm_ruby_sign_out>
+* Email: Joel Parker Henderson, <joel@sixarm.com>
+
+
+## Introduction
+
+Sign Out simple abstract framework.
+
+You can include this module in your application controller,
+then your controller can define any of these concrete methods.
+
+For docs go to <http://sixarm.com/sixarm_ruby_sign_out/doc>
+
+Want to help? We're happy to get pull requests.
+
+
+## Install quickstart
+
+Install:
+
+    gem install sixarm_ruby_sign_out
+
+Bundler:
+
+    gem "sixarm_ruby_sign_out", ">=1.1.5", "<2"
+
+Require:
+
+    require "sixarm_ruby_sign_out"
+
+
+## Install with security (optional)
+
+To enable high security for all our gems:
+
+    wget http://sixarm.com/sixarm.pem
+    gem cert --add sixarm.pem
+    gem sources --add http://sixarm.com
+
+To install with high security:
+
+    gem install sixarm_ruby_sign_out --trust-policy HighSecurity
+
+
+## Details
+
+This provides one top-level method:
+
+    sign_out(options=nil) => true for success, false for failure
+
+The top level method will call mid-level methods
+that you will define in your own controller.
+
+sign_out calls:
+
+    sign_out_attempt(options=nil), e.g. unset the current user
+    sign_out_success(options=nil), e.g. redirect to a goodbye page
+    sign_out_failure(options=nil), e.g. flash warning help message
+
+
+## AuthLogic Example
+
+AuthLogic provides this example:
+
+    def destroy
+      current_user_session.destroy
+     redirect_to new_user_session_url
+    end
+
+The same example written using Sign Out to provide better structure and security:
+
+    def sign_out_attempt
+      current_user_session.destroy
+      current_user_session.frozen? or raise SecurityError, "Problem with sign out ... ", caller
+    end
+
+    def sign_out_success
+      redirect_to new_user_session_url
+    end
+
+    def sign_out_failure
+      # The AuthLogic example doesn't handle this case unfortunately;
+      # we should handle it because it indicates something is amiss.
+    end

data/Rakefile

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+require "rake"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*.rb'
+end
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]

data/VERSION

@@ -0,0 +1 @@
+1.1.5

data/lib/sixarm_ruby_sign_out.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Please see README
+=end
+
+
+module SignOut
+
+
+ # The sign_out method calls:
+ # - sign_out_attempt
+ # - sign_out_success (if sign_out_attempt returns true)
+ # - sign_out_failure (if sign_out_attempt returns false or raises a SecurityError)
+
+ def sign_out(options=nil)
+  begin
+   sign_out_attempt(options) or raise SecurityError
+   sign_out_success(options)
+   return true
+  rescue SecurityError
+   sign_out_failure(options)
+   return false
+  end
+ end
+
+
+ # The sign_out method calls this first.
+ #
+ # You override this method to e.g.:
+ # - prompt the user to save any of his open work
+ # - clear the current user variable
+ # - clear the current user id in the session
+ #
+ # If this method succeeds, then control goes to sign_out_success.
+ #
+ # If this method raises an error, then control goes to sign_out_failure.
+
+ def sign_out_attempt(options=nil)
+ end
+
+
+ # The sign_out method calls this second,
+ # iff sign_out_attempt succeeds.
+ #
+ # You override this method to e.g.:
+ # - show the user a flash notice message saying "Goodbye..."
+ # - redirect to the application home page
+
+ def sign_out_success(options=nil)
+ end
+
+
+ # The sign_out method calls this second,
+ # iff sign_out_attempt raises an exception.
+ #
+ # You override this method to e.g.:
+ # - show the user a flash warning message saying "Problem..."
+ # - redirect to a help page with a way to report the problem
+
+ def sign_out_failure(options=nil)
+ end
+
+end

data/test/sixarm_ruby_sign_out_test.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+require "minitest/autorun"
+require "simplecov"
+SimpleCov.start
+require "sixarm_ruby_sign_out"
+
+class SignOutTest < Minitest::Test
+
+ include SignOut
+
+ RIGHT=:foo
+ WRONG=:bar
+
+ def setup
+  @sign_out_attempt_seen=false
+  @sign_out_success_seen=false
+  @sign_out_failure_seen=false
+ end
+
+ def test_sign_out_right
+  x=sign_out(RIGHT)
+  assert_equal(true,x,"sign_out x:#{x}")
+  assert( @sign_out_attempt_seen,"sign_out_attempt_seen")
+  assert( @sign_out_success_seen,"sign_out_success_seen")
+  assert(!@sign_out_failure_seen,"sign_out_failure_seen")
+ end
+
+ def test_sign_out_wrong
+  x=sign_out(WRONG)
+  assert_equal(false,x,"sign_out x:#{x}")
+  assert( @sign_out_attempt_seen,"sign_out_attempt_seen")
+  assert(!@sign_out_success_seen,"sign_out_success_seen")
+  assert( @sign_out_failure_seen,"sign_out_failure_seen")
+ end
+
+ def sign_out_attempt(options=nil)
+  @sign_out_attempt_seen=true
+  if options==WRONG then raise SecurityError end
+  return options==RIGHT
+ end
+
+ def sign_out_success(options=nil)
+  @sign_out_success_seen=true
+ end
+
+ def sign_out_failure(options=nil)
+  @sign_out_failure_seen=true
+ end
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: sixarm_ruby_sign_out
+version: !ruby/object:Gem::Version
+  version: 1.1.5
+platform: ruby
+authors:
+- SixArm
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIGCTCCA/GgAwIBAgIJAK3igyLv2hNNMA0GCSqGSIb3DQEBBQUAMGAxCzAJBgNV
+  BAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQHEw1TYW4gRnJhbmNp
+  c2NvMQ8wDQYDVQQKEwZTaXhBcm0xEzARBgNVBAMTCnNpeGFybS5jb20wHhcNMTUw
+  MzE0MjA0MTE5WhcNMTcxMjA4MjA0MTE5WjBgMQswCQYDVQQGEwJVUzETMBEGA1UE
+  CBMKQ2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEPMA0GA1UEChMG
+  U2l4QXJtMRMwEQYDVQQDEwpzaXhhcm0uY29tMIICIjANBgkqhkiG9w0BAQEFAAOC
+  Ag8AMIICCgKCAgEA4et7SlePzuE46eK5BAVVGg+yWt6FkX7xcLt3Uun9RntKPSuR
+  TbS/+KBqbja5reZD64hdQ9npxpQPKafxUm+RlCd9F5KFxwi8G9usKzCTPOwUeDI2
+  TNEfC+1eRU19QuEW58ZC0pC/bx5Zmp6/DTD6VV+qxKEE9U1M5P85LNkwnxqmRIMR
+  AN8VKOG+GRGOMNDGZ8Kp4h5V3Wyu0N7anY8AUveIx1SyLrEbAhcWp1asLs+/H22q
+  92YFgnwTtnDpZsAmNgZrVw9xY0v79BXqPoyKIl2psPfZi2mOIWi/N+cx6LGF1G+B
+  b+NZdAgwuLyFOoVknkTqsuYEsFhxz0dqDUgM/RvGrADxZk6yUD/1lBNTWnIDVKaN
+  Onu08gOb1lfn21Sbd5r/K32hngasiEuDvh61pJVwszBuFv3v++hVlvNzHw9oT7wc
+  W0z258Qw6fkPhozF5l+zaR+xPZG/4Kk4vc3D4mnw5MEHna6Q9rVsVktqGuIOie8Q
+  5MQAyjdNxywnl7GDllX97oVN+35JbyTePeUyZZnk5tb4p6BlYrd3rtQ2Te7tkQRz
+  8T4Scy5THaPvxf8SsfDGSj3AVPARvSX//hSFFxJM+up+S1jsquU0RjBU52nCdh7p
+  1hBZ1nqfVPeSktx3F+R2RZBPA692UKjpSA7r2vOEfoh3rUTEsNUBQGpPg2MCAwEA
+  AaOBxTCBwjAdBgNVHQ4EFgQUHnpLsysq561sVXhWi+3NoSb9n94wgZIGA1UdIwSB
+  ijCBh4AUHnpLsysq561sVXhWi+3NoSb9n96hZKRiMGAxCzAJBgNVBAYTAlVTMRMw
+  EQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQHEw1TYW4gRnJhbmNpc2NvMQ8wDQYD
+  VQQKEwZTaXhBcm0xEzARBgNVBAMTCnNpeGFybS5jb22CCQCt4oMi79oTTTAMBgNV
+  HRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4ICAQCYcCnvJpEhpo5mdVM8JDUuUZFt
+  qP2Kvj9J6tqugO+cuUF2S/ro4gdEQhl7Gv6+DCWHd0FQWJBSXMsZ9a6RhFGAcE5C
+  egK706Gh40yNeobd1aoUh+Pn17kYH2WSBRC+KsIvhZaAnra/1JPZItoge64GS+lM
+  PJJbVrtSati++s39wnss1QlMy9TXoesmR8vqsOU0XdCnK5hOun5RA8SYDWLffsfG
+  E3hvCg4C5viEkPY0YdC0KMSqs5kIA2nCUiqpkwIOa36rVEwiKiU7OCfE3u3baDpL
+  FlfMBznZKOdxDFAmNaxvXBe2XeTzrZPvJtnNLWL6K4LaBHhq3bBdh1Hge0iMkpQ7
+  RTIGlfhlIFkMV3wT0LTsNznUPsoo6e+IW/tDrk23mrNRY6QynTETb+QVIevuzD9m
+  Drcxp/zlVhud+a0ezdnyNvF520arJWvqA4GrOo8F+TT2vVrjscgYjiVGdSq+8wQv
+  Efa5jhe8QwG7R1rdpMMP5yBSAqWuFBczMveX5j4rp9Ifw5/XsZbgwcmdm26bjhzh
+  w2grAHIhvR9mztm6uXQlZhv1fu3P+RWHDSYhnZSCJSCdxPzQJ1mG5T5ahiL3HvCZ
+  2AC9FOGkybW6DJEFSFFMlNk0IILsa/gNp8ufGuTVLWF9FUUdMNK+TMbghnifT8/1
+  n+ES/gQPOnvmVkLDGw==
+  -----END CERTIFICATE-----
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies: []
+description: Sign Out abstraction for a typical web app user
+email: sixarm@sixarm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemtest"
+- CHANGES.md
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION
+- lib/sixarm_ruby_sign_out.rb
+- test/sixarm_ruby_sign_out_test.rb
+homepage: http://sixarm.com/
+licenses:
+- BSD
+- GPL
+- MIT
+- PAL
+- Various
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: SixArm.com » Ruby » Sign Out
+test_files:
+- test/sixarm_ruby_sign_out_test.rb