spage 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54883813e4806e59ff2641b139408d512d21bc30c873b1a01c401541849cf49b
-  data.tar.gz: a7388e1c8b05ea32342411a7d62ef4fcb821606e8b3194dd1f42ac6e92dbc901
+  metadata.gz: 35eb8fd43c5337e98c631c59eb397344965292b8a31b41e374f892e9ef78b5ad
+  data.tar.gz: 789bb45f03127d6ffeda448880b9adf7a16f94511a49325c1ca9765c7ed2d9d9
 SHA512:
-  metadata.gz: b85f98b5d7aca797bb91e43ffb071c5c2e9c39cd8c1511c9e206d707cf11f56651ea54f8dccf9b3f0e1cc00c9666f8cf4a81d351ef2b5fcaac2929c8de56057e
-  data.tar.gz: 4a005cd7b9e291b83a9a15fe8cabadb663e48282ab2571a172e46f3e998c83e52934db68f8a504692de130c6e4a0fd5d1a6a480d57a834fc09173273ff00260d
+  metadata.gz: c55f9a3bfa318905236d38dd8eac141f78302a87d40686875921664183b72330126985af57ff66bbc7377f7c804b7a201dd877f3a09f5733c08fcd2d17284b25
+  data.tar.gz: a56f9e1c53e87c1ed3bee822e194d760e319eb6f7d4a78b53da341adadf2305aff2c4687949f1b7af3b7261bb6dd999626c531382081f5c31fd16fd6caee00ba

data/.gitignore

@@ -8,6 +8,6 @@
 /tmp/
 
 Gemfile.lock
-
+*.gem
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## [v0.2.0](https://github.com/nulty/spage/tree/v0.2.0) (2020-11-01)
+
+- Add CRUD Component API features
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
+## [v0.1.0](https://github.com/nulty/spage/tree/v0.1.0) (2020-10-20)
+
+[Full Changelog](https://github.com/nulty/spage/compare/a0bab1b42c6762ceaaa448a100763ca57d5f3449...v0.1.0)
+
+**Merged pull requests:**
+
+- Rename project to Spage [\#1](https://github.com/nulty/spage/pull/1) ([nulty](https://github.com/nulty))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -1,8 +1,6 @@
 # Spage
 
-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/spage`. To experiment with that code, 
-
-TODO: Delete this and the text above, and describe your gem
+Spage is a Ruby client for integrating Statuspage.io into your ruby app. The idea is for it to be more than just a set of http requests to the server. It tries to model the data on the server for you so you don't have to.
 
 ## Installation
 
@@ -38,12 +36,11 @@ Spage.configure do |config|
 end
 ```
 
-
 ### Client
 
-`Spage::Api::Page.all` returns all the pages for your account
-`Spage::Api::Page.find(id)` returns a single page
-`Spage::Api::Page.update(id, page)` updates the page
+`Spage::Api::Page.new.all` returns all the pages for your account
+`Spage::Api::Page.new.find(id)` returns a single page
+`Spage::Api::Page.new.update(id, page)` updates the page
 
 
 ## Development
@@ -58,14 +55,16 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/nulty/
 
 ### Testing
 
-The test suite should run normally. If the recorded API requests need to be updated, set an environment variable for the API key
+The test suite should run normally. If the recorded API requests need to be updated, set an environment variable for the API key and pass the `record: :all` to the use_cassette function you want to re-record.
 
-`STATUSPAGE_API_KEY=your-api-key bundle exec rspec`
+`VCR=1 STATUSPAGE_API_KEY=your-api-key bundle exec rspec`
 
 ## Roadmap
 
 - Add a logger with null logging
 - Add url_encoded body option to configuration
+- Validations on the resources
+- Respect HTTP caching like [`faraday/http_cache`](https://github.com/sourcelevel/faraday-http-cache)
 
 ## License
 

data/lib/spage.rb

@@ -16,15 +16,18 @@ module Spage
   autoload :Api, 'spage/api'
   autoload :Page, 'spage/resources/page'
   autoload :Incident, 'spage/resources/incident'
+  autoload :Component, 'spage/resources/component'
 
   module Api
     autoload :Page, 'spage/api/page'
     autoload :Incident, 'spage/api/incident'
+    autoload :Component, 'spage/api/component'
   end
 
   module Serializers
     autoload :Page, 'spage/serializers/page'
     autoload :Incident, 'spage/serializers/incident'
+    autoload :Component, 'spage/serializers/component'
   end
 
   def self.config

data/lib/spage/api/component.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Spage
+  # Api Module
+  #
+  module Api
+    # Component resources in the statuspage.io API
+    #
+    class Component
+      include Api
+
+      def all(page_id:)
+        response = client.get("pages/#{page_id}/components")
+
+        handle_response(response) do
+          response.body.map do |component|
+            Spage::Component.new(component)
+          end
+        end
+      end
+
+      def find(page_id:, id:)
+        response = client.get("pages/#{page_id}/components", id)
+
+        handle_response(response) do
+          Spage::Component.new(response.body)
+        end
+      end
+
+      def create(component, page_id:)
+        json = Spage::Serializers::Component.new(component,
+                                                 update: true).to_json
+        response = client.post("pages/#{page_id}/components", json)
+
+        handle_response(response) do
+          Spage::Component.new(response.body)
+        end
+      end
+
+      def update(component, page_id:, id:)
+        json = Spage::Serializers::Component.new(component,
+                                                 update: true).to_json
+        response = client.put("pages/#{page_id}/components", id, json)
+
+        handle_response(response) do
+          Spage::Component.new(response.body)
+        end
+      end
+
+      def delete(page_id:, id:)
+        response = client.delete("pages/#{page_id}/components", id)
+
+        handle_response(response) do
+          true
+        end
+      end
+    end
+
+    private
+
+    def handle_response(response)
+      case response
+      when Net::HTTPSuccess
+        yield
+      when Net::HTTPUnauthorized
+        raise(Error, 'Unauthorized: wrong API Key')
+      else
+        # Net::HTTPBadRequest, Net::HTTPUnprocessableEntity, Net::HTTPForbidden
+        raise(Error, response.body)
+      end
+    end
+  end
+end

data/lib/spage/api/incident.rb

@@ -29,6 +29,26 @@ module Spage
         end
       end
 
+      def scheduled(page_id:)
+        response = client.get("pages/#{page_id}/incidents/scheduled")
+
+        handle_response(response) do
+          response.body.map do |incident|
+            Spage::Incident.new(incident)
+          end
+        end
+      end
+
+      def active_maintenance(page_id:)
+        response = client.get("pages/#{page_id}/incidents/active_maintenance")
+
+        handle_response(response) do
+          response.body.map do |incident|
+            Spage::Incident.new(incident)
+          end
+        end
+      end
+
       def find(page_id:, id:)
         response = client.get("pages/#{page_id}/incidents", id)
 
@@ -39,7 +59,7 @@ module Spage
 
       def create(incident, page_id:)
         json = Spage::Serializers::Incident.new(incident,
-                                                     update: true).to_json
+                                                update: true).to_json
 
         response = client.post("pages/#{page_id}/incidents", json)
 
@@ -50,13 +70,21 @@ module Spage
 
       def update(incident, page_id:, id:)
         json = Spage::Serializers::Incident.new(incident,
-                                                     update: true).to_json
+                                                update: true).to_json
         response = client.put("pages/#{page_id}/incidents", id, json)
 
         handle_response(response) do
           Spage::Incident.new(response.body)
         end
       end
+
+      def delete(page_id:, id:)
+        response = client.delete("pages/#{page_id}/incidents", id)
+
+        handle_response(response) do
+          Spage::Incident.new(response.body)
+        end
+      end
     end
 
     private

data/lib/spage/client.rb

@@ -23,10 +23,14 @@ module Spage
     end
 
     def post(resource, body)
-      make_request(Net::HTTP::Post, resource, id = nil, body)
+      make_request(Net::HTTP::Post, resource, nil, body)
     end
 
-    # rubocop: disable Metrics/MethodLength
+    def delete(resource, id)
+      make_request(Net::HTTP::Delete, resource, id)
+    end
+
+    # rubocop: disable Metrics/MethodLength, Metrics/AbcSize
     def make_request(http_method, resource, id, body = nil)
       path = [@api_version, resource, id].compact.join('/')
       uri = URI::HTTP.build(host: BASE_URL, path: "/#{path}")
@@ -40,13 +44,13 @@ module Spage
       res = Net::HTTP.start(uri.hostname, use_ssl: true) do |http|
         response = http.request(request)
 
-        response.body = JSON.parse(response.body)
+        response.body = JSON.parse(response.body) if response.body
         response
       end
 
       yield(res) if block_given?
       res
     end
-    # rubocop: enable Metrics/MethodLength
+    # rubocop: enable Metrics/MethodLength, Metrics/AbcSize
   end
 end

data/lib/spage/resources/component.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Spage
+  # Page resource in statuspage.io
+  #
+  class Component
+    # rubocop: disable Metrics/MethodLength, Metrics/AbcSize
+    def initialize(attrs)
+      @id               = attrs['id']
+      @page_id          = attrs['page_id']
+      @created_at       = attrs['created_at']
+      @updated_at       = attrs['updated_at']
+      @group            = attrs['group']
+      @position         = attrs['position']
+      @automation_email = attrs['automation_email']
+
+      # Updatable properties
+      @description           = attrs['description']
+      @status                = attrs['status']
+      @name                  = attrs['name']
+      @only_show_if_degraded = attrs['only_show_if_degraded']
+      @group_id              = attrs['group_id']
+      @showcase              = attrs['showcase']
+    end
+    # rubocop: enable Metrics/MethodLength, Metrics/AbcSize
+
+    # rubocop: disable Layout/LineLength
+    attr_reader :id, :page_id, :created_at, :updated_at, :group, :position, :automation_email
+
+    attr_accessor :description, :status, :name, :only_show_if_degraded, :group_id, :showcase
+    # rubocop: enable Layout/LineLength
+
+    private
+
+    def date_parse(str)
+      return str if str.nil?
+      return str if str.is_a?(DateTime)
+
+      DateTime.parse(str)
+    end
+  end
+end

data/lib/spage/serializers/component.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Spage
+  module Serializers
+    # Serializer for the Component resource
+    #
+    class Component
+      def initialize(component, update: false)
+        @component = component
+        @ivars = ivars(update)
+      end
+
+      def to_json(obj = nil)
+        as_json.to_json(obj)
+      end
+
+      def as_json
+        to_hash
+      end
+
+      def to_hash
+        {
+          'component' => Hash[
+            @ivars.map do |name|
+              [name[1..-1], @component.instance_variable_get(name)]
+            end
+          ]
+        }
+      end
+
+      private
+
+      def ivars(update)
+        if update
+          @component.instance_variables.select do |name|
+            processed_name = name[1..-1]
+            update_attrs.include?(processed_name) &&
+              !@component.send(processed_name).nil?
+          end
+        else
+          @component.instance_variables
+        end
+      end
+
+      def update_attrs
+        %w[
+          description
+          status
+          name
+          only_show_if_degraded
+          group_id
+          showcase
+        ]
+      end
+    end
+  end
+end

data/lib/spage/serializers/incident.rb

@@ -34,7 +34,8 @@ module Spage
         if update
           @incident.instance_variables.select do |name|
             processed_name = name[1..-1]
-            update_attrs.include?(processed_name) && !@incident.send(processed_name).nil?
+            update_attrs.include?(processed_name) &&
+              !@incident.send(processed_name).nil?
           end
         else
           @incident.instance_variables

data/lib/spage/version.rb

@@ -1,3 +1,3 @@
 module Spage
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spage.gemspec

@@ -1,33 +1,32 @@
+# frozen_string_literal: true
+
 require_relative 'lib/spage/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "spage"
+  spec.name          = 'spage'
   spec.version       = Spage::VERSION
-  spec.authors       = ["Iain McNulty"]
-  spec.email         = ["iain@inulty.com"]
-
-  spec.summary       = %q{Ruby Client for using the Spage API}
-  spec.description   = %q{Ruby client for making requests the Spage API}
-  spec.homepage      = "https://github.com/nulty/spage"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.authors       = ['Iain McNulty']
+  spec.email         = ['iain@inulty.com']
 
-  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  spec.summary       = 'Ruby client for using the statuspage.io API'
+  spec.description   = 'Ruby client for making requests the statuspage.io API'
+  spec.homepage      = 'https://github.com/nulty/spage'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/nulty/spage"
-  spec.metadata["changelog_uri"] = "https://github.com/nulty/spage/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/nulty/spage'
+  spec.metadata['changelog_uri'] = 'https://github.com/nulty/spage/CHANGELOG.md'
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
   end
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "simplecov"
+  spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Iain McNulty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby client for making requests the Spage API
+description: Ruby client for making requests the statuspage.io API
 email:
 - iain@inulty.com
 executables: []
@@ -77,8 +77,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -86,12 +86,15 @@ files:
 - bin/setup
 - lib/spage.rb
 - lib/spage/api.rb
+- lib/spage/api/component.rb
 - lib/spage/api/incident.rb
 - lib/spage/api/page.rb
 - lib/spage/client.rb
 - lib/spage/config.rb
+- lib/spage/resources/component.rb
 - lib/spage/resources/incident.rb
 - lib/spage/resources/page.rb
+- lib/spage/serializers/component.rb
 - lib/spage/serializers/incident.rb
 - lib/spage/serializers/page.rb
 - lib/spage/version.rb
@@ -121,5 +124,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Ruby Client for using the Spage API
+summary: Ruby client for using the statuspage.io API
 test_files: []