sessionvoc-open 1.7.3

data/lib/sessionvoc/open/exceptions.rb

@@ -0,0 +1,59 @@
+# Copyright:: 2011 triAGENS GmbH
+# Author:: Oliver Kiessler (mailto:kiessler@inceedo.com)
+module Sessionvoc
+  module Open
+    # Raised when no SessionVOC client could be created due to a missing configuration.
+    class ConfigurationMissingException < Exception; end
+  
+    # The SessionVOC server is not accessible with this configuration.
+    class ConnectionRefusedException < Exception; end
+  
+    # Raised when the SessionVOC server could not create a new session.
+    class SessionCreationFailureException < Exception; end
+  
+    # Raised when no or an invalid session id is used and it is unknown to SessionVOC.
+    class InvalidSidException < Exception; end
+  
+    # Raised when the session identified by a sid could not be deleted.
+    class SessionDeletionFailure < Exception; end
+  
+    # Raised when invalid JSON is passed to SessionVOC.
+    class InvalidJSONException < Exception; end
+  
+    # Raised when an unidentified problem occured.
+    class UnknownException < Exception; end
+  
+    # Raised when the given credentials are unknown to SessionVOC.
+    class AuthentificationFailedException < Exception; end
+  
+    # Raised when an illegal user identifier is passed to SessionVOC.
+    class IllegalUserIdentifierException < Exception; end
+  
+    # Raised when an illegal authentification request is passed to SessionVOC.
+    class IllegalAuthentificationRequestException < Exception; end
+  
+    # Raised when an illegal request is passed to SessionVOC.
+    class IllegalRequestException < Exception; end
+  
+    # Raised when an internal server error occurs in SessionVOC.
+    class InternalServerErrorException < Exception; end
+  
+    # Raised when an unknown or invalid form id is passed to SessionVOC.
+    class InvalidFidException < Exception; end
+  
+    # Raised when a form data problem occurred in SessionVOC.
+    class FormDataCantBeDestroyedException < Exception; end
+  
+    # Raised when a form data problem occurred in SessionVOC.
+    class FormDataCantBeModifiedException < Exception; end
+  
+    # Raised when an unsupported functionality in this ruby library was used.
+    class NotSupportedException < Exception; end
+  
+    # Raised when the given data could not be converted to the data types expected by SessionVOC.
+    class DataConversionException < Exception; end
+    
+    # Raised when an unknown, temporary error in SessionVOC occurs.
+    class TemporaryErrorException < Exception; end
+  end
+end

data/lib/sessionvoc/open/form_data.rb

@@ -0,0 +1,64 @@
+# Copyright:: 2011 triAGENS GmbH
+# Author:: Oliver Kiessler (mailto:kiessler@inceedo.com)
+module Sessionvoc
+  module Open
+    # The methods in this module handle all form data relevant actions.
+    module FormData    
+      # Creates a new form context within a given session and returns a fid which identifies the form context.
+      # === Parameters
+      # * sid = Session Id
+      # * options
+      def create_form_data(sid, options = {})
+        response = get_response(:post, "/formdata/#{sid}")
+        if response_ok?(response)
+          response.parsed_response["fid"]
+        else
+          handle_exception(response.parsed_response["errorCode"], response.parsed_response["message"])
+        end
+      end
+
+      # Deletes a form context within a session.
+      # === Parameters
+      # * sid = Session Id
+      # * fid = Form Id
+      # * options
+      def delete_form_data(sid, fid, options = {})
+        response = get_response(:delete, "/formdata/#{sid}/#{fid}")
+        if response_ok?(response)
+          response.parsed_response["deleted"]
+        else
+          handle_exception(response.parsed_response["errorCode"], response.parsed_response["message"])
+        end
+      end
+
+      # Returns the contents of a form context within a session.
+      # === Parameters
+      # * sid = Session Id
+      # * fid = Form Id
+      # * options
+      def get_form_data(sid, fid, options = {})
+        response = get_response(:get, "/formdata/#{sid}/#{fid}")
+        if response and response.response.is_a?(Net::HTTPOK)
+          response.parsed_response
+        else
+          handle_exception(response.parsed_response["errorCode"], response.parsed_response["message"])
+        end
+      end
+
+      # Updates/replaces the form data in SessionVOC with the form_data passed to this method.
+      # === Parameters
+      # * sid = Session Id
+      # * fid = Form Id
+      # * form_data = Form data hash
+      # * options
+      def update_form_data(sid, fid, form_data, options = {})
+        response = get_response(:put, "/formdata/#{sid}/#{fid}", {:body => form_data.to_json})
+        if response_ok?(response)
+          (response.parsed_response['sid'] and response.parsed_response['fid'])
+        else
+          handle_exception(response.parsed_response["errorCode"], response.parsed_response["message"])
+        end
+      end
+    end
+  end
+end

data/lib/sessionvoc/open/meta_data.rb

@@ -0,0 +1,18 @@
+# Copyright:: 2011 triAGENS GmbH
+# Author:: Oliver Kiessler (mailto:kiessler@inceedo.com)
+module Sessionvoc
+  module Open
+    # The methods in this module handle all meta data related actions.
+    module MetaData
+      # Returns meta data info from the SessionVOC server. Includes types and access permissions.
+      def datainfo
+        response = get_response(:get, "/datainfo")
+        if response_ok?(response)
+          return response.parsed_response
+        else
+          raise Sessionvoc::Open::UnknownException
+        end
+      end
+    end
+  end
+end

data/lib/sessionvoc/open/session.rb

@@ -0,0 +1,63 @@
+# Copyright:: 2011 triAGENS GmbH
+# Author:: Oliver Kiessler (mailto:kiessler@inceedo.com)
+module Sessionvoc
+  module Open
+    # The methods in this module handle all session related actions.
+    module Session
+      # Creates a new session in the SessionVOC server and returns a sid.
+      def new_session
+        response = get_response(:post, "/session")
+        if response_ok?(response)
+          return response.parsed_response["sid"]
+        else
+          raise Sessionvoc::Open::SessionCreationFailureException
+        end
+      end
+
+      # Deletes an existing session in the SessionVOC server.
+      # === Parameters
+      # * sid = Session Id
+      def delete_session(sid)
+        response = get_response(:delete, "/session/#{sid}")
+        if response_ok?(response) and response.parsed_response["deleted"]
+          return true
+        else
+          handle_exception(response.parsed_response["errorCode"], response.parsed_response["message"])
+        end
+      end
+
+      # Updates the contents of the session in the SessionVOC server. Pass in a session_data hash containing the "transData" und "userData"
+      # sections.
+      # === Parameters
+      # * sid = Session Id
+      # * session_data = Session data hash
+      # * options
+      def update(sid, session_data, options = {})
+        logger.debug("Session Data for sid #{sid}: #{session_data.inspect}")
+        body = {}
+        body['transData'] = session_data['transData'] if session_data['transData'] and not session_data['transData'].empty?
+        body['userData'] = session_data['userData'] if session_data['userData'] and not session_data['userData'].empty?
+        logger.debug("Body JSON: #{body.to_json}")
+        response = get_response(:put, "/session/#{sid}", {:body => body.to_json})
+        response_ok?(response) ? response.parsed_response : handle_exception(response.parsed_response["errorCode"], response.parsed_response["message"])
+      end
+
+      # Alias for get_session.
+      # === Parameters
+      # * sid
+      def output(sid); get_session(sid); end
+    
+      # Retuns the contents of a session from the SessionVOC server as a hash.
+      # === Parameters
+      # * sid = Session Id
+      def get_session(sid)
+        response = get_response(:get, "/session/#{sid}")
+        if response_ok?(response)
+          return response.parsed_response
+        else
+          raise Sessionvoc::Open::InvalidSidException
+        end
+      end
+    end
+  end
+end

data/sessionvoc-open.gemspec

@@ -0,0 +1,103 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sessionvoc-open}
+  s.version = "1.7.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["triAGENS GmbH", "Oliver Kiessler"]
+  s.date = %q{2011-04-14}
+  s.description = %q{Rails 3 Plugin to integrate with SessionVOC. In order to manage user sessions efficiently the SessionVOC provides the functions login, logout, read and write of a session. Furthermore it has the ability to synchronize with one or more persistent relational databases.}
+  s.email = %q{kiessler@inceedo.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "config.yml.sample",
+    "examples/example.sql",
+    "examples/example.xml",
+    "init.rb",
+    "install.rb",
+    "lib/sessionvoc-open.rb",
+    "lib/sessionvoc-store/open/controller_methods.rb",
+    "lib/sessionvoc-store/open/railtie.rb",
+    "lib/sessionvoc-store/open/sessionvoc_store.rb",
+    "lib/sessionvoc/open/authentification.rb",
+    "lib/sessionvoc/open/base.rb",
+    "lib/sessionvoc/open/client.rb",
+    "lib/sessionvoc/open/configuration.rb",
+    "lib/sessionvoc/open/data_conversion.rb",
+    "lib/sessionvoc/open/exceptions.rb",
+    "lib/sessionvoc/open/form_data.rb",
+    "lib/sessionvoc/open/meta_data.rb",
+    "lib/sessionvoc/open/session.rb",
+    "test/config.yml",
+    "test/helper.rb",
+    "test/test_sessionvoc_authentification.rb",
+    "test/test_sessionvoc_base.rb",
+    "test/test_sessionvoc_data_conversion.rb",
+    "test/test_sessionvoc_form_data.rb",
+    "test/test_sessionvoc_meta_data.rb",
+    "test/test_sessionvoc_session.rb",
+    "uninstall.rb"
+  ]
+  s.homepage = %q{http://www.worldofvoc.com/products/sessionvoc/summary/}
+  s.licenses = ["Apache License Version 2.0, January 2004"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{The SessionVOC is a noSQL database optimized for the management of user sessions.}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_sessionvoc_authentification.rb",
+    "test/test_sessionvoc_base.rb",
+    "test/test_sessionvoc_data_conversion.rb",
+    "test/test_sessionvoc_form_data.rb",
+    "test/test_sessionvoc_meta_data.rb",
+    "test/test_sessionvoc_session.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.7.4"])
+      s.add_runtime_dependency(%q<json>, [">= 1.4.6"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.7.4"])
+      s.add_dependency(%q<json>, [">= 1.4.6"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.7.4"])
+    s.add_dependency(%q<json>, [">= 1.4.6"])
+  end
+end
+

data/test/config.yml

@@ -0,0 +1,5 @@
+protocol: http
+host: localhost
+port: 8208
+strict_mode: true
+auth: simple

data/test/helper.rb

@@ -0,0 +1,38 @@
+# Copyright:: 2011 triAGENS GmbH
+# Author:: Oliver Kiessler (mailto:kiessler@inceedo.com)
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'digest'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sessionvoc-open'
+
+class Test::Unit::TestCase
+  def non_sid
+    "473878374888888888888zfgiusdhfkhsdfz843z987843975893745897389#{rand(10)}#{Time.now.to_i}"
+  end
+
+  def non_fid
+    "3748748#{rand(10)}#{Time.now.to_i}"
+  end
+
+  def client
+    port = ENV['SESSIONVOC_PORT']
+    host = ENV['SESSIONVOC_HOST']
+    if host and port
+      @client ||= Sessionvoc::Open::Client.new('host' => host, 'port' => port, 'log_level' => Logger::DEBUG)
+    else
+      @client ||= Sessionvoc::Open::Client.new('log_level' => Logger::DEBUG)
+    end
+  end
+end

data/test/test_sessionvoc_authentification.rb

@@ -0,0 +1,62 @@
+# Copyright:: 2011 triAGENS GmbH
+# Author:: Oliver Kiessler (mailto:kiessler@inceedo.com)
+require 'helper'
+
+class TestSessionvocAuthentification < Test::Unit::TestCase
+  should "perform a simple authentification" do
+    sid = client.new_session
+    assert client.simple(sid, 'testuser', 'tester')
+  end
+
+  should "fail to perform a simple authentification due to a non-existing sid" do
+    sid = client.new_session
+    assert non_sid != sid
+    assert_raise Sessionvoc::Open::InvalidSidException do
+      client.simple(non_sid, 'testuser', 'tester')
+    end
+  end
+
+  should "perform a logout" do
+    sid = client.new_session
+    assert client.simple(sid, 'testuser', 'tester')
+    assert client.logout(sid)
+  end
+
+  should "perform the correct encryption and hashing" do
+    assert_equal client.send(:encrypt_password, 'tester', 'abcdef', Sessionvoc::Open::Base::HASH_TYPES[:HASH_NONE]), 'tester'
+    assert_equal client.send(:encrypt_password, 'tester', 'abcdef', Sessionvoc::Open::Base::HASH_TYPES[:HASH_SHA1]), 'db1e80e88bdeb3182c368f2b9d798431'
+    assert_equal client.send(:encrypt_password, 'tester', 'abcdef', Sessionvoc::Open::Base::HASH_TYPES[:HASH_MD5]), '8310a7f94396ec64c9221227ba5c667e'
+    
+    assert_raise Sessionvoc::Open::NotSupportedException do
+      client.send(:encrypt_password, 'tester', 'abcdef', Sessionvoc::Open::Base::HASH_TYPES[:HASH_SHA224])
+    end
+    
+    assert_raise Sessionvoc::Open::NotSupportedException do
+      client.send(:encrypt_password, 'tester', 'abcdef', Sessionvoc::Open::Base::HASH_TYPES[:HASH_SHA256])
+    end
+  end
+
+  should "create a nonce" do
+    nonce = client.create_nonce
+    assert_not_nil nonce
+    assert_equal nonce.length, 17
+    timestamp = Time.now.to_i
+    random_number = client.gen_64bit_id
+    local_nonce = Base64.encode64("#{timestamp.to_s[0..3]}#{random_number[4..11]}")
+    nonce = client.create_nonce(timestamp, random_number)
+    assert_not_nil nonce
+    assert_equal nonce.length, 17
+    assert_equal nonce, local_nonce
+    
+    nonce = client.create_nonce(timestamp, random_number, {:no_encode => true})
+    assert_equal nonce, "#{timestamp.to_s[0..3]}#{random_number[4..11]}"
+  end
+
+  should "check the status of a nonce" do
+    10.times do
+      nonce = client.create_nonce
+      assert client.get_nonce(nonce)
+      assert !client.get_nonce(nonce)
+    end
+  end
+end

data/test/test_sessionvoc_base.rb

@@ -0,0 +1,62 @@
+# Copyright:: 2011 triAGENS GmbH
+# Author:: Oliver Kiessler (mailto:kiessler@inceedo.com)
+require 'helper'
+require "ftools"
+
+class TestSessionvocBase < Test::Unit::TestCase
+  should "initialize configuration" do
+    client = Sessionvoc::Open::Client.new('protocol' => 'http', 'host' => 'localhost', 'port' => '12345',
+                                          'log_level' => Logger::DEBUG, 'strict_mode' => true)
+    assert_not_nil client
+    assert_not_nil client.configuration
+    assert_not_nil client.configuration.options
+    assert_not_nil client.logger
+
+    assert_equal client.configuration.options['protocol'], 'http'
+    assert_equal client.configuration.options['host'], 'localhost'
+    assert_equal client.configuration.options['port'], '12345'
+    assert_equal client.configuration.options['log_level'], Logger::DEBUG
+    assert client.configuration.options['strict_mode']
+  end
+  
+  should "return error codes" do
+    client = Sessionvoc::Open::Client.new('host' => 'localhost', 'port' => '12345', 'strict_mode' => true)
+    assert_not_nil client.send(:codes)
+  end
+  
+  should "return correct server base url based on configuration" do
+    client = Sessionvoc::Open::Client.new('host' => 'localhost', 'port' => '12345')
+    assert_equal client.send(:base_url), 'http://localhost:12345'
+
+    client2 = Sessionvoc::Open::Client.new('protocol' => 'https', 'host' => 'localhost', 'port' => '8080')
+    assert_equal client2.send(:base_url), 'https://localhost:8080'
+  end
+
+  should 'initialize configuration from yml file from current directory' do
+    client = Sessionvoc::Open::Client.new
+    assert_equal client.configuration.options['protocol'], 'http'
+    assert_equal client.configuration.options['host'], 'localhost'
+    assert_equal client.configuration.options['port'], '8208'
+    assert client.configuration.options['strict_mode']
+    assert_equal client.configuration.options['auth'], 'none'
+  end
+
+  should "read configuration" do
+    assert_not_nil (client = Sessionvoc::Open::Client.new)
+    File.copy('test/config.yml', './config.yml')
+    client.send(:read_configuration)
+    assert_not_nil client.configuration
+    File.delete('./config.yml')
+  end
+
+  should "set the strict mode" do
+    client = Sessionvoc::Open::Client.new('host' => 'localhost', 'port' => '12345', 'strict_mode' => true)
+    assert client.send(:use_strict_mode?)
+    client = Sessionvoc::Open::Client.new('host' => 'localhost', 'port' => '12345', 'strict_mode' => false)
+    assert !client.send(:use_strict_mode?)
+  end
+
+  should 'return client version' do
+    assert_equal Sessionvoc::Open::Client::VERSION, '1.7.3'
+  end
+end