ki 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15b4a578063b70b747d42d5f0326bcd79865351a
-  data.tar.gz: 942f6272d7b8a256cc4c469f6fa4ac82d6c4b82c
+  metadata.gz: 506138e83d5016227ef6acdf6a5f7bf29e6191e8
+  data.tar.gz: c79f376faf3bca31d325f41d0e760ab9fb774861
 SHA512:
-  metadata.gz: 9ab148975be190e176f344ecbfc7ece85d79dc728730e7bc30189099ce770c054ac20fef8500ca69d409d0c9e333c58195dd0f932b4e7ad079f79c9d3b6550c4
-  data.tar.gz: b649dad7d5ce844da1da67df28f4e88a92702705dcb68fa123587dc64ee7297fd6b000e2ec350dd2ba4d4e069a0330b9cc960bfee1050fb6c1dadb00a3eb158b
+  metadata.gz: 00331f90e93a2dab923bf5d3131c773fd5ffdd1f6e6bf0a914cabcd5069ff24c6e2b3a27aa99758ad25ed062cda3c995cfbb1bf88b806e13a399023f68da49c9
+  data.tar.gz: b7d60288bbb44bdf9e7a0aa4b3502117bf36e5254131d762d514e951fcdcd163d0fe9f589b0168027f9d3aee248fe2ce39de73e4968d5093b819ff8a4998ae86

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  Exclude:
+    - 'spec/examples/**/*'
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    ki (0.4.6)
+    ki (0.4.7)
       bson_ext
       bundler (~> 1.5)
       coffee-script
       haml
-      mongo
+      mongo (= 1.9.2)
       rack
       rack-cors
       rack-parser
@@ -16,8 +16,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    bson (3.0.1)
-    bson_ext (1.5.1)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    bson (1.9.2)
+    bson_ext (1.9.2)
+      bson (~> 1.9.2)
     celluloid (0.15.2)
       timers (~> 1.1.0)
     celluloid-io (0.15.0)
@@ -44,6 +48,9 @@ GEM
     guard-rspec (4.2.8)
       guard (~> 2.1)
       rspec (>= 2.14, < 4.0)
+    guard-rubocop (1.2.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
     haml (4.0.6)
       tilt
     listen (2.7.1)
@@ -53,10 +60,13 @@ GEM
       rb-inotify (>= 0.9)
     lumberjack (1.0.5)
     method_source (0.8.2)
-    mongo (2.0.2)
-      bson (~> 3.0)
+    mongo (1.9.2)
+      bson (~> 1.9.2)
     multi_json (1.11.0)
     nio4r (1.0.0)
+    parser (2.2.2.1)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.0)
     pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
@@ -67,6 +77,7 @@ GEM
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
+    rainbow (2.0.0)
     rake (10.1.1)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.3)
@@ -79,6 +90,13 @@ GEM
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
+    rubocop (0.30.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
     sass (3.4.13)
     simplecov (0.9.2)
       docile (~> 1.1.0)
@@ -96,6 +114,7 @@ PLATFORMS
 DEPENDENCIES
   codeclimate-test-reporter
   guard-rspec
+  guard-rubocop
   ki!
   rack-test
   rake

data/Guardfile

@@ -1,9 +1,15 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard :rspec do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { 'spec' }
+  end
 
+  guard :rubocop, cli: ['--config=.rubocop.yml', '--display-cop-names'] do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/README.md

@@ -9,6 +9,36 @@ Tiny REST JSON ORM framework with MongoDB.
 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.
 
+**Table of Contents**
+
+- [TLDR](#tldr)
+- [Install](#install)
+- [Getting started](#getting-started)
+  - [Create a new app](#create-a-new-app)
+  - [Adding a view](#adding-a-view)
+  - [Adding assets](#adding-assets)
+  - [View layout](#view-layout)
+  - [Middleware](#middleware)
+  - [Helpers](#helpers)
+  - [Adding a resource](#adding-a-resource)
+    - [Create](#create)
+    - [Get all](#get-all)
+    - [Get by id](#get-by-id)
+    - [Get advanced queries](#advanced-queries)
+    - [Update](#update)
+    - [Delete](#delete)
+  - [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)
+- [Deploy](#deploy)
+  - [Heroku deployment](#heroku-deployment)
+- [CORS enabled](#cors-enabled)
+- [Documentation](#documentation)
+- [Administration Interface](#administration-interface)
+
 ## TLDR
 
 To create an api endpoint '/todo.json' with GET/POST/PATCH and restricting
@@ -198,6 +228,30 @@ curl -X GET http://localhost:9292/todo.json
 curl -X GET http://localhost:9292/todo.json?id=ITEM_ID
 ```
 
+#### Advanced queries
+
+Mongo syntax is supported. See [here](http://docs.mongodb.org/manual/tutorial/query-documents/) for more details.
+
+Some examples:
+
+Search in array
+
+```
+curl -k -X GET -d '{"category": {"$in": ["music"]}}' "https://json.northpole.ro/storage.json?api_key=guest&secret=guest"
+```
+
+Greater than number
+
+```
+curl -k -X GET -d '{"i": {"$gt": 0}}' "https://json.northpole.ro/storage.json?api_key=guest&secret=guest"
+```
+
+OR Query
+
+```
+curl -k -X GET -d '{"$or": [{"category": "music"}, {"category": "band"}]}' "https://json.northpole.ro/storage.json?api_key=secret&secret=secret"
+```
+
 #### Update
 
 ```shell
@@ -224,6 +278,21 @@ end
 This will make sure a Todo item can not be saved or updated in the database
 without a title attribute.
 
+### Unique attributes
+
+You can add unique attributes on resources with the *unique* method. It
+takes one parameter or an array of parameters as an argument.
+
+```ruby
+class Todo < Ki::Model
+  unique :title
+end
+```
+
+This will make sure a Todo item can not be saved or updated in the database
+if it is not unique.
+
+
 ### Restricting resource requests
 
 Let's say you want to forbid access to deleting items. You can do that with
@@ -304,7 +373,16 @@ git push heroku master
 heroku open
 ```
 
+## CORS enabled
+
+Yes.
+
 ## Documentation
 
 Ki offers instant documentation. Add the middleware 'DocGenerator' and access
 */instadoc*.
+
+## Administration Interface
+
+Ki offers an instant administration interface. Add the middleware 'AdminIntefaceGenerator'
+and access */instadmin*.

data/Rakefile

@@ -3,12 +3,12 @@ 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.main = 'README.md'
+  rdoc.rdoc_files
+    .include('README.md', 'lib/**/*.rb')
   rdoc.rdoc_dir = 'doc'
 end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/ki.gemspec

@@ -4,34 +4,35 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ki/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ki"
+  spec.name          = 'ki'
   spec.version       = Ki::VERSION
-  spec.authors       = ["Cristian Mircea Messel"]
-  spec.email         = ["mess110@gmail.com"]
-  spec.summary       = %q{it said optional}
-  spec.description   = %q{it said optional}
-  spec.homepage      = "https://github.com/mess110/ki"
-  spec.license       = "MIT"
+  spec.authors       = ['Cristian Mircea Messel']
+  spec.email         = ['mess110@gmail.com']
+  spec.summary       = 'it said optional'
+  spec.description   = 'it said optional'
+  spec.homepage      = 'https://github.com/mess110/ki'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib", "examples"]
+  spec.require_paths = %w(lib examples)
 
-  spec.add_runtime_dependency "bundler", "~> 1.5"
-  spec.add_runtime_dependency "rack"
-  spec.add_runtime_dependency "rack-parser"
-  spec.add_runtime_dependency "thor"
-  spec.add_runtime_dependency "haml"
-  spec.add_runtime_dependency "sass"
-  spec.add_runtime_dependency "coffee-script"
-  spec.add_runtime_dependency "mongo"
-  spec.add_runtime_dependency "bson_ext"
-  spec.add_runtime_dependency "rack-cors"
+  spec.add_runtime_dependency 'bundler', '~> 1.5'
+  spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency 'rack-parser'
+  spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'haml'
+  spec.add_runtime_dependency 'sass'
+  spec.add_runtime_dependency 'coffee-script'
+  spec.add_runtime_dependency 'mongo', '1.9.2'
+  spec.add_runtime_dependency 'bson_ext'
+  spec.add_runtime_dependency 'rack-cors'
 
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/ki.rb

@@ -19,10 +19,12 @@ require 'ki/utils/indifferent_hash'
 require 'ki/modules/query_interface'
 require 'ki/modules/restrictions'
 require 'ki/modules/callbacks'
-require 'ki/modules/model_helpers'
-require 'ki/modules/view_helper'
-require 'ki/modules/format_of'
-require 'ki/modules/public_file_helper'
+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/view_helper'
 
 require 'ki/middleware/base_middleware'
 require 'ki/middleware/init_middleware'
@@ -39,5 +41,6 @@ require 'ki/helpers'
 require 'ki/orm'
 require 'ki/model'
 require 'ki/base_request'
+require 'ki/ki_app'
 
 require 'ki/ki'

data/lib/ki/base_request.rb

@@ -19,7 +19,7 @@ module Ki
     end
 
     def to_ki_model_class
-      self.path.to_s.gsub('/','').gsub(format_of(path), '').gsub('.', '').to_class
+      path.to_s.gsub('/', '').gsub(format_of(path), '').gsub('.', '').to_class
     end
 
     def to_action
@@ -35,7 +35,7 @@ module Ki
       when 'SEARCH'
         :find
       else
-        raise 'unkown action'
+        fail 'unkown action'
       end
     end
   end

data/lib/ki/helpers.rb

@@ -2,24 +2,24 @@ module Ki
   module Helpers
     include Middleware::Helpers::View
 
-    def css url
-      render_haml "%link{:href => '#{url}', :rel => 'stylesheet'}"
+    def css(url)
+      haml "%link{:href => '#{url}', :rel => 'stylesheet'}"
     end
 
-    def js url
-      render_haml "%script{:src => '#{url}'}"
+    def js(url)
+      haml "%script{:src => '#{url}'}"
     end
 
-    def render_haml s
+    def haml(s)
       Haml::Engine.new(s).render
     end
 
-    def partial s
+    def partial(s)
       path = view_path(s)
       if File.file?(path)
         render_haml(File.read(path))
       else
-        raise PartialNotFoundError.new path
+        fail PartialNotFoundError, path
       end
     end
   end

data/lib/ki/ki.rb

@@ -1,13 +1,4 @@
 module Ki
-  class KiApp
-    # should never reach this
-    # middleware should catch all the requests
-    def call env
-      s = 'misplaced in space'
-      Rack::Response.new(s).finish
-    end
-  end
-
   class Ki
     PUBLIC_PATH = 'public'
     VIEWS_PATH = 'views'
@@ -17,17 +8,20 @@ module Ki
 
       @app = Rack::Builder.new do
         use Middleware::InitMiddleware
-        # TODO what happens with invalid json?
-        use Rack::Parser, :content_types => { 'application/json'  => Proc.new { |body| ::MultiJson.decode body } }
+        use Rack::Parser, content_types: {
+          'application/json' => proc { |body| ::MultiJson.decode body }
+        }
+        if KiConfig.instance.cors?
+          use Rack::Cors do
+            allow do
+              origins '*'
+              resource '*', headers: :any, methods: [:get, :search, :put, :post, :delete]
+            end
+          end
+        end
         KiConfig.instance.middleware.each do |middleware|
           use middleware
         end
-        use Rack::Cors do
-          allow do
-            origins '*'
-            resource '*', headers: :any, methods: :any
-          end
-        end
         run KiApp.new
       end
     end
@@ -41,7 +35,7 @@ module Ki
       ENV['RACK_ENV'] || 'development'
     end
 
-    def call env
+    def call(env)
       @app.call env
     end
   end