ki 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d3882f219cbe5267ace949b299161f8d7088de4
-  data.tar.gz: dbd684f59faf3cb6ed83dcce014f7f6c024bd4b9
+  metadata.gz: fecab0fa4fb36ca609b3858125f8966cb2c83b24
+  data.tar.gz: 374608a0b13d1bce947ac0e8d42facc78b7fa5dd
 SHA512:
-  metadata.gz: 906832115b4f414a7c78d00ca31bc9bcd4b1a1eb5f7e18e5f341a7794c364b6caf2738b9ae123b6a4afbca4d0328342512c66e3e38e920cacdf4fc34806015db
-  data.tar.gz: 54f9f057d005f7ce0697b4584b3af94ceb5f0bcfdccb5d14282d19f1eeaa61dc9ceeb70a0c0179ded589898ca015f02b5ecc59b78e0e3628b9a8ce47e737af53
+  metadata.gz: 142a52569d62b87646811ee4f2ab16d7dc397427f495aaca1a8369d2d3632d7bd4f91fd50623114a94b8d57e265faf142b70fa29a6f1a719f3b1f9d9a8e16681
+  data.tar.gz: a75db7d74e8e7e816efa78ea57a573a613285e8bbea0f844f7006f69256ebc3e9136c46b035fac074d938ff36597ae8271cbcf32a6c68fd61d5ea65af425a074

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ki (0.4.1)
+    ki (0.4.2)
       bson_ext
       bundler (~> 1.5)
       coffee-script

data/README.md

@@ -1,12 +1,37 @@
 # Ki Framework
 
-Tiny REST JSON ORM framework
+Tiny REST JSON ORM framework.
 
-* rvm
-* mongodb
-* haml
-* sass
-* coffee
+Ki's goal is to help you protoype your ideas blazing fast. It has a db backend
+and provides a fullblown REST api on top.
+
+## TLDR
+
+To create an api endpoint '/todo.json' with GET/POST/PATCH and restricting
+DELETE, with title and description as required attributes, with db backend,
+with a unique title, and before/after filters you would need to write:
+
+```ruby
+class Todo < Ki::Model
+  requires :title, :description
+  unique :title
+  forbid :delete
+
+  def before_all
+    puts 'hello'
+  end
+
+  def before_create
+    params['created_at'] = Time.now.to_i
+  end
+
+  def after_find
+    if result['keywords'].include? 'food'
+      puts 'yummy'
+    end
+  end
+end
+```
 
 ## Install
 
@@ -16,20 +41,42 @@ gem install ki
 
 ## Getting started
 
+Learn by example. We will create the traditional 'hello world' app for web
+development: the dreaded TODO app.
+
+View the [code](https://github.com/mess110/ki/tree/master/spec/examples/todo) for
+the final webapp.
+
 ### Creating a new app
 
 ```shell
-ki new my-app
-cd my-app
-bundle
+ki new todo
 ```
 
-This will create the folder *my-app* containing a bare bones ki application.
+This will create the folder *todo* containing a bare bones ki application. Your
+app will look [like this](https://github.com/mess110/ki/tree/master/spec/examples/base).
+
+App directory structure:
+
+* public/
+  * javascripts/
+  * stylesheets/
+* views/
+* app.rb
+* config.yml
+
+The entry point for the app is *app.rb*. You will add most of your code there.
+Views are in the *views* folder and you can find some database info in
+*config.yml*.
 
 ```shell
+cd todo
+bundle
 rackup
 ```
 
+*rackup* is the command which starts the webserver. The port will be displayed.
+
 ### Adding a view
 
 A view is a html page. By default, a view called 'index.haml' is created for
@@ -48,16 +95,178 @@ similar to haml.
 
 ### View layout
 
-TODO
+If the file *views/layout.haml* exists, it will be used as a layout for all the
+other haml files. The content of the route will be placed in the layout *yield*
+
+*views/layout.haml*
+
+```haml
+!!!
+%html
+  %head
+    %title Ki Framework
+  %body
+    = yield
+```
+
+*views/index.haml*
+
+```haml
+%p Hello World!
+```
+
+### Helpers
+
+To reduce complexity in your views, you can use helpers. Here we create a
+*say_hello* method which we can use in *views/index.haml*.
+
+*app.rb*
+
+```ruby
+module Ki::Helpers
+  def say_hello
+    'hello'
+  end
+end
+```
+
+*views/index.haml*
+
+```haml
+%p= say_hello
+```
 
 ### Adding a resource
 
-TODO
+Think of resources as the M in MVC. Except they also have routes attached.
+All resources must inherit from Ki::Model. For example, to create a todo model
+add the fallowing snippet to *app.rb*
+
+```ruby
+class Todo < Ki::Model
+end
+```
+
+This will create the Todo resource and its corresponding routes. Each route is
+mapped to a model method.
+
+Method name | Verb | HTTP request|Required params|
+------------|------|-------------|---------------|
+find        |GET   | /todo.json  |               |
+create      |POST  | /todo.json  |               |
+update      |PATCH | /todo.json  |id             |
+delete      |DELETE| /todo.json  |id             |
+
+Below is a curl example for creating a todo item. Notice the data sent in the
+body request is a JSON string. It can take the shape of any valid JSON object.
+All json objects will be stored in the database under the resource name. In our
+case *todo*.
+
+#### Create
+
+```shell
+curl -X POST -d '{"title": "make a todo tutorial"}' http://localhost:9292/todo.json
+```
+
+#### Get all
+
+```shell
+curl -X GET http://localhost:9292/todo.json
+```
+
+#### Get by id
+
+```shell
+curl -X GET http://localhost:9292/todo.json?id=ITEM_ID
+```
+
+#### Update
+
+```shell
+curl -X PATCH -d '{"id": "ITEM_ID", "title": "finish the todo tutorial"}' http://localhost:9292/todo.json
+```
+
+#### Delete
+
+```shell
+curl -X DELETE -d http://localhost:9292/todo.json?id=ITEM_ID
+```
+
+### Required attributes
+
+You can add mandatory attributes on resources with the *requires* method. It
+takes one parameter or an array of parameters as an argument.
+
+```ruby
+class Todo < Ki::Model
+  requires :title
+end
+```
+
+This will make sure a Todo item can not be saved or updated in the database
+without a title attribute.
 
 ### Restricting resource requests
 
-TODO
+Let's say you want to forbid access to deleting items. You can do that with
+the *forbid* method.
+
+```ruby
+class Todo < Ki::Model
+  forbid :delete
+end
+```
+
+### Before/after callbacks
+
+The framework has [these callbacks](https://github.com/mess110/ki/blob/master/lib/ki/modules/callbacks.rb).
+Here is an example on how to use them:
+
+```ruby
+class Todo < Ki::Model
+  def before_create
+    # do your stuff
+  end
+end
+```
+
+#### Accessing the json object within a callback
+
+Before the request is sent to the client, you can look at the result through
+the *result* method. Modifying it will change what the client receives.
+
+```ruby
+class Todo < Ki::Model
+  def after_find
+    puts result
+  end
+end
+```
+
+### Exceptions
+
+A list of exceptions can be found [here](https://github.com/mess110/ki/blob/master/lib/ki/api_error.rb)
+
+```ruby
+class Todo < Ki::Model
+  def before_all
+    ensure_authroization
+  end
+
+  private
+
+  def ensure_authorization
+    if params[:key] = 'secret-key'
+      raise UnauthorizedError.new
+    end
+  end
+end
+```
+
+## Deploy
 
-### Before/after filters
+It has a *config.ru* file. Ki is based on *rack*. You can deploy anywhere (ex:
+nginx, thin, apache, webrick).
 
-TODO
+In the webserver config, just remember to point the virtual host to the
+*public* directory.

data/ki.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["mess110@gmail.com"]
   spec.summary       = %q{it said optional}
   spec.description   = %q{it said optional}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/mess110/ki"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -28,7 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "mongo"
   spec.add_runtime_dependency "bson_ext"
 
-
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "rspec"

data/lib/ki.rb

@@ -19,6 +19,7 @@ require 'ki/modules/view_helper'
 require 'ki/modules/format_of'
 require 'ki/modules/public_file_helper'
 
+require 'ki/indifferent_hash'
 require 'ki/ki_config'
 require 'ki/helpers'
 require 'ki/orm'

data/lib/ki/api_error.rb

@@ -16,8 +16,13 @@ module Ki
   class RequiredAttributeMissing < ApiError; end
   class AttributeNotUnique < ApiError; end
   class ForbiddenAction < ApiError
-    def initialize
-      super 'action forbidden', 400
+    def initialize s='forbidden', code=403
+      super s, code
+    end
+  end
+  class UnauthorizedError < ApiError
+    def initialize s='unauthroized', code=401
+      super s, code
     end
   end
   class PartialNotFoundError < ApiError

data/lib/ki/indifferent_hash.rb

@@ -0,0 +1,11 @@
+class IndifferentHash < Hash
+  def []=(key,val)
+    key = key.to_sym
+    super(key, val)
+  end
+
+  def [](*args)
+    args[0] = args[0].to_sym
+    super(*args)
+  end
+end

data/lib/ki/orm.rb

@@ -9,7 +9,11 @@ module Ki
 
       def establish_connection
         @config = KiConfig.instance.database
-        @connection = Mongo::Connection.new(@config['host'], @config['port'])
+        if ENV["MONGODB_URI"]
+          @connection = Mongo::Connection.new
+        else
+          @connection = Mongo::Connection.new(@config['host'], @config['port'])
+        end
         @db = @connection.db(@config['name'])
         self
       end

data/lib/ki/version.rb

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

data/spec/examples/couch-lock/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    ki (0.4.0)
+    ki (0.4.1)
       bson_ext
       bundler (~> 1.5)
       coffee-script

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

@@ -1,5 +1,35 @@
 require 'ki'
 
+def run cmd
+  res = `DISPLAY=:0.0 #{cmd}`
+  puts res
+  res
+end
+
+module Ki
+  module Helpers
+    def display_status
+      res = run "xrandr | head -n 1 | awk '{ print $8 }'"
+      res.strip.to_i == 1920 ? 'cloned' : 'extended'
+    end
+
+    def vlc_running?
+      res = run "ps -ef | grep vlc | grep -v grep | head -n 1"
+      res.strip != ""
+    end
+
+    def couch_lock_running?
+      res = run "ps -ef | grep lockserver.UDPServer | grep -v grep | head -n 1"
+      res.strip != ""
+    end
+
+    def sound_output
+      res = run "pactl info | grep 'Default Sink' | grep hdmi"
+      res.strip == "" ? 'analog' : 'hdmi'
+    end
+  end
+end
+
 class Monitors < Ki::Model
   forbid :create, :update, :delete
 
@@ -7,7 +37,7 @@ class Monitors < Ki::Model
     return if params["q"].nil?
     return unless ['c', 'e'].include? params["q"]
 
-    `disper -#{params["q"]}`
+    run "disper -#{params["q"]}"
   end
 end
 
@@ -19,9 +49,9 @@ class Fireplace < Ki::Model
     return unless ['kill', 'start'].include? params["q"]
 
     if params["q"] == "kill"
-      `killall -9 vlc`
+      run "killall -9 vlc"
     else
-      `vlc https://www.youtube.com/watch?v=rH79BmeeM0o --fullscreen`
+      run "vlc https://www.youtube.com/watch?v=rH79BmeeM0o --fullscreen &"
     end
   end
 end
@@ -34,9 +64,24 @@ class Sound < Ki::Model
     return unless ['speakers', 'hdmi'].include? params["q"]
 
     if params["q"] == "speakers"
-      `pacmd set-default-sink alsa_output.pci-0000_00_1b.0.analog-stereo`
+      run "pactl set-default-sink alsa_output.pci-0000_00_1b.0.analog-stereo"
+    else
+      run "pactl set-default-sink alsa_output.pci-0000_01_00.1.hdmi-stereo-extra1"
+    end
+  end
+end
+
+class Jrobot < Ki::Model
+  forbid :create, :update, :delete
+
+  def after_find
+    return if params["q"].nil?
+    return unless ['listen', 'kill'].include? params["q"]
+
+    if params["q"] == "listen"
+      run `cd ../../../../CouchLockServer/; ./start.sh`
     else
-      `pacmd set-default-sink alsa_output.pci-0000_01_00.1.hdmi-stereo-extra1`
+      run `kill \`ps ax | grep lockserver.UDPServer | grep -v grep | awk '{ print $1 }'\``
     end
   end
 end