rory 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40ba6de912d0a2eff585bacee9ac6e17583bf70c
-  data.tar.gz: de1a192df73c293d81945d0f015173c3e338484e
+  metadata.gz: df765583fa4f315b7f217e8324523d7dd4b3c2ba
+  data.tar.gz: f977ad97a93566d606319301ea03a06447c2a260
 SHA512:
-  metadata.gz: 864bb31119f46b7f067df7dcb60779844b53efd383f8a40de18376054abb36263694a19b9f40fc0414fcf7ce36577a83a59d55e7f03cedf23e170309a409a2c1
-  data.tar.gz: 23e76ae90efc1de98ecd4cd629ca64624eccc09576156d7cc7a647de7ab07a05326890b9fea1b54304e81138e997c86c51e347a7613a4b8f00e578ca017a08a0
+  metadata.gz: 3c2dd88f139db2931ebe7fdb9153c6ca4180d65f36622fdc51e18859ae55f6661636fe5c5b525564b9ac6973f9980a2e6266b8508317579f87bce4218b68bf83
+  data.tar.gz: 152c81f7ab8498553a4d4e1dce0d583c25d29bd882c8c776178e8b73815b3a3f9a08e2ab3e2300b8c95f50d0b2efc034348522125a0089efac00574ebc5c8a4f

data/lib/rory/application.rb

@@ -118,15 +118,28 @@ module Rory
     end
 
     def turn_off_request_logging!
-      @stack = nil
+      reset_stack
       @request_logging = false
     end
 
+    def parameters_to_filter
+      @parameters_to_filter || [:password]
+    end
+
+    def filter_parameters(*params)
+      reset_stack
+      @parameters_to_filter = params
+    end
+
+    def reset_stack
+      @stack = nil
+    end
+
     def use_default_middleware
       if request_logging_on?
         use_middleware Rack::PostBodyContentTypeParser
         use_middleware Rack::CommonLogger, logger
-        use_middleware Rory::RequestParameterLogger, logger
+        use_middleware Rory::RequestParameterLogger, logger, :filters => parameters_to_filter
       end
     end
 

data/lib/rory/request_parameter_logger.rb

@@ -3,10 +3,10 @@ require_relative 'parameter_filter'
 module Rory
   class RequestParameterLogger
 
-    def initialize(app, logger=nil, filters=[:password])
+    def initialize(app, logger = nil, options = {})
       @app = app
       @logger = logger
-      @filters = filters
+      @filters = options.fetch(:filters, [])
     end
 
     def call(env)

data/lib/rory/version.rb

@@ -1,3 +1,3 @@
 module Rory
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

data/rory.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.name = "rory"
   s.version = Rory::VERSION
   s.platform = Gem::Platform::RUBY
-  s.authors = ["Ravi Gadad"]
+  s.authors = ["Ravi Gadad", "Michael Irey", "David Begin"]
   s.email = ["ravi@screamingmuse.com"]
   s.homepage = "http://github.com/screamingmuse/rory"
   s.summary = "Another Ruby web framework. Just what the world needs."

data/spec/fixture_app/config/application.rb

@@ -1,5 +1,6 @@
 module Fixture
   class Application < Rory::Application
     turn_off_request_logging!
+    filter_parameters :orcas, :noodles
   end
 end

data/spec/lib/rory/application_spec.rb

@@ -61,14 +61,20 @@ describe Rory::Application do
     end
   end
 
+  describe ".dispatcher" do
+    it "returns new dispatcher rack app" do
+      allow(Rory::Dispatcher).to receive(:rack_app).
+        with(subject).and_return(:dispatcher_app)
+      expect(subject.dispatcher).to eq(:dispatcher_app)
+    end
+  end
+
   describe ".call" do
-    it "forwards arg to new dispatcher, and calls dispatch" do
-      dispatcher = double(:dispatch => :expected)
-      rack_request = double(:media_type => 'application/json')
-      env = { "rack.input" => double(:read => {}) }
-      allow(Rack::Request).to receive(:new).with(env).and_return(rack_request)
-      expect(Rory::Dispatcher).to receive(:new).with(rack_request, subject.instance).and_return(dispatcher)
-      expect(subject.call(env)).to eq(:expected)
+    it "calls the stack with the given environment" do
+      stack = double
+      allow(stack).to receive(:call).with(:the_env).and_return(:expected)
+      expect(subject.instance).to receive(:stack).and_return(stack)
+      expect(subject.call(:the_env)).to eq(:expected)
     end
   end
 
@@ -90,7 +96,7 @@ describe Rory::Application do
   end
 
   describe ".logger" do
-    it "reutrns a logger" do
+    it "returns a logger" do
       logger = double
       allow_any_instance_of(subject).to receive(:log_file)
       allow(Logger).to receive(:new).and_return(logger)
@@ -98,19 +104,68 @@ describe Rory::Application do
     end
   end
 
+  describe ".turn_off_request_logging!" do
+    it "resets stack and turns off request logging" do
+      subject.instance.instance_variable_set(:@request_logging, :true)
+      expect(subject.request_logging_on?).to eq(true)
+      expect(subject.instance).to receive(:reset_stack)
+      subject.turn_off_request_logging!
+      expect(subject.request_logging_on?).to eq(false)
+    end
+  end
+
+  describe ".filter_parameters" do
+    it "resets stack and sets parameters to filter" do
+      expect(subject.instance).to receive(:reset_stack)
+      subject.filter_parameters :dog, :kitty
+      expect(subject.parameters_to_filter).to eq([:dog, :kitty])
+    end
+  end
+
+  describe ".reset_stack" do
+    it "clears memoization of stack" do
+      stack = subject.stack
+      expect(subject.stack).to eq(stack)
+      subject.reset_stack
+      expect(subject.stack).not_to eq(stack)
+    end
+  end
+
+  describe ".stack" do
+    it "returns a rack builder instance with configured middleware" do
+      builder = double
+      allow(subject.instance).to receive(:dispatcher).
+        and_return(:the_dispatcher)
+      allow(Rack::Builder).to receive(:new).and_return(builder)
+      subject.use_middleware :horse
+      expect(subject.instance).to receive(:use_default_middleware)
+      expect(builder).to receive(:use).with(:horse)
+      expect(builder).to receive(:run).with(:the_dispatcher)
+      expect(subject.stack).to eq(builder)
+    end
+  end
+
+  describe ".parameters_to_filter" do
+    it "returns [:password] by default" do
+      expect(subject.parameters_to_filter).to eq([:password])
+    end
+  end
+
   describe ".use_default_middleware" do
     it "adds middleware when request logging is on" do
       allow(subject.instance).to receive(:request_logging_on?).and_return(true)
+      allow(subject.instance).to receive(:parameters_to_filter).and_return([:horses])
       allow(subject.instance).to receive(:logger).and_return(:the_logger)
+      expect(subject.instance).to receive(:use_middleware).with(Rack::PostBodyContentTypeParser)
+      expect(subject.instance).to receive(:use_middleware).with(Rack::CommonLogger, :the_logger)
+      expect(subject.instance).to receive(:use_middleware).with(Rory::RequestParameterLogger, :the_logger, :filters => [:horses])
       subject.use_default_middleware
-      expect(subject.middleware.count).to_not eq(0)
     end
 
     it "does not add middleware when request logging is off" do
       allow(subject.instance).to receive(:request_logging_on?).and_return(false)
-      allow(subject.instance).to receive(:logger).and_return(:the_logger)
+      expect(subject.instance).to receive(:use_middleware).never
       subject.use_default_middleware
-      expect(subject.middleware.count).to eq(0)
     end
   end
 
@@ -201,5 +256,11 @@ describe Rory::Application do
         ]
       end
     end
+
+    describe ".parameters_to_filter" do
+      it "returns overridden parameters" do
+        expect(subject.parameters_to_filter).to eq([:orcas, :noodles])
+      end
+    end
   end
 end

data/spec/lib/rory/dispatcher_spec.rb

@@ -55,6 +55,15 @@ describe Rory::Dispatcher do
     end
   end
 
+  describe ".rack_app" do
+    it "returns a callable object that dispatches to a new dispatcher" do
+      allow(Rack::Request).to receive(:new).with(:env).and_return(:a_request)
+      allow(described_class).to receive(:new).with(:a_request, :the_app).and_return(subject)
+      allow(subject).to receive(:dispatch).and_return(:the_dispatch)
+      expect(described_class.rack_app(:the_app).call(:env)).to eq(:the_dispatch)
+    end
+  end
+
   describe "#dispatch" do
     let(:request) { { :whatever => :yay } }
     before(:each) do

data/spec/lib/rory/request_parameter_logger_spec.rb

@@ -2,7 +2,7 @@ describe Rory::RequestParameterLogger do
 
   let(:logger) { double(:write) }
   let(:app) { double(:call) }
-  subject { described_class.new(app, logger, :filters) }
+  subject { described_class.new(app, logger, :filters => :filters) }
 
   describe '#initialize' do
     it 'returns a new RequestParameterLogger' do
@@ -14,6 +14,11 @@ describe Rory::RequestParameterLogger do
       expect(subject.instance_variable_get(:@logger)).to eq(logger)
       expect(subject.instance_variable_get(:@filters)).to eq(:filters)
     end
+
+    it 'defaults filters to empty array' do
+      no_filter_logger = described_class.new(app, logger)
+      expect(no_filter_logger.instance_variable_get(:@filters)).to eq([])
+    end
   end
 
   describe '#log_request' do

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rory
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Ravi Gadad
+- Michael Irey
+- David Begin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack