statuspageio 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ec421c4e88d18d4fc0895107ce63e3d81ae6b4d
-  data.tar.gz: 0a79a02b7197521c53fc52b4d8980981a1a2f1f6
+SHA256:
+  metadata.gz: 541f00d959571fab29334ef1dbff8403564931e8023f7877c256f76edaa1c26b
+  data.tar.gz: 79ef800c5802e0539680880c09fa89519bc9f2f8b97dfff6270d68bc306b4cfd
 SHA512:
-  metadata.gz: 82b6707f58b5f53abe9af0454d4ea4a03af8d254b5ce8ac8383e0e984b7e89ff116b18d4b8f022174420ded0f531b9e4ec0cfdd0d679e8c2b35540e0d4de937e
-  data.tar.gz: b7ab5e90dda41a0a89f2ae1d11650555489ce2a77a6ea36751fc2c2e3c78fb9ae2eb65fdd3d85042853ec8b8b41dfcc2a27725864140ee69b1fad19a3e7f9fb9
+  metadata.gz: 44ad4009dadceee1950526c5930c15b9f56a53d252fed9e967170e3979da8c4c27d6dc4ddcfa990950c0294b66832e094b328402fe221f973ce3885693abaf87
+  data.tar.gz: beb031e23a779106d81711afba0ef97adb4a9987668c31834107880d1eeb9a21013ddf641cd494cf1f95266c9a73191cce17bc5dae1ef62b2b3853660a9a737f

data/Gemfile.lock

@@ -1,24 +1,28 @@
 PATH
   remote: .
   specs:
-    statuspageio (0.1.0)
-      httparty (~> 0.15.6)
+    statuspageio (0.1.5)
+      httparty (~> 0.17)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    httparty (0.15.6)
+    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.0225)
     multi_xml (0.6.0)
-    rake (10.5.0)
+    rake (12.3.3)
 
 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)
   statuspageio!
 
 BUNDLED WITH
-   1.16.0
+   2.2.17

data/README.md

@@ -1,8 +1,6 @@
 # Statuspageio
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/statuspageio`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby gem for the [Statuspage REST API](https://developer.statuspage.io).
 
 ## Installation
 
@@ -22,7 +20,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+##### In plain Ruby
+
+```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
+```
+
+##### In Rails you can configure using an initializer
+
+`config/intializers/statuspage.rb`
+
+```ruby
+Statuspageio.configure do |config|
+  config.api_key = ENV['STATUSPAGE_API_KEY']
+  config.page_id = ENV['STATUSPAGE_PAGE_ID']
+end
+```
 
 ## Development
 

data/lib/statuspageio.rb

@@ -3,15 +3,12 @@ require 'statuspageio/configuration'
 
 module Statuspageio
   extend Configuration
+
   class << self
-    # Alias for Statuspageio::Client.new
-    #
-    # @return [Statuspageio::Client]
     def new(options = {})
       Statuspageio::Client.new(options)
     end
 
-    # Delegate to Gems::Client
     def method_missing(method, *args, &block)
       return super unless new.respond_to?(method)
       new.send(method, *args, &block)

data/lib/statuspageio/client.rb

@@ -1,12 +1,17 @@
+require 'httparty'
 require 'statuspageio/configuration'
-require 'statuspageio/request'
+require 'statuspageio/response_error'
 
 module Statuspageio
   class Client
+    include HTTParty
+    base_uri 'https://api.statuspage.io/v1'
+
     require 'statuspageio/client/incident'
+    require 'statuspageio/client/subscriber'
 
-    include Statuspageio::Request
     include Statuspageio::Client::Incident
+    include Statuspageio::Client::Subscriber
 
     attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
 
@@ -16,5 +21,45 @@ module Statuspageio
         send("#{key}=", options[key])
       end
     end
+
+    def self.handle_response(response)
+      if response.success?
+        JSON.parse(response.body)
+      else
+        bad_response(response)
+      end
+    end
+
+    def self.bad_response(response)
+      if response.class == HTTParty::Response
+        raise ResponseError, response
+      end
+      raise StandardError, 'Unknown error'
+    end
+
+    def delete(path)
+      self.class.handle_response(self.class.delete("#{path}.json", headers: headers))
+    end
+
+    def get(path, query = {})
+      self.class.handle_response(self.class.get("#{path}.json", query: query, headers: headers))
+    end
+
+    def post(path, data = {})
+      self.class.handle_response(self.class.post("#{path}.json", body: data.to_json, headers: headers))
+    end
+
+    def put(path, data = {})
+      self.class.handle_response(self.class.put("#{path}.json", body: data.to_json, headers: headers))
+    end
+
+    private
+
+    def headers
+      {
+        'Authorization' => "OAuth #{self.api_key}",
+        'Content-Type'  => 'application/json'
+      }
+    end
   end
 end

data/lib/statuspageio/client/incident.rb

@@ -13,6 +13,11 @@ module Statuspageio
           get("/pages/#{self.page_id}/incidents")
         end
       end
+
+      def search_incidents(q)
+        return incidents if q.nil? || q.empty?
+        get("/pages/#{self.page_id}/incidents", { q: q })
+      end
     end
   end
 end

data/lib/statuspageio/client/subscriber.rb

@@ -0,0 +1,52 @@
+module Statuspageio
+  class Client
+    module Subscriber
+      SUBSCRIBER_OPTIONS = %i(
+        email
+        endpoint
+        phone_country
+        phone_number
+        skip_confirmation_notification
+        page_access_user
+        component_ids
+      )
+
+      def subscribers(incident_id: nil)
+        if incident_id
+          get("/pages/#{self.page_id}/incidents/#{incident_id}/subscribers")
+        else
+          get("/pages/#{self.page_id}/subscribers")
+        end
+      end
+
+      def search_subscribers(q)
+        return subscribers if q.nil? || q.empty?
+        get("/pages/#{self.page_id}/subscribers", { q: q })
+      end
+
+      def create_subscriber(options)
+        create_options = options.dup.slice(*SUBSCRIBER_OPTIONS)
+
+        if valid_for_subscribing?(create_options)
+          post("/pages/#{self.page_id}/subscribers", { subscriber: create_options })
+        else
+          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}")
+        else
+          delete("/pages/#{self.page_id}/subscribers/#{subscriber_id}")
+        end
+      end
+
+      private
+
+      def valid_for_subscribing?(options)
+        !(options[:email].empty? && (options[:phone_country].empty? || options[:phone_number].empty?))
+      end
+    end
+  end
+end

data/lib/statuspageio/response_error.rb

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

data/lib/statuspageio/version.rb

@@ -1,3 +1,3 @@
 module Statuspageio
-  VERSION = '0.1.1'
+  VERSION = '0.1.6'
 end

data/statuspageio.gemspec

@@ -29,8 +29,8 @@ 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.15.6"
+  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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statuspageio
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Chris Nixon
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,43 +16,55 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        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: '10.0'
-description: 
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+description:
 email:
 - chris.d.nixon@gmail.com
 executables: []
@@ -70,15 +82,16 @@ files:
 - lib/statuspageio.rb
 - lib/statuspageio/client.rb
 - lib/statuspageio/client/incident.rb
+- lib/statuspageio/client/subscriber.rb
 - lib/statuspageio/configuration.rb
-- lib/statuspageio/request.rb
+- lib/statuspageio/response_error.rb
 - lib/statuspageio/version.rb
 - statuspageio.gemspec
 homepage: https://github.com/dasnixon/statuspageio
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,9 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby API wrapper for Statuspage.io.
 test_files: []

data/lib/statuspageio/request.rb

@@ -1,30 +0,0 @@
-require 'httparty'
-
-module Statuspageio
-  module Request
-    include HTTParty
-    base_uri 'api.statuspage.io/v1'
-
-    def delete(path, data = {})
-      self.class.delete("#{path}.json", data, headers: headers)
-    end
-
-    def get(path, data = {})
-      self.class.get("#{path}.json", data, headers: headers)
-    end
-
-    def post(path, data = {})
-      self.class.post("#{path}.json", data, headers: headers)
-    end
-
-    def put(path, data = {})
-      self.class.put("#{path}.json", data, headers: headers)
-    end
-
-    private
-
-    def headers
-      { Authorization: "OAuth #{self.api_key}" }
-    end
-  end
-end