pingdom_client_v3 0.0.1

data/spec/pingdom_client_v3/resources/check_spec.rb

@@ -0,0 +1,125 @@
+require_relative '../../spec_helper'
+
+module PingdomClientV3
+  RSpec.describe Resources::Check do
+    include_context :pingdom_client
+
+    subject { described_class.new(pingdom_client) }
+
+    describe '#index', vcr: { cassette_name: 'resources/check/index' } do
+      let(:response) { subject.index }
+
+      it 'returns a PingdomClientV3::Response' do
+        expect(response).to be_a PingdomClientV3::Response
+      end
+
+      it 'is successful' do
+        expect(response.success?).to be_truthy
+      end
+
+      it 'returns a hash' do
+        expect(response.body).to be_a Hash
+      end
+
+      context 'sanity check' do
+        let(:check) { response.response_object['checks'].first }
+
+        it 'is a check' do
+          expect(check['id']).to eq 13904858
+          expect(check['name']).to eq 'google'
+          expect(check['hostname']).to eq 'google.com'
+        end
+      end
+    end
+
+    describe '#show', vcr: { cassette_name: 'resources/check/show' } do
+      let(:response) { subject.show(13904898) }
+
+      it 'returns a PingdomClientV3::Response' do
+        expect(response).to be_a PingdomClientV3::Response
+      end
+
+      it 'is successful' do
+        expect(response.success?).to be_truthy
+      end
+
+      it 'returns a hash' do
+        expect(response.body).to be_a Hash
+      end
+
+      context 'sanity check' do
+        let(:check) { response.response_object['check'] }
+
+        it 'is a check' do
+          expect(check['id']).to eq 13904898
+          expect(check['name']).to eq 'a test check'
+          expect(check['hostname']).to eq 'google.com'
+        end
+      end
+    end
+
+    describe '#create', vcr: { cassette_name: 'resources/check/create' } do
+      let(:payload) do
+        {
+          host: 'google.com',
+          name: 'a test check',
+          type: 'http'
+        }
+      end
+      let(:response) { subject.create(payload) }
+
+      it 'returns a PingdomClientV3::Response' do
+        expect(response).to be_a PingdomClientV3::Response
+      end
+
+      it 'is successful' do
+        expect(response.success?).to be_truthy
+      end
+
+      it 'returns a hash' do
+        expect(response.body).to be_a Hash
+      end
+
+      context 'sanity check' do
+        let(:check) { response.response_object['check'] }
+
+        it 'is a check' do
+          expect(check['id']).to eq 13904898
+          expect(check['name']).to eq 'a test check'
+        end
+      end
+    end
+
+    describe '#destroy', vcr: { cassette_name: 'resources/check/destroy' } do
+      let(:payload) do
+        {
+          host: 'google.com',
+          name: 'a test check to destroy',
+          type: 'http'
+        }
+      end
+      let(:create_response) { subject.create(payload) }
+      let(:response) { subject.destroy(create_response.response_object['check']['id']) }
+
+      it 'returns a PingdomClientV3::Response' do
+        expect(response).to be_a PingdomClientV3::Response
+      end
+
+      it 'is successful' do
+        expect(response.success?).to be_truthy
+      end
+
+      it 'returns a hash' do
+        expect(response.body).to be_a Hash
+      end
+
+      context 'sanity check' do
+        let(:message) { response.response_object['message'] }
+
+        it 'deletes the check' do
+          expect(message).to eq 'Deletion of check was successful!'
+        end
+      end
+    end
+  end
+end

data/spec/pingdom_client_v3/response_object_spec.rb

@@ -0,0 +1,18 @@
+require_relative '../spec_helper'
+
+module PingdomClientV3
+  RSpec.describe ResponseObject do
+    let(:original_response) { double }
+
+    subject { described_class.new(attrs) }
+
+    describe '#initialize' do
+      let(:attrs) { { :method_1 => 'value', :method_2 => 'value 2', :PascalCase => 1 } }
+
+      it 'transform hash keys into methods' do
+        expect(subject[:method_1]).to eq 'value'
+        expect(subject[:method_2]).to eq 'value 2'
+      end
+    end
+  end
+end

data/spec/pingdom_client_v3/response_spec.rb

@@ -0,0 +1,86 @@
+require_relative '../spec_helper'
+require 'json'
+
+module PingdomClientV3
+  RSpec.describe Response do
+    let(:original_response) { double }
+
+    subject { described_class.new(original_response) }
+
+    describe '#success?' do
+      let(:original_response) { double(:code => code) }
+
+      context 'when code between 200..226' do
+        let(:code) { 200 }
+
+        it 'returns true' do
+          expect(subject.success?).to be_truthy
+        end
+      end
+
+      context 'when code is not between 200..226' do
+        let(:code) { 500 }
+
+        it 'returns true' do
+          expect(subject.success?).to be_falsey
+        end
+      end
+    end
+
+    describe '#failure?' do
+      let(:original_response) { double(:code => code) }
+
+      context 'when code is not between 200..226' do
+        let(:code) { 500 }
+
+        it 'returns true' do
+          expect(subject.failure?).to be_truthy
+        end
+      end
+
+      context 'when code between 200..226' do
+        let(:code) { 200 }
+
+        it 'returns true' do
+          expect(subject.failure?).to be_falsey
+        end
+      end
+    end
+
+    describe '#body' do
+      let(:hash) { { 'some' => 'response' } }
+      let(:original_response) { double(body: JSON.dump(hash)) }
+
+      it 'parses json into a hash' do
+        expect(subject.body).to eq hash
+      end
+    end
+
+    describe '#original_body' do
+      let(:hash) { { :some => 'response' } }
+      let(:original_response) { double(body: JSON.dump(hash)) }
+
+      it 'returns the raw json' do
+        expect(subject.original_body).to eq JSON.dump(hash)
+      end
+    end
+
+    describe '#response_object' do
+      let(:original_response) {double(body: JSON.dump(:code => '1234')) }
+
+      it 'returns a ResponseObject' do
+        expect(subject.response_object).to be_a PingdomClientV3::ResponseObject
+      end
+
+      context 'when it is an array' do
+        let(:original_response) { double(body: JSON.dump([{:code => '1234'}, {:code => '12345'}])) }
+
+        it 'returns an array of ResponseObject' do
+          expect(subject.response_object).to be_an Array
+          expect(subject.response_object.size).to eq 2
+          expect(subject.response_object.first).to be_a PingdomClientV3::ResponseObject
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "pingdom_client_v3"
+require "byebug"
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/pingdom_client.rb

@@ -0,0 +1,5 @@
+shared_context :pingdom_client do
+  let(:pingdom_api_key) { ENV['PINGDOM_API_KEY'] }
+  let(:pingdom_api_url) { 'https://api.pingdom.com/api/3.1' }
+  let(:pingdom_client) { PingdomClientV3::Client.new(pingdom_api_key, pingdom_api_url) }
+end

data/spec/support/vcr_setup.rb

@@ -0,0 +1,19 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.before_record do |i|
+    i.response.body.force_encoding('UTF-8')
+  end
+
+  c.preserve_exact_body_bytes do |http_message|
+    http_message.body.encoding.name == 'ASCII-8BIT' ||
+    !http_message.body.valid_encoding?
+  end
+
+  c.filter_sensitive_data('<AUTHORIZATION_TOKEN>') do |interaction|
+    interaction.request.headers['Authorization']&.first
+  end
+end

data/spec/vcr_cassettes/resources/check/create.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.pingdom.com/api/3.1/checks
+    body:
+      encoding: UTF-8
+      string: '{"host":"google.com","name":"a test check","type":"http"}'
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin22 arm64) ruby/3.2.2p53
+      Authorization:
+      - "<AUTHORIZATION_TOKEN>"
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '57'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - api.pingdom.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 15 May 2025 03:54:34 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '47'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Req-Limit-Long:
+      - 'Remaining: 2087982 Time until reset: 2576731'
+      Req-Limit-Short:
+      - 'Remaining: 11593 Time until reset: 1322'
+      Server-Time:
+      - '1747281274'
+      X-Trace:
+      - 2B77AF6DF5C01D8D77CA59038991E6CF8F245E0D01803B70B491B4379E00
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 93ffb1d45912d723-BNE
+    body:
+      encoding: UTF-8
+      string: '{"check":{"id":13904898,"name":"a test check"}}'
+    http_version:
+  recorded_at: Thu, 15 May 2025 03:54:34 GMT
+recorded_with: VCR 3.0.3

data/spec/vcr_cassettes/resources/check/destroy.yml

@@ -0,0 +1,109 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.pingdom.com/api/3.1/checks
+    body:
+      encoding: UTF-8
+      string: '{"host":"google.com","name":"a test check to destroy","type":"http"}'
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin22 arm64) ruby/3.2.2p53
+      Authorization:
+      - "<AUTHORIZATION_TOKEN>"
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '68'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - api.pingdom.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 15 May 2025 03:57:52 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Req-Limit-Long:
+      - 'Remaining: 2087979 Time until reset: 2576533'
+      Req-Limit-Short:
+      - 'Remaining: 11590 Time until reset: 1124'
+      Server-Time:
+      - '1747281472'
+      X-Trace:
+      - 2BFD9E9330B4C76F32A5D93B1E44688C48F2FFEAB28AAA23714EF1823A00
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 93ffb6ad98874875-BNE
+    body:
+      encoding: UTF-8
+      string: '{"check":{"id":13904902,"name":"a test check to destroy"}}'
+    http_version:
+  recorded_at: Thu, 15 May 2025 03:57:52 GMT
+- request:
+    method: delete
+    uri: https://api.pingdom.com/api/3.1/checks/13904902
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin22 arm64) ruby/3.2.2p53
+      Authorization:
+      - "<AUTHORIZATION_TOKEN>"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - api.pingdom.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 15 May 2025 03:57:53 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '47'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Req-Limit-Long:
+      - 'Remaining: 2087978 Time until reset: 2576532'
+      Req-Limit-Short:
+      - 'Remaining: 11589 Time until reset: 1123'
+      Server-Time:
+      - '1747281473'
+      X-Trace:
+      - 2B0CA449C5B4F5EE1C9684CF9DABE8D1874480D17E33D722E5A4C2E01F00
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 93ffb6b4d920d70c-BNE
+    body:
+      encoding: UTF-8
+      string: '{"message":"Deletion of check was successful!"}'
+    http_version:
+  recorded_at: Thu, 15 May 2025 03:57:53 GMT
+recorded_with: VCR 3.0.3

data/spec/vcr_cassettes/resources/check/index.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.pingdom.com/api/3.1/checks
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin22 arm64) ruby/3.2.2p53
+      Authorization:
+      - "<AUTHORIZATION_TOKEN>"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - api.pingdom.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 15 May 2025 02:51:43 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Req-Limit-Long:
+      - 'Remaining: 2087990 Time until reset: 2580502'
+      Req-Limit-Short:
+      - 'Remaining: 11591 Time until reset: 1476'
+      Server-Time:
+      - '1747277503'
+      X-Trace:
+      - 2B39541495636BC807675A88F08918C8D51DA7B4A5968589B22897308400
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 93ff55c6ef4dd70f-BNE
+    body:
+      encoding: UTF-8
+      string: '{"checks":[{"id":13904858,"created":1747277371,"name":"google","hostname":"google.com","resolution":1,"type":"http","ipv6":false,"verify_certificate":true,"status":"unknown"}],"counts":{"total":1,"limited":1,"filtered":1}}'
+    http_version:
+  recorded_at: Thu, 15 May 2025 02:51:43 GMT
+recorded_with: VCR 3.0.3

data/spec/vcr_cassettes/resources/check/show.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.pingdom.com/api/3.1/checks/13904898
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin22 arm64) ruby/3.2.2p53
+      Authorization:
+      - "<AUTHORIZATION_TOKEN>"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - api.pingdom.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 15 May 2025 03:55:36 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Req-Limit-Long:
+      - 'Remaining: 2087981 Time until reset: 2576670'
+      Req-Limit-Short:
+      - 'Remaining: 11592 Time until reset: 1261'
+      Server-Time:
+      - '1747281336'
+      X-Trace:
+      - 2BDC8EA31018D89D20BE7E0DBD0363EF660EF38F60EE720D933CE6045100
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 93ffb355ab76d734-BNE
+    body:
+      encoding: UTF-8
+      string: '{"check":{"id":13904898,"name":"a test check","resolution":5,"sendnotificationwhendown":2,"notifyagainevery":0,"notifywhenbackup":true,"created":1747281274,"type":{"http":{"verify_certificate":true,"url":"\/","encryption":false,"port":80,"requestheaders":{"User-Agent":"Pingdom.com_bot_version_1.4_(http:\/\/www.pingdom.com\/)"}}},"hostname":"google.com","ipv6":false,"responsetime_threshold":30000,"custom_message":"","integrationids":[],"status":"unknown","tags":[],"probe_filters":[]}}'
+    http_version:
+  recorded_at: Thu, 15 May 2025 03:55:36 GMT
+recorded_with: VCR 3.0.3