dzl 1.0.0.beta0

data/spec/trey_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+require 'rack/test'
+require 'dzl/examples/trey'
+
+describe 'trey support' do
+  include Rack::Test::Methods
+
+  def app; Dzl::Examples::Trey; end
+
+  describe '/page_insights' do
+    req_params = {
+      page_ids: [1, 2, 3].join(' '),
+      metrics: ['m1', 'm2'].join(' '),
+      since: '2012-01-01',
+      until: '2012-02-01'
+    }
+
+    opt_params = {
+      interval: 'week'
+    }
+
+    bad_params = {
+      post_ids: [4, 5, 6].join(' '),
+      limit: 100,
+      sort: 'these',
+      order: 'descending'
+    }
+
+    it "responds 404 to a request with no parameters" do
+      get '/page_insights' do |response|
+        response.status.should == 404
+        errors = JSON.parse(response.body)['errors']['/page_insights']
+        errors.size.should == 4 # required params
+        errors.values.each {|v| v.should == 'missing_required_param'}
+      end
+    end
+
+    it "responds 404 with only optional parameters" do
+      get('/page_insights', opt_params) do |response|
+        response.status.should == 404
+        errors = JSON.parse(response.body)['errors']['/page_insights']
+        errors.size.should == 4 # required params
+        errors.values.each {|v| v.should == 'missing_required_param'}
+      end
+    end
+
+    it "responds 404 if extra, unknown parameters are provided" do
+      get('/page_insights', req_params.merge(foo: 'bar')) do |response|
+        JSON.parse(response.body).has_key?('params').should == false
+        response.status.should == 404
+      end
+    end
+
+    it "responds 200 to a request with required parameters provided" do
+      get('/page_insights', req_params) do |response|
+        response.status.should == 200
+      end
+    end
+
+    it "allows optional parameters in addition to the required params" do
+      get('/page_insights', req_params.merge(opt_params)) do |response|
+        response.status.should == 200
+      end
+    end
+
+    it "sets omitted optional parameters to their default values" do
+      get('/page_insights', req_params) do |response|
+        JSON.parse(response.body)['params']['interval'].should == 'day'
+      end
+    end
+
+    it "understands array parameters" do
+      get('/page_insights', req_params) do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['params']['page_ids'].should == ['1', '2', '3']
+      end
+    end
+
+    it "understands date parameters" do
+      get('/page_insights', req_params) do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['params']['since'].should == '2012-01-01'
+      end
+    end
+
+    it "understands time parameters" do
+      get('/page_insights', req_params.merge({
+          since:"#{req_params[:since]}T00:00:00-05:00",
+          until:"#{req_params[:until]}T00:00:00-05:00",
+        })) do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['params']['since'].should == '2012-01-01'
+      end
+    end
+
+    it "responds 404 to a request with required parameters improperly formatted" do
+      get('/page_insights', req_params.merge(since: 'not a date')) do |response|
+        response.status.should == 404
+        errors = JSON.parse(response.body)['errors']['/page_insights']
+        errors.size.should == 1
+        errors.values.each {|v| v.should == 'type_conversion_error'}
+      end
+    end
+
+    it "checks array length conditions" do
+      get('/page_insights', req_params.merge(page_ids: [1, 2, 3, 4, 5, 6].join(' '))) do |response|
+        response.status.should == 404
+        errors = JSON.parse(response.body)['errors']['/page_insights']
+        errors.size.should == 1
+        errors.values.each {|v| v.should == 'size_validation_failed'}
+      end
+    end
+
+    it "validates that only allowed parameters are accepted" do
+      get('/page_insights', req_params.merge(metrics:['not_allowed'])) do |response|
+        response.status.should == 404
+        errors = JSON.parse(response.body)['errors']['/page_insights']
+        errors.size.should == 1
+        errors.values.each {|v| v.should == 'allowed_values_failed'}
+      end
+    end
+
+    it "transforms params prior to validation" do
+      get('/posts', req_params.merge(sort:'m1', order:'ASC')) do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['params']['order'].should == 'asc'
+      end
+    end
+  end
+
+  it "knows the rack environment" do
+    Dzl.env.should == 'test'
+    Dzl.test?.should == true
+  end
+end

data/spec/value_or_error_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Dzl::ValueOrError do
+  it 'can be initialized with value or error but not both' do
+    expect {
+      Dzl::ValueOrError.new(value: 1)
+
+      Dzl::ValueOrError.new(error: 2)
+    }.to_not raise_exception
+
+    expect {
+      Dzl::ValueOrError.new(value: 3, error: 4)
+    }.to raise_exception
+  end
+
+  it "knows whether it's a value or an error" do
+    v = Dzl::ValueOrError.new(value: 5)
+    e = Dzl::ValueOrError.new(error: 6)
+
+    (e.error? && v.value?).should == true
+    (v.error? && e.value?).should == false
+
+    v.value.should == 5
+    e.error.should == 6
+
+    e.value.should == nil
+    v.error.should == nil
+  end
+
+  it 'allows v: and e: shortcuts in initializer hash' do
+    e = Dzl::ValueOrError.new(e: 7)
+    e.error.should == 7
+
+    v = Dzl::ValueOrError.new(v: 8)
+    v.value.should == 8
+  end
+
+  it 'accepts nil as a valid value' do
+    v = Dzl::ValueOrError.new(v: nil)
+
+    v.value?.should == true
+    v.value.should == nil
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: dzl
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta0
+  prerelease: 6
+platform: ruby
+authors:
+- Kyle Brett
+- Paul Bergeron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70134974768260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70134974768260
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70134974767320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70134974767320
+description: Dzl zones live!
+email:
+- kyle@vitrue.com
+- pbergeron@vitrue.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- config.ru
+- dzl.gemspec
+- lib/dzl.rb
+- lib/dzl/doc.rb
+- lib/dzl/doc/endpoint_doc.rb
+- lib/dzl/doc/router_doc.rb
+- lib/dzl/doc/task.rb
+- lib/dzl/doc/templates/endpoint.erb
+- lib/dzl/doc/templates/home.erb
+- lib/dzl/dsl_proxies/defaults.rb
+- lib/dzl/dsl_proxies/endpoint.rb
+- lib/dzl/dsl_proxies/parameter.rb
+- lib/dzl/dsl_proxies/parameter_block.rb
+- lib/dzl/dsl_proxies/protection.rb
+- lib/dzl/dsl_proxies/router.rb
+- lib/dzl/dsl_proxy.rb
+- lib/dzl/dsl_subject.rb
+- lib/dzl/dsl_subjects/defaults.rb
+- lib/dzl/dsl_subjects/endpoint.rb
+- lib/dzl/dsl_subjects/parameter.rb
+- lib/dzl/dsl_subjects/parameter/allowed_values.rb
+- lib/dzl/dsl_subjects/parameter/type_conversion.rb
+- lib/dzl/dsl_subjects/parameter_block.rb
+- lib/dzl/dsl_subjects/protection.rb
+- lib/dzl/dsl_subjects/router.rb
+- lib/dzl/errors.rb
+- lib/dzl/examples/base.rb
+- lib/dzl/examples/fun_with_handlers.rb
+- lib/dzl/examples/fun_with_hooks.rb
+- lib/dzl/examples/fun_with_params.rb
+- lib/dzl/examples/fun_with_requests.rb
+- lib/dzl/examples/route_profile.rb
+- lib/dzl/examples/trey.rb
+- lib/dzl/logger.rb
+- lib/dzl/rack_interface.rb
+- lib/dzl/request.rb
+- lib/dzl/response_context.rb
+- lib/dzl/response_context/request_helpers.rb
+- lib/dzl/validator.rb
+- lib/dzl/validators/size.rb
+- lib/dzl/validators/value.rb
+- lib/dzl/value_or_error.rb
+- lib/dzl/version.rb
+- spec/dsl_subject_spec.rb
+- spec/endpoint_doc_spec.rb
+- spec/fun_with_handlers_spec.rb
+- spec/fun_with_hooks_spec.rb
+- spec/fun_with_params_spec.rb
+- spec/fun_with_requests_spec.rb
+- spec/logger_spec.rb
+- spec/route_params_spec.rb
+- spec/router_doc_spec.rb
+- spec/spec_helper.rb
+- spec/trey_spec.rb
+- spec/value_or_error_spec.rb
+homepage: http://github.com/vitrue/dzl
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Parameter validation and request routing DSL & framework
+test_files:
+- spec/dsl_subject_spec.rb
+- spec/endpoint_doc_spec.rb
+- spec/fun_with_handlers_spec.rb
+- spec/fun_with_hooks_spec.rb
+- spec/fun_with_params_spec.rb
+- spec/fun_with_requests_spec.rb
+- spec/logger_spec.rb
+- spec/route_params_spec.rb
+- spec/router_doc_spec.rb
+- spec/spec_helper.rb
+- spec/trey_spec.rb
+- spec/value_or_error_spec.rb