goz 0.0.2 → 0.0.3

data/lib/goz/group.rb

@@ -0,0 +1,174 @@
+# encoding: utf-8
+
+require 'goz/database'
+require 'goz/event'
+require 'goz/group_service'
+
+module Goz # :nodoc:
+ 
+  # 
+  # = Goz::Group - Generic Goz group
+  #   
+  # == Usage
+  #
+  #   require 'goz/group'
+  #
+  #   g = Goz::Group.find_by_name(name)
+  #   unless g
+  #     g = Goz::Group.create( :display_name => display_name,
+  #                            :identifier   => identifier,
+  #                            :name         => name
+  #                         )
+  #   end
+  #   g.display_name  # => 'Foo : Bar'
+  #   g.identifier    # => <some unique identifier>
+  #   g.name          # => 'foo:bar'
+  #   g.created_at    # => '2012-03-23 14:58:02 -0500'
+  #  
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/goz/
+  #
+  class Group < Sequel::Model
+    include Comparable
+
+    plugin :validation_helpers
+
+    many_to_many  :admins,
+                  :left_key     => :group_id,
+                  :right_key    => :user_id,
+                  :join_table   => :admins,
+                  :class        => :'Goz::User',
+                  :after_add    => proc { |g, u| Goz::Event.admin_add(g, u) },
+                  :after_remove => proc { |g, u| Goz::Event.admin_remove(g, u) }
+    many_to_many  :members,
+                  :left_key     => :group_id,
+                  :right_key    => :user_id,
+                  :join_table   => :members,
+                  :class        => :'Goz::User',
+                  :after_add    => proc { |g, u| Goz::Event.member_add(g, u) },
+                  :after_remove => proc { |g, u| Goz::Event.member_remove(g, u) }
+    many_to_many  :services,
+                  :left_key     => :group_id,
+                  :right_key    => :service_id,
+                  :join_table   => :group_services,
+                  :class        => :'Goz::Service',
+                  :after_add    => proc { |g, s| Goz::Event.group_service_add(g, s) },
+                  :after_remove => proc { |g, s| Goz::Event.group_service_remove(g, s) }
+
+
+    #
+    # Initialize new (non-persistent) Goz::Group object
+    #
+    def initialize(*params)
+      super
+      yield self if block_given?
+      self
+    end
+
+    #
+    # Compare equality.
+    #
+    def <=>(other)
+      if    self.display_name < other.display_name  ||
+            self.identifier   < other.identifier    ||
+            self.name         < other.name
+        -1
+      elsif self.display_name > other.display_name  ||
+            self.identifier   > other.identifier    ||
+            self.name         > other.name
+        1
+      else
+        0
+      end
+    end
+
+    #
+    # Create Goz::Group or raise +RuntimeError+
+    #
+    def self.create( params = {} )
+      params = {} unless params.kind_of?(Hash)
+      [ :display_name, :identifier, :name ].each do |k|
+        raise( "invalid #{k.to_s}" ) if ( params[k].nil? || params[k].empty? )
+      end
+      super
+    end
+
+    #
+    # Find Goz::Group by name or return +nil+
+    #
+    def self.find_by_name(name)
+      self.find( :name => name )
+    end
+
+    #
+    # Synchronize group with external data sources (if relevant).
+    # 
+    def sync(force = false)
+      if force || synchronized_at.nil? || synchronized_at < ( Time.now - ( 1 * 60 * 60 ) ) # XXX
+        # XXX Synchronize group from remote source (if necessary)
+        # XXX Synchronize admins
+        # XXX Synchronize members
+        self.services.each { |s| self.sync_service(s, force) }
+        self.synchronized_at = Time.now
+        self.save
+        Goz::Event.group_sync(self)
+        return true
+      end
+      false
+    end
+
+    #
+    # Synchronize group service with external data soruces (if relevant).
+    # 
+    def sync_service(service, force = false )
+      Goz::GroupService.first( :group_id => self.id, :service_id => service.id ).sync(force)
+    end
+
+    #
+    # Perform model valiations.
+    #
+    def validate
+      super
+      validates_presence  [ :display_name, :identifier, :name ]
+      validates_type      Time, [ :created_at, :modified_at, :synchronized_at ]
+      validates_unique    [ :display_name, :identifier, :name ]
+    end
+                             
+
+    private
+
+    def after_destroy
+      super
+      Goz::Event.group_remove(self)
+    end
+
+    def after_create
+      super
+      Goz::Event.group_add(self)
+    end
+
+    def before_create
+      super
+      self.created_at ||= Time.now
+    end
+
+    def before_destroy
+      remove_all_members
+      remove_all_admins
+      remove_all_services
+    end
+
+    def before_update
+      super
+      self.modified_at = Time.now
+    end
+
+  end # class Group
+
+end # module Goz
+

data/lib/goz/group_service.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'goz/database'
+require 'goz/event'
+require 'goz/group_service'
+
+module Goz # :nodoc:
+ 
+  # 
+  # = Goz::GroupService - TODO
+  #   
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/goz/
+  #
+  class GroupService < Sequel::Model
+
+    #
+    # Synchronize group with external service.
+    # 
+    def sync(force = false)
+      if force || synchronized_at.nil? || synchronized_at < ( Time.now - ( 1 * 60 * 60 ) ) # XXX
+        # XXX Synchronize group from remote source (if necessary)
+        # XXX Synchronize admins
+        # XXX Synchronize members
+        self.synchronized_at = Time.now
+        self.save
+        Goz::Event.group_service_sync( Group[ self.group_id ], Service[ self.service_id ] )
+        return true
+      end
+      false
+    end
+
+  end
+
+end
+

data/lib/goz/service.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+
+require 'goz/database'
+require 'goz/event'
+
+
+module Goz # :nodoc:
+ 
+  # 
+  # = Goz::Service - Generic Goz service
+  #   
+  # == Usage
+  #
+  # TODO
+  #
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/goz/
+  #
+  class Service < Sequel::Model
+    include Comparable
+
+    plugin :validation_helpers
+
+    many_to_many  :groups,
+                  :left_key     => :service_id,
+                  :right_key    => :group_id,
+                  :join_table   => :group_services,
+                  :class        => :'Goz::Group',
+                  :after_add    => proc { |s, g| Goz::Event.group_service_add(g, s) },
+                  :after_remove => proc { |s, g| Goz::Event.group_service_remove(g, s) }
+
+    #
+    # Initialize new (non-persistent) Goz::Event object
+    #
+    def initialize(*params)
+      super
+      yield self if block_given?
+      self
+    end
+
+
+    #
+    # Compare equality.
+    #
+    def <=>(other)
+      if    self.name   < other.name  ||
+            self.klass  < other.klass
+        -1
+      elsif self.name   > other.name  ||
+            self.klass  > other.klass
+        1
+      else
+        0
+      end
+    end
+
+    #
+    # Create Goz::Service or raise +RuntimeError+
+    #
+    def self.create( params = {} )
+      params = {} unless params.kind_of?(Hash)
+      [ :name, :klass ].each do |k|
+        raise( "invalid #{k.to_s}" ) if ( params[k].nil? || params[k].empty? )
+      end
+      super
+    end
+
+    #
+    # Find Goz::Service by name or return +nil+
+    #
+    def self.find_by_name(name)
+      self.find( :name => name )
+    end
+
+    #
+    # Synchronize service with external data sources (if relevant).
+    # 
+    def sync(force = false)
+      if force || synchronized_at.nil? || synchronized_at < ( Time.now - ( 1 * 60 * 60 ) ) # XXX
+        # XXX Synchronize service from remote source (if necessary)
+        # XXX Synchronize groups
+        # XXX Synchronize group admins
+        # XXX Synchronize group members
+        self.synchronized_at = Time.now
+        self.save
+        Goz::Event.service_sync(self)
+        return true
+      end
+      false
+    end
+
+    #
+    # Perform model valiations.
+    #
+    def validate
+      super
+      validates_presence  [ :name, :klass ]
+      validates_type      Time, [ :created_at, :modified_at, :synchronized_at ]
+    end
+    
+    
+    private                          
+
+    def after_destroy
+      super
+      Goz::Event.service_remove self
+    end
+
+    def after_create
+      super
+      Goz::Event.service_add self
+    end
+
+    def before_create
+      super
+      self.created_at ||= Time.now
+    end
+
+    def before_destroy
+      super
+      remove_all_groups
+    end
+
+    def before_update
+      super
+      self.modified_at = Time.now
+    end
+
+  end # class Service
+
+end # module Goz
+

data/lib/goz/test_case.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'goz/database'
+require 'test/unit'
+
+
+module Goz # :nodoc:
+ 
+  # 
+  # = Goz::TestCase - Goz test case.
+  #   
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/goz/
+  #
+  class TestCase < Test::Unit::TestCase
+
+    def setup
+      super
+      Goz::Database.instance do |db|
+        [ :admins, :events, :group_services, :members ].each { |t| db[t].delete }
+        [ :groups, :services, :users ].each { |t| db[t].delete }
+      end
+
+      @groups = {
+        :a => { :display_name => 'Group:A', :identifier => 'c6347f2a0375db1e2ebfe0ad70e24172a3193037', :name => 'gA' },
+        :b => { :display_name => 'Group:B', :identifier => '341af322e54bea31f8d08d4f2c627a4db341781a', :name => 'gB' }
+      }
+
+      @services = {
+        :a => { :name => 'Service A', :klass => 'Goz::Service' },
+        :b => { :name => 'Service B', :klass => 'Goz::Service' }
+      }
+
+      @users = {
+        :a => { :email => 'a@example.org', :login => 'uA', :identifier => '40b071bd23a8fd2b8cff7f59da9211dca7806d47', :name => 'User A' },
+        :b => { :email => 'b@example.org', :login => 'uB', :identifier => '40b071bd23a8fd2b8cff7f59da9211dca7806d47', :name => 'User B' }
+      }
+    end
+
+  end # class TestCase
+
+end # module Goz
+

data/lib/goz/user.rb

@@ -0,0 +1,164 @@
+# encoding: utf-8
+
+require 'goz/database'
+require 'goz/event'
+
+module Goz # :nodoc:
+ 
+  # 
+  # = Goz::User - Generic Goz user
+  #   
+  # == Usage
+  #
+  #   require 'goz/user'
+  #
+  #   u = Goz::User.find_by_login(login)
+  #   unless u
+  #     u = Goz::User.create( :email      => email,
+  #                           :identifier => identifier,
+  #                           :login      => login, 
+  #                           :name       => name
+  #                         )
+  #   end
+  #   u.email       # => 'user1@example.org'
+  #   u.identifier  # => <some unique identifier>
+  #   u.login       # => 'user1'
+  #   u.name        # => 'User Number One'
+  #   u.created_at  # => '2012-03-23 14:58:02 -0500'
+  #  
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/goz/
+  #
+  class User < Sequel::Model
+    include Comparable
+
+    plugin :validation_helpers
+
+    many_to_many  :groups,
+                  :left_key     => :user_id,
+                  :right_key    => :group_id,
+                  :join_table   => :admins,
+                  :class        => :'Goz::Group',
+                  :after_add    => proc { |u, g| Goz::Event.admin_add(g, u) },
+                  :after_remove => proc { |u, g| Goz::Event.admin_remove(g, u) }
+    many_to_many  :memberships,
+                  :left_key     => :user_id,
+                  :right_key    => :group_id,
+                  :join_table   => :members,
+                  :class        => :'Goz::Group',
+                  :after_add    => proc { |u, g| Goz::Event.member_add(g, u) },
+                  :after_remove => proc { |u, g| Goz::Event.member_remove(g, u) }
+
+
+    #
+    # Initialize new (non-persistent) Goz::User object
+    #
+    def initialize(*params)
+      super
+      yield self if block_given?
+      self
+    end
+
+    #
+    # Compare equality.
+    #
+    def <=>(other)
+      if    self.login      < other.login       ||
+            self.email      < other.email       ||
+            self.name       < other.name        ||
+            self.identifier < other.identifier
+        -1
+      elsif self.login      > other.login       ||
+            self.email      > other.email       ||
+            self.name       > other.name        ||
+            self.identifier > other.identifier
+        1
+      else
+        0
+      end
+    end
+
+    #
+    # Create Goz::User or raise +RuntimeError+
+    #
+    def self.create( params = {} )
+      params = {} unless params.kind_of?(Hash)
+      [ :email, :identifier, :login, :name ].each do |k|
+        raise( "invalid #{k.to_s}" ) if ( params[k].nil? || params[k].empty? )
+      end
+      super
+    end
+
+    #
+    # Find Goz::User by login or return +nil+
+    #
+    def self.find_by_login(login)
+      Goz::Database.instance do |db|
+        return User.find( :login => login )
+      end
+    end
+
+    #
+    # Synchronize user with external data sources (if relevant).
+    # 
+    def sync(force = false)
+      if force || synchronized_at.nil? || synchronized_at < ( Time.now - ( 1 * 60 * 60 ) ) # XXX
+        # XXX Synchronize user with remote source (if necessary)
+        # XXX Synchronize groups
+        # XXX Synchronize memberships
+        self.synchronized_at = Time.now
+        self.save
+        Goz::Event.user_sync(self)
+        return true
+      end
+      false
+    end
+
+    #
+    # Perform model valiations.
+    #
+    def validate
+      super
+      validates_presence  [ :email, :identifier, :login, :name ]
+      validates_type      Time, [ :created_at, :modified_at, :synchronized_at ]
+      validates_unique    [ :email, :identifier, :login ]
+    end
+    
+    
+    private                          
+
+    def after_destroy
+      super
+      Event.create :event_type_id => Goz::EventType::USER_REMOVE, :user_id => self.id
+    end
+
+    def after_create
+      super
+      Event.create :event_type_id => Goz::EventType::USER_ADD, :user_id => self.id
+    end
+
+    def before_create
+      super
+      self.created_at ||= Time.now
+    end
+
+    def before_destroy
+      super
+      remove_all_memberships
+      remove_all_groups
+    end
+
+    def before_update
+      super
+      self.modified_at = Time.now
+    end
+
+  end # class User
+
+end # module Goz
+