osm 0.0.26 → 0.1.0

data/spec/osm/flexi_record_spec.rb

@@ -0,0 +1,128 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'date'
+
+
+describe "Flexi Record" do
+
+  it "Create FlexiRecord::Field" do
+    field = Osm::FlexiRecord::Field.new(
+      :id => "f_1",
+      :name => "Field Name",
+      :editable => true
+    )
+
+    field.id.should == 'f_1'
+    field.name.should == 'Field Name'
+    field.editable.should be_true
+    field.valid?.should be_true
+  end
+
+  it "Create FlexiRecord::Data" do
+    rd = Osm::FlexiRecord::Data.new(
+      :member_id => 1,
+      :grouping_id => 2,
+      :fields => {
+        'firstname' => 'First',
+        'lastname' => 'Last',
+        'dob' => Date.new(1899, 11, 30),
+        'total' => 3,
+        'completed' => nil,
+        'age' => nil,
+        'f_1' => 'a',
+        'f_2' => 'b',
+      }
+    )
+
+    rd.member_id.should == 1
+    rd.grouping_id.should == 2
+    rd.fields.should == {
+      'firstname' => 'First',
+      'lastname' => 'Last',
+      'dob' => Date.new(1899, 11, 30),
+      'total' => 3,
+      'completed' => nil,
+      'age' => nil,
+      'f_1' => 'a',
+      'f_2' => 'b',
+    }
+    rd.valid?.should be_true
+  end
+
+
+  describe "Using the API" do
+
+    it "Fetch Fields" do
+      data = {
+        "extraid" => "2",
+        "sectionid" => "1",
+        "name" => "A Flexi Record",
+        "config" => "[{\"id\":\"f_1\",\"name\":\"Field 1\",\"width\":\"150\"},{\"id\":\"f_2\",\"name\":\"Field 2\",\"width\":\"150\"}]",
+        "total" => "none",
+        "extrafields" => "[]",
+        "structure" => [
+          {
+            "rows" => [
+              {"name" => "First name","field" => "firstname","width" => "150px"},
+              {"name" => "Last name","field" => "lastname","width" => "150px"},
+            ],
+            "noscroll" => true
+          },
+          {"rows" => [
+            {"name" => "Field 1","field" => "f_1","width" => "150px","editable" => true},
+            {"name" => "Filed 2","field" => "f_2","width" => "150px","editable" => true},
+          ]}
+        ]
+      }
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/extras.php?action=getExtra&sectionid=1&extraid=2", :body => data.to_json)
+
+      fields = Osm::FlexiRecord.get_fields(@api, 1, 2)
+      fields.is_a?(Array).should be_true
+      fields[0].valid?.should be_true
+      fields[0].id.should == 'firstname'
+      fields[1].id.should == 'lastname'
+      fields[2].id.should == 'f_1'
+      fields[3].id.should == 'f_2'
+    end
+
+    it "Fetch Data" do
+      data = {
+        'identifier' => 'scoutid',
+        'label' => "name",
+        'items' => [{
+          "scoutid" => "1",
+          "firstname" => "First",
+          "lastname" => "Last",
+          "dob" => "",
+          "patrolid" => "2",
+          "total" => "",
+          "completed" => "",
+          "f_1" => "A",
+          "f_2" => "B",
+          "age" => "",
+          "patrol" => "Green"
+        }]
+      }
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/extras.php?action=getExtraRecords&sectionid=1&extraid=2&termid=3&section=cubs", :body => data.to_json)
+
+      records = Osm::FlexiRecord.get_data(@api, Osm::Section.new(:id => 1, :type => :cubs), 2, 3)
+      records.is_a?(Array).should be_true
+      record = records[0]
+      record.member_id.should == 1
+      record.grouping_id.should == 2
+      record.fields.should == {
+        'firstname' => 'First',
+        'lastname' => 'Last',
+        'dob' => nil,
+        'total' => nil,
+        'completed' => nil,
+        'age' => nil,
+        'f_1' => 'A',
+        'f_2' => 'B',
+      }
+      record.valid?.should be_true
+    end
+
+  end
+
+end

data/spec/osm/grouping_spec.rb

@@ -4,18 +4,22 @@ require 'spec_helper'
 describe "Grouping" do
 
   it "Create" do
-    data = {
+    body = {'patrols' => [{
       'patrolid' => 1,
       'name' => 'Patrol Name',
       'active' => 1,
-      'points' => '2',
-    }
-    patrol = Osm::Grouping.from_api(data)
+      'points' => '3',
+    }]}
+    FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/users.php?action=getPatrols&sectionid=2", :body => body.to_json)
 
+    patrols = Osm::Grouping.get_for_section(@api, 2)
+    patrols.size.should == 1
+    patrol = patrols[0]
     patrol.id.should == 1
+    patrol.section_id.should == 2
     patrol.name.should == 'Patrol Name'
     patrol.active.should == true
-    patrol.points.should == 2
+    patrol.points.should == 3
     patrol.valid?.should be_true
   end
 

data/spec/osm/member_spec.rb

@@ -3,43 +3,49 @@ require 'spec_helper'
 
 describe "Member" do
 
-  it "Create from API data" do
-    data = {
-      'scoutid' => 1,
-      'sectionidO' => 2,
-      'type' => '',
-      'firstname' => 'First',
-      'lastname' => 'Last',
-      'email1' => 'email1@example.com',
-      'email2' => 'email2@example.com',
-      'email3' => 'email3@example.com',
-      'email4' => 'email4@example.com',
-      'phone1' => '11111 111111',
-      'phone2' => '222222',
-      'phone3' => '+33 3333 333333',
-      'phone4' => '4444 444 444',
-      'address' => '1 Some Road',
-      'address2' => '',
-      'dob' => '2000-01-02',
-      'started' => '2006-01-02',
-      'joining_in_yrs' => '2',
-      'parents' => 'John and Jane Doe',
-      'notes' => 'None',
-      'medical' => 'Nothing',
-      'religion' => 'Unknown',
-      'school'=> 'Some School',
-      'ethnicity' => 'Yes',
-      'subs' => 'Upto end of 2007',
-      'patrolid' => '3',
-      'patrolleader' => 0,
-      'joined' => '2006-01-07',
-      'age' => '06/07',
-      'yrs' => 1,
-      'patrol' => 'Blue',
-      'patrolidO' => '4',
-      'patrolleaderO' => 0,
+  it "Create" do
+    attributes = {
+      :id => 1,
+      :section_id => 2,
+      :type => '',
+      :first_name => 'First',
+      :last_name => 'Last',
+      :email1 => 'email1@example.com',
+      :email2 => 'email2@example.com',
+      :email3 => 'email3@example.com',
+      :email4 => 'email4@example.com',
+      :phone1 => '11111 111111',
+      :phone2 => '222222',
+      :phone3 => '+33 3333 333333',
+      :phone4 => '4444 444 444',
+      :address => '1 Some Road',
+      :address2 => '',
+      :date_of_birth => '2000-01-02',
+      :started => '2006-01-02',
+      :joining_in_years => '2',
+      :parents => 'John and Jane Doe',
+      :notes => 'None',
+      :medical => 'Nothing',
+      :religion => 'Unknown',
+      :school=> 'Some School',
+      :ethnicity => 'Yes',
+      :subs => 'Upto end of 2007',
+      :custom1 => 'Custom Field 1',
+      :custom2 => 'Custom Field 2',
+      :custom3 => 'Custom Field 3',
+      :custom4 => 'Custom Field 4',
+      :custom5 => 'Custom Field 5',
+      :custom6 => 'Custom Field 6',
+      :custom7 => 'Custom Field 7',
+      :custom8 => 'Custom Field 8',
+      :custom9 => 'Custom Field 9',
+      :grouping_id => '3',
+      :grouping_leader => 0,
+      :joined => '2006-01-07',
+      :age => '06/07',
+      :joined_years => 1,
     }
-    member = Osm::Member.from_api(data, 2)
+    member = Osm::Member.new(attributes)
 
     member.id.should == 1
     member.section_id.should == 2
@@ -66,6 +72,15 @@ describe "Member" do
     member.school.should == 'Some School'
     member.ethnicity.should == 'Yes'
     member.subs.should == 'Upto end of 2007'
+    member.custom1.should == 'Custom Field 1'
+    member.custom2.should == 'Custom Field 2'
+    member.custom3.should == 'Custom Field 3'
+    member.custom4.should == 'Custom Field 4'
+    member.custom5.should == 'Custom Field 5'
+    member.custom6.should == 'Custom Field 6'
+    member.custom7.should == 'Custom Field 7'
+    member.custom8.should == 'Custom Field 8'
+    member.custom9.should == 'Custom Field 9'
     member.grouping_id.should == 3
     member.grouping_leader.should == 0
     member.joined.should == Date.new(2006, 1, 7)
@@ -97,4 +112,64 @@ describe "Member" do
     member.age_months.should == 7
   end
 
+
+  describe "Using the API" do
+
+    it "Create from API data" do
+      body = {
+        'identifier' => 'scoutid',
+        'items' => [{
+          'scoutid' => 1,
+          'sectionidO' => 2,
+          'type' => '',
+          'firstname' => 'First',
+          'lastname' => 'Last',
+          'email1' => 'email1@example.com',
+          'email2' => 'email2@example.com',
+          'email3' => 'email3@example.com',
+          'email4' => 'email4@example.com',
+          'phone1' => '11111 111111',
+          'phone2' => '222222',
+          'phone3' => '+33 3333 333333',
+          'phone4' => '4444 444 444',
+          'address' => '1 Some Road',
+          'address2' => '',
+          'dob' => '2000-01-02',
+          'started' => '2006-01-02',
+          'joining_in_yrs' => '2',
+          'parents' => 'John and Jane Doe',
+          'notes' => 'None',
+          'medical' => 'Nothing',
+          'religion' => 'Unknown',
+          'school'=> 'Some School',
+          'ethnicity' => 'Yes',
+          'subs' => 'Upto end of 2007',
+          'custom1' => 'Custom Field 1',
+          'custom2' => 'Custom Field 2',
+          'custom3' => 'Custom Field 3',
+          'custom4' => 'Custom Field 4',
+          'custom5' => 'Custom Field 5',
+          'custom6' => 'Custom Field 6',
+          'custom7' => 'Custom Field 7',
+          'custom8' => 'Custom Field 8',
+          'custom9' => 'Custom Field 9',
+          'patrolid' => '3',
+          'patrolleader' => 0,
+          'joined' => '2006-01-07',
+          'age' => '06/07',
+          'yrs' => 1,
+          'patrol' => 'Blue',
+          'patrolidO' => '4',
+          'patrolleaderO' => 0,
+        }]
+      }
+
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/users.php?action=getUserDetails&sectionid=1&termid=2", :body => body.to_json)
+      members = Osm::Member.get_for_section(@api, 1, 2)
+      members.size.should == 1
+      members[0].id.should == 1
+    end
+
+  end
+
 end

data/spec/osm/model_spec.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+require 'spec_helper'
+
+
+describe "Model" do
+
+  class ModelTester < Osm::Model
+    def self.test_get_config
+      {
+        :cache => @@cache,
+        :prepend_to_key => @@cache_prepend,
+        :ttl => @@cache_ttl,
+      }
+    end
+
+    def self.cache(method, *options)
+      self.send("cache_#{method}", *options)
+    end
+  end
+
+
+  it "Create" do
+    model = Osm::Model.new
+    model.should_not be_nil
+  end
+
+
+  it "Configure" do
+    options = {
+      :cache => OsmTest::Cache,
+      :ttl => 100,
+      :prepend_to_key => 'Hi',
+    }
+
+    Osm::Model.configure(options)
+    config = ModelTester.test_get_config
+    config.should == options
+  end
+
+  it "Configure (allows empty Hash)" do
+    Osm::Model.configure({})
+    config = ModelTester.test_get_config
+    config[:cache].should be_nil
+    config[:ttl].should == 1800
+    config[:prepend_to_key].should == 'OSMAPI'
+  end
+
+  it "Configure (bad arguments)" do
+    expect{ Osm::Model.configure(@CONFIGURATION[:cache].merge(:prepend_to_key => :invalid)) }.to raise_error(ArgumentError, ':prepend_to_key must be a String')
+
+    expect{ Osm::Model.configure(@CONFIGURATION[:cache].merge(:ttl => :invalid)) }.to raise_error(ArgumentError, ':ttl must be a FixNum greater than 0')
+    expect{ Osm::Model.configure(@CONFIGURATION[:cache].merge(:ttl => 0)) }.to raise_error(ArgumentError, ':ttl must be a FixNum greater than 0')
+
+    expect{ Osm::Model.configure(@CONFIGURATION[:cache].merge(:cache => String)) }.to raise_error(ArgumentError, ':cache must have a exist? method')
+  end
+
+
+  describe "Caching" do
+
+    it "Checks for existance" do
+      OsmTest::Cache.should_receive('exist?').with('OSMAPI-osm-key') { true }
+      ModelTester.cache('exist?', @api, 'key').should be_true
+    end
+
+    it "Writes" do
+      OsmTest::Cache.should_receive('write').with('OSMAPI-osm-key', 'data', {:expires_in=>1800}) { true }
+      ModelTester.cache('write', @api, 'key', 'data').should be_true
+    end
+
+    it "Reads" do
+      OsmTest::Cache.should_receive('read').with('OSMAPI-osm-key') { 'data' }
+      ModelTester.cache('read', @api, 'key').should == 'data'
+    end
+
+    it "Deletes" do
+      OsmTest::Cache.should_receive('delete').with('OSMAPI-osm-key') { true }
+      ModelTester.cache('delete', @api, 'key').should be_true
+    end
+
+    it "Behaves when cache is nil (no caching)" do
+      Osm::Model.configure({:cache => nil})
+      ModelTester.cache('exist?', @api, 'key').should be_false
+      ModelTester.cache('write', @api, 'key', 'data').should be_false
+      ModelTester.cache('read', @api, 'key').should be_nil
+      ModelTester.cache('delete', @api, 'key').should be_true
+    end
+
+    it "Builds a key from an array" do
+      ModelTester.cache('key', @api, ['a', 'b']).should == 'OSMAPI-osm-a-b'
+    end
+
+  end
+
+
+  describe "Get User Permissions" do
+
+    it "From cache" do
+      permissions = {1 => {:a => [:read, :write]}, 2 => {:a => [:read]}}
+      OsmTest::Cache.should_receive('exist?').with('OSMAPI-osm-permissions-user_id') { true }
+      OsmTest::Cache.should_receive('read').with('OSMAPI-osm-permissions-user_id') { permissions }
+      ModelTester.get_user_permissions(@api).should == permissions
+    end
+
+    it "From API" do
+      permissions = {1 => {:a => [:read, :write]}, 2 => {:a => [:read]}}
+      OsmTest::Cache.should_receive('exist?').with('OSMAPI-osm-permissions-user_id') { false }
+      Osm::Section.should_receive('fetch_user_permissions').with(@api) { permissions }
+      ModelTester.get_user_permissions(@api).should == permissions
+    end
+
+    it "Single section" do
+      permissions = {1 => {:a => [:read, :write]}, 2 => {:a => [:read]}}
+      OsmTest::Cache.should_receive('exist?').with('OSMAPI-osm-permissions-user_id').twice { true }
+      OsmTest::Cache.should_receive('read').with('OSMAPI-osm-permissions-user_id').twice { permissions }
+      ModelTester.get_user_permissions(@api, 1).should == permissions[1]
+      ModelTester.get_user_permissions(@api, 2).should == permissions[2]
+    end
+
+  end
+
+
+  describe "Set User Permissions" do
+
+    it "All Sections" do
+      permissions = {1 => {:a => [:read, :write]}, 2 => {:a => [:read]}}
+      OsmTest::Cache.should_receive('write').with('OSMAPI-osm-permissions-user_id', permissions, {:expires_in=>1800}) { true }
+      ModelTester.set_user_permissions(@api, permissions)
+    end
+
+    it "Single section" do
+      permissions = {1 => {:a => [:read, :write]}, 2 => {:a => [:read]}}
+      OsmTest::Cache.should_receive('exist?').with('OSMAPI-osm-permissions-user_id') { true }
+      OsmTest::Cache.should_receive('read').with('OSMAPI-osm-permissions-user_id') { permissions }
+      OsmTest::Cache.should_receive('write').with('OSMAPI-osm-permissions-user_id', permissions.merge(3 => {:a => [:read]}), {:expires_in=>1800}) { true }
+      ModelTester.set_user_permissions(@api, 3, {:a => [:read]})
+    end
+
+  end
+
+end