dzl 1.0.0.rc9 → 1.0.0.rc10

data/config.ru

@@ -30,10 +30,10 @@ end
 #   run Dzl::Examples::RouteProfile
 # end
 
-require 'dzl/examples/fun_with_handlers'
-map '/' do
-  run Dzl::Examples::FunWithHandlers
-end
+# require 'dzl/examples/fun_with_handlers'
+# map '/' do
+#   run Dzl::Examples::FunWithHandlers
+# end
 
 # require 'dzl/examples/fun_with_hooks'
 # map '/' do
@@ -45,10 +45,10 @@ end
 #   run Dzl::Examples::FunWithScopes
 # end
 
-# require 'dzl/examples/fun_with_hashes'
-# map '/' do
-#   run Dzl::Examples::FunWithHashes
-# end
+require 'dzl/examples/fun_with_hashes'
+map '/' do
+  run Dzl::Examples::FunWithHashes
+end
 
 # require 'dzl/examples/fun_with_pblocks'
 # map '/' do

data/lib/dzl/core_ext.rb

@@ -6,10 +6,20 @@ class Hash
   def recursively_symbolize_keys!
     self.symbolize_keys!
     self.values.each do |v|
-      if v.is_a?(Hash)
+      if v.is_a?(Hash) || v.is_a?(Array)
         v.recursively_symbolize_keys!
       end
     end
     self
   end
-end
+end
+
+class Array
+  def recursively_symbolize_keys!
+    self.each do |item|
+      if item.is_a?(Hash) || item.is_a?(Array)
+        item.recursively_symbolize_keys!
+      end
+    end
+  end
+end

data/lib/dzl/dsl_proxies/parameter.rb

@@ -48,10 +48,6 @@ class Dzl::DSLProxies::Parameter < Dzl::DSLProxy
     end
 
     if type == Hash
-      unless @subject.router.subject(2).is_a?(Dzl::DSLSubjects::Endpoint)
-        raise Dzl::NYI.new("Hash parameters may only be specified in endpoints, for now")
-      end
-
       raise Dzl::RetryBlockPlease.new(
         subject: HashValidator.new(
           @subject.opts.except(:type_opts).reverse_merge(format: :json)

data/lib/dzl/dsl_proxies/protection.rb

@@ -3,4 +3,8 @@ class Dzl::DSLProxies::Protection < Dzl::DSLProxy
     raise ArgumentError unless [:username, :password].all? {|k| opts[k].present?}
     @subject.opts[:http_basic] = opts
   end
-end
+  def api_key(opts)
+    raise ArgumentError unless [:header, :valid_keys].all? {|k| opts[k].present?}
+    @subject.opts[:api_key] = opts
+  end
+end

data/lib/dzl/dsl_subjects/parameter_block.rb

@@ -21,6 +21,9 @@ class Dzl::DSLSubjects::ParameterBlock < Dzl::DSLSubject
       if param.opts[:type] == Hash
         param = if parandidate.nil? && param.opts[:required]
           Dzl::ValueOrError.new(e: param.opts[:header] ? :missing_required_header : :missing_required_param)
+        elsif parandidate.nil?
+          # TODO HashValidator with default values
+          Dzl::ValueOrError.new(v: :__no_value__)
         else
           unless parandidate.is_a?(Hash)
             if param.opts[:format] == :json

data/lib/dzl/dsl_subjects/protection.rb

@@ -1,6 +1,7 @@
 require 'dzl/dsl_proxies/protection'
 
 class Dzl::RespondWithHTTPBasicChallenge < StandardError; end
+class Dzl::RespondWithInvalidAPIKey < StandardError; end
 
 class Dzl::DSLSubjects::Protection < Dzl::DSLSubject
   def initialize
@@ -15,17 +16,34 @@ class Dzl::DSLSubjects::Protection < Dzl::DSLSubject
     if @opts[:http_basic].present?
       @auth = Rack::Auth::Basic::Request.new(request.env)
       if @auth.provided? && @auth.basic? && @auth.credentials
+        # Invalid basic auth credentials
         unless @auth.credentials[0] == @opts[:http_basic][:username] &&
                @auth.credentials[1] == @opts[:http_basic][:password]
-          Dzl::ValueOrError.new(e: :invalid_http_basic_credentials)
-        else
-          Dzl::ValueOrError.new(v: nil)
+          return Dzl::ValueOrError.new(e: :invalid_http_basic_credentials)
         end
+        # No basic auth credentials provided
       else
-        Dzl::ValueOrError.new(e: :no_http_basic_credentials)
+        return Dzl::ValueOrError.new(e: :no_http_basic_credentials)
       end
-    else
-      Dzl::ValueOrError.new(v: nil)
     end
+
+    if @opts[:api_key].present?
+      api_key_header = @opts[:api_key][:header]
+      allowed_keys = @opts[:api_key][:valid_keys]
+      request_key = request.headers[api_key_header]
+
+      if request_key
+        # Invalid API key provided
+        unless allowed_keys.include? request_key
+          return Dzl::ValueOrError.new(e: :invalid_api_key)
+        end
+      # No API key provided
+      else
+        return Dzl::ValueOrError.new(e: :no_api_key)
+      end
+    end
+
+    # Auth passed
+    return Dzl::ValueOrError.new(v: nil)
   end
-end
+end

data/lib/dzl/dsl_subjects/router.rb

@@ -99,7 +99,12 @@ class Dzl::DSLSubjects::Router < Dzl::DSLSubject
       raise Dzl::RespondWithHTTPBasicChallenge
     end
 
+    if !errors.empty? &&
+        errors.values.any? {|v| v == :no_api_key || v == :invalid_api_key}
+      raise Dzl::RespondWithInvalidAPIKey
+    end
+
     endpoint || raise(Dzl::NotFound.new(errors))
   end
   
-end
+end

data/lib/dzl/examples/fun_with_hashes.rb

@@ -28,4 +28,33 @@ class Dzl::Examples::FunWithHashes < Dzl::Examples::Base
       allowed_values %w{one two three}
     end
   end
+
+  pblock :ingredients do
+    required :ingredients do
+      type Hash
+      required :cheese, :meat, :bread
+    end
+  end
+
+  post '/boring_sandwich' do
+    import_pblock :ingredients
+  end
+
+  post '/awesome_sandwich' do
+    import_pblock :ingredients
+    parameter :ingredients do
+      required(:meat) { type Array }
+    end
+  end
+
+  post '/another_boring_sandwich' do
+    import_pblock :ingredients
+  end
+
+  post '/elis_bug' do
+    optional :hash do
+      type Hash
+      optional(:id) { type Fixnum }
+    end
+  end
 end

data/lib/dzl/examples/fun_with_params.rb

@@ -48,6 +48,12 @@ class Dzl::Examples::FunWithParams < Dzl::Examples::Base
     end
   end
 
+  endpoint '/api' do
+    protect do
+      api_key header: 'x_api_key', valid_keys: ['valid-key']
+    end
+  end
+
   endpoint '/arithmetic' do
     optional :int do
       type Fixnum

data/lib/dzl/rack_interface.rb

@@ -15,6 +15,8 @@ module Dzl::RackInterface
       [__router.handle_request(request), nil]
     rescue Dzl::RespondWithHTTPBasicChallenge
       [respond_with_http_basic_challenge, nil]
+    rescue Dzl::RespondWithInvalidAPIKey
+      [respond_with_invalid_api_key, nil]
     rescue Dzl::Error => e
       [respond_with_dzl_error_handler(e), nil]
     rescue StandardError => e
@@ -51,6 +53,14 @@ module Dzl::RackInterface
     response.finish
   end
 
+  def respond_with_invalid_api_key
+    response = Rack::Response.new
+    response.status = 401
+    response.headers['Content-Type'] = 'text/html'
+    response.write("Not Authorized\n")
+    response.finish
+  end
+
   def respond_with_standard_error_handler(e)
     response = Rack::Response.new
     response.headers['Content-Type'] = 'application/json'
@@ -108,4 +118,4 @@ module Dzl::RackInterface
       end
     end
   end
-end
+end

data/lib/dzl/version.rb

@@ -1,3 +1,3 @@
 module Dzl
-  VERSION = "1.0.0.rc9"
+  VERSION = "1.0.0.rc10"
 end

data/lib/hash_validator/hash_validator.rb

@@ -24,6 +24,16 @@ class HashValidator
     @template[:opts]
   end
 
+  def overwrite_opts(opts)
+    @template[:opts].merge(opts)
+  end
+
+  def clone
+    copy = HashValidator.new
+    copy.instance_variable_set(:@template, Marshal.load(Marshal.dump(@template)))
+    copy
+  end
+
   def valid?(hsh)
     return false unless hsh.keys.all? { |key| top[:keys].include?(key) }
 
@@ -71,7 +81,6 @@ class HashValidator
   def key(k, opts, &block)
     top[:keys][k] = {
       opts: opts,
-      block: block,
       keys: {}
     }
 

data/spec/fun_with_hashes_spec.rb

@@ -29,16 +29,6 @@ describe 'hash parameters' do
       }.to raise_exception(Dzl::Deprecated)
     end
 
-    specify 'NYI: hash parameters are currently only allowed in anonymous pblocks' do
-      expect {
-        class T1 < Dzl::Examples::Base
-          pblock :broken do
-            required(:foo) { type Hash }
-          end
-        end
-      }.to raise_error(Dzl::NYI)
-    end
-
     specify 'hash parameters retry their blocks against a hash validator' do
       HashValidator.any_instance.should_receive(:key).with(:key, {required: true, type: String})
       class T1 < Dzl::Examples::Base
@@ -86,6 +76,38 @@ describe 'hash parameters' do
     end
   end
 
+  context 'importing & reopening' do
+    specify 'works, basically' do
+      boring_sandwich = {
+        bread: 'multi-grain',
+        meat: 'roast beast',
+        cheese: 'swiss'
+      }
+
+      awesome_sandwich = {
+        bread: 'sourdough',
+        meat: ['roast beast', 'salami', 'turkey'],
+        cheese: 'cheddar'
+      }
+
+      post('/boring_sandwich', {ingredients: boring_sandwich.to_json}) do |response|
+        response.status.should == 200
+      end
+
+      post('/awesome_sandwich', {ingredients: awesome_sandwich.to_json}) do |response|
+        response.status.should == 200
+      end
+
+      post('/another_boring_sandwich', {ingredients: awesome_sandwich.to_json}) do |response|
+        response.status.should == 404
+      end
+
+      post('/another_boring_sandwich', {ingredients: boring_sandwich.to_json}) do |response|
+        response.status.should == 200
+      end
+    end
+  end
+
   context 'validate' do
     specify 'JSON post bodies' do
       header 'Content-Type', 'application/json'
@@ -153,4 +175,17 @@ describe 'hash parameters' do
       get('/mixed', valid).status.should == 200
     end
   end
+
+  context "eli's bug" do
+    specify 'omitted optional hashes are OK' do
+      post('/elis_bug', {hash: {id: 1}.to_json}) do |response|
+        response.status.should == 200
+      end
+
+      post('/elis_bug') do |response|
+        JSON.parse(response.body)['errors'].should == nil
+        response.status.should == 200
+      end
+    end
+  end
 end

data/spec/fun_with_params_spec.rb

@@ -172,6 +172,23 @@ describe Dzl::Examples::FunWithParams do
     end
   end
 
+  describe '/api' do
+    it 'should 401 if no api key provided' do
+      get '/api'
+      last_response.status.should == 401
+    end
+
+    it 'should 401 if invalid api key provided' do
+      get '/api', {}, {"HTTP_X_API_KEY" => 'invalid-key'}
+      last_response.status.should == 401
+    end
+
+    it 'should accept valid api key' do
+      get '/api', {}, {"HTTP_X_API_KEY" => 'valid-key'}
+      last_response.status.should == 200
+    end
+  end
+
   describe '/arithmetic' do
     it 'should not allow :int < 5' do
       get('/arithmetic', {int: 4}) do |response|

data/spec/hash_validator_spec.rb

@@ -280,4 +280,38 @@ describe HashValidator do
       v.valid?({foo: 'three'}).should == true
     end
   end
+
+  context 'cloning' do
+    before(:each) do
+      @original = HashValidator.new do
+        required(:foo)
+      end 
+    end
+
+    specify 'dupes the data in @template' do
+      orig_template = @original.instance_variable_get(:@template)
+
+      cloned = @original.clone
+
+      @original.instance_variable_get(:@template).object_id.should == orig_template.object_id
+      @original.instance_variable_get(:@template).object_id.should_not == cloned.instance_variable_get(:@template).object_id
+      @original.instance_variable_get(:@template).should == cloned.instance_variable_get(:@template)
+
+      cloned.required(:foo) { type Fixnum }
+
+      @original.instance_variable_get(:@template).should_not == cloned.instance_variable_get(:@template)
+      @original.instance_variable_get(:@template)[:keys][:foo][:opts][:type].should == String
+      cloned.instance_variable_get(:@template)[:keys][:foo][:opts][:type].should == Fixnum
+    end
+
+    specify 'validation works as expected' do
+      cloned = @original.clone
+      cloned.required(:foo) { type Fixnum }
+
+      @original.valid?({foo: 'hello'}).should == true
+      @original.valid?({foo: 1}).should == false
+      cloned.valid?({foo: 'hello'}).should == false
+      cloned.valid?({foo: 1}).should == true
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dzl
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc9
+  version: 1.0.0.rc10
   prerelease: 6
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70219390708320 !ruby/object:Gem::Requirement
+  requirement: &70114952344160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *70219390708320
+  version_requirements: *70114952344160
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70219390707820 !ruby/object:Gem::Requirement
+  requirement: &70114952343660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +33,7 @@ dependencies:
         version: 3.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *70219390707820
+  version_requirements: *70114952343660
 description: Small, fast racktivesupport web framework with handy DSL and explicit
   parameter validation.
 email: