snitcher 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5ce9137c78af3585cd04a72db5dcfa25890c5c58
-  data.tar.gz: 0382afa241770a4ce4eb1757fa3e3dd911ac608a
+SHA256:
+  metadata.gz: 28c075e51d743b5bd9cfea27193db58b8eadd72774ac4d1478800ffe6b73fb12
+  data.tar.gz: e08200f4bc411eed2c909c91cac08bb993497063a8955f0155f499c27f35fc43
 SHA512:
-  metadata.gz: 9f4d73519250309f111a2359162a4748eeccf10161aa3f37dce680372b11c2d611efd32c1da98a4c2246c0e3f653e00c6a832cf99964ca668c87049bb44a7f57
-  data.tar.gz: 03a7310d071a11568fcb2f6d05abf74c69138dc8211715c9d8782431fada6d0136ddf5772e443f043aff40e6b5bf16b1483bf97534988dc95789165cc5361172
+  metadata.gz: f53823e4e0ba5ea1d435104de453427dcafa2f32a51bc092ad7f679c1b79a24a8ba0e9a06dcc7850b30e29c776d78e2b8652ec1099012de89b1093bfa8aa9232
+  data.tar.gz: a793e491ed792109ec1702287a575d893f215385863add7844242e6524cde7078b4479c1f1fef5fc762f906b0ba4bb3cd7df8dd6f40cfeeaaca3a16208b88d5a

data/.travis.yml

@@ -14,7 +14,9 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
-  - 2.3.1
+  - 2.3
+  - 2.4
+  - 2.5
   - jruby
   - ruby-head
 

data/CHANGELOG.md

@@ -1,9 +1,12 @@
+## 0.4.1 / 2018-07-09
+* [FEATURE] Added :status option to Snitcher.snitch! ([@gaffneyc](https://github.com/gaffneyc))
+*
 ## 0.4.0 / 2016-06-20
 * [FEATURE] Added Snitcher::API for integrating with the DMS API ([@danabrit](https://github.com/danabrit))
 * [FEATURE] Added Snitcher.snitch! which raises exceptions on errors ([@gaffneyc](https://github.com/gaffneyc))
 
 ## 0.3.2 / 2015-08-13
-* [BUG] Fixed passing messaging during a check-in ([@ryoung](https://github.com/ryoung))
+* [BUG] Fixed passing messages during a check-in ([@ryoung](https://github.com/ryoung))
 
 ## 0.3.1 / 2015-06-23
 * [ENHANCEMENT] Add a custom User-Agent

data/README.md

@@ -23,6 +23,14 @@ You also may provide a message with the check in:
 Snitcher.snitch("c2354d53d2", message: "Finished in 23.8 seconds.")
 ```
 
+Errors can be reported by providing the `status` option. A status of `nil`,
+`0`, or `""` are all considered a success. Any other status is treated as a
+failure.
+
+```ruby
+Snitcher.snitch("c2354d53d2", status: 1)
+```
+
 The default timeout of 5 seconds can be overridden:
 
 ```ruby

data/lib/snitcher.rb

@@ -17,6 +17,9 @@ module Snitcher
   # @option opts [String] :message Text message to include with the check-in.
   #   The message is limited to 256 characters.
   #
+  # @option opts [String, Fixnum, nil] :status Exit code for the check-in. A
+  #   status of "", nil, or 0 are all treated as the job finishing successfully.
+  #
   # @option opts [Float, Fixnum] :timeout Number of seconds to wait for a
   #   response from the server. Default is 5 seconds.
   #
@@ -26,8 +29,18 @@ module Snitcher
   #
   # @return [Boolean] if the check-in succeeded.
   def snitch!(token, opts = {})
-    uri       = URI.parse(checkin_url(opts, token))
-    uri.query = URI.encode_www_form(m: opts[:message]) if opts[:message]
+    params = {}
+    params[:m] = opts[:message] if opts[:message]
+
+    # It's unnecessary to send an empty status
+    if opts[:status] && opts[:status] != ""
+      params[:s] = opts[:status]
+    end
+
+    uri = URI.parse(checkin_url(opts, token))
+    if params.any?
+      uri.query = URI.encode_www_form(params)
+    end
 
     opts = initialize_opts(opts, uri)
 
@@ -51,6 +64,9 @@ module Snitcher
   # @option opts [String] :message Text message to include with the check-in.
   #   The message is limited to 256 characters.
   #
+  # @option opts [String, Fixnum, nil] :status Exit code for the check-in. A
+  #   status of "", nil, or 0 are all treated as the job finishing successfully.
+  #
   # @option opts [Float, Fixnum] :timeout Number of seconds to wait for a
   #   response from the server. Default is 5 seconds.
   #
@@ -74,7 +90,7 @@ module Snitcher
       open_timeout: timeout,
       read_timeout: timeout,
       ssl_timeout:  timeout,
-      use_ssl:      use_ssl?(uri)
+      use_ssl:      use_ssl?(uri),
     }
   end
 

data/lib/snitcher/version.rb

@@ -1,3 +1,3 @@
 module Snitcher
-  VERSION = "0.4.0"
+  VERSION = "0.4.1".freeze
 end

data/spec/snitcher_spec.rb

@@ -48,6 +48,19 @@ describe Snitcher do
       end
     end
 
+    specify "with status" do
+      Snitcher.snitch!(token, status: "0")
+      expect(a_request(:get, "https://nosnch.in/#{token}?s=0")).to have_been_made
+
+      Snitcher.snitch!(token, status: 1237)
+      expect(a_request(:get, "https://nosnch.in/#{token}?s=1237")).to have_been_made
+
+      # Both nil and "" avoid adding the `s` query param.
+      Snitcher.snitch!(token, status: nil)
+      Snitcher.snitch!(token, status: "")
+      expect(a_request(:get, "https://nosnch.in/#{token}")).to have_been_made.twice
+    end
+
     it "raises a Timeout::Error if the request timesout" do
       stub_request(:get, "https://nosnch.in/#{token}").to_timeout
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snitcher
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Collective Idea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple API client for deadmanssnitch.com