serverspec-extended-types 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2QzMDBhYzA5MjU0M2RkOTA3MGU1ZTgxNDFlMzg3ZWE4YWQyOWQ2OQ==
+    Yzc2OWUzM2M5NDljNTNkM2I1ZjE5ZWUwYjZlMzUzM2NhNTAyYjliMg==
   data.tar.gz: !binary |-
-    OWYxYTE2NGM5NmExZWNhY2JlYWZjNmZhYThlNDdjZTFiMzM4YTZjNA==
+    OGRiMjQ5NWZhNGMxZjg4MzQ2ZmM0MDA1MTllM2M4NDUzZWE5ZWU4Yw==
 SHA512:
   metadata.gz: !binary |-
-    NTk1ZTA4NzQ4NzQ4YTM0YmQ4MTE0ZTQ5ZTEwNjgxZThhNzExODk0MGM4MDg0
-    MjcyN2NkNDRhMTJlNmE1ZGE4YmUxNTJmZGE3NDY2ZjQyM2E0YmEyZDA0Nzlk
-    ZDE2YjEzYjJlMTVjNTU5YWUyN2YzNzIwZjBjMzFhZmJhYWFlZGM=
+    YWE2ZWRlOGZmNzlkZjM0OWIwODZhODUwMmQzNzkxNjYwYWJjYjFhZWUxNTYw
+    ZjA0NmVjNTkzYmQ5OTI3ZjA4ZDFkYjIxZTQwM2NjNzE0ZjNiNjJhMDAzNjBm
+    NzkzYjY3NDE4NDcwZGNkNmQzMmQ0ZGFjY2EzZTcxYWQ4OTQ5YzY=
   data.tar.gz: !binary |-
-    ZTczY2FlZTQxZWUxNDkwNDVmMzA3MjA4MmU2YzIxMzdjZTQ3ODFjZTg2ODYx
-    YWMxNzU4ODE2Y2UxMTE0NWY0NTE5MjhiNWQwYjJhOTAyYTE2NTcwNzdjYzk4
-    NzgxYTZhYWZmMmRkNDQ1YjBmZTQ0NTFjZWFlZTY2M2ZkYTJlNmY=
+    OWFhMTJmOTE5YzU3NDI3ODZmNTZkZjQyNGFhMTk4NzQ4MjZmMDQ3Yzc0ODRi
+    ZTUzMTJkMmM5YjFjYzllNjZhMWQ2ZWY1MmQwNjQ0YzU3ZGIwMWVlNTgyNjc0
+    YzM1ODRkYTRjYzZhOWVmMmRjMGJmZjY4NTJlNzEwMDM0NTY1NmQ=

data/CHANGES.md

@@ -1,9 +1,13 @@
 # serverspec-extended-types, changelog
 
-## 0.0.1 2015-03-14 Jason Antman <jason@jasonantman.com>
+## 0.0.3 2015-03-23 Jason Antman <jason@jasonantman.com>
 
-* Initial release with bitlbee, http_get and virtualenv types
+* Add ``json`` matcher for http_get type.
 
 ## 0.0.2 2015-03-14 Jason Antman <jason@jasonantman.com>
 
 * Minor bugfix in Serverspec::Types::Virtualenv#virtualenv?
+
+## 0.0.1 2015-03-14 Jason Antman <jason@jasonantman.com>
+
+* Initial release with bitlbee, http_get and virtualenv types

data/README.md

@@ -17,7 +17,8 @@ Current types include:
 * A ``virtualenv`` type to make expectations about a Python Virtualenv, its ``pip`` and ``python`` versions, and packages
   installed in it. This also works for system-wide Python if ``pip`` is installed.
 * A ``http_get`` type to perform an HTTP GET request (specifying a port number, the ``Host:`` header to set, and the path
-  to request) and make expectations about whether the request times out, its status code, headers, and response body.
+  to request) and make expectations about whether the request times out, its status code, headers, response body, and
+  JSON content (if the response body is parsable as JSON).
 * A ``bitlbee`` type to actually connect via IRC to a running [bitlbee](http://www.bitlbee.org/) IRC gateway and authenticate
   to it, and make expectations that the connection and authentication worked, and what version of Bitlbee is running.
 
@@ -141,6 +142,15 @@ Returns the HTTP response headers as a hash.
       its(:headers) { should include('HeaderName' => /value regex/) }
     end
 
+##### json
+
+If the response body is deserializable as JSON, contains the JSON hash,
+otherwise an empty hash.
+
+    describe http_get(80, 'myhostname', '/') do
+      its(:json) { should include('Key' => /value regex/) }
+    end
+
 ##### status
 
 Returns the HTTP status code, or 0 if timed out.

data/lib/serverspec_extended_types/http_get.rb

@@ -12,6 +12,7 @@
 require 'timeout'
 require 'faraday'
 require 'serverspec_extended_types/version'
+require 'json'
 
 module Serverspec
   module Type
@@ -46,6 +47,7 @@ module Serverspec
         @content_str = nil
         @headers_hash = nil
         @response_code_int = nil
+        @response_json = nil
         begin
           Timeout::timeout(timeout_sec) do
             getpage
@@ -75,6 +77,12 @@ module Serverspec
         response.headers.each do |header, val|
           @headers_hash[header] = val
         end
+        # try to JSON decode
+        begin
+          @response_json = JSON.parse(@content_str)
+        rescue
+          @response_json = {}
+        end
       end
 
       # Whether or not the request timed out
@@ -103,6 +111,19 @@ module Serverspec
         @headers_hash
       end
 
+      # Returns the decoded JSON response, or an empty hash
+      #
+      # @example
+      #   describe http_get(80, 'myhostname', '/') do
+      #     its(:json) { should include('foo' => /value regex/) }
+      #   end
+      #
+      # @api public
+      # @return [Hash]
+      def json
+        @response_json
+      end
+      
       # Returns the HTTP status code, or 0 if timed out
       #
       # @example

data/lib/serverspec_extended_types/version.rb

@@ -1,3 +1,3 @@
 module ServerspecExtendedTypes
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/types/http_get_spec.rb

@@ -25,6 +25,7 @@ describe 'http_get()' do
       expect(x.instance_variable_get(:@content_str)).to be nil
       expect(x.instance_variable_get(:@headers_hash)).to be nil
       expect(x.instance_variable_get(:@response_code_int)).to be nil
+      expect(x.instance_variable_get(:@response_json)).to be nil
     end
     it 'calls getpage' do
       expect_any_instance_of(Serverspec::Type::Http_Get).to receive(:getpage).once
@@ -70,6 +71,31 @@ describe 'http_get()' do
       expect(x.body).to eq 'foo bar'
       expected_headers = {'h1' => 'h1val', 'h2' => 'h2val'}
       expect(x.headers).to eq expected_headers
+      expect(x.json).to be_empty
+      expect(x.json).to be_a_kind_of(Hash)
+    end
+    it 'sets JSON if parsable' do
+      stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'myhost'))
+      conn = double
+      headers = double
+      expect(headers).to receive(:[]=).with(:user_agent, %r"Serverspec::Type::Http_Get/\d+\.\d+\.\d+ \(https://github.com/jantman/serverspec-extended-types\)")
+      expect(conn).to receive(:headers).and_return(headers)
+      expect(headers).to receive(:[]=).with(:Host, 'hostheader')
+      expect(conn).to receive(:headers).and_return(headers)
+      response = double
+      expect(response).to receive(:status).and_return(200)
+      expect(response).to receive(:body).and_return('{"foo": "bar", "baz": {"blam": "blarg"}}')
+      expect(response).to receive(:headers).and_return({'h1' => 'h1val', 'h2' => 'h2val'})
+      expect(conn).to receive(:get).with('mypath').and_return(response)
+      expect(Faraday).to receive(:new).with("http://myhost:1/").and_return(conn)
+      x = http_get(1, 'hostheader', 'mypath')
+      expect(x.timed_out?).to eq false
+      expect(x.status).to eq 200
+      expect(x.body).to eq '{"foo": "bar", "baz": {"blam": "blarg"}}'
+      expected_headers = {'h1' => 'h1val', 'h2' => 'h2val'}
+      expect(x.headers).to eq expected_headers
+      expected_json = {"foo" => "bar", "baz" => {"blam" => "blarg"}}
+      expect(x.json).to eq expected_json
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverspec-extended-types
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jason Antman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-14 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverspec