bw_status_board_api 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5b1fdc69b090bbcd2e26f764d91da563f0b8787
-  data.tar.gz: 2f79d2f40eccda0887a71321a7f17b3c737a8774
+  metadata.gz: d5e487fe194eb83bdcfb1a9bdc308caecf9003e3
+  data.tar.gz: 5165623308736693ee65b76e37eade4fc1c4534f
 SHA512:
-  metadata.gz: f455b550839455d5b9cc833f96f8f0cc8c8e8fd7ffff35518a3805142a2f9ebadda40af4bc52008105259696ff4838ca270f12af2c32bae96394dc110ccf74a2
-  data.tar.gz: d9ed2ba171a3d1f6306753fc5ce7a3f84dec7c081dba6a6446712843a1855adebcf3920e5f5aed47012ac3f215e95758192ae5ce9df43bf94e6761d09fc82094
+  metadata.gz: 68ba44ea521c74c9d9e4b11d85eac3bc93aeb19d7da9abc84b9b9049b9bbaeea5b3584ff83a738127cc571098c23deeadc3b51b2f3e21dfd841b5c433f259c7d
+  data.tar.gz: ec3a688534b51212564567ed012f1b57c76d7811af5ff086909b129c769fe73a92199872aa3329f7cae4dbf846dfa81fdfa1ce39b1afed1636de2ce04afdaea9

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 1.0.2
+### Added
+* NoTask - added cops configuration to .rubocop.yml
+* NoTask - added Gemfile.lock to .gitignore
+
 ## 1.0.1
 ### Fixed
 * NoTask - fixed conflict with bwapi gem middleware

data/bw_status_board_api.gemspec

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/lib/bw_status_board_api/version'
 Gem::Specification.new do |s|
   s.name        = 'bw_status_board_api'
   s.version     = BWStatusBoardAPI::VERSION
-  s.date        = '2014-09-15'
+  s.date        = '2014-10-05'
   s.summary     = 'Brandwatch Status Board API Wrapper'
   s.description = 'A Ruby wrapper for the Brandwatch Status Board'
   s.author      = 'Jonathan Chrisp'
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'faraday', '~> 0.9.0'
   s.add_runtime_dependency 'faraday_middleware', '~> 0.9.1'
   s.add_runtime_dependency 'faraday_middleware-parse_oj', '~> 0.3.0'
-  s.add_runtime_dependency 'oj', '~> 2.10.2'
+  s.add_runtime_dependency 'oj', '~> 2.10.3'
 
   s.files         = `git ls-files`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }

data/lib/bw_status_board_api/client.rb

@@ -3,7 +3,9 @@ require 'bw_status_board_api/connection'
 require 'bw_status_board_api/request'
 require 'bw_status_board_api/performance'
 
+require 'bw_status_board_api/client/boards'
 require 'bw_status_board_api/client/environments'
+require 'bw_status_board_api/client/metrics'
 
 require 'faraday'
 
@@ -15,7 +17,9 @@ module BWStatusBoardAPI
     include BWStatusBoardAPI::Request
     include BWStatusBoardAPI::Performance
 
+    include BWStatusBoardAPI::Client::Boards
     include BWStatusBoardAPI::Client::Environments
+    include BWStatusBoardAPI::Client::Metrics
 
     # Initializes Client
     #

data/lib/bw_status_board_api/client/boards.rb

@@ -0,0 +1,77 @@
+require 'bw_status_board_api/client/environments/services'
+require 'bw_status_board_api/client/helpers/filter'
+
+module BWStatusBoardAPI
+  class Client
+    # Boards module for boards endpoints
+    module Boards
+      include BWStatusBoardAPI::Client::Helpers
+      include BWStatusBoardAPI::Client::Environments::Services
+
+      # Get boards
+      #
+      # @return [Hash] boards
+      def boards
+        get 'boards'
+      end
+
+      # Returns boards name list
+      #
+      # @return [Array] environments
+      def boards_summary
+        filter(boards, true)
+      end
+
+      # Get board
+      #
+      # @param board_id [Integer] board id
+      # @return [Hash] board
+      def board(board_id)
+        get "boards/#{board_id}"
+      end
+
+      # Create board
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] name name of the board
+      # @option opts [Array] environments environments within the board
+      # @option opts [Boolean] enabled board enabled flag
+      # @return [Hash] board
+      def create_board(opts = {})
+        post 'boards', opts
+      end
+
+      # Update board
+      #
+      # @param board_id [Integer] board id
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] name name of the board
+      # @option opts [Array] environments environments within the board
+      # @option opts [Boolean] enabled board enabled flag
+      # @return [Hash] board
+      def update_board(board_id, opts = {})
+        put "boards/#{board_id}", opts
+      end
+
+      # Patch board
+      #
+      # @param board_id [Integer] board id
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] name name of the board
+      # @option opts [Array] environments environments within the board
+      # @option opts [Boolean] enabled board enabled flag
+      # @return [Hash] board
+      def patch_board(board_id, opts = {})
+        patch "boards/#{board_id}", opts
+      end
+
+      # Delete board
+      #
+      # @param board_id [Integer] board id
+      # @return [Hash] board
+      def delete_board(board_id)
+        delete "boards/#{board_id}"
+      end
+    end
+  end
+end

data/lib/bw_status_board_api/client/environments.rb

@@ -1,17 +1,107 @@
 require 'bw_status_board_api/client/environments/services'
+require 'bw_status_board_api/client/helpers/filter'
 
 module BWStatusBoardAPI
   class Client
     # Environments module for environments endpoints
     module Environments
+      include BWStatusBoardAPI::Client::Helpers
       include BWStatusBoardAPI::Client::Environments::Services
 
-      # Get environments stored
+      # Get environments
       #
-      # @return [Hash] the environments stored
+      # @return [Hash] environments
       def environments
         get 'environments'
       end
+
+      # Returns environments name list
+      #
+      # @return [Array] environments
+      def environments_summary
+        filter(environments, true)
+      end
+
+      # Get environment
+      #
+      # @param environment_id [Integer] environment id
+      # @return [Hash] environment
+      def environment(environment_id)
+        get "environments/#{environment_id}"
+      end
+
+      # Create environment
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] name name of the environment
+      # @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] enabled environment enabled flag
+      # @return [Hash] environment
+      def create_environment(opts = {})
+        post 'environments', opts
+      end
+
+      # Update environment
+      #
+      # @param environment_id [Integer] environment id
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] name name of the environment
+      # @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] enabled environment enabled flag
+      # @return [Hash] environment
+      def update_environment(environment_id, opts = {})
+        put "environments/#{environment_id}", opts
+      end
+
+      # Patch environment
+      #
+      # @param environment_id [Integer] environment id
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] name name of the environment
+      # @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] enabled environment enabled flag
+      # @return [Hash] environment
+      def patch_environment(environment_id, opts = {})
+        patch "environments/#{environment_id}", opts
+      end
+
+      # Delete environment
+      #
+      # @param environment_id [Integer] environment id
+      # @return [Hash] environment
+      def delete_environment(environment_id)
+        delete "environments/#{environment_id}"
+      end
+
+      # Returns failing environments
+      #
+      # @param summary [Boolean] summary flag
+      # @return [Array] environments
+      def failing_environments(summary = true)
+        filter(environments, summary, 'status', 'failure')
+      end
+
+      # Returns partially successful environments
+      #
+      # @param summary [Boolean] summary flag
+      # @return [Array] environments
+      def partially_successful_environments(summary = true)
+        filter(environments, summary, 'status', 'partialSuccess')
+      end
+
+      # Returns successful environments
+      #
+      # @param summary [Boolean] summary flag
+      # @return [Array] environments
+      def successful_environments(summary = true)
+        filter(environments, summary, 'status', 'success')
+      end
     end
   end
 end

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

@@ -1,15 +1,110 @@
+require 'bw_status_board_api/client/helpers/filter'
+
 module BWStatusBoardAPI
   class Client
     module Environments
       # Services module for environment services endpoints
       module Services
+        include BWStatusBoardAPI::Client::Helpers
+
         # Get environment services
         #
-        # @param environment_id [Integer] Id of the existing environment
-        # @return [Hash] the services stored
+        # @param environment_id [Integer] environment id
+        # @return [Hash] services
         def services(environment_id)
           get "environments/#{environment_id}/services"
         end
+
+        # Returns services name list
+        #
+        # @param environment_id [Integer] environment id
+        # @return [Array] the environments
+        def services_summary(environment_id)
+          filter(services(environment_id), true)
+        end
+
+        # Get environment service
+        #
+        # @param environment_id [Integer] environment id
+        # @param service_id [Integer] service id
+        # @return [Hash] service
+        def service(environment_id, service_id)
+          get "environments/#{environment_id}/services/#{service_id}"
+        end
+
+        # Create service
+        #
+        # @param environment_id [Integer] environment id
+        # @param opts [Hash] options hash of parameters
+        # @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] enabled service enabled flag
+        # @return [Hash] service
+        def create_service(environment_id, opts = {})
+          post "environments/#{environment_id}/services", opts
+        end
+
+        # Update environment service
+        #
+        # @param environment_id [Integer] environment id
+        # @param service_id [Integer] service id
+        # @param opts [Hash] options hash of parameters
+        # @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] enabled service enabled flag
+        # @return [Hash] service
+        def update_service(environment_id, service_id, opts = {})
+          put "environments/#{environment_id}/services/#{service_id}", opts
+        end
+
+        # Patch environment service
+        #
+        # @param environment_id [Integer] environment id
+        # @param service_id [Integer] service id
+        # @param opts [Hash] options hash of parameters
+        # @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] enabled service enabled flag
+        # @return [Hash] service
+        def patch_service(environment_id, service_id, opts = {})
+          patch "environments/#{environment_id}/services/#{service_id}", opts
+        end
+
+        # Delete environment service
+        #
+        # @param environment_id [Integer] environment id
+        # @param service_id [Integer] service id
+        # @return [Hash] service
+        def delete_service(environment_id, service_id)
+          delete "environments/#{environment_id}/services/#{service_id}"
+        end
+
+        # Returns failing services for environment
+        #
+        # @param environment_id [Integer] environment id
+        # @param summary [Boolean] summary flag
+        # @return [Array] services
+        def failing_services(environment_id, summary = true)
+          filter(services(environment_id), summary, 'status', 'failure')
+        end
+
+        # Returns successful services for environment
+        #
+        # @param environment_id [Integer] environment id
+        # @param summary [Boolean] summary flag
+        # @return [Array] services
+        def successful_services(environment_id, summary = true)
+          filter(services(environment_id), summary, 'status', 'success')
+        end
       end
     end
   end

data/lib/bw_status_board_api/client/helpers/filter.rb

@@ -0,0 +1,14 @@
+module BWStatusBoardAPI
+  class Client
+    # Helpers module
+    module Helpers
+      def filter(response, summary = false, key = nil, value = nil)
+        response.each_with_object([]) do |hash, array|
+          if value.nil? || hash[key] == value
+            summary ? array << hash['name'] : array << hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bw_status_board_api/client/metrics.rb

@@ -0,0 +1,86 @@
+require 'bw_status_board_api/client/boards'
+require 'bw_status_board_api/client/environments'
+require 'bw_status_board_api/client/environments/services'
+require 'bw_status_board_api/client/helpers/filter'
+
+module BWStatusBoardAPI
+  class Client
+    # Metrics module
+    module Metrics
+      include BWStatusBoardAPI::Client::Boards
+      include BWStatusBoardAPI::Client::Environments
+      include BWStatusBoardAPI::Client::Environments::Services
+      include BWStatusBoardAPI::Client::Helpers
+
+      # Returns total boards
+      #
+      # @return [Integer] total
+      def total_boards
+        boards.size
+      end
+
+      # Returns total environments
+      #
+      # @return [Integer] total
+      def total_environments
+        environments.size
+      end
+
+      # Returns total failing environments
+      #
+      # @return [Integer] total
+      def total_failing_environments
+        filter(environments, false, 'status', 'failure').size
+      end
+
+      # Returns total partially successful environments
+      #
+      # @return [Integer] total
+      def total_partially_successful_environments
+        filter(environments, false, 'status', 'partialSuccess').size
+      end
+
+      # Returns total successful environments
+      #
+      # @return [Integer] total
+      def total_successful_environments
+        filter(environments, false, 'status', 'success').size
+      end
+
+      # Returns total services
+      #
+      # @return [Integer] total
+      def total_services
+        environments.map { |environment| environment['services'].size }.inject(:+)
+      end
+
+      # Returns total services for environment
+      #
+      # @param environment_id [Integer] environment id
+      # @return [Integer] total
+      def total_environment_services(environment_id)
+        services(environment_id).size
+      end
+
+      # Returns total failing services
+      #
+      # @return [Integer] total
+      def total_failing_services
+        filter(all_services, false, 'status', 'failure').size
+      end
+
+      # Returns total successful services
+      #
+      # @return [Integer] total
+      def total_successful_services
+        filter(all_services, false, 'status', 'success').size
+      end
+
+      private
+
+      def all_services
+        environments.map { |environment| environment['services'] }.flatten
+      end
+    end
+  end
+end

data/lib/bw_status_board_api/error.rb

@@ -2,70 +2,12 @@ module BWStatusBoardAPI
   # BWStatusBoardAPI error class
   class BWStatusBoardAPIError < StandardError
     def initialize(response = nil)
-      @errors = []
-      valid_response?(response)
-      @errors.empty? ? super() : super(@errors.join(', '))
-    end
-
-    # Check if response is valid
-    #
-    # @param object [Object] response object to check for errors
-    def valid_response?(response)
-      return nil if response.nil?
-      return nil unless response.body.is_a?(Object) && response.respond_to?(:body)
-      return nil unless response.body.is_a?(Hash)
-      parse_errors(errors_keys?(response.body)) unless response.body.nil?
-    end
-
-    # Check if response has known errors keys
-    #
-    # @param object [Object] response object to process for errors
-    def errors_keys?(body)
-      if body.key?('error') && body.key?('error_description')
-        body
-      elsif body.key?('errors')
-        body['errors']
+      if response.respond_to?(:body) && response.body.is_a?(Hash) && response.body.key?('message')
+        super(response.body['message'])
       else
-        nil
+        super()
       end
     end
-
-    # Parses errors based on error body passed
-    #
-    # @param body [Hash] errors
-    def parse_errors(body)
-      verify_type body
-    end
-
-    # Verifies type
-    #
-    # @param object [Object] type to determine
-    def verify_type(type)
-      case type
-      when Array
-        split_array_errors(type)
-      when Hash
-        split_hash_errors(type)
-      when String
-        @errors << type
-      end
-    end
-
-    # Iterates through errors in array
-    #
-    # @param array [Array] array to iterate
-    def split_array_errors(array)
-      array.each_with_index { |_e, i| verify_type array[i] }
-    end
-
-    # Iterates through errors in hash
-    #
-    # @param hash [Hash] hash to iterate
-    def split_hash_errors(hash)
-      message = []
-      hash.each { |k, v| message << "#{k}: #{v}" }
-      @errors << message.flatten.join(' with ')
-    end
   end
 
   # Raised when Brandwatch returns a 400 HTTP status code

data/lib/bw_status_board_api/version.rb

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

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: bw_status_board_api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonathan Chrisp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2014-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.24.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.24.1
 - !ruby/object:Gem::Dependency
   name: allotment
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware-parse_oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.2
+        version: 2.10.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.2
+        version: 2.10.3
 description: A Ruby wrapper for the Brandwatch Status Board
 email: jonathan@brandwatch.com
 executables:
@@ -115,9 +115,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .editorconfig
-- .gitignore
-- .rubocop.yml
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -126,8 +126,11 @@ files:
 - bw_status_board_api.gemspec
 - lib/bw_status_board_api.rb
 - lib/bw_status_board_api/client.rb
+- lib/bw_status_board_api/client/boards.rb
 - lib/bw_status_board_api/client/environments.rb
 - lib/bw_status_board_api/client/environments/services.rb
+- lib/bw_status_board_api/client/helpers/filter.rb
+- lib/bw_status_board_api/client/metrics.rb
 - lib/bw_status_board_api/configuration.rb
 - lib/bw_status_board_api/connection.rb
 - lib/bw_status_board_api/default.rb
@@ -150,17 +153,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Brandwatch Status Board API Wrapper