osm 0.1.3 → 0.1.4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Version 0.1.4
+
+  * Osm::Model has new class method get\_user\_permission(api, section_id, permission)
+  * API may return permissions value as a string not integer
+
 ## Version 0.1.3
 
   * Add get\_badge\_stock(api) to section

data/lib/osm/due_badges.rb

@@ -39,7 +39,7 @@ module Osm
       term_id = (term.nil? ? Osm::Term.get_current_term_for_section(api, section, options) : term).to_i
       cache_key = ['due_badges', section.id, term_id]
 
-      if !options[:no_cache] && cache_exist?(api, cache_key) && get_user_permissions(api, section.id)[:badge].include?(:read)
+      if !options[:no_cache] && cache_exist?(api, cache_key) && get_user_permission(api, section.id, :badge).include?(:read)
         return cache_read(api, cache_key)
       end
 

data/lib/osm/evening.rb

@@ -68,7 +68,7 @@ module Osm
       term_id = term.nil? ? Osm::Term.get_current_term_for_section(api, section).id : term.to_i
       cache_key = ['programme', section_id, term_id]
 
-      if !options[:no_cache] && cache_exist?(api, cache_key) && get_user_permissions(api, section_id)[:programme].include?(:read)
+      if !options[:no_cache] && cache_exist?(api, cache_key) && get_user_permission(api, section_id, :programme).include?(:read)
         return cache_read(api, cache_key)
       end
 
@@ -186,7 +186,7 @@ module Osm
       section = Osm::Section.get(api, section_id)
       cache_key = ['badge_requirements', section.id, id]
 
-      if !options[:no_cache] && self.class.cache_exist?(api, cache_key) && get_user_permissions(api, section_id)[:programme].include?(:read)
+      if !options[:no_cache] && self.class.cache_exist?(api, cache_key) && get_user_permission(api, section_id, :programme).include?(:read)
         return self.class.cache_read(api, cache_key)
       end
 

data/lib/osm/event.rb

@@ -58,7 +58,7 @@ module Osm
       cache_key = ['events', section_id]
       events = nil
 
-      if !options[:no_cache] && cache_exist?(api, cache_key) && get_user_permissions(api, section_id)[:events].include?(:read)
+      if !options[:no_cache] && cache_exist?(api, cache_key) && get_user_permission(api, section_id, :events).include?(:read)
         return cache_read(api, cache_key)
       end
 
@@ -109,7 +109,7 @@ module Osm
       section_id = section.to_i
       cache_key = ['event', event_id]
 
-      if !options[:no_cache] && cache_exist?(api, cache_key) && get_user_permissions(api, section_id)[:events].include?(:read)
+      if !options[:no_cache] && cache_exist?(api, cache_key) && get_user_permission(api, section_id, :events).include?(:read)
         return cache_read(api, cache_key)
       end
 
@@ -130,7 +130,7 @@ module Osm
     def self.create(api, parameters)
       event = new(parameters)
       raise ObjectIsInvalid, 'event is invalid' unless event.valid?
-      raise Forbidden, 'you do not have permission to write to events for this section' unless get_user_permissions(api, event.section_id)[:events].include?(:write)
+      raise Forbidden, 'you do not have permission to write to events for this section' unless get_user_permission(api, event.section_id, :events).include?(:write)
 
       data = api.perform_query("events.php?action=addEvent&sectionid=#{event.section_id}", {
         'name' => event.name,
@@ -159,7 +159,7 @@ module Osm
     # @param [Osm::Api] api The api to use to make the request
     # @return [Boolean] wether the update succedded
     def update(api)
-      raise Forbidden, 'you do not have permission to write to events for this section' unless self.class.get_user_permissions(api, section_id)[:events].include?(:write)
+      raise Forbidden, 'you do not have permission to write to events for this section' unless self.class.get_user_permission(api, section_id, :events).include?(:write)
 
       data = api.perform_query("events.php?action=addEvent&sectionid=#{section_id}", {
         'eventid' => id,
@@ -184,7 +184,7 @@ module Osm
     # @param [Osm::Api] api The api to use to make the request
     # @return [Boolean] wether the delete succedded
     def delete(api)
-      raise Forbidden, 'you do not have permission to write to events for this section' unless self.class.get_user_permissions(api, section_id)[:events].include?(:write)
+      raise Forbidden, 'you do not have permission to write to events for this section' unless self.class.get_user_permission(api, section_id, :events).include?(:write)
 
       data = api.perform_query("events.php?action=deleteEvent&sectionid=#{section_id}&eventid=#{id}")
 
@@ -206,7 +206,7 @@ module Osm
       term_id = term.nil? ? Osm::Term.get_current_term_for_section(api, section).id : term.to_i
       cache_key = ['event_attendance', id]
 
-      if !options[:no_cache] && self.class.cache_exist?(api, cache_key) && self.class.get_user_permissions(api, section_id)[:events].include?(:read)
+      if !options[:no_cache] && self.class.cache_exist?(api, cache_key) && self.class.get_user_permission(api, section_id, :events).include?(:read)
         return self.class.cache_read(api, cache_key)
       end
 
@@ -242,7 +242,7 @@ module Osm
     # @return [Boolean] wether the update succedded
     def add_field(api, label)
       raise ArgumentIsInvalid, 'label is invalid' if label.blank?
-      raise Forbidden, 'you do not have permission to write to events for this section' unless self.class.get_user_permissions(api, section_id)[:events].include?(:write)
+      raise Forbidden, 'you do not have permission to write to events for this section' unless self.class.get_user_permission(api, section_id, :events).include?(:write)
 
       data = api.perform_query("events.php?action=addColumn&sectionid=#{section_id}&eventid=#{id}", {
         'columnName' => label
@@ -299,7 +299,7 @@ module Osm
       # @return [Boolean] if the operation suceeded or not
       def update(api, field_id)
         raise ArgumentIsInvalid, 'field_id is invalid' unless field_id.match(/\Af_\d+\Z/) || field_id.eql?('attending')
-        raise Forbidden, 'you do not have permission to write to events for this section' unless Osm::Model.get_user_permissions(api, event.section_id)[:events].include?(:write)
+        raise Forbidden, 'you do not have permission to write to events for this section' unless Osm::Model.get_user_permission(api, event.section_id, :events).include?(:write)
 
         data = api.perform_query("events.php?action=updateScout", {
           'scoutid' => member_id,

data/lib/osm/flexi_record.rb

@@ -12,7 +12,7 @@ module Osm
       section_id = section.to_i
       cache_key = ['flexi_record_fields', id]
 
-      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key) && Osm::Model.get_user_permissions(api, section_id)[:flexi].include?(:read)
+      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key) && Osm::Model.get_user_permission(api, section_id, :flexi).include?(:read)
         return Osm::Model.cache_read(api, cache_key)
       end
 
@@ -45,7 +45,7 @@ module Osm
       term_id = term.nil? ? Osm::Term.get_current_term_for_section(api, section).id : term.to_i
       cache_key = ['flexi_record_data', id, term_id]
 
-      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key) && Osm::Model.get_user_permissions(api, section.id)[:flexi].include?(:read)
+      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key) && Osm::Model.get_user_permission(api, section.id, :flexi).include?(:read)
         return Osm::Model.cache_read(api, cache_key)
       end
 

data/lib/osm/member.rb

@@ -152,7 +152,7 @@ module Osm
       section_id = section.to_i
       cache_key = ['members', section_id, term_id]
 
-      if !options[:no_cache] && cache_exist?(api, cache_key) && get_user_permissions(api, section_id)[:member].include?(:read)
+      if !options[:no_cache] && cache_exist?(api, cache_key) && get_user_permission(api, section_id, :member).include?(:read)
         return cache_read(api, cache_key)
       end
 

data/lib/osm/model.rb

@@ -75,7 +75,19 @@ module Osm
     def self.get_user_permissions(api, section_id=nil, options={})
       key = ['permissions', api.user_id]
       permissions = (!options[:no_cache] && cache_exist?(api, key)) ? cache_read(api, key) : Osm::Section.fetch_user_permissions(api)
-      return section_id.nil? ? permissions : (permissions[section_id] || {})
+      permissions ||= {}
+      return section_id.nil? ? (permissions || {}) : (permissions[section_id] || {})
+    end
+
+    # Get an access permission for an API user
+    # @param [Osm::Api] The api to use to make the request
+    # @param [Fixnum, nil] section_id to get permissions for, if nil a Hash of all section's permissions is returned
+    # @param [Symbol] permission
+    # @!macro options_get
+    # @return [Array<Symbol>] the actions the user can perform for the provided permission
+    def self.get_user_permission(api, section_id, permission, options={})
+      permissions = get_user_permissions(api, section_id, options)[permission]
+      return (permissions || [])
     end
 
     # Set access permission for an API user

data/lib/osm/register.rb

@@ -13,7 +13,7 @@ module Osm
       term_id = term.nil? ? Osm::Term.get_current_term_for_section(api, section).id : term.to_i
       cache_key = ['register_structure', section_id, term_id]
 
-      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key) && Osm::Model.get_user_permissions(api, section_id)[:register].include?(:read)
+      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key) && Osm::Model.get_user_permission(api, section_id, :register).include?(:read)
         return Osm::Model.cache_read(api, cache_key)
       end
 
@@ -45,7 +45,7 @@ module Osm
       term_id = term.nil? ? Osm::Term.get_current_term_for_section(api, section).id : term.to_i
       cache_key = ['register_attendance', section_id, term_id]
 
-      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key) && Osm::Model.get_user_permissions(api, section_id)[:register].include?(:read)
+      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key) && Osm::Model.get_user_permission(api, section_id, :register).include?(:read)
         return Osm::Model.cache_read(api, cache_key)
       end
 

data/lib/osm/section.rb

@@ -217,7 +217,7 @@ module Osm
       term_id = term.nil? ? Osm::Term.get_current_term_for_section(api, self).id : term.to_i
       cache_key = ['badge_stock', id, term_id]
 
-      if !options[:no_cache] && self.class.cache_exist?(api, cache_key) && self.class.get_user_permissions(api, self)[:badge].include?(:read)
+      if !options[:no_cache] && self.class.cache_exist?(api, cache_key) && self.class.get_user_permission(api, self, :badge).include?(:read)
         return self.class.cache_read(api, cache_key)
       end
 
@@ -296,7 +296,7 @@ module Osm
       }
 
       return permissions.inject({}) do |new_hash, (key, value)|
-        new_hash[key.to_sym] = (permissions_map[value] || [])
+        new_hash[key.to_sym] = (permissions_map[value.to_i] || [])
         new_hash
       end
     end

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-22 00:00:00.000000000Z
+date: 2012-10-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &78033570 !ruby/object:Gem::Requirement
+  requirement: &78318930 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *78033570
+  version_requirements: *78318930
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &78033180 !ruby/object:Gem::Requirement
+  requirement: &78318540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *78033180
+  version_requirements: *78318540
 - !ruby/object:Gem::Dependency
   name: active_attr
-  requirement: &78032730 !ruby/object:Gem::Requirement
+  requirement: &78318210 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *78032730
+  version_requirements: *78318210
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &78032450 !ruby/object:Gem::Requirement
+  requirement: &78317870 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *78032450
+  version_requirements: *78317870
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &78032090 !ruby/object:Gem::Requirement
+  requirement: &78317510 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *78032090
+  version_requirements: *78317510
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &78031770 !ruby/object:Gem::Requirement
+  requirement: &78317150 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *78031770
+  version_requirements: *78317150
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &78031150 !ruby/object:Gem::Requirement
+  requirement: &78316920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *78031150
+  version_requirements: *78316920
 description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
   to retrieve and save data.
 email:
@@ -149,18 +149,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -198994829
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -198994829
 requirements: []
 rubyforge_project: osm
 rubygems_version: 1.8.10
@@ -168,3 +162,4 @@ signing_key:
 specification_version: 3
 summary: Use the Online Scout Manager API
 test_files: []
+has_rdoc: