Class: GdsApi::Base
- Inherits:
-
Object
- Object
- GdsApi::Base
- Extended by:
- Forwardable
- Defined in:
- lib/gds_api/base.rb
Direct Known Subclasses
AssetManager, Calendars, ContentStore, EmailAlertApi, Imminence, LicenceApplication, LinkCheckerApi, LocalLinksManager, Mapit, Maslow, Organisations, PerformancePlatform::DataIn, PerformancePlatform::DataOut, PublishingApi, PublishingApiV2, Router, Rummager, Support, SupportApi, Worldwide
Defined Under Namespace
Classes: InvalidAPIURL
Class Attribute Summary collapse
-
.default_options ⇒ Object
Returns the value of attribute default_options.
- .logger ⇒ Object
Instance Attribute Summary collapse
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Instance Method Summary collapse
- #client ⇒ Object
- #create_client ⇒ Object
- #get_list(url) ⇒ Object
-
#initialize(endpoint_url, options = {}) ⇒ Base
constructor
A new instance of Base.
- #url_for_slug(slug, options = {}) ⇒ Object
Constructor Details
#initialize(endpoint_url, options = {}) ⇒ Base
Returns a new instance of Base.
42 43 44 45 46 47 48 49 |
# File 'lib/gds_api/base.rb', line 42 def initialize(endpoint_url, = {}) [:endpoint_url] = endpoint_url raise InvalidAPIURL unless endpoint_url =~ URI::RFC3986_Parser::RFC3986_URI = { logger: self.class.logger } = .merge(GdsApi::Base. || {}) @options = .merge() self.endpoint = [:endpoint_url] end |
Class Attribute Details
.default_options ⇒ Object
Returns the value of attribute default_options.
35 36 37 |
# File 'lib/gds_api/base.rb', line 35 def @default_options end |
.logger ⇒ Object
38 39 40 |
# File 'lib/gds_api/base.rb', line 38 def self.logger @logger ||= NullLogger.instance end |
Instance Attribute Details
#options ⇒ Object (readonly)
Returns the value of attribute options.
31 32 33 |
# File 'lib/gds_api/base.rb', line 31 def @options end |
Instance Method Details
#client ⇒ Object
13 14 15 |
# File 'lib/gds_api/base.rb', line 13 def client @client ||= create_client end |
#create_client ⇒ Object
17 18 19 |
# File 'lib/gds_api/base.rb', line 17 def create_client GdsApi::JsonClient.new() end |
#get_list(url) ⇒ Object
55 56 57 58 59 |
# File 'lib/gds_api/base.rb', line 55 def get_list(url) get_json(url) do |r| GdsApi::ListResponse.new(r, self) end end |
#url_for_slug(slug, options = {}) ⇒ Object
51 52 53 |
# File 'lib/gds_api/base.rb', line 51 def url_for_slug(slug, = {}) "#{base_url}/#{slug}.json#{query_string()}" end |