ki 0.4.10 → 0.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e570dca285d0879a444188fe3f855404b7eea148
-  data.tar.gz: bd7f3d50f1e5c475b8e04e263c498a1878d76408
+  metadata.gz: 027faaedcab27f0fd3f3d65e878da0dfd98e74da
+  data.tar.gz: bc9e0f3ec9dd2c17fa4b238b829bd50afcdce5f3
 SHA512:
-  metadata.gz: 69ae313e5b0596c6d064ca51a4b805ae7b3dd5785450e6987982d454ac27a56cfd61b15201ef4aa1511a888892f4b500d2ab47eeed850525db5d83a959a59ce7
-  data.tar.gz: 5de90c09ce1b696cefa724cf8a3a1569fe39843617c0465d717ea8c1ef467da94d64911fd80dca983eb50195a0aad986726d2f7b7f738521eed8805b8bae04ff
+  metadata.gz: aa073bd56faec752bea84241acd3602b85c010628d10f393c006d96337ed9952d064af70991b69b6a40108df3794433ed9ecc8ac6f469eb7c6682b0b5e6d538c
+  data.tar.gz: 97eebe5a6b2e5b0e03d029e44dbe8bcdeacb9f16a7d721dd2644ff74be97fa67ab81dac38f19c3e9f057d442e6d57ca531281c136294d7744c394896fc243aed

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    ki (0.4.10)
+    ki (0.4.11)
       bson_ext
       bundler (~> 1.5)
       coffee-script
+      faye-websocket
       haml
       mongo (= 1.9.2)
       rack
@@ -33,10 +34,14 @@ GEM
     coffee-script (2.4.1)
       coffee-script-source
       execjs
-    coffee-script-source (1.9.1.1)
+    coffee-script-source (1.10.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    execjs (2.5.2)
+    eventmachine (1.2.0.1)
+    execjs (2.6.0)
+    faye-websocket (0.10.3)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
     ffi (1.9.3)
     formatador (0.2.4)
     guard (2.5.1)
@@ -51,7 +56,7 @@ GEM
     guard-rubocop (1.2.0)
       guard (~> 2.0)
       rubocop (~> 0.20)
-    haml (4.0.6)
+    haml (4.0.7)
       tilt
     listen (2.7.1)
       celluloid (>= 0.15.2)
@@ -73,7 +78,7 @@ GEM
       slop (~> 3.4)
     rack (1.5.2)
     rack-cors (0.4.0)
-    rack-parser (0.6.1)
+    rack-parser (0.7.0)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
@@ -97,7 +102,7 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
     ruby-progressbar (1.7.5)
-    sass (3.4.13)
+    sass (3.4.22)
     simplecov (0.9.2)
       docile (~> 1.1.0)
       multi_json (~> 1.0)
@@ -105,8 +110,11 @@ GEM
     simplecov-html (0.9.0)
     slop (3.5.0)
     thor (0.18.1)
-    tilt (2.0.1)
+    tilt (2.0.2)
     timers (1.1.0)
+    websocket-driver (0.6.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
 
 PLATFORMS
   ruby
@@ -121,4 +129,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.10.3
+   1.10.6

data/MIDDLEWARE.md

@@ -5,6 +5,8 @@ Rack handles everything™
 
 ## Middleware
 
+It is configured in the config.yml of the application.
+
 The default enabled middleware list:
 
 * ApiHandler
@@ -36,10 +38,28 @@ Similar to CoffeeCompiler, compiles haml to html.
 
 Serves static files from the *public/* folder.
 
-## Make your own
-
-TODO
-
-### config.yml
-
-TODO middleware config example.
+### example middleware configuration
+
+```yml
+development:
+  database:
+    name: base_development
+    host: 127.0.0.1
+    port: 27017
+  add_middleware: ['Realtime', 'DocGenerator', 'AdminInterfaceGenerator']
+  rm_middleware: ['SassCompiler']
+
+test:
+  database:
+    name: np_test
+    host: 127.0.0.1
+    port: 27017
+
+production:
+  middleware: ['ApiHandler', 'PublicFileServer']
+  add_middleware: ['Realtime', 'DocGenerator', 'AdminInterfaceGenerator']
+  database:
+    name: np
+    host: 127.0.0.1
+    port: 27017
+```

data/README.md

@@ -15,6 +15,7 @@ and provides a fullblown REST api on top.
 - [Install](#install)
 - [Getting started](#getting-started)
   - [Create a new app](#create-a-new-app)
+  - [Realtime](#realtime)
   - [Adding a view](#adding-a-view)
   - [Adding assets](#adding-assets)
   - [View layout](#view-layout)
@@ -27,12 +28,14 @@ and provides a fullblown REST api on top.
     - [Get advanced queries](#advanced-queries)
     - [Update](#update)
     - [Delete](#delete)
+  - [Headers](#headers)
   - [Required attributes](#required-attributes)
   - [Unique attributes](#unique-attributes)
   - [Restricting resource requests](#restricting-resource-requests)
   - [Before/after callbacks](#beforeafter-callbacks)
     - [Accessing the json object within the callback](#accessing-the-json-object-within-the-callback)
   - [Exceptions](#exceptions)
+  - [Magic](#magic)
 - [Deploy](#deploy)
   - [Heroku deployment](#heroku-deployment)
 - [CORS enabled](#cors-enabled)
@@ -81,7 +84,7 @@ 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
+### Create a new app
 
 ```shell
 ki new todo
@@ -119,6 +122,12 @@ irb session with your application context already loaded.
 ki console
 ```
 
+### Realtime
+
+ki supports realtime communication though [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API)
+
+To learn how to use the realtime api, [read this](REALTIME.md).
+
 ### Adding a view
 
 A view is a html page. By default, a view called 'index.haml' is created for
@@ -252,6 +261,17 @@ OR Query
 curl -k -X GET -d '{"$or": [{"category": "music"}, {"category": "band"}]}' "https://json.northpole.ro/storage.json?api_key=secret&secret=secret"
 ```
 
+To limit the number of results use a param called *__limit* and the value desired.
+For example, the request below will limit itself to 10 results.
+
+```
+curl -k -X GET -d '{"__limit": 10}' "https://json.northpole.ro/storage.json?api_key=guest&secret=guest"
+```
+
+To sort the results, use a param called *__sort* and the key value desired. Example
+
+curl -k -X GET -d '{"__sort": { "name": "desc" }}' "https://json.northpole.ro/storage.json?api_key=guest&secret=guest"
+
 #### Update
 
 ```shell
@@ -264,6 +284,18 @@ curl -X PATCH -d '{"id": "ITEM_ID", "title": "finish the todo tutorial"}' http:/
 curl -X DELETE -d http://localhost:9292/todo.json?id=ITEM_ID
 ```
 
+### Headers
+
+To access headers, simply call `@req.headers`. In this example, the headers are returned by the API.
+
+```ruby
+class Headers < Ki::Model
+  def after_find
+    @result = @req.headers
+  end
+end
+```
+
 ### Required attributes
 
 You can add mandatory attributes on resources with the *requires* method. It
@@ -350,6 +382,17 @@ class Todo < Ki::Model
 end
 ```
 
+### Magic
+
+#### redirect_to param
+
+By setting the param `redirect_to`, you can set an endpoint on where to redirect
+once the request is completed.
+
+```
+http://localhost:1337/storage.json?api_key=guest&secret=guest&redirect_to=/examples
+```
+
 ## Deploy
 
 It has a *config.ru* file. Ki is based on *rack*. You can deploy anywhere (ex:
@@ -389,4 +432,4 @@ and access */instadmin*.
 
 ## Tasks
 
-Ki offers a simple task framework. [More info here](https://github.com/mess110/ki/tree/master/spec/examples/tasks-examples/).
+Ki offers a simple task framework. [More info here](https://github.com/mess110/ki/tree/master/spec/examples/tasks-example/).

data/REALTIME.md

@@ -0,0 +1,48 @@
+# Realtime
+
+The following webservers are supported:
+
+* Goliath
+* Phusion Passenger >= 4.0 with nginx >= 1.4
+* Puma >= 2.0
+* Rainbows
+* Thin
+
+## Requrirements
+
+* Load the adapter for your webserver in config.ru after 'require' (example: Faye::WebSocket.load_adapter('thin'))
+* You need to run in production mode (example: rackup -p 1337 -E production)
+* add the Realtime middlware in config.yml (example: add_middleware: 'Realtime')
+
+## Documentation
+
+Ki realtime offers channels to which a user subscribes to. Once a user is subscribed
+to a channel he/she will receive messages from that channel. Anybody can publish
+messages in a channel.
+
+Upon connecting, the user will receive a unique id.
+
+Using WebSockets, connect to the /realtime endpoint:
+
+```javascript
+// connect
+var socket = new WebSocket("ws://localhost:1337/realtime");
+socket.onclose = function() { console.log('socket closed'); }
+socket.onmessage = function(m) {
+  json = JSON.parse(m)
+  console.log(json);
+}
+
+send = function (hash) {
+  socket.send(JSON.stringify(hash))
+}
+
+// Subscribe to channel events
+send({type: 'subscribe', channel_name: 'my-channel'})
+
+// Unsubscribe from channel events
+send({type: 'unsubscribe', channel_name: 'my-channel'})
+
+// Send a message to a channel
+send({type: 'publish', channel_name: 'my-channel', text: 'asd', custom_attribute: [1, 'text']})
+```

data/TODO.md

@@ -0,0 +1,19 @@
+# deploy new version to rubygems
+# add logging
+# respect RESTful routing /foo/:id is the only thing missing
+
+if param is set to redirect_to, ki will redirect
+
+class Redirector < Ki::Model
+  def after_find
+    @params['redirect_to'] = 'http://localhost:1337/'
+  end
+end>
+
+how to read headers
+
+class Headers < Ki::Model
+  def after_find
+    @result = @req.headers
+  end
+end

data/ki.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'mongo', '1.9.2'
   spec.add_runtime_dependency 'bson_ext'
   spec.add_runtime_dependency 'rack-cors'
+  spec.add_runtime_dependency 'faye-websocket'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rack-test'

data/lib/ki.rb

@@ -10,6 +10,8 @@ require 'haml'
 require 'sass'
 require 'coffee-script'
 require 'mongo'
+require 'faye/websocket'
+require 'eventmachine'
 
 # code
 require 'ki/utils/api_error'
@@ -24,6 +26,7 @@ require 'ki/modules/model_helper'
 require 'ki/middleware/helpers/format_of_helper'
 require 'ki/middleware/helpers/public_file_helper'
 require 'ki/middleware/helpers/haml_compiler_helper'
+require 'ki/middleware/helpers/redirect_to_helper'
 require 'ki/middleware/helpers/view_helper'
 
 require 'ki/middleware/base_middleware'
@@ -35,11 +38,13 @@ require 'ki/middleware/haml_compiler'
 require 'ki/middleware/coffee_compiler'
 require 'ki/middleware/doc_generator'
 require 'ki/middleware/admin_interface_generator'
+require 'ki/middleware/realtime'
 
 require 'ki/ki_config'
 require 'ki/helpers'
 require 'ki/orm'
 require 'ki/model'
+require 'ki/channel_manager'
 require 'ki/base_request'
 require 'ki/ki_app'
 

data/lib/ki/base_request.rb

@@ -18,6 +18,13 @@ module Ki
       content_type == 'application/json' || format_of(path) == 'json'
     end
 
+    def headers
+      Hash[*env.select { |k, _v| k.start_with? 'HTTP_' }
+        .collect { |k, v| [k.sub(/^HTTP_/, ''), v] }
+        .sort
+        .flatten]
+    end
+
     def to_ki_model_class
       path.to_s.gsub('/', '').gsub(format_of(path), '').gsub('.', '').to_class
     end

data/lib/ki/channel_manager.rb

@@ -0,0 +1,58 @@
+module Ki
+  class ChannelManager
+    def self.connect
+      db.insert 'realtime_channel_sockets', {}
+    end
+
+    def self.disconnect(socket)
+      db.delete 'realtime_channel_sockets', { 'id' => socket['id'] }
+      db.delete 'realtime_channel_subscriptions', { 'socket_id' => socket['id'] }
+    end
+
+    def self.sockets
+      db.find 'realtime_channel_sockets'
+    end
+
+    def self.subscribe(json)
+      channels = db.find 'realtime_channel_subscriptions', json
+      if channels.empty?
+        item = db.insert 'realtime_channel_subscriptions', json
+        channels.push item
+      end
+      channels
+    end
+
+    def self.unsubscribe(json)
+      json.delete('type')
+      db.delete 'realtime_channel_subscriptions', json
+    end
+
+    def self.publish(json)
+      json['created_at'] = Time.now.to_i
+      db.insert 'realtime_channel_messages', json
+    end
+
+    def self.tick(json)
+      subscribed_channels = db.find 'realtime_channel_subscriptions', json
+      channel_names = subscribed_channels.map { |sc| sc['channel_name'] }
+
+      t = Time.now.to_i
+
+      messages = db.find 'realtime_channel_messages', {
+        'channel_name' => { '$in' => channel_names },
+        'created_at' => { '$gt' => t - 5 }
+      }
+      messages
+    end
+
+    def self.cleanup
+      db.delete 'realtime_channel_sockets', {}
+      db.delete 'realtime_channel_subscriptions', {}
+      db.delete 'realtime_channel_messages', {}
+    end
+
+    def self.db
+      Orm::Db.instance
+    end
+  end
+end

data/lib/ki/ki.rb

@@ -16,6 +16,7 @@ module Ki
             allow do
               origins '*'
               resource '*', headers: :any, methods: [:get, :search, :put, :post, :delete]
+              # resource '*', headers: :any, methods: :any # TODO: find out why :any doesn't work
             end
           end
         end

data/lib/ki/ki_cli.rb

@@ -83,7 +83,7 @@ module Ki
           say Dir['tasks/**/*.rb']
         else
           task_path = File.join('tasks', "#{name}.rb")
-          unless File.exists?(task_path)
+          unless File.exist?(task_path)
             say "Task #{name} not found in ./tasks/"
             exit 3
           end

data/lib/ki/ki_config.rb

@@ -23,10 +23,13 @@ module Ki
     def middleware
       used_middleware = %w(ApiHandler CoffeeCompiler SassCompiler HamlCompiler
                            PublicFileServer)
-      used_middleware = @config['middleware'] if @config['middleware'].present?
+      used_middleware = @config['middleware'] if @config['middleware']
+
+      used_middleware = add_rm_middleware used_middleware, 'add_middleware', 'push'
+      used_middleware = add_rm_middleware used_middleware, 'rm_middleware', 'delete'
 
       # convert middleware to ruby object
-      used_middleware.map do |middleware|
+      used_middleware.uniq.map do |middleware|
         Object.const_get('Ki').const_get('Middleware').const_get(middleware)
       end
     end
@@ -34,5 +37,18 @@ module Ki
     def database
       @config['database']
     end
+
+    private
+
+    def add_rm_middleware(used_middleware, key, action)
+      if @config.key?(key)
+        # TODO: concat should work here
+        @config[key] = [@config[key]] if @config[key].class != Array
+        @config[key].each do |mid|
+          used_middleware.send(action, mid)
+        end
+      end
+      used_middleware
+    end
   end
 end