service_jynx 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c009a39d4d2e7c6cc7def699c51e36dbf5c3afd
-  data.tar.gz: 17f338eda74d45838774899c5091e96dfb07e579
+  metadata.gz: 31a8eeaba3f5ddc9eec324006473b0809e5b917e
+  data.tar.gz: aa1348f58ab0d36f3402e4f2e679657abacfa6ba
 SHA512:
-  metadata.gz: 847b210f597317a88396ce42468b4c313c6b9207dedfe1f94888fa05e31aa2431f7496b528d2f52e319d14c06ddf482f09f4bd1749bd9f7c20943ca262e1201d
-  data.tar.gz: 0f98d7d2ed5d9a1068c66856d51779b8f8b4119753a8bd30418b56c0ab6d035bb84ec294a2fbfe26d458f24fb365032007087b725140705c4c338087f5d56703
+  metadata.gz: 25b220479d24fe6adfc5b60c6bb784fe912d0cc06942bf494c612f901f760f5db1ed538eb4482347eb2fb0e42722ed5b038229fcc03d2136508192475321a7f4
+  data.tar.gz: b1cf5af0c289a4e1008bf384e65f92c9273a0605e5bda4a74c325d02902254da2ec776560669d4ace659432dba536e4ccda67cd5a1aba67a9af451a1f73a1ac0

data/README.md

@@ -16,9 +16,9 @@ The code is MRI depended and is not thread safe(!), is is also designed specific
 
   def index
     begin
-      response = {countery: "Israel"}
+      response = {country: "Israel"}
       if ServiceJynx.alive?("inbox")
-        response = {countery: HTTParty.get("https://api.github.com/users/AvnerCohen", :timeout => 20)["location"]}
+        response = {country: HTTParty.get("https://api.github.com/users/AvnerCohen", :timeout => 20)["location"]}
       else
         response.merge!({error: "service down ! #{__method__}"})
       end
@@ -26,12 +26,54 @@ The code is MRI depended and is not thread safe(!), is is also designed specific
       ServiceJynx.failure!("inbox")
       response.merge!({error: "exception occured, #{__method__}"})
     ensure
-      render json: response.to_json and return
+      render json: response and return
     end
   end
 
 ````
 
+
+## Complete Use case extracted
+
+[1] Register the service for Jynx monitoring at application start time:
+
+````
+  opts = {
+    time_window_in_seconds: 20,
+    max_errors: 10,
+    grace_period: 60
+  }
+  ServiceJynx.register!("github_api", opts)
+````
+
+[2] Define a module that wraps your HTTP calls to have a generic safe api
+
+````
+module HttpInternalWrapper
+  extend self
+    def get_api(service_name, url, &on_error_block)
+      if ServiceJynx.alive?(service_name)
+            HTTParty.get(url, :timeout => 20)
+      else
+        on_error_block.call("#{service_name}_service set as down.")
+      end
+    rescue Exception => e
+      ServiceJynx.failure!(service_name)
+      on_error_block.call("Exception in #{service_name}_service exceution - #{e.message}")
+    end
+end
+````
+
+[3] Execute with a stubbed on_error_block that gets executed on failure or service down
+
+````
+HttpInternalWrapper.get_api("github_api", "https://api.github.com/users/AvnerCohen") do |msg|
+  @logger.error "#{msg} -- #{path} failed at #{__method__} !!"
+  {error: "Github api is currently unavailable"} # stub an empty hash with error messages
+end
+````
+
+
 ## Defaults
 
 Defined when registering a service:

data/lib/service_jynx.rb

@@ -33,7 +33,12 @@ module ServiceJynx
     now = Time.now.to_i
     jynx.errors << now
     jynx.clean_aged(now)
-    down!(name, "Max error count (#{jynx.max_errors}) reached at #{Time.now}.") if jynx.errors.count > jynx.max_errors
+    if jynx.errors.count > jynx.max_errors
+      down!(name, "Max error count (#{jynx.max_errors}) reached at #{Time.now}.")
+      :WENT_DOWN
+    else
+      :FAIL_MARKED
+    end
   end
 
 

data/lib/service_jynx/version.rb

@@ -1,3 +1,3 @@
 module ServiceJynx
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/service_jynx_spec.rb

@@ -88,6 +88,20 @@ describe ServiceJynx do
     ServiceJynx.alive?(:dummy_service).should eq(false)
   end 
 
+  it "should report result for failure" do
+    ServiceJynx.register!(:dummy_service, {time_window_in_seconds: 2, max_errors: 3})
+    jynx = ServiceJynx.counters.fetch(:dummy_service)
+    ServiceJynx.alive?(:dummy_service).should eq(true)
+    ServiceJynx.failure!(:dummy_service).should eq(:FAIL_MARKED)
+    ServiceJynx.failure!(:dummy_service).should eq(:FAIL_MARKED)
+    ServiceJynx.failure!(:dummy_service).should eq(:FAIL_MARKED)
+    
+    ## After 3 errors, report as down
+    ServiceJynx.failure!(:dummy_service).should eq(:WENT_DOWN)
+    ServiceJynx.alive?(:dummy_service).should eq(false)
+  end  
+
+
   it "should auto disable when errors limit reached old errors and restart again when grace period passes" do
     ServiceJynx.register!(:dummy_service, {time_window_in_seconds: 2, max_errors: 20, grace_period: 5})
     jynx = ServiceJynx.counters.fetch(:dummy_service)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_jynx
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Avner Cohen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies: []
 description: Use errors count over sliding windows to block calls to an external service
   or method, or whatever.