ki 0.4.2 → 0.4.3

data/lib/ki/modules/public_file_helper.rb

@@ -1,13 +1,17 @@
 module Ki
-  module PublicFileHelper
-    def public_file_exists? path
-      path = path.path if path.class == BaseRequest
-      File.file?(public_file_path(path))
-    end
+  module Middleware
+    module Helpers
+      module PublicFile
+        def public_file_exists? path
+          path = path.path if path.class == BaseRequest
+          File.file?(public_file_path(path))
+        end
 
-    def public_file_path path
-      path = path.path if path.class == BaseRequest
-      File.join(Ki::PUBLIC_PATH, path)
+        def public_file_path path
+          path = path.path if path.class == BaseRequest
+          File.join(Ki::PUBLIC_PATH, path)
+        end
+      end
     end
   end
 end

data/lib/ki/modules/query_interface.rb

@@ -1,36 +1,38 @@
 module Ki
-  # the query interface does not respect before/after filters,
-  # unique attributes, required attributes or anything of the
-  # sort.
-  # it writes directly to the database
-  module QueryInterface
-    def count hash={}
-      Orm::Db.instance.count class_name, hash
-    end
+  class Model
+    # the query interface does not respect before/after filters,
+    # unique attributes, required attributes or anything of the
+    # sort.
+    # it writes directly to the database
+    module QueryInterface
+      def count hash={}
+        Orm::Db.instance.count class_name, hash
+      end
 
-    def find hash={}
-      Orm::Db.instance.find class_name, hash
-    end
+      def find hash={}
+        Orm::Db.instance.find class_name, hash
+      end
 
-    def create hash
-      Orm::Db.instance.insert class_name, hash
-    end
+      def create hash
+        Orm::Db.instance.insert class_name, hash
+      end
 
-    def find_or_create hash
-      r = find hash
-      r.empty? ? create(hash) : r
-    end
+      def find_or_create hash
+        r = find hash
+        r.empty? ? create(hash) : r
+      end
 
-    def update hash
-      Orm::Db.instance.update class_name, hash
-    end
+      def update hash
+        Orm::Db.instance.update class_name, hash
+      end
 
-    def delete hash
-      Orm::Db.instance.delete class_name, hash
-    end
+      def delete hash
+        Orm::Db.instance.delete class_name, hash
+      end
 
-    def class_name
-      self.to_s
+      def class_name
+        self.to_s
+      end
     end
   end
 end

data/lib/ki/modules/restrictions.rb

@@ -1,47 +1,49 @@
 module Ki
-  module Restrictions
-    def forbidden_actions
-      []
-    end
+  class Model
+    module Restrictions
+      def forbidden_actions
+        []
+      end
+
+      def forbid *actions
+        send :define_method, :forbidden_actions do
+          actions
+        end
 
-    def forbid *actions
-      send :define_method, :forbidden_actions do
-        actions
+        eigen_class = class << self; self; end
+        eigen_class.send(:define_method, :forbidden_actions) do
+          actions
+        end
       end
 
-      eigen_class = class << self; self; end
-      eigen_class.send(:define_method, :forbidden_actions) do
-        actions
+      def required_attributes
+        []
       end
-    end
 
-    def required_attributes
-      []
-    end
+      def requires *attributes
+        send :define_method, :required_attributes do
+          attributes
+        end
 
-    def requires *attributes
-      send :define_method, :required_attributes do
-        attributes
+        eigen_class = class << self; self; end
+        eigen_class.send(:define_method, :required_attributes) do
+          attributes
+        end
       end
 
-      eigen_class = class << self; self; end
-      eigen_class.send(:define_method, :required_attributes) do
-        attributes
+      def unique_attributes
+        []
       end
-    end
-
-    def unique_attributes
-      []
-    end
 
-    def unique *attributes
-      send :define_method, :unique_attributes do
-        attributes
-      end
+      def unique *attributes
+        send :define_method, :unique_attributes do
+          attributes
+        end
 
-      eigen_class = class << self; self; end
-      eigen_class.send(:define_method, :unique_attributes) do
-        attributes
+        eigen_class = class << self; self; end
+        eigen_class.send(:define_method, :unique_attributes) do
+          attributes
+        end
       end
     end
   end

data/lib/ki/modules/view_helper.rb

@@ -1,13 +1,17 @@
 module Ki
-  module ViewHelper
-    def view_exists? path
-      path = path.path if path.class == BaseRequest
-      File.file?(view_path(path))
-    end
+  module Middleware
+    module Helpers
+      module View
+        def view_exists? path
+          path = path.path if path.class == BaseRequest
+          File.file?(view_path(path))
+        end
 
-    def view_path path
-      path = path.path if path.class == BaseRequest
-      File.join(Ki::VIEWS_PATH, path + ".haml")
+        def view_path path
+          path = path.path if path.class == BaseRequest
+          File.join(Ki::VIEWS_PATH, path + ".haml")
+        end
+      end
     end
   end
 end

data/lib/ki/orm.rb

@@ -1,37 +1,122 @@
 require 'singleton'
 
 module Ki
-  module Orm
+  module Orm #:nodoc:
+    # This singleton class establishes the database connection and CRUD
+    # operations.
+    #
+    # == Connecting
+    #
+    #   Db.instance.establish_connection
+    #
+    # == Queries
+    #
+    #   db = Db.instance
+    #   db.find 'users', {}
+    #   db.find 'users', { name: 'Homer' }
+    #
     class Db
       include Singleton
 
       attr_reader :config, :connection, :db
 
+      # Creates the mongo connection.
+      #
+      # It first checks if the env variable "MONGODB_URI" is set. The required
+      # format: http://docs.mongodb.org/manual/reference/connection-string/
+      #
+      # If the env variable is not set, it will use the information stored in
+      # config.yml.
+      #
       def establish_connection
         @config = KiConfig.instance.database
         if ENV["MONGODB_URI"]
           @connection = Mongo::Connection.new
+          @db = @connection.db
         else
           @connection = Mongo::Connection.new(@config['host'], @config['port'])
+          @db = @connection.db(@config['name'])
         end
-        @db = @connection.db(@config['name'])
         self
       end
 
+      # ==== Returns
+      #
+      # An array of all the collection names in the database.
+      #
       def collection_names
         @db.collection_names.delete_if{|name| name =~ /^system/}
       end
 
+      # Insert a hash in the database.
+      #
+      # ==== Attributes
+      #
+      # * +name+ - the mongo collection name
+      # * +hash+ - the hash which will be inserted
+      #
+      # ==== Returns
+      #
+      # The inserted hash.
+      #
+      # * +:conditions+ - An SQL fragment like "administrator = 1"
+      #
+      # ==== Examples
+      #
+      #   db = Db.instance
+      #   db.insert 'users', { name: 'Homer' }
+      #
       def insert name, hash
         @db[name].insert(hash)
         [hash].stringify_ids.first
       end
 
+      # Find a hash in the database
+      #
+      # ==== Attributes
+      #
+      # * +name+ - the mongo collection name
+      #
+      # ==== Options
+      #
+      # * +:hash+ - Filter by specific hash attributes
+      #
+      # ==== Returns
+      #
+      # An array of hashes which match the query criteria
+      #
+      # ==== Examples
+      #
+      #   db = Db.instance
+      #   db.find 'users'
+      #   db.find 'users', { id: 'id' }
+      #   db.find 'users', { name: 'Homer' }
+      #
       def find name, hash={}
         hash = nourish_hash_id hash
         @db[name].find(hash).to_a.stringify_ids
       end
 
+      # Update a hash from the database
+      #
+      # The method will update the hash obj with the id specified in the hash
+      # attribute.
+      #
+      # ==== Attributes
+      #
+      # * +name+ - the mongo collection name
+      # * +hash+ - requires at least the id of the hash which needs to be
+      #            updated
+      #
+      # ==== Returns
+      #
+      # The updated hash
+      #
+      # ==== Examples
+      #
+      #  db = Db.instance
+      #  db.update('users', { id: 'id', name: 'Sir Homer' })
+      #
       def update name, hash
         hash = nourish_hash_id hash
         id = hash['_id'].to_s
@@ -41,12 +126,50 @@ module Ki
         hash
       end
 
+      # Deletes a hash from the database
+      #
+      # ==== Attributes
+      #
+      # * +name+ - the mongo collection name
+      # * +:hash+ - Filter by specific hash attributes. id required
+      #
+      # ==== Returns
+      #
+      # Empty hash
+      #
+      # ==== Examples
+      #
+      #   db = Db.instance
+      #   db.delete 'users', { id: 'id' }
+      #   db.delete 'users', {}
+      #
       def delete name, hash
         hash = nourish_hash_id hash
         @db[name].remove hash
         {}
       end
 
+      # Count the number of hashes found in a specified collection, filtered
+      # by a hash attribute
+      #
+      # ==== Attributes
+      #
+      # * +name+ - the mongo collection name
+      #
+      # ==== Options
+      #
+      # * +hash+ - used for filtering
+      #
+      # ==== Returns
+      #
+      # The number of objects found.
+      #
+      # ==== Examples
+      #
+      #   db = Db.instance
+      #   db.count 'users'
+      #   db.count 'users', { name: 'Homer' }
+      #
       def count name, hash={}
         @db[name].count hash
       end

data/lib/ki/version.rb

@@ -1,3 +1,3 @@
 module Ki 
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/spec/examples/base/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.1.2

data/spec/examples/base/Gemfile

@@ -1,4 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gem 'ki'
-gem 'passenger'

data/spec/examples/couch-lock/Gemfile

@@ -1,4 +1,3 @@
 source "https://rubygems.org"
 
 gem 'ki', :path => '../../..'
-gem 'passenger'

data/spec/examples/couch-lock/app.rb

@@ -8,6 +8,13 @@ end
 
 module Ki
   module Helpers
+    def wiki_defaults
+      base = Wiki.count base: "1"
+      if base == 0
+        Wiki.create({ title: "wiki", body: "", base: "1" })
+      end
+    end
+
     def display_status
       res = run "xrandr | head -n 1 | awk '{ print $8 }'"
       res.strip.to_i == 1920 ? 'cloned' : 'extended'
@@ -30,6 +37,43 @@ module Ki
   end
 end
 
+class Wiki < Ki::Model
+  requires :title, :body
+end
+
+class Items < Ki::Model
+  requires :name, :qty
+end
+
+class Radio < Ki::Model
+  forbid :create, :update, :delete
+
+  def after_find
+    return if params["q"].nil?
+    return unless ['rockfm'].include? params["q"]
+
+    run "vlc http://80.86.106.35:800/"
+  end
+end
+
+class Volume < Ki::Model
+  forbid :create, :update, :delete
+
+  def after_find
+    return if params["q"].nil?
+    return unless ['up', 'down', 'manager'].include? params["q"]
+
+    case params["q"]
+    when 'up'
+      run "amixer -D pulse sset Master 5%+"
+    when 'down'
+      run "amixer -D pulse sset Master 5%-"
+    when 'manager'
+      run "gnome-control-center sound &"
+    end
+  end
+end
+
 class Monitors < Ki::Model
   forbid :create, :update, :delete
 
@@ -41,6 +85,14 @@ class Monitors < Ki::Model
   end
 end
 
+class Ring < Ki::Model
+  forbid :create, :update, :delete
+
+  def after_find
+    run "aplay public/doorbell-1.wav &"
+  end
+end
+
 class Fireplace < Ki::Model
   forbid :create, :update, :delete