ki 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fecab0fa4fb36ca609b3858125f8966cb2c83b24
-  data.tar.gz: 374608a0b13d1bce947ac0e8d42facc78b7fa5dd
+  metadata.gz: 848983c889362ba630e00014d4b670342d59ac68
+  data.tar.gz: a34e3829a0b471ba4f2cf3e31c7c3f0ba1a82231
 SHA512:
-  metadata.gz: 142a52569d62b87646811ee4f2ab16d7dc397427f495aaca1a8369d2d3632d7bd4f91fd50623114a94b8d57e265faf142b70fa29a6f1a719f3b1f9d9a8e16681
-  data.tar.gz: a75db7d74e8e7e816efa78ea57a573a613285e8bbea0f844f7006f69256ebc3e9136c46b035fac074d938ff36597ae8271cbcf32a6c68fd61d5ea65af425a074
+  metadata.gz: b4c33d21423505f78dd4d20afa6bae4e8c42c6dafd79325290384db94f53162d346c6087c9b3e8fa4dace49dfa13f4be41c70b6e24cc6116bb5d1756e89c2117
+  data.tar.gz: 4c7442a2117142f8cd45a8e1c690ec6f7d42b7d7bc10cb0d96b71c8ca1fb2a6b891b12c6459f04dbb3ccb9e8c3b79e18faf94e1fbacd50d942b0b4b611a1283e

data/.gitignore

@@ -8,3 +8,5 @@
 
 spec/examples/*/tmp
 spec/examples/*/log
+
+/doc/*

data/Gemfile.lock

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

data/README.md

@@ -72,10 +72,11 @@ Views are in the *views* folder and you can find some database info in
 ```shell
 cd todo
 bundle
-rackup
+ki server
 ```
 
-*rackup* is the command which starts the webserver. The port will be displayed.
+*ki server* is the command which starts the webserver. By default it starts on
+port 1337.
 
 ### Adding a view
 
@@ -270,3 +271,18 @@ nginx, thin, apache, webrick).
 
 In the webserver config, just remember to point the virtual host to the
 *public* directory.
+
+### Heroku deployment
+
+```shell
+ki new heroku-ki
+cd heroku-ki
+bundle
+git init
+git add .
+git commit -m 'initial commit'
+heroku create
+heroku config:set MONGODB_URI="mongodb://user:pass@mongo_url:mongo_port/db_name"
+git push heroku master
+heroku open
+```

data/Rakefile

@@ -1,5 +1,13 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.
+    include("README.md", "lib/**/*.rb")
+  rdoc.rdoc_dir = 'doc'
+end
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/ki

@@ -4,4 +4,4 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'ki/ki_cli'
 
-KiCli.start(ARGV)
+Ki::Cli::Main.start(ARGV)

data/lib/ki/api_error.rb

@@ -1,5 +1,5 @@
 module Ki
-  class ApiError < StandardError
+  class ApiError < StandardError #:nodoc:
     attr_reader :status
 
     def initialize body, status=400
@@ -12,20 +12,28 @@ module Ki
     end
   end
 
-  class InvalidUrlError < ApiError; end
-  class RequiredAttributeMissing < ApiError; end
-  class AttributeNotUnique < ApiError; end
-  class ForbiddenAction < ApiError
+  class InvalidUrlError < ApiError #:nodoc:
+  end
+
+  class RequiredAttributeMissing < ApiError #:nodoc:
+  end
+
+  class AttributeNotUnique < ApiError #:nodoc:
+  end
+
+  class ForbiddenAction < ApiError #:nodoc:
     def initialize s='forbidden', code=403
       super s, code
     end
   end
-  class UnauthorizedError < ApiError
+
+  class UnauthorizedError < ApiError #:nodoc:
     def initialize s='unauthroized', code=401
       super s, code
     end
   end
-  class PartialNotFoundError < ApiError
+
+  class PartialNotFoundError < ApiError #:nodoc:
     def initialize s
       super "partial #{s} not found", 404
     end

data/lib/ki/base_request.rb

@@ -1,6 +1,6 @@
 module Ki
   class BaseRequest < Rack::Request
