osm 0.1.17 → 0.2.0

data/lib/osm/term.rb

@@ -36,12 +36,14 @@ module Osm
       cache_key = ['terms', api.user_id]
 
       if !options[:no_cache] && cache_exist?(api, cache_key)
-        return cache_read(api, cache_key)
+        ids = cache_read(api, cache_key)
+        return get_from_ids(api, ids, 'term', options, :get_all)
       end
 
       data = api.perform_query('api.php?action=getTerms')
 
-      result = Array.new
+      terms = Array.new
+      ids = Array.new
       data.each_key do |key|
         data[key].each do |term_data|
           term = Osm::Term.new(
@@ -51,37 +53,39 @@ module Osm
             :start => Osm::parse_date(term_data['startdate']),
             :finish => Osm::parse_date(term_data['enddate']),
           )
-          result.push term
+          terms.push term
+          ids.push term.id
           cache_write(api, ['term', term.id], term)
         end
       end
 
-      cache_write(api, cache_key, result)
-      return result
+      cache_write(api, cache_key, ids)
+      return terms
     end
 
     # Get the terms that the OSM user can access for a given section
     # @param [Osm::Api] api The api to use to make the request
-    # @param [Fixnum] section the section (or its ID) of the section to get terms for
+    # @param [Fixnum] section The section (or its ID) of the section to get terms for
     # @!macro options_get
     # @return [Array<Osm::Term>, nil] An array of terms or nil if the user can not access that section
     def self.get_for_section(api, section, options={})
+      require_access_to_section(api, section, options)
       section_id = section.to_i
-      return nil unless get_user_permissions(api).keys.include?(section_id)
       return get_all(api, options).select{ |term| term.section_id == section_id }
     end
 
     # Get a term
-    # @param [Osm::Api] The api to use to make the request
-    # @param [Fixnum] term_id the id of the required term
+    # @param [Osm::Api] api The api to use to make the request
+    # @param [Fixnum] term_id The id of the required term
     # @!macro options_get
     # @return nil if an error occured or the user does not have access to that term
-    # @return [Osm::Section]
+    # @return [Osm::Term]
     def self.get(api, term_id, options={})
       cache_key = ['term', term_id]
 
       if !options[:no_cache] && cache_exist?(api, cache_key)
-        return cache_read(api, cache_key)
+        term = cache_read(api, cache_key)
+        return term if can_access_section?(api, term.section_id, options)
       end
 
       terms = get_all(api, options)
@@ -89,7 +93,7 @@ module Osm
 
       terms.each do |term|
         if term.id == term_id
-          return (get_user_permissions(api).keys.include?(term.section_id) ? term : nil)
+          return (can_access_section?(api, term.section_id, options) ? term : nil)
         end
       end
       return nil
@@ -97,9 +101,10 @@ module Osm
 
     # Get the current term for a given section
     # @param [Osm::Api] api The api to use to make the request
-    # @param [Osm::Section, Fixnum] section The section (or its ID)  to get terms for
-    # @!macro options_get
+    # @param [Osm::Section, Fixnum, #to_i] section The section (or its ID)  to get terms for
+    # @!macro options_get 
     # @return [Osm::Term, nil] The current term or nil if the user can not access that section
+    # @raise [Osm::Error] If the term doesn't have a Term which is current
     def self.get_current_term_for_section(api, section, options={})
       section_id = section.to_i
       terms = get_for_section(api, section_id, options)
@@ -109,7 +114,7 @@ module Osm
         return term if term.current?
       end
 
-      raise Error, 'There is no current term for the section.'
+      raise Osm::Error, 'There is no current term for the section.'
     end
 
     # Create a term in OSM
@@ -125,6 +130,7 @@ module Osm
       raise ArgumentError, ":name can't be nil" if options[:name].nil?
       raise ArgumentError, ":start can't be nil" if options[:start].nil?
       raise ArgumentError, ":finish can't be nil" if options[:finish].nil?
+      require_access_to_section(api, options[:section])
 
       api_data = {
         'term' => options[:name],
@@ -146,10 +152,12 @@ module Osm
 
 
     # Update a term in OSM
-    # @param [Osm::Api] The api to use to make the request
+    # @param [Osm::Api] api The api to use to make the request
     # @return [Boolean] if the operation suceeded or not
+    # @raise [Osm::ObjectIsInvalid] If the Term is invalid
     def update(api)
-      raise ObjectIsInvalid, 'term is invalid' unless valid?
+      raise Osm::ObjectIsInvalid, 'term is invalid' unless valid?
+      require_access_to_section(api, section_id)
 
       data = api.perform_query("users.php?action=addTerm&sectionid=#{section_id}", {
         'term' => name,
@@ -158,18 +166,21 @@ module Osm
         'termid' => id
       })
 
-      # The cached terms for the section will be out of date - remove them
-      cache_delete(api, ['term', id])
-      cache_delete(api, ['terms', api.user_id])
-
-      return data.is_a?(Hash) && data['terms'].is_a?(Hash)
+      if data.is_a?(Hash) && data['terms'].is_a?(Hash)
+        reset_changed_attributes
+        # The cached term will be out of date - remove it
+        cache_delete(api, ['term', id])
+        return true
+      else
+        return false
+      end
     end
 
 
 
     # @!method initialize
     #   Initialize a new Term
-    #   @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+    #   @param [Hash] attributes The hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
 
 
     # Determine if the term is completly before the passed date
@@ -205,7 +216,7 @@ module Osm
     end
 
     # Determine if the provided date is within the term
-    # @param [Date] date the date to test
+    # @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 (start <= date) && (finish >= date)

data/osm.gemspec

@@ -26,5 +26,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 10.0'
   s.add_development_dependency 'rspec', '~> 2.11'
   s.add_development_dependency 'fakeweb', '~> 1.3'
+  s.add_development_dependency 'guard-rspec', '~> 2.4'
+  s.add_development_dependency 'rb-inotify', '~> 0.8.8'
 
 end

data/spec/osm/activity_spec.rb

@@ -1,179 +1,196 @@
 # encoding: utf-8
 require 'spec_helper'
 
-describe "Using The API" do
-
-  it "Get One" do
-    body = {
-        'details' => {
-        'activityid' => '1',
-        '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' => '1',
-          'filename' => 'File Name',
-          'name' => 'Name',
-        }
-      ],
-      'badges' => [
-        {
+describe "Activity" do
+
+    it "Get OSM link" do
+      activity = Osm::Activity.new(
+        :id => 1,
+        :running_time => 10,
+        :title => 'Title',
+        :description => 'Description',
+        :resources => 'Resources',
+        :instructions => 'Instructions',
+        :location => :indoors,
+      )
+      activity.osm_link.should == 'https://www.onlinescoutmanager.co.uk/?l=p1'
+    end
+
+
+  describe "Using The API" do
+  
+    it "Get One" do
+      body = {
+          'details' => {
           'activityid' => '1',
-          '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=1", :body => body.to_json)
-
-
-    activity = Osm::Activity.get(@api, 1)
-
-    activity.id.should == 1
-    activity.version.should == 0
-    activity.group_id.should == 2
-    activity.user_id.should == 3
-    activity.title.should == 'Activity Name'
-    activity.description.should == 'Description'
-    activity.resources.should == 'Resources'
-    activity.instructions.should == 'Instructions'
-    activity.running_time.should == 15
-    activity.location.should == :indoors
-    activity.shared.should == 0
-    activity.rating.should == 4
-    activity.editable.should == true
-    activity.deletable.should == false
-    activity.used.should == 3
-    activity.versions[0].version.should == 0
-    activity.versions[0].created_by.should == 1
-    activity.versions[0].created_by_name.should == 'Alice'
-    activity.versions[0].label.should == 'Current version - Alice'
-    activity.sections.should == [:beavers, :cubs]
-    activity.tags.should == ['Tag 1', 'Tag2']
-    activity.files[0].id.should == 6
-    activity.files[0].activity_id.should == 1
-    activity.files[0].file_name.should == 'File Name'
-    activity.files[0].name.should == 'Name'
-    activity.badges[0].activity_id.should == 1
-    activity.badges[0].section_type.should == :section
-    activity.badges[0].type.should == :type
-    activity.badges[0].badge.should == 'badge'
-    activity.badges[0].requirement.should == 'col_name'
-    activity.badges[0].label.should == 'This is a label'
-
-    activity.valid?.should be_true
-  end
-
-
-  it "Add activity to programme (succeded)" do
-    url = 'https://www.onlinescoutmanager.co.uk/programme.php?action=addActivityToProgramme'
-    post_data = {
-      'apiid' => @CONFIGURATION[:api][:osm][:id],
-      'token' => @CONFIGURATION[:api][:osm][:token],
-      'userid' => 'user_id',
-      'secret' => 'secret',
-      'meetingdate' => '2000-01-02',
-      'sectionid' => 1,
-      'activityid' => 2,
-      'notes' => 'Notes',
-    }
-
-    HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"result":0}'}) }
-    activity = Osm::Activity.new(:id => 2)
-    activity.add_to_programme(@api, 1, Date.new(2000, 1, 2), 'Notes').should be_true
+          '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' => '1',
+            'filename' => 'File Name',
+            'name' => 'Name',
+          }
+        ],
+        'badges' => [
+          {
+            'activityid' => '1',
+            '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=1", :body => body.to_json)
+  
+  
+      activity = Osm::Activity.get(@api, 1)
+  
+      activity.id.should == 1
+      activity.version.should == 0
+      activity.group_id.should == 2
+      activity.user_id.should == 3
+      activity.title.should == 'Activity Name'
+      activity.description.should == 'Description'
+      activity.resources.should == 'Resources'
+      activity.instructions.should == 'Instructions'
+      activity.running_time.should == 15
+      activity.location.should == :indoors
+      activity.shared.should == 0
+      activity.rating.should == 4
+      activity.editable.should == true
+      activity.deletable.should == false
+      activity.used.should == 3
+      activity.versions[0].version.should == 0
+      activity.versions[0].created_by.should == 1
+      activity.versions[0].created_by_name.should == 'Alice'
+      activity.versions[0].label.should == 'Current version - Alice'
+      activity.sections.should == [:beavers, :cubs]
+      activity.tags.should == ['Tag 1', 'Tag2']
+      activity.files[0].id.should == 6
+      activity.files[0].activity_id.should == 1
+      activity.files[0].file_name.should == 'File Name'
+      activity.files[0].name.should == 'Name'
+      activity.badges[0].activity_id.should == 1
+      activity.badges[0].section_type.should == :section
+      activity.badges[0].type.should == :type
+      activity.badges[0].badge.should == 'badge'
+      activity.badges[0].requirement.should == 'col_name'
+      activity.badges[0].label.should == 'This is a label'
+  
+      activity.valid?.should be_true
+    end
+  
+  
+    it "Add activity to programme (succeded)" do
+      url = 'https://www.onlinescoutmanager.co.uk/programme.php?action=addActivityToProgramme'
+      post_data = {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'meetingdate' => '2000-01-02',
+        'sectionid' => 1,
+        'activityid' => 2,
+        'notes' => 'Notes',
+      }
+  
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"result":0}'}) }
+      activity = Osm::Activity.new(:id => 2)
+      activity.add_to_programme(@api, 1, Date.new(2000, 1, 2), 'Notes').should be_true
+    end
+  
+    it "Add activity to programme (failed)" do
+      HTTParty.should_receive(:post) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"result":1}'}) }
+      activity = Osm::Activity.new(:id => 2)
+      activity.add_to_programme(@api, 1, Date.new(2000, 1, 2), 'Notes').should be_false
+    end
+  
+  
+    it "Update activity in OSM (succeded)" do
+      url = 'https://www.onlinescoutmanager.co.uk/programme.php?action=update'
+      post_data = {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'title' => 'title',
+        'description' => 'description',
+        'resources' => 'resources',
+        'instructions' => 'instructions',
+        'id' => 2,
+        'files' => '3,4',
+        'time' => '5',
+        'location' => :indoors,
+        'sections' => '["beavers","cubs"]',
+        'tags' => '["tag1","tag2"]',
+        'links' => '[{"activityid":"2","section":"beavers","badgetype":"t","badge":"b","columnname":"r","label":"l"}]',
+        'shared' => 0,
+        'sectionid' => 1,
+        'secretEdit' => true,
+      }
+  
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"result":true}'}) }
+      activity = Osm::Activity.new(
+        :id => 2,
+        :title => 'title',
+        :description => 'description',
+        :resources => 'resources',
+        :instructions => 'instructions',
+        :files => [Osm::Activity::File.new(:id=>3, :activity_id=>2, :file_name=>'fn', :name=>'n'), Osm::Activity::File.new(:id=>4, :activity_id=>2, :file_name=>'fn2', :name=>'n2')],
+        :running_time => 5,
+        :location => :indoors,
+        :sections => [:beavers, :cubs],
+        :tags => ['tag1', 'tag2'],
+        :badges => [Osm::Activity::Badge.new(:activity_id=>2, :section_type=>:beavers, :type=>:t, :badge=>'b', :requirement=>'r', :label=>'l')],
+        :shared => 0,
+        :section_id => 1,
+      )
+      activity.update(@api, 1, true).should be_true
+    end
+  
+    it "Update activity in OSM (failed)" do
+      HTTParty.should_receive(:post) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"result":false}'}) }
+      activity = Osm::Activity.new(
+        :id => 2,
+        :title => 'title',
+        :description => 'description',
+        :resources => 'resources',
+        :instructions => 'instructions',
+        :location => :indoors,
+        :running_time => 0,
+      )
+      activity.update(@api, 1, true).should be_false
+    end
+  
   end
 
-  it "Add activity to programme (failed)" do
-    HTTParty.should_receive(:post) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"result":1}'}) }
-    activity = Osm::Activity.new(:id => 2)
-    activity.add_to_programme(@api, 1, Date.new(2000, 1, 2), 'Notes').should be_false
-  end
-
-
-  it "Update activity in OSM (succeded)" do
-    url = 'https://www.onlinescoutmanager.co.uk/programme.php?action=update'
-    post_data = {
-      'apiid' => @CONFIGURATION[:api][:osm][:id],
-      'token' => @CONFIGURATION[:api][:osm][:token],
-      'userid' => 'user_id',
-      'secret' => 'secret',
-      'title' => 'title',
-      'description' => 'description',
-      'resources' => 'resources',
-      'instructions' => 'instructions',
-      'id' => 2,
-      'files' => '3,4',
-      'time' => '5',
-      'location' => :indoors,
-      'sections' => '["beavers","cubs"]',
-      'tags' => '["tag1","tag2"]',
-      'links' => '[{"activityid":"2","section":"beavers","badgetype":"t","badge":"b","columnname":"r","label":"l"}]',
-      'shared' => 0,
-      'sectionid' => 1,
-      'secretEdit' => true,
-    }
-
-    HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"result":true}'}) }
-    activity = Osm::Activity.new(
-      :id => 2,
-      :title => 'title',
-      :description => 'description',
-      :resources => 'resources',
-      :instructions => 'instructions',
-      :files => [Osm::Activity::File.new(:id=>3, :activity_id=>2, :file_name=>'fn', :name=>'n'), Osm::Activity::File.new(:id=>4, :activity_id=>2, :file_name=>'fn2', :name=>'n2')],
-      :running_time => 5,
-      :location => :indoors,
-      :sections => [:beavers, :cubs],
-      :tags => ['tag1', 'tag2'],
-      :badges => [Osm::Activity::Badge.new(:activity_id=>2, :section_type=>:beavers, :type=>:t, :badge=>'b', :requirement=>'r', :label=>'l')],
-      :shared => 0,
-      :section_id => 1,
-    )
-    activity.update(@api, 1, true).should be_true
-  end
-
-  it "Update activity in OSM (failed)" do
-    HTTParty.should_receive(:post) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"result":false}'}) }
-    activity = Osm::Activity.new(
-      :id => 2,
-      :title => 'title',
-      :description => 'description',
-      :resources => 'resources',
-      :instructions => 'instructions',
-      :location => :indoors,
-      :running_time => 0,
-    )
-    activity.update(@api, 1, true).should be_false
-  end
-
-
-end
+end