cameleon 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yjg2ZDYwYjQ4NjYwNzNlOTczM2FhZjc3ZjI5NTYwNGFhMDMxMmE3OQ==
+  data.tar.gz: !binary |-
+    MDRkNmM1ZDJhMjMzZDg5MGRhY2NiMjIxYzE1YTBmODM0ZDYzOTMxMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NzkzNzkzYzJiMWRlYTdjNTViYTFjN2U4NWU3Yjk5MzdlODhkZDhiOWI5ZDAz
+    MTkwYjQxNjg1NTdjOGEyNzBiZTZkMjdiNTZlOWRmYjI1OTAyMTFkNzRiZDAw
+    NmZjYjYwMzRiNDgwNDNiNDI3NWI2ODRiNWRjMjA1M2IzMzM2MWQ=
+  data.tar.gz: !binary |-
+    YzdhMTYyNzgwYTY0NzgzZDVmNDk5NTg4NWE2MDNjYzU3NjU0ODMwY2RjNTJj
+    N2I2MDNkZTMyZmUxNTZlYzgyZmFkM2RlNWE2MjU2M2Q5ZTQxNDRkZDRhZjYw
+    YzFlY2U0MTU3YzUzMTgwZjYyNzE2Y2NhMGJkYWFiYjMzZmFjNWI=

data/Gemfile

@@ -3,11 +3,11 @@ gem "erubis"
 gem "rack"
 gem "hashie"
 gem "json"
+gem "json-schema"
 gem "nokogiri"
 
 group :development do
   gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
+  gem "bundler"
+  gem "jeweler"#, "~> 1.6.4"
 end

data/README.md

@@ -1,15 +1,17 @@
 Cameleon
 =======================================
 
-Cameleon (not Chameleon!) is HTTP mock server framework based on Rack. You can easily create HTTP server for mockup or stub of external system for your application.
+Cameleon (not Chameleon!) is HTTP mock/stub server framework based on Rack. 
+You can easily create HTTP server behaves as external system for your application.
 
-All you have to do to create a new interface is simply make directory and put text file into the directory.
+All you have to do to create a new HTTP interface is simply make directory and put response file into the directory.
 
 Features:
 
+ - Easy to create new HTTP interfaces (only to create directory and put response file into it)
  - Simple API for "_switch.rb" (for selecting response file)
- - Communicate in JSON, XML or any format over HTTP
- - Easy to create RESTful API
+ - Communicate in JSON, XML or any other format over HTTP
+ - Ready for RESTful API
 
 
 ## Installation
@@ -19,11 +21,11 @@ You can install Cameleon using RubyGems as below:
 
   
 ## Getting started
-First, create a new Cameleon project.
+First, create a new Cameleon project using 'cameleon new' command.
 
-    $ cameleon new your_project_name.
+    $ cameleon new your_project_name
 
-Then move the directory now you created, and launch cameleon server.
+Move into the directory you've created now, and start cameleon server.
 
     $ cd your_project_name
     $ cameleon server
@@ -43,7 +45,7 @@ Think about creating HTTP interface such like below:
  - URL: /path/to/interface
  - response: "ok"
 
-Then all you have to do are below:
+Follow these steps:
 
     $ mkdir -p response/path/to/interface
     $ cd response/path/to/interface
@@ -55,7 +57,7 @@ Test the interface:
     ok
 
 ### generate command
-Or simply, you can create a interface using "cameleon generate" command.
+You can create a interface using "cameleon generate" command.
 If you want to create a new interface "/path/to/foo", type:
 
     $ cameleon generate path/to/foo
@@ -65,10 +67,11 @@ and test it.
     $ curl http://localhost:9292/path/to/foo
     edit me: response/path/to/foo/default
 
-So edit the file as you need.
+Edit the file as you need.
 
 ### _switch.rb
-If you want to change the response by HTTP request, you shold create "_switch.rb" in your response directory.
+If you want to change the response by HTTP request, you should create "_switch.rb" in your response directory.
+"_switch.rb" should be pure Ruby file. You can write any logic you need in Ruby.
 
 Below shows a sample of "_switch.rb".
 
@@ -85,9 +88,38 @@ Below shows a sample of "_switch.rb".
     
     # if else, render "default" (any extention acceptable) file.
 
+### Validation
+Cameleon can validate HTTP request body. Currently JSON format is supported. If you want to validate your request to Cameleon,  add 'validation' attribute and 'type' sub-attribute as 'json' into your 'cameleon.yml' config file.
+
+    port: 9292
+    validation:
+      type: json
+
+then put 'request.schema.json' into response directory. If your interface allows json request body like:
+
+    {"a": 1}
+
+You should create 'request.schema.json' like:
+
+    {
+      "type" : "object",
+      "properties" : {
+        "a" : {
+          "type" : "integer",
+          "required" : true
+        }
+      }
+    }
+
+Cameleon uses json-schema gem as validation engine, and it's based on [JSON Schema Draft 3](http://tools.ietf.org/html/draft-zyp-json-schema-03). See [json-schema](https://github.com/hoxworth/json-schema) for more detail.
+
+Notice:
+
+Cameleon validates request body only in POST or PUT http method.
 
 ## Gallery
 You can get various samples using "cameleon gallery" command.
+
     $ cd YOUR_CAMELEON_HOME
     $ cameleon gallery
 

data/Rakefile

@@ -31,23 +31,4 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
-end
-
 task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "cameleon #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/cameleon.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cameleon}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{daixque}]

data/lib/cameleon/action.rb

@@ -1,7 +1,14 @@
 # -*- coding: utf-8 -*-
 require 'erubis'
+require 'json-schema'
 
 class Cameleon
+  class ValidationError < Exception
+    def initialize(msg)
+      super(msg)
+    end
+  end
+
   class Action
     def find_default_file
       Dir.entries(@base_path).find { |f| f =~ /^default\./ }
@@ -14,6 +21,13 @@ class Cameleon
       end
       @params = req.params
       @body = req.body.read
+      if ["POST", "PUT"].include? req.request_method
+        begin
+          validate_request_body
+        rescue Cameleon::ValidationError => e
+          return [400, {}, [e.message]]
+        end
+      end
       switch_filepath = File.join @base_path, "_switch.rb"
       renderer = nil
       if !File.exists?(@base_path)
@@ -25,5 +39,29 @@ class Cameleon
       end
       renderer.build_response
     end
+
+    def validate_request_body
+      validation_type = Cameleon.config.validation && Cameleon.config.validation.type
+      case validation_type
+      when "json"
+        validate_json
+      when nil
+      else
+        raise "unknown validation type '#{validation_type}' in config.yml"
+      end
+    end
+
+    def validate_json
+      schema_filepath = File.join(@base_path, "request.schema.json")
+      if File.exists? schema_filepath
+        begin
+          schema = JSON.parse File.read(schema_filepath)
+          JSON::Validator.validate!(schema, @body)
+        rescue JSON::Schema::ValidationError => e
+          error_body = {"error" => e.message}.to_json
+          raise Cameleon::ValidationError.new(error_body)
+        end
+      end
+    end
   end
 end

data/template/gallery/response/gallery/json/_switch.rb

@@ -11,5 +11,9 @@ when "bar"
   render "bar.json"
 end
 
+# when you enable JSON validation (edit cameleon.yml)
+# you may receive error if you post invalid request
+# curl -XPOST http://localhost:9292/gallery/json -d"{\"invalid\":\"format\"}"
+
 # if nothing to match, use 404 HTTP Status Code and render default.json.
 status_code 404

data/template/new/cameleon.yml

@@ -1 +1,5 @@
-port: 9292
+port: 9292
+
+# uncommnet to enable JSON format validation feature
+#validation:
+#  type: json

metadata

@@ -1,115 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: cameleon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - daixque
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-11 00:00:00.000000000Z
+date: 2011-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &2156026340 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156026340
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2156019320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156019320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2156012980 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156012980
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2156005480 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156005480
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2156000260 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156000260
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2155995580 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155995580
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2155991700 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2155991700
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2155982160 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2155982160
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2155978480 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155978480
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Cameleon is HTTP mock server framework based on Rack. You can easily
   create HTTP server for mockup or stub of external system for your application.
 email: daixque@gmail.com
@@ -165,28 +191,24 @@ files:
 homepage: http://github.com/daixque/cameleon
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2425352503709104828
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 3
 summary: Cameleon is HTTP mock server framework.