gds-api-adapters 53.1.0 → 53.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa07967cdfd1c7791a385f7bc585e8be843b5b447b2891b85d5242e44c834f12
-  data.tar.gz: 212336983c63d9e570b2adede0057d5976527b3417fdd487bebff5007a620457
+  metadata.gz: 28fdb9aa5f03109f651caa65a00eefcbf488473ae40a0a5ca671a4bb49506c0b
+  data.tar.gz: daf953f3e6f81eb98c61198cd25611378f0ee86f95bc82980b1f442637c2bf30
 SHA512:
-  metadata.gz: 5966d420493995200b47eac6f8895f4265914e8e76c56320e8756c716a23191cc2228932ce956b6b4e1ad23fa62db6a934e816d65f8e930e06dd9ac2de620c86
-  data.tar.gz: '09c2be717c31149258089e9982f34ca9e5af8544b60f292f73a157018de0c68ecb6ea2cdd9d64b4d22cf565f605cb603ca96c2344748994c962ac47a0c441083'
+  metadata.gz: e3dcc1d0b4e5cc2f37d0dc70b179a5523add55295a3713fe4214417f416c494ddb99c439dc329af764be9af3f00185e0126ae6770a48f5b126950703e58f2daf
+  data.tar.gz: fd4c5bbdff4794567c2aadf420e1e7f30eb2e22a583570d911968fe7678525b7bbd6e8545a8d99fef8b305262db47dc5185ca16321a128290ca486203937ed59

data/lib/gds-api-adapters.rb

@@ -1,2 +1,3 @@
 require 'gds_api/railtie' if defined?(Rails)
 require 'gds_api/exceptions'
+require 'gds_api'

data/lib/gds_api.rb

@@ -0,0 +1,184 @@
+require 'plek'
+require 'gds_api/asset_manager'
+require 'gds_api/calendars'
+require 'gds_api/content_store'
+require 'gds_api/email_alert_api'
+require 'gds_api/imminence'
+require 'gds_api/licence_application'
+require 'gds_api/link_checker_api'
+require 'gds_api/local_links_manager'
+require 'gds_api/mapit'
+require 'gds_api/maslow'
+require 'gds_api/organisations'
+require 'gds_api/publishing_api'
+require 'gds_api/publishing_api_v2'
+require 'gds_api/router'
+require 'gds_api/rummager'
+require 'gds_api/support'
+require 'gds_api/support_api'
+require 'gds_api/worldwide'
+
+# @api documented
+module GdsApi
+  # Creates a GdsApi::AssetManager adapter
+  #
+  # This will set a bearer token if a ASSET_MANAGER_BEARER_TOKEN environment
+  # variable is set
+  #
+  # @return [GdsApi::AssetManager]
+  def self.asset_manager(options = {})
+    GdsApi::AssetManager.new(
+      Plek.find('asset-manager'),
+      { bearer_token: ENV['ASSET_MANAGER_BEARER_TOKEN'] }.merge(options)
+    )
+  end
+
+  # Creates a GdsApi::Calendars adapter
+  #
+  # @return [GdsApi::Calendars]
+  def self.calendars(options = {})
+    GdsApi::Calendars.new(Plek.find('calendars'), options)
+  end
+
+  # Creates a GdsApi::ContentStore adapter
+  #
+  # @return [GdsApi::ContentStore]
+  def self.content_store(options = {})
+    GdsApi::ContentStore.new(Plek.find('content-store'), options)
+  end
+
+  # Creates a GdsApi::EmailAlertApi adapter
+  #
+  # This will set a bearer token if a EMAIL_ALERT_API_BEARER_TOKEN environment
+  # variable is set
+  #
+  # @return [GdsApi::EmailAlertApi]
+  def self.email_alert_api(options = {})
+    GdsApi::EmailAlertApi.new(
+      Plek.find('email-alert-api'),
+      { bearer_token: ENV['EMAIL_ALERT_API_BEARER_TOKEN'] }.merge(options)
+    )
+  end
+
+  # Creates a GdsApi::Imminence adapter
+  #
+  # @return [GdsApi::Imminence]
+  def self.imminence(options = {})
+    GdsApi::Imminence.new(Plek.find('imminence'), options)
+  end
+
+  # Creates a GdsApi::LicenceApplication
+  #
+  # @return [GdsApi::LicenceApplication]
+  def self.licence_application(options = {})
+    GdsApi::LicenceApplication.new(Plek.find('licensify'), options)
+  end
+
+  # Creates a GdsApi::LinkCheckerApi adapter
+  #
+  # @return [GdsApi::LinkCheckerApi]
+  def self.link_checker_api(options = {})
+    GdsApi::LinkCheckerApi.new(Plek.find('link-checker-api'), options)
+  end
+
+  # Creates a GdsApi::LocalLinksManager adapter
+  #
+  # @return [GdsApi::LocalLinksManager]
+  def self.local_links_manager(options = {})
+    GdsApi::LocalLinksManager.new(Plek.find('local-links-manager'), options)
+  end
+
+  # Creates a GdsApi::Mapit adapter
+  #
+  # @return [GdsApi::Mapit]
+  def self.mapit(options = {})
+    GdsApi::Mapit.new(Plek.find('mapit'), options)
+  end
+
+  # Creates a GdsApi::Maslow adapter
+  #
+  # It's set to use an external url as an endpoint as the Maslow adapter is
+  # used to generate external links
+  #
+  # @return [GdsApi::Maslow]
+  def self.maslow(options = {})
+    GdsApi::Maslow.new(Plek.new.external_url_for('maslow'), options)
+  end
+
+  # Creates a GdsApi::Organisations adapter for accessing Whitehall APIs on a
+  # whitehall-admin host
+  #
+  # @return [GdsApi::Organisations]
+  def self.organisations(options = {})
+    GdsApi::Organisations.new(Plek.find('whitehall-admin'), options)
+  end
+
+  # Creates a GdsApi::PublishingApi adapter
+  #
+  # This will set a bearer token if a PUBLISHING_API_BEARER_TOKEN environment
+  # variable is set
+  #
+  # @return [GdsApi::PublishingApi]
+  def self.publishing_api(options = {})
+    GdsApi::PublishingApi.new(
+      Plek.find('publishing-api'),
+      { bearer_token: ENV['PUBLISHING_API_BEARER_TOKEN'] }.merge(options)
+    )
+  end
+
+  # Creates a GdsApi::PublishingApiV2 adapter
+  #
+  # This will set a bearer token if a PUBLISHING_API_BEARER_TOKEN environment
+  # variable is set
+  #
+  # @return [GdsApi::PublishingApiV2]
+  def self.publishing_api_v2(options = {})
+    GdsApi::PublishingApiV2.new(
+      Plek.find('publishing-api'),
+      { bearer_token: ENV['PUBLISHING_API_BEARER_TOKEN'] }.merge(options)
+    )
+  end
+
+  # Creates a GdsApi::Router adapter for communicating with Router API
+  #
+  # @return [GdsApi::Router]
+  def self.router(options = {})
+    GdsApi::Router.new(Plek.find('router-api'), options)
+  end
+
+  # Creates a GdsApi::Rummager adapter to access via a rummager.* hostname
+  #
+  # @return [GdsApi::Rummager]
+  def self.rummager(options = {})
+    GdsApi::Rummager.new(Plek.find('rummager'), options)
+  end
+
+  # Creates a GdsApi::Rummager adapter to access via a search.* hostname
+  #
+  # @return [GdsApi::Rummager]
+  def self.search(options = {})
+    GdsApi::Rummager.new(Plek.find('search'), options)
+  end
+
+  # Creates a GdsApi::Support adapter
+  #
+  # @return [GdsApi::Support]
+  def self.support(options = {})
+    GdsApi::Support.new(Plek.find('support'), options)
+  end
+
+  # Creates a GdsApi::SupportApi adapter
+  #
+  # @return [GdsApi::SupportApi]
+  def self.support_api(options = {})
+    GdsApi::SupportApi.new(Plek.find('support-api'), options)
+  end
+
+  # Creates a GdsApi::Worldwide adapter for accessing Whitehall APIs on a
+  # whitehall-admin host
+  #
+  # @return [GdsApi::Worldwide]
+  def self.worldwide(options = {})
+    GdsApi::Worldwide.new(Plek.find('whitehall-admin'), options)
+  end
+end

data/lib/gds_api/helpers.rb

@@ -5,6 +5,9 @@ require 'gds_api/licence_application'
 require 'gds_api/worldwide'
 require 'gds_api/email_alert_api'
 
+# This module is deprecated and should be removed in the next major release
+# Apps using this are encouraged to use GdsApi module methods
+# (e.g. GdsApi.asset_manger) rather than using this mixin
 module GdsApi
   module Helpers
     def asset_manager_api(options = {})

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '53.1.0'.freeze
+  VERSION = '53.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 53.1.0
+  version: 53.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-19 00:00:00.000000000 Z
+date: 2018-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -356,6 +356,7 @@ files:
 - README.md
 - Rakefile
 - lib/gds-api-adapters.rb
+- lib/gds_api.rb
 - lib/gds_api/asset_manager.rb
 - lib/gds_api/base.rb
 - lib/gds_api/calendars.rb