snitcher 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8c248e10b01d23be566aa4d4f0f63c6536b672d
-  data.tar.gz: f3f2054fce497f55b4abcb15be75ebba1b8d1532
+  metadata.gz: dfa2c9e77f2a460c686bc38cb48b271c32276baf
+  data.tar.gz: cb0fe423892d35aec921787bb619e899231148d5
 SHA512:
-  metadata.gz: 86e2b8428cf2f239d1e6dd3eb9bc005e11729f1156c208ec5d3906d379f121748a2fe0179d9ed8da68bbfbc9e7a082d580af0abbdd4ec66ebcf502c9f24c2948
-  data.tar.gz: b0701107c63002a730162abb24d197d9aa3740d85e09956eb86111cd5d2fdfa1ca01c3ea4790226f899b570839fcbba74c9711db0688c56102d30a7afc09e6a9
+  metadata.gz: da4d0919667bc3e3ee37316368c5980fb06e34d9c388f9145fdf58a0cfc4e1229e425842150f32b09bfe7b54e7e00b4f7a6f8989483fbae7338bd8a247dddb58
+  data.tar.gz: 0ee626c061780cfb8d65ff0b68ab7fd9e0226878b11c0ca777393255a4672485c3b3d35581e7214a36e2606cfdda3132de228eeb3536f81740e67020aa558610

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.0 / 2014-10-14
+
+* [FEATURE] Add support for the message parameter during check-in
+* [FEATUER] Add support for timeouts during check-in
+* [ENHANCEMENT] Improve documentation
+
 ## 0.2.0 / 2014-01-20
 
 * [FEATURE] Add "snitch" executable ([@laserlemon](https://github.com/laserlemon))

data/bin/snitch

@@ -3,6 +3,8 @@
 require "optparse"
 require "snitcher"
 
+params = {}
+
 option_parser = OptionParser.new do |parser|
   parser.banner = "Usage: snitch TOKEN"
 
@@ -10,6 +12,10 @@ option_parser = OptionParser.new do |parser|
     puts parser.help
     exit 0
   end
+
+  parser.on("-m", "--message", "Include a message with the check-in") do |msg|
+    params[:message] = msg
+  end
 end
 
 token = ARGV[0]
@@ -17,7 +23,11 @@ token = ARGV[0]
 if token
   print "Snitching #{token} ... "
 
-  if Snitcher.snitch(token)
+  opts = {
+    :message => params[:message]
+  }
+
+  if Snitcher.snitch(token, opts)
     puts "succeeded."
     exit 0
   else

data/lib/snitcher.rb

@@ -1,13 +1,43 @@
+require "uri"
+require "timeout"
 require "net/http"
 
 module Snitcher
   extend self
 
-  def snitch(token)
-    http = Net::HTTP.new("nosnch.in", 443)
-    http.use_ssl = true
+  # Public: Check-in to Deadman's Snitch
+  #
+  # token - The Snitch token given by Deadman's Snitch (see the install page).
+  # opts  - The hash of optional parameters that can be given during check-in:
+  #         :message - Text message limited to ~250 characters.
+  #         :timeout - Number of seconds to set as connect and read timeout.
+  #
+  # Examples
+  #
+  #   Snitch.snitch("c2354d53d2")
+  #   # => true
+  #
+  # Returns true if the check-in succeeded or false if it failed
+  def snitch(token, opts = {})
+    uri     = URI.parse("https://nosnch.in/#{token}")
+    timeout = opts.fetch(:timeout, 2)
 
-    response = http.request(Net::HTTP::Get.new("/#{token}"))
-    response.is_a?(Net::HTTPSuccess)
+    opts = {
+      :open_timeout => timeout,
+      :read_timeout => timeout,
+      :ssl_timeout  => timeout,
+      :use_ssl      => uri.port == 443
+    }
+
+    Net::HTTP.start(uri.host, uri.port, opts) do |http|
+      if message = opts[:message]
+        uri.query = URI.encode_www_form(:m => message)
+      end
+
+      response = http.request(Net::HTTP::Get.new(uri.request_uri))
+      response.is_a?(Net::HTTPSuccess)
+    end
+  rescue ::Timeout::Error
+    false
   end
 end

data/snitcher.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name    = "snitcher"
-  spec.version = "0.2.0"
+  spec.version = "0.3.0"
 
   spec.author   = "Collective Idea"
   spec.email    = "info@collectiveidea.com"

data/spec/snitcher_spec.rb

@@ -35,6 +35,24 @@ describe Snitcher do
         expect(Snitcher.snitch(token)).to eq(false)
       end
     end
+
+    describe "with message" do
+      it "includes the message as a query param" do
+        Snitcher.snitch(token, :message => "A thing just happened")
+
+        expect(a_request(:get, "https://nosnch.in/#{token}?m=A%20thing%20just%20happened"))
+      end
+    end
+
+    describe "timeout" do
+      before do
+        stub_request(:get, "https://nosnch.in/#{token}").to_raise(::Timeout::Error)
+      end
+
+      it "returns false when timed out" do
+        expect(Snitcher.snitch(token)).to eq(false)
+      end
+    end
   end
 
   describe "inclusion" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snitcher
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Collective Idea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simple API client for deadmanssnitch.com