status_cake 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54631854b22ce18d59ba60b7a63bcd7851b7704c
-  data.tar.gz: f4b449653d6c70d5870494dd40d6d6029566655d
+  metadata.gz: ff3b630f3d2987f2d9118c790d60271954614bfb
+  data.tar.gz: af2abdcc4d702c58819615ed5bfc7486a5f5fdce
 SHA512:
-  metadata.gz: 795cb752256910ee4a82a51077f0c9c4f622f88dbc46e7a7c880d1907b3d246ae8686b6b23367176b6bf38e31d080f961788e2b948333554395c94bb7e4f740b
-  data.tar.gz: 081cbbcac9510bd31cbcdcdf9a67da6fa6ff8ca8c23b365f84cdb19c2353e02625efa665f30329957e0192f260cc36c3b2aac71c3dca6662186bf6fbd1d9f90b
+  metadata.gz: 2d3dfbd8ef901478af4393f7a0cba12550a0f75babd69392bf835d14f6396f224f1b9ed162aef345dfa2b74adbd0f3524137d1e2d1d58832e44e37964689af51
+  data.tar.gz: 83c83f3818a5b381f92643c9e851228ffbe224757269e79d9b425fae9fbf8d830bf34574fe38fec74dab9c98788ca4d59e031ea34040d8443884bd11a570b618

data/README.rdoc

@@ -29,6 +29,18 @@ Please be aware that although filtering is supported on any criteria via the gem
   @sc.pause_test(t)
   @sc.unpause_test(t)
 
+=== Retrieving Contact Groups
+
+  @sc.contact_groups('GroupName' => 'Production')
+
+=== Updating and Insert Contact Groups
+
+  response = @sc.update_contact_group({
+    'ContactID' => 12345,
+    'GroupName' => 'Test Group',
+    'Email' => 'updated@invalid.com'
+  })
+
 == Logging
 
 Override the debug_output, see Net::HTTP#set_debug_output for options.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/status_cake/status_cake.rb

@@ -16,9 +16,22 @@ class StatusCake
     @auth = {'Username' => opts[:username], 'API' => opts[:api_key]}
   end
 
-  def find(id)
-    @opts = {headers:@auth, query:{ 'TestID' => id }}
-    respond(self.class.get("/Tests/Details", @opts))
+  def contact_groups(options={})
+    @opts = {headers:@auth}
+    filter_opts = options
+
+    contact_groups = respond(self.class.get("/ContactGroups", @opts)) || []
+
+    unless filter_opts.empty?
+      contact_groups.find_all { |t| (t & filter_opts) == filter_opts }
+    else
+      contact_groups
+    end
+  end
+
+  def update_contact_group(contact_group={})
+    @opts = {headers:@auth, body:contact_group }
+    respond(self.class.put("/ContactGroups/Update",@opts))
   end
 
   def tests(options={})
@@ -27,7 +40,7 @@ class StatusCake
     filter_opts = options.reject { |k,v| SUPPORTED_QUERIES.index(k) }
 
     @opts = {headers:@auth, query:query_opts}
-    tests = respond(self.class.get("/Tests", @opts))
+    tests = respond(self.class.get("/Tests", @opts)) || []
 
     unless filter_opts.empty?
       tests.find_all { |t| (t & filter_opts) == filter_opts }
@@ -36,6 +49,11 @@ class StatusCake
     end
   end
 
+  def find_test(id)
+    @opts = {headers:@auth, query:{ 'TestID' => id }}
+    respond(self.class.get("/Tests/Details", @opts))
+  end
+
   def update_test(test={})
     @opts = {headers:@auth, body:test }
     respond(self.class.put("/Tests/Update",@opts))

data/spec/fixtures/vcr/create_contact_group.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://www.statuscake.com/API/ContactGroups/Update
+    body:
+      encoding: UTF-8
+      string: GroupName=Test%20Contact%20Group%20API&Email=test%40invalid.com
+    headers:
+      Username:
+      - <USER>
+      Api:
+      - <APIKEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 11 Jun 2014 21:19:15 GMT
+      Server:
+      - LiteSpeed
+      Connection:
+      - close
+      X-Powered-By:
+      - PHP/5.4.9
+      Set-Cookie:
+      - PHPSESSID=16001fd974e6af6fe12e5c36d17f9ead; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '161'
+    body:
+      encoding: UTF-8
+      string: '{"Success":true,"Message":"Test Inserted","Issues":[],"Data":{"Email":"test@invalid.com","GroupName":"Test
+        Contact Group API","Client":"14818"},"InsertID":10564}'
+    http_version: 
+  recorded_at: Wed, 11 Jun 2014 21:19:20 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/vcr/retrieve_contact_groups.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.statuscake.com/API/ContactGroups
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Username:
+      - <USER>
+      Api:
+      - <APIKEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 11 Jun 2014 21:10:37 GMT
+      Server:
+      - LiteSpeed
+      Connection:
+      - close
+      X-Powered-By:
+      - PHP/5.4.9
+      Set-Cookie:
+      - PHPSESSID=e96390eda7cfc292ef505638b8d1af01; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '284'
+    body:
+      encoding: UTF-8
+      string: '[{"GroupName":"Test","Emails":["nothing@<USER>.com"],"Mobiles":"","Boxcar":"","Pushover":"","ContactID":10313,"DesktopAlert":0,"PingURL":""},{"GroupName":"All
+        Sites","Emails":["nothing@<USER>.com"],"Mobiles":"","Boxcar":"","Pushover":"","ContactID":10395,"DesktopAlert":0,"PingURL":""}]'
+    http_version: 
+  recorded_at: Wed, 11 Jun 2014 21:10:42 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/vcr/update_contact_group.yml

