maestrano 0.4.0 → 0.5.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    maestrano (0.3.0)
+    maestrano (0.4.0)
       json (~> 1.8)
       mime-types (~> 1.25)
       nokogiri (>= 1.5.0)

data/README.md

@@ -23,9 +23,9 @@ Maestrano Cloud Integration is currently in closed beta. Want to know more? Send
 - - -
 
 ## Getting Setup
-Before integrating with us you will need an API Key. Maestrano Cloud Integration being still in closed beta you will need to contact us beforehand to gain production access.
+Before integrating with us you will need an App ID and API Key. Maestrano Cloud Integration being still in closed beta you will need to contact us beforehand to gain production access.
 
-For testing purpose we provide an API Sandbox where you can freely obtain an API Token. The sandbox is great to test single sign-on and API integration (e.g: billing API).
+For testing purpose we provide an API Sandbox where you can freely obtain an App ID and API Key. The sandbox is great to test single sign-on and API integration (e.g: billing API).
 
 To get started just go to: http://api-sandbox.maestrano.io
 

data/lib/maestrano.rb

@@ -61,6 +61,25 @@ module Maestrano
     self.config.api_token = "#{self.config.app_id}:#{self.config.api_key}"
   end
   
+  # Check that app_id and api_key passed
+  # in argument match
+  def self.authenticate(app_id,api_key)
+    self.param(:app_id) == app_id && self.param(:api_key) == api_key
+  end
+  
+  def self.mask_user(user_uid,group_uid)
+    sanitized_user_uid = self.unmask_user(user_uid)
+    if Maestrano.param('user_creation_mode') == 'virtual'
+      return "#{sanitized_user_uid}.#{group_uid}"
+    else
+      return sanitized_user_uid
+    end
+  end
+  
+  def self.unmask_user(user_uid)
+    user_uid.split(".").first
+  end
+  
   # Get configuration parameter value
   # E.g:
   # Maestrano.param('api_key')

data/lib/maestrano/sso.rb

@@ -68,14 +68,11 @@ module Maestrano
     # Takes the BaseUser hash representation and current session
     # in arguments
     def self.set_session(session, auth)
-      if auth && (extra = (auth[:extra] || auth['extra'])) && (sso_session = (extra[:session] || extra['session']))
-        session[:mno_uid] = (sso_session[:uid] || sso_session['uid'])
-        session[:mno_session] = (sso_session[:token] || sso_session['token'])
-        if recheck = (sso_session[:recheck] || sso_session['recheck'])
-          session[:mno_session_recheck] = recheck.utc.iso8601
-        end
-        session[:mno_group_uid] = (sso_session[:group_uid] || sso_session['group_uid'])
-      end
+      Maestrano::SSO::Session.from_user_auth_hash(session,auth).save
+    end
+    
+    def self.unset_session(session)
+      session.delete(:maestrano) && session.delete('maestrano')
     end
   end
 end

data/lib/maestrano/sso/session.rb

@@ -1,19 +1,37 @@
 module Maestrano
   module SSO
     class Session
-      attr_accessor :session, :uid, :session_token, :recheck
+      attr_accessor :session, :uid, :session_token, :recheck, :group_uid
+      
+      # Load a Maestrano::SSO::Session object from a
+      # hash generated by Maestrano::SSO::BaseUser#to_hash
+      def self.from_user_auth_hash(session, auth)
+        instance = self.new({})
+        instance.session = session
+        
+        if (extra = (auth[:extra] || auth['extra'])) && (sso_session = (extra[:session] || extra['session']))
+          instance.uid = (sso_session[:uid] || sso_session['uid'])
+          instance.session_token = (sso_session[:token] || sso_session['token'])
+          instance.group_uid = (sso_session[:group_uid] || sso_session['group_uid'])
+          if recheck = (sso_session[:recheck] || sso_session['recheck'])
+            instance.recheck = recheck
+          end
+        end
+        return instance
+      end
       
       def initialize(session)
         self.session = session
-        self.uid = (self.session['mno_uid'] || self.session[:mno_uid])
-        self.session_token = (self.session['mno_session'] || self.session[:mno_session])
-        if recheck = (self.session['mno_session_recheck'] || self.session[:mno_session_recheck])
-          self.recheck = Time.iso8601(recheck)
+        begin
+          if mno_session = (self.session[:maestrano] || self.session['maestrano'])
+            decrypted_session = JSON.parse(Base64.decode64(mno_session))
+            self.uid = decrypted_session['uid']
+            self.session_token = decrypted_session['session']
+            self.recheck = Time.iso8601(decrypted_session['session_recheck'])
+            self.group_uid = decrypted_session['group_uid']
+          end
+        rescue
         end
-        
-        if self.uid.nil? || self.session_token.nil? || self.recheck.nil?
-          $stderr.puts "WARNING: Maestrano session information missing. User will have to relogin"
-        end 
       end
       
       def remote_check_required?
@@ -49,7 +67,7 @@ module Maestrano
       def valid?
         if self.remote_check_required?
           if perform_remote_check
-            self.session[:mno_session_recheck] = self.recheck.utc.iso8601
+            self.save
             return true
           else
             return false
@@ -58,6 +76,15 @@ module Maestrano
         return true
       end
       
+      def save
+        self.session[:maestrano] = Base64.encode64({
+          uid: self.uid,
+          session: self.session_token,
+          session_recheck: self.recheck.utc.iso8601,
+          group_uid: self.group_uid
+        }.to_json)
+      end
+      
     end
   end
 end

data/lib/maestrano/version.rb

@@ -1,3 +1,3 @@
 module Maestrano
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/test/maestrano/maestrano_test.rb

@@ -23,12 +23,53 @@ class MaestranoTest < Test::Unit::TestCase
     end
   end
   
-  should "return the specified parameters" do
-    @config.keys.each do |key|
-      assert Maestrano.param(key) == @config[key]
+  context "param" do
+    should "return the specified parameters" do
+      @config.keys.each do |key|
+        assert Maestrano.param(key) == @config[key]
+      end
+    end
+  end
+  
+  context "authenticate" do
+    should "return true if app_id and api_key match" do
+      assert Maestrano.authenticate(Maestrano.param(:app_id),Maestrano.param(:api_key))
+    end
+    
+    should "return false otherwise" do
+      assert !Maestrano.authenticate(Maestrano.param(:app_id) + 'a',Maestrano.param(:api_key))
+      assert !Maestrano.authenticate(Maestrano.param(:app_id),Maestrano.param(:api_key) + 'a')
     end
   end
   
+  context "mask_user_uid" do
+    should "return the composite uid if creation_mode is virtual" do
+      Maestrano.configure { |c| c.user_creation_mode = 'virtual' }
+      assert_equal 'usr-1.cld-1', Maestrano.mask_user('usr-1','cld-1')
+    end
+    
+    should "not double up the composite uid" do
+      Maestrano.configure { |c| c.user_creation_mode = 'virtual' }
+      assert_equal 'usr-1.cld-1', Maestrano.mask_user('usr-1.cld-1','cld-1')
+    end
+    
+    should "return the real uid if creation_mode is real" do
+      Maestrano.configure { |c| c.user_creation_mode = 'real' }
+      assert_equal 'usr-1', Maestrano.mask_user('usr-1','cld-1')
+    end
+  end
+  
+  context "unmask_user_uid" do
+    should "return the right uid if composite" do
+      assert_equal 'usr-1', Maestrano.unmask_user('usr-1.cld-1')
+    end
+    
+    should "return the right uid if non composite" do
+      assert_equal 'usr-1', Maestrano.unmask_user('usr-1')
+    end
+  end
+  
+  
   context "configuration" do
     should "return the right test parameters" do
       Maestrano.configure { |config| config.environment = 'test' }

data/test/maestrano/sso/session_test.rb

@@ -4,20 +4,47 @@ module Maestrano
   module SSO
     class SessionTest < Test::Unit::TestCase
       setup do
+        @mno_session = {
+          uid: 'usr-1',
+          session: 'g4dfg4fdg8378d6acf45',
+          session_recheck: Time.now.utc.iso8601,
+          group_uid: 'cld-2'
+        }
         @session = {
-          mno_uid: 'usr-1',
-          mno_session: 'g4dfg4fdg8378d6acf45',
-          mno_session_recheck: Time.now.utc.iso8601
+          maestrano: Base64.encode64(@mno_session.to_json)
         }
       end
   
       should "initialize the sso session properly" do
         sso_session = Maestrano::SSO::Session.new(@session)
-        assert_equal sso_session.uid, @session[:mno_uid]
-        assert_equal sso_session.session_token, @session[:mno_session]
-        assert_equal sso_session.recheck, Time.iso8601(@session[:mno_session_recheck])
+        assert_equal sso_session.uid, @mno_session[:uid]
+        assert_equal sso_session.session_token, @mno_session[:session]
+        assert_equal sso_session.recheck, Time.iso8601(@mno_session[:session_recheck])
+        assert_equal sso_session.group_uid, @mno_session[:group_uid]
       end
-  
+      
+      context "from_user_auth_hash" do
+        should "set the session correctly" do
+          sso_session = {}
+          auth = {
+            extra: {
+              session: {
+                uid: 'usr-1',
+                token: '15fg6d',
+                recheck: Time.now,
+                group_uid: 'cld-3'
+              }
+            }
+          }
+          sso_session = Maestrano::SSO::Session.from_user_auth_hash(@session,auth)
+          assert_equal sso_session.uid, auth[:extra][:session][:uid]
+          assert_equal sso_session.session_token, auth[:extra][:session][:token]
+          assert_equal sso_session.recheck.utc.iso8601, auth[:extra][:session][:recheck].utc.iso8601
+          assert_equal sso_session.group_uid, auth[:extra][:session][:group_uid]
+        end
+      end
+      
+      
       context "remote_check_required?" do
         setup do
           @sso_session = Maestrano::SSO::Session.new(@session)
@@ -87,13 +114,13 @@ module Maestrano
           assert @sso_session.valid?
         end
     
-        should "update session recheck timestamp if remote_check_required? and valid" do
+        should "update maestrano session with recheck timestamp if remote_check_required? and valid" do
           recheck = (@sso_session.recheck + 600)
           @sso_session.recheck = recheck
           @sso_session.stubs(:remote_check_required?).returns(true)
           @sso_session.stubs(:perform_remote_check).returns(true)
           @sso_session.valid?
-          assert_equal @session[:mno_session_recheck], recheck.utc.iso8601
+          assert_equal JSON.parse(Base64.decode64(@session[:maestrano]))['session_recheck'], recheck.utc.iso8601
         end
     
         should "return false if remote_check_required? and invalid" do

data/test/maestrano/sso_test.rb

@@ -58,24 +58,36 @@ module Maestrano
       response = Maestrano::SSO.build_response(response_document)
       assert Maestrano::SSO.build_response(response_document) == response
     end
-  
-    should "set the session correctly" do
-      session = {}
-      auth = {
-        extra: {
-          session: {
-            uid: 'usr-1',
-            token: '15fg6d',
-            recheck: Time.now,
-            group_uid: 'cld-3'
+    
+    context "session management" do
+      setup do
+        @session = {}
+        @auth = {
+          extra: {
+            session: {
+              uid: 'usr-1',
+              token: '15fg6d',
+              recheck: Time.now,
+              group_uid: 'cld-3'
+            }
           }
         }
-      }
-      Maestrano::SSO.set_session(session,auth)
-      assert_equal session[:mno_uid], auth[:extra][:session][:uid]
-      assert_equal session[:mno_session], auth[:extra][:session][:token]
-      assert_equal session[:mno_session_recheck], auth[:extra][:session][:recheck].utc.iso8601
-      assert_equal session[:mno_group_uid], auth[:extra][:session][:group_uid]
+      end
+    
+      should "set the session correctly" do
+        Maestrano::SSO.set_session(@session,@auth)
+        decrypt_session = JSON.parse(Base64.decode64(@session[:maestrano]))
+        assert_equal decrypt_session['uid'], @auth[:extra][:session][:uid]
+        assert_equal decrypt_session['session'], @auth[:extra][:session][:token]
+        assert_equal decrypt_session['session_recheck'], @auth[:extra][:session][:recheck].utc.iso8601
+        assert_equal decrypt_session['group_uid'], @auth[:extra][:session][:group_uid]
+      end
+      
+      should "unset the session correctly" do
+        Maestrano::SSO.set_session(@session,@auth)
+        Maestrano::SSO.unset_session(@session)
+        assert @session[:maestrano].nil?
+      end
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: maestrano
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Arnaud Lachaume