Module: Osm

Defined in:
lib/osm.rb,
lib/osm.rb,
lib/osm/sms.rb,
lib/osm/api.rb,
lib/osm/term.rb,
lib/osm/badge.rb,
lib/osm/event.rb,
lib/osm/model.rb,
lib/osm/badges.rb,
lib/osm/budget.rb,
lib/osm/member.rb,
lib/osm/meeting.rb,
lib/osm/giftaid.rb,
lib/osm/section.rb,
lib/osm/invoice.rb,
lib/osm/grouping.rb,
lib/osm/activity.rb,
lib/osm/register.rb,
lib/osm/api_access.rb,
lib/osm/flexi_record.rb

Defined Under Namespace

Classes: Activity, ActivityBadge, Api, ApiAccess, ArgumentIsInvalid, Badge, Badges, Budget, ChallengeBadge, ConnectionError, CoreBadge, Error, Event, FlexiRecord, Forbidden, GiftAid, Grouping, Invoice, Meeting, Member, Model, ObjectIsInvalid, Register, Section, Sms, StagedBadge, Term

Class Method Summary collapse

Class Method Details

.configure(options) ⇒ Object

Configure the options used by classes in the module

Parameters:

  • options (Hash)
  • options[:api] (Hash)

    a customizable set of options

  • options[:api][:osm] (Hash)

    a customizable set of options

  • options[:api][:ogm] (Hash)

    a customizable set of options

  • options[:cache] (Hash)

    a customizable set of options

Options Hash (options):

  • :api (Hash)

    Default options for accessing the API

  • :cache_config (Hash) — default: optional

    How classes in the module will cache data. Whilst this is optional you should remember that caching is required to use the OSM API.

Returns:

  • nil


83
84
85
86
87
# File 'lib/osm.rb', line 83

def self.configure(options)
  Osm::Model.configure(options[:cache])
  Osm::Api.configure(options[:api])
  nil
end