snitcher 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e56f9fe98d4ef909a4fab53faa0c58db5298cd6c
-  data.tar.gz: 6df2091f4831bf880e95f117abd750cee1cd1115
+  metadata.gz: a8c248e10b01d23be566aa4d4f0f63c6536b672d
+  data.tar.gz: f3f2054fce497f55b4abcb15be75ebba1b8d1532
 SHA512:
-  metadata.gz: 09a09239a6d04449e485be7619e793dafc5b262fb9ddef3e4674d2982517a610eb4e49abd5725e5fd47ff9ecc2e59cd0bdf9c237e96f37961932ace32510aecf
-  data.tar.gz: 0858831e9a8bc9df6b6afce7d3dbb8bd34f3fbdbf135818a10f8a2e9ad43bdbd223d04768be4c5574543fdb223e806536bff8057121f10e665c518af6f4d46d0
+  metadata.gz: 86e2b8428cf2f239d1e6dd3eb9bc005e11729f1156c208ec5d3906d379f121748a2fe0179d9ed8da68bbfbc9e7a082d580af0abbdd4ec66ebcf502c9f24c2948
+  data.tar.gz: b0701107c63002a730162abb24d197d9aa3740d85e09956eb86111cd5d2fdfa1ca01c3ea4790226f899b570839fcbba74c9711db0688c56102d30a7afc09e6a9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,12 @@
+branches:
+  only:
+    - master
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.2.0 / 2014-01-20
+
+* [FEATURE] Add "snitch" executable ([@laserlemon](https://github.com/laserlemon))
+* [FEATURE] Allow Snitcher module mixin ([@zspencer](https://github.com/zspencer))
+* [ENHANCEMENT] Add tests ([@laserlemon](https://github.com/laserlemon), [@ersatzryan](https://github.com/ersatzryan))
+
+## 0.1.0 / 2013-06-22
+
+* [FEATURE] Add `Snitcher.snitch` method ([@gaffneyc](https://github.com/gaffneyc))

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "coveralls", "~> 0.7", require: false
+  gem "rspec", "~> 2.14"
+  gem "webmock", "~> 1.17"
+end

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Chris Gaffney
+Copyright (c) 2013 Collective Idea
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,24 +2,51 @@
 
 Simple API client for [Dead Man's Snitch](https://deadmanssnitch.com)
 
+[![Gem Version](https://badge.fury.io/rb/snitcher.png)](http://badge.fury.io/rb/snitcher)
+[![Build Status](https://travis-ci.org/collectiveidea/snitcher.png?branch=master)](https://travis-ci.org/collectiveidea/snitcher)
+[![Code Climate](https://codeclimate.com/github/collectiveidea/snitcher.png)](https://codeclimate.com/github/collectiveidea/snitcher)
+[![Coverage Status](https://coveralls.io/repos/collectiveidea/snitcher/badge.png)](https://coveralls.io/r/collectiveidea/snitcher)
+[![Dependency Status](https://gemnasium.com/collectiveidea/snitcher.png)](https://gemnasium.com/collectiveidea/snitcher)
+
 ![Snitches get Stitches](doc/get_them_stitches.jpg)
 
-## Basic Usage
+## Usage
+
+To check in for one of your snitches:
 
-Notify Dead Man's Snitch that a thing happened:
 ```ruby
 Snitcher.snitch("c2354d53d2")
 ```
 
-## Note on Patches/Pull Requests
+You can also check in from the command line:
+
+```bash
+$ snitch c2354d53d2
+```
+
+## Contributing
+
+Snitcher is open source and contributions from the community are encouraged! No
+contribution is too small. Please consider:
+
+* adding features
+* squashing bugs
+* updating documentation
+* fixing typos
+
+For the best chance of having your changes merged, please:
+
+1. fork the project
+2. push your changes, with tests
+3. submit a pull request with at least one animated GIF
 
-* Fork the project.
-* Add tests to show the problem or test your feature
-* Make your feature addition or bug fix.
-* Send me a pull request. Bonus points for topic branches.
+## Thanks
 
-Please don't make changes to the Rakefile or version.
+A big thank you to [Randy Schmidt](https://github.com/r38y) for dreaming up
+Dead Man's Snitch in the first place and for
+[entrusting](http://r38y.com/dead-mans-snitch-sold) its future to Collective
+Idea.
 
 ## Copyright
 
-See LICENSE for details.
+See [LICENSE.txt](LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/snitch

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "snitcher"
+
+option_parser = OptionParser.new do |parser|
+  parser.banner = "Usage: snitch TOKEN"
+
+  parser.on("-h", "--help", "Show this message") do
+    puts parser.help
+    exit 0
+  end
+end
+
+token = ARGV[0]
+
+if token
+  print "Snitching #{token} ... "
+
+  if Snitcher.snitch(token)
+    puts "succeeded."
+    exit 0
+  else
+    warn "failed."
+    exit 1
+  end
+else
+  puts option_parser.help
+end

data/lib/snitcher.rb

@@ -1,31 +1,13 @@
-require "net/https"
+require "net/http"
 
 module Snitcher
+  extend self
 
-  class Snitch
-    attr_reader :token
+  def snitch(token)
+    http = Net::HTTP.new("nosnch.in", 443)
+    http.use_ssl = true
 
-    def initialize(token)
-      @token = token
-    end
-
-    def checkin
-      http = Net::HTTP.new("nosnch.in", 443)
-      http.use_ssl = true
-
-      response = http.request(Net::HTTP::Get.new("/#{@token}"))
-      response.code_type == Net::HTTPOK
-    end
-  end
-
-  class << self
-    def by_token(token)
-      Snitch.new(token)
-    end
-
-    def checkin(token)
-      by_token(token).checkin
-    end
-    alias_method :snitch, :checkin
+    response = http.request(Net::HTTP::Get.new("/#{token}"))
+    response.is_a?(Net::HTTPSuccess)
   end
 end

data/snitcher.gemspec

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+Gem::Specification.new do |spec|
+  spec.name    = "snitcher"
+  spec.version = "0.2.0"
+
+  spec.author   = "Collective Idea"
+  spec.email    = "info@collectiveidea.com"
+  spec.homepage = "https://github.com/collectiveidea/snitcher"
+  spec.summary  = "Simple API client for deadmanssnitch.com"
+  spec.license  = "MIT"
+
+  spec.files       = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files  = spec.files.grep(/^spec/)
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1"
+end

data/spec/snitcher_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+require "securerandom"
+
+describe Snitcher do
+  let(:token) { SecureRandom.hex(5) }
+
+  before do
+    stub_request(:get, /nosnch\.in/)
+  end
+
+  describe ".snitch" do
+    it "pings DMS with the given token" do
+      Snitcher.snitch(token)
+
+      expect(a_request(:get, "https://nosnch.in/#{token}")).to have_been_made.once
+    end
+
+    context "when successful" do
+      before do
+        stub_request(:get, "https://nosnch.in/#{token}").to_return(status: 200)
+      end
+
+      it "returns true" do
+        expect(Snitcher.snitch(token)).to eq(true)
+      end
+    end
+
+    context "when unsuccessful" do
+      before do
+        stub_request(:get, "https://nosnch.in/#{token}").to_return(status: 404)
+      end
+
+      it "returns false" do
+        expect(Snitcher.snitch(token)).to eq(false)
+      end
+    end
+  end
+
+  describe "inclusion" do
+    let(:snitching_class) { Class.new { include Snitcher } }
+
+    it "snitches" do
+      snitching_class.new.snitch(token)
+
+      expect(a_request(:get, "https://nosnch.in/#{token}")).to have_been_made.once
+    end
+  end
+
+  describe "extension" do
+    let(:snitching_class) { Class.new { extend Snitcher } }
+
+    it "snitches" do
+      snitching_class.snitch(token)
+
+      expect(a_request(:get, "https://nosnch.in/#{token}")).to have_been_made.once
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+if ENV["TRAVIS"]
+  require "coveralls"
+  Coveralls.wear!
+end
+
+require "snitcher"
+
+Dir[File.expand_path("../support/*.rb", __FILE__)].each { |f| require f }

data/spec/support/random.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.order = "random"
+end

data/spec/support/webmock.rb

@@ -0,0 +1 @@
+require "webmock/rspec"

metadata

@@ -1,27 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: snitcher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Chris Gaffney
+- Collective Idea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-22 00:00:00.000000000 Z
-dependencies: []
+date: 2014-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
 description: 
-email:
-- gaffneyc@gmail.com
-executables: []
+email: info@collectiveidea.com
+executables:
+- snitch
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/snitcher.rb
-- LICENSE
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
 - README.md
-homepage: https://github.com/gaffneyc/snitcher
-licenses: []
+- Rakefile
+- bin/snitch
+- doc/get_them_stitches.jpg
+- lib/snitcher.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
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -29,18 +70,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Simple API client for deadmanssnitch.com
-test_files: []
+test_files:
+- spec/snitcher_spec.rb
+- spec/spec_helper.rb
+- spec/support/random.rb
+- spec/support/webmock.rb