osm 0.0.1.alpha

data/spec/osm/section_spec.rb

@@ -0,0 +1,199 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'date'
+
+
+describe "Section" do
+
+  class DummyRole
+    attr_reader :id
+    def initialize(id)
+      @id = id
+    end
+    def <=>(another)
+      @id <=> another.try(:id)
+    end
+  end
+
+
+
+  it "Create" 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)
+    section = Osm::Section.new(1, 'Name', data, role)
+
+    section.id.should == 1
+    section.name.should == 'Name' 
+    section.subscription_level.should == :gold
+    section.subscription_expires.should == Date.today + 60
+    section.type.should == :cubs
+    section.num_scouts.should == 10
+    section.has_badge_records.should == true
+    section.has_programme.should == true
+    section.wizard.should == false
+    section.column_names.should == {}
+    section.fields.should == {}
+    section.intouch_fields.should == {}
+    section.mobile_fields.should == {}
+    section.extra_records.should == []
+    section.role.should == role
+  end
+
+  it "Create has sensible defaults" do
+    section = Osm::Section.new(1, 'Name', {}, nil)
+
+    section.subscription_level.should == :unknown
+    section.subscription_expires.should == nil
+    section.type.should == :unknown
+    section.num_scouts.should == nil
+    section.column_names.should == {}
+    section.fields.should == {}
+    section.intouch_fields.should == {}
+    section.mobile_fields.should == {}
+    section.extra_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)
+    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.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))
+
+    [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))
+
+    {: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|
+        section.send("#{type.to_s}?").should == (section_type == type)
+      end
+    end
+  end
+
+
+  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))
+
+    [beavers, cubs, scouts, explorers].each do |section|
+      section.youth_section?.should == true
+    end
+    [adults, waiting, unknown].each do |section|
+      section.youth_section?.should == false
+    end
+  end
+
+end

data/spec/osm/term_spec.rb

@@ -0,0 +1,162 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'date'
+
+describe "Term" do
+
+  it "Create" do
+    data = {
+      'termid' => '1',
+      'sectionid' => '2',
+      'name' => 'Term name',
+      'startdate' => '2001-01-01',
+      'enddate' => '2001-03-31'
+    }
+    term = Osm::Term.new(data)
+
+    term.id.should == 1
+    term.section_id.should == 2
+    term.name.should == 'Term name'
+    term.start.should == Date.new(2001, 1, 1)
+    term.end.should == Date.new(2001, 3, 31)
+  end
+
+
+  it "Compares two matching terms" do
+    data = {
+      'termid' => '1',
+      'sectionid' => '2',
+      'name' => 'Term name',
+      'startdate' => '2001-01-01',
+      'enddate' => '2001-03-31'
+    }
+    term1 = Osm::Term.new(data)
+    term2 = Osm::Term.new(data)
+    term1.should == term2
+  end
+
+  it "Compares two non-matching terms" do
+    data = {
+      'termid' => '1',
+      'sectionid' => '2',
+      'name' => 'Term name',
+      'startdate' => '2001-01-01',
+      'enddate' => '2001-03-31'
+    }
+    term = Osm::Term.new(data)
+
+    term.should_not == Osm::Term.new(data.merge('termid' => '3'))
+  end
+
+
+  it "Sorts by Section ID, Start date and then Term ID" do
+    data = {
+      'name' => 'Term name',
+    }
+    term1 = Osm::Term.new(data.merge('sectionid' => '1', 'termid' => '11', 'startdate' => (Date.today - 60).strftime('%Y-%m-%d'), 'enddate' => (Date.today - 1).strftime('%Y-%m-%d')))
+    term2 = Osm::Term.new(data.merge('sectionid' => '1', 'termid' => '12', 'startdate' => (Date.today -  0).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 0).strftime('%Y-%m-%d')))
+    term3 = Osm::Term.new(data.merge('sectionid' => '1', 'termid' => '13', 'startdate' => (Date.today +  1).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 60).strftime('%Y-%m-%d')))
+    term4 = Osm::Term.new(data.merge('sectionid' => '2', 'termid' => '1', 'startdate' => (Date.today +  1).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 60).strftime('%Y-%m-%d')))
+    term5 = Osm::Term.new(data.merge('sectionid' => '2', 'termid' => '2', 'startdate' => (Date.today +  1).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 60).strftime('%Y-%m-%d')))
+
+    data = [term5, term3, term2, term4, term1]
+    data.sort.should == [term1, term2, term3, term4, term5]
+  end
+
+
+  it "Works out if it is completly before a date" do
+    data = {
+      'termid' => '1',
+      'sectionid' => '2',
+      'name' => 'Term name',
+    }
+    term1 = Osm::Term.new(data.merge('startdate' => (Date.today - 60).strftime('%Y-%m-%d'), 'enddate' => (Date.today - 1).strftime('%Y-%m-%d')))
+    term2 = Osm::Term.new(data.merge('startdate' => (Date.today -  0).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 0).strftime('%Y-%m-%d')))
+    term3 = Osm::Term.new(data.merge('startdate' => (Date.today +  1).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 60).strftime('%Y-%m-%d')))
+
+    term1.before?(Date.today).should == true
+    term2.before?(Date.today).should == false
+    term3.before?(Date.today).should == false
+  end
+
+
+  it "Works out if it is completly after a date" do
+    data = {
+      'termid' => '1',
+      'sectionid' => '2',
+      'name' => 'Term name',
+    }
+    term1 = Osm::Term.new(data.merge('startdate' => (Date.today - 60).strftime('%Y-%m-%d'), 'enddate' => (Date.today - 1).strftime('%Y-%m-%d')))
+    term2 = Osm::Term.new(data.merge('startdate' => (Date.today -  0).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 0).strftime('%Y-%m-%d')))
+    term3 = Osm::Term.new(data.merge('startdate' => (Date.today +  1).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 60).strftime('%Y-%m-%d')))
+
+    term1.after?(Date.today).should == false
+    term2.after?(Date.today).should == false
+    term3.after?(Date.today).should == true
+  end
+
+
+  it "Works out if it has passed" do
+    data = {
+      'termid' => '1',
+      'sectionid' => '2',
+      'name' => 'Term name',
+    }
+    term1 = Osm::Term.new(data.merge('startdate' => (Date.today - 60).strftime('%Y-%m-%d'), 'enddate' => (Date.today - 1).strftime('%Y-%m-%d')))
+    term2 = Osm::Term.new(data.merge('startdate' => (Date.today -  0).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 0).strftime('%Y-%m-%d')))
+    term3 = Osm::Term.new(data.merge('startdate' => (Date.today +  1).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 60).strftime('%Y-%m-%d')))
+
+    term1.past?().should == true
+    term2.past?().should == false
+    term3.past?().should == false
+  end
+
+
+  it "Works out if it is in the future" do
+    data = {
+      'termid' => '1',
+      'sectionid' => '2',
+      'name' => 'Term name',
+    }
+    term1 = Osm::Term.new(data.merge('startdate' => (Date.today - 60).strftime('%Y-%m-%d'), 'enddate' => (Date.today - 1).strftime('%Y-%m-%d')))
+    term2 = Osm::Term.new(data.merge('startdate' => (Date.today -  0).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 0).strftime('%Y-%m-%d')))
+    term3 = Osm::Term.new(data.merge('startdate' => (Date.today +  1).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 60).strftime('%Y-%m-%d')))
+
+    term1.future?().should == false
+    term2.future?().should == false
+    term3.future?().should == true
+  end
+
+
+  it "Works out if it is the current term" do
+    data = {
+      'termid' => '1',
+      'sectionid' => '2',
+      'name' => 'Term name',
+    }
+    term1 = Osm::Term.new(data.merge('startdate' => (Date.today - 60).strftime('%Y-%m-%d'), 'enddate' => (Date.today - 1).strftime('%Y-%m-%d')))
+    term2 = Osm::Term.new(data.merge('startdate' => (Date.today -  0).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 0).strftime('%Y-%m-%d')))
+    term3 = Osm::Term.new(data.merge('startdate' => (Date.today +  1).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 60).strftime('%Y-%m-%d')))
+
+    term1.current?().should == false
+    term2.current?().should == true
+    term3.current?().should == false
+  end
+
+
+  it "Works out if it contains a date" do
+    data = {
+      'termid' => '1',
+      'sectionid' => '2',
+      'name' => 'Term name',
+    }
+    term1 = Osm::Term.new(data.merge('startdate' => (Date.today - 60).strftime('%Y-%m-%d'), 'enddate' => (Date.today - 1).strftime('%Y-%m-%d')))
+    term2 = Osm::Term.new(data.merge('startdate' => (Date.today -  0).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 0).strftime('%Y-%m-%d')))
+    term3 = Osm::Term.new(data.merge('startdate' => (Date.today +  1).strftime('%Y-%m-%d'), 'enddate' => (Date.today + 60).strftime('%Y-%m-%d')))
+
+    term1.contains_date?(Date.today).should == false
+    term2.contains_date?(Date.today).should == true
+    term3.contains_date?(Date.today).should == false
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+require 'fakeweb'
+require 'httparty'
+require 'active_support'
+
+require 'osm'
+
+FakeWeb.allow_net_connect = false
+
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  config.before(:each) do
+    FakeWeb.clean_registry
+    Rails.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
+
+  class Cache
+    def initialize
+      @cache = {}
+    end
+    def write(key, data, options={})
+      @cache[key] = data
+    end
+    def read(key)
+      @cache[key]
+    end
+    def exist?(key)
+      @cache.include?(key)
+    end
+    def clear
+      @cache = {}
+    end
+  end
+end

data/version.rb

@@ -0,0 +1,3 @@
+module Osm
+  VERSION = "0.0.1.alpha"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: osm
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Robert Gauld
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-31 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &86907540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *86907540
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &86907280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *86907280
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &86907050 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *86907050
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &86906700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *86906700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &86906390 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *86906390
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &86906030 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *86906030
+description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
+  to retrieve and save data.
+email:
+- robert@robertgauld.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.rdoc
+- README.md
+- Rakefile
+- lib/osm.rb
+- lib/osm/activity.rb
+- lib/osm/api.rb
+- lib/osm/api_access.rb
+- lib/osm/due_badges.rb
+- lib/osm/event.rb
+- lib/osm/grouping.rb
+- lib/osm/member.rb
+- lib/osm/programme_activity.rb
+- lib/osm/programme_item.rb
+- lib/osm/role.rb
+- lib/osm/section.rb
+- lib/osm/term.rb
+- osm.gemspec
+- spec/osm/activity_spec.rb
+- spec/osm/api_access_spec.rb
+- spec/osm/api_spec.rb
+- spec/osm/api_strangeness_spec.rb
+- spec/osm/due_badges_spec.rb
+- spec/osm/event_spec.rb
+- spec/osm/grouping_spec.rb
+- spec/osm/member_spec.rb
+- spec/osm/osm_spec.rb
+- spec/osm/programme_activity_spec.rb
+- spec/osm/programme_item_spec.rb
+- spec/osm/role_spec.rb
+- spec/osm/section_spec.rb
+- spec/osm/term_spec.rb
+- spec/spec_helper.rb
+- version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: osm
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Use the Online Scout Manager API
+test_files: []
+has_rdoc: