cannikin-encosion 0.1.4 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.1

data/encosion.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{encosion}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Cameron"]
-  s.date = %q{2009-07-07}
+  s.date = %q{2009-07-22}
   s.email = %q{cannikinn@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",

data/lib/encosion/base.rb

@@ -48,95 +48,29 @@ module Encosion
       # This is an alias for find(:all)
       def all(*args)
         find(:all, *args)
-      end    
+      end
 
-      protected
+      # Performs an HTTP GET
+      def get(server,port,path,secure,command,options)
+        http = HTTPClient.new
+        url = secure ? 'https://' : 'http://'
+        url += "#{server}:#{port}#{path}"
         
-      
-        # Pulls any Hash off the end of an array of arguments and returns it
-        def extract_options(opts)
-          opts.last.is_a?(::Hash) ? opts.pop : {}
-        end
-
-
-        # Find an asset from a single or array of ids
-        def find_from_ids(ids, options)
-          expects_array = ids.first.kind_of?(Array)
-          return ids.first if expects_array && ids.first.empty?
-
-          ids = ids.flatten.compact.uniq
-
-          case ids.size
-            when 0
-              raise AssetNotFound, "Couldn't find #{self.class} without an ID"
-            when 1
-              result = find_one(ids.first, options)
-              expects_array ? [ result ] : result
-            else
-              find_some(ids, options)
-          end
-        end
+        options.merge!({'command' => command })
+        query_string = options.collect { |key,value| "#{key.to_s}=#{value.to_s}" }.join('&')
         
+        response = http.get(url, query_string)
         
-        # Performs an HTTP GET
-        def get(server,port,path,secure,command,options)
-          http = HTTPClient.new
-          url = secure ? 'https://' : 'http://'
-          url += "#{server}:#{port}#{path}"
-          
-          options.merge!({'command' => command })
-          query_string = options.collect { |key,value| "#{key.to_s}=#{value.to_s}" }.join('&')
-          
-          response = http.get(url, query_string)
-          
-          body = response.body.content.strip == 'null' ? nil : JSON.parse(response.body.content.strip)   # if the call returns 'null' then there were no valid results
-          header = response.header
-          
-          error_check(header,body)
-
-          return body
-        end
-
+        body = response.body.content.strip == 'null' ? nil : JSON.parse(response.body.content.strip)   # if the call returns 'null' then there were no valid results
+        header = response.header
         
-        # Checks the HTTP response and handles any errors
-        def error_check(header,body)
-          if header.status_code == 200
-            return true if body.nil?
-            puts body['error']
-            if body.has_key? 'error' && !body['error'].nil?
-              message = "Brightcove responded with an error: #{body['error']} (code #{body['code']})"
-              body['errors'].each do |error| 
-                message += "\n#{error.values.first} (code #{error.values.last})"
-              end if body.has_key? 'errors'
-              raise BrightcoveException, message
-            end
-          else
-            # should only happen if the Brightcove API is unavailable (even BC errors return a 200)
-            raise BrightcoveException, body + " (status code: #{header.status_code})"
-          end
-        end
+        error_check(header,body)
         
+        # puts "url: #{url}\nquery_string:#{query_string}"
 
-        # Turns a hash into a query string and appends the token
-        def queryize_args(args, type)
-          case type
-          when :read
-            raise MissingToken, 'No read token found' if @read_token.nil?
-            args.merge!({ :token => @read_token })
-          when :write
-            raise MissingToken, 'No write token found' if @write_token.nil?
-            args.merge!({ :token => @write_token })
-          end
-          return args.collect { |key,value| "#{key.to_s}=#{value.to_s}" }.join('&')
-        end
+        return body
+      end
       
-    end
-    
-    
-    #
-    # Instance methods
-    #
-    private
       # Performs an HTTP POST
       def post(server,port,path,secure,command,options,instance)
         http = HTTPClient.new
@@ -144,7 +78,7 @@ module Encosion
         url += "#{server}:#{port}#{path}"
 
         content = { 'json' => { 'method' => command, 'params' => options }.to_json }    # package up the variables as a JSON-RPC string
-        content.merge!({ 'file' => instance.file }) if instance.file                    # and add a file if there is one
+        content.merge!({ 'file' => instance.file }) if instance.respond_to?('file')                    # and add a file if there is one
 
         response = http.post(url, content)
         # get the header and body for error checking
@@ -156,8 +90,6 @@ module Encosion
         return body
       end
       
-      
-      # TODO: shouldn't need to duplicate this method here, some way to call the class method
       # Checks the HTTP response and handles any errors
       def error_check(header,body)
         if header.status_code == 200
@@ -175,6 +107,50 @@ module Encosion
           raise BrightcoveException, body + " (status code: #{header.status_code})"
         end
       end
+      
+
+      protected
+        
+        # Pulls any Hash off the end of an array of arguments and returns it
+        def extract_options(opts)
+          opts.last.is_a?(::Hash) ? opts.pop : {}
+        end
+
+
+        # Find an asset from a single or array of ids
+        def find_from_ids(ids, options)
+          expects_array = ids.first.kind_of?(Array)
+          return ids.first if expects_array && ids.first.empty?
+
+          ids = ids.flatten.compact.uniq
+
+          case ids.size
+            when 0
+              raise AssetNotFound, "Couldn't find #{self.class} without an ID"
+            when 1
+              result = find_one(ids.first, options)
+              expects_array ? [ result ] : result
+            else
+              find_some(ids, options)
+          end
+        end
+        
+
+        # Turns a hash into a query string and appends the token
+        def queryize_args(args, type)
+          case type
+          when :read
+            raise MissingToken, 'No read token found' if @read_token.nil?
+            args.merge!({ :token => @read_token })
+          when :write
+            raise MissingToken, 'No write token found' if @write_token.nil?
+            args.merge!({ :token => @write_token })
+          end
+          return args.collect { |key,value| "#{key.to_s}=#{value.to_s}" }.join('&')
+        end
+      
+    end
+    
     
   end
   

data/lib/encosion/video.rb

@@ -37,7 +37,6 @@ module Encosion
       
       # Find a video by reference_id. Invokes Brightcove Media API command 'find_video_by_reference_id' or
       # 'find_videos_by_reference_ids' depending on whether you call one or multiple ids
-      #
       #   Encosion::Video.find_by_reference_id('mycompany_1',:token => 'asdf')
       #   Encosion::Video.find_by_reference_id('mycompany_1','mycompany_2','mycompany_3',:token => 'asdf')
       
@@ -55,12 +54,11 @@ module Encosion
           else
             options.merge!({:reference_ids => ids.join(',')})
             response = get(SERVER,PORT,READ_PATH,SECURE,'find_videos_by_reference_ids',options)
-            return self.parse(response)
+            return response['items'].collect { |item| self.parse(item) }
           end
       end
       
       # Find a video by text search. Invokes Brightcove Media API command 'find_videos_by_text'
-      #
       #   Encosion::Video.find_by_text('funny videos',:token => 'asdf')
       
       def find_by_text(*args)
@@ -68,25 +66,29 @@ module Encosion
         text = args.flatten.compact.uniq
         raise AssetNotFound, "Couldn't find #{self.class} without text" if text == ''
         options.merge!({:text => text.first})
-        response = get(SERVER,PORT,READ_PATH,SECURE,'find_videos_by_text',options)
-        return response['items'].collect { |item| self.parse(item) }
+        if response = get(SERVER,PORT,READ_PATH,SECURE,'find_videos_by_text',options)
+          return response['items'].collect { |item| self.parse(item) }
+        else
+          nil
+        end
       end
       
 
       # Find videos related to the given video_id. Invokes Brightcove Media API command 'find_related_videos'
-      #
       #   Encosion::Video.find_related(123456,:token => 'asdf')
       
       def find_related(*args)
         options = extract_options(args)
         raise AssetNotFound, "Cannot find related #{self.class}s without a video_id or reference_id" if options[:video_id].nil? && options[:reference_id].nil?
-        response = get(SERVER,PORT,READ_PATH,SECURE,'find_related_videos',options)
-        return response['items'].collect { |item| self.parse(item) }
+        if response = get(SERVER,PORT,READ_PATH,SECURE,'find_related_videos',options)
+          return response['items'].collect { |item| self.parse(item) }
+        else
+          return nil
+        end
       end
       
       
       # Find a video by tag search. Invokes Brightcove Media API command 'find_videos_by_tags'
-      #
       #   Encosion::Video.find_by_tags('bloopers','gagreel','funny',:token => 'asdf')
       
       def find_by_tags(*args)
@@ -98,10 +100,36 @@ module Encosion
             raise AssetNotFound, "Couldn't find #{self.class} without tags"
           else
             options.merge!({:and_tags => tags.join(',')})
-            response = get(SERVER,PORT,READ_PATH,SECURE,'find_videos_by_tags',options)
-            return response['items'].collect { |item| self.parse(item) }
+            if response = get(SERVER,PORT,READ_PATH,SECURE,'find_videos_by_tags',options)
+              return response['items'].collect { |item| self.parse(item) }
+            else
+              return nil
+            end
           end
       end
+      
+      
+      # Returns the status of a video upload (returns one of :uploading | :processing | :complete | :error )
+      # Takes either Brightcove's video_id or your own reference_id. If you pass an integer it's assumed to be
+      # a video_id, if you pass a string it's assumed to be a reference_id.
+      #   Encosion::Video.status(12345)
+      
+      def status(*args)
+        options = extract_options(args)
+        id = args.flatten.compact.uniq.first
+        
+        if id.class == String
+          options.merge!({:reference_id => id})
+        else
+          options.merge!({:video_id => id})
+        end
+        
+        if response = Video.post(SERVER,PORT,WRITE_PATH,SECURE,'get_upload_status',options,self)
+          return response['result'].downcase.to_sym
+        else
+          return nil
+        end
+      end
 
       protected
         # Find some videos by ids
@@ -116,7 +144,6 @@ module Encosion
         def find_some(ids, options)
           options.merge!({:video_ids => ids.join(',')})
           response = get(SERVER,PORT,READ_PATH,SECURE,'find_videos_by_ids',options)
-          puts response
           return response['items'].collect { |item| self.parse(item) }
         end
       
@@ -130,24 +157,29 @@ module Encosion
       
         # Creates a new Video object from a Ruby hash (used to create a video from a parsed API call)
         def parse(obj)
-          args = {:id => obj['id'].to_i,
-                  :name => obj['name'],
-                  :short_description => obj['shortDescription'],
-                  :long_description => obj['longDescription'],
-                  :creation_date => Time.at(obj['creationDate'].to_i/1000),
-                  :published_date => Time.at(obj['publishedDate'].to_i/1000),
-                  :last_modified_date => Time.at(obj['lastModifiedDate'].to_i/1000),
-                  :link_url => obj['linkURL'],
-                  :link_text => obj['linkText'],
-                  :tags => obj['tags'],
-                  :video_still_url => obj['videoStillURL'],
-                  :thumbnail_url => obj['thumbnailURL'],
-                  :reference_id => obj['referenceID'],
-                  :length => obj['length'].to_i,
-                  :economics => obj['economics'] ? ENUMS[:economics].find { |key,value| value == obj['economics'] }.first : nil,
-                  :plays_total => obj['playsTotal'].to_i,
-                  :plays_trailing_week => obj['playsTrailingWeek'].to_i } unless obj.nil?
-          return self.new(args)
+          puts obj.inspect
+          if obj
+            args = {:id => obj['id'].to_i,
+                    :name => obj['name'],
+                    :short_description => obj['shortDescription'],
+                    :long_description => obj['longDescription'],
+                    :creation_date => Time.at(obj['creationDate'].to_i/1000),
+                    :published_date => Time.at(obj['publishedDate'].to_i/1000),
+                    :last_modified_date => Time.at(obj['lastModifiedDate'].to_i/1000),
+                    :link_url => obj['linkURL'],
+                    :link_text => obj['linkText'],
+                    :tags => obj['tags'],
+                    :video_still_url => obj['videoStillURL'],
+                    :thumbnail_url => obj['thumbnailURL'],
+                    :reference_id => obj['referenceID'],
+                    :length => obj['length'].to_i,
+                    :economics => obj['economics'] ? ENUMS[:economics].find { |key,value| value == obj['economics'] }.first : nil,
+                    :plays_total => obj['playsTotal'].to_i,
+                    :plays_trailing_week => obj['playsTrailingWeek'].to_i } unless obj.nil?
+            return self.new(args)
+          else
+            return nil
+          end
         end
       
     end
@@ -185,7 +217,7 @@ module Encosion
       # check to make sure we have everything needed for a create_video call
       raise NoFile, "You need to attach a file to this video before you can upload it: Video.file = File.new('/path/to/file')" if @file.nil?
       options = args.merge({ 'video' => self.to_brightcove })   # take the parameters of this video and make them a valid video object for upload
-      response = post(SERVER,PORT,WRITE_PATH,SECURE,'create_video',options,self)
+      response = Video.post(SERVER,PORT,WRITE_PATH,SECURE,'create_video',options,self)
       return response['result']    # returns the Brightcove ID of the video that was just uploaded
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cannikin-encosion
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rob Cameron
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-07 00:00:00 -07:00
+date: 2009-07-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency