streamio 0.5.0 → 0.5.1

data/HISTORY

@@ -1,3 +1,7 @@
+== 0.5.1 2011-06-16
+
+* Added lots of (YARD style) documentation and updated README
+
 == 0.5.0 2011-06-15
 
 * Basic api functionality for Videos, Images and Encoding Profiles

data/README.rdoc

@@ -32,4 +32,19 @@ Use it.
   # Find a video by id
   video = Streamio::Video.find("4c57f3975412901427000005")
   
+  # Create a video
+  video = Streamio::Video.new
+  video.save # false
+  video.errors # {:file => ["can't be blank"]}
+  video.file = File.new("my_awesome_video.mov")
+  video.save # true
+
 Same principles work for the other availible models (Streamio::Image and Streamio::EncodingProfile).
+
+== More Documentation
+
+YARDoc is avaible here:
+http://rubydoc.info/gems/streamio
+
+Please refer to the official Streamio API Documentation for details on parameters etc:
+http://streamio.com/api/docs

data/lib/streamio.rb

@@ -15,6 +15,14 @@ module Streamio
     attr_accessor :use_ssl
     attr_accessor :host
     
+    # The idiomatic configure block for the Streamio gem. Basically a shortcut
+    # for the Streamio module attributes.
+    #
+    # @example Configure your API username and password.
+    #   Streamio.configure do |config|
+    #     config.username = "my_awesome_account"
+    #     config.password = "3633b4a027d74ead0038addff89550"
+    #   end
     def configure
       yield self
     end

data/lib/streamio/model.rb

@@ -1,10 +1,22 @@
 module Streamio
   class Model
     class << self
+      # Gets a model by its id.
+      #
+      # @param [String] id The models id.
+      #
+      # @return [Model] The found model.
       def find(id)
         parse_response(resource["#{id}"].get)
       end
       
+      # Querys for a list of models.
+      #
+      # @param [Hash] parameters The parameters will determine the conditions
+      # for the query. Refer to Streamio API reference for a list of valid
+      # parameters for each of the different models availible.
+      #
+      # @return [Array] Array of found models.
       def all(parameters = {})
         sanitize_parameters(parameters)
         parse_response(resource.get(:params => parameters))
@@ -30,9 +42,14 @@ module Streamio
     end
     
     CASTED_ATTRIBUTES = %w(tags created_at updated_at)
-  
-    attr_reader :attributes, :errors
-  
+    
+    # A Hash resulting from parsing the JSON returned from Streamios API.
+    attr_reader :attributes
+    
+    # A Hash containing validation errors after a failed +save+.
+    attr_reader :errors
+    
+    # @param [Hash] attributes The attributes you wish to apply to the new Model instance.
     def initialize(attributes = {})
       @errors = {}
       @attributes = attributes.inject(Hash.new) do |options, (key, value)|
@@ -40,7 +57,16 @@ module Streamio
         options
       end
     end
-  
+    
+    # Saves the model.
+    #
+    # If the model is new a record gets created, otherwise the existing record
+    # gets updated.
+    #
+    # If +save+ fails it might be due to validation errors so you might want
+    # to check the models +errors+.
+    #
+    # @return [Boolean] Indicating if the save / update was successful.
     def save
       if persisted?
         update
@@ -51,31 +77,40 @@ module Streamio
       @errors = JSON.parse(e.response)
       false
     end
-  
+    
+    # Deletes the record and freezes this instance to reflect that no changes
+    # should be made (since they can't be persisted).
+    #
+    # @return [Boolean] True if the record was deleted.
     def destroy
       self.class.resource[id].delete
       @attributes.freeze
       true
     end
-  
+    
+    # @return [Boolean] True if the record is persisted.
     def persisted?
       !destroyed? && !id.nil?
     end
-  
+    
+    # @return [Boolean] True if you destroyed this record.
     def destroyed?
       @attributes.frozen?
     end
-  
+    
+    # @return [Array] Array of tags applied to the record.
     def tags
       @attributes["tags"] = [] if @attributes["tags"].nil?
       @attributes["tags"]
     end
-  
+    
+    # @return [Time] When the record was created.
     def created_at
       return nil unless @attributes["created_at"]
       Time.parse(@attributes["created_at"])
     end
-  
+    
+    # @return [Time] When the record was last updated.
     def updated_at
       return nil unless @attributes["updated_at"]
       Time.parse(@attributes["updated_at"])

data/lib/streamio/version.rb

@@ -1,3 +1,3 @@
 module Streamio
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/lib/streamio/video.rb

@@ -20,13 +20,25 @@ module Streamio
       end
     end
     
-    def add_transcoding(parameters = {})
+    # Adds a transcoding to the video instance.
+    #
+    # @param [Hash] parameters The parameters to pass in when creating the transcoding.
+    #
+    # @option parameters [String] :encoding_profile_id Id of the Encoding Profile to be used for the transcoding.
+    #
+    # @return [Boolean] Indicating wether the transcoding was successfully created.
+    def add_transcoding(parameters)
       self.class.resource["#{id}/transcodings"].post(parameters)
       true
     rescue RestClient::Exception
       false
     end
     
+    # Deletes a transcoding from the video.
+    #
+    # @param [String] transcoding_id The id of the transcoding to be deleted.
+    #
+    # @return [Boolean] Indicating wether the transcoding was successfully deleted.
     def delete_transcoding(transcoding_id)
       self.class.resource["#{id}/transcodings/#{transcoding_id}"].delete
       true

metadata

@@ -2,7 +2,7 @@
 name: streamio
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - David Backeus
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-15 00:00:00 Z
+date: 2011-06-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -108,3 +108,4 @@ specification_version: 3
 summary: Ruby wrapper for the Streamio api.
 test_files: []
 
+has_rdoc: