osm 0.0.8 → 0.0.9

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Version 0.0.9
+
+  * Allow passing of Osm::Term objects as well as term IDs
+  * Allow passing of Osm::Section objects as well as section IDs
+  * Allow configuration of text prepended to keys used in the cache (:cache\_prepend\_to\_key option to configure method)
+  * Require setting of cache class to use caching (:cache option to configure method)
+
 ## version 0.0.8
 
   * Fix unknown variable when updating evening

data/README.md

@@ -23,7 +23,7 @@ Add to your Gemfile and run the `bundle` command to install it.
 gem 'osm'
 ```
 
-Configure the gem during the initalization of the app (e.g. in config/initializers/osm.rb).
+Configure the gem during the initalization of the app (e.g. if using rails then config/initializers/osm.rb would look like):
 
 ```ruby
 ActionDispatch::Callbacks.to_prepare do
@@ -32,6 +32,7 @@ Osm::Api.configure(
   :api_token  => 'YOU WILL BE GIVEN THIS BY ED AT OSM',
   :api_name   => 'YOU WILL GIVE THIS TO ED AT OSM',
   :api_site   => :scout,
+  :cache      => Rails.cache
 )
 end
 ```
@@ -58,3 +59,34 @@ Documentation can be found on [rubydoc.info](http://rubydoc.info/github/robertga
 
 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.
+
+
+## Parts of the OSM API Supported:
+
+### Read
+  * Activity
+  * API Access
+  * API Access for our app
+  * Due Badges
+  * Events
+  * Groupings (e.g. Sixes, Patrols)
+  * Members
+  * Notepad
+  * Notepads
+  * Programme
+  * Register
+  * Register Structure
+  * Roles
+  * Section
+  * Sections
+  * Term
+  * Terms
+
+### Update
+  * Evening
+
+### Create
+  * Evening
+
+### Actions
+  * Authorise an app to use the API on a user's behalf

data/lib/osm/activity.rb

@@ -4,13 +4,13 @@ module Osm
 
     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
+    #   @return [Fixnum] the id for the activity
     # @!attribute [r] version
-    #   @return [FixNum] the version of the activity
+    #   @return [Fixnum] the version of the activity
     # @!attribute [r] group_id
-    #   @return [FixNum] the group_id
+    #   @return [Fixnum] the group_id
     # @!attribute [r] user_id
-    #   @return [FixNum] the user_id of the creator of the activity
+    #   @return [Fixnum] the user_id of the creator of the activity
     # @!attribute [r] title
     #   @return [String] the activity's title
     # @!attribute [r] description
@@ -20,19 +20,19 @@ module Osm
     # @!attribute [r] instructions
     #   @return [String] instructions for doing the activity
     # @!attribute [r] running_time
-    #   @return [FixNum] duration of the activity in minutes
+    #   @return [Fixnum] duration of the activity in minutes
     # @!attribute [r] location
     #   @return [Symbol] :indoors, :outdoors or :both
     # @!attribute [r] shared
-    #   @return [FixNum] 2 - Public, 0 - Private
+    #   @return [Fixnum] 2 - Public, 0 - Private
     # @!attribute [r] rating
-    #   @return [FixNum] ?
+    #   @return [Fixnum] ?
     # @!attribute [r] editable
     #   @return [Boolean] Wether the current API user can edit this activity
     # @!attribute [r] deletable
     #   @return [Boolean] Wether the current API user can delete this activity
     # @!attribute [r] used
-    #   @return [FixNum] How many times this activity has been used (total accross all of OSM)
+    #   @return [Fixnum] How many times this activity has been used (total accross all of OSM)
     # @!attribute [r] versions
     #   @return [Array<Hash>] ? (:value - version, :firstname - created by, :label - label, :user_id - OSM user ID of creator)
     # @!attribute [r] sections

data/lib/osm/api.rb

@@ -18,6 +18,8 @@ module Osm
                                       # Most items however will be cached for this time
 
     @@user_access = Hash.new
+    @@cache_prepend_to_key = 'OSMAPI'
+    @@cache = nil
 
     # Initialize a new API connection
     # If passing user details then both must be passed
@@ -42,7 +44,9 @@ module Osm
     # @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).
+    # @option options [Class] :cache (optional) An instance of a cache class, must provide the methods (exist?, delete, write, read), for details see Rails.cache. Whilst this is optional you should remember that caching is required to use the OSM API.
+    # @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)
+    # @option options [String] :cache_prepend_to_key (optional, default = 'OSMAPI') Text to prepend to the key used to store data in the cache
     # @return nil
     def self.configure(options)
       raise ArgumentError, ':api_id does not exist in options hash' if options[:api_id].nil?
@@ -50,12 +54,19 @@ module Osm
       raise ArgumentError, ':api_name does not exist in options hash' if options[:api_name].nil?
       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)
+      unless options[:cache].nil?
+        [:exist?, :delete, :write, :read].each do |method|
+          raise ArgumentError, ":cache must have a #{method} method" unless options[:cache].methods.include?(method)
+        end
+      end
 
       @@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?
+      @@cache_prepend_to_key = options[:cache_prepend_to_key].to_s unless options[:cache_prepend_to_key].nil?
+      @@cache = options[:cache]
       nil
     end
 
@@ -94,8 +105,8 @@ module Osm
     # @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}")
+      if !options[:no_cache] && cache_exist?("roles-#{api_data[:userid] || @userid}")
+        return cache_read("roles-#{api_data[:userid] || @userid}")
       end
 
       data = perform_query('api.php?action=getUserRoles', api_data)
@@ -104,10 +115,10 @@ module Osm
       data.each do |item|
         role = Osm::Role.new(item)
         result.push role
-        Rails.cache.write("OSMAPI-section-#{role.section.id}", role.section, :expires_in => @@default_cache_ttl*2)
+        cache_write("section-#{role.section.id}", role.section, :expires_in => @@default_cache_ttl*2)
         self.user_can_access :section, role.section.id, api_data
       end
-      Rails.cache.write("OSMAPI-roles-#{api_data[:userid] || @userid}", result, :expires_in => @@default_cache_ttl*2)
+      cache_write("roles-#{api_data[:userid] || @userid}", result, :expires_in => @@default_cache_ttl*2)
 
       return result
     end
@@ -117,8 +128,8 @@ module Osm
     # @!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}")
+      if !options[:no_cache] && cache_exist?("notepads-#{api_data[:userid] || @userid}")
+        return cache_read("notepads-#{api_data[:userid] || @userid}")
       end
 
       notepads = perform_query('api.php?action=getNotepads', api_data)
@@ -127,22 +138,24 @@ module Osm
       data = {}
       notepads.each do |key, value|
         data[key.to_i] = value
-        Rails.cache.write("OSMAPI-notepad-#{key}", value, :expires_in => @@default_cache_ttl*2)
+        cache_write("notepad-#{key}", value, :expires_in => @@default_cache_ttl*2)
       end
 
-      Rails.cache.write("OSMAPI-notepads-#{api_data[:userid] || @userid}", data, :expires_in => @@default_cache_ttl*2)
+      cache_write("notepads-#{api_data[:userid] || @userid}", data, :expires_in => @@default_cache_ttl*2)
       return data
     end
 
     # Get the notepad for a specified section
-    # @param [FixNum] section_id the section id of the required section
+    # @param [Osm:Section, Fixnum] section the section (or its ID) to get the notepad for
     # @!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}")
+    def get_notepad(section, options={}, api_data={})
+      section_id = id_for_section(section)
+
+      if !options[:no_cache] && cache_exist?("notepad-#{section_id}") && self.user_can_access?(:section, section_id, api_data)
+        return cache_read("notepad-#{section_id}")
       end
 
       notepads = get_notepads(options, api_data)
@@ -156,15 +169,14 @@ module Osm
     end
 
     # Get the section (and its configuration)
-    # @param [FixNum] section_id the section id of the required section
+    # @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}")
+      if !options[:no_cache] && cache_exist?("section-#{section_id}") && self.user_can_access?(:section, section_id, api_data)
+        return cache_read("section-#{section_id}")
       end
 
       roles = get_roles(options, api_data)
@@ -178,13 +190,15 @@ module Osm
     end
 
     # Get the groupings (e.g. patrols, sixes, lodges) for a given section
-    # @param [FixNum] section_id the section to get the programme for
+    # @param [Osm::Section, Fixnum] section the section to get the groupings 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}")
+    def get_groupings(section, options={}, api_data={})
+      section_id = id_for_section(section)
+
+      if !options[:no_cache] && cache_exist?("groupings-#{section_id}") && self.user_can_access?(:section, section_id, api_data)
+        return cache_read("groupings-#{section_id}")
       end
 
       data = perform_query("users.php?action=getPatrols&sectionid=#{section_id}", api_data)
@@ -193,10 +207,10 @@ module Osm
       data['patrols'].each do |item|
         grouping = Osm::Grouping.new(item)
         result.push grouping
-        Rails.cache.write("OSMAPI-grouping-#{grouping.id}", grouping, :expires_in => @@default_cache_ttl*2)
+        cache_write("grouping-#{grouping.id}", grouping, :expires_in => @@default_cache_ttl*2)
         self.user_can_access :grouping, grouping.id, api_data
       end
-      Rails.cache.write("OSMAPI-groupings-#{section_id}", result, :expires_in => @@default_cache_ttl*2)
+      cache_write("groupings-#{section_id}", result, :expires_in => @@default_cache_ttl*2)
 
       return result
     end
@@ -206,8 +220,8 @@ module Osm
     # @!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}")
+      if !options[:no_cache] && cache_exist?("terms-#{api_data[:userid] || @userid}")
+        return cache_read("terms-#{api_data[:userid] || @userid}")
       end
 
       data = perform_query('api.php?action=getTerms', api_data)
@@ -217,24 +231,24 @@ module Osm
         data[key].each do |item|
           term = Osm::Term.new(item)
           result.push term
-          Rails.cache.write("OSMAPI-term-#{term.id}", term, :expires_in => @@default_cache_ttl*2)
+          cache_write("term-#{term.id}", term, :expires_in => @@default_cache_ttl*2)
           self.user_can_access :term, term.id, api_data
         end
       end
 
-      Rails.cache.write("OSMAPI-terms-#{api_data[:userid] || @userid}", result, :expires_in => @@default_cache_ttl*2)
+      cache_write("terms-#{api_data[:userid] || @userid}", result, :expires_in => @@default_cache_ttl*2)
       return result
     end
 
     # Get a term
-    # @param [FixNum] term_id the id of the required term
+    # @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}")
+      if !options[:no_cache] && cache_exist?("term-#{term_id}") && self.user_can_access?(:term, term_id, api_data)
+        return cache_read("term-#{term_id}")
       end
 
       terms = get_terms(options)
@@ -248,14 +262,17 @@ module Osm
     end
 
     # Get the programme for a given term
-    # @param [FixNum] section_id the section to get the programme for
-    # @param [FixNum] term_id the term to get the programme for
+    # @param [Osm:Section, Fixnum] section the section (or its ID) to get the programme for
+    # @param [Osm:term, Fixnum] term the term (or its ID) to get the programme for, passing nil causes the current term to be used
     # @!macro options_get
     # @!macro options_api_data
     # @return [Array<Osm::Evening>]
-    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}")
+    def get_programme(section, term, options={}, api_data={})
+      section_id = id_for_section(section)
+      term_id = id_for_term(term)
+
+      if !options[:no_cache] && cache_exist?("programme-#{section_id}-#{term_id}") && self.user_can_access?(:programme, section_id, api_data)
+        return cache_read("programme-#{section_id}-#{term_id}")
       end
 
       data = perform_query("programme.php?action=getProgramme&sectionid=#{section_id}&termid=#{term_id}", api_data)
@@ -274,19 +291,19 @@ module Osm
         end
       end
 
-      Rails.cache.write("OSMAPI-programme-#{section_id}-#{term_id}", result, :expires_in => @@default_cache_ttl)
+      cache_write("programme-#{section_id}-#{term_id}", result, :expires_in => @@default_cache_ttl)
       return result
     end
 
     # Get activity details
-    # @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
+    # @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}")
+      if !options[:no_cache] && cache_exist?("activity-#{activity_id}-#{version}") && self.user_can_access?(:activity, activity_id, api_data)
+        return cache_read("activity-#{activity_id}-#{version}")
       end
 
       data = nil
@@ -297,24 +314,25 @@ module Osm
       end
 
       activity = Osm::Activity.new(data)
-      Rails.cache.write("OSMAPI-activity-#{activity_id}-#{nil}", activity, :expires_in => @@default_cache_ttl*2) if version.nil?
-      Rails.cache.write("OSMAPI-activity-#{activity_id}-#{activity.version}", activity, :expires_in => @@default_cache_ttl/2)
+      cache_write("activity-#{activity_id}-#{nil}", activity, :expires_in => @@default_cache_ttl*2) if version.nil?
+      cache_write("activity-#{activity_id}-#{activity.version}", activity, :expires_in => @@default_cache_ttl/2)
       self.user_can_access :activity, activity.id, api_data
 
       return activity
     end
 
-    # Get member details
-    # @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
+    # Get members
+    # @param [Osm:Section, Fixnum] section the section (or its ID) to get the members for
+    # @param [Osm:Term, Fixnum] term the term (or its ID) to get the members for, passing nil causes the current term to be used
     # @!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?
+    def get_members(section, term=nil, options={}, api_data={})
+      section_id = id_for_section(section)
+      term_id = id_for_term(term)
 
-      if !options[:no_cache] && Rails.cache.exist?("OSMAPI-members-#{section_id}-#{term_id}") && self.user_can_access?(:member, section_id, api_data)
-        return Rails.cache.read("OSMAPI-members-#{section_id}-#{term_id}")
+      if !options[:no_cache] && cache_exist?("members-#{section_id}-#{term_id}") && self.user_can_access?(:member, section_id, api_data)
+        return cache_read("members-#{section_id}-#{term_id}")
       end
 
       data = perform_query("users.php?action=getUserDetails&sectionid=#{section_id}&termid=#{term_id}", api_data)
@@ -324,19 +342,21 @@ module Osm
         result.push Osm::Member.new(item)
       end
       self.user_can_access :member, section_id, api_data
-      Rails.cache.write("OSMAPI-members-#{section_id}-#{term_id}", result, :expires_in => @@default_cache_ttl)
+      cache_write("members-#{section_id}-#{term_id}", result, :expires_in => @@default_cache_ttl)
 
       return result
     end
 
     # Get API access details for a given section
-    # @param [FixNum] section_id the section to get details for
+    # @param [Osm:Section, Fixnum] section the section (or its ID) to get the 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}")
+    def get_api_access(section, options={}, api_data={})
+      section_id = id_for_section(section)
+
+      if !options[:no_cache] && cache_exist?("api_access-#{api_data['userid'] || @userid}-#{section_id}")
+        return cache_read("api_access-#{api_data['userid'] || @userid}-#{section_id}")
       end
 
       data = perform_query("users.php?action=getAPIAccess&sectionid=#{section_id}", api_data)
@@ -348,20 +368,22 @@ module Osm
         self.user_can_access(:programme, section_id, api_data) if this_item.can_read?(:programme)
         self.user_can_access(:member, section_id, api_data) if this_item.can_read?(:member)
         self.user_can_access(:badge, section_id, api_data) if this_item.can_read?(:badge)
-        Rails.cache.write("OSMAPI-api_access-#{api_data['userid'] || @userid}-#{section_id}-#{this_item.id}", this_item, :expires_in => @@default_cache_ttl*2)
+        cache_write("api_access-#{api_data['userid'] || @userid}-#{section_id}-#{this_item.id}", this_item, :expires_in => @@default_cache_ttl*2)
       end
 
       return result
     end
 
     # Get our API access details for a given section
-    # @param [FixNum] section_id the section to get details for
+    # @param [Osm:Section, Fixnum] section the section (or its ID) to get the 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}")
+    def get_our_api_access(section, options={}, api_data={})
+      section_id = id_for_section(section)
+
+      if !options[:no_cache] && cache_exist?("api_access-#{api_data['userid'] || @userid}-#{section_id}-#{Osm::Api.api_id}")
+        return cache_read("api_access-#{api_data['userid'] || @userid}-#{section_id}-#{Osm::Api.api_id}")
       end
 
       data = get_api_access(section_id, options)
@@ -374,13 +396,15 @@ module Osm
     end
 
     # Get events
-    # @param [FixNum] section_id the section to get details for
+    # @param [Osm:Section, Fixnum] section the section (or its ID) to get the events 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}")
+    def get_events(section, options={}, api_data={})
+      section_id = id_for_section(section)
+
+      if !options[:no_cache] && cache_exist?("events-#{section_id}") && self.user_can_access?(:programme, section_id, api_data)
+        return cache_read("events-#{section_id}")
       end
 
       data = perform_query("events.php?action=getEvents&sectionid=#{section_id}", api_data)
@@ -392,21 +416,22 @@ module Osm
         end
       end
       self.user_can_access :programme, section_id, api_data
-      Rails.cache.write("OSMAPI-events-#{section_id}", result, :expires_in => @@default_cache_ttl)
+      cache_write("events-#{section_id}", result, :expires_in => @@default_cache_ttl)
 
       return result
     end
 
     # Get due badges
-    # @param [FixNum] section_id the section to get details for
+    # @param [Osm:Section, Fixnum] section the section (or its ID) to get the due badges 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?
+    def get_due_badges(section, term=nil, options={}, api_data={})
+      section_id = id_for_section(section)
+      term_id = id_for_term(term)
 
-      if !options[:no_cache] && Rails.cache.exist?("OSMAPI-due_badges-#{section_id}-#{term_id}") && self.user_can_access?(:badge, section_id, api_data)
-        return Rails.cache.read("OSMAPI-due_badges-#{section_id}-#{term_id}")
+      if !options[:no_cache] && cache_exist?("due_badges-#{section_id}-#{term_id}") && self.user_can_access?(:badge, section_id, api_data)
+        return cache_read("due_badges-#{section_id}-#{term_id}")
       end
 
       section_type = get_section(section_id, api_data).type.to_s
@@ -414,21 +439,23 @@ module Osm
 
       data = Osm::DueBadges.new(data)
       self.user_can_access :badge, section_id, api_data
-      Rails.cache.write("OSMAPI-due_badges-#{section_id}-#{term_id}", data, :expires_in => @@default_cache_ttl*2)
+      cache_write("due_badges-#{section_id}-#{term_id}", data, :expires_in => @@default_cache_ttl*2)
 
       return data
     end
 
     # Get register structure
-    # @param [FixNum] section_id the section to get details for
+    # @param [Osm:Section, Fixnum] section the section (or its ID) to get the structure for
+    # @param [Osm:Term, Fixnum] section the term (or its ID) to get the structure for, passing nil causes the current term to be used
     # @!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?
+    def get_register_structure(section, term=nil, options={}, api_data={})
+      section_id = id_for_section(section)
+      term_id = id_for_term(term)
 
-      if !options[:no_cache] && Rails.cache.exist?("OSMAPI-register_structure-#{section_id}-#{term_id}") && self.user_can_access?(:register, section_id, api_data)
-        return Rails.cache.read("OSMAPI-register_structure-#{section_id}-#{term_id}")
+      if !options[:no_cache] && cache_exist?("register_structure-#{section_id}-#{term_id}") && self.user_can_access?(:register, section_id, api_data)
+        return cache_read("register_structure-#{section_id}-#{term_id}")
       end
 
       data = perform_query("users.php?action=registerStructure&sectionid=#{section_id}&termid=#{term_id}", api_data)
@@ -440,21 +467,23 @@ module Osm
         end
       end
       self.user_can_access :register, section_id, api_data
-      Rails.cache.write("OSMAPI-register_structure-#{section_id}-#{term_id}", data, :expires_in => @@default_cache_ttl/2)
+      cache_write("register_structure-#{section_id}-#{term_id}", data, :expires_in => @@default_cache_ttl/2)
 
       return data
     end
 
     # Get register
-    # @param [FixNum] section_id the section to get details for
+    # @param [Osm:Section, Fixnum] section the section (or its ID) to get the register for
+    # @param [Osm:Term, Fixnum] section the term (or its ID) to get the register for, passing nil causes the current term to be used
     # @!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?
+    def get_register(section, term=nil, options={}, api_data={})
+      section_id = id_for_section(section)
+      term_id = id_for_term(term)
 
-      if !options[:no_cache] && Rails.cache.exist?("OSMAPI-register-#{section_id}-#{term_id}") && self.user_can_access?(:register, section_id, api_data)
-        return Rails.cache.read("OSMAPI-register-#{section_id}-#{term_id}")
+      if !options[:no_cache] && cache_exist?("register-#{section_id}-#{term_id}") && self.user_can_access?(:register, section_id, api_data)
+        return cache_read("register-#{section_id}-#{term_id}")
       end
 
       data = perform_query("users.php?action=register&sectionid=#{section_id}&termid=#{term_id}", api_data)
@@ -467,17 +496,17 @@ module Osm
         item[:patrolid] = item[:patrolid].to_i
       end
       self.user_can_access :register, section_id, api_data
-      Rails.cache.write("OSMAPI-register-#{section_id}-#{term_id}", data, :expires_in => @@default_cache_ttl/2)
+      cache_write("register-#{section_id}-#{term_id}", data, :expires_in => @@default_cache_ttl/2)
       return data
     end
 
     # Create an evening in OSM
-    # @param [FixNum] section_id the id of the section to add the term to
+    # @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
+    def create_evening(section, meeting_date, api_data={})
+      section_id = id_for_section(section)
       evening_api_data = {
         'meetingdate' => meeting_date.strftime('%Y-%m-%d'),
         'sectionid' => section_id,
@@ -488,7 +517,7 @@ module Osm
 
       # The cached programmes for the section will be out of date - remove them
       get_terms(api_data).each do |term|
-        Rails.cache.delete("OSMAPI-programme-#{term.section_id}-#{term.id}") if term.section_id == section_id
+        cache_delete("programme-#{term.section_id}-#{term.id}") if term.section_id == section_id
       end
 
       return data.is_a?(Hash) && (data['result'] == 0)
@@ -503,7 +532,7 @@ module Osm
 
       # The cached programmes for the section will be out of date - remove them
       get_terms(api_data).each do |term|
-        Rails.cache.delete("OSMAPI-programme-#{term.section_id}-#{term.id}") if term.section_id == evening.section_id
+        cache_delete("programme-#{term.section_id}-#{term.id}") if term.section_id == evening.section_id
       end
 
       return response.is_a?(Hash) && (response['result'] == 0)
@@ -513,7 +542,7 @@ module Osm
     protected
     # Set access permission for the current user on a resource stored in the cache
     # @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 [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
@@ -530,7 +559,7 @@ module Osm
 
     # Get access permission for the current user on a resource stored in the cache
     # @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 [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
@@ -569,11 +598,6 @@ module Osm
         end
       end
 
-      if Rails.env.development?
-        puts "Making OSM API request to #{url}"
-        puts api_data.to_s
-      end
-
       begin
         result = HTTParty.post("#{@base_url}/#{url}", {:body => api_data})
       rescue SocketError, TimeoutError, OpenSSL::SSL::SSLError
@@ -581,11 +605,6 @@ module Osm
       end
       raise ConnectionError.new("HTTP Status code was #{result.response.code}") if !result.response.code.eql?('200')
 
-      if Rails.env.development?
-        puts "Result from OSM request to #{url}"
-        puts result.response.body
-      end
-
       raise Error.new(result.response.body) unless looks_like_json?(result.response.body)
       decoded = ActiveSupport::JSON.decode(result.response.body)
       osm_error = get_osm_error(decoded)
@@ -608,10 +627,43 @@ module Osm
       return false unless data.is_a?(Hash)
       to_return = data['error'] || data['err'] || false
       to_return = false if to_return.blank?
-      puts "OSM API ERROR: #{to_return}" if Rails.env.development? && to_return
       return to_return
     end
 
+    # Wrap cache calls
+    def cache_read(key)
+      return @@cache.nil? ? nil : @@cache.read("#{@@cache_prepend_to_key}-#{key}")
+    end
+    def cache_write(key, data, options={})
+      return @@cache.nil? ? false : @@cache.write("#{@@cache_prepend_to_key}-#{key}", data, options)
+    end
+    def cache_exist?(key)
+      return @@cache.nil? ? false : @@cache.exist?("#{@@cache_prepend_to_key}-#{key}")
+    end
+    def cache_delete(key)
+      return @@cache.nil? ? true : @@cache.delete("#{@@cache_prepend_to_key}-#{key}")
+    end
+
+    # Get the ID from an object or fixnum
+    # @param cl the Class being used (e.g. Osm::Section)
+    # @param value the value to get the ID from
+    # @param [String] error_name the name of the class to use in error messages
+    # @param [String, Symbol] id_method the method to call on cl to get the ID
+    # @return [Fixnum] the ID
+    def id_for(cl, value, error_name, id_method=:id)
+      raise(ArgumentError, "Invalid type for #{error_name}") unless value.is_a?(cl) || value.is_a?(Fixnum)
+      id = value.is_a?(cl) ? value.send(id_method) : value
+      raise(ArgumentError, "Invalid #{error_name} ID") unless id > 0
+      return id
+    end
+
+    def id_for_section(section)
+      id_for(Osm::Section, section, 'section')
+    end
+    def id_for_term(term)
+      return term.nil? ? Osm::find_current_term_id(self, section_id, api_data) : id_for(Osm::Term, term, 'term')
+    end
+
   end
 
 end

data/lib/osm/api_access.rb

@@ -4,7 +4,7 @@ module Osm
 
     attr_reader :id, :name, :permissions
     # @!attribute [r] id
-    #   @return [FixNum] the id for the API
+    #   @return [Fixnum] the id for the API
     # @!attribute [r] name
     #   @return [String] the name of the API
     # @!attribute [r] permissions

data/lib/osm/evening.rb

@@ -5,9 +5,9 @@ module Osm
     attr_accessor :evening_id, :section_id, :title, :notes_for_parents, :games, :pre_notes, :post_notes, :leaders, :meeting_date, :activities
     attr_reader :start_time, :end_time
     # @!attribute [rw] evening_id
-    #   @return [FixNum] the id of the evening
+    #   @return [Fixnum] the id of the evening
     # @!attribute [rw] sectionid
-    #   @return [FixNum] the section the evening belongs to
+    #   @return [Fixnum] the section the evening belongs to
     # @!attribute [rw] title
     #   @return [String] the title of the evening
     # @!attribute [rw] notes_for_parents
@@ -105,7 +105,7 @@ module Osm
   
       attr_reader :activity_id, :title, :notes
       # @!attribute [r] activity_id
-      #   @return [FixNum] the activity being done
+      #   @return [Fixnum] the activity being done
       # @!attribute [r] title
       #   @return [String] the activity's title
       # @!attribute [r] notes

data/lib/osm/event.rb

@@ -4,9 +4,9 @@ module Osm
 
     attr_reader :id, :section_id, :name, :start, :end, :cost, :location, :notes
     # @!attribute [r] id
-    #   @return [FixNum] the id for the event
+    #   @return [Fixnum] the id for the event
     # @!attribute [r] section_id
-    #   @return [FixNum] the id for the section
+    #   @return [Fixnum] the id for the section
     # @!attribute [r] name
     #   @return [String] the name of the event
     # @!attribute [r] start

data/lib/osm/grouping.rb

@@ -4,13 +4,13 @@ module Osm
 
     attr_reader :id, :name, :active, :points
     # @!attribute [r] id
-    #   @return [FixNum] the id for grouping
+    #   @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
+    #   @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

@@ -4,9 +4,9 @@ module Osm
 
     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
+    #   @return [Fixnum] the id for the member
     # @!attribute [r] section_id
-    #   @return [FixNum] the section the member belongs to
+    #   @return [Fixnum] the section the member belongs to
     # @!attribute [r] type
     #   @return [?] ?
     # @!attribute [r] first_name
@@ -38,7 +38,7 @@ module Osm
     # @!attribute [r] started
     #   @return [Date] when the member started Scouting
     # @!attribute [r] joined_in_years
-    #   @return [FixNum] ?
+    #   @return [Fixnum] ?
     # @!attribute [r] parents
     #   @return [String] the member's parent's names
     # @!attribute [r] notes
@@ -54,15 +54,15 @@ module Osm
     # @!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
+    #   @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)
+    #   @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] how many years the member has been in Scouting
+    #   @return [Fixnum] how many years the member has been in Scouting
 
 
     # Initialize a new Member using the hash returned by the API call
@@ -101,13 +101,13 @@ module Osm
     end
 
     # Get the years element of this scout's age
-    # @return [FixNum] 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
-    # @return [FixNum] 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

data/lib/osm/role.rb

@@ -8,7 +8,7 @@ module Osm
     # @!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
+    #   @return [Fixnum] the group the section is in
     # @!attribute [r] permissions
     #   @return [Hash] the permissions the user has in this role
 

data/lib/osm/section.rb

@@ -4,7 +4,7 @@ module Osm
 
     attr_reader :id, :name, :subscription_level, :subscription_expires, :type, :num_scouts, :column_names, :fields, :intouch_fields, :mobile_fields, :extra_records, :role
     # @!attribute [r] id
-    #   @return [FixNum] the id for the section
+    #   @return [Fixnum] the id for the section
     # @!attribute [r] name
     #   @return [String] the section name
     # @!attribute [r] subscription_level
@@ -14,7 +14,7 @@ module Osm
     # @!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
+    #   @return [Fixnum] how many members the section has
     # @!attribute [r] column_names
     #   @return [Hash] custom names to use for the data columns
     # @!attribute [r] fields
@@ -31,7 +31,9 @@ module Osm
 
     # 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
+    # @param name the name given to the sction in OSM
     # @param data the hash of data for the object returned by the API
+    # @param role the Osm::Role linked with this section
     def initialize(id, name, data, role)
       subscription_levels = [:bronze, :silver, :gold]
       subscription_level = data['subscription_level'].to_i - 1
@@ -51,8 +53,8 @@ module Osm
 
       # Symbolise the keys in each hash of the extra_records array
       @extra_records.each do |item|
-        # Expect item to be: {:name=>String, :extraid=>FixNum}
-        # Sometimes get item as: [String, {"name"=>String, "extraid"=>FixNum}]
+        # Expect item to be: {:name=>String, :extraid=>Fixnum}
+        # Sometimes get item as: [String, {"name"=>String, "extraid"=>Fixnum}]
         if item.is_a?(Array)
           item = Osm::symbolize_hash(item[1])
         else

data/lib/osm/term.rb

@@ -4,11 +4,11 @@ module Osm
 
     attr_reader :id, :section_id, :name, :start, :end
     # @!attribute [r] id
-    #   @return [FixNum] the id for the term
+    #   @return [Fixnum] the id for the term
     # @!attribute [r] section_id
-    #   @return [FixNum] the section the term belongs to
+    #   @return [Fixnum] the section the term belongs to
     # @!attribute [r] name
-    #   @return [FixNum] the name of the term
+    #   @return [Fixnum] the name of the term
     # @!attribute [r] start
     #   @return [Date] when the term starts
     # @!attribute [r] end

data/osm.gemspec

@@ -18,9 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'rails', '>= 3.2.5'  # Used to provide the cache (and the environment controls slightly different behavior in perform_query)
   s.add_runtime_dependency 'activesupport', '>= 3.2'  # Used to parse JSON from OSM
-  s.add_runtime_dependency 'httparty'   # Used to make web requests to the API
+  s.add_runtime_dependency 'httparty'                 # Used to make web requests to the API
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/spec/osm/api_spec.rb

@@ -31,6 +31,7 @@ describe "API" do
       :api_token => 'API TOKEN',
       :api_name => 'API NAME',
       :api_site => :scout,
+      :cache => OsmTest::Cache,
     }.freeze
     Osm::Api.configure(@api_config)
   end
@@ -111,6 +112,17 @@ describe "API" do
     it "Fetch the notepad for a section" do
       FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/api.php?action=getNotepads", :body => {"1" => "Section 1", "2" => "Section 2"}.to_json)
       Osm::Api.new('1', '2').get_notepad(1).should == 'Section 1'
+      Osm::Api.new('1', '2').get_notepad(Osm::Section.new(2, '', {}, nil)).should == 'Section 2'
+    end
+
+    it "Fetch the notepad for a section (invalid section/id)" do
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/api.php?action=getNotepads", :body => {"1" => "Section 1"}.to_json)
+
+      expect{ Osm::Api.new('1', '2').get_notepad(-10) }.to raise_error(ArgumentError, 'Invalid section ID')
+      expect{ Osm::Api.new('1', '2').get_notepad(0) }.to raise_error(ArgumentError, 'Invalid section ID')
+
+      expect{ Osm::Api.new('1', '2').get_notepad(Osm::Section.new(-10, '', {}, nil)) }.to raise_error(ArgumentError, 'Invalid section ID')
+      expect{ Osm::Api.new('1', '2').get_notepad('1') }.to raise_error(ArgumentError, 'Invalid type for section')
     end
 
 
@@ -531,6 +543,18 @@ describe "API" do
       HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"1":"New content."}'}) }
       Osm::Api.new('user', 'secret').get_notepad(1, {:no_cache => true}).should == 'New content.'
     end
+
+
+    it "Uses the provided cache_prepend_to_key text" do
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/api.php?action=getNotepads", :body => {"1" => "Section 1"}.to_json)
+
+      OsmTest::Cache.should_receive('exist?').with('OSMAPI-notepads-1')
+      Osm::Api.new('1', '2').get_notepads.should == {1 => 'Section 1'}
+
+      Osm::Api.configure(@api_config.merge(:cache_prepend_to_key => 'AB'))
+      OsmTest::Cache.should_receive('exist?').with('AB-notepads-1')
+      Osm::Api.new('1', '2').get_notepads.should == {1 => 'Section 1'}
+    end
   end
 
 

data/spec/spec_helper.rb

@@ -19,40 +19,28 @@ RSpec.configure do |config|
 
   config.before(:each) do
     FakeWeb.clean_registry
-    Rails.cache.clear
+    OsmTest::Cache.clear
   end
 end
 
 
-module Rails
-  def self.cache
-    @cache ||= Cache.new
-  end
-  def self.env
-    Env.new
-  end
-
-  class Env
-    def development?
-      false
-    end
-  end
-
+module OsmTest
   class Cache
-    def initialize
-      @cache = {}
+    @@cache = {}
+    def self.write(key, data, options={})
+      @@cache[key] = data
     end
-    def write(key, data, options={})
-      @cache[key] = data
+    def self.read(key)
+      @@cache[key]
     end
-    def read(key)
-      @cache[key]
+    def self.exist?(key)
+      @@cache.include?(key)
     end
-    def exist?(key)
-      @cache.include?(key)
+    def self.delete(key)
+      @@cache.delete(key)
     end
-    def clear
-      @cache = {}
+    def self.clear
+      @@cache = {}
     end
   end
 end

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-08 00:00:00.000000000Z
+date: 2012-08-19 00:00:00.000000000Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &76581020 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.2.5
-  type: :runtime
-  prerelease: false
-  version_requirements: *76581020
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &76567570 !ruby/object:Gem::Requirement
+  requirement: &85718650 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *76567570
+  version_requirements: *85718650
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &76566430 !ruby/object:Gem::Requirement
+  requirement: &85718390 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76566430
+  version_requirements: *85718390
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &76562170 !ruby/object:Gem::Requirement
+  requirement: &85718050 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76562170
+  version_requirements: *85718050
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &76542270 !ruby/object:Gem::Requirement
+  requirement: &85715520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76542270
+  version_requirements: *85715520
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &76541290 !ruby/object:Gem::Requirement
+  requirement: &85714410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76541290
+  version_requirements: *85714410
 description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
   to retrieve and save data.
 email: