osm 0.0.11 → 0.0.12

data/lib/osm/api_access.rb

@@ -10,18 +10,33 @@ module Osm
     # @!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
-    def initialize(data)
-      @id = data['apiid'].to_i
-      @name = data['name']
-      @permissions = data['permissions'].is_a?(Hash) ? data['permissions'] : {}
+    # Initialize a new ApiAccess
+    # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+    def initialize(attributes={})
+      raise ArgumentError, ':id must be a Fixnum > 0' unless (attributes[:id].is_a?(Fixnum) && attributes[:id] > 0)
+      raise ArgumentError, ':name must be a String' unless attributes[:name].is_a?(String)
+      raise ArgumentError, ':permissions must be a Hash' unless attributes[:permissions].is_a?(Hash)
+
+      attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+    end
+
+
+    # Initialize a new ApiAccess from api data
+    # @param [Hash] data the hash of data provided by the API
+    def self.from_api(data)
+      attributes = {}
+      attributes[:id] = data['apiid'].to_i
+      attributes[:name] = data['name']
+      attributes[:permissions] = data['permissions'].is_a?(Hash) ? data['permissions'] : {}
 
       # Rubyfy permissions hash
-      @permissions.keys.each do |key|
-        @permissions[key] = @permissions[key].to_i
-        @permissions[(key.to_sym rescue key) || key] = @permissions.delete(key) # Symbolize key
+      attributes[:permissions].keys.each do |key|
+        attributes[:permissions][key] = attributes[:permissions][key].to_i
+        attributes[:permissions][(key.to_sym rescue key) || key] = attributes[:permissions].delete(key) # Symbolize key
       end
+      attributes[:permissions].freeze
+
+      return new(attributes)
     end
 
     # Determine if this API has read access for the provided permission
@@ -44,6 +59,6 @@ module Osm
       return @id == Osm::Api.api_id.to_i
     end
 
-  end
+  end # Class
 
-end
+end # Module

data/lib/osm/due_badges.rb

@@ -10,44 +10,58 @@ module Osm
     # @!attribute [r] totals
     #   @return [Hash] the total number of each badge 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
-    def initialize(data)
+    # Initialize a new DueBadges
+    # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+    def initialize(attributes={})
+      [:descriptions, :by_member, :totals].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be a Hash" unless attributes[attribute].is_a?(Hash)
+      end
+
+      attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+    end
+
+
+    # Initialize a new DueBadges from api data
+    # @param [Hash] data the hash of data provided by the API
+    def self.from_api(data)
       data = {} unless data.is_a?(Hash)
+      attributes = {}
 
-      @pending = data['pending'].is_a?(Hash) ? Osm::symbolize_hash(data['pending']) : {}
-      @descriptions = data['description'].is_a?(Hash) ? Osm::symbolize_hash(data['description']) : {}
+      attributes[:pending] = data['pending'].is_a?(Hash) ? Osm::symbolize_hash(data['pending']) : {}
+      attributes[:descriptions] = data['description'].is_a?(Hash) ? Osm::symbolize_hash(data['description']) : {}
 
-      @pending.each_key do |key|
-        @pending[key].each_with_index do |item, index|
-          @pending[key][index] = item = Osm::symbolize_hash(item)
+      attributes[:pending].each_key do |key|
+        attributes[:pending][key].each_with_index do |item, index|
+          attributes[:pending][key][index] = item = Osm::symbolize_hash(item)
           item[:sid] = item[:sid].to_i
           item[:completed] = item[:completed].to_i
         end
       end
-      @descriptions.each_key do |key|
-        @descriptions[key] = Osm::symbolize_hash(@descriptions[key])
-        @descriptions[key][:section] = @descriptions[key][:section].to_sym
-        @descriptions[key][:type] = @descriptions[key][:type].to_sym
+      attributes[:descriptions].each_key do |key|
+        attributes[:descriptions][key] = Osm::symbolize_hash(attributes[:descriptions][key])
+        attributes[:descriptions][key][:section] = attributes[:descriptions][key][:section].to_sym
+        attributes[:descriptions][key][:type] = attributes[:descriptions][key][:type].to_sym
       end
 
 
-      @by_member = {}
-      @totals = {}
-      @pending.each_key do |key|
-        @pending[key].each do |item|
+      attributes[:by_member] = {}
+      attributes[:totals] = {}
+      attributes[:pending].each_key do |key|
+        attributes[:pending][key].each do |item|
           name = "#{item[:firstname]} #{item[:lastname]}"
-          by_member[name] = [] if by_member[name].nil?
+          attributes[:by_member][name] = [] if attributes[:by_member][name].nil?
 
           badge = {
             :badge => key,
             :extra_information => item[:extra]
           }
-          by_member[name].push badge
-          @totals[key] = {} if @totals[key].nil?
-          @totals[key][item[:extra]] = @totals[key][item[:extra]].to_i + 1
+          attributes[:by_member][name].push badge
+          attributes[:totals][key] = {} if attributes[:totals][key].nil?
+          attributes[:totals][key][item[:extra]] = attributes[:totals][key][item[:extra]].to_i + 1
         end
       end
+      
+      new(attributes)
     end
 
     # Check if there are no badges due
@@ -56,6 +70,6 @@ module Osm
       return @by_member.empty?
     end
 
-  end
+  end # Class
 
-end
+end # Module

data/lib/osm/evening.rb

@@ -6,7 +6,7 @@ module Osm
     attr_reader :start_time, :end_time
     # @!attribute [rw] evening_id
     #   @return [Fixnum] the id of the evening
-    # @!attribute [rw] sectionid
+    # @!attribute [rw] section_id
     #   @return [Fixnum] the section the evening belongs to
     # @!attribute [rw] title
     #   @return [String] the title of the evening
@@ -23,35 +23,59 @@ module Osm
     # @!attribute [rw] meeting_date
     #   @return [Date] the date of the evening
     # @!attribute [rw] activities
-    #   @return [Array<EveningActivity>] list of activities being done during the evening
+    #   @return [Array<Activity>] list of activities being done during the evening
     # @!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
+    # Initialize a new Evening
+    # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+    def initialize(attributes={})
+      [:evening_id, :section_id].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be nil or a Fixnum > 0" unless attributes[attribute].nil? || (attributes[attribute].is_a?(Fixnum) && attributes[attribute] > 0)
+      end
+      [:title, :notes_for_parents, :games, :pre_notes, :post_notes, :leaders].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be nil or a String" unless (attributes[attribute].nil? || attributes[attribute].is_a?(String))
+      end
+      raise ArgumentError, ':meeting_date must be a Date' unless attributes[:meeting_date].is_a?(Date)
+      raise ArgumentError, ':activities must be nil or an Array of Osm::Evening::Activity' unless (attributes[:activities].nil? || Osm::is_array_of?(attributes[:activities], Osm::Evening::Activity))
+
+      attributes.each { |k,v| send("#{k}=", v) }
+
+      @activities ||= []
+      @title ||= 'Unnamed meeting'
+      [:notes_for_parents, :games, :pre_notes, :post_notes, :leaders].each do |attribute|
+        instance_variable_set("@#{attribute}", '') if instance_variable_get("@#{attribute}").nil?
+      end
+    end
+
+
+    # Initialize a new Evening from api data
+    # @param [Hash] data the hash of data provided by the API
     # @param activities an array of hashes to generate the list of ProgrammeActivity objects
-    def initialize(data, activities)
-      @evening_id = Osm::to_i_or_nil(data['eveningid'])
-      @section_id = Osm::to_i_or_nil(data['sectionid'])
-      @title = data['title'] || 'Unnamed meeting'
-      @notes_for_parents = data['notesforparents'] || ''
-      @games = data['games'] || ''
-      @pre_notes = data['prenotes'] || ''
-      @post_notes = data['postnotes'] || ''
-      @leaders = data['leaders'] || ''
-      @start_time = data['starttime'].nil? ? nil : data['starttime'][0..4]
-      @end_time = data['endtime'].nil? ? nil : data['endtime'][0..4]
-      @meeting_date = Osm::parse_date(data['meetingdate'])
-
-      @activities = Array.new
+    def self.from_api(data, activities)
+      attributes = {}
+      attributes[:evening_id] = Osm::to_i_or_nil(data['eveningid'])
+      attributes[:section_id] = Osm::to_i_or_nil(data['sectionid'])
+      attributes[:title] = data['title'] || 'Unnamed meeting'
+      attributes[:notes_for_parents] = data['notesforparents'] || ''
+      attributes[:games] = data['games'] || ''
+      attributes[:pre_notes] = data['prenotes'] || ''
+      attributes[:post_notes] = data['postnotes'] || ''
+      attributes[:leaders] = data['leaders'] || ''
+      attributes[:start_time] = data['starttime'].nil? ? nil : data['starttime'][0..4]
+      attributes[:end_time] = data['endtime'].nil? ? nil : data['endtime'][0..4]
+      attributes[:meeting_date] = Osm::parse_date(data['meetingdate'])
+
+      attributes[:activities] = Array.new
       unless activities.nil?
         activities.each do |item|
-          @activities.push EveningActivity.new(item)
+          attributes[:activities].push Evening::Activity.from_api(item)
         end
       end
-      @activities.freeze
+
+      new(attributes)
     end
 
     # Custom setters for times
@@ -67,11 +91,11 @@ module Osm
 
     # Get the evening's data for use with the API
     # @return [Hash]
-    def data_for_saving
+    def to_api
       {
         'eveningid' => evening_id,
         'sectionid' => section_id,
-        'meetingdate' => meeting_date.try(:strftime, '%Y-%m-%d'),
+        'meetingdate' => meeting_date.strftime('%Y-%m-%d'),
         'starttime' => start_time,
         'endtime' => end_time,
         'title' => title,
@@ -80,15 +104,15 @@ module Osm
         'postnotes' => post_notes,
         'games' => games,
         'leaders' => leaders,
-        'activity' => activities_for_saving,
+        'activity' => activities_for_to_api,
       }
     end
 
 
     private
-    # Get the JSON for the activitied to pass to the OSM API
+    # Get the JSON for the activities to pass to the OSM API
     # @return [String]
-    def activities_for_saving
+    def activities_for_to_api
       to_save = Array.new
       @activities.each do |activity|
         this_activity = {
@@ -101,8 +125,8 @@ module Osm
     end
 
 
-    class EveningActivity
-  
+    class Activity
+
       attr_reader :activity_id, :title, :notes
       # @!attribute [r] activity_id
       #   @return [Fixnum] the activity being done
@@ -111,14 +135,27 @@ module Osm
       # @!attribute [r] notes
       #   @return [String] notes 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
-      def initialize(data)
-        @activity_id = Osm::to_i_or_nil(data['activityid'])
-        @title = data['title']
-        @notes = data['notes']
-      end
+      # Initialize a new Evening::Activity
+      # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+      def initialize(attributes={})
+        raise ArgumentError, ':activity_id must be a Fixnum > 0' unless (attributes[:activity_id].is_a?(Fixnum) && attributes[:activity_id] > 0)
+        raise ArgumentError, ':title must be nil or a String' unless (attributes[:title].nil? || attributes[:title].is_a?(String))
+        raise ArgumentError, ':notes must be nil or a String' unless (attributes[:notes].nil? || attributes[:notes].is_a?(String))
   
+        attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+      end
+
+
+      # Initialize a new Evening::Activity from api data
+      # @param [Hash] data the hash of data provided by the API
+      def self.from_api(data)
+        new({
+          :activity_id => Osm::to_i_or_nil(data['activityid']),
+          :title => data['title'],
+          :notes => data['notes'],
+        })
+      end
+
     end
 
 

data/lib/osm/event.rb

@@ -20,17 +20,36 @@ module Osm
     # @!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
-    def initialize(data)
-      @id = Osm::to_i_or_nil(data['eventid'])
-      @section_id = Osm::to_i_or_nil(data['sectionid'])
-      @name = data['name']
-      @start = Osm::make_datetime(data['startdate'], data['starttime'])
-      @end = Osm::make_datetime(data['enddate'], data['endtime'])
-      @cost = data['cost']
-      @location = data['location']
-      @notes = data['notes']
+    # Initialize a new Event
+    # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+    def initialize(attributes={})
+      [:id, :section_id].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be nil or a Fixnum > 0" unless attributes[attribute].nil? || (attributes[attribute].is_a?(Fixnum) && attributes[attribute] > 0)
+      end
+      raise ArgumentError, ':name must be a String' unless attributes[:name].is_a?(String)
+      raise ArgumentError, ':start must be nil or a DateTime' unless attributes[:start].nil? || attributes[:start].is_a?(DateTime)
+      raise ArgumentError, ':end must be nil or a DateTime' unless attributes[:end].nil? || attributes[:end].is_a?(DateTime)
+      [:cost, :location, :notes].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be nil or a String" unless attributes[attribute].nil? || attributes[attribute].is_a?(String)
+      end
+
+      attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+    end
+
+
+    # Initialize a new Event from api data
+    # @param [Hash] data the hash of data provided by the API
+    def self.from_api(data)
+      new({
+        :id => Osm::to_i_or_nil(data['eventid']),
+        :section_id => Osm::to_i_or_nil(data['sectionid']),
+        :name => data['name'],
+        :start => Osm::make_datetime(data['startdate'], data['starttime']),
+        :end => Osm::make_datetime(data['enddate'], data['endtime']),
+        :cost => data['cost'],
+        :location => data['location'],
+        :notes => data['notes'],
+      })
     end
 
   end

data/lib/osm/grouping.rb

@@ -7,18 +7,32 @@ module Osm
     #   @return [Fixnum] the id for grouping
     # @!attribute [r] name
     #   @return [String] the name of the grouping
-    # @!attribute [r] id
+    # @!attribute [r] active
     #   @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
-    def initialize(data)
-      @id = Osm::to_i_or_nil(data['patrolid'])
-      @name = data['name']
-      @active = (data['active'] == 1)
-      @points = Osm::to_i_or_nil(data['points'])
+    # Initialize a new Grouping
+    # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+    def initialize(attributes={})
+      raise ArgumentError, ':id must be a Fixnum > 0' unless (attributes[:id].is_a?(Fixnum) && attributes[:id] > 0)
+      raise ArgumentError, ':name must be a String' unless attributes[:name].is_a?(String)
+      raise ArgumentError, ':active must be nil or a Boolean' unless attributes[:active].nil? || [true, false].include?(attributes[:active])
+      raise ArgumentError, ':points must be nil or a Fixnum >= 0' unless attributes[:points].nil? || (attributes[:points].is_a?(Fixnum) && attributes[:points] >= 0)
+
+      attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+    end
+
+
+    # Initialize a new Grouping from api data
+    # @param [Hash] data the hash of data provided by the API
+    def self.from_api(data)
+      new({
+        :id => Osm::to_i_or_nil(data['patrolid']),
+        :name => data['name'],
+        :active => (data['active'] == 1),
+        :points => Osm::to_i_or_nil(data['points']),
+      })
     end
 
   end

data/lib/osm/member.rb

@@ -2,7 +2,7 @@ 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
+    attr_reader :id, :section_id, :type, :first_name, :last_name, :email1, :email2, :email3, :email4, :phone1, :phone2, :phone3, :phone4, :address, :address2, :date_of_birth, :started, :joining_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
@@ -37,7 +37,7 @@ module Osm
     #   @return [Date] the member's date of birth
     # @!attribute [r] started
     #   @return [Date] when the member started Scouting
-    # @!attribute [r] joined_in_years
+    # @!attribute [r] joining_in_years
     #   @return [Fixnum] ?
     # @!attribute [r] parents
     #   @return [String] the member's parent's names
@@ -61,43 +61,66 @@ module Osm
     #   @return [Date] when the member joined the section
     # @!attribute [r] age
     #   @return [String] the member's current age (yy/mm)
-    # @!attribute [r] joined_years
+    # @!attribute [r] joining_years
     #   @return [Fixnum] how many years the member has been in Scouting
 
 
-    # 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
-    def initialize(data)
-      @id = Osm::to_i_or_nil(data['scoutid'])
-      @section_id = Osm::to_i_or_nil(data['sectionidO'])
-      @type = data['type']
-      @first_name = data['firstname']
-      @last_name = data['lastname']
-      @email1 = data['email1']
-      @email2 = data['email2']
-      @email3 = data['email3']
-      @email4 = data['email4']
-      @phone1 = data['phone1']
-      @phone2 = data['phone2']
-      @phone3 = data['phone3']
-      @phone4 = data['phone4']
-      @address = data['address']
-      @address2 = data['address2']
-      @date_of_birth = Osm::parse_date(data['dob'])
-      @started = Osm::parse_date(data['started'])
-      @joined_in_years = data['joining_in_yrs'].to_i
-      @parents = data['parents']
-      @notes = data['notes']
-      @medical = data['medical']
-      @religion = data['religion']
-      @school = data['school']
-      @ethnicity = data['ethnicity']
-      @subs = data['subs']
-      @grouping_id = Osm::to_i_or_nil(data['patrolidO'])
-      @grouping_leader = data['patrolleaderO'] # 0 - No, 1 = seconder, 2 = sixer
-      @joined = Osm::parse_date(data['joined'])
-      @age = data['age'] # 'yy / mm'
-      @joined_years = data['yrs'].to_i
+    # Initialize a new Member
+    # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+    def initialize(attributes={})
+      [:id, :section_id, :grouping_id].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be nil or a Fixnum > 0" unless attributes[attribute].nil? || (attributes[attribute].is_a?(Fixnum) && attributes[attribute] > 0)
+      end
+      [:joined_years, :grouping_leader].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be nil or a Fixnum >= 0" unless attributes[attribute].nil? || (attributes[attribute].is_a?(Fixnum) && attributes[attribute] >= 0)
+      end
+      raise ArgumentError, ':joining_in_years must be nil or a Fixnum' unless attributes[:joining_in_years].nil? || attributes[:joining_in_years].is_a?(Fixnum)
+      [:type, :first_name, :last_name, :email1, :email2, :email3, :email4, :phone1, :phone2, :phone3, :phone4, :address, :address2, :parents, :notes, :medical, :religion, :school, :ethnicity, :subs, :age].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be nil or a String" unless attributes[attribute].nil? || attributes[attribute].is_a?(String)
+      end
+      [:date_of_birth, :started, :joined].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be nil or a Date" unless attributes[attribute].nil? || attributes[attribute].is_a?(Date)
+      end
+
+      attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+    end
+
+
+    # Initialize a new Member from api data
+    # @param [Hash] data the hash of data provided by the API
+    def self.from_api(data)
+      new({
+        :id => Osm::to_i_or_nil(data['scoutid']),
+        :section_id => Osm::to_i_or_nil(data['sectionidO']),
+        :type => data['type'],
+        :first_name => data['firstname'],
+        :last_name => data['lastname'],
+        :email1 => data['email1'],
+        :email2 => data['email2'],
+        :email3 => data['email3'],
+        :email4 => data['email4'],
+        :phone1 => data['phone1'],
+        :phone2 => data['phone2'],
+        :phone3 => data['phone3'],
+        :phone4 => data['phone4'],
+        :address => data['address'],
+        :address2 => data['address2'],
+        :date_of_birth => Osm::parse_date(data['dob']),
+        :started => Osm::parse_date(data['started']),
+        :joining_in_years => data['joining_in_yrs'].to_i,
+        :parents => data['parents'],
+        :notes => data['notes'],
+        :medical => data['medical'],
+        :religion => data['religion'],
+        :school => data['school'],
+        :ethnicity => data['ethnicity'],
+        :subs => data['subs'],
+        :grouping_id => Osm::to_i_or_nil(data['patrolidO']),
+        :grouping_leader => data['patrolleaderO'],
+        :joined => Osm::parse_date(data['joined']),
+        :age => data['age'],
+        :joined_years => data['yrs'].to_i,
+      })
     end
 
     # Get the years element of this scout's age