LVS-JSONService 0.3.6 → 0.3.7

data/.specification

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: LVS-JSONService 
 version: !ruby/object:Gem::Version 
-  version: 0.3.6
+  version: 0.3.7
 require_paths:
 - lib
 platform: ruby

data/LVS-JSONService.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{LVS-JSONService}
-  s.version = "0.3.6"
+  s.version = "0.3.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["LVS", "andyjeffries"]

data/VERSION

@@ -1 +1 @@
-0.3.6
+0.3.7

data/lib/lvs/json_service/base.rb

@@ -220,7 +220,7 @@ module LVS
     class Error < StandardError
       attr_reader :message, :code, :service, :args, :json_response
 
-      def initialize(message, code, service, args, response=nil)
+      def initialize(message, code=nil, service=nil, args=nil, response=nil)
         @message = message
         @code   = code
         @service = service
@@ -235,5 +235,6 @@ module LVS
     class TimeoutError < Error; end
     class BackendUnavailableError < Error; end
     class NotModified < Error; end
+    class RequestMismatchError < Error; end
   end
 end

data/lib/lvs/json_service/request.rb

@@ -19,7 +19,8 @@ module LVS
           uri = URI.parse(service)
         
           req = Net::HTTP::Post.new(uri.path)
-          args[:requestId] = unique_request_id
+          req.add_field("X-LVS-Request-ID", options[:request_id])
+          
           req.form_data = { "object_request" => args.to_json }
 
           options[:encrypted] ||= require_ssl?
@@ -78,11 +79,13 @@ module LVS
         def run_remote_request(service, args, options = {})
           LVS::JsonService::Logger.debug "Requesting '#{service}' with #{args.to_json}"
           
+          options[:request_id] = unique_request_id
           if options[:cached_for]
             timing = "CACHED"
             response, result = Rails.cache.fetch([service, args].cache_key, :expires_in => options[:cached_for]) do
               start = Time.now
               response = http_request_with_timeout(service, args, options)
+              verify_request_id(response, options[:request_id])
               net_timing = ("%.1f" % ((Time.now - start) * 1000)) + "ms"
               start = Time.now
               result = JSON.parse(response.body)
@@ -93,6 +96,7 @@ module LVS
           else
             start = Time.now
             response = http_request_with_timeout(service, args, options)
+            verify_request_id(response, options[:request_id])
             net_timing = ("%.1f" % ((Time.now - start) * 1000)) + "ms"
             start = Time.now
             result = JSON.parse(response.body)
@@ -110,6 +114,14 @@ module LVS
           end
           result
         end
+        
+        def verify_request_id(response, request_id)
+          returned_request_id = response["X-LVS-Request-ID"]
+          if returned_request_id != request_id && !returned_request_id.blank?
+            raise LVS::JsonService::RequestMismatchError.new("The sent Request ID (#{request_id}) didn't " + 
+              "match the returned Request ID (#{returned_request_id}) ")
+          end
+        end
       end
     end
   end

data/spec/lvs/json_service/request_spec.rb

@@ -234,6 +234,78 @@ describe LVS::JsonService::Request do
         ClassWithRequest.run_remote_request(@url, @args, @options)
       }.should raise_error(LVS::JsonService::Error)
     end
+
+    it "should generate a unique Request ID" do
+      ClassWithRequest.unique_request_id.should_not eql(ClassWithRequest.unique_request_id)
+    end
+    
+    it "should send a Request ID" do
+      @mock_post = mock(:post, :null_object => true)
+      Net::HTTP::Post.stub!(:new).and_return(@mock_post)
+      @mock_post.should_receive(:add_field).with("X-LVS-Request-ID", '1234')
+      
+      @mock_http = MockNetHttp.new
+      @connection = @mock_http.connection
+      Net::HTTP.stub!(:new).and_return(@mock_http)      
+
+      response = {}
+      response.stub!(:body).and_return("")
+      JSON.stub(:parse)
+      ClassWithRequest.stub!(:unique_request_id).and_return('1234')
+      ClassWithRequest.stub!(:verify_request_id)
+      ClassWithRequest.run_remote_request(@url, @args, @options)
+    end
+    
+    it "should raise an error if the Request ID doesn't match the one returned" do
+      @mock_post = mock(:post, :null_object => true)
+      Net::HTTP::Post.stub!(:new).and_return(@mock_post)
+      @mock_http = MockNetHttp.new
+      @connection = @mock_http.connection
+      Net::HTTP.stub!(:new).and_return(@mock_http)      
+
+      response = {"X-LVS-Request-ID" => "5678"}
+      response.stub!(:body).and_return("")
+      ClassWithRequest.stub!(:http_request_with_timeout).and_return(response)
+      JSON.stub(:parse)
+      ClassWithRequest.stub!(:unique_request_id).and_return('1234')
+      lambda {
+        ClassWithRequest.run_remote_request(@url, @args, @options)
+      }.should raise_error(LVS::JsonService::RequestMismatchError)
+    end
+    
+    it "shouldn't raise an error if the Request ID matches the one returned" do
+      @mock_post = mock(:post, :null_object => true)
+      Net::HTTP::Post.stub!(:new).and_return(@mock_post)
+      @mock_http = MockNetHttp.new
+      @connection = @mock_http.connection
+      Net::HTTP.stub!(:new).and_return(@mock_http)      
+
+      response = {"X-LVS-Request-ID" => "5678"}
+      response.stub!(:body).and_return("")
+      ClassWithRequest.stub!(:http_request_with_timeout).and_return(response)
+      JSON.stub(:parse)
+      ClassWithRequest.stub!(:unique_request_id).and_return('5678')
+      lambda {
+        ClassWithRequest.run_remote_request(@url, @args, @options)
+      }.should_not raise_error(LVS::JsonService::RequestMismatchError)
+    end
+    
+    it "shouldn't raise an error if there is no response Request ID header" do
+      @mock_post = mock(:post, :null_object => true)
+      Net::HTTP::Post.stub!(:new).and_return(@mock_post)
+      @mock_http = MockNetHttp.new
+      @connection = @mock_http.connection
+      Net::HTTP.stub!(:new).and_return(@mock_http)      
+
+      response = {}
+      response.stub!(:body).and_return("")
+      ClassWithRequest.stub!(:http_request_with_timeout).and_return(response)
+      JSON.stub(:parse)
+      ClassWithRequest.stub!(:unique_request_id).and_return('5678')
+      lambda {
+        ClassWithRequest.run_remote_request(@url, @args, @options)
+      }.should_not raise_error(LVS::JsonService::RequestMismatchError)
+    end
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: LVS-JSONService
 version: !ruby/object:Gem::Version 
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors: 
 - LVS