cs50 0.1.1

data/lib/cs50.rb

@@ -0,0 +1,100 @@
+require 'openid'
+require 'openid/extensions/ax'
+require 'openid/extensions/sreg'
+require 'openid/store/filesystem'
+require 'pathname'
+
+# CS50 OpenID authentication
+#
+# Licensed under the {http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike 3.0 Unported License}
+#
+# @author {mailto:macwilliamt@gmail.com Tommy MacWilliam}
+# @version 0.1
+# @see https://manual.cs50.net/CS50_Library
+#
+class CS50
+    
+    # Get URL to which user can be redirected to authenticate using CS50 ID.
+    #
+    # @param [String] directory Path to directory used to store state (i.e. <tt>Rails.root.join('tmp')</tt> for Ruby on Rails)
+    # @param [String] trust_root URL that CS50 ID should prompt user to trust
+    # @param [String] return_to URL to which CS50 should return user after login
+    # @param session Session variable (i.e. <tt>session</tt> for Ruby on Rails)
+    # @return [String] URL for CS50 ID authentication
+    #
+    def self.getLoginUrl(directory, trust_root, return_to, session)
+        # prepare request
+        store = OpenID::Store::Filesystem.new(Pathname.new(directory))
+        consumer = OpenID::Consumer.new(session, store)
+        auth_request = consumer.begin('https://id.cs50.net/')
+
+        # simple registration fields
+        auth_request.add_extension(OpenID::SReg::Request.new(['email'], ['fullname']))
+
+=begin AX code, removed for now due to URL length limitation in WEBrick
+        # attribute exchange attributes
+        ax_request = OpenID::AX::FetchRequest.new
+        ax_request.add(OpenID::AX::AttrInfo.new("http://axschema.org/contact/email", 1, true))
+        ax_request.add(OpenID::AX::AttrInfo.new("http://axschema.org/contact/namePerson", 2, false))
+        auth_request.add_extension(ax_request)
+=end
+
+        # generate url for redirection
+        return auth_request.redirect_url(trust_root, return_to)
+    end
+
+    # If user has been authenticated by CS50 ID, get the user's information.
+    # @note A unique ID for the user *will* be returned, and the user's email and name *may* be returned.
+    #
+    # @param [String] directory Path to directory used to store state (i.e. <tt>Rails.root.join('tmp')</tt> for Ruby on Rails)
+    # @param [String] return_to URL to which CS50 should return user after login
+    # @param session Session variable (i.e. <tt>session</tt> for Ruby on Rails)
+    # @param params Parameters array (i.e. <tt>params</tt> for Ruby on Rails)
+    # @return [Hash] User's <tt>:id</tt>, <tt>:email</tt> and <tt>:name</tt>
+    #
+    def self.getUser(directory, return_to, session, params)
+        # clean rails parameters from the URL (else Janrain fails)
+        parameters = params.clone
+        parameters.delete(:controller)
+        parameters.delete(:action)
+
+        # get response
+        store = OpenID::Store::Filesystem.new(Pathname.new(directory))
+        consumer = OpenID::Consumer.new(session, store)
+        response = consumer.complete(parameters, return_to)
+
+        if (response.status == OpenID::Consumer::SUCCESS)
+            # simple registration fields
+            sreg_resp = OpenID::SReg::Response.from_success_response(response)
+            
+=begin AX code, removed for now due to URL length limitation in WEBrick
+            # get attribute exchange attributes
+            ax_resp = OpenID::AX::FetchResponse.from_success_response(response)
+            data = ax_resp.data
+=end
+
+            # get user's ID from identity url
+            if (response.identity_url =~ /^https:\/\/id.cs50.net\/([0123456789abcdef]{64})$/)
+                user = { :id => $1 }
+            else
+                return false
+            end
+
+            # get user's email
+            if (sreg_resp["email"])
+                user[:email] = sreg_resp["email"]
+            end
+                
+            # get user's name
+            if (sreg_resp["fullname"])
+                user[:name] = sreg_resp["fullname"]
+            end
+
+            return user;
+            
+        # response failure
+        else
+            return false
+        end
+    end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: cs50
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Tommy MacWilliam
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-openid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Utility functions for authenticating users via CS50 ID (https://id.cs50.net/)
+email: macwilliamt@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cs50.rb
+has_rdoc: true
+homepage: https://docs.cs50.net/CS50_ID
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Library for Harvard College's CS50
+test_files: []
+