LVS-JSONService 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+coverage/
+spec/reports
+pkg/

data/.specification

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

data/JSONService.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{JSONService}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["LVS"]
@@ -13,7 +13,9 @@ Gem::Specification.new do |s|
      "README.rdoc"
   ]
   s.files = [
-    "JSONService.gemspec",
+    ".gitignore",
+     ".specification",
+     "JSONService.gemspec",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -31,23 +33,22 @@ Gem::Specification.new do |s|
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/lvs/JSONService}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{TODO}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{A Ruby library for interacting with external JSON services}
   s.test_files = [
-    "spec/lvs/json_service/base_spec.rb",
+    "spec/json_service_spec.rb",
+     "spec/lvs/json_service/base_spec.rb",
      "spec/lvs/json_service/logger_spec.rb",
      "spec/lvs/json_service/request_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/json_service_spec.rb"
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/lvs/json_service/request.rb

@@ -4,72 +4,80 @@ require 'lvs/json_service/logger'
 module LVS
   module JsonService
     module Request
-      def self.http_request_with_timeout(service, args, options)
+      
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods    
+      end      
+      
+      module ClassMethods      
+      
+        def http_request_with_timeout(service, args, options)
 
-        uri = URI.parse(service)
+          uri = URI.parse(service)
 
-        http = Net::HTTP.new(uri.host, uri.port)
+          http = Net::HTTP.new(uri.host, uri.port)
         
-        if options[:encrypted] && !SSL_DISABLED
-          http.use_ssl = true
-          if options[:auth_cert]
-            http.cert = OpenSSL::X509::Certificate.new(File.read(options[:auth_cert]))
-            http.key = OpenSSL::PKey::RSA.new(File.read(options[:auth_key]), options[:auth_key_password])
+          if options[:encrypted] && !SSL_DISABLED
+            http.use_ssl = true
+            if options[:auth_cert]
+              http.cert = OpenSSL::X509::Certificate.new(File.read(options[:auth_cert]))
+              http.key = OpenSSL::PKey::RSA.new(File.read(options[:auth_key]), options[:auth_key_password])
+            end
           end
-        end
         
-        http.open_timeout = options[:timeout] || 1
-        http.read_timeout = options[:timeout] || 1
+          http.open_timeout = options[:timeout] || 1
+          http.read_timeout = options[:timeout] || 1
         
-        req = Net::HTTP::Post.new(uri.path)
-        req.form_data = { "object_request" => args.to_json }
+          req = Net::HTTP::Post.new(uri.path)
+          req.form_data = { "object_request" => args.to_json }
 
-        retries = options[:retries] || 0
+          retries = options[:retries] || 0
 
-        begin
-          retries -= 1          
-          response = http.start { |connection| connection.request(req) }
+          begin
+            retries -= 1          
+            response = http.start { |connection| connection.request(req) }
           
-        rescue Timeout::Error
-          if retries >= 0
-            LVS::JsonService::Logger.debug(
-              "Retrying #{service} due to TimeoutError"
-            )
-            retry
-          end
-          raise LVS::JsonService::TimeoutError.new("Backend failed to respond in time", 500, service, args)
+          rescue Timeout::Error
+            if retries >= 0
+              LVS::JsonService::Logger.debug(
+                "Retrying #{service} due to TimeoutError"
+              )
+              retry
+            end
+            raise LVS::JsonService::TimeoutError.new("Backend failed to respond in time", 500, service, args)
                     
-        rescue Errno::ECONNREFUSED
-          if retries >= 0
-            LVS::JsonService::Logger.debug(
-              "Retrying #{service} due to Errno::ECONNREFUSED"
-            )
-            sleep(1)  
-            retry
+          rescue Errno::ECONNREFUSED
+            if retries >= 0
+              LVS::JsonService::Logger.debug(
+                "Retrying #{service} due to Errno::ECONNREFUSED"
+              )
+              sleep(1)  
+              retry
+            end
+            raise LVS::JsonService::BackendUnavailableError.new("Backend unavailable", 500, service, args)
           end
-          raise LVS::JsonService::BackendUnavailableError.new("Backend unavailable", 500, service, args)
-        end
-
-        if response.is_a?(Net::HTTPNotFound)
-          raise LVS::JsonService::NotFoundError.new("404 Found for the service", 404, service, args)
-        end
 
-        response
-      end
+          if response.is_a?(Net::HTTPNotFound)
+            raise LVS::JsonService::NotFoundError.new("404 Found for the service", 404, service, args)
+          end
 
-      def self.run_remote_request(service, args, options = {})
-        LVS::JsonService::Logger.debug "run_remote_request('#{service}', #{args.to_json}"
-        response = http_request_with_timeout(service, args, options)
-        if response.body.size < 1024
-          LVS::JsonService::Logger.debug "Response: #{response.body.gsub(/\n/, '')}"
-        else
-          LVS::JsonService::Logger.debug "Response Snippet: #{response.body.gsub(/\n/, '')[0..1024]}"
+          response
         end
-        result = JSON.parse(response.body)
-        if result.is_a?(Hash) && result.has_key?("PCode")
-          raise LVS::JsonService::Error.new(result["message"], result["PCode"], service, args, result)
+
+        def run_remote_request(service, args, options = {})
+          LVS::JsonService::Logger.debug "run_remote_request('#{service}', #{args.to_json}"
+          response = http_request_with_timeout(service, args, options)
+          if response.body.size < 1024
+            LVS::JsonService::Logger.debug "Response: #{response.body.gsub(/\n/, '')}"
+          else
+            LVS::JsonService::Logger.debug "Response Snippet: #{response.body.gsub(/\n/, '')[0..1024]}"
+          end
+          result = JSON.parse(response.body)
+          if result.is_a?(Hash) && result.has_key?("PCode")
+            raise LVS::JsonService::Error.new(result["message"], result["PCode"], service, args, result)
+          end
+          result
         end
-        result
       end
     end
   end

data/spec/lvs/json_service/request_spec.rb

@@ -121,12 +121,12 @@ describe LVS::JsonService::Request do
       
       before :each do
         @options = {:retries => 2}
-        LVS::JsonService::Request.stub!(:sleep)                  
+        ClassWithRequest.stub!(:sleep)                  
       end
       
       it "should sleep for 1 second before each timeout" do
         @connection.stub!(:request).and_raise(Errno::ECONNREFUSED)        
-        LVS::JsonService::Request.should_receive(:sleep).with(1)
+        ClassWithRequest.should_receive(:sleep).with(1)
         do_request_catching_errors
       end
       
@@ -181,7 +181,7 @@ describe LVS::JsonService::Request do
     end
     
     def do_request
-      LVS::JsonService::Request.http_request_with_timeout(@url, @args, @options)
+      ClassWithRequest.http_request_with_timeout(@url, @args, @options)
     end
     
     def do_request_catching_errors
@@ -197,10 +197,10 @@ describe LVS::JsonService::Request do
     end
 
     it "should call http_request_with_timeout with service, args and options" do
-      LVS::JsonService::Request.should_receive(:http_request_with_timeout).
+      ClassWithRequest.should_receive(:http_request_with_timeout).
         with(@url, @args, @options).
         and_return(@response)
-      LVS::JsonService::Request.run_remote_request(@url, @args, @options)
+      ClassWithRequest.run_remote_request(@url, @args, @options)
     end
 
     it "should return the parsed JSON result" do
@@ -208,17 +208,17 @@ describe LVS::JsonService::Request do
         {"id"=>1100, "description"=>"Handball (ABP)"},
         {"id"=>978400, "description"=>"Casino Roulette"}
       ]
-      LVS::JsonService::Request.stub!(:http_request_with_timeout).and_return(@response)
-      LVS::JsonService::Request.run_remote_request(@url, @args, @options).should == expected_result
+      ClassWithRequest.stub!(:http_request_with_timeout).and_return(@response)
+      ClassWithRequest.run_remote_request(@url, @args, @options).should == expected_result
     end
 
     it "should raise an error if the response contains PCode" do
       error_response = load_fixture('error_response.yml')
-      LVS::JsonService::Request.stub!(:http_request_with_timeout).
+      ClassWithRequest.stub!(:http_request_with_timeout).
         and_return(error_response)
 
       lambda {
-        LVS::JsonService::Request.run_remote_request(@url, @args, @options)
+        ClassWithRequest.run_remote_request(@url, @args, @options)
       }.should raise_error(LVS::JsonService::Error)
     end
   end
@@ -247,3 +247,8 @@ class MockNetHttp
   end
     
 end
+
+class ClassWithRequest
+  include LVS::JsonService::Request
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: LVS-JSONService
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - LVS
@@ -23,6 +23,8 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- .gitignore
+- .specification
 - JSONService.gemspec
 - LICENSE
 - README.rdoc
@@ -40,7 +42,7 @@ files:
 - spec/lvs/json_service/request_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/lvs/JSONService
 post_install_message: 
 rdoc_options: 
@@ -64,11 +66,11 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
-summary: TODO
+specification_version: 3
+summary: A Ruby library for interacting with external JSON services
 test_files: 
+- spec/json_service_spec.rb
 - spec/lvs/json_service/base_spec.rb
 - spec/lvs/json_service/logger_spec.rb
 - spec/lvs/json_service/request_spec.rb
 - spec/spec_helper.rb
-- spec/json_service_spec.rb