gds-api-adapters 41.2.0 → 41.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c24e95959f29019789dbd84c748719cb0e0293c0
-  data.tar.gz: b65490923a5fc29011e568465c5654150e5d5045
+  metadata.gz: 5feb2ce88c93b7b3358523b586e7a756e3d4c4df
+  data.tar.gz: 5fb3102fd2d3b114ad2bffe89873478c6e6f4a53
 SHA512:
-  metadata.gz: 05c5d36089691eccd15cd8d764681ab62ea3027d343836d72c3ff6e1db72be7a88febc0bd74a80806b162a244278b943c30e45c0164f4a1a2cac4e34ab08c88e
-  data.tar.gz: 5baee7586f8abc91b4a9941bb16e9c81729d07c60bce9aaeaf2f8cf39238a94cdf837220c8b430c1c68429a0e18be2da6dd822a8c37404ecd7e5ceebfd492948
+  metadata.gz: f64b7cece8973c47f5078a4aa07f24292581b9799c99ec908cad406a3946024555e19406c5767c52a7687ac042f95bb2384d45e8f51d1d29b646cdaada178ffe
+  data.tar.gz: e09157c36fbadfef46512ecc341cfa8671014d8008bfad84553709970b9b77417477bf19d61e892ba23e2204e5f3019a43535afca5f07824e3cb0116d4b1c57c

data/lib/gds_api/link_checker_api.rb

@@ -0,0 +1,131 @@
+require_relative 'base'
+
+class GdsApi::LinkCheckerApi < GdsApi::Base
+  # Checks whether a link is broken.
+  #
+  # Makes a +GET+ request to the link checker api to check a link.
+  #
+  # @param uri [String] The URI to check.
+  # @param synchronous [Boolean] Whether the check should happen immediately. (optional)
+  # @param checked_within [Fixnum] The number of seconds the last check should
+  #   be within before doing another check. (optional)
+  # @return [LinkReport] A +SimpleDelegator+ of the +GdsApi::Response+ which
+  #   responds to:
+  #     :uri           the URI of the link
+  #     :status        the status of the link, one of: ok, pending, broken, caution
+  #     :checked       the date the link was checked
+  #     :errors        a hash mapping short descriptions to arrays of long descriptions
+  #     :warnings      a hash mapping short descriptions to arrays of long descriptions
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  def check(uri, synchronous: nil, checked_within: nil)
+    params = {
+      uri: uri,
+      synchronous: synchronous,
+      checked_within: checked_within
+    }
+
+    response = get_json(
+      "#{endpoint}/check" + query_string(params.delete_if { |_, v| v.nil? })
+    )
+
+    LinkReport.new(response.to_hash)
+  end
+
+  # Create a batch of links to check.
+  #
+  # Makes a +POST+ request to the link checker api to create a batch.
+  #
+  # @param uris [Array] A list of URIs to check.
+  # @param checked_within [Fixnum] The number of seconds the last check should
+  #   be within before doing another check. (optional)
+  # @param webhook_uri [String] The URI to be called when the batch finishes. (optional)
+  # @return [BatchReport] A +SimpleDelegator+ of the +GdsApi::Response+ which
+  #   responds to:
+  #     :id            the ID of the batch
+  #     :status        the status of the check, one of: complete or in_progress
+  #     :links         an array of link reports
+  #     :totals        an +OpenStruct+ of total information, fields: links, ok, caution, broken, pending
+  #     :completed_at  a date when the batch was completed
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  def create_batch(uris, checked_within: nil, webhook_uri: nil)
+    payload = {
+      uris: uris,
+      checked_within: checked_within,
+      webhook_uri: webhook_uri
+    }
+
+    response = post_json(
+      "#{endpoint}/batch", payload.delete_if { |_, v| v.nil? }
+    )
+
+    BatchReport.new(response.to_hash)
+  end
+
+  # Get information about a batch.
+  #
+  # Makes a +GET+ request to the link checker api to get a batch.
+  #
+  # @param id [Fixnum] The batch ID to get information about.
+  # @return [BatchReport] A +SimpleDelegator+ of the +GdsApi::Response+ which
+  #   responds to:
+  #     :id            the ID of the batch
+  #     :status        the status of the check, one of: complete or in_progress
+  #     :links         an array of link reports
+  #     :totals        an +OpenStruct+ of total information, fields: links, ok, caution, broken, pending
+  #     :completed_at  a date when the batch was completed
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  def get_batch(id)
+    BatchReport.new(
+      get_json(
+        "#{endpoint}/batch/#{id}"
+      ).to_hash
+    )
+  end
+
+  class LinkReport < SimpleDelegator
+    def uri
+      self["uri"]
+    end
+
+    def status
+      self["status"].to_sym
+    end
+
+    def checked
+      Time.iso8601(self["checked"])
+    end
+
+    def errors
+      self["errors"].each_with_object({}) { |(k, v), hash| hash[k.to_sym] = v }
+    end
+
+    def warnings
+      self["warnings"].each_with_object({}) { |(k, v), hash| hash[k.to_sym] = v }
+    end
+  end
+
+  class BatchReport < SimpleDelegator
+    def id
+      self["id"]
+    end
+
+    def status
+      self["status"].to_sym
+    end
+
+    def links
+      self["links"].map { |link_report| LinkReport.new(link_report) }
+    end
+
+    def totals
+      OpenStruct.new(self["totals"])
+    end
+
+    def completed_at
+      Time.iso8601(self["completed_at"])
+    end
+  end
+end

data/lib/gds_api/test_helpers/link_checker_api.rb

@@ -0,0 +1,70 @@
+require "gds_api/test_helpers/json_client_helper"
+
+module GdsApi
+  module TestHelpers
+    module LinkCheckerApi
+      LINK_CHECKER_API_ENDPOINT = Plek.current.find("link-checker-api")
+
+      def link_checker_api_link_report_hash(uri:, status: :ok, checked: nil, errors: {}, warnings: {})
+        {
+          uri: uri,
+          status: status,
+          checked: checked || Time.now.iso8601,
+          errors: errors,
+          warnings: warnings,
+        }
+      end
+
+      def link_checker_api_batch_report_hash(id:, status: :completed, links: [], totals: {}, completed_at: nil)
+        {
+          id: id,
+          status: status,
+          links: links.map { |hash| link_checker_api_link_report_hash(**hash) },
+          totals: totals,
+          completed_at: completed_at || Time.now.iso8601,
+        }
+      end
+
+      def link_checker_api_check(uri:, status: :ok, checked: nil, errors: {}, warnings: {})
+        body = link_checker_api_link_report_hash(
+          uri: uri, status: status, checked: checked, errors: errors, warnings: warnings
+        ).to_json
+
+        stub_request(:get, "#{LINK_CHECKER_API_ENDPOINT}/check")
+          .with(query: { uri: uri })
+          .to_return(body: body, status: 200, headers: { "Content-Type" => "application/json" })
+      end
+
+      def link_checker_api_get_batch(id:, status: :completed, links: [], totals: {}, completed_at: nil)
+        body = link_checker_api_batch_report_hash(
+          id: id, status: status, links: links, totals: totals, completed_at: completed_at
+        ).to_json
+
+        stub_request(:get, "#{LINK_CHECKER_API_ENDPOINT}/batch/#{id}")
+          .to_return(body: body, status: 200, headers: { "Content-Type" => "application/json" })
+      end
+
+      def link_checker_api_create_batch(uris:, checked_within: nil, webhook_uri: nil, id: 0, status: :in_progress, links: nil, totals: {}, completed_at: nil)
+        links = uris.map { |uri| { uri: uri } } if links.nil?
+
+        response_body = link_checker_api_batch_report_hash(
+          id: id, status: status, links: links, totals: totals, completed_at: completed_at
+        ).to_json
+
+        request_body = {
+          uris: uris,
+          checked_within: checked_within,
+          webhook_uri: webhook_uri,
+        }.delete_if { |_, v| v.nil? }.to_json
+
+        stub_request(:post, "#{LINK_CHECKER_API_ENDPOINT}/batch")
+          .with(body: request_body)
+          .to_return(
+            body: response_body,
+            status: status == :in_progress ? 202 : 201,
+            headers: { "Content-Type" => "application/json" }
+          )
+      end
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '41.2.0'.freeze
+  VERSION = '41.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 41.2.0
+  version: 41.3.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -369,6 +369,7 @@ files:
 - lib/gds_api/imminence.rb
 - lib/gds_api/json_client.rb
 - lib/gds_api/licence_application.rb
+- lib/gds_api/link_checker_api.rb
 - lib/gds_api/list_response.rb
 - lib/gds_api/local_links_manager.rb
 - lib/gds_api/mapit.rb
@@ -402,6 +403,7 @@ files:
 - lib/gds_api/test_helpers/intent_helpers.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
 - lib/gds_api/test_helpers/licence_application.rb
+- lib/gds_api/test_helpers/link_checker_api.rb
 - lib/gds_api/test_helpers/local_links_manager.rb
 - lib/gds_api/test_helpers/mapit.rb
 - lib/gds_api/test_helpers/need_api.rb