rtunesu 0.2.3 → 0.2.4

data/History.txt

@@ -1,4 +1,5 @@
-== 0.0.1 2008-06-27
+
+Pre 0.2.3 2008-09-12
 
 * 1 major enhancement:
   * Initial release

data/README.txt

@@ -1,7 +1,12 @@
 = RTunesU
 
 == DESCRIPTION:
-RTunesU is a ruby library for accessing Apple's iTunes U Webservices to integrate your education institutions iTunes U account into ruby applications
+RTunesU is a ruby library for accessing Apple's iTunes U Webservices to integrate your education institutions iTunes U account into ruby applications. iTunes U's Webservices interface is fairly primitive by today's standards for XML based APIs.  Some known flaws of iTunes U
+ * No arbitrary search
+ * Queries for missing objects return an XML document representing the entire institution instead of returning an error
+ * Does not follow REST principles
+ * Does not use HTTP status codes meaningfully
+ * Collections not contained in an outer element
 
 == FEATURES/PROBLEMS:
  - TODO: file uploading
@@ -14,7 +19,7 @@ http://github.com/trek/rtunesu/wikis
 RTunesU depends on the ruby-hmac, hpricot, and builder libraries. These should all install automatically as dependencies when installing RTunesU
 
 == INSTALL:
-RTunesU install via rubygems. wit
+RTunesU install via rubygems with
    gem instal rtunesu
 
 == LICENSE:

data/lib/rtunesu/document.rb

@@ -6,12 +6,15 @@ module RTunesU
   # c = Course.find(12345, itunes_connection_object)
   # c.Name # "Exemple Course"
   # c.Name = 'Example Course'
-  # c.save # genertes and sends a Document::Merge object with the Course data.
+  # c.save(itunes_connection_object) # genertes and sends a Document::Merge object with the Course data.
   module Document
     class Base
       INDENT = 2
       attr_accessor :builder, :source, :options, :xml
       
+      # Creates a new XML document using Builder.  Includes the required XML entities of 
+      # ITunesUDocument and Version, then calls tag_action to add in specific XML entities for
+      # the type of document being built. tag_action is defined in each sublcass of Document.
       def initialize(source, options = {})
         self.source, self.options = source, options
         builder = Builder::XmlMarkup.new(:indent => INDENT)

data/lib/rtunesu/entities/theme.rb

@@ -1,4 +1,5 @@
 module RTunesU
+  # A visual theme for iTunesU pages. Color values are in 6 digit hex (e.g. #ffffff)
   # == Attributes
   # Name
   # Handle

data/lib/rtunesu/entities/track.rb

@@ -13,11 +13,21 @@ module RTunesU
   # DownloadURL
   # Comment
   class Track < Entity
-    # Tracks can only be found from within their Course. There is currently no way to find a Track separete from its Course.  
+    # Tracks can only be found from within their Course. There is currently no way to find a Track separete from its Course in iTunes U.
     def self.find(handle, course_handle, connection)
       entity = self.new(:handle => handle)
       entity.source_xml = Course.find(course_handle, connection).source_xml.at("Handle[text()=#{entity.handle}]..")
       entity
     end
+    
+    # Duration in millseconds is the one attribute in plural form that is not a collection 
+    def DurationMilliseconds
+      self.value_from_edits_or_store('DurationMilliseconds')
+    end
+    
+    # Duration in millseconds is the one attribute in plural form that is not a collection 
+    def DurationMilliseconds=(duration)
+      self.edits['DurationMilliseconds'] = duration
+    end
   end
 end

data/lib/rtunesu/entity.rb

@@ -39,7 +39,7 @@ module RTunesU
       self.attributes = {}
       attrs.each {|attribute, value| self.send("#{attribute}=", value)}
     end
-    
+        
     # Finds a specific entity in iTunes U. To find an entity you will need to know both its type (Course, Group, etc) and handle.  Handles uniquely identify entities in iTunes U and the entity type is used to search the returned XML for the specific entity you are looking for.  For example,
     # Course.find(123456, rtunes_connection_object)
     def self.find(handle, connection)
@@ -71,7 +71,8 @@ module RTunesU
     end
     
     def method_missing(method_name, args = nil)
-      # introspect the kind of method call (read one attribute, read an array of related items, write one attribute, write an array of related items)
+      # introspect the kind of method call (read one attribute, 
+      # read an array of related items, write one attribute, write an array of related items)
       case method_name.to_s.match(/(s)*(=)*$/).captures
        when [nil, "="] : self.edits[method_name.to_s[0..-2]] = args
        when ["s", "="] : self.edits[method_name.to_s[0..-2]] = args
@@ -101,7 +102,7 @@ module RTunesU
     # course.class #=> 'RTunesU::Course'
     # course.class_name #=> 'Course'
     def class_name
-      self.class.to_s.split(':').last
+      self.class.to_s.split('::').last
     end
     
     # Returns the handle of the entitiy's parent.  This can either be set directly as a string or interger or will access the parent entity.  Sometimes you know the parent_handle without the parent object (for example, stored locally from an earlier request). This allows you to add a new Entity to iTunes U without first firing a reques for a prent entity (For example, if your institution places all inside the same Section, you want to add a new Section to your Site, or a new Group to a course tied to your institution's LMS).
@@ -116,11 +117,13 @@ module RTunesU
       }
     end
     
+    # called when .save is called on an object that is already stored in iTunes U
     def update(connection)
       connection.process(Document::Merge.new(self).xml)
       self
     end
     
+    # called when .save is called on an object that has no Handle (i.e. does not already exist in iTunes U)
     def create(connection)
       response = Hpricot.XML(connection.process(Document::Add.new(self).xml))
       raise Exception, response.at('error').innerHTML if response.at('error')

data/lib/rtunesu/version.rb

@@ -2,7 +2,7 @@ module RTunesU
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 2
-    TINY  = 3
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rtunesu
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Trek Glowacki
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-09 00:00:00 -04:00
+date: 2008-09-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency