osm 0.0.13 → 0.0.14

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Version 0.0.14
+
+  * Add :debug option to Api.configure
+  * -2 is a valid grouping\_id value
+  * Fix Api.get_register\_data\ returning wrong object
+  * Fix check of :num\_scouts in Section.initalize
+
 ## Version 0.0.13
 
   * Fix bug - invalid grouping\_leader in member incorrectly risen for -1

data/lib/osm/api.rb

@@ -20,6 +20,7 @@ module Osm
     @@user_access = Hash.new
     @@cache_prepend_to_key = 'OSMAPI'
     @@cache = nil
+    @@debug = false
 
     # Initialize a new API connection
     # If passing user details then both must be passed
@@ -47,6 +48,7 @@ module Osm
     # @option options [Class] :cache (optional) An instance of a cache class, must provide the methods (exist?, delete, write, read), for details see Rails.cache. Whilst this is optional you should remember that caching is required to use the OSM API.
     # @option options [Fixnum] :default_cache_ttl (optional, default = 30.minutes) The default TTL value for the cache, note that some items are cached for twice this time and others are cached for half this time (in seconds)
     # @option options [String] :cache_prepend_to_key (optional, default = 'OSMAPI') Text to prepend to the key used to store data in the cache
+    # @option options [Boolean] :debug if true debugging info is output (options, default = false)
     # @return nil
     def self.configure(options)
       raise ArgumentError, ':api_id does not exist in options hash' if options[:api_id].nil?
@@ -67,6 +69,7 @@ module Osm
       @@default_cache_ttl = options[:default_cache_ttl].to_i unless options[:default_cache_ttl].nil?
       @@cache_prepend_to_key = options[:cache_prepend_to_key].to_s unless options[:cache_prepend_to_key].nil?
       @@cache = options[:cache]
+      @@debug = !!options[:debug]
       nil
     end
 
@@ -489,12 +492,13 @@ module Osm
       data = perform_query("users.php?action=register&sectionid=#{section_id}&termid=#{term_id}", api_data)
 
       data = data['items']
+      to_return = []
       data.each do |item|
-        item = Osm::RegisterData.from_api(item)
+        to_return.push Osm::RegisterData.from_api(item)
       end
       self.user_can_access :register, section_id, api_data
       cache_write("register-#{section_id}-#{term_id}", data, :expires_in => @@default_cache_ttl/2)
-      return data
+      return to_return
     end
 
     # Create an evening in OSM
@@ -595,6 +599,11 @@ module Osm
         end
       end
 
+      if @@debug
+        puts "Making OSM API request to #{url}"
+        puts api_data.to_s
+      end
+
       begin
         result = HTTParty.post("#{@base_url}/#{url}", {:body => api_data})
       rescue SocketError, TimeoutError, OpenSSL::SSL::SSLError
@@ -602,6 +611,11 @@ module Osm
       end
       raise ConnectionError, "HTTP Status code was #{result.response.code}" if !result.response.code.eql?('200')
 
+      if @@debug
+        puts "Result from OSM request to #{url}"
+        puts result.response.body
+      end
+
       raise Error, result.response.body unless looks_like_json?(result.response.body)
       decoded = ActiveSupport::JSON.decode(result.response.body)
       osm_error = get_osm_error(decoded)

data/lib/osm/member.rb

@@ -68,9 +68,10 @@ module Osm
     # Initialize a new Member
     # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
     def initialize(attributes={})
-      [:id, :section_id, :grouping_id].each do |attribute|
+      [:id, :section_id].each do |attribute|
         raise ArgumentError, ":#{attribute} must be nil or a Fixnum > 0" unless attributes[attribute].nil? || (attributes[attribute].is_a?(Fixnum) && attributes[attribute] > 0)
       end
+      raise ArgumentError, ':grouping_id must be nil or a Fixnum >= -2' unless attributes[:grouping_id].nil? || (attributes[:grouping_id].is_a?(Fixnum) && attributes[:grouping_id] >= -2)
       [:joined_years, :grouping_leader].each do |attribute|
         raise ArgumentError, ":#{attribute} must be nil or a Fixnum >= -1" unless attributes[attribute].nil? || (attributes[attribute].is_a?(Fixnum) && attributes[attribute] >= -1)
       end

data/lib/osm/register_data.rb

@@ -21,9 +21,10 @@ module Osm
     # Initialize a new RegisterData
     # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
     def initialize(attributes={})
-      [:member_id, :grouping_id, :section_id].each do |attribute|
+      [:member_id, :section_id].each do |attribute|
         raise ArgumentError, ":#{attribute} must be nil or a Fixnum > 0" unless attributes[attribute].nil? || (attributes[attribute].is_a?(Fixnum) && attributes[attribute] > 0)
       end
+      raise ArgumentError, ':grouping_id must be nil or a Fixnum >= -2' unless attributes[:grouping_id].nil? || (attributes[:grouping_id].is_a?(Fixnum) && attributes[:grouping_id] >= -2)
       raise ArgumentError, ':total must be a Fixnum >= 0' unless (attributes[:total].is_a?(Fixnum) && attributes[:total] >= 0)
       [:first_name, :last_name].each do |attribute|
         raise ArgumentError, "#{attribute} must be nil or a String" unless attributes[attribute].nil? || attributes[attribute].is_a?(String)

data/lib/osm/section.rb

@@ -32,9 +32,10 @@ module Osm
     # Initialize a new Section
     # @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
     def initialize(attributes={})
+puts ":num_scouts = #{attributes[:num_scouts].inspect}"
       raise ArgumentError, ':id must be nil or a Fixnum > 0' unless attributes[:id].nil? || (attributes[:id].is_a?(Fixnum) && attributes[:id] > 0)
       raise ArgumentError, ':section_name must be nil or a String' unless attributes[:section_name].nil? || attributes[:section_name].is_a?(String)
-      raise ArgumentError, ':num_scouts must be nil or a Fixnum >= 0' unless attributes[:num_scouts].nil? || (attributes[:num_scouts].is_a?(Fixnum) && attributes[:num_scouts] > 0)
+      raise ArgumentError, ':num_scouts must be nil or a Fixnum >= 0' unless attributes[:num_scouts].nil? || (attributes[:num_scouts].is_a?(Fixnum) && attributes[:num_scouts] >= 0)
       [:column_names, :fields, :intouch_fields, :mobile_fields].each do |attribute|
         raise ArgumentError, ":#{attribute} must be nil or a Hash" unless attributes[attribute].nil? || attributes[attribute].is_a?(Hash)
       end

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-29 00:00:00.000000000Z
+date: 2012-08-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &88856060 !ruby/object:Gem::Requirement
+  requirement: &87769510 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *88856060
+  version_requirements: *87769510
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &88846770 !ruby/object:Gem::Requirement
+  requirement: &87769250 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *88846770
+  version_requirements: *87769250
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &88846430 !ruby/object:Gem::Requirement
+  requirement: &87768850 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *88846430
+  version_requirements: *87768850
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &88846130 !ruby/object:Gem::Requirement
+  requirement: &87768490 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *88846130
+  version_requirements: *87768490
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &88845870 !ruby/object:Gem::Requirement
+  requirement: &87768140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *88845870
+  version_requirements: *87768140
 description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
   to retrieve and save data.
 email: