Module: Quark::Publisher

Defined in:
lib/quark/publisher.rb,
lib/quark/publisher/asset.rb,
lib/quark/publisher/request.rb,
lib/quark/publisher/version.rb,
lib/quark/publisher/collection.rb,
lib/quark/publisher/saved_query.rb,
lib/quark/publisher/asset_binary.rb,
lib/quark/publisher/service_error.rb

Defined Under Namespace

Modules: Asset, AssetBinary, Collection, Request, SavedQuery Classes: Configuration, ServiceError

Constant Summary collapse

VERSION = 
"0.2.0"

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Quark::Publisher::Configuration

Method used to fetch the configuration object

Returns:



34
35
36
 
# File 'lib/quark/publisher.rb', line 34

def configuration
  @configuration
end

Instance Attribute Details

#configuration ⇒ Quark::Publisher::Configuration

Returns Object used to configure the Quark::Author library.

Returns:




# File 'lib/quark/publisher.rb', line 13

Class Method Details

.configure {|Quark::Publisher::Configuration| ... } ⇒ Object

Configuration block used to configure the library.

Examples:

An example configuration

Quark::Publisher.configure do |config|
  config.api_key = '123456'
end

Yields:



26
27
28
29
 
# File 'lib/quark/publisher.rb', line 26

def self.configure
  yield configuration
  self.configuration
end

.reset ⇒ Quark::Publisher::Configuration

Method used to reset configuration. Primarily required during testing.

Returns:



41
42
43
 
# File 'lib/quark/publisher.rb', line 41

def self.reset
  @configuration = Configuration.new
end

.test_configure {|configuration| ... } ⇒ Quark::Publisher::Configuration

Method used during testing to temporarily set configurations and then immediately reset the configuration

Examples:

An example configuration

Quark::Publisher.test_configure do |config|
  config.username = '123545'

  assert_equal '123545', Quark::Publisher.configuration.username
end

Yields:

Returns:



55
56
57
58
 
# File 'lib/quark/publisher.rb', line 55

def self.test_configure
  yield configuration
  self.reset
end