osm 0.0.9 → 0.0.10

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Version 0.0.10
+
+  * Fix handling an empty array being returned from OSM for fields (presumably if not allowed to view)
+  * Fix undefined variable in id\_for\_term
+
 ## Version 0.0.9
 
   * Allow passing of Osm::Term objects as well as term IDs

data/lib/osm/activity.rb

@@ -64,10 +64,10 @@ module Osm
       @deletable = data['deletable'] ? true : false
       @used = data['used'].to_i
       @versions = data['versions']
-      @sections = Osm::make_array_of_symbols(data['sections'] || [])
-      @tags = data['tags'] || []
-      @files = data['files'] || []
-      @badges = data['badges'] || []
+      @sections = data['sections'].is_a?(Array) ? Osm::make_array_of_symbols(data['sections']) : []
+      @tags = data['tags'].is_a?(Array) ? data['tags'] : []
+      @files = data['files'].is_a?(Array) ? data['files'] : []
+      @badges = data['badges'].is_a?(Array) ? data['badges'] : []
 
       # Clean versions hashes
       @versions.each do |version|

data/lib/osm/api.rb

@@ -269,7 +269,7 @@ module Osm
     # @return [Array<Osm::Evening>]
     def get_programme(section, term, options={}, api_data={})
       section_id = id_for_section(section)
-      term_id = id_for_term(term)
+      term_id = id_for_term(term, section)
 
       if !options[:no_cache] && cache_exist?("programme-#{section_id}-#{term_id}") && self.user_can_access?(:programme, section_id, api_data)
         return cache_read("programme-#{section_id}-#{term_id}")
@@ -329,7 +329,7 @@ module Osm
     # @return [Array<Osm::Member>]
     def get_members(section, term=nil, options={}, api_data={})
       section_id = id_for_section(section)
-      term_id = id_for_term(term)
+      term_id = id_for_term(term, section)
 
       if !options[:no_cache] && cache_exist?("members-#{section_id}-#{term_id}") && self.user_can_access?(:member, section_id, api_data)
         return cache_read("members-#{section_id}-#{term_id}")
@@ -428,7 +428,7 @@ module Osm
     # @return [Osm::DueBadges]
     def get_due_badges(section, term=nil, options={}, api_data={})
       section_id = id_for_section(section)
-      term_id = id_for_term(term)
+      term_id = id_for_term(term, section)
 
       if !options[:no_cache] && cache_exist?("due_badges-#{section_id}-#{term_id}") && self.user_can_access?(:badge, section_id, api_data)
         return cache_read("due_badges-#{section_id}-#{term_id}")
@@ -452,7 +452,7 @@ module Osm
     # @return [Array<Hash>] representing the rows of the register
     def get_register_structure(section, term=nil, options={}, api_data={})
       section_id = id_for_section(section)
-      term_id = id_for_term(term)
+      term_id = id_for_term(term, section)
 
       if !options[:no_cache] && cache_exist?("register_structure-#{section_id}-#{term_id}") && self.user_can_access?(:register, section_id, api_data)
         return cache_read("register_structure-#{section_id}-#{term_id}")
@@ -480,7 +480,7 @@ module Osm
     # @return [Array<Hash>] representing the attendance of each member
     def get_register(section, term=nil, options={}, api_data={})
       section_id = id_for_section(section)
-      term_id = id_for_term(term)
+      term_id = id_for_term(term, section)
 
       if !options[:no_cache] && cache_exist?("register-#{section_id}-#{term_id}") && self.user_can_access?(:register, section_id, api_data)
         return cache_read("register-#{section_id}-#{term_id}")
@@ -651,17 +651,21 @@ module Osm
     # @param [String, Symbol] id_method the method to call on cl to get the ID
     # @return [Fixnum] the ID
     def id_for(cl, value, error_name, id_method=:id)
-      raise(ArgumentError, "Invalid type for #{error_name}") unless value.is_a?(cl) || value.is_a?(Fixnum)
-      id = value.is_a?(cl) ? value.send(id_method) : value
-      raise(ArgumentError, "Invalid #{error_name} ID") unless id > 0
-      return id
+      if value.is_a?(cl)
+        value = value.send(id_method)
+      else
+        raise(ArgumentError, "Invalid type for #{error_name}") unless value.is_a?(Fixnum)
+      end
+
+      raise(ArgumentError, "Invalid #{error_name} ID") unless value > 0
+      return value
     end
 
     def id_for_section(section)
       id_for(Osm::Section, section, 'section')
     end
-    def id_for_term(term)
-      return term.nil? ? Osm::find_current_term_id(self, section_id, api_data) : id_for(Osm::Term, term, 'term')
+    def id_for_term(term, section)
+      return term.nil? ? Osm::find_current_term_id(self, id_for_section(section), api_data) : id_for(Osm::Term, term, 'term')
     end
 
   end

data/lib/osm/api_access.rb

@@ -15,7 +15,7 @@ module Osm
     def initialize(data)
       @id = data['apiid'].to_i
       @name = data['name']
-      @permissions = data['permissions'] || {}
+      @permissions = data['permissions'].is_a?(Hash) ? data['permissions'] : {}
 
       # Rubyfy permissions hash
       @permissions.keys.each do |key|

data/lib/osm/due_badges.rb

@@ -8,15 +8,15 @@ module Osm
     # @!attribute [r] by_member
     #   @return [Hash] the due badges grouped by member
     # @!attribute [r] totals
-    #   @return [Hash] the total number of each nadge which is due
+    #   @return [Hash] the total number of each badge which is due
 
     # Initialize a new Event using the hash returned by the API call
     # @param data the hash of data for the object returned by the API
     def initialize(data)
       data = {} unless data.is_a?(Hash)
 
-      @pending = Osm::symbolize_hash(data['pending'] || {})
-      @descriptions = Osm::symbolize_hash(data['description'] || {})
+      @pending = data['pending'].is_a?(Hash) ? Osm::symbolize_hash(data['pending']) : {}
+      @descriptions = data['description'].is_a?(Hash) ? Osm::symbolize_hash(data['description']) : {}
 
       @pending.each_key do |key|
         @pending[key].each_with_index do |item, index|

data/lib/osm/role.rb

@@ -18,7 +18,7 @@ module Osm
       @section = Osm::Section.new(data['sectionid'], data['sectionname'], ActiveSupport::JSON.decode(data['sectionConfig']), self)
       @group_name = data['groupname']
       @group_id = Osm::to_i_or_nil(data['groupid'])
-      @permissions = Osm::symbolize_hash(data['permissions'] || {})
+      @permissions = data['permissions'].is_a?(Hash) ? Osm::symbolize_hash(data['permissions']) : {}
 
       # Convert permission values to a number
       @permissions.each_key do |key|

data/lib/osm/section.rb

@@ -44,11 +44,11 @@ module Osm
       @subscription_expires = data['subscription_expires'] ? Date.parse(data['subscription_expires'], 'yyyy-mm-dd') : nil
       @type = !data['sectionType'].nil? ? data['sectionType'].to_sym : :unknown
       @num_scouts = data['numscouts']
-      @column_names = Osm::symbolize_hash(data['columnNames'] || {})
-      @fields = Osm::symbolize_hash(data['fields'] || {})
-      @intouch_fields = Osm::symbolize_hash(data['intouch'] || {})
-      @mobile_fields = Osm::symbolize_hash(data['mobFields'] || {})
-      @extra_records = data['extraRecords'] || []
+      @column_names = data['columnNames'].is_a?(Hash) ? Osm::symbolize_hash(data['columnNames']) : {}
+      @fields = data['fields'].is_a?(Hash) ? Osm::symbolize_hash(data['fields']) : {}
+      @intouch_fields = data['intouch'].is_a?(Hash) ? Osm::symbolize_hash(data['intouch']) : {}
+      @mobile_fields = data['mobFields'].is_a?(Hash) ? Osm::symbolize_hash(data['mobFields']) : {}
+      @extra_records = data['extraRecords'].is_a?(Array) ? data['extraRecords'] : []
       @role = role
 
       # Symbolise the keys in each hash of the extra_records array

data/spec/osm/api_strangeness_spec.rb

@@ -45,4 +45,12 @@ describe "Online Scout Manager API Strangeness" do
     @api.get_events(1).should == []
   end
 
+
+  it "handles a section config where fields is an empty array" do
+    body = '[{"sectionConfig":"{\"subscription_level\":3,\"subscription_expires\":\"2013-01-05\",\"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\":[{\"name\":\"Subs\",\"extraid\":\"529\"}],\"wizard\":\"false\",\"fields\":[],\"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":"1","sectionname":"Section 1","section":"cubs","isDefault":"1","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)
+
+    @api.get_section(1).fields.should == {}
+
+  end
 end

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-08-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &85718650 !ruby/object:Gem::Requirement
+  requirement: &81097930 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *85718650
+  version_requirements: *81097930
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &85718390 !ruby/object:Gem::Requirement
+  requirement: &81097720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *85718390
+  version_requirements: *81097720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &85718050 !ruby/object:Gem::Requirement
+  requirement: &81097480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *85718050
+  version_requirements: *81097480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &85715520 !ruby/object:Gem::Requirement
+  requirement: &81097190 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *85715520
+  version_requirements: *81097190
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &85714410 !ruby/object:Gem::Requirement
+  requirement: &81083410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *85714410
+  version_requirements: *81083410
 description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
   to retrieve and save data.
 email: