statuspageio 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c94e53b439a9509a7bb2d66d4935f6d7fc4264155ef471de82cb36660a226715
-  data.tar.gz: 39b2b3672117b309391f9cb1cb3bc6d4edb4a4836f288ab7b527572014967b69
+  metadata.gz: f43cbc28350fdc2b5afccd05f3d1e2019afd66628194aebee9be946f8fdca91f
+  data.tar.gz: '095dd6153b9dab01037d0158b1baeb7e52dfb71d8b3d040d1284d8ad42ad2536'
 SHA512:
-  metadata.gz: 0fa4e7c17f275c7d40e7064109b662534fc3460450d2e351b1154cdd1254dce9ec54c8a42395031211c46aafa109e7de9652e3ed484c293d3373ab2ff60be26f
-  data.tar.gz: 0dc970cf730beabc42b60455850ceec989b2a1d1d47eeac9411b4b84d751f6892ae71e69d442ad3e81092ff17056dcd8d78511b509e0df4d2b44635af714b535
+  metadata.gz: 4ac50e89b3f18e9ba6eb5715889fb5320057f1496811509b8942fa15b568f3dfa24e1b931a29b73ecd52de0df3dd150593e879906d0fb556505bb378091a4d11
+  data.tar.gz: d992c244e59e3f4eed5e086e4fbe4ff59d2e7b0687654b431283d134d558fa9de010848df6f6b07940e36ab0c172ce90f624f917e685250cb4cbea8c785c14a1

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.7

data/Gemfile.lock

@@ -1,24 +1,76 @@
 PATH
   remote: .
   specs:
-    statuspageio (0.1.0)
-      httparty (~> 0.15.6)
+    statuspageio (0.2.0)
+      httparty (~> 0.17)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    httparty (0.15.6)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
     multi_xml (0.6.0)
-    rake (10.5.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (5.0.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.2)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+    webmock (3.13.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
+  bundler (~> 2.1, >= 2.1.0)
+  rake (~> 12.3, >= 12.3.3)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.18)
   statuspageio!
+  webmock (~> 3.13.0)
 
 BUNDLED WITH
-   1.16.0
+   2.2.17

data/README.md

@@ -1,3 +1,6 @@
+[![Build Status](https://travis-ci.com/dasnixon/statuspageio.svg?branch=master)](https://travis-ci.com/dasnixon/statuspageio)
+[![Maintainability](https://api.codeclimate.com/v1/badges/bc9c8c9d3bcad2438f10/maintainability)](https://codeclimate.com/github/dasnixon/statuspageio/maintainability)
+
 # Statuspageio
 
 Ruby gem for the [Statuspage REST API](https://developer.statuspage.io).
@@ -20,14 +23,70 @@ Or install it yourself as:
 
 ## Usage
 
-##### In plain Ruby
+#### Initializing a client
 
 ```ruby
 client = Statuspageio::Client.new(api_key: '<your_api_key>', page_id: '<your_page_id>')
-client.incidents(:all) # get a list of all your incidents
+
+client.incidents
+```
+
+#### Incidents
+
+```ruby
+# get a list of all your incidents
+client.incidents
+
+# get incidents scoped by their status
+client.incidents(:active_maintenance)
+client.incidents(:scheduled)
+client.incidents(:unresolved)
+client.incidents(:upcoming)
+
+# pagination support
+client.incidents(limit: 20, page: 2)
+
+# query support
+client.incidents(query: 'AWS is down')
+
+# fetch an incident
+client.incident(<incident_id>)
+
+# create an incident (see https://developer.statuspage.io for payload options)
+client.create_incident(<incident payload>)
+
+# update an incident
+client.update_incident(<incident_id>, payload)
+
+# delete an incident
+client.delete_incident(<incident_id>)
+
+```
+
+#### Subscribers
+
+```ruby
+# get a list of all your subscribers
+client.subscribers
+
+# get a list of all your subscribers per incident
+client.subscribers(incident_id: <incident_id>)
+
+# query support
+client.subscribers(query: 'Albert Einstein')
+
+# create a subscriber (see https://developer.statuspage.io for payload options)
+client.create_subscriber(<subscriber payload>)
+
+# delete a subscriber
+client.delete_subscriber(<subscriber_id>)
+
+# delete a subscriber for an incident
+client.delete_subscriber(<subscriber_id>, incident_id: <incident_id>)
+
 ```
 
-##### In Rails you can configure using an initializer
+#### In Rails you can configure using an initializer
 
 `config/intializers/statuspage.rb`
 
@@ -46,7 +105,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/statuspageio.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dasnixon/statuspageio.
 
 ## License
 

data/lib/statuspageio/client/incident.rb

@@ -1,22 +1,85 @@
+# frozen_string_literal: true
+
+# https://developer.statuspage.io/#tag/incidents
 module Statuspageio
   class Client
     module Incident
-      def incidents(scope = :all)
-        case scope
-        when :all
-          get("/pages/#{self.page_id}/incidents")
-        when :unresolved
-          get("/pages/#{self.page_id}/incidents/unresolved")
-        when :scheduled
-          get("/pages/#{self.page_id}/incidents/scheduled")
-        else
-          get("/pages/#{self.page_id}/incidents")
-        end
+      extend Gem::Deprecate
+
+      INCIDENT_TYPES = %w[
+        active_maintenance
+        scheduled
+        unresolved
+        upcoming
+      ].freeze
+
+      VALID_INCIDENT_OPTIONS = %i[
+        auto_transition_deliver_notifications_at_end
+        auto_transition_deliver_notifications_at_start
+        auto_transition_to_maintenance_state
+        auto_transition_to_operational_state
+        auto_tweet_at_beginning
+        auto_tweet_on_completion
+        auto_tweet_on_creation
+        auto_tweet_one_hour_before
+        backfill_date
+        backfilled
+        body
+        components
+        component_ids
+        deliver_notifications
+        impact_override
+        metadata
+        name
+        status
+        scheduled_auto_completed
+        scheduled_auto_transition
+        scheduled_auto_in_progress
+        scheduled_for
+        scheduled_remind_prior
+        scheduled_until
+      ].freeze
+
+      def incidents(scope = :all, limit: 100, page: 1, query: nil)
+        query_opts = { limit: limit, page: page, query: query }.compact
+
+        return get("/pages/#{page_id}/incidents/#{scope}", query_opts) if INCIDENT_TYPES.include?(scope&.to_s)
+
+        get("/pages/#{page_id}/incidents", query_opts)
       end
 
-      def search_incidents(q)
-        return incidents if q.nil? || q.empty?
-        get("/pages/#{self.page_id}/incidents", { q: q })
+      def incident(incident_id)
+        get("/pages/#{page_id}/incidents/#{incident_id}")
+      end
+
+      def search_incidents(query)
+        incidents(query: query)
+      end
+
+      deprecate :search_incidents, :incidents, 2021, 7
+
+      def delete_incident(incident_id)
+        delete("/pages/#{page_id}/incidents/#{incident_id}")
+      end
+
+      def create_incident(opts = {})
+        create_opts = allowlist_opts(symbolize_keys(opts))
+
+        raise ArgumentError, 'name is required' if create_opts[:name].nil? || create_opts[:name].empty?
+
+        post("/pages/#{page_id}/incidents", incident: create_opts)
+      end
+
+      def update_incident(incident_id, opts = {})
+        update_opts = allowlist_opts(symbolize_keys(opts))
+
+        put("/pages/#{page_id}/incidents/#{incident_id}", incident: update_opts)
+      end
+
+      private
+
+      def allowlist_opts(opts)
+        opts.slice(*VALID_INCIDENT_OPTIONS)
       end
     end
   end

data/lib/statuspageio/client/subscriber.rb

@@ -1,51 +1,61 @@
+# frozen_string_literal: true
+
+# https://developer.statuspage.io/#tag/subscribers
 module Statuspageio
   class Client
     module Subscriber
-      SUBSCRIBER_OPTIONS = %i(
+      extend Gem::Deprecate
+
+      SUBSCRIBER_OPTIONS = %i[
+        component_ids
         email
         endpoint
+        page_access_user
         phone_country
         phone_number
         skip_confirmation_notification
-        page_access_user
-        component_ids
-      )
+      ].freeze
+
+      def subscribers(incident_id: nil, query: nil)
+        query_opts = { q: query }.compact
 
-      def subscribers(incident_id: nil)
         if incident_id
-          get("/pages/#{self.page_id}/incidents/#{incident_id}/subscribers")
+          get("/pages/#{page_id}/incidents/#{incident_id}/subscribers", query_opts)
         else
-          get("/pages/#{self.page_id}/subscribers")
+          get("/pages/#{page_id}/subscribers", query_opts)
         end
       end
 
-      def search_subscribers(q)
-        return subscribers if q.nil? || q.empty?
-        get("/pages/#{self.page_id}/subscribers", { q: q })
+      def search_subscribers(query)
+        subscribers(query: query)
       end
 
+      deprecate :search_subscribers, :subscribers, 2021, 7
+
       def create_subscriber(options)
-        create_options = options.dup.slice(*SUBSCRIBER_OPTIONS)
+        create_options = symbolize_keys(options).slice(*SUBSCRIBER_OPTIONS)
 
         if valid_for_subscribing?(create_options)
-          post("/pages/#{self.page_id}/subscribers", { subscriber: create_options })
+          post("/pages/#{page_id}/subscribers", subscriber: create_options)
         else
-          raise ArgumentError, 'An email address or phone number with the two digit country code is required'
+          raise ArgumentError, 'An email address or phone number with the two digit country code '\
+                               'is required'
         end
       end
 
       def delete_subscriber(subscriber_id, incident_id: nil)
         if incident_id
-          delete("/pages/#{self.page_id}/incidents/#{incident_id}/subscribers/#{subscriber_id}")
+          delete("/pages/#{page_id}/incidents/#{incident_id}/subscribers/#{subscriber_id}")
         else
-          delete("/pages/#{self.page_id}/subscribers/#{subscriber_id}")
+          delete("/pages/#{page_id}/subscribers/#{subscriber_id}")
         end
       end
 
       private
 
       def valid_for_subscribing?(options)
-        !(options[:email].empty? && (options[:phone_country].empty? || options[:phone_number].empty?))
+        !(options[:email].empty? &&
+          (options[:phone_country].empty? || options[:phone_number].empty?))
       end
     end
   end

data/lib/statuspageio/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'httparty'
 require 'statuspageio/configuration'
 require 'statuspageio/response_error'
@@ -31,9 +33,8 @@ module Statuspageio
     end
 
     def self.bad_response(response)
-      if response.class == HTTParty::Response
-        raise ResponseError, response
-      end
+      raise ResponseError, response if response.instance_of?(HTTParty::Response)
+
       raise StandardError, 'Unknown error'
     end
 
@@ -55,10 +56,18 @@ module Statuspageio
 
     private
 
+    def symbolize_keys(opts)
+      opts.transform_keys do |key|
+        key.to_sym
+      rescue StandardError
+        key
+      end
+    end
+
     def headers
       {
-        'Authorization' => "OAuth #{self.api_key}",
-        'Content-Type'  => 'application/json'
+        'Authorization' => "OAuth #{api_key}",
+        'Content-Type' => 'application/json'
       }
     end
   end

data/lib/statuspageio/configuration.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Statuspageio
   module Configuration
     # An array of valid keys in the options hash when configuring a {Gems::Client}
-    VALID_OPTIONS_KEYS = [
-      :api_key,
-      :page_id
+    VALID_OPTIONS_KEYS = %i[
+      api_key
+      page_id
     ].freeze
 
     attr_accessor(*VALID_OPTIONS_KEYS)

data/lib/statuspageio/response_error.rb

@@ -1,35 +1,40 @@
+# frozen_string_literal: true
+
 module Statuspageio
   class ResponseError < StandardError
-
-    attr_reader :response, :code, :errors
+    attr_accessor :response, :code, :errors
 
     def initialize(res)
-      @response = res.response
-      @code     = res.code
+      self.response = res.response
+      self.code     = res.code
       begin
-        @errors = parse_errors(res.parsed_response)
+        self.errors = parse_errors(res.parsed_response)
       rescue JSON::ParserError
-        @errors = [res.response.body]
+        self.errors = [res.response.body]
       end
     end
 
     def to_s
-      "#{code.to_s} #{response.msg}".strip
+      [code.to_s, response.msg, inlined_errors].compact.map(&:strip).join(' ')
     end
 
     private
 
     def parse_errors(errors)
-      return case errors
-        when Hash
-          errors.collect{|k,v| "#{k}: #{v}"}
-        when String
-          [errors]
-        when Array
-          errors
-        else
-          []
+      case errors
+      when Hash
+        errors.collect { |k, v| "#{k}: #{v}" }
+      when String
+        [errors]
+      when Array
+        errors
+      else
+        []
       end
     end
+
+    def inlined_errors
+      errors&.join(', ')
+    end
   end
 end

data/lib/statuspageio/version.rb

@@ -1,3 +1,3 @@
 module Statuspageio
-  VERSION = '0.1.5'
+  VERSION = '0.2.0'
 end

data/lib/statuspageio.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'statuspageio/client'
 require 'statuspageio/configuration'
 
@@ -11,6 +13,7 @@ module Statuspageio
 
     def method_missing(method, *args, &block)
       return super unless new.respond_to?(method)
+
       new.send(method, *args, &block)
     end
 

data/rubocop.yml

@@ -0,0 +1,43 @@
+# This explicitly enables all new cops
+# We should just have to adjust where we deviate from the defaults
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'test/**/*.rb'
+
+Layout/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  AllowAliasSyntax: true
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  AllowComments: true
+  Enabled: true
+
+Lint/RaiseException:
+  AllowedImplicitNamespaces: true
+  Enabled: true
+
+Style/ExponentialNotation:
+  EnforcedStyle: scientific
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+  EnforcedStyle: braces

data/statuspageio.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "statuspageio/version"
@@ -29,8 +28,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty", "~> 0.16.4"
+  spec.add_dependency "httparty", "~> 0.17"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.1.0'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rubocop', '~> 1.18'
+  spec.add_development_dependency 'webmock', '~> 3.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statuspageio
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Nixon
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2023-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,43 +16,97 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.4
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.4
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+        version: 3.13.0
+description:
 email:
 - chris.d.nixon@gmail.com
 executables: []
@@ -60,6 +114,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -74,12 +130,13 @@ files:
 - lib/statuspageio/configuration.rb
 - lib/statuspageio/response_error.rb
 - lib/statuspageio/version.rb
+- rubocop.yml
 - statuspageio.gemspec
 homepage: https://github.com/dasnixon/statuspageio
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.18
+signing_key:
 specification_version: 4
 summary: Ruby API wrapper for Statuspage.io.
 test_files: []