-    include FormatOf
+    include Middleware::Helpers::FormatOf
 
     def root?
       path == '/'

data/lib/ki/helpers.rb

@@ -1,4 +1,13 @@
 class String
+  # Converts a string to a class
+  #
+  # ==== Examples
+  #
+  #   class User
+  #   end
+  #
+  #   "user".to_class == User
+  #
   def to_class
     chain = self.split "::"
     klass = Kernel
@@ -29,7 +38,7 @@ end
 
 module Ki
   module Helpers
-    include ViewHelper
+    include Middleware::Helpers::View
 
     def css url
       render_haml "%link{:href => '#{url}', :rel => 'stylesheet'}"

data/lib/ki/ki_cli.rb

@@ -1,46 +1,67 @@
 require 'thor'
 
-class KiGenerator < Thor::Group
-  include Thor::Actions
+module Ki
+  module Cli #:nodoc:
+    class KiGenerator < Thor::Group #:nodoc:
+      include Thor::Actions
 
-  def self.source_root
-    File.join(File.dirname(__FILE__), '..', '..')
-  end
-end
+      def self.source_root
+        File.join(File.dirname(__FILE__), '..', '..')
+      end
+    end
 
-class AppGenerator < KiGenerator
+    class AppGenerator < KiGenerator
 
-  argument :app_name
+      argument :app_name
 
-  def prepare_dir
-    unless app_name =~ /^[a-zA-Z0-9-]*$/
-      say "App name must contain only alphanumeric characters and -"
-      exit 1
-    end
+      def prepare_dir
+        unless app_name =~ /^[a-zA-Z0-9-]*$/
+          say "App name must contain only alphanumeric characters and -"
+          exit 1
+        end
+
+        if Dir.exists? app_name
+          say "#{app_name} already exists"
+          exit 2
+        end
+
+        Dir.mkdir app_name
+      end
+
+      def create_app
+        directory("spec/examples/base", app_name)
 
-    if Dir.exists? app_name
-      say "#{app_name} already exists"
-      exit 2
+        # Set database names
+        config_file = File.read("#{app_name}/config.yml")
+        config_file.gsub!("name: np_development", "name: #{app_name}_development")
+        config_file.gsub!("name: np_test", "name: #{app_name}_test")
+        config_file.gsub!("name: np", "name: #{app_name}")
+        File.open("#{app_name}/config.yml", "w") {|file| file.puts config_file}
+
+        # Set rvm gemset name
+        `echo #{app_name} > #{app_name}/.ruby-gemset`
+      end
     end
 
-    Dir.mkdir app_name
-  end
+    class DevServer < KiGenerator
+      DEFAULT_PORT = 1337
 
-  def create_app
-    directory("spec/examples/base", app_name)
+      argument :port, type: :numeric, desc: "port for ki server.", default: DEFAULT_PORT
+      desc "Starts the ki server"
 
-    # Set database names
-    config_file = File.read("#{app_name}/config.yml")
-    config_file.gsub!("name: np_development", "name: #{app_name}_development")
-    config_file.gsub!("name: np_test", "name: #{app_name}_test")
-    config_file.gsub!("name: np", "name: #{app_name}")
-    File.open("#{app_name}/config.yml", "w") {|file| file.puts config_file}
+      def start_server
+        unless File.exists? 'config.ru'
+          say "Working directory should be a ki app."
+          exit 3
+        end
 
-    # Set rvm gemset name
-    `echo #{app_name} > #{app_name}/.ruby-gemset`
-  end
-end
+        `bundle exec rackup -o 0.0.0.0 -p #{port}`
+      end
+    end
 
-class KiCli < Thor
-  register AppGenerator, :new, 'new [APP_NAME]', 'generate a new app'
+    class Main < Thor
+      register AppGenerator, :new, 'new [APP_NAME]', 'generate a new app'
+      register DevServer, :server, 'server [PORT]', "start the ki server. Default port is #{DevServer::DEFAULT_PORT}"
+    end
+  end
 end

data/lib/ki/middleware.rb

@@ -1,9 +1,9 @@
 module Ki
-  module Middleware
+  module Middleware #:nodoc:
     module BaseMiddleware
-      include FormatOf
-      include ViewHelper
-      include PublicFileHelper
+      include Helpers::FormatOf
+      include Helpers::View
+      include Helpers::PublicFile
 
       def initialize app
         @app = app
@@ -29,9 +29,14 @@ module Ki
       def call env
         req = BaseRequest.new env
         if req.root?
-          resp = Rack::Response.new
-          resp.redirect('/index')
-          resp.finish
+          if public_file_exists? 'index.html'
+            env['PATH_INFO'] = '/index.html'
+            Rack::File.new(Ki::PUBLIC_PATH).call env
+          else
+            resp = Rack::Response.new
+            resp.redirect('/index')
+            resp.finish
+          end
         else
           env['CONTENT_TYPE'] = 'application/json' if format_of(req) == 'json'
           @app.call env
@@ -80,7 +85,7 @@ module Ki
         coffee_path = req.path.to_s[0...-3] + '.coffee'
         if !public_file_exists?(req) && format_of(req) == 'js' && public_file_exists?(coffee_path)
           js = CoffeeScript.compile(File.read(public_file_path(coffee_path)))
-          Rack::Response.new(js).finish
+          Rack::Response.new(js, 200, {"Content-Type" => "application/javascript"}).finish
         else
           @app.call env
         end
@@ -96,7 +101,7 @@ module Ki
         # if req ends with css and it does not exist, if a sass file exists instead
         if !public_file_exists?(req) && format_of(req) == 'css' && public_file_exists?(sass_path)
           eng = Sass::Engine.new(File.read(public_file_path(sass_path)), :syntax => :sass)
-          Rack::Response.new(eng.render).finish
+          Rack::Response.new(eng.render, 200, {"Content-Type" => "text/css"}).finish
         else
           @app.call env
         end

data/lib/ki/modules/callbacks.rb

@@ -1,33 +1,35 @@
 module Ki
-  module Callbacks
-    def before_all
-    end
+  class Model
+    module Callbacks
+      def before_all
+      end
 
-    def before_find
-    end
+      def before_find
+      end
 
-    def after_find
-    end
+      def after_find
+      end
 
-    def before_create
-    end
+      def before_create
+      end
 
-    def after_create
-    end
+      def after_create
+      end
 
-    def before_update
-    end
+      def before_update
+      end
 
-    def after_update
-    end
+      def after_update
+      end
 
-    def before_delete
-    end
+      def before_delete
+      end
 
-    def after_delete
-    end
+      def after_delete
+      end
 
-    def after_all
+      def after_all
+      end
     end
   end
 end

data/lib/ki/modules/format_of.rb

@@ -1,10 +1,14 @@
 module Ki
-  module FormatOf
-    def format_of uri
-      uri = uri.path if uri.class == BaseRequest
-      File.extname(URI.parse(uri).path).gsub('.','')
-    rescue URI::InvalidURIError => e
-      ''
+  module Middleware
+    module Helpers
+      module FormatOf
+        def format_of uri
+          uri = uri.path if uri.class == BaseRequest
+          File.extname(URI.parse(uri).path).gsub('.','')
+        rescue URI::InvalidURIError => e
+          ''
+        end
+      end
     end
   end
 end

data/lib/ki/modules/model_helpers.rb

@@ -1,35 +1,37 @@
 module Ki
-  module ModelHelpers
-    def get?
-      @req.get?
-    end
+  class Model
+    module ModelHelpers
+      def get?
+        @req.get?
+      end
 
-    def post?
-      @req.post?
-    end
+      def post?
+        @req.post?
+      end
 
-    def put?
-      @req.put?
-    end
+      def put?
+        @req.put?
+      end
 
-    def delete?
-      @req.delete?
-    end
+      def delete?
+        @req.delete?
+      end
 
-    def forbidden_actions
-      []
-    end
+      def forbidden_actions
+        []
+      end
 
-    def required_attributes
-      []
-    end
+      def required_attributes
+        []
+      end
 
-    def skipped_params
-      []
-    end
+      def skipped_params
+        []
+      end
 
-    def unique_attributes
-      []
+      def unique_attributes
+        []
+      end
     end
   end
 end