snitcher 0.4.0.rc4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 269d8a39f4f95c7cf5d1d574d7e0db92f3ca3d95
-  data.tar.gz: 9b6ce02c920e04cb8e544b0d1b2d0b2510626ca5
+  metadata.gz: 5ce9137c78af3585cd04a72db5dcfa25890c5c58
+  data.tar.gz: 0382afa241770a4ce4eb1757fa3e3dd911ac608a
 SHA512:
-  metadata.gz: 394d5c82f089074d385f237da314701ea7cf00a353d2339698f90da97a988a4387c41ce7c422bdfddc42719026b9721c5e737f90ba21379883e4bdb8705571f7
-  data.tar.gz: b9126ddc040154e125d763a13cfef5b09897d916fcb04c49cce36a00af93b1b838dd96bd8bb05e725a8bc15d0dce5baa7f409ef060266ff912f424bacdaaf754
+  metadata.gz: 9f4d73519250309f111a2359162a4748eeccf10161aa3f37dce680372b11c2d611efd32c1da98a4c2246c0e3f653e00c6a832cf99964ca668c87049bb44a7f57
+  data.tar.gz: 03a7310d071a11568fcb2f6d05abf74c69138dc8211715c9d8782431fada6d0136ddf5772e443f043aff40e6b5bf16b1483bf97534988dc95789165cc5361172

data/.travis.yml

@@ -14,6 +14,12 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
-  - 2.3
+  - 2.3.1
   - jruby
   - ruby-head
+
+notifications:
+  webhooks:
+    urls:
+      - http://buildlight.collectiveidea.com/
+    on_start: always

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 0.4.0 / TBD
+## 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

@@ -31,16 +31,6 @@ Snitcher.snitch("c2354d53d2", timeout: 10)
 
 ## API Access
 
-### Retrieving Your API Key At Command Line
-
-```ruby
-require "snitcher/api"
-
-key = Snitcher::API.get_key("jane@example.com", "password")
-```
-
-Returns an authentication key to access the api.
-
 ### Setup
 
 Initialize the API client directly with your api key:

data/examples/api.rb

@@ -3,17 +3,17 @@ $:.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"
+if !ENV["DMS_API_KEY"]
+  puts "Set DMS_API_KEY environment variable to your deadmanssnitch.com API key"
+  puts "before running this example."
   puts
-  puts "example: DMS_USER=email DMS_PASS=pass ruby examples/api.rb"
+  puts "example: DMS_API_KEY=c23452notarealkeyhello! 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"])
+key = ENV["DMS_API_KEY"]
 
 # Create a new API client
 client = Snitcher::API::Client.new(key)

data/lib/snitcher/api.rb

@@ -7,67 +7,8 @@ require "snitcher/version"
 
 module Snitcher
   module API
-    extend self
-
     # Snitcher::API::Error and subclasses
     require "snitcher/api/error"
-
-    # Retrieve an API Key for your account.
-    #
-    # @param username [String] username for your Dead Man's Snitch account.
-    # @param password [String] password for your Dead Man's Snitch account.
-    #
-    # @param [Hash] options
-    # @option options [String] uri location of alternative Dead Man's Snitch API
-    # @option timeout [Float, Fixnum] timeout number of seconds to wait for
-    #   server response before timing out.
-    #
-    # @example
-    #   Snitcher::API.get_key("alice@example.com", "password")
-    #   # => "_caeEiZXnEyEzXXYVh2NhQ"
-    #
-    # @raise [Timeout::Error] if the API request took too long to execute.
-    # @raise [Snitcher::API::AuthenticationError] credentials are invalid.
-    # @raise [Snitcher::API::Error] if any other API errors occur.
-    #
-    # @return [String] the API key to use for further API requests.
-    def get_key(username, password, options={})
-      api = options.fetch(:uri, "https://api.deadmanssnitch.com")
-      uri = URI.parse("#{api}/v1/api_key")
-
-      timeout = options.fetch(:timeout, 5)
-      http_options = {
-        open_timeout: timeout,
-        read_timeout: timeout,
-        ssl_timeout:  timeout,
-        use_ssl:      uri.scheme == "https",
-      }
-
-      Net::HTTP.start(uri.host, uri.port, http_options) do |http|
-        request = Net::HTTP::Get.new(uri.path)
-        request["User-Agent"] = user_agent
-        request.basic_auth(username, password)
-
-        response = http.request(request)
-
-        if response.is_a?(Net::HTTPSuccess)
-          JSON.parse(response.body)["api_key"]
-        else
-          error = JSON.parse(response.body)
-
-          raise ::Snitcher::API::Error.new(error)
-        end
-      end
-    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#{::Snitcher::VERSION}"
-    end
   end
 end
 

data/lib/snitcher/version.rb

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

data/spec/api_spec.rb

@@ -1,78 +1,6 @@
 require "spec_helper"
 
-require "base64"
-require "securerandom"
-
 require "snitcher/api"
 
 describe Snitcher::API do
-  describe "#get_key" do
-    it "returns the api_key" do
-      user = "alice@example.com"
-      pass = "password"
-
-      request = stub_request(:get, "https://api.deadmanssnitch.com/v1/api_key").
-        with(basic_auth: [user, pass]).
-        to_return({
-          :body   => '{"api_key": "_caeEiZXnEyEzXXYVh2NhQ"}',
-          :status => 200
-        })
-
-      actual = Snitcher::API.get_key(user, pass)
-
-      expect(actual).to eq("_caeEiZXnEyEzXXYVh2NhQ")
-      expect(request).to have_been_made.once
-    end
-
-    it "raises an error if authentication failed" do
-      user = "lol@notreally.horse"
-      pass = "nope"
-
-      request = stub_request(:get, "https://api.deadmanssnitch.com/v1/api_key").
-        with(basic_auth: [user, pass]).
-        to_return({
-          :body => JSON.generate({
-            :type  => "sign_in_incorrect",
-            :error => "Invalid email or password."
-          }),
-          :status => 401
-        })
-
-      expect {
-        # Some shenanigans to verify type
-        begin
-          Snitcher::API.get_key(user, pass)
-        rescue Snitcher::API::Error => e
-          expect(e.type).to eq("sign_in_incorrect")
-          expect(e.message).to eq("Invalid email or password.")
-
-          raise e
-        end
-      }.to raise_error(Snitcher::API::AuthenticationError)
-
-      expect(request).to have_been_made.once
-    end
-
-    it "raises Timeout::Error on a timeout" do
-      stub_request(:any, "https://api.deadmanssnitch.com/v1/api_key").to_timeout
-
-      expect {
-        Snitcher::API.get_key("", "")
-      }.to raise_error(Timeout::Error)
-    end
-
-    it "allows the API URI to be provided" do
-      request = stub_request(:any, "dms.dev:4000/v1/api_key").
-        with(basic_auth: ["user", "pass"]).
-        to_return({
-          :body   => '{"api_key": "this_is_an_api_key"}',
-          :status => 200
-        })
-
-      actual = Snitcher::API.get_key("user", "pass", uri: "http://dms.dev:4000")
-
-      expect(actual).to eq("this_is_an_api_key")
-      expect(request).to have_been_made.once
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snitcher
 version: !ruby/object:Gem::Version
-  version: 0.4.0.rc4
+  version: 0.4.0
 platform: ruby
 authors:
 - Collective Idea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2016-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,12 +85,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Simple API client for deadmanssnitch.com