snitcher 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfa2c9e77f2a460c686bc38cb48b271c32276baf
-  data.tar.gz: cb0fe423892d35aec921787bb619e899231148d5
+  metadata.gz: f95719e2e2be1ad6b5432efc058e665e0f10c0f5
+  data.tar.gz: 728ab009d5477a6e8ecfd07660d2e40c013e52d5
 SHA512:
-  metadata.gz: da4d0919667bc3e3ee37316368c5980fb06e34d9c388f9145fdf58a0cfc4e1229e425842150f32b09bfe7b54e7e00b4f7a6f8989483fbae7338bd8a247dddb58
-  data.tar.gz: 0ee626c061780cfb8d65ff0b68ab7fd9e0226878b11c0ca777393255a4672485c3b3d35581e7214a36e2606cfdda3132de228eeb3536f81740e67020aa558610
+  metadata.gz: 8c66ef13e29d9b58b74c16bed76b3f272161a861bdc5f36ba824c90ada6abf09bc7f1a8d11dc01de150d297cd43133371d83ad35632d6945b874d8ecf5fcf18e
+  data.tar.gz: ddcee25b534ce9f06ac50e6ab515e68aa079d2dcf3b17ebb4c846a003c712295379fe38231dc8d7af29b50ff023cafaab97bb743a3c28c1a71bc9f275232f717

data/.travis.yml

@@ -8,5 +8,6 @@ matrix:
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
+  - 2.2
   - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.3.1 / TBD
+* [ENHANCEMENT] Add a custom User-Agent
+
 ## 0.3.0 / 2014-10-14
 
 * [FEATURE] Add support for the message parameter during check-in

data/README.md

@@ -18,12 +18,33 @@ To check in for one of your snitches:
 Snitcher.snitch("c2354d53d2")
 ```
 
+You also may provide a message with the check in:
+
+```ruby
+Snitcher.snitch("c2354d53d2", message: "Finished in 23.8 seconds.")
+```
+
+The default timeout of 2 seconds can be overridden:
+
+```ruby
+Snitcher.snitch("c2354d53d2", timeout: 10)
+```
+
+## Command Line Tool
+
 You can also check in from the command line:
 
 ```bash
 $ snitch c2354d53d2
 ```
 
+If you want to include a message, use the `-m` or `--message` flag.
+
+```bash
+$ snitch c2354d53d2 -m "Finished in 23.8 seconds."
+$ snitch c2354d53d2 --message "Finished in 23.8 seconds."
+```
+
 ## Contributing
 
 Snitcher is open source and contributions from the community are encouraged! No

data/lib/snitcher.rb

@@ -34,10 +34,24 @@ module Snitcher
         uri.query = URI.encode_www_form(:m => message)
       end
 
-      response = http.request(Net::HTTP::Get.new(uri.request_uri))
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request["User-Agent"] = user_agent
+
+      response = http.request(request)
       response.is_a?(Net::HTTPSuccess)
     end
   rescue ::Timeout::Error
     false
   end
+
+  private
+
+  def user_agent
+    # RUBY_ENGINE was not added until 1.9.3
+    engine = defined?(::RUBY_ENGINE) ? ::RUBY_ENGINE : "Ruby"
+
+    "Snitcher; #{engine}/#{RUBY_VERSION}; #{RUBY_PLATFORM}; v#{VERSION}"
+  end
 end
+
+require "snitcher/version"

data/lib/snitcher/version.rb

@@ -0,0 +1,3 @@
+module Snitcher
+  VERSION = "0.3.1"
+end

data/snitcher.gemspec

@@ -1,12 +1,15 @@
 # encoding: UTF-8
 
+$:.unshift File.expand_path("../lib", __FILE__)
+require "snitcher/version"
+
 Gem::Specification.new do |spec|
   spec.name    = "snitcher"
-  spec.version = "0.3.0"
+  spec.version = Snitcher::VERSION
 
   spec.author   = "Collective Idea"
-  spec.email    = "info@collectiveidea.com"
-  spec.homepage = "https://github.com/collectiveidea/snitcher"
+  spec.email    = "hi@deadmanssnitch.com"
+  spec.homepage = "https://github.com/deadmanssnitch/snitcher"
   spec.summary  = "Simple API client for deadmanssnitch.com"
   spec.license  = "MIT"
 

data/spec/snitcher_spec.rb

@@ -16,6 +16,16 @@ describe Snitcher do
       expect(a_request(:get, "https://nosnch.in/#{token}")).to have_been_made.once
     end
 
+    it "includes a custom user-agent" do
+      Snitcher.snitch(token)
+
+      expect(
+        a_request(:get, "https://nosnch.in/#{token}").with(
+          headers: { "User-Agent" => /\ASnitcher;.*; v#{Snitcher::VERSION}\z/ },
+        )
+      ).to have_been_made
+    end
+
     context "when successful" do
       before do
         stub_request(:get, "https://nosnch.in/#{token}").to_return(status: 200)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snitcher
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Collective Idea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2015-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.1'
 description: 
-email: info@collectiveidea.com
+email: hi@deadmanssnitch.com
 executables:
 - snitch
 extensions: []
@@ -55,12 +55,13 @@ files:
 - bin/snitch
 - doc/get_them_stitches.jpg
 - lib/snitcher.rb
+- lib/snitcher/version.rb
 - snitcher.gemspec
 - spec/snitcher_spec.rb
 - spec/spec_helper.rb
 - spec/support/random.rb
 - spec/support/webmock.rb
-homepage: https://github.com/collectiveidea/snitcher
+homepage: https://github.com/deadmanssnitch/snitcher
 licenses:
 - MIT
 metadata: {}
@@ -80,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Simple API client for deadmanssnitch.com