goz 0.0.2 → 0.0.3

data/HISTORY.rdoc

@@ -1,10 +1,16 @@
 = Goz History
 
+== 2012-04-30 v0.0.3
+
+* Added +Goz::Database+
+* Added +Goz::Group+
+* Added +Goz::Service+
+* Added +Goz::User+
+
 == 2012-03-08 v0.0.2
 
 * Added +Goz::Cache+
 
-
 == 2012-03-02 v0.0.1
 
 * First public release

data/README.rdoc

@@ -17,7 +17,7 @@
 
 == See Also
 
-Goz::Cache, Goz::Logger
+Goz::Cache, Goz::Group, Goz::Logger, Goz::User
 
 == Author
 

data/goz.gemspec

@@ -18,11 +18,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rdoc'
-  s.add_development_dependency 'rdoc-readme', '~> 0.1.2'
-  s.add_development_dependency 'simplecov'
+  s.add_runtime_dependency  'sequel'
+
+  s.add_development_dependency  'rake'
+  s.add_development_dependency  'rdoc'
+  s.add_development_dependency  'rdoc-readme',  '~> 0.1.2'
+  s.add_development_dependency  'simplecov'
+  s.add_development_dependency  'sqlite3'
 end
+

data/lib/goz.rb

@@ -1,7 +1,12 @@
 # encoding: utf-8
 
 require 'goz/cache'
+require 'goz/event'
+require 'goz/event_type'
+require 'goz/group'
 require 'goz/logger'
+require 'goz/service'
+require 'goz/user'
 require 'goz/version'
 
 # 
@@ -24,7 +29,7 @@ require 'goz/version'
 #
 # == See Also
 #
-# Goz::Cache, Goz::Logger
+# Goz::Cache, Goz::Group, Goz::Logger, Goz::User
 #
 # == Author
 #

data/lib/goz/cache/hash_store.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-module Goz # :nodoc:
-  class Cache # :nodoc
+module Goz    # :nodoc:
+  class Cache # :nodoc:
 
     #
     # = Goz::Cache::HashStore - Hash-based cache implementation.

data/lib/goz/database.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'sequel'
+require 'goz/database/migrations'
+
+module Goz # :nodoc:
+ 
+  # 
+  # = Goz::Database - Goz persistence layer.
+  #   
+  # == Usage
+  #
+  #   require 'goz/database'
+  #
+  #   # Get Sequel connection
+  #   Goz::Database.instance do |db|
+  #     ... do database stuff ...
+  #   end
+  #
+  # == Environment
+  #
+  # If +GOZ_DATABASE_URL+ is not set in your environment, an in-memory SQLite database will be
+  # used.
+  #
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/goz/
+  #
+  class Database
+
+    #
+    # Sequel database instance
+    #
+    DB = ENV['GOZ_DATABASE_URL'] ? Sequel.connect( ENV['GOZ_DATABASE_URL'] ) : Sequel.sqlite
+    Goz::Database::Migrations.migrate!
+
+
+    #
+    # Get database instance
+    #
+    def self.instance
+      yield DB if block_given?
+      DB
+    end
+
+  end
+
+end # module Goz
+

data/lib/goz/database/migrations.rb

@@ -0,0 +1,171 @@
+# encoding: utf-8
+
+module Goz        # :nodoc:
+  class Database  # :nodoc:
+
+    #
+    # = Goz::Database::Migrations - Database Migrations
+    #
+    # == See Also
+    #
+    # Goz::Database
+    #
+    # == Author
+    #
+    # blair christensen. <mailto:blair.christensen@gmail.com>
+    #
+    # == Homepage
+    #
+    # https://github.com/blairc/goz/
+    #
+    class Migrations 
+
+      #
+      # Perform database migrations.
+      #
+      def self.migrate!
+        Sequel.extension :migration
+
+        # TODO Split!
+        Sequel.migration do
+          change do
+            DB.create_table(:groups) do
+              primary_key :id
+              String      :display_name,    :null => false
+              String      :identifier,      :null => false
+              String      :name,            :null => false
+              timestamp   :created_at,      :null => false
+              timestamp   :modified_at
+              timestamp   :synchronized_at
+
+              index :display_name,  :unique => true
+              index :identifier,    :unique => true
+              index :login,         :unique => true
+            end
+          end
+        end
+
+        Sequel.migration do
+          change do
+            DB.create_table(:services) do
+              primary_key :id
+              String      :name,            :null => false
+              String      :klass,           :null => false
+              timestamp   :created_at,      :null => false
+              timestamp   :modified_at
+              timestamp   :synchronized_at
+
+              index :name, :unique => true
+            end
+          end
+        end
+
+        Sequel.migration do
+          change do
+            DB.create_table(:users) do
+              primary_key :id
+              String      :email,           :null => false
+              String      :identifier,      :null => false
+              String      :login,           :null => false
+              String      :name,            :null => false
+              timestamp   :created_at,      :null => false
+              timestamp   :modified_at
+              timestamp   :synchronized_at
+
+              index :email,       :unique => true
+              index :identifier,  :unique => true
+              index :login,       :unique => true
+            end
+          end
+        end
+
+        Sequel.migration do
+          change do
+            DB.create_table(:admins) do
+              foreign_key :group_id,    :groups
+              foreign_key :user_id,     :users
+
+              index [ :group_id, :user_id ], :unique => true
+            end
+          end
+        end
+
+        Sequel.migration do
+          change do
+            DB.create_table(:members) do
+              foreign_key :group_id,    :groups
+              foreign_key :user_id,     :users
+
+              index [ :group_id, :user_id ], :unique => true
+            end
+          end
+        end
+
+        Sequel.migration do
+          change do
+            DB.create_table(:group_services) do
+              primary_key :id
+              foreign_key :group_id,        :groups
+              foreign_key :service_id,      :services
+              timestamp   :synchronized_at
+
+              index [ :group_id, :service_id ], :unique => true
+            end
+          end
+        end
+
+        Sequel.migration do
+          change do
+            DB.create_table(:event_types) do
+              primary_key :id
+              String      :name
+              timestamp   :created_at,  :null => false
+
+              index :name, :unique => true
+            end
+          end
+        end
+
+        Sequel.migration do
+          change do
+            event_types = DB[:event_types]
+            # TODO More to add
+            %w( admin_add         admin_remove
+                group_add         group_remove          group_sync
+                group_service_add group_service_remove  group_service_sync
+                member_add        member_remove
+                service_add       service_remove        service_sync
+                user_add          user_remove           user_sync
+            ).each do |type|
+              event_types.insert( :name => type, :created_at => Time.now )
+            end
+          end
+        end
+
+        Sequel.migration do
+          change do
+            DB.create_table(:events) do
+              primary_key :id
+              Integer :event_type_id,   :null => false
+              Integer :group_id,        :null => true
+              Integer :service_id,      :null => true
+              Integer :user_id,         :null => true
+              # TODO Some sort of boolean or enum completion status?
+              timestamp   :created_at,  :null => false
+              # TODO Some sort of completed_at timestamp?
+
+              index :event_type_id
+              index :group_id
+              index :service_id
+              index :user_id
+            end
+          end
+        end
+
+      end
+
+    end # class Migrations
+
+  end # class Database
+end   # module Goz
+

data/lib/goz/event.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+
+require 'goz/database'
+require 'goz/event_type'
+
+module Goz # :nodoc:
+ 
+  # 
+  # = Goz::Event - Goz event
+  #   
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/goz/
+  #
+  class Event < Sequel::Model
+
+    plugin :validation_helpers
+
+
+    #
+    # Initialize new (non-persistent) Goz::Event object
+    #
+    def initialize(*params)
+      super
+      yield self if block_given?
+      self
+    end
+
+    def self.admin_add(group, user)
+      self.create( :event_type_id => Goz::EventType::ADMIN_ADD, :group_id => group.id, :user_id => user.id )
+    end
+
+    def self.admin_remove(group, user)
+      self.create( :event_type_id => Goz::EventType::ADMIN_REMOVE, :group_id => group.id, :user_id => user.id )
+    end
+
+    def self.group_add(group)
+      self.create :event_type_id => Goz::EventType::GROUP_ADD, :group_id => group.id
+    end
+
+    def self.group_remove(group)
+      self.create :event_type_id => Goz::EventType::GROUP_REMOVE, :group_id => group.id
+    end
+
+    def self.group_sync(group)
+      self.create :event_type_id => Goz::EventType::GROUP_SYNC, :group_id => group.id
+    end
+
+    def self.group_service_add(group, service)
+      self.create( :event_type_id => Goz::EventType::GROUP_SERVICE_ADD, :group_id => group.id, :service_id => service.id )
+    end
+
+    def self.group_service_remove(group, service)
+      self.create( :event_type_id => Goz::EventType::GROUP_SERVICE_REMOVE, :group_id => group.id, :service_id => service.id )
+    end
+
+    def self.group_service_sync(group, service)
+      self.create( :event_type_id => Goz::EventType::GROUP_SERVICE_SYNC, :group_id => group.id, :service_id => service.id )
+    end
+
+    def self.member_add(group, user)
+      self.create( :event_type_id => Goz::EventType::MEMBER_ADD, :group_id => group.id, :user_id => user.id )
+    end
+
+    def self.member_remove(group, user)
+      self.create( :event_type_id => Goz::EventType::MEMBER_REMOVE, :group_id => group.id, :user_id => user.id )
+    end
+
+    def self.service_add(service)
+      self.create( :event_type_id => Goz::EventType::SERVICE_ADD, :service_id => service.id )
+    end
+
+    def self.service_remove(service)
+      self.create( :event_type_id => Goz::EventType::SERVICE_REMOVE, :service_id => service.id )
+    end
+
+    def self.service_sync(service)
+      self.create( :event_type_id => Goz::EventType::SERVICE_SYNC, :service_id => service.id )
+    end
+
+    def self.user_sync(user)
+      self.create( :event_type_id => Goz::EventType::USER_SYNC, :user_id => user.id )
+    end
+
+    #
+    # Perform model valiations.
+    #
+    def validate
+      super
+      validates_presence  :event_type_id
+      validates_type      Integer, [ :event_type_id, :group_id, :service_id, :user_id ]
+    end
+    
+    
+    private                          
+
+    def before_create
+      super
+      self.created_at ||= Time.now
+    end
+
+  end # class Event
+
+end # module Goz
+

data/lib/goz/event_type.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'goz/database'
+
+module Goz # :nodoc:
+ 
+  # 
+  # = Goz::EventType - Goz event type
+  #   
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/goz/
+  #
+  class EventType < Sequel::Model
+
+    plugin :validation_helpers
+
+    TYPES = EventType.to_hash(:name, :id)
+    TYPES.each_pair { |k, v| const_set k.upcase.to_s, v }
+
+
+    #
+    # Perform model valiations.
+    #
+    def validate
+      super
+      validates_presence  [ :name ]
+      validates_type      Time, [ :created_at ]
+      validates_unique    [ :name ]
+    end
+    
+    
+    private                          
+
+    def before_create
+      super
+      self.created_at ||= Time.now
+    end
+
+  end # class EventType
+
+end # module Goz
+