osm 0.0.11 → 0.0.12

data/spec/osm/due_badges_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 
 describe "DueBadge" do
 
-  it "Create" do
+  it "Create from API data" do
     data = {
       'pending' => {
         'badge_name' => [
@@ -46,7 +46,7 @@ describe "DueBadge" do
         }
       }
     }
-    db = Osm::DueBadges.new(data)
+    db = Osm::DueBadges.from_api(data)
 
     db.empty?.should == false
     db.descriptions.should == {:badge_name=>{:name=>"Badge Name", :section=>:cubs, :type=>:activity, :badge=>"badge_name"}, :cubs_core_participation=>{:name=>"Participation", :section=>:cubs, :type=>:core, :badge=>"participation"}}

data/spec/osm/evening_spec.rb

@@ -4,7 +4,23 @@ require 'date'
 
 describe "Evening" do
 
-  it "Create" do
+  before :each do
+    @attributes = {
+      :evening_id => 1,
+      :section_id => 2,
+      :title => 'Evening Name',
+      :notes_for_parents => 'Notes for parents',
+      :games => 'Games',
+      :pre_notes => 'Before',
+      :post_notes => 'After',
+      :leaders => 'Leaders',
+      :start_time => '19:00',
+      :end_time => '21:00',
+      :meeting_date => Date.new(2000, 01, 02),
+    }
+  end
+
+  it "Create from API data" do
     data = {
       'eveningid' => 1,
       'sectionid' => 2,
@@ -24,7 +40,7 @@ describe "Evening" do
       'title' => 'Activity Name',
       'notes' => 'Notes',
     }]
-    e = Osm::Evening.new(data, activities)
+    e = Osm::Evening.from_api(data, activities)
 
     e.evening_id.should == 1
     e.section_id.should == 2
@@ -38,7 +54,6 @@ describe "Evening" do
     e.end_time.should == '21:00'
     e.meeting_date.should == Date.new(2000, 1, 2)
 
-    e.activities.frozen?.should be_true
     ea = e.activities[0]
     ea.activity_id.should == 2
     ea.title.should == 'Activity Name'
@@ -47,7 +62,7 @@ describe "Evening" do
 
 
   it "Raises exceptions when trying to set invalid times" do
-    e = Osm::Evening.new({}, [])
+    e = Osm::Evening.new(@attributes)
     
     expect{ e.start_time = 'abcde' }.to raise_error(ArgumentError)
     expect{ e.start_time = '24:00' }.to raise_error(ArgumentError)
@@ -64,27 +79,17 @@ describe "Evening" do
 
 
   it "Creates the data for saving through the API" do
-    data = {
-      'eveningid' => 1,
-      'sectionid' => 2,
-      'title' => 'Evening Name',
-      'notesforparents' => 'Notes for parents',
-      'games' => 'Games',
-      'prenotes' => 'Before',
-      'postnotes' => 'After',
-      'leaders' => 'Leaders',
-      'starttime' => '19:00',
-      'endtime' => '21:00',
-      'meetingdate' => '2000-01-02',
-    }
-    activities = [{
-      'eveningid' => 3,
-      'activityid' => 4,
-      'title' => 'Activity Name',
-      'notes' => 'Notes',
-    }]
-    e = Osm::Evening.new(data, activities)
-    e.data_for_saving.should == {
+    data = @attributes.merge(
+      :activities => [ Osm::Evening::Activity.new(
+        :activity_id => 4,
+        :title => 'Activity Name',
+        :notes => 'Notes',
+      ) ]
+    )
+
+    e = Osm::Evening.new(data)
+
+    e.to_api.should == {
       'eveningid' => 1,
       'sectionid' => 2,
       'meetingdate' => '2000-01-02',

data/spec/osm/event_spec.rb

@@ -4,7 +4,7 @@ require 'date'
 
 describe "Event" do
 
-  it "Create" do
+  it "Create from API data" do
     data = {
       'eventid' => 1,
       'sectionid' => 2,
@@ -17,7 +17,7 @@ describe "Event" do
       'location' => 'Somewhere',
       'notes' => 'None'
     }
-    event = Osm::Event.new(data)
+    event = Osm::Event.from_api(data)
 
     event.id.should == 1
     event.section_id.should == 2

data/spec/osm/grouping_spec.rb

@@ -10,7 +10,7 @@ describe "Grouping" do
       'active' => 1,
       'points' => '2',
     }
-    patrol = Osm::Grouping.new(data)
+    patrol = Osm::Grouping.from_api(data)
 
     patrol.id.should == 1
     patrol.name.should == 'Patrol Name'

data/spec/osm/member_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 
 describe "Member" do
 
-  it "Create" do
+  it "Create from API data" do
     data = {
       'scoutid' => 1,
       'sectionidO' => 2,
@@ -39,7 +39,7 @@ describe "Member" do
       'patrolidO' => '3',
       'patrolleaderO' => 0,
     }
-    member = Osm::Member.new(data)
+    member = Osm::Member.from_api(data)
 
     member.id.should == 1
     member.section_id.should == 2
@@ -58,7 +58,7 @@ describe "Member" do
     member.address2.should == ''
     member.date_of_birth.should == Date.new(2000, 1, 2)
     member.started.should == Date.new(2006, 1, 2)
-    member.joined_in_years.should == 2
+    member.joining_in_years.should == 2
     member.parents.should == 'John and Jane Doe'
     member.notes.should == 'None'
     member.medical.should == 'Nothing'
@@ -76,8 +76,8 @@ describe "Member" do
 
   it "Provides member's full name" do
     data = {
-      'firstname' => 'First',
-      'lastname' => 'Last',
+      :first_name => 'First',
+      :last_name => 'Last',
     }
     member = Osm::Member.new(data)
 
@@ -88,7 +88,7 @@ describe "Member" do
 
   it "Provides each part of age" do
     data = {
-      'age' => '06/07',
+      :age => '06/07',
     }
     member = Osm::Member.new(data)
 

data/spec/osm/register_data_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'date'
+
+
+describe "Register Data" do
+
+  it "Create from API data" do
+    data = {
+      'scoutid' => '1',
+      'firstname' => 'A',
+      'lastname' => 'B',
+      'sectionid' => '2',
+      'patrolid' => '3',
+      'total' => 4,
+      '2012-01-10' => 'Yes',
+      '2012-01-24' => 'No',
+    }
+
+    rd = Osm::RegisterData.from_api(data)
+
+    rd.member_id.should == 1
+    rd.section_id.should == 2
+    rd.grouping_id.should == 3
+    rd.first_name.should == 'A'
+    rd.last_name.should == 'B'
+    rd.total.should == 4
+    rd.attendance.should == {
+      Date.new(2012, 01, 10) => 'Yes',
+      Date.new(2012, 01, 24) => 'No'
+    }
+  end
+
+end

data/spec/osm/register_field_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'spec_helper'
+
+
+describe "Register Field" do
+
+  it "Create" do
+    data = {
+      'name' => 'Human name',
+      'field' => 'machine_name',
+      'formatter' => 'doneFormatter',
+      'width' => '110px',
+      'tooltip' => 'Tooltip'
+    }
+
+    field = Osm::RegisterField.from_api(data)
+
+    field.id.should == 'machine_name'
+    field.name.should == 'Human name'
+    field.tooltip.should == 'Tooltip'
+  end
+
+end

data/spec/osm/role_spec.rb

@@ -3,9 +3,17 @@ require 'spec_helper'
 require 'date'
 
 
+class DummySection
+  attr_reader :name, :id
+  def initialize(options={})
+    options.each { |k,v| instance_variable_set("@#{k}", v) }
+  end
+end
+
+
 describe "Role" do
 
-  it "Create" do
+  it "Create from API data" do
     data = {
       'sectionid' => 1,
       'sectionname' => 'A Section',
@@ -16,7 +24,7 @@ describe "Role" do
       'isDefault' => '1',
       'permissions' => {}
     }
-    role = Osm::Role.new(data)
+    role = Osm::Role.from_api(data)
 
     role.section.id.should == 1
     role.section.name.should == 'A Section'
@@ -26,28 +34,28 @@ describe "Role" do
 
 
   it "Compares two matching roles" do
-    role1 = Osm::Role.new({'sectionConfig' => '{}'})
-    role2 = Osm::Role.new({'sectionConfig' => '{}'})
+    role1 = Osm::Role.new
+    role2 = Osm::Role.new
     role1.should == role2
   end
 
   it "Compares two non-matching roles" do
-    role1 = Osm::Role.new({'sectionid' => 1, 'sectionConfig' => '{}'})
-    role2 = Osm::Role.new({'sectionid' => 2, 'sectionConfig' => '{}'})
+    role1 = Osm::Role.new(:section => DummySection.new(:id => 1))
+    role2 = Osm::Role.new(:section => DummySection.new(:id => 2))
 
     role1.should_not == role2
   end
 
 
   it "Sorts by Group Name then section type (age order)" do
-    role1 = Osm::Role.new({'groupname' => 'Group A', 'sectionConfig' => '{}'})
-    role2 = Osm::Role.new({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"beavers"}'})
-    role3 = Osm::Role.new({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"cubs"}'})
-    role4 = Osm::Role.new({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"scouts"}'})
-    role5 = Osm::Role.new({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"explorers"}'})
-    role6 = Osm::Role.new({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"waiting"}'})
-    role7 = Osm::Role.new({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"adults"}'})
-    role8 = Osm::Role.new({'groupname' => 'Group C', 'sectionConfig' => '{}'})
+    role1 = Osm::Role.from_api({'groupname' => 'Group A', 'sectionConfig' => '{}'})
+    role2 = Osm::Role.from_api({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"beavers"}'})
+    role3 = Osm::Role.from_api({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"cubs"}'})
+    role4 = Osm::Role.from_api({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"scouts"}'})
+    role5 = Osm::Role.from_api({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"explorers"}'})
+    role6 = Osm::Role.from_api({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"waiting"}'})
+    role7 = Osm::Role.from_api({'groupname' => 'Group B', 'sectionConfig' => '{"sectionType":"adults"}'})
+    role8 = Osm::Role.from_api({'groupname' => 'Group C', 'sectionConfig' => '{}'})
 
     data = [role8, role5, role3, role7, role2, role4, role1, role6]
     data.sort.should == [role1, role2, role3, role4, role5, role6, role7, role8]
@@ -56,15 +64,13 @@ describe "Role" do
 
   it "Provides a long name for the role" do
     role = Osm::Role.new({
-      'sectionname' => 'A Section',
-      'sectionConfig' => '{}',
-      'groupname' => 'A Group',
+      :section => DummySection.new(:name => 'A Section'),
+      :group_name => 'A Group',
     })
     role.long_name.should == 'A Section (A Group)'
 
     role = Osm::Role.new({
-      'sectionname' => 'A Section',
-      'sectionConfig' => '{}',
+      :section => DummySection.new(:name => 'A Section'),
     })
     role.long_name.should == 'A Section'
   end
@@ -72,15 +78,13 @@ describe "Role" do
 
   it "Provides a full name for the role" do
     role = Osm::Role.new({
-      'sectionname' => 'A Section',
-      'sectionConfig' => '{}',
-      'groupname' => 'A Group',
+      :section => DummySection.new(:name => 'A Section'),
+      :group_name => 'A Group',
     })
     role.full_name.should == 'A Group A Section'
 
     role = Osm::Role.new({
-      'sectionname' => 'A Section',
-      'sectionConfig' => '{}',
+      :section => DummySection.new(:name => 'A Section'),
     })
     role.full_name.should == 'A Section'
   end
@@ -88,11 +92,10 @@ describe "Role" do
 
   it "Allows interegation of the permissions hash" do
     role = Osm::Role.new({
-      'sectionConfig' => '{}',
-      'permissions' => {
-        'read_only' => 10,
-        'read_write' => 20,
-        'administer' => 100
+      :permissions => {
+        :read_only => 10,
+        :read_write => 20,
+        :administer => 100
       }
     })
 
@@ -108,4 +111,4 @@ describe "Role" do
     role.can_write?(:non_existant).should == false
   end
 
-end
+end

data/spec/osm/section_spec.rb

@@ -11,13 +11,33 @@ describe "Section" do
       @id = id
     end
     def <=>(another)
-      @id <=> another.try(:id)
+      @id <=> another.id
     end
   end
 
 
+  before :each do
+    @attributes = {
+      :id => 1,
+      :name => 'Name',
+      :subscription_level => :silver,
+      :subscription_expires => (Date.today + 60).strftime('%Y-%m-%d'),
+      :sectionType => :cubs,
+      :numscouts => 10,
+      :hasUsedBadgeRecords => true,
+      :hasProgramme => true,
+      :wizard => false,
+      :columnNames => {},
+      :fields => {},
+      :intouch => {},
+      :mobFields => {},
+      :extraRecords => [],
+      :role => DummyRole.new(1)
+    }
+  end
 
-  it "Create" do
+
+  it "Create from API data" do
     data = {
       'subscription_level' => '3',
       'subscription_expires' => (Date.today + 60).strftime('%Y-%m-%d'),
@@ -27,10 +47,21 @@ describe "Section" do
       'fields' => {},
       'intouch' => {},
       'mobFields' => {},
-      'extraRecords' => [],
+      'extraRecords' => [
+        {
+          'name' => 'Name 1',
+          'extraid' => 1
+        }, [
+          '',
+          {
+            'name' => 'Name 2',
+            'extraid' => 2
+          }
+        ]
+      ]
     }
     role = DummyRole.new(1)
-    section = Osm::Section.new(1, 'Name', data, role)
+    section = Osm::Section.from_api(1, 'Name', data, role)
 
     section.id.should == 1
     section.name.should == 'Name' 
@@ -42,12 +73,15 @@ describe "Section" do
     section.fields.should == {}
     section.intouch_fields.should == {}
     section.mobile_fields.should == {}
-    section.extra_records.should == []
+    section.flexi_records[0].id.should == 1
+    section.flexi_records[0].name.should == 'Name 1'
+    section.flexi_records[1].id.should == 2
+    section.flexi_records[1].name.should == 'Name 2'
     section.role.should == role
   end
 
   it "Create has sensible defaults" do
-    section = Osm::Section.new(1, 'Name', {}, nil)
+    section = Osm::Section.new
 
     section.subscription_level.should == :unknown
     section.subscription_expires.should == nil
@@ -57,99 +91,41 @@ describe "Section" do
     section.fields.should == {}
     section.intouch_fields.should == {}
     section.mobile_fields.should == {}
-    section.extra_records.should == []
+    section.flexi_records.should == []
   end
 
 
   it "Compares two matching sections" do
-    data = {
-      'subscription_level' => '3',
-      'subscription_expires' => (Date.today + 60).strftime('%Y-%m-%d'),
-      'sectionType' => 'cubs',
-      'numscouts' => '10',
-      'hasUsedBadgeRecords' => '1',
-      'hasProgramme' => true,
-      'wizard' => 'False',
-      'columnNames' => {},
-      'fields' => {},
-      'intouch' => {},
-      'mobFields' => {},
-      'extraRecords' => [],
-    }
-    role = DummyRole.new(1)
-    section1 = Osm::Section.new(1, 'Name', data, role)
+    section1 = Osm::Section.new(@attributes)
     section2 = section1.clone
 
     section1.should == section2
   end
 
   it "Compares two non-matching sections" do
-    data = {
-      'subscription_level' => '3',
-      'subscription_expires' => (Date.today + 60).strftime('%Y-%m-%d'),
-      'sectionType' => 'cubs',
-      'numscouts' => '10',
-      'hasUsedBadgeRecords' => '1',
-      'hasProgramme' => true,
-      'wizard' => 'False',
-      'columnNames' => {},
-      'fields' => {},
-      'intouch' => {},
-      'mobFields' => {},
-      'extraRecords' => [],
-    }
-    role = DummyRole.new(1)
-    section1 = Osm::Section.new(1, 'Name', data, role)
-    section2 = Osm::Section.new(2, 'Name', data, role)
+    section1 = Osm::Section.new(@attributes)
+    section2 = Osm::Section.new(@attributes.merge(:id => 2))
 
     section1.should_not == section2
   end
 
 
   it "Sorts by role" do
-    data = {
-      'subscription_level' => '3',
-      'subscription_expires' => (Date.today + 60).strftime('%Y-%m-%d'),
-      'sectionType' => 'cubs',
-      'numscouts' => '10',
-      'hasUsedBadgeRecords' => '1',
-      'hasProgramme' => true,
-      'wizard' => 'False',
-      'columnNames' => {},
-      'fields' => {},
-      'intouch' => {},
-      'mobFields' => {},
-      'extraRecords' => [],
-    }
-    section1 = Osm::Section.new(1, 'Name', data, DummyRole.new(1))
-    section2 = Osm::Section.new(1, 'Name', data, DummyRole.new(2))
+    section1 = Osm::Section.new(@attributes.merge(:role => DummyRole.new(1)))
+    section2 = Osm::Section.new(@attributes.merge(:role => DummyRole.new(2)))
 
     [section2, section1].sort.should == [section1, section2]
   end
 
 
   it "Correctly works out the section type" do
-    data = {
-      'subscription_level' => '3',
-      'subscription_expires' => (Date.today + 60).strftime('%Y-%m-%d'),
-      'numscouts' => '10',
-      'hasUsedBadgeRecords' => '1',
-      'hasProgramme' => true,
-      'wizard' => 'False',
-      'columnNames' => {},
-      'fields' => {},
-      'intouch' => {},
-      'mobFields' => {},
-      'extraRecords' => [],
-    }
-
-    unknown =   Osm::Section.new(1, 'Name', data, DummyRole.new(1))
-    beavers =   Osm::Section.new(2, 'Name', data.merge('sectionType' => 'beavers'), DummyRole.new(2))
-    cubs =      Osm::Section.new(3, 'Name', data.merge('sectionType' => 'cubs'), DummyRole.new(3))
-    scouts =    Osm::Section.new(4, 'Name', data.merge('sectionType' => 'scouts'), DummyRole.new(4))
-    explorers = Osm::Section.new(5, 'Name', data.merge('sectionType' => 'explorers'), DummyRole.new(5))
-    adults =    Osm::Section.new(6, 'Name', data.merge('sectionType' => 'adults'), DummyRole.new(6))
-    waiting =   Osm::Section.new(7, 'Name', data.merge('sectionType' => 'waiting'), DummyRole.new(7))
+    unknown =   Osm::Section.new(@attributes.merge(:id => 1, :role => DummyRole.new(1)))
+    beavers =   Osm::Section.new(@attributes.merge(:id => 2, :type => :beavers, :role => DummyRole.new(2)))
+    cubs =      Osm::Section.new(@attributes.merge(:id => 3, :type => :cubs, :role => DummyRole.new(3)))
+    scouts =    Osm::Section.new(@attributes.merge(:id => 4, :type => :scouts, :role => DummyRole.new(4)))
+    explorers = Osm::Section.new(@attributes.merge(:id => 5, :type => :explorers, :role => DummyRole.new(5)))
+    adults =    Osm::Section.new(@attributes.merge(:id => 6, :type => :adults, :role => DummyRole.new(6)))
+    waiting =   Osm::Section.new(@attributes.merge(:id => 7, :type => :waiting, :role => DummyRole.new(7)))
 
     {:beavers => beavers, :cubs => cubs, :scouts => scouts, :explorers => explorers, :adults => adults, :waiting => waiting, :unknwoon => unknown}.each do |section_type, section|
       [:beavers, :cubs, :scouts, :explorers, :adults, :waiting].each do |type|
@@ -160,27 +136,13 @@ describe "Section" do
 
 
   it "Correctly works out if the section is a youth section" do
-    data = {
-      'subscription_level' => '3',
-      'subscription_expires' => (Date.today + 60).strftime('%Y-%m-%d'),
-      'numscouts' => '10',
-      'hasUsedBadgeRecords' => '1',
-      'hasProgramme' => true,
-      'wizard' => 'False',
-      'columnNames' => {},
-      'fields' => {},
-      'intouch' => {},
-      'mobFields' => {},
-      'extraRecords' => [],
-    }
-
-    unknown =   Osm::Section.new(1, 'Name', data, DummyRole.new(1))
-    beavers =   Osm::Section.new(2, 'Name', data.merge('sectionType' => 'beavers'), DummyRole.new(2))
-    cubs =      Osm::Section.new(3, 'Name', data.merge('sectionType' => 'cubs'), DummyRole.new(3))
-    scouts =    Osm::Section.new(4, 'Name', data.merge('sectionType' => 'scouts'), DummyRole.new(4))
-    explorers = Osm::Section.new(5, 'Name', data.merge('sectionType' => 'explorers'), DummyRole.new(5))
-    adults =    Osm::Section.new(6, 'Name', data.merge('sectionType' => 'adults'), DummyRole.new(6))
-    waiting =   Osm::Section.new(7, 'Name', data.merge('sectionType' => 'waiting'), DummyRole.new(7))
+    unknown =   Osm::Section.new(@attributes.merge(:id => 1, :role => DummyRole.new(1)))
+    beavers =   Osm::Section.new(@attributes.merge(:id => 2, :type => :beavers, :role => DummyRole.new(2)))
+    cubs =      Osm::Section.new(@attributes.merge(:id => 3, :type => :cubs, :role => DummyRole.new(3)))
+    scouts =    Osm::Section.new(@attributes.merge(:id => 4, :type => :scouts, :role => DummyRole.new(4)))
+    explorers = Osm::Section.new(@attributes.merge(:id => 5, :type => :explorers, :role => DummyRole.new(5)))
+    adults =    Osm::Section.new(@attributes.merge(:id => 6, :type => :adults, :role => DummyRole.new(6)))
+    waiting =   Osm::Section.new(@attributes.merge(:id => 7, :type => :waiting, :role => DummyRole.new(7)))
 
     [beavers, cubs, scouts, explorers].each do |section|
       section.youth_section?.should == true
@@ -190,4 +152,4 @@ describe "Section" do
     end
   end
 
-end
+end