Module: StrawberryAPI

Defined in:
lib/strawberry_api.rb,
lib/strawberry_api/edit.rb,
lib/strawberry_api/role.rb,
lib/strawberry_api/team.rb,
lib/strawberry_api/user.rb,
lib/strawberry_api/asset.rb,
lib/strawberry_api/proxy.rb,
lib/strawberry_api/client.rb,
lib/strawberry_api/marker.rb,
lib/strawberry_api/api_key.rb,
lib/strawberry_api/feature.rb,
lib/strawberry_api/library.rb,
lib/strawberry_api/project.rb,
lib/strawberry_api/session.rb,
lib/strawberry_api/setting.rb,
lib/strawberry_api/version.rb,
lib/strawberry_api/feedback.rb,
lib/strawberry_api/schedule.rb,
lib/strawberry_api/strategy.rb,
lib/strawberry_api/template.rb,
lib/strawberry_api/metadatum.rb,
lib/strawberry_api/collection.rb,
lib/strawberry_api/http_client.rb,
lib/strawberry_api/status_flag.rb,
lib/strawberry_api/access_right.rb,
lib/strawberry_api/client/edits.rb,
lib/strawberry_api/client/roles.rb,
lib/strawberry_api/client/teams.rb,
lib/strawberry_api/client/users.rb,
lib/strawberry_api/client/assets.rb,
lib/strawberry_api/configuration.rb,
lib/strawberry_api/client/markers.rb,
lib/strawberry_api/client/api_keys.rb,
lib/strawberry_api/client/features.rb,
lib/strawberry_api/client/projects.rb,
lib/strawberry_api/client/searches.rb,
lib/strawberry_api/client/sessions.rb,
lib/strawberry_api/client/settings.rb,
lib/strawberry_api/client/libraries.rb,
lib/strawberry_api/client/schedules.rb,
lib/strawberry_api/client/templates.rb,
lib/strawberry_api/custom_metadatum.rb,
lib/strawberry_api/client/collections.rb,
lib/strawberry_api/client/status_flags.rb,
lib/strawberry_api/client/asset_feedbacks.rb,
lib/strawberry_api/client/custom_metadata.rb,
lib/strawberry_api/feedback/asset_feedback.rb,
lib/strawberry_api/client/copy_to_feedbacks.rb,
lib/strawberry_api/client/project_feedbacks.rb,
lib/strawberry_api/client/archive_strategies.rb,
lib/strawberry_api/feedback/copy_to_feedback.rb,
lib/strawberry_api/feedback/project_feedback.rb,
lib/strawberry_api/strategy/archive_strategy.rb,
lib/strawberry_api/client/custom_metadata_sets.rb,
lib/strawberry_api/client/custom_metadata_fields.rb,
lib/strawberry_api/client/custom_metadata_options.rb,
lib/strawberry_api/client/asset_copy_to_strategies.rb,
lib/strawberry_api/strategy/archive_strategy_state.rb,
lib/strawberry_api/strategy/asset_copy_to_strategy.rb,
lib/strawberry_api/client/project_copy_to_strategies.rb,
lib/strawberry_api/strategy/project_copy_to_strategy.rb,
lib/strawberry_api/custom_metadata/custom_metadata_set.rb,
lib/strawberry_api/custom_metadata/custom_metadata_field.rb,
lib/strawberry_api/custom_metadata/custom_metadata_option.rb

Overview

module StrawberryAPI provides access to Strawberry REST API

Author:

Defined Under Namespace

Classes: AccessRight, ApiKey, ArchiveStrategy, ArchiveStrategyState, Asset, AssetCopyToStrategy, AssetFeedback, Client, Collection, Configuration, CopyToFeedback, CustomMetadataField, CustomMetadataOption, CustomMetadataSet, CustomMetadatum, Edit, Feature, Feedback, HttpClient, Library, Marker, Metadatum, Project, ProjectCopyToStrategy, ProjectFeedback, Proxy, Role, Schedule, Session, Setting, StatusFlag, Strategy, Team, Template, User

Constant Summary collapse

VERSION = 
"0.6.7"

Class Method Summary collapse

Class Method Details

.config ⇒ StrawberryAPI::Configuration

Return configuration If it has not been configured yet, initialize configuration

Returns:



15
16
17
 
# File 'lib/strawberry_api.rb', line 15

def self.config
  @config ||= StrawberryAPI::Configuration.new
end

.config=(config) ⇒ StrawberryAPI::Configuration

Set configuration

Parameters:

Returns:

Raises:

  • (TypeError) 


23
24
25
26
 
# File 'lib/strawberry_api.rb', line 23

def self.config=(config)
  raise TypeError unless config.is_a?(StrawberryAPI::Configuration)
  @config = config
end

.configure {|config| ... } ⇒ Object

Configure some settings

Yields:

  • (config) —

    Given configuration object

Yield Parameters:



33
34
35
 
# File 'lib/strawberry_api.rb', line 33

def self.configure
  yield(config)
end