osm 1.0.0 → 1.0.1

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Version 1.0.1
+
+  * Fix Osm::Term date helping methods when term contains nil dates
+  * Fix fetching event attendance when no attendance has been set for any members
+  * Osm::Api exposes the debug option as a psudo class attribute
+
 ## Version 1.0.0
 
   * SMS text messages:

data/README.md

@@ -32,7 +32,7 @@ Use the [Online Scout Manager](https://www.onlinescoutmanager.co.uk) API.
 Add to your Gemfile and run the `bundle` command to install it.
 
 ```ruby
-gem 'osm', '~> 1.0.0'
+gem 'osm', '~> 1.0'
 ```
 
 Configure the gem during the initalization of the app (e.g. if using rails then config/initializers/osm.rb would look like):

data/lib/osm/api.rb

@@ -50,6 +50,19 @@ module Osm
       nil
     end
 
+    # Configure the debug option
+    # @param [Boolean] debug whether to display debugging information
+    # @return nil
+    def self.debug=(debug)
+      @@debug = !!debug
+    end
+
+    # The debug option
+    # @return Boolean whether debugging output is enabled
+    def self.debug
+      @@debug
+    end
+
     # Initialize a new API connection
     # @param [String] user_id OSM userid of the user to act as (get this by using the authorize method)
     # @param [String] secret OSM secret of the user to act as (get this by using the authorize method)

data/lib/osm/event.rb

@@ -256,7 +256,7 @@ module Osm
       end
 
       data = api.perform_query("events.php?action=getEventAttendance&eventid=#{id}&sectionid=#{section_id}&termid=#{term_id}")
-      data = data['items']
+      data = data['items'] || []
 
       payment_values = {
         'Manual' => :manual,

data/lib/osm/term.rb

@@ -187,6 +187,7 @@ module Osm
     # @param [Date] date
     # @return [Boolean] if the term is completly before the passed date
     def before?(date)
+      return false if finish.nil?
       return finish < date.to_date
     end
 
@@ -194,24 +195,29 @@ module Osm
     # @param [Date] date
     # @return [Boolean] if the term is completly after the passed date
     def after?(date)
+      return false if start.nil?
       return start > date.to_date
     end
 
     # Determine if the term is in the future
     # @return [Boolean] if the term starts after today
     def future?
+      return false if start.nil?
       return start > Date.today
     end
 
     # Determine if the term is in the past
     # @return [Boolean] if the term finished before today
     def past?
+      return false if finish.nil?
       return finish < Date.today
     end
 
     # Determine if the term is current
     # @return [Boolean] if the term started before today and finishes after today
     def current?
+      return false if start.nil?
+      return false if finish.nil?
       return (start <= Date.today) && (finish >= Date.today)
     end
 
@@ -219,6 +225,8 @@ module Osm
     # @param [Date] date The date to test
     # @return [Boolean] if the term started before the date and finishes after the date
     def contains_date?(date)
+      return false if start.nil?
+      return false if finish.nil?
       return (start <= date) && (finish >= date)
     end
 

data/spec/osm/api_spec.rb

@@ -25,6 +25,14 @@ describe "API" do
     expect{ Osm::Api.configure(@CONFIGURATION[:api].merge(:ogm => @CONFIGURATION[:api][:ogm].select{ |k,v| (k != :name)})) }.to raise_error(ArgumentError, ':ogm must contain a key :name')
   end
 
+  it "Exposes the debug option seperatly too" do
+    Osm::Api.debug.should be_false
+    Osm::Api.debug = true
+    Osm::Api.debug.should be_true
+    Osm::Api.debug = false
+    Osm::Api.debug.should be_false
+  end
+
 
   it "Raises errors on bad arguments to create" do
     # Both userid and secret must be passed

data/spec/osm/event_spec.rb

@@ -680,7 +680,6 @@ describe "Event" do
       FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/events.php?action=getEventAttendance&eventid=2&sectionid=1&termid=3", :body => attendance_body.to_json)
 
       event = Osm::Event.new(:id => 2, :section_id => 1)
-      event.should_not be_nil
       attendance = event.get_attendance(@api, 3)
       attendance.is_a?(Array).should be_true
       ea = attendance[0]
@@ -699,6 +698,19 @@ describe "Event" do
       ea.row.should == 0
     end
 
+    it "Get attendance (no items)" do
+      attendance_body = {
+	'identifier' => 'scoutid',
+	'eventid' => '2',
+      }
+
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/events.php?action=getEventAttendance&eventid=2&sectionid=1&termid=3", :body => attendance_body.to_json)
+
+      event = Osm::Event.new(:id => 2, :section_id => 1)
+      attendance = event.get_attendance(@api, 3)
+      attendance.should == []
+    end
+
     it "Update attendance (succeded)" do
       ea = Osm::Event::Attendance.new(:row => 0, :member_id => 4, :fields => {1 => 'old value', 2 => 'another old value'}, :event => Osm::Event.new(:id => 2, :section_id => 1))
 

data/spec/osm/term_spec.rb

@@ -108,6 +108,16 @@ describe "Term" do
     term3.contains_date?(Date.today).should == false
   end
 
+  it "Date helpers return false for nil dates" do
+    term = Osm::Term.new
+    term.before?(Date.today).should be_false
+    term.after?(Date.today).should be_false
+    term.past?.should be_false
+    term.future?.should be_false
+    term.current?.should be_false
+    term.contains_date?(Date.today).should be_false
+  end
+
 
   describe "Using the API" do
 

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-07 00:00:00.000000000 Z
+date: 2013-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport