osm 0.0.5 → 0.0.6

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## Version 0.0.6
+
+  * Usage changes:
+    * When calling an api.get\_\* method api_data is now passed as an additional paramter not as part of the options
+  * Work on documentation:
+    * Tidy up params
+    * Tidy up returns
+    * Add class attributes
+  * Update README file:
+    * Improve installation instructions
+    * Add use section
+    * Add versioning section
+
+## Version 0.0.5
+
+  * Bug fix
+
+## Version 0.0.4
+
+  * Bug fix
+
+## Version 0.0.3
+
+  * Retrieve grouping points from OSM
+  * Respond to OSM chaninging how it returns member's groupings
+
+## Version 0.0.2
+
+  * Bug fixes
+
 ## Version 0.0.1
 
  * Initial release.

data/README.md

@@ -13,14 +13,48 @@ Staging [![Build Status](https://secure.travis-ci.org/robertgauld/osm.png?branch
 Use the [Online Scout Manager](https://www.onlinescoutmanager.co.uk) API.
 
 
-## Installation / Documentation
+## Installation
+
+**Requires Ruby 1.9.2 or later.**
 
 Add to your Gemfile and run the `bundle` command to install it.
 
 ```ruby
 gem 'osm'
 ```
-**Requires Ruby 1.9.2 or later.**
 
+Configure the gem during the initalization of the app (e.g. in config/initializers/osm.rb).
+
+```ruby
+ActionDispatch::Callbacks.to_prepare do
+Osm::Api.configure(
+  :api_id     => 'YOU WILL BE GIVEN THIS BY ED AT OSM',
+  :api_token  => 'YOU WILL BE GIVEN THIS BY ED AT OSM',
+  :api_name   => 'YOU WILL GIVE THIS TO ED AT OSM',
+  :api_site   => :scout,
+)
+end
+```
+
+
+## Use
+
+In order to use the OSM API you first need to authorize the api to be used by the user, to do this use the {Osm::Api#authorize} method to get a userid and secret.
+
+```ruby
+Osm::Api.new.authorize(users_email_address, users_osm_password)
+```
+
+Once you have done this you should store the userid and secret somewhere, you can then create an {Osm::Api} object to start acting as the user.
+
+```ruby
+api_for_this_user = Osm::Api.new(userid, secret)
+```
+
+
+## Documentation & Versioning
 
 Documentation can be found on [rubydoc.info](http://rubydoc.info/github/robertgauld/osm/master/frames)
+
+We follow the [Semantic Versioning](http://semver.org/) concept,
+however it should be noted that when the OSM API adds a feature it can be difficult to decide wether to bump the patch or minor version number up. A smaller change (such as adding score into the grouping object) will bump the patch whereas a larger change wil bump the minor version.

data/lib/osm/activity.rb

@@ -3,6 +3,47 @@ module Osm
   class Activity
 
     attr_reader :id, :version, :group_id, :user_id, :title, :description, :resources, :instructions, :running_time, :location, :shared, :rating, :editable, :deletable, :used, :versions, :sections, :tags, :files, :badges
+    # @!attribute [r] id
+    #   @return [FixNum] the id for the activity
+    # @!attribute [r] version
+    #   @return [FixNum] the version of the activity
+    # @!attribute [r] group_id
+    #   @return [FixNum] the group_id
+    # @!attribute [r] user_id
+    #   @return [FixNum] the user_id of the creator of the activity
+    # @!attribute [r] title
+    #   @return [String] the activity's title
+    # @!attribute [r] description
+    #   @return [String] the description of the activity
+    # @!attribute [r] resources
+    #   @return [String] resources required to do the activity
+    # @!attribute [r] instructions
+    #   @return [String] instructions for doing the activity
+    # @!attribute [r] running_time
+    #   @return [FixNum] duration of the activity in minutes
+    # @!attribute [r] location
+    #   @return [Symbol] :indoors or :outdoors
+    # @!attribute [r] shared
+    #   @return [FixNum] ?
+    # @!attribute [r] rating
+    #   @return [FixNum] ?
+    # @!attribute [r] editable
+    #   @return [Boolean] ?
+    # @!attribute [r] deletable
+    #   @return [Boolean] ?
+    # @!attribute [r] used
+    #   @return [FixNum] ?
+    # @!attribute [r] versions
+    #   @return [Hash] ?
+    # @!attribute [r] sections
+    #   @return [Array<Symbol>] the sections the activity is appropriate for
+    # @!attribute [r] tags
+    #   @return [Array<String>] the tags attached to the activity
+    # @!attribute [r] files
+    #   @return [Array] ?
+    # @!attribute [r] badges
+    #   @return [Array] ?
+
 
     # Initialize a new Activity using the hash returned by the API call
     # @param data the hash of data for the object returned by the API

data/lib/osm/api.rb

@@ -1,3 +1,13 @@
+# @!macro [new] options_get
+#   @param [Hash] options
+#   @option options [Boolean] :no_cache (optional) if true then the data will be retreived from OSM not the cache
+
+# @!macro [new] options_api_data
+#   @param [Hash] api_data
+#   @option api_data [String] 'userid' (optional) the OSM userid to make the request as
+#   @option api_data [String] 'secret' (optional) the OSM secret belonging to the above user
+
+
 module Osm
 
   class Api
@@ -11,9 +21,10 @@ module Osm
 
     # Initialize a new API connection
     # If passing user details then both must be passed
-    # @param userid (optional) osm userid of the user to act as
-    # @param secret (optional) osm secret of the user to act as
-    # @param site (optional) wether to use OSM (:scout) or OGM (:guide), defaults to the value set for the class
+    # @param [String] userid osm userid of the user to act as
+    # @param [String] secret osm secret of the user to act as
+    # @param [Symbol] site wether to use OSM (:scout) or OGM (:guide), defaults to the value set for the class
+    # @return nil
     def initialize(userid=nil, secret=nil, site=@@api_site)
       raise ArgumentError, 'You must pass a secret if you are passing a userid' if secret.nil? && !userid.nil?
       raise ArgumentError, 'You must pass a userid if you are passing a secret' if userid.nil? && !secret.nil?
@@ -22,15 +33,17 @@ module Osm
       @base_url = 'https://www.onlinescoutmanager.co.uk' if site == :scout
       @base_url = 'http://www.onlineguidemanager.co.uk' if site == :guide
       set_user(userid, secret)
+      nil
     end
 
     # Configure the API options used by all instances of the class
-    # @param options - a hash containing the following keys:
-    #   * :api_id - the apiid given to you for using the OSM id
-    #   * :api_token - the token which goes with the above api
-    #   * :api_name - the name displayed in the External Access tab of OSM
-    #   * :api_site - wether to use OSM (if :scout) or OGM (if :guide)
-    #   * :default_cache_ttl (optional, default = 30 minutes) - The default TTL value for the cache, note that some items are cached for twice this time and others are cached for half this time.
+    # @param [Hash] options
+    # @option options [String] :api_id the apiid given to you for using the OSM id
+    # @option options [String] :api_token the token which goes with the above api
+    # @option options [String] :api_name the name displayed in the External Access tab of OSM
+    # @option options [Symbol] :api_sate wether to use OSM (if :scout) or OGM (if :guide)
+    # @option options [FixNum] :default_cache_ttl (optional, default = 30.minutes) The default TTL value for the cache, note that some items are cached for twice this time and others are cached for half this time (in seconds).
+    # @return nil
     def self.configure(options)
       raise ArgumentError, ':api_id does not exist in options hash' if options[:api_id].nil?
       raise ArgumentError, ':api_token does not exist in options hash' if options[:api_token].nil?
@@ -38,30 +51,31 @@ module Osm
       raise ArgumentError, ':api_site does not exist in options hash or is invalid, this should be set to either :scout or :guide' unless [:scout, :guide].include?(options[:api_site])
       raise ArgumentError, ':default_cache_ttl must be greater than 0' unless (options[:default_cache_ttl].nil? || options[:default_cache_ttl].to_i > 0)
 
-      @@api_id = options[:api_id]
-      @@api_token = options[:api_token]
-      @@api_name = options[:api_name]
+      @@api_id = options[:api_id].to_s
+      @@api_token = options[:api_token].to_s
+      @@api_name = options[:api_name].to_s
       @@api_site = options[:api_site]
       @@default_cache_ttl = options[:default_cache_ttl].to_i unless options[:default_cache_ttl].nil?
+      nil
     end
 
     # Get the API ID used in this class
-    # @returns the API ID
+    # @return [String] the API ID
     def self.api_id
       return @@api_id
     end
 
     # Get the API name displayed in the External Access tab of OSM
-    # @returns the API ID
+    # @return [String] the API name
     def self.api_name
       return @@api_name
     end
 
     # Get the userid and secret to be able to act as a certain user on the OSM system
     # Also set's the 'current user'
-    # @param email the login email address of the user on OSM
-    # @param password the login password of the user on OSM
-    # @returns hash containing the following keys:
+    # @param [String] email the login email address of the user on OSM
+    # @param [String] password the login password of the user on OSM
+    # @return [Hash] a hash containing the following keys:
     #   * 'userid' - the userid to use in future requests
     #   * 'secret' - the secret to use in future requests
     def authorize(email, password)
@@ -75,14 +89,10 @@ module Osm
     end
 
     # Get the user's roles
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an array of Osm::Role objects
-    def get_roles(options={})
-      api_data = options[:api_data] || {}
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Array<Osm::Role>]
+    def get_roles(options={}, api_data={})
 
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-roles-#{api_data[:userid] || @userid}")
         return Rails.cache.read("OSMAPI-roles-#{api_data[:userid] || @userid}")
@@ -103,15 +113,10 @@ module Osm
     end
 
     # Get the user's notepads
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns a hash (keys are section IDs, values are a string)
-    def get_notepads(options={})
-      api_data = options[:api_data] || {}
-
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Hash] a hash (keys are section IDs, values are a string)
+    def get_notepads(options={}, api_data={})
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-notepads-#{api_data[:userid] || @userid}")
         return Rails.cache.read("OSMAPI-notepads-#{api_data[:userid] || @userid}")
       end
@@ -130,22 +135,17 @@ module Osm
     end
 
     # Get the notepad for a specified section
-    # @param section_id the section id of the required section
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns nil if an error occured or the user does not have access to that section
-    # @returns a string otherwise
-    def get_notepad(section_id, options={})
-      api_data = options[:api_data] || {}
-
+    # @param [FixNum] section_id the section id of the required section
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return nil if an error occured or the user does not have access to that section
+    # @return [String] the content of the notepad otherwise
+    def get_notepad(section_id, options={}, api_data={})
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-notepad-#{section_id}") && self.user_can_access?(:section, section_id, api_data)
         return Rails.cache.read("OSMAPI-notepad-#{section_id}")
       end
 
-      notepads = get_notepads(options)
+      notepads = get_notepads(options, api_data)
       return nil unless notepads.is_a? Hash
 
       notepads.each_key do |key|
@@ -156,22 +156,18 @@ module Osm
     end
 
     # Get the section (and its configuration)
-    # @param section_id the section id of the required section
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns nil if an error occured or the user does not have access to that section
-    # @returns an Osm::SectionConfig object otherwise
-    def get_section(section_id, options={})
-      api_data = options[:api_data] || {}
+    # @param [FixNum] section_id the section id of the required section
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return nil if an error occured or the user does not have access to that section
+    # @return [Osm::Section]
+    def get_section(section_id, options={}, api_data={})
 
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-section-#{section_id}") && self.user_can_access?(:section, section_id, api_data)
         return Rails.cache.read("OSMAPI-section-#{section_id}")
       end
 
-      roles = get_roles(options)
+      roles = get_roles(options, api_data)
       return nil unless roles.is_a? Array
 
       roles.each do |role|
@@ -182,16 +178,11 @@ module Osm
     end
 
     # Get the groupings (e.g. patrols, sixes, lodges) for a given section
-    # @param section_id the section to get the programme for
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an array of Osm::Patrol objects
-    def get_groupings(section_id, options={})
-      api_data = options[:api_data] || {}
-
+    # @param [FixNum] section_id the section to get the programme for
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Array<Osm::Grouping>]
+    def get_groupings(section_id, options={}, api_data={})
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-groupings-#{section_id}") && self.user_can_access?(:section, section_id, api_data)
         return Rails.cache.read("OSMAPI-groupings-#{section_id}")
       end
@@ -211,15 +202,10 @@ module Osm
     end
 
     # Get the terms that the OSM user can access
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns  an array of Osm::Term objects
-    def get_terms(options={})
-      api_data = options[:api_data] || {}
-
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Array<Osm::Term>]
+    def get_terms(options={}, api_data={})
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-terms-#{api_data[:userid] || @userid}")
         return Rails.cache.read("OSMAPI-terms-#{api_data[:userid] || @userid}")
       end
@@ -241,17 +227,12 @@ module Osm
     end
 
     # Get a term
-    # @param term_id the id of the required term
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns nil if an error occured or the user does not have access to that term
-    # @returns an Osm::Term object otherwise
-    def get_term(term_id, options={})
-      api_data = options[:api_data] || {}
-
+    # @param [FixNum] term_id the id of the required term
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return nil if an error occured or the user does not have access to that term
+    # @return [Osm::Term]
+    def get_term(term_id, options={}, api_data={})
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-term-#{term_id}") && self.user_can_access?(:term, term_id, api_data)
         return Rails.cache.read("OSMAPI-term-#{term_id}")
       end
@@ -267,17 +248,12 @@ module Osm
     end
 
     # Get the programme for a given term
-    # @param sectionid the section to get the programme for
-    # @param termid the term to get the programme for
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an array of Osm::ProgrammeItem objects
-    def get_programme(section_id, term_id, options={})
-      api_data = options[:api_data] || {}
-
+    # @param [FixNum] section_id the section to get the programme for
+    # @param [FixNum] term_id the term to get the programme for
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Array<Osm::ProgrammeItem>]
+    def get_programme(section_id, term_id, options={}, api_data={})
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-programme-#{section_id}-#{term_id}") && self.user_can_access?(:programme, section_id, api_data)
         return Rails.cache.read("OSMAPI-programme-#{section_id}-#{term_id}")
       end
@@ -303,17 +279,12 @@ module Osm
     end
 
     # Get activity details
-    # @param activity_id the activity ID
-    # @param version (optional) the version of the activity to retreive
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an Osm::Activity object
-    def get_activity(activity_id, version=nil, options={})
-      api_data = options[:api_data] || {}
-
+    # @param [FixNum] activity_id the activity ID
+    # @param [FixNum] version the version of the activity to retreive, if nil the latest version will be assumed
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Osm::Activity]
+    def get_activity(activity_id, version=nil, options={}, api_data={})
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-activity-#{activity_id}-#{version}") && self.user_can_access?(:activity, activity_id, api_data)
         return Rails.cache.read("OSMAPI-activity-#{activity_id}-#{version}")
       end
@@ -334,16 +305,12 @@ module Osm
     end
 
     # Get member details
-    # @section_id the section to get details for
-    # @term_id (optional) the term to get details for, if it is omitted then the current term is used
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an array of Osm::Member objects
-    def get_members(section_id, term_id=nil, options={})
-      api_data = options[:api_data] || {}
+    # @param [FixNum] section_id the section to get details for
+    # @param [FixNum] term_id the term to get details for, if nil the current term is assumed
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Array<Osm::Member>]
+    def get_members(section_id, term_id=nil, options={}, api_data={})
       term_id = Osm::find_current_term_id(self, section_id, api_data) if term_id.nil?
 
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-members-#{section_id}-#{term_id}") && self.user_can_access?(:member, section_id, api_data)
@@ -363,16 +330,11 @@ module Osm
     end
 
     # Get API access details for a given section
-    # @param section_id the section to get details for
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an array of Osm::ApiAccess objects
-    def get_api_access(section_id, options={})
-      api_data = options[:api_data] || {}
-
+    # @param [FixNum] section_id the section to get details for
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Array<Osm::ApiAccess>]
+    def get_api_access(section_id, options={}, api_data={})
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-api_access-#{api_data['userid'] || @userid}-#{section_id}")
         return Rails.cache.read("OSMAPI-api_access-#{api_data['userid'] || @userid}-#{section_id}")
       end
@@ -393,16 +355,11 @@ module Osm
     end
 
     # Get our API access details for a given section
-    # @param section_id the section to get details for
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an Osm::ApiAccess objects
-    def get_our_api_access(section_id, options={})
-      api_data = options[:api_data] || {}
-
+    # @param [FixNum] section_id the section to get details for
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Osm::ApiAccess]
+    def get_our_api_access(section_id, options={}, api_data={})
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-api_access-#{api_data['userid'] || @userid}-#{section_id}-#{Osm::Api.api_id}")
         return Rails.cache.read("OSMAPI-api_access-#{api_data['userid'] || @userid}-#{section_id}-#{Osm::Api.api_id}")
       end
@@ -417,16 +374,11 @@ module Osm
     end
 
     # Get events
-    # @section_id the section to get details for
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an array of Osm::Event objects
-    def get_events(section_id, options={})
-      api_data = options[:api_data] || {}
-
+    # @param [FixNum] section_id the section to get details for
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Array<Osm::Event>]
+    def get_events(section_id, options={}, api_data={})
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-events-#{section_id}") && self.user_can_access?(:programme, section_id, api_data)
         return Rails.cache.read("OSMAPI-events-#{section_id}")
       end
@@ -446,15 +398,11 @@ module Osm
     end
 
     # Get due badges
-    # @section_id the section to get details for
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an Osm::DueBadges object
-    def get_due_badges(section_id, term_id=nil, options={})
-      api_data = options[:api_data] || {}
+    # @param [FixNum] section_id the section to get details for
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Osm::DueBadges]
+    def get_due_badges(section_id, term_id=nil, options={}, api_data={})
       term_id = Osm::find_current_term_id(self, section_id, api_data) if term_id.nil?
 
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-due_badges-#{section_id}-#{term_id}") && self.user_can_access?(:badge, section_id, api_data)
@@ -472,15 +420,11 @@ module Osm
     end
 
     # Get register structure
-    # @section_id the section to get details for
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an array of hashes representing the rows of the register
-    def get_register_structure(section_id, term_id=nil, options={})
-      api_data = options[:api_data] || {}
+    # @param [FixNum] section_id the section to get details for
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Array<Hash>] representing the rows of the register
+    def get_register_structure(section_id, term_id=nil, options={}, api_data={})
       term_id = Osm::find_current_term_id(self, section_id, api_data) if term_id.nil?
 
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-register_structure-#{section_id}-#{term_id}") && self.user_can_access?(:register, section_id, api_data)
@@ -502,15 +446,11 @@ module Osm
     end
 
     # Get register
-    # @section_id the section to get details for
-    # @param options (optional) a hash which may contain the following keys:
-    #   * :no_cache - if true then the data will be retreived from OSM not the cache
-    #   * :api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #     * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #     * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns an array of hashes representing the attendance of each member
-    def get_register(section_id, term_id=nil, options={})
-      api_data = options[:api_data] || {}
+    # @param [FixNum] section_id the section to get details for
+    # @!macro options_get
+    # @!macro options_api_data
+    # @return [Array<Hash>] representing the attendance of each member
+    def get_register(section_id, term_id=nil, options={}, api_data={})
       term_id = Osm::find_current_term_id(self, section_id, api_data) if term_id.nil?
 
       if !options[:no_cache] && Rails.cache.exist?("OSMAPI-register-#{section_id}-#{term_id}") && self.user_can_access?(:register, section_id, api_data)
@@ -532,12 +472,10 @@ module Osm
     end
 
     # Create an evening in OSM
-    # @param section_id the id of the section to add the term to
-    # @param meeting_date the date of the meeting
-    # @param api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #   * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #   * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns a boolean representing if the operation suceeded or not
+    # @param [FixNum] section_id the id of the section to add the term to
+    # @param [Date] meeting_date the date of the meeting
+    # @!macro options_api_data
+    # @return [Boolean] if the operation suceeded or not
     def create_evening(section_id, meeting_date, api_data={})
       section_id = section_id.to_i
       evening_api_data = {
@@ -557,11 +495,9 @@ module Osm
     end
 
     # Update an evening in OSM
-    # @param programme_item is the Osm::ProgrammeItem object to update
-    # @param api_data (optional) a hash containing information to be sent to the server, it may contain the following keys:
-    #   * 'userid' (optional) the OSM userid to make the request as, this will override one provided using the set_user method
-    #   * 'secret' (optional) the OSM secret belonging to the above user
-    # @returns a boolean representing if the operation suceeded or not
+    # @param [Osm::ProgrammeItem] programme_item is the Osm::ProgrammeItem object to update
+    # @!macro options_api_data
+    # @return [Boolean] if the operation suceeded or not
     def update_evening(programme_item, api_data={})
       response = perform_query("programme.php?action=editEvening", api_data.merge({
         'eveningid' => programme_item.evening_id,
@@ -590,10 +526,11 @@ module Osm
 
     protected
     # Set access permission for the current user on a resource stored in the cache
-    # @param resource_type a symbol representing the resource type (:section, :grouping, :term, :activity, :programme, :member, :badge, :register)
-    # @param resource_id the id of the resource being checked
-    # @param api_data the data hash used in accessing the api
-    # @param permission (optional, default true) wether the user can access the resource
+    # @param [Symbol] resource_type a symbol representing the resource type (:section, :grouping, :term, :activity, :programme, :member, :badge, :register)
+    # @param [FixNum] resource_id the id of the resource being checked
+    # @param [Hash] api_data the data hash used in accessing the api
+    # @param [Boolean] permission wether the user can access the resource
+    # @return [Boolean] the permission which was set
     def user_can_access(resource_type, resource_id, api_data, permission=true)
       user = (api_data['userid'] || @userid).to_i
       resource_id = resource_id.to_i
@@ -606,12 +543,11 @@ module Osm
     end
 
     # Get access permission for the current user on a resource stored in the cache
-    # @param resource_type a symbol representing the resource type (:section, :grouping, :term, :activity, :programme, :member, :badge, :register)
-    # @param resource_id the id of the resource being checked
-    # @param api_data the data hash used in accessing the api
-    # @returns true if the user can access the resource
-    # @returns false if the user can not access the resource
-    # @returns nil if the combination of user and resource has not been seen
+    # @param [Symbol] resource_type a symbol representing the resource type (:section, :grouping, :term, :activity, :programme, :member, :badge, :register)
+    # @param [FixNum] resource_id the id of the resource being checked
+    # @param [Hash] api_data the data hash used in accessing the api
+    # @return nil if the combination of user and resource has not been set
+    # @return [Boolean] if the user can access the resource
     def user_can_access?(resource_type, resource_id, api_data)
       user = (api_data['userid'] || @userid).to_i
       resource_id = resource_id.to_i
@@ -625,17 +561,17 @@ module Osm
 
     private
     # Set the OSM user to make future requests as
-    # @param userid the OSM userid to use (get this using the authorize method)
-    # @param secret the OSM secret to use (get this using the authorize method)
+    # @param [String] userid the OSM userid to use (get this using the authorize method)
+    # @param [String] secret the OSM secret to use (get this using the authorize method)
     def set_user(userid, secret)
       @userid = userid
       @secret = secret
     end
 
     # Make the query to the OSM API
-    # @param url the script on the remote server to invoke
-    # @param api_data (optional) a hash containing the values to be sent to the server
-    # @returns the parsed JSON returned by OSM
+    # @param [String] url the script on the remote server to invoke
+    # @param [Hash] api_data a hash containing the values to be sent to the server
+    # @return [Hash, Array, String] the parsed JSON returned by OSM
     def perform_query(url, api_data={})
       api_data['apiid'] = @@api_id
       api_data['token'] = @@api_token
@@ -671,10 +607,17 @@ module Osm
       return decoded        
     end
 
+    # Check if text looks like it's JSON
+    # @param [String] text what to look at
+    # @return [Boolean]
     def looks_like_json?(text)
       (['[', '{'].include?(text[0]))
     end
 
+    # Get the error returned by OSM
+    # @param data what OSM gave us
+    # @return false if no error message was found
+    # @return [String] the error message
     def get_osm_error(data)
       return false unless data.is_a?(Hash)
       to_return = data['error'] || data['err'] || false

data/lib/osm/api_access.rb

@@ -3,6 +3,12 @@ module Osm
   class ApiAccess
 
     attr_reader :id, :name, :permissions
+    # @!attribute [r] id
+    #   @return [FixNum] the id for the API
+    # @!attribute [r] name
+    #   @return [String] the name of the API
+    # @!attribute [r] permissions
+    #   @return [Hash] the permissions assigned to this API by the user in OSM
 
     # Initialize a new API Access using the hash returned by the API call
     # @param data the hash of data for the object returned by the API
@@ -19,21 +25,21 @@ module Osm
     end
 
     # Determine if this API has read access for the provided permission
-    # @param key - the key for the permission being queried
-    # @returns - true if this API can read the passed permission, false otherwise
+    # @param [Symbol] key the permission being queried
+    # @return [Boolean] if this API can read the passed permission
     def can_read?(key)
       return [20, 10].include?(@permissions[key])
     end
 
     # Determine if this API has write access for the provided permission
-    # @param key - the key for the permission being queried
-    # @returns - true if this API can write the passed permission, false otherwise
+    # @param [Symbol] key the permission being queried
+    # @return [Boolean] if this API can write the passed permission
     def can_write?(key)
       return [20].include?(@permissions[key])
     end
 
     # Determine if this API is the API being used to make requests
-    # @returns - true if this is the API being used, false otherwise
+    # @return [Boolean] if this is the API being used
     def our_api?
       return @id == Osm::Api.api_id.to_i
     end

data/lib/osm/due_badges.rb

@@ -3,6 +3,12 @@ module Osm
   class DueBadges
 
     attr_reader :descriptions, :by_member, :totals
+    # @!attribute [r] descriptions
+    #   @return [Hash] descriptions for each of the badges
+    # @!attribute [r] by_member
+    #   @return [Hash] the due badges grouped by member
+    # @!attribute [r] totals
+    #   @return [Hash] the total number of each nadge which is due
 
     # Initialize a new Event using the hash returned by the API call
     # @param data the hash of data for the object returned by the API
@@ -44,6 +50,8 @@ module Osm
       end
     end
 
+    # Check if there are no badges due
+    # @return [Boolean]
     def empty?
       return @by_member.empty?
     end

data/lib/osm/event.rb

@@ -3,6 +3,22 @@ module Osm
   class Event
 
     attr_reader :id, :section_id, :name, :start, :end, :cost, :location, :notes
+    # @!attribute [r] id
+    #   @return [FixNum] the id for the event
+    # @!attribute [r] section_id
+    #   @return [FixNum] the id for the section
+    # @!attribute [r] name
+    #   @return [String] the name of the event
+    # @!attribute [r] start
+    #   @return [DateTime] when the event starts
+    # @!attribute [r] end
+    #   @return [DateTime] when the event ends
+    # @!attribute [r] cost
+    #   @return [?] the cost of the event
+    # @!attribute [r] location
+    #   @return [String] where the event is
+    # @!attribute [r] notes
+    #   @return [String] notes about the event
 
     # Initialize a new Event using the hash returned by the API call
     # @param data the hash of data for the object returned by the API

data/lib/osm/grouping.rb

@@ -3,6 +3,14 @@ module Osm
   class Grouping
 
     attr_reader :id, :name, :active, :points
+    # @!attribute [r] id
+    #   @return [FixNum] the id for grouping
+    # @!attribute [r] name
+    #   @return [String] the name of the grouping
+    # @!attribute [r] id
+    #   @return [Boolean] wether the grouping is active
+    # @!attribute [r] points
+    #   @return [FixNum] the points awarded to the grouping
 
     # Initialize a new Grouping using the hash returned by the API call
     # @param data the hash of data for the object returned by the API

data/lib/osm/member.rb

@@ -3,6 +3,67 @@ module Osm
   class Member
 
     attr_reader :id, :section_id, :type, :first_name, :last_name, :email1, :email2, :email3, :email4, :phone1, :phone2, :phone3, :phone4, :address, :address2, :date_of_birth, :started, :joined_in_years, :parents, :notes, :medical, :religion, :school, :ethnicity, :subs, :grouping_id, :grouping_leader, :joined, :age, :joined_years
+    # @!attribute [r] id
+    #   @return [FixNum] the id for the member
+    # @!attribute [r] section_id
+    #   @return [FixNum] the section the member belongs to
+    # @!attribute [r] type
+    #   @return [?] ?
+    # @!attribute [r] first_name
+    #   @return [String] the member's first name
+    # @!attribute [r] last_name
+    #   @return [String] the imember's last name
+    # @!attribute [r] email1
+    #   @return [String] the 1st email address for the member
+    # @!attribute [r] email2
+    #   @return [String] the 2nd email address for the member
+    # @!attribute [r] email3
+    #   @return [String] the 3rd email address for the member
+    # @!attribute [r] email4
+    #   @return [String] the 4th email address for the member
+    # @!attribute [r] phone1
+    #   @return [String] the 1st phone number for the member
+    # @!attribute [r] phone2
+    #   @return [String] the 2nd phone number for the member
+    # @!attribute [r] phone3
+    #   @return [String] the 3rd phone number for the member
+    # @!attribute [r] phone4
+    #   @return [String] the 4th phone number for the member
+    # @!attribute [r] address
+    #   @return [String] the member's address
+    # @!attribute [r] address2
+    #   @return [String] the member's 2nd address
+    # @!attribute [r] date_of_birth
+    #   @return [Date] the member's date of birth
+    # @!attribute [r] started
+    #   @return [Date] when the member started Scouting
+    # @!attribute [r] joined_in_years
+    #   @return [FixNum] thow many full years the member has been in Scouting
+    # @!attribute [r] parents
+    #   @return [String] the member's parent's names
+    # @!attribute [r] notes
+    #   @return [String] notes relating to the member
+    # @!attribute [r] medical
+    #   @return [String] the member's key medical details
+    # @!attribute [r] religion
+    #   @return [String] the member's religion
+    # @!attribute [r] school
+    #   @return [String] the school the member attends
+    # @!attribute [r] ethnicity
+    #   @return [String] the member's ethnicity
+    # @!attribute [r] subs
+    #   @return [String] details about the member's subs
+    # @!attribute [r] grouping_id
+    #   @return [FixNum] the grouping within the section that the member belongs to
+    # @!attribute [r] grouping_leader
+    #   @return [FixNum] wether the member is the grouping leader (0=no, 1=seconder/APL, 2=sixer/PL)
+    # @!attribute [r] joined
+    #   @return [Date] when the member joined the section
+    # @!attribute [r] age
+    #   @return [String] the member's current age (yy/mm)
+    # @!attribute [r] joined_years
+    #   @return [FixNum] ?
+
 
     # Initialize a new Member using the hash returned by the API call
     # @param data the hash of data for the object returned by the API
@@ -40,20 +101,20 @@ module Osm
     end
 
     # Get the years element of this scout's age
-    # @returns the number of years this scout has been alive
+    # @return [FixNum] the number of years this scout has been alive
     def age_years
       return @age[0..1].to_i
     end
 
     # Get the months element of this scout's age
-    # @returns the number of months since this scout's last birthday
+    # @return [FixNum] the number of months since this scout's last birthday
     def age_months
       return @age[-2..-1].to_i
     end
 
     # Get the full name
-    # @param seperator (optional) what to split the scout's first name and last name with, defaults to a space
-    # @returns this scout's full name seperate by the optional seperator
+    # @param [String] seperator what to split the scout's first name and last name with
+    # @return [String] this scout's full name seperated by the optional seperator
     def name(seperator=' ')
       return "#{@first_name}#{seperator.to_s}#{@last_name}"
     end

data/lib/osm/programme_activity.rb

@@ -3,6 +3,14 @@ module Osm
   class ProgrammeActivity
 
     attr_reader :evening_id, :activity_id, :title, :notes
+    # @!attribute [r] eveing_id
+    #   @return [FixNum] the evening the activity is being done
+    # @!attribute [r] activity_id
+    #   @return [FixNum] the activity being done
+    # @!attribute [r] title
+    #   @return [String] the activity's title
+    # @!attribute [r] notes
+    #   @return [String] tnotes relevant to doing this activity on this evening
 
     # Initialize a new EveningActivity using the hash returned by the API call
     # @param data the hash of data for the object returned by the API

data/lib/osm/programme_item.rb

@@ -4,6 +4,32 @@ module Osm
 
     attr_accessor :evening_id, :section_id, :title, :notes_for_parents, :games, :pre_notes, :post_notes, :leaders, :meeting_date, :activities, :google_calendar
     attr_reader :start_time, :end_time
+    # @!attribute [rw] evening_id
+    #   @return [FixNum] the id of the evening
+    # @!attribute [rw] sectionid
+    #   @return [FixNum] the section the evening belongs to
+    # @!attribute [rw] title
+    #   @return [String] the title of the evening
+    # @!attribute [rw] notes_for_parents
+    #   @return [String] notes to be shared with parents
+    # @!attribute [rw] games
+    #   @return [String] games to be played during the evening
+    # @!attribute [rw] pre_notes
+    #   @return [String] notes for the start of the evening
+    # @!attribute [rw] post_notes
+    #   @return [String] notes for the end of the evening
+    # @!attribute [rw] leaders
+    #   @return [String] the leaders present at the evening
+    # @!attribute [rw] meeting_date
+    #   @return [Date] the date of the evening
+    # @!attribute [rw] activities
+    #   @return [Array<ProgrammeActivity>] tlist of activities being done during the evening
+    # @!attribute [rw] google_calendar
+    #   @return [String] ?
+    # @!attribute [rw] start_time
+    #   @return [String] the start time (hh:mm)
+    # @!attribute [rw] end_time
+    #   @return [String] the end time (hh:mm)
 
     # Initialize a new ProgrammeItem using the hash returned by the API call
     # @param data the hash of data for the object returned by the API
@@ -41,6 +67,9 @@ module Osm
       end
     end
 
+
+    # Get the JSON for the activitied to pass to the OSM API
+    # @return [String]
     def activities_for_saving
       to_save = Array.new
       @activities.each do |activity|

data/lib/osm/role.rb

@@ -3,6 +3,18 @@ module Osm
   class Role
 
     attr_reader :section, :group_name, :group_id, :group_normalized, :default, :permissions
+    # @!attribute [r] section
+    #   @return [Osm::Section] the section this role related to
+    # @!attribute [r] group_name
+    #   @return [String] the name of the group the section is in
+    # @!attribute [r] group_id
+    #   @return [FixNum] the group the section is in
+    # @!attribute [r] group_normalized
+    #   @return [FixNum] ?
+    # @!attribute [r] default
+    #   @return [Boolean] was this the last section this user used in OSM
+    # @!attribute [r] permissions
+    #   @return [Hash] the permissions the user has in this role
 
     # Initialize a new UserRole using the hash returned by the API call
     # @param data the hash of data for the object returned by the API
@@ -21,27 +33,27 @@ module Osm
     end
 
     # Determine if this role has read access for the provided permission
-    # @param key - the key for the permission being queried
-    # @returns - true if this role can read the passed permission, false otherwise
+    # @param [Symbol] key the permission being queried
+    # @return [Boolean] if this role can read the passed permission
     def can_read?(key)
       return [10, 20, 100].include?(@permissions[key])
     end
 
     # Determine if this role has write access for the provided permission
-    # @param key - the key for the permission being queried
-    # @returns - true if this role can write the passed permission, false otherwise
+    # @param [Symbol] key the permission being queried
+    # @return [Boolean] if this role can write the passed permission
     def can_write?(key)
       return [20, 100].include?(@permissions[key])
     end
 
-    # Get section's full name in a consistent format
-    # @returns a string e.g. "Scouts (1st Somewhere)"
+    # Get section's long name in a consistent format
+    # @return [String] e.g. "Scouts (1st Somewhere)"
     def long_name
       @group_name.blank? ? @section.name : "#{@section.name} (#{@group_name})"
     end
 
     # Get section's full name in a consistent format
-    # @returns a string e.g. "1st Somewhere Beavers"
+    # @return [String] e.g. "1st Somewhere Beavers"
     def full_name
       @group_name.blank? ? @section.name : "#{@group_name} #{@section.name}"
     end

data/lib/osm/section.rb

@@ -3,6 +3,37 @@ module Osm
   class Section
 
     attr_reader :id, :name, :subscription_level, :subscription_expires, :type, :num_scouts, :has_badge_records, :has_programme, :wizard, :column_names, :fields, :intouch_fields, :mobile_fields, :extra_records, :role
+    # @!attribute [r] id
+    #   @return [FixNum] the id for the section
+    # @!attribute [r] name
+    #   @return [String] the section name
+    # @!attribute [r] subscription_level
+    #   @return [Symbol] what subscription the section has to OSM (:bronze, :silver or :gold)
+    # @!attribute [r] subscription_expires
+    #   @return [Date] when the section's subscription to OSM expires
+    # @!attribute [r] type
+    #   @return [Symbol] the section type (:beavers, :cubs, :scouts, :exporers, :adults, :waiting, :unknown)
+    # @!attribute [r] num_scouts
+    #   @return [FixNum] how many members the section has
+    # @!attribute [r] has_badge_records
+    #   @return [Boolean] ?
+    # @!attribute [r] has_programme
+    #   @return [Boolean] ?
+    # @!attribute [r] wizard
+    #   @return [Boolean] ?
+    # @!attribute [r] column_names
+    #   @return [Hash] custom names to use for the data columns
+    # @!attribute [r] fields
+    #   @return [Hash] which columns are shown in OSM
+    # @!attribute [r] intouch_fields
+    #   @return [Hash] which columns are shown in OSM's in touch reports
+    # @!attribute [r] mobile_fields
+    #   @return [Hash] which columns are shown in the OSM mobile app
+    # @!attribute [r] extraRecords
+    #   @return [Array<hash>] list of the extra records the section has
+    # @!attribute [r] role
+    #   @return [Osm::Role] the role linking the user to this section
+
 
     # Initialize a new SectionConfig using the hash returned by the API call
     # @param id the section ID used by the API to refer to this section
@@ -39,11 +70,31 @@ module Osm
       end
     end
 
+    # Check if this section is one of the youth sections
+    # @return [Boolean]
     def youth_section?
       [:beavers, :cubs, :scouts, :explorers].include?(@type)
     end
 
     # Custom section type checkers
+    # @!method beavers?
+    #   Check if this is a Beavers section
+    #   @return (Boolean)
+    # @!method cubs?
+    #   Check if this is a Cubs section
+    #   @return (Boolean)
+    # @!method scouts?
+    #   Check if this is a Scouts section
+    #   @return (Boolean)
+    # @!method explorers?
+    #   Check if this is an Explorers section
+    #   @return (Boolean)
+    # @!method adults?
+    #   Check if this is an Adults section
+    #   @return (Boolean)
+    # @!method waiting?
+    #   Check if this is a waiting list
+    #   @return (Boolean)
     [:beavers, :cubs, :scouts, :explorers, :adults, :waiting].each do |attribute|
       define_method "#{attribute}?" do
         @type == attribute

data/lib/osm/term.rb

@@ -3,6 +3,16 @@ module Osm
   class Term
 
     attr_reader :id, :section_id, :name, :start, :end
+    # @!attribute [r] id
+    #   @return [FixNum] the id for the term
+    # @!attribute [r] section_id
+    #   @return [FixNum] the section the term belongs to
+    # @!attribute [r] name
+    #   @return [FixNum] the name of the term
+    # @!attribute [r] start
+    #   @return [Date] when the term starts
+    # @!attribute [r] end
+    #   @return [Date] when the term ends
 
     # Initialize a new Term using the hash returned by the API call
     # @param data the hash of data for the object returned by the API
@@ -15,40 +25,40 @@ module Osm
     end
 
     # Determine if the term is completly before the passed date
-    # @param date
-    # @returns true if the term is completly before the passed date
+    # @param [Date] date
+    # @return [Boolean] if the term is completly before the passed date
     def before?(date)
       return @end < date.to_date
     end
 
     # Determine if the term is completly after the passed date
-    # @param date
-    # @returns true if the term is completly after the passed date
+    # @param [Date] date
+    # @return [Boolean] if the term is completly after the passed date
     def after?(date)
       return @start > date.to_date
     end
 
     # Determine if the term is in the future
-    # @returns true if the term starts after today
+    # @return [Boolean] if the term starts after today
     def future?
       return @start > Date.today
     end
 
     # Determine if the term is in the past
-    # @returns true if the term finished before today
+    # @return [Boolean] if the term finished before today
     def past?
       return @end < Date.today
     end
 
     # Determine if the term is current
-    # @returns true if the term started before today and finishes after today
+    # @return [Boolean] if the term started before today and finishes after today
     def current?
       return (@start <= Date.today) && (@end >= Date.today)
     end
 
     # Determine if the provided date is within the term
-    # @param date the date to test
-    # @returns true if the term started before the date and finishes after the date
+    # @param [Date] date the date to test
+    # @return [Boolean] if the term started before the date and finishes after the date
     def contains_date?(date)
       return (@start <= date) && (@end >= date)
     end

data/spec/osm/api_spec.rb

@@ -465,7 +465,7 @@ describe "API" do
       }
 
       HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"1":"Section 1"}'}) }
-      Osm::Api.new('1', '2').get_notepads(:api_data => {'userid'=>'user', 'secret'=>'secret'}).should == {1 => 'Section 1'}
+      Osm::Api.new('1', '2').get_notepads({}, {'userid'=>'user', 'secret'=>'secret'}).should == {1 => 'Section 1'}
     end
   end
 

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-31 00:00:00.000000000Z
+date: 2012-08-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &72147560 !ruby/object:Gem::Requirement
+  requirement: &80730730 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.5
   type: :runtime
   prerelease: false
-  version_requirements: *72147560
+  version_requirements: *80730730
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &72146620 !ruby/object:Gem::Requirement
+  requirement: &80713860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *72146620
+  version_requirements: *80713860
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &72145990 !ruby/object:Gem::Requirement
+  requirement: &80710730 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *72145990
+  version_requirements: *80710730
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &72145330 !ruby/object:Gem::Requirement
+  requirement: &80697000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72145330
+  version_requirements: *80697000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &72119020 !ruby/object:Gem::Requirement
+  requirement: &80694320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72119020
+  version_requirements: *80694320
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &72117720 !ruby/object:Gem::Requirement
+  requirement: &80680900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72117720
+  version_requirements: *80680900
 description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
   to retrieve and save data.
 email: