osm 1.2.3 → 1.2.4

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
 branches:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Version 1.2.4
+
+  * Remove support for ruby 1.9.2 (listen gem requires >= 1.9.3)
+  * Activity's get\_badge\_requirements method now will iterate through activities if there's no permission to use the existing one OSM query trick
+  * Fix exception when OSM returns a number (instead of a string) for total/completed columns of a flexi record
+
 ## Version 1.2.3
 
   * Fix bug determining if a badge has been earnt (-1 sections required = all required)

data/README.md

@@ -15,7 +15,6 @@ Staging [![Build Status](https://secure.travis-ci.org/robertgauld/osm.png?branch
 ## Ruby Versions
 This gem supports the following versions of ruby, it may work on other versions but is not tested against them so don't rely on it.
 
-  * 1.9.2
   * 1.9.3
   * 2.0.0
 

data/lib/osm/flexi_record.rb

@@ -98,8 +98,8 @@ module Osm
           }
           fields.merge!(
             'dob' => item['dob'].empty? ? nil : item['dob'],
-            'total' => item['total'].empty? ? nil : item['total'],
-            'completed' => item['completed'].empty? ? nil : item['completed'],
+            'total' => item['total'].to_s.empty? ? nil : item['total'],
+            'completed' => item['completed'].to_s.empty? ? nil : item['completed'],
             'age' => item['age'].empty? ? nil : item['age'],
           )
   

data/lib/osm/meeting.rb

@@ -253,22 +253,47 @@ module Osm
 
 
     # Get the badge requirements met on a specific meeting
+    # Requires either write permission to badges (prefered as it's one OSM query)
+    # or read permission to programme.
     # @param [Osm::Api] api The api to use to make the request
     # @!macro options_get
     # @return [Array<Hash>] hashes ready to pass into the update_register method
+    # @return [nil] if something went wrong
     def get_badge_requirements(api, options={})
-      require_ability_to(api, :read, :programme, section_id, options)
       section = Osm::Section.get(api, section_id)
       cache_key = ['badge_requirements', section.id, id]
-
       if !options[:no_cache] && cache_exist?(api, cache_key)
         return cache_read(api, cache_key)
       end
+      badges = nil
+
+      if user_has_permission?(api, :write, :badge, section_id, options)
+        # We can shortcut and do it in one query
+        badges = api.perform_query("users.php?action=getActivityRequirements&date=#{date.strftime(Osm::OSM_DATE_FORMAT)}&sectionid=#{section.id}&section=#{section.type}")
 
-      data = api.perform_query("users.php?action=getActivityRequirements&date=#{date.strftime(Osm::OSM_DATE_FORMAT)}&sectionid=#{section.id}&section=#{section.type}")
+      else
+        # We'll have to iterate through the activities
+        require_ability_to(api, :read, :programme, section_id, options)
+        badges = []
+        activities.each do |activity|
+          activity = Osm::Activity.get(api, activity.activity_id, nil, options)
+          activity.badges.each do |badge|
+            badges.push ({
+              'name' => badge.label,
+              'badgeName' => badge.badge,
+              'sectionid' => section_id.to_s,
+              'eveningid' => id.to_s,
+              'section' => badge.section_type,
+              'badgetype' => badge.type,
+              'badge' => badge.badge,
+              'columnname' => badge.requirement,
+            })
+          end
+        end
+      end
 
-      cache_write(api, cache_key, data)
-      return data
+      cache_write(api, cache_key, badges) unless badges.nil?
+      return badges
     end
 
     # Compare Meeting based on section_id, date, start_time then id

data/lib/osm/model.rb

@@ -131,28 +131,61 @@ module Osm
       api.get_user_permissions(options).keys.include?(section.to_i)
     end
 
-    # Raise an exception if the user does not have the relevant permission
+    # Check if the user has the relevant permission
     # @param [Osm::Api] api The api to use to make the request
     # @param [Symbol] to What action is required to be done (e.g. :read or :write)
     # @param [Symbol] on What the OSM permission is required on (e.g. :member or :programme)
     # @param [Osm::Section, Fixnum, #to_i] section The Section (or its ID) the permission is required on
     # @!macro options_get
-    # @raise [Osm::Forbidden] If the Api user does not have the required permission
-    def self.require_permission(api, to, on, section, options={})
-      section_id = section.to_i
+    def self.has_permission?(api, to, on, section, options={})
+      user_has_permission(api, to, on, section, options) && api_has_permission(api, to, on, section, options)
+    end
 
-      # Check user's permissions in OSM
+    # Check if the user has the relevant permission within OSM
+    # @param [Osm::Api] api The api to use to make the request
+    # @param [Symbol] to What action is required to be done (e.g. :read or :write)
+    # @param [Symbol] on What the OSM permission is required on (e.g. :member or :programme)
+    # @param [Osm::Section, Fixnum, #to_i] section The Section (or its ID) the permission is required on
+    # @!macro options_get
+    def self.user_has_permission?(api, to, on, section, options={})
+      section_id = section.to_i
       permissions = api.get_user_permissions(options)
       permissions = permissions[section_id] || {}
       permissions = permissions[on] || []
       unless permissions.include?(to)
-        raise Osm::Forbidden, "Your OSM user does not have permission to #{to} on #{on} for #{Osm::Section.get(api, section_id, options).try(:name)}"
+        return false
       end
+      return true
+    end
 
-      # Check what the user gave our API
+    # Check if the user has granted the relevant permission to the API
+    # @param [Osm::Api] api The api to use to make the request
+    # @param [Symbol] to What action is required to be done (e.g. :read or :write)
+    # @param [Symbol] on What the OSM permission is required on (e.g. :member or :programme)
+    # @param [Osm::Section, Fixnum, #to_i] section The Section (or its ID) the permission is required on
+    # @!macro options_get
+    def self.api_has_permission?(api, to, on, section, options={})
+      section_id = section.to_i
       permissions = Osm::ApiAccess.get_ours(api, section_id, options).permissions
       permissions = permissions[on] || []
       unless permissions.include?(to)
+        return false
+      end
+      return true
+    end
+
+    # Raise an exception if the user does not have the relevant permission
+    # @param [Osm::Api] api The api to use to make the request
+    # @param [Symbol] to What action is required to be done (e.g. :read or :write)
+    # @param [Symbol] on What the OSM permission is required on (e.g. :member or :programme)
+    # @param [Osm::Section, Fixnum, #to_i] section The Section (or its ID) the permission is required on
+    # @!macro options_get
+    # @raise [Osm::Forbidden] If the Api user does not have the required permission
+    def self.require_permission(api, to, on, section, options={})
+      unless user_has_permission?(api, to, on, section, options)
+        raise Osm::Forbidden, "Your OSM user does not have permission to #{to} on #{on} for #{Osm::Section.get(api, section_id, options).try(:name)}"
+      end
+      unless api_has_permission?(api, to, on, section, options)
         raise Osm::Forbidden, "You have not granted the #{to} permissions on #{on} to the #{api.api_name} API for #{Osm::Section.get(api, section_id, options).try(:name)}"
       end
     end
@@ -229,7 +262,8 @@ module Osm
     # Make selected class methods instance methods too
     %w{
       cache_read cache_write cache_exist? cache_delete require_access_to_section
-      can_access_section? require_permission require_subscription require_ability_to
+      can_access_section? has_permission? user_has_permission? api_has_permission?
+      require_permission require_subscription require_ability_to
     }.each do |method_name|
       define_method method_name do |*options|
         self.class.send(method_name, *options)

data/spec/osm/flexi_record_spec.rb

@@ -531,4 +531,37 @@ describe "Flexi Record" do
 
   end
 
+  describe "API Strangeness" do
+
+    it "Calculated columns containing numbers not strings" do
+      data = {
+        'identifier' => 'scoutid',
+        'label' => "name",
+        'items' => [{
+          "scoutid" => "1",
+          "firstname" => "First",
+          "lastname" => "Last",
+          "dob" => "",
+          "patrolid" => "2",
+          "total" => 3,
+          "completed" => 4,
+          "f_1" => "A",
+          "f_2" => "B",
+          "age" => "",
+          "patrol" => "Green"
+        }]
+      }
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/extras.php?action=getExtraRecords&sectionid=1&extraid=2&termid=3&section=cubs", :body => data.to_json, :content_type => 'application/json')
+      Osm::Section.stub(:get) { Osm::Section.new(:id => 1, :type => :cubs) }
+
+      flexi_record = Osm::FlexiRecord.new(:section_id => 1, :id => 2, :name => 'A Flexi Record')
+      records = flexi_record.get_data(@api, 3)
+      record = records[0]
+      record.fields['total'].should == 3
+      record.fields['completed'].should == 4
+    end
+
+  end
+
 end
+

data/spec/osm/meeting_spec.rb

@@ -156,11 +156,11 @@ describe "Meeting" do
       badge_link.label.should == 'Cubs Artist Activity - A: Poster'
     end
 
-    it "Fetch badge requirements for a meeting" do
+    it "Fetch badge requirements for a meeting (from API)" do
       badges_body = [{'a'=>'a'},{'a'=>'A'}]
       FakeWeb.register_uri(:post, 'https://www.onlinescoutmanager.co.uk/users.php?action=getActivityRequirements&date=2000-01-02&sectionid=3&section=cubs', :body => badges_body.to_json, :content_type => 'application/json')
       roles_body = [
-        {"sectionConfig"=>"{\"subscription_level\":1,\"subscription_expires\":\"2013-01-05\",\"sectionType\":\"cubs\",\"columnNames\":{\"column_names\":\"names\"},\"numscouts\":10,\"hasUsedBadgeRecords\":true,\"hasProgramme\":true,\"extraRecords\":[],\"wizard\":\"false\",\"fields\":{\"fields\":true},\"intouch\":{\"intouch_fields\":true},\"mobFields\":{\"mobile_fields\":true}}", "groupname"=>"3rd Somewhere", "groupid"=>"3", "groupNormalised"=>"1", "sectionid"=>"3", "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\":1,\"subscription_expires\":\"2013-01-05\",\"sectionType\":\"cubs\",\"columnNames\":{\"column_names\":\"names\"},\"numscouts\":10,\"hasUsedBadgeRecords\":true,\"hasProgramme\":true,\"extraRecords\":[],\"wizard\":\"false\",\"fields\":{\"fields\":true},\"intouch\":{\"intouch_fields\":true},\"mobFields\":{\"mobile_fields\":true}}", "groupname"=>"3rd Somewhere", "groupid"=>"3", "groupNormalised"=>"1", "sectionid"=>"3", "sectionname"=>"Section 1", "section"=>"beavers", "isDefault"=>"1", "permissions"=>{"badge"=>100, "member"=>20, "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 => roles_body.to_json, :content_type => 'application/json')
 
@@ -168,6 +168,67 @@ describe "Meeting" do
       meeting.get_badge_requirements(@api).should == badges_body
     end
 
+    it "Fetch badge requirements for a meeting (iterating through activities)" do
+      roles_body = [
+        {"sectionConfig"=>"{\"subscription_level\":1,\"subscription_expires\":\"2013-01-05\",\"sectionType\":\"cubs\",\"columnNames\":{\"column_names\":\"names\"},\"numscouts\":10,\"hasUsedBadgeRecords\":true,\"hasProgramme\":true,\"extraRecords\":[],\"wizard\":\"false\",\"fields\":{\"fields\":true},\"intouch\":{\"intouch_fields\":true},\"mobFields\":{\"mobile_fields\":true}}", "groupname"=>"3rd Somewhere", "groupid"=>"3", "groupNormalised"=>"1", "sectionid"=>"3", "sectionname"=>"Section 1", "section"=>"beavers", "isDefault"=>"1", "permissions"=>{"badge"=>10, "member"=>20, "user"=>100, "register"=>100, "contact"=>100, "programme"=>10, "originator"=>1, "events"=>100, "finance"=>100, "flexi"=>100}},
+      ]
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/api.php?action=getUserRoles", :body => roles_body.to_json, :content_type => 'application/json')
+
+      activity_body = {
+        'details' => {
+          'activityid' => '4',
+          'version' => '0',
+          'groupid' => '2',
+          'userid' => '3',
+          'title' => 'Activity Name',
+          'description' => 'Description',
+          'resources' => 'Resources',
+          'instructions' => 'Instructions',
+          'runningtime' => '15',
+          'location' => 'indoors',
+          'shared' => '0',
+          'rating' => '4',
+          'facebook' => ''
+        },
+        'editable' => true,
+        'deletable' => false,
+        'used' => 3,
+        'versions' => [
+          {
+            'value' => '0',
+            'userid' => '1',
+            'firstname' => 'Alice',
+            'label' => 'Current version - Alice',
+            'selected' => 'selected'
+          }
+        ],
+        'sections' => ['beavers', 'cubs'],
+        'tags' => ['Tag 1', 'Tag2'],
+        'files' => [
+          {
+            'fileid' => '6',
+            'activityid' => '4',
+            'filename' => 'File Name',
+            'name' => 'Name',
+          }
+        ],
+        'badges' => [
+          {
+            'activityid' => '4',
+            'section' => 'section',
+            'badgetype' => 'type',
+            'badge' => 'badge',
+            'columnname' => 'col_name',
+            'label' => 'This is a label',
+          }
+        ]
+      }
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/programme.php?action=getActivity&id=4", :body => activity_body.to_json, :content_type => 'application/json')
+  
+      meeting = Osm::Meeting.new(:id => 2, :date => Date.new(2000, 1, 2), :section_id => 3, :activities=>[Osm::Meeting::Activity.new(:activity_id => 4)])
+      meeting.get_badge_requirements(@api).should == [{"name"=>"This is a label", "badgeName"=>"badge", "sectionid"=>"3", "eveningid"=>"2", "section"=>:section, "badgetype"=>:type, "badge"=>"badge", "columnname"=>"col_name"}]
+    end
+
     it "Create a meeting (succeded)" do
       url = 'https://www.onlinescoutmanager.co.uk/programme.php?action=addActivityToProgramme'
       post_data = {
@@ -303,4 +364,4 @@ describe "Meeting" do
     end
 
   end
-end
+end

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-28 00:00:00.000000000 Z
+date: 2014-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport