snitcher 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28c075e51d743b5bd9cfea27193db58b8eadd72774ac4d1478800ffe6b73fb12
-  data.tar.gz: e08200f4bc411eed2c909c91cac08bb993497063a8955f0155f499c27f35fc43
+  metadata.gz: 2613d8b9e2918478b19e16717aa65726a8a0b6aae250846bd0b966b5b34bffa5
+  data.tar.gz: ab08596c2a1fe6e7fba7db7e4c7ecb9b092eb6dd1ac16dae8b75fd68e2f7efd1
 SHA512:
-  metadata.gz: f53823e4e0ba5ea1d435104de453427dcafa2f32a51bc092ad7f679c1b79a24a8ba0e9a06dcc7850b30e29c776d78e2b8652ec1099012de89b1093bfa8aa9232
-  data.tar.gz: a793e491ed792109ec1702287a575d893f215385863add7844242e6524cde7078b4479c1f1fef5fc762f906b0ba4bb3cd7df8dd6f40cfeeaaca3a16208b88d5a
+  metadata.gz: 8ca6c380e026b3c086683eba26b836429ac32a6b61dad10f48a0a906012d2d0783c6e15097100b5ffeb4b6a4edfb47736d33e026533afd85e9c86e168fe1f6ba
+  data.tar.gz: a04bdb064748796ba5297a28268fed83c0c4c2867f10cecd22be56a595e8914feb7fb5fe5b56ea43d1842cbb775800ed519e1fa47859755df69972b5e1b86b1c

data/.travis.yml

@@ -1,22 +1,15 @@
+dist: bionic
+
 language: ruby
 matrix:
   allow_failures:
     - rvm: ruby-head
 
-before_install:
-  - gem install bundler
-
-# Disable support for sudo to get faster builds with Docker
-sudo: false
-
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
   - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
   - jruby
   - ruby-head
 

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+## 0.4.2 / 2021-06-07
+* [BUG] Fixed Ruby 3.0 support ([@gaffneyc](https://github.com/gaffneyc))
+
 ## 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))

data/README.md

@@ -3,7 +3,7 @@
 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/deadmanssnitch/snitcher.png?branch=master)](https://travis-ci.org/deadmanssnitch/snitcher)
+[![Build Status](https://travis-ci.com/deadmanssnitch/snitcher.png?branch=master)](https://travis-ci.com/deadmanssnitch/snitcher)
 [![Code Climate](https://codeclimate.com/github/deadmanssnitch/snitcher.png)](https://codeclimate.com/github/deadmanssnitch/snitcher)
 [![Coverage Status](https://coveralls.io/repos/deadmanssnitch/snitcher/badge.png)](https://coveralls.io/r/deadmanssnitch/snitcher)
 

data/lib/snitcher/api/client.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require "net/https"
 require "timeout"
 require "json"
+require "cgi"
 
 require "snitcher/api"
 require "snitcher/version"
@@ -93,6 +96,8 @@ class Snitcher::API::Client
   #
   # @return [Snitcher::API::Snitch] the Snitch
   def snitch(token)
+    token = CGI.escape(token)
+
     payload = get("/v1/snitches/#{token}")
     Snitcher::API::Snitch.new(payload)
   end
@@ -175,7 +180,7 @@ class Snitcher::API::Client
   #
   # Raise Timeout::Error if the API request times out
   def update_snitch(token, attributes = {})
-    if attributes.has_key?(:tags)
+    if attributes.key?(:tags)
       attributes[:tags] = [attributes[:tags]].flatten.compact
     end
 
@@ -185,7 +190,9 @@ class Snitcher::API::Client
       type[:interval] ||= interval
     end
 
+    token = CGI.escape(token)
     payload = patch("/v1/snitches/#{token}", attributes)
+
     Snitcher::API::Snitch.new(payload)
   end
 
@@ -209,6 +216,8 @@ class Snitcher::API::Client
   #
   # @return [Array<String>] full list of tags on the Snitch.
   def add_tags(token, tags = [])
+    token = CGI.escape(token)
+
     post("/v1/snitches/#{token}/tags", Array(tags).flatten)
   end
 
@@ -227,6 +236,9 @@ class Snitcher::API::Client
   #
   # @return [Array<String>] list of the remaining tags on the Snitch.
   def remove_tag(token, tag)
+    token = CGI.escape(token)
+    tag = CGI.escape(tag)
+
     delete("/v1/snitches/#{token}/tags/#{tag}")
   end
 
@@ -245,6 +257,8 @@ class Snitcher::API::Client
   #
   # @return [nil]
   def pause_snitch(token)
+    token = CGI.escape(token)
+
     post("/v1/snitches/#{token}/pause")
 
     nil
@@ -264,6 +278,8 @@ class Snitcher::API::Client
   #
   # @return [nil]
   def delete_snitch(token)
+    token = CGI.escape(token)
+
     delete("/v1/snitches/#{token}")
 
     nil
@@ -282,8 +298,8 @@ class Snitcher::API::Client
     http_options = {
       open_timeout: @timeout,
       read_timeout: @timeout,
-      ssl_timeout:  @timeout,
-      use_ssl:      @endpoint.scheme == "https",
+      ssl_timeout: @timeout,
+      use_ssl: @endpoint.scheme == "https",
     }
 
     Net::HTTP.start(@endpoint.host, @endpoint.port, http_options) do |http|
@@ -315,9 +331,10 @@ class Snitcher::API::Client
     when Net::HTTPInternalServerError
       # InternalServerError does not have a parseable body as the error may not
       # be generated by the application itself.
-      raise ::Snitcher::API::InternalServerError.new(
-        "http_#{response.code}", response.body
-      )
+      raise ::Snitcher::API::InternalServerError.new({
+        "type"  => "internal_server_error",
+        "error" => response.body,
+      })
     else
       error = JSON.parse(response.body)
 
@@ -326,8 +343,6 @@ class Snitcher::API::Client
   end
 
   def get(path, query = {})
-    path = URI.encode(path)
-
     # Only add the query param if any valid filters were given.
     if query.any?
       path = "#{path}?#{URI.encode_www_form(query)}"
@@ -338,8 +353,6 @@ class Snitcher::API::Client
   end
 
   def post(path, data = nil)
-    path = URI.encode(path)
-
     request = Net::HTTP::Post.new(path)
     request.body = data
 
@@ -347,8 +360,6 @@ class Snitcher::API::Client
   end
 
   def patch(path, data)
-    path = URI.encode(path)
-
     request = Net::HTTP::Patch.new(path)
     request.body = data
 
@@ -356,7 +367,6 @@ class Snitcher::API::Client
   end
 
   def delete(path)
-    path    = URI.encode(path)
     request = Net::HTTP::Delete.new(path)
     execute_request(request)
   end

data/lib/snitcher/api/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Snitcher::API
   # Error is the base class for all API specific errors. For a full list of
   # errors and how they can happen please refer to the API documentation.
@@ -13,14 +15,15 @@ module Snitcher::API
       klass =
         case type.to_s
           # sign_in_incorrect is only returned when using username + password.
-          when "sign_in_incorrect";  AuthenticationError
+          when "sign_in_incorrect";     AuthenticationError
           # api_key_invalid is only returned when using the API key.
-          when "api_key_invalid";    AuthenticationError
-          when "plan_limit_reached"; PlanLimitReachedError
-          when "account_on_hold";    AccountOnHoldError
-          when "resource_not_found"; ResourceNotFoundError
-          when "resource_invalid";   ResourceInvalidError
-          else                       Error
+          when "api_key_invalid";       AuthenticationError
+          when "plan_limit_reached";    PlanLimitReachedError
+          when "account_on_hold";       AccountOnHoldError
+          when "resource_not_found";    ResourceNotFoundError
+          when "resource_invalid";      ResourceInvalidError
+          when "internal_server_error"; InternalServerError
+          else                          Error
         end
 
       error = klass.allocate

data/lib/snitcher/api/snitch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Snitcher::API::Snitch
   # @return [String] unique token used to identify a Snitch.
   attr_accessor :token
@@ -12,6 +14,14 @@ class Snitcher::API::Snitch
   #   "pending", "healthy", "paused", "failed", or "errored".
   attr_accessor :status
 
+  # alert_email is a list of email addresses that will be notified when this
+  # Snitch goes missing, errors, or becomes healthy again. When this is set,
+  # only the email addresses in the list will be notified. When the list is
+  # empty then all team members will be alerted by default.
+  #
+  # @return [Array<String>] override list of email addresses
+  attr_accessor :alert_email
+
   # @return [String] when the Snitch last checked_in
   attr_accessor :checked_in_at
 
@@ -37,6 +47,7 @@ class Snitcher::API::Snitch
   #     "token" => "c2354d53d3",
   #     "href" => "/v1/snitches/c2354d53d3",
   #     "name" => "Daily Backups",
+  #     "alert_email" => [],
   #     "tags" => [
   #       "production",
   #       "critical"
@@ -64,6 +75,7 @@ class Snitcher::API::Snitch
     @notes     = payload["notes"]
 
     @created_at    = payload["created_at"]
+    @alert_email   = payload["alert_email"] || []
     @check_in_url  = payload["check_in_url"]
     @checked_in_at = payload["checked_in_at"]
   end

data/lib/snitcher/version.rb

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

data/snitcher.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 1.9.3"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end

data/spec/api/client_spec.rb

@@ -3,7 +3,7 @@ require "snitcher/api/client"
 require "base64"
 require "securerandom"
 
-describe Snitcher::API::Client do
+RSpec.describe Snitcher::API::Client do
   subject(:client) do
     Snitcher::API::Client.new("key", endpoint: "http://api.dms.dev")
   end
@@ -76,6 +76,18 @@ describe Snitcher::API::Client do
       client.snitches(tags: ["phoenix foundary", "murggle"])
       expect(request).to have_been_made.once
     end
+
+    context "when Net::HTTPInternalServerError" do
+      it "raise ::Snitcher::API::InternalServerError" do
+        stub_request(:any, "#{snitch_url}?tags=phoenix")
+          .to_return(body: "Server Error", status: 500)
+
+        expect { client.snitches(tags: ["phoenix"]) }.to raise_error do |error|
+          expect(error).to be_a(::Snitcher::API::InternalServerError)
+          expect(error.message).to eq("Server Error")
+        end
+      end
+    end
   end
 
   describe "#snitch" do
@@ -387,9 +399,9 @@ 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").
+      request = stub_request(:delete, "#{snitch_url}/c2354d53d2/tags/tag+with+spaces").
         to_return(:body => body, :status => 200)
 
       client.remove_tag(token, "tag with spaces")

data/spec/api/error_spec.rb

@@ -1,4 +1,7 @@
-describe Snitcher::API::Error do
+require "spec_helper"
+require "snitcher/api"
+
+RSpec.describe Snitcher::API::Error do
   it "returns a AuthenticationError for 'sign_in_incorrect'" do
     error = Snitcher::API::Error.new({
       "type"  => "sign_in_incorrect",
@@ -58,5 +61,4 @@ describe Snitcher::API::Error do
     expect(error).to be_a(Snitcher::API::ResourceNotFoundError)
     expect(error.message).to eq("I can't find that!!")
   end
-
 end

data/spec/api/snitch_spec.rb

@@ -2,30 +2,32 @@ require "spec_helper"
 require "snitcher/api"
 require "snitcher/api/snitch"
 
-describe Snitcher::API::Snitch do
+RSpec.describe Snitcher::API::Snitch do
   describe "#new" do
-    before do
+    let(:snitch) do
       payload = {
-        "token" => "c2354d53d3",
-        "name" => "Daily Backups",
-        "type" => {
-          "interval" => "daily"
+        "token"       => "c2354d53d3",
+        "name"        => "Daily Backups",
+        "alert_email" => ["user@example.com"],
+        "notes"       => "Important user data.",
+        "type"        => {
+          "interval" => "daily",
         },
-        "notes" => "Important user data."
       }
 
-      @snitch = Snitcher::API::Snitch.new(payload)
+      Snitcher::API::Snitch.new(payload)
     end
 
     it "returns a Snitch object" do
-      expect(@snitch).to be_a(Snitcher::API::Snitch)
+      expect(snitch).to be_a(Snitcher::API::Snitch)
     end
 
     it "sets appropriate values" do
-      expect(@snitch.name).to eq("Daily Backups")
-      expect(@snitch.token).to eq("c2354d53d3")
-      expect(@snitch.notes).to eq("Important user data.")
-      expect(@snitch.interval).to eq("daily")
+      expect(snitch.name).to eq("Daily Backups")
+      expect(snitch.token).to eq("c2354d53d3")
+      expect(snitch.notes).to eq("Important user data.")
+      expect(snitch.interval).to eq("daily")
+      expect(snitch.alert_email).to eq(["user@example.com"])
     end
   end
 end

metadata

@@ -1,44 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: snitcher
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Collective Idea
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-09 00:00:00.000000000 Z
+date: 2021-06-07 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
-description: 
+        version: '0'
+description:
 email: hi@deadmanssnitch.com
 executables:
 - snitch
@@ -74,7 +74,7 @@ homepage: https://github.com/deadmanssnitch/snitcher
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,9 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Simple API client for deadmanssnitch.com
 test_files: