sinatra-rest-base 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57d73eb788f53e9e785801ac3bc484fa3f64ddca
-  data.tar.gz: df2f1dc92f930e864c202809ac7015f9bf6dafca
+  metadata.gz: 5b8c04a79fba6e26cc1309e58107b3e06d950364
+  data.tar.gz: fce5fc71f80bbbbb0a51c3b023fdd1eb220e01a9
 SHA512:
-  metadata.gz: ebaf5fdcef53ed2b83f9d10e2709ddbefb43c9ad2d7a72890f3c5a353badcb8bac117eb77eaedc2495494d1549b1f929a18af8fab0be13e985c13cd27c315978
-  data.tar.gz: e25c7baf2ae4b255d08976a2b12d663b814821dfb5c8408601706c2d7898f86faa4ba8bf96003004eadf433e6017091c37ea010fc952bfc1bf6a0b0261e065c7
+  metadata.gz: 0077f646ba6a2b2056b4aa2a34e41c013133d60773b282b9a81e6e83172d71daa7e3c2384615ebf1c17d2d88d07b110966117bef00a3e807a3410cb04c46ac3d
+  data.tar.gz: 8f78662d0f61227f4265f4cd6747ee76598a3439eae312298b40aa8f565a7aab7a1b7516ab5f965587527e724ba409ed2df2895336b95acbd04d1011e087b92d

data/lib/rest_base/application.rb

@@ -9,6 +9,7 @@ module RestBase
     attr_reader :request_body
     attr_reader :request_version
     attr_reader :errored
+    attr_reader :forensics
 
     configure do
       disable :raise_errors
@@ -29,6 +30,7 @@ module RestBase
 
       set_api_version if settings.header_versioning
       set_request_body
+      setup_forensics
       error 401 unless authenticated?
     end
 

data/lib/rest_base/application_helper.rb

@@ -36,6 +36,14 @@ module RestBase
       end
     end
     
+    def setup_forensics
+      @forensics = []
+    end
+    
+    def add_forensics_to_response?
+      !@env['Forensics'].nil? && @env['Forensics'].downcase == 'true'
+    end
+    
     def create_response()
       content_type :json
       content_type :xml if !request.accept?('*/*') && request.accept?('text/xml')
@@ -47,10 +55,10 @@ module RestBase
         response.body = nil
       end
       
-      response_hash = {
-        :errors => error_hash,
-        :results => response.body
-      }
+      response_hash = { }
+      response_hash[:errors] = error_hash unless error_hash.nil? || error_hash.empty?
+      response_hash[:result] = response.body unless response.body.nil?
+      response_hash[:forensics] = @forensics if add_forensics_to_response? && !(@forensics.nil? || @forensics.empty?)
       
       return '' if empty_body_status_code? && (response.body.empty?)
       return response_hash.to_xml(:root => :response) if response.headers['Content-Type'].start_with? 'application/xml;'

data/lib/rest_base/version.rb

@@ -1,3 +1,3 @@
 module RestBase
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/fixtures/test_forensics.rb

@@ -0,0 +1,14 @@
+module RestBase
+  module Test
+    class TestApplication
+      get '/forensics', :version => 1 do
+        @forensics << "Added Forensics"
+        "Forensics Test"
+      end
+      
+      get '/forensics_empty', :version => 1 do
+        "Forensics Test"
+      end
+    end
+  end
+end

data/spec/lib/rest_base/application_spec.rb

@@ -23,7 +23,7 @@ describe RestBase::Application do
       
       expect(last_request.env["HTTP_ACCEPT"].include? expected_version).to be_truthy
       expect(last_response.headers["Content-Type"].include? expected_version).to be_truthy
-      expect(last_response.body).to eq({:errors => nil, :results => { :gotten => "success" }}.to_json)
+      expect(last_response.body).to eq({:result => { :gotten => "success" }}.to_json)
     end
     
     it "should get the version 2 version" do
@@ -34,7 +34,7 @@ describe RestBase::Application do
       
       expect(last_request.env["HTTP_ACCEPT"].include? expected_version).to be_truthy
       expect(last_response.headers["Content-Type"].include? expected_version).to be_truthy
-      expect(last_response.body).to eq({:errors => nil, :results => { :gotten => "success 2" }}.to_json)
+      expect(last_response.body).to eq({:result => { :gotten => "success 2" }}.to_json)
     end
   end
   
@@ -56,7 +56,7 @@ describe RestBase::Application do
     it "should return an empty string response" do
       get '/empty', {}, @headers
       
-      expect(last_response.body).to eq({:errors => nil, :results => nil}.to_json)
+      expect(last_response.body).to eq({}.to_json)
     end
   end
   
@@ -79,7 +79,7 @@ describe RestBase::Application do
       get '/created_with_body', {}, @headers
       
       expect(last_response.status).to eq(201)
-      expect(last_response.body).to eq({:errors => nil, :results => {:created => true}}.to_json)
+      expect(last_response.body).to eq({:result => {:created => true}}.to_json)
     end
     
     it "should return a not modified response with empty body" do
@@ -96,16 +96,44 @@ describe RestBase::Application do
       expect(last_response.body).to be_empty
     end
   end
-  
+
+  describe :forensics do
+    before(:each) do
+      @expected_hash = {:result => ["Forensics Test"], :forensics => ["Added Forensics"]}
+      @headers['Forensics'] = 'TRUE'
+    end
+    
+    it "should add forensics to body" do
+      get '/forensics', {}, @headers
+      
+      expect(last_response.body).to eq(@expected_hash.to_json)
+    end
+    
+    it "should not add forensics to body" do
+      @headers.delete('Forensics')
+      get '/forensics', {}, @headers
+      
+      @expected_hash.delete(:forensics)
+      expect(last_response.body).to eq(@expected_hash.to_json)
+    end
+    
+    it "should not add nil/empty forensics to body" do
+      get '/forensics_empty', {}, @headers
+      
+      @expected_hash.delete(:forensics)
+      expect(last_response.body).to eq(@expected_hash.to_json)
+    end
+  end
+    
   describe :json do
     before(:each) do
       @posted_body =  { :success => true }
       
-      @expected_hash = {:errors => nil, :results => { :posted => @posted_body }}
+      @expected_hash = {:result => { :posted => @posted_body }}
     end
     
     it "should get json" do
-      @expected_hash = {:errors => nil, :results => { :gotten => "success" }}
+      @expected_hash = {:result => { :gotten => "success" }}
       
       get '/', {}, @headers
       
@@ -130,7 +158,7 @@ describe RestBase::Application do
     it "should post empty json and return json" do
       post '/', "", @headers
       
-      @expected_hash[:results][:posted] = {}
+      @expected_hash[:result][:posted] = {}
       expect(last_response.body).to eq(@expected_hash.to_json)
     end
     
@@ -145,12 +173,12 @@ describe RestBase::Application do
     before(:each) do
       @posted_body =  { :success => true }
       
-      @expected_hash = {:errors => nil, :results => { :posted => @posted_body }}
+      @expected_hash = {:result => { :posted => @posted_body }}
     end
     
     it "should get xml" do
       @headers['HTTP_ACCEPT'] = 'text/xml'
-      @expected_hash = { :errors => nil, :results => { :gotten => 'success'} }
+      @expected_hash = {:result => { :gotten => 'success'} }
       
       get '/', {}, @headers
       

data/spec/lib/rest_base/error_handeling_spec.rb

@@ -12,8 +12,7 @@ describe RestBase::Application do
           "Invalid Request Format",
           "param1 is not valid: Must be a String",
           "param2 is not valid: Must be an Integer"
-        ],
-        :results => nil
+        ]
       }
       
       get '/invalid_request', {}, @headers

data/spec/lib/rest_base/error_status_handeling_spec.rb

@@ -3,8 +3,7 @@ require 'spec_helper'
 describe RestBase::Application do
   before(:each) do
     @expected_body = {
-      :errors => [],
-      :results => nil
+      :errors => []
     }
     
     @headers = { 'HTTP_AUTHORIZATION' => 'key1' }  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-rest-base
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - bmills
@@ -177,6 +177,7 @@ files:
 - spec/fixtures/test_application.rb
 - spec/fixtures/test_end_points.rb
 - spec/fixtures/test_errors_end_points.rb
+- spec/fixtures/test_forensics.rb
 - spec/lib/rest_base/application_spec.rb
 - spec/lib/rest_base/authentication/authentication_base_spec.rb
 - spec/lib/rest_base/authentication/basic_authentication_spec.rb
@@ -211,6 +212,7 @@ test_files:
 - spec/fixtures/test_application.rb
 - spec/fixtures/test_end_points.rb
 - spec/fixtures/test_errors_end_points.rb
+- spec/fixtures/test_forensics.rb
 - spec/lib/rest_base/application_spec.rb
 - spec/lib/rest_base/authentication/authentication_base_spec.rb
 - spec/lib/rest_base/authentication/basic_authentication_spec.rb