osm 0.0.26 → 0.1.0

data/spec/osm/term_spec.rb

@@ -14,15 +14,8 @@ describe "Term" do
     }
   end
 
-  it "Create from API data" do
-    data = {
-      'termid' => '1',
-      'sectionid' => '2',
-      'name' => 'Term name',
-      'startdate' => '2001-01-01',
-      'enddate' => '2001-03-31'
-    }
-    term = Osm::Term.from_api(data)
+  it "Create" do
+    term = Osm::Term.new(@attributes)
 
     term.id.should == 1
     term.section_id.should == 2
@@ -32,18 +25,6 @@ describe "Term" do
     term.valid?.should be_true
   end
 
-
-  it "Creates the data for saving through the API" do
-    term = Osm::Term.new(@attributes)
-    term.to_api.should == {
-      'term' => @attributes[:name],
-      'start' => @attributes[:start].strftime(Osm::OSM_DATE_FORMAT),
-      'end' => @attributes[:finish].strftime(Osm::OSM_DATE_FORMAT),
-      'termid' => @attributes[:id]
-    }
-  end
-
-
   it "Compares two matching terms" do
     term1 = Osm::Term.new(@attributes)
     term2 = Osm::Term.new(@attributes)
@@ -56,7 +37,6 @@ describe "Term" do
     term.should_not == Osm::Term.new(@attributes.merge(:id => 3))
   end
 
-
   it "Sorts by Section ID, Start date and then Term ID" do
     term1 = Osm::Term.new(@attributes.merge(:section_id => 1, :term => 11, :start => (Date.today - 60), :finish => (Date.today - 1)))
     term2 = Osm::Term.new(@attributes.merge(:section_id => 1, :term => 12, :start => (Date.today -  0), :finish => (Date.today + 0)))
@@ -68,7 +48,6 @@ describe "Term" do
     data.sort.should == [term1, term2, term3, term4, term5]
   end
 
-
   it "Works out if it is completly before a date" do
     term1 = Osm::Term.new(@attributes.merge(:start => (Date.today - 60), :finish => (Date.today - 1)))
     term2 = Osm::Term.new(@attributes.merge(:start => (Date.today -  0), :finish => (Date.today + 0)))
@@ -79,7 +58,6 @@ describe "Term" do
     term3.before?(Date.today).should == false
   end
 
-
   it "Works out if it is completly after a date" do
     term1 = Osm::Term.new(@attributes.merge(:start => (Date.today - 60), :finish => (Date.today - 1)))
     term2 = Osm::Term.new(@attributes.merge(:start => (Date.today -  0), :finish => (Date.today + 0)))
@@ -90,7 +68,6 @@ describe "Term" do
     term3.after?(Date.today).should == true
   end
 
-
   it "Works out if it has passed" do
     term1 = Osm::Term.new(@attributes.merge(:start => (Date.today - 60), :finish => (Date.today - 1)))
     term2 = Osm::Term.new(@attributes.merge(:start => (Date.today -  0), :finish => (Date.today + 0)))
@@ -101,7 +78,6 @@ describe "Term" do
     term3.past?().should == false
   end
 
-
   it "Works out if it is in the future" do
     term1 = Osm::Term.new(@attributes.merge(:start => (Date.today - 60), :finish => (Date.today - 1)))
     term2 = Osm::Term.new(@attributes.merge(:start => (Date.today -  0), :finish => (Date.today + 0)))
@@ -112,7 +88,6 @@ describe "Term" do
     term3.future?().should == true
   end
 
-
   it "Works out if it is the current term" do
     term1 = Osm::Term.new(@attributes.merge(:start => (Date.today - 60), :finish => (Date.today - 1)))
     term2 = Osm::Term.new(@attributes.merge(:start=> (Date.today -  0), :finish => (Date.today + 0)))
@@ -123,7 +98,6 @@ describe "Term" do
     term3.current?().should == false
   end
 
-
   it "Works out if it contains a date" do
     term1 = Osm::Term.new(@attributes.merge(:start => (Date.today - 60), :finish => (Date.today - 1)))
     term2 = Osm::Term.new(@attributes.merge(:start => (Date.today -  0), :finish => (Date.today + 0)))
@@ -134,4 +108,166 @@ describe "Term" do
     term3.contains_date?(Date.today).should == false
   end
 
+
+  describe "Using the API" do
+
+    before :each do
+      body = [
+        {"sectionConfig"=>"{\"subscription_level\":1,\"subscription_expires\":\"2013-01-05\",\"sectionType\":\"beavers\",\"columnNames\":{\"column_names\":\"names\"},\"numscouts\":10,\"hasUsedBadgeRecords\":true,\"hasProgramme\":true,\"extraRecords\":[{\"name\":\"Flexi Record 1\",\"extraid\":\"111\"}],\"wizard\":\"false\",\"fields\":{\"fields\":true},\"intouch\":{\"intouch_fields\":true},\"mobFields\":{\"mobile_fields\":true}}", "groupname"=>"3rd Somewhere", "groupid"=>"3", "groupNormalised"=>"1", "sectionid"=>"9", "sectionname"=>"Section 1", "section"=>"beavers", "isDefault"=>"1", "permissions"=>{"badge"=>10, "member"=>20, "user"=>100, "register"=>100, "contact"=>100, "programme"=>100, "originator"=>1, "events"=>100, "finance"=>100, "flexi"=>100}},
+        {"sectionConfig"=>"{\"subscription_level\":3,\"subscription_expires\":\"2013-01-05\",\"sectionType\":\"cubs\",\"columnNames\":{\"phone1\":\"Home Phone\",\"phone2\":\"Parent 1 Phone\",\"address\":\"Member's Address\",\"phone3\":\"Parent 2 Phone\",\"address2\":\"Address 2\",\"phone4\":\"Alternate Contact Phone\",\"subs\":\"Gender\",\"email1\":\"Parent 1 Email\",\"medical\":\"Medical / Dietary\",\"email2\":\"Parent 2 Email\",\"ethnicity\":\"Gift Aid\",\"email3\":\"Member's Email\",\"religion\":\"Religion\",\"email4\":\"Email 4\",\"school\":\"School\"},\"numscouts\":10,\"hasUsedBadgeRecords\":true,\"hasProgramme\":true,\"extraRecords\":[],\"wizard\":\"false\",\"fields\":{\"email1\":true,\"email2\":true,\"email3\":true,\"email4\":false,\"address\":true,\"address2\":false,\"phone1\":true,\"phone2\":true,\"phone3\":true,\"phone4\":true,\"school\":false,\"religion\":true,\"ethnicity\":true,\"medical\":true,\"patrol\":true,\"subs\":true,\"saved\":true},\"intouch\":{\"address\":true,\"address2\":false,\"email1\":false,\"email2\":false,\"email3\":false,\"email4\":false,\"phone1\":true,\"phone2\":true,\"phone3\":true,\"phone4\":true,\"medical\":false},\"mobFields\":{\"email1\":false,\"email2\":false,\"email3\":false,\"email4\":false,\"address\":true,\"address2\":false,\"phone1\":true,\"phone2\":true,\"phone3\":true,\"phone4\":true,\"school\":false,\"religion\":false,\"ethnicity\":true,\"medical\":true,\"patrol\":true,\"subs\":false}}", "groupname"=>"1st Somewhere", "groupid"=>"1", "groupNormalised"=>"1", "sectionid"=>"10", "sectionname"=>"Section 2", "section"=>"cubs", "isDefault"=>"0", "permissions"=>{"badge"=>100, "member"=>100, "user"=>100, "register"=>100, "contact"=>100, "programme"=>100, "originator"=>1, "events"=>100, "finance"=>100, "flexi"=>100}}
+      ]
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/api.php?action=getUserRoles", :body => body.to_json)
+
+      body = {
+        "9" => [
+          {"termid" => "1", "name" => "Term 1", "sectionid" => "9", "startdate" => (Date.today + 31).strftime('%Y-%m-%d'), "enddate" => (Date.today + 90).strftime('%Y-%m-%d')}
+        ],
+        "10" => [
+          {"termid" => "2", "name" => "Term 2", "sectionid" => "10", "startdate" => (Date.today + 31).strftime('%Y-%m-%d'), "enddate" => (Date.today + 90).strftime('%Y-%m-%d')},
+          {"termid" => "3", "name" => "Term 3", "sectionid" => "10", "startdate" => (Date.today + 91).strftime('%Y-%m-%d'), "enddate" => (Date.today + 180).strftime('%Y-%m-%d')}
+        ]
+      }
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/api.php?action=getTerms", :body => body.to_json)
+    end
+
+
+    it "Gets all terms" do
+      terms = Osm::Term.get_all(@api)
+      terms.size.should == 3
+      terms.map{ |i| i.id }.should == [1, 2, 3]
+      term = terms[0]
+      term.is_a?(Osm::Term).should be_true
+      term.id.should == 1
+      term.name.should == 'Term 1'
+      term.start.should == (Date.today + 31)
+      term.finish.should == (Date.today + 90)
+    end
+
+    it "Gets all terms for a section" do
+      terms = Osm::Term.get_for_section(@api, 10)
+      terms.size.should == 2
+      terms.map{ |i| i.id }.should == [2, 3]
+    end
+
+    it "Gets a term" do
+      term = Osm::Term.get(@api, 2)
+      term.is_a?(Osm::Term).should be_true
+      term.id.should == 2
+    end
+
+    describe "find current term" do
+      it "Returns the current term for the section from all terms returned by OSM" do
+        body = '{"9":['
+        body += '{"termid":"1","name":"Term 1","sectionid":"9","startdate":"' + (Date.today - 90).strftime('%Y-%m-%d') + '","enddate":"' + (Date.today - 31).strftime('%Y-%m-%d') + '"},'
+        body += '{"termid":"2","name":"Term 2","sectionid":"9","startdate":"' + (Date.today - 30).strftime('%Y-%m-%d') + '","enddate":"' + (Date.today + 30).strftime('%Y-%m-%d') + '"},'
+        body += '{"termid":"3","name":"Term 3","sectionid":"9","startdate":"' + (Date.today + 31).strftime('%Y-%m-%d') + '","enddate":"' + (Date.today + 90).strftime('%Y-%m-%d') + '"}'
+        body += ']}'
+        FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/api.php?action=getTerms", :body => body)
+    
+        Osm::Term.get_current_term_for_section(@api, 9).id.should == 2
+      end
+    
+      it "Raises an error if there is no current term" do
+        body = '{"9":['
+        body += '{"termid":"1","name":"Term 1","sectionid":"9","startdate":"' + (Date.today + 31).strftime('%Y-%m-%d') + '","enddate":"' + (Date.today + 90).strftime('%Y-%m-%d') + '"}'
+        body += ']}'
+        FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/api.php?action=getTerms", :body => body)
+    
+        expect{ Osm::Term.get_current_term_for_section(@api, 9) }.to raise_error(Osm::Error, 'There is no current term for the section.')
+      end
+    end
+
+    it "Create a term" do
+      url = 'https://www.onlinescoutmanager.co.uk/users.php?action=addTerm&sectionid=1'
+      post_data = {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'term' => 'A Term',
+        'start' => '2010-01-01',
+        'end' => '2010-12-31',
+        'termid' => '0'
+      }
+
+      Osm::Term.stub(:get_all) { [] }
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"terms":{}}'}) }
+
+      Osm::Term.create(@api, {
+        :section => 1,
+        :name => 'A Term',
+        :start => Date.new(2010, 01, 01),
+        :finish => Date.new(2010, 12, 31),
+      }).should be_true
+    end
+
+    it "Create a term (failed)" do
+      url = 'https://www.onlinescoutmanager.co.uk/users.php?action=addTerm&sectionid=1'
+      post_data = {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'term' => 'A Term',
+        'start' => '2010-01-01',
+        'end' => '2010-12-31',
+        'termid' => '0'
+      }
+
+      Osm::Term.stub(:get_all) { [] }
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{}'}) }
+
+      Osm::Term.create(@api, {
+        :section => 1,
+        :name => 'A Term',
+        :start => Date.new(2010, 01, 01),
+        :finish => Date.new(2010, 12, 31),
+      }).should be_false
+    end
+
+    it "Update a term" do
+      url = 'https://www.onlinescoutmanager.co.uk/users.php?action=addTerm&sectionid=1'
+      post_data = {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'term' => 'A Term',
+        'start' => '2010-01-01',
+        'end' => '2010-12-31',
+        'termid' => 2
+      }
+      Osm::Term.stub(:get_all) { [] }
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"terms":{}}'}) }
+
+      term = Osm::Term.new(:id=>2, :section_id=>1, :name=>'A Term', :start=>Date.new(2010, 01, 01), :finish=>Date.new(2010, 12, 31))
+      term.update(@api).should be_true
+    end
+
+    it "Update a term (failed)" do
+      url = 'https://www.onlinescoutmanager.co.uk/users.php?action=addTerm&sectionid=1'
+      post_data = {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'term' => 'A Term',
+        'start' => '2010-01-01',
+        'end' => '2010-12-31',
+        'termid' => 2
+      }
+      Osm::Term.stub(:get_all) { [] }
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{}'}) }
+
+      term = Osm::Term.new(:id=>2, :section_id=>1, :name=>'A Term', :start=>Date.new(2010, 01, 01), :finish=>Date.new(2010, 12, 31))
+      term.update(@api).should be_false
+    end
+
+    it "Update a term (invalid term)" do
+      term = Osm::Term.new
+      expect{ term.update(@api) }.to raise_error(Osm::ObjectIsInvalid)
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -22,6 +22,28 @@ RSpec.configure do |config|
   config.before(:each) do
     FakeWeb.clean_registry
     OsmTest::Cache.clear
+
+    @CONFIGURATION = {
+      :api => {
+        :default_site => :osm,
+        :osm => {
+          :id => '1',
+          :token => 'API TOKEN',
+          :name => 'API NAME',
+        },
+        :ogm => {
+          :id => '2',
+          :token => 'API TOKEN 2',
+          :name => 'API NAME 2',
+        },
+      },
+      :cache => {
+        :cache => OsmTest::Cache,
+      },
+    }
+    Osm::configure(@CONFIGURATION)
+    
+    @api = Osm::Api.new('user_id', 'secret')
   end
 end
 

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.0.26"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.0.26
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000Z
+date: 2012-10-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &84281650 !ruby/object:Gem::Requirement
+  requirement: &77741230 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *84281650
+  version_requirements: *77741230
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &84280940 !ruby/object:Gem::Requirement
+  requirement: &77740810 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *84280940
+  version_requirements: *77740810
 - !ruby/object:Gem::Dependency
   name: active_attr
-  requirement: &84277910 !ruby/object:Gem::Requirement
+  requirement: &77740380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *84277910
+  version_requirements: *77740380
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &84277570 !ruby/object:Gem::Requirement
+  requirement: &77740070 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *84277570
+  version_requirements: *77740070
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &84277120 !ruby/object:Gem::Requirement
+  requirement: &77739770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *84277120
+  version_requirements: *77739770
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &84276710 !ruby/object:Gem::Requirement
+  requirement: &77739280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *84276710
+  version_requirements: *77739280
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &84276320 !ruby/object:Gem::Requirement
+  requirement: &77738950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *84276320
+  version_requirements: *77738950
 description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
   to retrieve and save data.
 email:
@@ -113,33 +113,26 @@ files:
 - lib/osm/due_badges.rb
 - lib/osm/evening.rb
 - lib/osm/event.rb
-- lib/osm/event_attendance.rb
-- lib/osm/flexi_record_data.rb
-- lib/osm/flexi_record_field.rb
+- lib/osm/flexi_record.rb
 - lib/osm/grouping.rb
 - lib/osm/member.rb
-- lib/osm/register_data.rb
-- lib/osm/register_field.rb
-- lib/osm/role.rb
+- lib/osm/model.rb
+- lib/osm/register.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/evening_spec.rb
-- spec/osm/event_attendance_spec.rb
 - spec/osm/event_spec.rb
-- spec/osm/flexi_record_data_spec.rb
-- spec/osm/flexi_record_field_spec.rb
+- spec/osm/flexi_record_spec.rb
 - spec/osm/grouping_spec.rb
 - spec/osm/member_spec.rb
+- spec/osm/model_spec.rb
 - spec/osm/osm_spec.rb
-- spec/osm/register_data_spec.rb
-- spec/osm/register_field_spec.rb
-- spec/osm/role_spec.rb
+- spec/osm/register_spec.rb
 - spec/osm/section_spec.rb
 - spec/osm/term_spec.rb
 - spec/spec_helper.rb

data/lib/osm/event_attendance.rb

@@ -1,55 +0,0 @@
-module Osm
-
-  class EventAttendance
-    include ::ActiveAttr::MassAssignmentSecurity
-    include ::ActiveAttr::Model
-
-    # @!attribute [rw] member_id
-    #   @return [Fixnum] OSM id for the member
-    # @!attribute [rw] grouping__id
-    #   @return [Fixnum] OSM id for the grouping the member is in
-    # @!attribute [rw] fields
-    #   @return [Hash] Keys are the field's id, values are the field values
-    # @!attribute [rw] row
-    #   @return [Fixnum] part of the OSM API
-
-    attribute :row, :type => Integer
-    attribute :member_id, :type => Integer
-    attribute :grouping_id, :type => Integer
-    attribute :fields, :default => {}
-
-    attr_accessible :member_id, :grouping_id, :fields, :row
-
-    validates_numericality_of :row, :only_integer=>true, :greater_than_or_equal_to=>0
-    validates_numericality_of :member_id, :only_integer=>true, :greater_than=>0
-    validates_numericality_of :grouping_id, :only_integer=>true, :greater_than_or_equal_to=>-2
-    validates :fields, :hash => {:key_type => String}
-
-
-    # @!method initialize
-    #   Initialize a new FlexiRecordData
-    #   @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
-
-
-    # Initialize a new FlexiRecordData from api data
-    # @param [Hash] data the hash of data provided by the API
-    # @param [Fixnum] row part of the OSM API
-    def self.from_api(data, row)
-      data.merge!({
-        'dob' => data['dob'].nil? ? nil : Osm::parse_date(data['dob'], :ignore_epoch => true),
-        'attending' => data['attending'].eql?('Yes'),
-      })
-
-      new({
-        :member_id => Osm::to_i_or_nil(data['scoutid']),
-        :grouping_id => Osm::to_i_or_nil(data['patrolid'].eql?('') ? nil : data['patrolid']),
-        :fields => data.select { |key, value|
-          ['firstname', 'lastname', 'dob', 'attending'].include?(key) || key.to_s.match(/\Af_\d+\Z/)
-        },
-        :row => row,
-      })
-    end
-
-  end # Class EventAttendance
-
-end # Module