utep_sso 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02a0e482c6cfceb8553f0187ffe93a69363210eb
-  data.tar.gz: b0c1209fb357a25d0a869b46b0372c408b4bdb60
+  metadata.gz: d794d674afd4ef31f64eb15a558a28499c178e11
+  data.tar.gz: 6e4714a156ced0844268429c3985a5131bba093a
 SHA512:
-  metadata.gz: 153607159c46af42f4c0ce217797444f3f9e7f82c4f8ac7bded17348521a59e3251e5c6927caf3cb1e66c4072a9342add88a5143477665f23715451c4762cfcc
-  data.tar.gz: 8a6259ccc516b9ddccc333ebf09d2727007385fc903c3a643041fbe6ba0c55e1154f4ed784c4ed24463bf884c4e00466b94224b427a1f5cbd4456efeb82a1f89
+  metadata.gz: 0719a894c877bedca9c7fb7af01a8d041e0c223a838c50c8c55c5216e79e4ebf73da57ed1764aafa73885cfa0275afc55b283bee789c20019684198bf6eae7aa
+  data.tar.gz: 0722926593918c6cb6668a85be774618f9f76ee7bea21f35cbc22f45065e99aff474a66bfe480b9c6b1d1f919a6c5c1f158bc131b0437540c83baf6ed7d20414

data/.gitignore

@@ -11,4 +11,5 @@
 *.so
 *.o
 *.a
+.DS_Store
 mkmf.log

data/README.md

@@ -1,6 +1,6 @@
 # UTEP SingleSignOn for Ruby
 
-TODO: Write a gem description
+Authenticate users using UTEP's SingleSignOn
 
 ## Installation
 
@@ -12,7 +12,7 @@ gem 'utep_sso'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -20,11 +20,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+
+require 'utep_sso'
+
+
+# Check if a user is signed in
+UTEPSSO.authenticated?(cookies[:UTEP_SE], cookies[:UTEP_SA])
+
+# Authenticate a user using UTEP cookies (will return nil values in the hash for invalid cookies)
+UTEPSSO.authenticate(cookies[:UTEP_SE], cookies[:UTEP_SA])
+# => {:user_name, :full_name, :email_address, :authenticated, :role_value, :external_user, :@xmlns}
+
+# roles are returned as a binary
+#  000010 = faculty
+#  000100 = staff
+#  010000 = student
+
+#  010110 = user that is a student, faculty and staff 
+
+# Deauthenticate a user
+UTEPSSO.deauthenticate(cookies[:UTEP_SE], cookies[:UTEP_SA])
+
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/utep_sso/fork )
+1. Fork it ( https://github.com/awernick/utep_sso/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/utep_sso/version.rb

@@ -1,3 +1,3 @@
 module UTEPSSO
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/utep_sso.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["alan.wernik@gmail.com"]
   spec.summary       = %q{UTEP SingleSignOn Authentication for Ruby}
   spec.description   = %q{Fetch user information using UTEP's Single Sign On service}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/awernick/utep_sso"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utep_sso
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alan Wernick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,7 +68,7 @@ files:
 - lib/utep_sso.rb
 - lib/utep_sso/version.rb
 - utep_sso.gemspec
-homepage: ''
+homepage: https://github.com/awernick/utep_sso
 licenses:
 - MIT
 metadata: {}