snitcher 0.4.0.rc1 → 0.4.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85ae5078348c51d73c8830f198ff49a276a5ef36
-  data.tar.gz: 18bf74b6a9b887f3ca6c213cbf2cd38bb7814be0
+  metadata.gz: 6d59a08f5f3886dc3f7b0aef1943627c22795c2f
+  data.tar.gz: 108054b71ff9b607b91ac3808d01e8c9173b5b0a
 SHA512:
-  metadata.gz: fabe574bb26a7766144e532bcf6e12562e2a9ad0d8029dd5e04984ba5ba97ac5de44b7da7dba229618bfc388d43639182f38d5cfb3ba6f5b5b53688329b89d55
-  data.tar.gz: b67166b247c7648b4d6a18a22c0894373176afb7bd5b62ecb5595770e9b25ced02462360c408ee69db4ff95c6ed1fa845d7f01c95ccc2becb87e61790c7cc70e
+  metadata.gz: 5fb6accdbc955dd55cf0f1e1a994660557a2425882fe125fa09caa1051510585bc4fea89d4f56bc7588985bf01c487b35b78db8b0b454b5b6c7fe5813786e930
+  data.tar.gz: 3dfdbc8579aac588a50626ed6993bbbf380ca0579c355554a9711fd1d9d0aaa57d84ef03a04f984f1e0e21beccef787e0b7ab2a272f9685461e9a9fac11bd7e2

data/Gemfile

@@ -4,7 +4,6 @@ gemspec
 
 group :development do
   gem "pry"
-  gem "yard-ghpages"
 end
 
 group :test do

data/README.md

@@ -82,8 +82,7 @@ Returns a Snitch.
 ### Retrieve Snitches That Match a Set of Tags
 
 ```ruby
-tags = ["critical", "sales"]
-client.tagged_snitches(tags)
+client.snitches(tags: ["critical", "sales"])
 ```
 
 Returns an array of Snitches.
@@ -141,29 +140,6 @@ client.remove_tag(token, tag)
 
 Returns an array of all of the Snitch's remaining tags.
 
-### Replace Tags on a Snitch
-
-Replaces all of a Snitch's tags with an array of new tags.
-
-```ruby
-token = "c2354d53d2"
-tags = ["csv", "server_a"]
-client.replace_tags(token, tags)
-```
-
-Returns the updated Snitch.
-
-### Remove Tags From a Snitch
-
-Removes all of a Snitch's tags.
-
-```ruby
-token = "c2354d53d2"
-client.clear_tags(token)
-```
-
-Returns the updated Snitch.
-
 ### Pause a Snitch
 
 ```ruby
@@ -171,7 +147,7 @@ token = "c2354d53d2"
 client.pause_snitch(token)
 ```
 
-Returns a hash with a `message` key, whose value is "Response complete".
+Returns a nil object.
 
 ### Delete a Snitch
 
@@ -180,7 +156,7 @@ token = "c2354d53d2"
 client.delete_snitch(token)
 ```
 
-Returns a hash with a `message` key, whose value is "Response complete".
+Returns a nil object.
 
 ## Contributing
 

data/Rakefile

@@ -4,7 +4,4 @@ Bundler::GemHelper.install_tasks
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
-require "yard-ghpages"
-Yard::GHPages::Tasks.install_tasks
-
 task default: :spec

data/examples/api.rb

@@ -0,0 +1,51 @@
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+# Need to require the API separately as it is not required by Snitcher itself.
+require "snitcher/api"
+
+if !(ENV["DMS_USER"] && ENV["DMS_PASS"])
+  puts "Set DMS_USER and DMS_PASS environment variables to your"
+  puts "deadmanssnitch.com credentials before running this example"
+  puts
+  puts "example: DMS_USER=email DMS_PASS=pass ruby examples/api.rb"
+
+  exit 1
+end
+
+# Get an API key for a given user with password
+key = Snitcher::API.get_key(ENV["DMS_USER"], ENV["DMS_PASS"])
+
+# Create a new API client
+client = Snitcher::API::Client.new(key)
+
+# Create an hourly Snitch called "Monitor All The Things"
+snitch = client.create_snitch({
+  name: "Monitor All The Things",
+  tags: ["things"],
+  interval: "hourly",
+})
+puts "Created: #{snitch.inspect}"
+
+# Change the name and notes of an existing Snitch
+snitch = client.update_snitch(snitch.token, {
+  name: "Monitor Fewer Things",
+  notes: "Only monitoring a couple things",
+})
+
+# Add new tags to a Snitch
+snitch.tags = client.add_tags(snitch.token, ["production", "critical issues"])
+
+# Remove the "critical issues" tag from the Snitch
+snitch.tags = client.remove_tag(snitch.token, "critical issues")
+
+# Get a list of Snitches tagged with "production"
+production = client.snitches(tags: ["production"])
+puts "Production Snitches:"
+production.each { |s| puts "  - #{s.inspect}"}
+
+# Pause a Snitch if it's currently missing or errored
+client.pause_snitch(snitch.token)
+
+# Delete a Snitch
+client.delete_snitch(snitch.token)
+puts "Deleted: #{snitch.token}"

data/lib/snitcher/api/client.rb

@@ -35,16 +35,46 @@ class Snitcher::API::Client
 
   # Get the list snitches on the account
   #
+  # @param [Hash] filters
+  # @option filters [String, Array<String>] tags only return Snitches that are
+  #   tagged with _all_ of the given tags. For example, if a Snitch is tagged
+  #   with "production" and "critical" it will be returned when filtering by
+  #   "production", "critical", or ["production", "critical"] but not
+  #   ["production", "backups"].
+  #
   # @example List the Snitches on an account
-  #     client.snitches
-  #     # => [ #<Snitcher::API::Snitch:...>, #<Snitcher::API::Snitch:...> ]
+  #   client.snitches
+  #   # => [ #<Snitcher::API::Snitch:...>, #<Snitcher::API::Snitch:...> ]
+  #
+  # @example List Snitches with a specific tag
+  #   client.snitches(tags: "production")
+  #   # => [ #<Snitcher::API::Snitch:...>, #<Snitcher::API::Snitch:...> ]
+  #
+  # @example List Snitches with multiple tags
+  #   client.snitches(tags: ["production", "critical"])
+  #   # => [ #<Snitcher::API::Snitch:...>, #<Snitcher::API::Snitch:...> ]
   #
   # @raise [Timeout::Error] if the API request took too long to execute.
   # @raise [Snitcher::API::Error] if any API errors occur.
   #
   # @return [Array<Snitcher::API::Snitch>] the snitches on the account.
-  def snitches
-    snitch_array(get("/v1/snitches"))
+  def snitches(filters = {})
+    path  = "/v1/snitches"
+    query = {}
+
+    # Tags allow for labeling Snitches for better categorization. This allows
+    # filtering by a set of tags.
+    if filters[:tags]
+      tags = Array(filters[:tags]).flatten
+      query[:tags] = tags.map(&:strip).compact.uniq.join(",")
+    end
+
+    # Only add the query param if any valid filters were given.
+    if query.any?
+      path = "#{path}?#{URI.encode_www_form(query)}"
+    end
+
+    snitch_array(get(path))
   end
 
   # Get a single Snitch by it's unique token.
@@ -67,36 +97,6 @@ class Snitcher::API::Client
     Snitcher::API::Snitch.new(payload)
   end
 
-  # Retrieve Snitches filtered by a list of tags. Only Snitches that are tagged
-  # with all of the given tags will be returned.
-  #
-  # @param tags [String, Array<String>] the tag(s) to filter by.
-  #
-  # @example Get the snitches that match a list of tags
-  #   client.tagged_snitches(["production","critical"])
-  #
-  #   # => [
-  #     #<Snitcher::API::Snitch tags=["production", "critical"]>,
-  #     #<Snitcher::API::Snitch tags=["production", "critical"]>,
-  #   ]
-  #
-  # @raise [Timeout::Error] if the API request took too long to execute.
-  #   with that token
-  # @raise [Snitcher::API::Error] if any API errors occur.
-  #
-  # @return [Array<Snitcher::API::Snitch>] list of Snitches matching all tags.
-  def tagged_snitches(*tags)
-    (tags ||= []).flatten!
-
-    query = URI.encode_www_form({
-      # Strip extra spaces, dedupe, and clean up the list of tags to be filtered
-      # by.
-      tags: tags.map(&:strip).compact.uniq.join(","),
-    })
-
-    snitch_array(get("/v1/snitches?#{query}"))
-  end
-
   # Create a new Snitch.
   #
   # @param [Hash] attributes The properties for the new Snitch
@@ -113,7 +113,7 @@ class Snitcher::API::Client
   # @example Create a new Snitch
   #   client.create_snitch({
   #     name:  "Daily Backups",
-  #     type:  { interval: "hourly" },
+  #     interval: "hourly",
   #     notes: "On error check the print tray for paper jams",
   #     tags:  [ "backups", "maintenance" ],
   #   })
@@ -227,7 +227,8 @@ class Snitcher::API::Client
   #
   # @return [Array<String>] list of the remaining tags on the Snitch.
   def remove_tag(token, tag)
-    delete("/v1/snitches/#{token}/tags/#{tag}")
+    path = "/v1/snitches/#{token}/tags/#{tag}"
+    delete(URI.encode(path))
   end
 
   # Pauses a Snitch if it can be paused. Snitches can only be paused if their

data/lib/snitcher/version.rb

@@ -1,3 +1,3 @@
 module Snitcher
-  VERSION = "0.4.0.rc1"
+  VERSION = "0.4.0.rc2"
 end

data/spec/api/client_spec.rb

@@ -60,6 +60,22 @@ describe Snitcher::API::Client do
       expect(client.snitches).to be_a(Array)
       expect(client.snitches.first).to be_a(Snitcher::API::Snitch)
     end
+
+    it "allows filtering by a tag" do
+      request = stub_request(:get, "#{snitch_url}?tags=production")
+        .to_return(body: body, status: 200)
+
+      client.snitches(tags: "production")
+      expect(request).to have_been_made.once
+    end
+
+    it "allows filtering by multiple tags" do
+      request = stub_request(:get, "#{snitch_url}?tags=phoenix%20foundary,murggle")
+        .to_return(body: body, status: 200)
+
+      client.snitches(tags: ["phoenix foundary", "murggle"])
+      expect(request).to have_been_made.once
+    end
   end
 
   describe "#snitch" do
@@ -99,77 +115,6 @@ describe Snitcher::API::Client do
     end
   end
 
-  describe "#tagged_snitches" do
-    let(:tags)  { ["sneetch", "belly"] }
-    let(:url)   { "#{snitch_url}?tags=sneetch,belly" }
-    let(:body)  { '[
-                     {
-                       "token": "c2354d53d2",
-                       "href": "/v1/snitches/c2354d53d2",
-                       "name": "Best Kind of Sneetch on the Beach",
-                       "tags": [
-                         "sneetch",
-                         "belly",
-                         "star-belly"
-                       ],
-                       "status": "pending",
-                       "checked_in_at": "",
-                       "type": {
-                         "interval": "hourly"
-                       }
-                     },
-                     {
-                       "token": "c2354d53d3",
-                       "href": "/v1/snitches/c2354d53d3",
-                       "name": "Have None Upon Thars",
-                       "tags": [
-                         "sneetch",
-                         "belly",
-                         "plain-belly"
-                       ],
-                       "status": "pending",
-                       "checked_in_at": "",
-                       "type": {
-                         "interval": "hourly"
-                       }
-                     }
-                   ]'
-                }
-
-    before do
-      stub_request(:get, stub_url).to_return(:body => body, :status => 200)
-    end
-
-    it "pings API with the api_key" do
-      client.tagged_snitches(tags)
-
-      expect(a_request(:get, url)).to have_been_made.once
-    end
-
-    it "returns the snitches" do
-      expect(client.tagged_snitches(tags)).to be_a(Array)
-      expect(client.tagged_snitches(tags).first).to be_a(Snitcher::API::Snitch)
-    end
-
-    it "supports spaces in tags" do
-      request = stub_request(:get, "#{snitch_url}?tags=phoenix%20foundary,murggle").
-        to_return(body: body, status: 200)
-
-      client.tagged_snitches("phoenix foundary", "murggle")
-
-      expect(request).to have_been_made.once
-    end
-
-    it "allows an array to be passed for tags" do
-      request = stub_request(:get, "#{snitch_url}?tags=murggle,gurgggle").
-        to_return(body: body, status: 200)
-
-      client.tagged_snitches(["murggle", "gurgggle"])
-
-      expect(request).to have_been_made.once
-    end
-  end
-
   describe "#create_snitch" do
     let(:data)  {
                   {
@@ -442,6 +387,14 @@ describe Snitcher::API::Client do
 
       expect(a_request(:delete, url)).to have_been_made.once
     end
+    
+    it "properly escapes tags with spaces" do
+      request = stub_request(:delete, "#{snitch_url}/c2354d53d2/tags/tag%20with%20spaces").
+        to_return(:body => body, :status => 200)
+
+      client.remove_tag(token, "tag with spaces")
+      expect(request).to have_been_made.once
+    end
 
     context "when successful" do
       it "returns an array of the snitch's remaining tags" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snitcher
 version: !ruby/object:Gem::Version
-  version: 0.4.0.rc1
+  version: 0.4.0.rc2
 platform: ruby
 authors:
 - Collective Idea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,6 +54,7 @@ files:
 - Rakefile
 - bin/snitch
 - doc/get_them_stitches.jpg
+- examples/api.rb
 - lib/snitcher.rb
 - lib/snitcher/api.rb
 - lib/snitcher/api/client.rb
@@ -102,4 +103,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/random.rb
 - spec/support/webmock.rb
-has_rdoc: