bw_status_board_api 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5e487fe194eb83bdcfb1a9bdc308caecf9003e3
-  data.tar.gz: 5165623308736693ee65b76e37eade4fc1c4534f
+  metadata.gz: a835820c177cd4db36dd774de38c6b7fa6f8fb2f
+  data.tar.gz: be7d7de5bfab59891bdcad3dc5d7bf767ffb177c
 SHA512:
-  metadata.gz: 68ba44ea521c74c9d9e4b11d85eac3bc93aeb19d7da9abc84b9b9049b9bbaeea5b3584ff83a738127cc571098c23deeadc3b51b2f3e21dfd841b5c433f259c7d
-  data.tar.gz: ec3a688534b51212564567ed012f1b57c76d7811af5ff086909b129c769fe73a92199872aa3329f7cae4dbf846dfa81fdfa1ce39b1afed1636de2ce04afdaea9
+  metadata.gz: 67a4624d8996bbf22c081decc6463a7cb72b9dcaeb8eddb561af360f72cc6c636f5420054519ec23144b045ec10327ea01e07b19b2e7e52a662b7db186df0d80
+  data.tar.gz: e2afceac5ffbec1694e51e72ea09150f7e543d70e5f3b829cce0681554879dbe910a8179591e49ea8a63d4e77232cc66f9567659d9adb4fdd1c29dbf80f33db0

data/CHANGELOG.md

@@ -1,15 +1,27 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 2.0.0
+### Updated
+* Updated endpoints following latest updates to status board api endpoints
+
+## 1.1.0
+### Added
+* Added additional endpoints for boards, environments and services
+* Added new metrics module for useful statistics
+
+### Fixed
+* Fixed error.rb so messages returned from API are displayed
+
 ## 1.0.2
 ### Added
-* NoTask - added cops configuration to .rubocop.yml
-* NoTask - added Gemfile.lock to .gitignore
+* Added cops configuration to .rubocop.yml
+* Added Gemfile.lock to .gitignore
 
 ## 1.0.1
 ### Fixed
-* NoTask - fixed conflict with bwapi gem middleware
+* Fixed conflict with bwapi gem middleware
 
 ## 1.0.0
 ### Added
-* NoTask - Initial version of the bw_status_board_api gem
+* Initial version of the bw_status_board_api gem

data/lib/bw_status_board_api/client/boards.rb

@@ -10,16 +10,22 @@ module BWStatusBoardAPI
 
       # Get boards
       #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] page the page
+      # @option opts [Integer] pageSize the page size
+      # @option opts [String] orderBy the parameter to order by
+      # @option opts [String] orderDirection the direction to order
+      # @option opts [String] fields the fields to return
       # @return [Hash] boards
-      def boards
-        get 'boards'
+      def boards(opts = {})
+        get 'boards', opts
       end
 
       # Returns boards name list
       #
       # @return [Array] environments
       def boards_summary
-        filter(boards, true)
+        filter(boards['results'], true)
       end
 
       # Get board

data/lib/bw_status_board_api/client/environments/services.rb

@@ -10,17 +10,24 @@ module BWStatusBoardAPI
         # Get environment services
         #
         # @param environment_id [Integer] environment id
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] page the page
+        # @option opts [Integer] pageSize the page size
+        # @option opts [String] orderBy the parameter to order by
+        # @option opts [String] orderDirection the direction to order
+        # @option opts [String] fields the fields to return
         # @return [Hash] services
-        def services(environment_id)
-          get "environments/#{environment_id}/services"
+        def services(environment_id, opts = {})
+          get "environments/#{environment_id}/services", opts
         end
 
         # Returns services name list
         #
         # @param environment_id [Integer] environment id
+        # @param opts [Hash] options hash of parameters
         # @return [Array] the environments
         def services_summary(environment_id)
-          filter(services(environment_id), true)
+          filter(services(environment_id)['results'], true)
         end
 
         # Get environment service
@@ -36,11 +43,15 @@ module BWStatusBoardAPI
         #
         # @param environment_id [Integer] environment id
         # @param opts [Hash] options hash of parameters
+        # @option opts [String] environment the id of the environment
         # @option opts [String] name name of the service
         # @option opts [String] shortName short name of the service
         # @option opts [String] status status of the service
         # @option opts [String] url url of the service
         # @option opts [Integer] successStatusCode success status code of the service
+        # @option opts [Boolean] slackNotify notify on slack flag
+        # @option opts [Array] slackUsersToNotify users to notify on status change
+        # @option opts [Array] slackChannelsToNotify channels to notify on status change
         # @option opts [Boolean] enabled service enabled flag
         # @return [Hash] service
         def create_service(environment_id, opts = {})
@@ -52,11 +63,15 @@ module BWStatusBoardAPI
         # @param environment_id [Integer] environment id
         # @param service_id [Integer] service id
         # @param opts [Hash] options hash of parameters
+        # @option opts [String] environment the id of the environment
         # @option opts [String] name name of the service
         # @option opts [String] shortName short name of the service
         # @option opts [String] status status of the service
         # @option opts [String] url url of the service
         # @option opts [Integer] successStatusCode success status code of the service
+        # @option opts [Boolean] slackNotify notify on slack flag
+        # @option opts [Array] slackUsersToNotify users to notify on status change
+        # @option opts [Array] slackChannelsToNotify channels to notify on status change
         # @option opts [Boolean] enabled service enabled flag
         # @return [Hash] service
         def update_service(environment_id, service_id, opts = {})
@@ -68,11 +83,15 @@ module BWStatusBoardAPI
         # @param environment_id [Integer] environment id
         # @param service_id [Integer] service id
         # @param opts [Hash] options hash of parameters
+        # @option opts [String] environment the id of the environment
         # @option opts [String] name name of the service
         # @option opts [String] shortName short name of the service
         # @option opts [String] status status of the service
         # @option opts [String] url url of the service
         # @option opts [Integer] successStatusCode success status code of the service
+        # @option opts [Boolean] slackNotify notify on slack flag
+        # @option opts [Array] slackUsersToNotify users to notify on status change
+        # @option opts [Array] slackChannelsToNotify channels to notify on status change
         # @option opts [Boolean] enabled service enabled flag
         # @return [Hash] service
         def patch_service(environment_id, service_id, opts = {})
@@ -94,7 +113,7 @@ module BWStatusBoardAPI
         # @param summary [Boolean] summary flag
         # @return [Array] services
         def failing_services(environment_id, summary = true)
-          filter(services(environment_id), summary, 'status', 'failure')
+          filter(services(environment_id)['results'], summary, 'status', 'failure')
         end
 
         # Returns successful services for environment
@@ -103,7 +122,7 @@ module BWStatusBoardAPI
         # @param summary [Boolean] summary flag
         # @return [Array] services
         def successful_services(environment_id, summary = true)
-          filter(services(environment_id), summary, 'status', 'success')
+          filter(services(environment_id)['results'], summary, 'status', 'success')
         end
       end
     end

data/lib/bw_status_board_api/client/environments.rb

@@ -10,16 +10,22 @@ module BWStatusBoardAPI
 
       # Get environments
       #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] page the page
+      # @option opts [Integer] pageSize the page size
+      # @option opts [String] orderBy the parameter to order by
+      # @option opts [String] orderDirection the direction to order
+      # @option opts [String] fields the fields to return
       # @return [Hash] environments
-      def environments
-        get 'environments'
+      def environments(opts = {})
+        get 'environments', opts
       end
 
       # Returns environments name list
       #
       # @return [Array] environments
       def environments_summary
-        filter(environments, true)
+        filter(environments['results'], true)
       end
 
       # Get environment
@@ -37,6 +43,9 @@ module BWStatusBoardAPI
       # @option opts [String] shortName short name of the environment
       # @option opts [Array] services services within the board
       # @option opts [String] status status of the environment
+      # @option opts [Boolean] slackNotify notify on slack flag
+      # @option opts [Array] slackUsersToNotify users to notify on status change
+      # @option opts [Array] slackChannelsToNotify channels to notify on status change
       # @option opts [Boolean] enabled environment enabled flag
       # @return [Hash] environment
       def create_environment(opts = {})
@@ -51,6 +60,9 @@ module BWStatusBoardAPI
       # @option opts [String] shortName short name of the environment
       # @option opts [Array] services services within the board
       # @option opts [String] status status of the environment
+      # @option opts [Boolean] slackNotify notify on slack flag
+      # @option opts [Array] slackUsersToNotify users to notify on status change
+      # @option opts [Array] slackChannelsToNotify channels to notify on status change
       # @option opts [Boolean] enabled environment enabled flag
       # @return [Hash] environment
       def update_environment(environment_id, opts = {})
@@ -65,6 +77,9 @@ module BWStatusBoardAPI
       # @option opts [String] shortName short name of the environment
       # @option opts [Array] services services within the board
       # @option opts [String] status status of the environment
+      # @option opts [Boolean] slackNotify notify on slack flag
+      # @option opts [Array] slackUsersToNotify users to notify on status change
+      # @option opts [Array] slackChannelsToNotify channels to notify on status change
       # @option opts [Boolean] enabled environment enabled flag
       # @return [Hash] environment
       def patch_environment(environment_id, opts = {})
@@ -84,7 +99,7 @@ module BWStatusBoardAPI
       # @param summary [Boolean] summary flag
       # @return [Array] environments
       def failing_environments(summary = true)
-        filter(environments, summary, 'status', 'failure')
+        filter(environments['results'], summary, 'status', 'failure')
       end
 
       # Returns partially successful environments
@@ -92,7 +107,7 @@ module BWStatusBoardAPI
       # @param summary [Boolean] summary flag
       # @return [Array] environments
       def partially_successful_environments(summary = true)
-        filter(environments, summary, 'status', 'partialSuccess')
+        filter(environments['results'], summary, 'status', 'partialSuccess')
       end
 
       # Returns successful environments
@@ -100,7 +115,7 @@ module BWStatusBoardAPI
       # @param summary [Boolean] summary flag
       # @return [Array] environments
       def successful_environments(summary = true)
-        filter(environments, summary, 'status', 'success')
+        filter(environments['results'], summary, 'status', 'success')
       end
     end
   end

data/lib/bw_status_board_api/client/metrics.rb

@@ -16,42 +16,42 @@ module BWStatusBoardAPI
       #
       # @return [Integer] total
       def total_boards
-        boards.size
+        boards['results'].size
       end
 
       # Returns total environments
       #
       # @return [Integer] total
       def total_environments
-        environments.size
+        environments['results'].size
       end
 
       # Returns total failing environments
       #
       # @return [Integer] total
       def total_failing_environments
-        filter(environments, false, 'status', 'failure').size
+        filter(environments['results'], false, 'status', 'failure').size
       end
 
       # Returns total partially successful environments
       #
       # @return [Integer] total
       def total_partially_successful_environments
-        filter(environments, false, 'status', 'partialSuccess').size
+        filter(environments['results'], false, 'status', 'partialSuccess').size
       end
 
       # Returns total successful environments
       #
       # @return [Integer] total
       def total_successful_environments
-        filter(environments, false, 'status', 'success').size
+        filter(environments['results'], false, 'status', 'success').size
       end
 
       # Returns total services
       #
       # @return [Integer] total
       def total_services
-        environments.map { |environment| environment['services'].size }.inject(:+)
+        environments['results'].map { |environment| environment['services'].size }.inject(:+)
       end
 
       # Returns total services for environment
@@ -59,7 +59,7 @@ module BWStatusBoardAPI
       # @param environment_id [Integer] environment id
       # @return [Integer] total
       def total_environment_services(environment_id)
-        services(environment_id).size
+        services(environment_id)['results'].size
       end
 
       # Returns total failing services
@@ -79,7 +79,7 @@ module BWStatusBoardAPI
       private
 
       def all_services
-        environments.map { |environment| environment['services'] }.flatten
+        environments['results'].map { |environment| environment['services'] }.flatten
       end
     end
   end

data/lib/bw_status_board_api/version.rb

@@ -1,4 +1,4 @@
 # BW Version
 module BWStatusBoardAPI
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bw_status_board_api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonathan Chrisp
@@ -170,4 +170,3 @@ summary: Brandwatch Status Board API Wrapper
 test_files:
 - spec/bw_status_board_api_spec.rb
 - spec/helper.rb
-has_rdoc: