osm 0.0.11 → 0.0.12

data/lib/osm/register_data.rb

@@ -0,0 +1,58 @@
+module Osm
+
+  class RegisterData
+
+    attr_reader :member_id, :first_name, :last_name, :section_id, :grouping_id, :total, :attendance
+    # @!attribute [r] member_id
+    #   @return [Fixnum] The OSM ID for the member
+    # @!attribute [r] grouping_id
+    #   @return [Fixnum] The OSM ID for the member's grouping
+    # @!attribute [r] section_id
+    #   @return [Fixnum] The OSM ID for the member's section
+    # @!attribute [r] first_name
+    #   @return [String] The member's first name
+    # @!attribute [r] last_name
+    #   @return [String] The member's last name
+    # @!attribute [r] total
+    #   @return [FixNum] Tooltip for the field
+    # @!attribute [r] attendance
+    #   @return [Hash] The data for each field - keys are the date, values one of 'Yes' (present), 'No' (known absence) or nil (absent)
+
+    # Initialize a new RegisterData
+    # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+    def initialize(attributes={})
+      [:member_id, :grouping_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, ':total must be a Fixnum >= 0' unless (attributes[:total].is_a?(Fixnum) && attributes[:total] >= 0)
+      [:first_name, :last_name].each do |attribute|
+        raise ArgumentError, "#{attribute} must be nil or a String" unless attributes[attribute].nil? || attributes[attribute].is_a?(String)
+      end
+      raise ArgumentError, ':attendance must be a Hash' unless attributes[:attendance].is_a?(Hash)
+
+      attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+    end
+
+
+    # Initialize a new RegisterData from api data
+    # @param [Hash] data the hash of data provided by the API
+    def self.from_api(data)
+      attributes = {}
+      attributes[:member_id] = Osm::to_i_or_nil(data['scoutid'])
+      attributes[:grouping_id] = Osm::to_i_or_nil(data['patrolid'])
+      attributes[:section_id] = Osm::to_i_or_nil(data['sectionid'])
+      attributes[:first_name] = data['firstname']
+      attributes[:last_name] = data['lastname']
+      attributes[:total] = data['total'].to_i
+
+      attributes[:attendance] = {}
+      data.except('scoutid', 'patrolid', 'sectionid', 'firstname', 'lastname', 'total').keys.each do |key|
+        attributes[:attendance][Date.strptime(key, '%Y-%m-%d')] = data[key]
+      end
+
+      new(attributes)
+    end
+
+  end
+
+end

data/lib/osm/register_field.rb

@@ -0,0 +1,39 @@
+module Osm
+
+  class RegisterField
+
+    attr_reader :id, :name, :tooltip
+    # @!attribute [r] id
+    #   @return [String] OSM identifier for the field
+    # @!attribute [r] name
+    #   @return [String] Human readable name for the field
+    # @!attribute [r] tooltip
+    #   @return [String] Tooltip for the field
+
+    # Initialize a new RegisterField
+    # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+    def initialize(attributes={})
+      [:id, :name].each do |attribute|
+        raise ArgumentError, "#{attribute} must be a String" unless attributes[attribute].is_a?(String)
+      end
+      raise ArgumentError, ':tooltip must be a String' unless attributes[:tooltip].nil? || attributes[:tooltip].is_a?(String)
+
+      attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+
+      @tooltip ||= ''
+    end
+
+
+    # Initialize a new RegisterField from api data
+    # @param [Hash] data the hash of data provided by the API
+    def self.from_api(data)
+      new({
+        :id => data['field'],
+        :name => data['name'],
+        :tooltip => data['tooltip'],
+      })
+    end
+
+  end
+
+end

data/lib/osm/role.rb

@@ -12,18 +12,35 @@ module 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
-    def initialize(data)
-      @section = Osm::Section.new(data['sectionid'], data['sectionname'], ActiveSupport::JSON.decode(data['sectionConfig']), self)
-      @group_name = data['groupname']
-      @group_id = Osm::to_i_or_nil(data['groupid'])
-      @permissions = data['permissions'].is_a?(Hash) ? Osm::symbolize_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, ':group_id must be nil or a Fixnum > 0' unless attributes[:group_id].nil? || (attributes[:group_id].is_a?(Fixnum) && attributes[:group_id] > 0)
+      raise ArgumentError, ':group_name must be nil or a String' unless attributes[:group_name].nil? || attributes[:group_name].is_a?(String)
+      raise ArgumentError, ':permissions must be nil or a Hash' unless attributes[:permissions].nil? || attributes[:permissions].is_a?(Hash)
+
+      attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+
+      @name ||= ''
+      @permissions ||= {}
+    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[:section] = Osm::Section.from_api(data['sectionid'], data['sectionname'], ActiveSupport::JSON.decode(data['sectionConfig']), self)
+      attributes[:group_name] = data['groupname']
+      attributes[:group_id] = Osm::to_i_or_nil(data['groupid'])
 
       # Convert permission values to a number
-      @permissions.each_key do |key|
-        @permissions[key] = @permissions[key].to_i
+      permissions = data['permissions'].is_a?(Hash) ? Osm::symbolize_hash(data['permissions']) : {}
+      permissions.each_key do |key|
+        permissions[key] = permissions[key].to_i
       end
+
+      new(attributes.merge(:permissions => permissions))
     end
 
     # Determine if this role has read access for the provided permission

data/lib/osm/section.rb

@@ -2,7 +2,7 @@ module Osm
 
   class Section
 
-    attr_reader :id, :name, :subscription_level, :subscription_expires, :type, :num_scouts, :column_names, :fields, :intouch_fields, :mobile_fields, :extra_records, :role
+    attr_reader :id, :name, :subscription_level, :subscription_expires, :type, :num_scouts, :column_names, :fields, :intouch_fields, :mobile_fields, :flexi_records, :role
     # @!attribute [r] id
     #   @return [Fixnum] the id for the section
     # @!attribute [r] name
@@ -23,44 +23,71 @@ module Osm
     #   @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] flexi_records
+    #   @return [Array<FlexiRecord>] 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
-    # @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)
+    # Initialize a new Section
+    # @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 nil or a Fixnum > 0' unless attributes[:id].nil? || (attributes[:id].is_a?(Fixnum) && attributes[:id] > 0)
+      raise ArgumentError, ':section_name must be nil or a String' unless attributes[:section_name].nil? || attributes[:section_name].is_a?(String)
+      raise ArgumentError, ':num_scouts must be nil or a Fixnum >= 0' unless attributes[:num_scouts].nil? || (attributes[:num_scouts].is_a?(Fixnum) && attributes[:num_scouts] > 0)
+      [:column_names, :fields, :intouch_fields, :mobile_fields].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be nil or a Hash" unless attributes[attribute].nil? || attributes[attribute].is_a?(Hash)
+      end
+      [:type, :subscription_level].each do |attribute|
+        raise ArgumentError, ":#{attribute} must be nil or a Symbol" unless attributes[attribute].nil? || attributes[attribute].is_a?(Symbol)
+      end
+      raise ArgumentError, ':flexi_records must be nil or an Array' unless attributes[:flexi_records].nil? || attributes[:flexi_records].is_a?(Array)
+
+      attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+
+      @section_name ||= ''
+      @column_names ||= {}
+      @fields ||= {}
+      @intouch_fields ||= {}
+      @mobile_fields ||= {}
+      @flexi_records ||= []
+      @subscription_level ||= :unknown
+      @type ||= :unknown
+    end
+
+
+    # Initialize a new Sections from api data
+    # @param [Fixnum] id the section ID used by the API to refer to this section
+    # @param [String] name the name given to the sction in OSM
+    # @param [Hash] data the hash of data for the object returned by the API
+    # @param {Osm::Role] role the Osm::Role linked with this section
+    def self.from_api(id, name, data, role)
       subscription_levels = [:bronze, :silver, :gold]
       subscription_level = data['subscription_level'].to_i - 1
 
-      @id = Osm::to_i_or_nil(id)
-      @name = name
-      @subscription_level = (subscription_levels[subscription_level] unless subscription_level < 0) || :unknown
-      @subscription_expires = data['subscription_expires'] ? Date.parse(data['subscription_expires'], 'yyyy-mm-dd') : nil
-      @type = !data['sectionType'].nil? ? data['sectionType'].to_sym : :unknown
-      @num_scouts = data['numscouts']
-      @column_names = data['columnNames'].is_a?(Hash) ? Osm::symbolize_hash(data['columnNames']) : {}
-      @fields = data['fields'].is_a?(Hash) ? Osm::symbolize_hash(data['fields']) : {}
-      @intouch_fields = data['intouch'].is_a?(Hash) ? Osm::symbolize_hash(data['intouch']) : {}
-      @mobile_fields = data['mobFields'].is_a?(Hash) ? Osm::symbolize_hash(data['mobFields']) : {}
-      @extra_records = data['extraRecords'].is_a?(Array) ? data['extraRecords'] : []
-      @role = role
-
-      # 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}]
-        if item.is_a?(Array)
-          item = Osm::symbolize_hash(item[1])
-        else
-          item = Osm::symbolize_hash(item)
-        end
+      attributes = {
+        :id => Osm::to_i_or_nil(id),
+        :name => name,
+        :subscription_level => (subscription_levels[subscription_level] unless subscription_level < 0) || :unknown,
+        :subscription_expires => data['subscription_expires'] ? Date.parse(data['subscription_expires'], 'yyyy-mm-dd') : nil,
+        :type => !data['sectionType'].nil? ? data['sectionType'].to_sym : :unknown,
+        :num_scouts => data['numscouts'],
+        :column_names => data['columnNames'].is_a?(Hash) ? Osm::symbolize_hash(data['columnNames']) : {},
+        :fields => data['fields'].is_a?(Hash) ? Osm::symbolize_hash(data['fields']) : {},
+        :intouch_fields => data['intouch'].is_a?(Hash) ? Osm::symbolize_hash(data['intouch']) : {},
+        :mobile_fields => data['mobFields'].is_a?(Hash) ? Osm::symbolize_hash(data['mobFields']) : {},
+        :role => role,
+        :flexi_records => [],
+      }
+
+
+      # Populate arrays
+      (data['extraRecords'].is_a?(Array) ? data['extraRecords'] : []).each do |record_data|
+        attributes[:flexi_records].push FlexiRecord.from_api(record_data)
       end
+      attributes[:flexi_records].freeze
+
+      new(attributes)
     end
 
     # Check if this section is one of the youth sections
@@ -102,6 +129,41 @@ module Osm
       self.id == another_section.try(:id)
     end
 
-  end
 
-end
+
+    private
+    class FlexiRecord
+
+      attr_reader :id, :name
+      # @!attribute [r] id
+      #   @return [Fixnum] the aid of the flexi-record
+      # @!attribute [r] name
+      #   @return [String] the name given to the flexi-record
+  
+      # 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)
+  
+        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)
+        # Expect item to be: {:name=>String, :extraid=>Fixnum}
+        # Sometimes get item as: [String, {"name"=>String, "extraid"=>Fixnum}]
+        data = data[1] if data.is_a?(Array)
+
+        new({
+          :id => Osm::to_i_or_nil(data['extraid']),
+          :name => data['name'],
+        })
+      end
+    end # FlexiRecord
+
+  end # Section
+
+end # Module

data/lib/osm/term.rb

@@ -14,14 +14,29 @@ module Osm
     # @!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
-    def initialize(data)
-      @id = Osm::to_i_or_nil(data['termid'])
-      @section_id = Osm::to_i_or_nil(data['sectionid'])
-      @name = data['name']
-      @start = Osm::parse_date(data['startdate'])
-      @end = Osm::parse_date(data['enddate'])
+    # Initialize a new Term
+    # @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 nil or a Fixnum > 0' unless attributes[:id].nil? || (attributes[:id].is_a?(Fixnum) && attributes[:id] > 0)
+      raise ArgumentError, ':section_id must be nil or a Fixnum > 0' unless attributes[:section_id].nil? || (attributes[:section_id].is_a?(Fixnum) && attributes[:section_id] > 0)
+      raise ArgumentError, ':name must be nil or a String' unless attributes[:name].nil? || attributes[:name].is_a?(String)
+      raise ArgumentError, ':start must be nil or a Date' unless attributes[:start].nil? || attributes[:start].is_a?(Date)
+      raise ArgumentError, ':end must be nil or a Date' unless attributes[:end].nil? || attributes[:end].is_a?(Date)
+
+      attributes.each { |k,v| instance_variable_set("@#{k}", v) }
+    end
+
+
+    # Initialize a new Term 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['termid']),
+        :section_id => Osm::to_i_or_nil(data['sectionid']),
+        :name => data['name'],
+        :start => Osm::parse_date(data['startdate']),
+        :end => Osm::parse_date(data['enddate']),
+      )
     end
 
     # Determine if the term is completly before the passed date

data/spec/osm/activity_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 
 describe "Activity" do
 
-  it "Create" do
+  it "Create from API data" do
     data = {
         'details' => {
         'activityid' => '1',
@@ -34,10 +34,26 @@ describe "Activity" do
       ],
       'sections' => ['beavers', 'cubs'],
       'tags' => ['Tag 1', 'Tag2'],
-      'files' => [],
-      'badges' => []
+      'files' => [
+        {
+          'fileid' => '6',
+          'activityid' => '1',
+          'filename' => 'File Name',
+          'name' => 'Name',
+        }
+      ],
+      'badges' => [
+        {
+          'activityid' => '1',
+          'section' => 'section',
+          'badgetype' => 'type',
+          'badge' => 'badge',
+          'columnname' => 'col_name',
+          'label' => 'This is a label',
+        }
+      ]
     }
-    activity = Osm::Activity.new(data)
+    activity = Osm::Activity.from_api(data)
 
     activity.id.should == 1
     activity.version.should == 0
@@ -54,11 +70,22 @@ describe "Activity" do
     activity.editable.should == true
     activity.deletable.should == false
     activity.used.should == 3
-    activity.versions.should == [{:value => 0, :user_id => 1, :firstname => 'Alice', :label => 'Current version - Alice', :selected => true}]
+    activity.versions[0].version.should == 0
+    activity.versions[0].created_by.should == 1
+    activity.versions[0].created_by_name.should == 'Alice'
+    activity.versions[0].label.should == 'Current version - Alice'
     activity.sections.should == [:beavers, :cubs]
     activity.tags.should == ['Tag 1', 'Tag2']
-    activity.files.should == []
-    activity.badges.should == []
+    activity.files[0].id.should == 6
+    activity.files[0].activity_id.should == 1
+    activity.files[0].file_name.should == 'File Name'
+    activity.files[0].name.should == 'Name'
+    activity.badges[0].activity_id.should == 1
+    activity.badges[0].section_type.should == :section
+    activity.badges[0].type.should == :type
+    activity.badges[0].badge.should == 'badge'
+    activity.badges[0].requirement.should == 'col_name'
+    activity.badges[0].label.should == 'This is a label'
   end
 
 end

data/spec/osm/api_access_spec.rb

@@ -4,13 +4,13 @@ require 'spec_helper'
 
 describe "API Access" do
 
-  it "Create" do
+  it "Create from API data" do
     data = {
       'apiid' => '1',
       'name' => 'Name',
       'permissions' => {'permission' => '100'},
     }
-    api_access = Osm::ApiAccess.new(data)
+    api_access = Osm::ApiAccess.from_api(data)
 
     api_access.id.should == 1
     api_access.name.should == 'Name'
@@ -20,11 +20,11 @@ describe "API Access" do
 
   it "Allows interegation of the permissions hash" do
     api_access = Osm::ApiAccess.new({
-      'apiid' => '1',
-      'name' => 'Name',
-      'permissions' => {
-        'read_only' => 10,
-        'read_write' => 20,
+      :id => 1,
+      :name => 'Name',
+      :permissions => {
+        :read_only => 10,
+        :read_write => 20,
       },
     })
 
@@ -43,8 +43,8 @@ describe "API Access" do
     Osm::Api.stub(:api_id) { '1' }
 
     apis = {
-      :ours => Osm::ApiAccess.new({'apiid' => '1', 'name' => 'Name', 'permissions' => {}}),
-      :not_ours => Osm::ApiAccess.new({'apiid' => '2', 'name' => 'Name', 'permissions' => {}}),
+      :ours => Osm::ApiAccess.new({:id => 1, :name => 'Name', :permissions => {}}),
+      :not_ours => Osm::ApiAccess.new({:id => 2, :name => 'Name', :permissions => {}}),
     }
 
     apis[:ours].our_api?.should == true

data/spec/osm/api_spec.rb

@@ -25,7 +25,7 @@ end
 
 describe "API" do
 
-  before(:each) do
+  before :each do
     @api_config = {
       :api_id => '1',
       :api_token => 'API TOKEN',
@@ -112,7 +112,7 @@ 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'
+      Osm::Api.new('1', '2').get_notepad(Osm::Section.new(:id => 2)).should == 'Section 2'
     end
 
     it "Fetch the notepad for a section (invalid section/id)" do
@@ -121,7 +121,6 @@ describe "API" do
       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
 
@@ -370,7 +369,7 @@ describe "API" do
       }
       FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/users.php?action=register&sectionid=1&termid=2", :body => data.to_json)
 
-      register = Osm::Api.new('1', '2').get_register(1, 2)
+      register = Osm::Api.new('1', '2').get_register_data(1, 2)
       register.is_a?(Array).should be_true
     end
 
@@ -420,7 +419,7 @@ describe "API" do
         'token' => @api_config[:api_token],
         'userid' => 'user',
         'secret' => 'secret',
-        'eveningid' => nil, 'sectionid' => nil, 'meetingdate' => nil, 'starttime' => nil,
+        'eveningid' => nil, 'sectionid' => nil, 'meetingdate' => '2000-01-02', 'starttime' => nil,
         'endtime' => nil, 'title' => 'Unnamed meeting', 'notesforparents' =>'', 'prenotes' => '',
         'postnotes' => '', 'games' => '', 'leaders' => '', 'activity' => '[]',
       }
@@ -428,7 +427,7 @@ describe "API" do
       api.stub(:get_terms) { [] }
       HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"result":0}'}) }
 
-      evening = Osm::Evening.new({}, [])
+      evening = Osm::Evening.new({:meeting_date => Date.new(2000, 01, 02)})
       api.update_evening(evening).should be_true
     end
 
@@ -439,7 +438,7 @@ describe "API" do
         'token' => @api_config[:api_token],
         'userid' => 'user',
         'secret' => 'secret',
-        'eveningid' => nil, 'sectionid' => nil, 'meetingdate' => nil, 'starttime' => nil,
+        'eveningid' => nil, 'sectionid' => nil, 'meetingdate' => '2000-01-02', 'starttime' => nil,
         'endtime' => nil, 'title' => 'Unnamed meeting', 'notesforparents' =>'', 'prenotes' => '',
         'postnotes' => '', 'games' => '', 'leaders' => '', 'activity' => '[]',
       }
@@ -447,7 +446,7 @@ describe "API" do
       api.stub(:get_terms) { [] }
       HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"result":1}'}) }
 
-      evening = Osm::Evening.new({}, [])
+      evening = Osm::Evening.new({:meeting_date => Date.new(2000, 01, 02)})
       api.update_evening(evening).should be_false
     end
   end