@@ -0,0 +1,130 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.statuscake.com/API/ContactGroups
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Username:
+      - <USER>
+      Api:
+      - <APIKEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 11 Jun 2014 21:19:18 GMT
+      Server:
+      - LiteSpeed
+      Connection:
+      - close
+      X-Powered-By:
+      - PHP/5.4.9
+      Set-Cookie:
+      - PHPSESSID=7866b25bc852d98af4ce4379f5c7fa86; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '440'
+    body:
+      encoding: UTF-8
+      string: '[{"GroupName":"Test","Emails":["nothing@<USER>.com"],"Mobiles":"","Boxcar":"","Pushover":"","ContactID":10313,"DesktopAlert":0,"PingURL":""},{"GroupName":"All
+        Sites","Emails":["nothing@<USER>.com"],"Mobiles":"","Boxcar":"","Pushover":"","ContactID":10395,"DesktopAlert":0,"PingURL":""},{"GroupName":"Test
+        Contact Group API","Emails":["test@invalid.com"],"Mobiles":"","Boxcar":"","Pushover":"","ContactID":10564,"DesktopAlert":0,"PingURL":""}]'
+    http_version: 
+  recorded_at: Wed, 11 Jun 2014 21:19:22 GMT
+- request:
+    method: put
+    uri: https://www.statuscake.com/API/ContactGroups/Update
+    body:
+      encoding: UTF-8
+      string: ContactID=10564&GroupName=Test%20Contact%20Group%20API%20-%20Updated&Email=test.updated%40invalid.com
+    headers:
+      Username:
+      - <USER>
+      Api:
+      - <APIKEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 11 Jun 2014 21:19:19 GMT
+      Server:
+      - LiteSpeed
+      Connection:
+      - close
+      X-Powered-By:
+      - PHP/5.4.9
+      Set-Cookie:
+      - PHPSESSID=80129dbbcbab25f6dcc1ea22bd66a261; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '72'
+    body:
+      encoding: UTF-8
+      string: '{"Success":true,"Issues":[],"Message":"Contact Group has been updated!"}'
+    http_version: 
+  recorded_at: Wed, 11 Jun 2014 21:19:23 GMT
+- request:
+    method: get
+    uri: https://www.statuscake.com/API/ContactGroups
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Username:
+      - <USER>
+      Api:
+      - <APIKEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 11 Jun 2014 21:19:21 GMT
+      Server:
+      - LiteSpeed
+      Connection:
+      - close
+      X-Powered-By:
+      - PHP/5.4.9
+      Set-Cookie:
+      - PHPSESSID=d6365a0832a8517504b5bf1355b38003; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '458'
+    body:
+      encoding: UTF-8
+      string: '[{"GroupName":"Test","Emails":["nothing@<USER>.com"],"Mobiles":"","Boxcar":"","Pushover":"","ContactID":10313,"DesktopAlert":0,"PingURL":""},{"GroupName":"All
+        Sites","Emails":["nothing@<USER>.com"],"Mobiles":"","Boxcar":"","Pushover":"","ContactID":10395,"DesktopAlert":0,"PingURL":""},{"GroupName":"Test
+        Contact Group API - Updated","Emails":["test.updated@invalid.com"],"Mobiles":"","Boxcar":"","Pushover":"","ContactID":10564,"DesktopAlert":0,"PingURL":""}]'
+    http_version: 
+  recorded_at: Wed, 11 Jun 2014 21:19:26 GMT
+recorded_with: VCR 2.9.2

data/spec/status_cake/status_cake_spec.rb

@@ -7,12 +7,11 @@ if ENV['STATUSCAKE_VERBOSE'] == 'true'
 end
 
 describe StatusCake do
+  subject do
+    StatusCake.new(username: ENV['STATUSCAKE_USER'], api_key: ENV['STATUSCAKE_APIKEY'])
+  end
 
-  context "simple operations" do
-    subject do
-      StatusCake.new(username: ENV['STATUSCAKE_USER'], api_key: ENV['STATUSCAKE_APIKEY'])
-    end
-
+  context "tests" do
     it 'should be able to create a test' do
       VCR.use_cassette('create_test') do
         response = subject.update_test({
@@ -35,7 +34,7 @@ describe StatusCake do
 
     it 'should be able to retrieve a test by id' do
       VCR.use_cassette('retrieve_by_id') do
-        test = subject.find(170051)
+        test = subject.find_test(170051)
         expect(test).not_to be_nil
         expect(test['WebsiteName']).to eq('google.com')
       end
@@ -49,6 +48,12 @@ describe StatusCake do
       end
     end
 
+    it 'should return blank arrays for no matches' do
+      VCR.use_cassette('retrieve_by_name') do
+        expect(subject.tests('CUID' => '10395', 'WebsiteName' => 'DOESNOTEXIST')).to eq([])
+      end
+    end
+
     it 'should be able to unpause a test' do
       VCR.use_cassette('unpause_test') do
         response = subject.unpause_test(subject.tests('WebsiteName' => 'google.com', 'CUID' => '10395').first)
@@ -70,4 +75,53 @@ describe StatusCake do
       end
     end
   end
+
+  context "contact groups" do
+    it 'should be able to retrieve contact groups' do
+      VCR.use_cassette('retrieve_contact_groups') do
+        expect(subject.contact_groups.size).to be 2
+      end
+    end
+
+    it 'should be able to retrieve contact groups by name' do
+      VCR.use_cassette('retrieve_contact_groups') do
+        expect(subject.contact_groups('GroupName' => 'Test').size).to be 1
+      end
+    end
+
+    it 'should return blank arrays for no matches' do
+      VCR.use_cassette('retrieve_contact_groups') do
+        expect(subject.contact_groups('GroupName' => 'DOESNOTEXIST')).to eq([])
+      end
+    end
+
+    it 'should be able to create a contact group' do
+      VCR.use_cassette('create_contact_group') do
+        response = subject.update_contact_group({
+          'GroupName' => 'Test Contact Group API',
+          'Email' => 'test@invalid.com'
+        })
+        expect(response['Success'] == 'true')
+      end
+    end
+
+    it 'should be able to update a contact group' do
+      VCR.use_cassette('update_contact_group') do
+        cg = subject.contact_groups.find { |c| c['GroupName'] == 'Test Contact Group API' }
+        expect(cg).not_to be_nil
+
+        response = subject.update_contact_group({
+          'ContactID' => cg['ContactID'],
+          'GroupName' => 'Test Contact Group API - Updated',
+          'Email' => 'test.updated@invalid.com'
+        })
+        expect(response['Success'] == 'true')
+
+        retrieved_cg = subject.contact_groups.find { |c| c['ContactID'] == cg['ContactID'] }
+        expect(retrieved_cg).not_to be_nil
+        expect(retrieved_cg['GroupName']).to eq('Test Contact Group API - Updated')
+        expect(retrieved_cg['Emails'].first).to eq('test.updated@invalid.com')
+      end
+    end
+  end
 end

data/status_cake.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: status_cake 0.1.1 ruby lib
+# stub: status_cake 0.1.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "status_cake"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Charles Cooke"]
-  s.date = "2014-06-10"
+  s.date = "2014-06-12"
   s.description = "Ruby gem for StatusCake API - supports basic functions on tests"
   s.email = "charles@coupa.com"
   s.extra_rdoc_files = [
@@ -31,13 +31,16 @@ Gem::Specification.new do |s|
     "lib/status_cake.rb",
     "lib/status_cake/status_cake.rb",
     "lib/status_cake/version.rb",
+    "spec/fixtures/vcr/create_contact_group.yml",
     "spec/fixtures/vcr/create_test.yml",
     "spec/fixtures/vcr/delete_test.yml",
     "spec/fixtures/vcr/pause_test.yml",
     "spec/fixtures/vcr/retrieve_all.yml",
     "spec/fixtures/vcr/retrieve_by_id.yml",
     "spec/fixtures/vcr/retrieve_by_name.yml",
+    "spec/fixtures/vcr/retrieve_contact_groups.yml",
     "spec/fixtures/vcr/unpause_test.yml",
+    "spec/fixtures/vcr/update_contact_group.yml",
     "spec/spec_helper.rb",
     "spec/status_cake/status_cake_spec.rb",
     "status_cake.gemspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: status_cake
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Charles Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -198,13 +198,16 @@ files:
 - lib/status_cake.rb
 - lib/status_cake/status_cake.rb
 - lib/status_cake/version.rb
+- spec/fixtures/vcr/create_contact_group.yml
 - spec/fixtures/vcr/create_test.yml
 - spec/fixtures/vcr/delete_test.yml
 - spec/fixtures/vcr/pause_test.yml
 - spec/fixtures/vcr/retrieve_all.yml
 - spec/fixtures/vcr/retrieve_by_id.yml
 - spec/fixtures/vcr/retrieve_by_name.yml
+- spec/fixtures/vcr/retrieve_contact_groups.yml
 - spec/fixtures/vcr/unpause_test.yml
+- spec/fixtures/vcr/update_contact_group.yml
 - spec/spec_helper.rb
 - spec/status_cake/status_cake_spec.rb
 - status_cake.gemspec