honkster-encosion 0.3.0 → 0.3.1

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 test/random.rb
 pkg
+.idea/

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake'
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.name = "honkster-encosion"
+    gem.name = "encosion"
     gem.summary = %q{Ruby library for working with the Brightcove API}
     gem.email = "cannikinn@gmail.com"
     gem.homepage = "http://github.com/cannikin/encosion"

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/encosion.gemspec

@@ -1,12 +1,12 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{encosion}
-  s.version = "0.3.0"
+  s.name = %q{honkster-encosion}
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Cameron"]
-  s.date = %q{2009-08-04}
+  s.date = %q{2009-11-09}
   s.email = %q{cannikinn@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
      "test/movie.mov",
      "test/test_helper.rb"
   ]
-  s.homepage = %q{http://github.com/cannikin/encosion}
+  s.homepage = %q{http://github.com/honkster/encosion}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.4}

data/lib/encosion/base.rb

@@ -4,38 +4,38 @@ require 'httpclient'
 require 'json'
 
 module Encosion
-
+  
   # Generic Encosion error class
   class EncosionError < StandardError
   end
-
+  
   # Raised when there is no token (required to use the Brightcove API)
   class MissingToken < EncosionError
   end
-
+  
   # Raised when some parameter is missing that we need in order to do a search
   class AssetNotFound < EncosionError
   end
-
+  
   # Raised when Brightcove doesn't like the call that was made for whatever reason
   class BrightcoveException < EncosionError
   end
-
+  
   # Raised when Brightcove doesn't like the call that was made for whatever reason
   class NoFile < EncosionError
   end
-
-
+  
+  
   # The base for all Encosion objects
   class Base
-
+    
     attr_accessor :read_token, :write_token
 
     #
     # Class methods
     #
     class << self
-
+      
       # Does a GET to search photos and other good stuff
       def find(*args)
         options = extract_options(args)
@@ -44,42 +44,43 @@ module Encosion
         else        find_from_ids(args,options)
         end
       end
-
+      
+        
       # This is an alias for find(:all)
       def all(*args)
         find(:all, *args)
       end
-
+      
 
       # Performs an HTTP GET
       def get(server,port,secure,path,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)
-
+        
         # puts "url: #{url}\nquery_string:#{query_string}"
 
         return body
       end
-
-
+      
+      
       # Performs an HTTP POST
       def post(server,port,secure,path,command,options,instance)
         http = HTTPClient.new
         url = secure ? 'https://' : 'http://'
         url += "#{server}:#{port}#{path}"
-
-        content = { 'json' => { 'method' => command, 'params' => options}.to_json }    # package up the variables as a JSON-RPC string
+        
+        content = { 'json' => { 'method' => command, 'params' => options }.to_json }    # package up the variables as a JSON-RPC string
         content.merge!({ 'file' => instance.file }) if instance.respond_to?('file')             # and add a file if there is one
 
         response = http.post(url, content)
@@ -91,15 +92,16 @@ module Encosion
         # if we get here then no exceptions were raised
         return body
       end
-
+      
+      
       # 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']
+#          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|
+            body['errors'].each do |error| 
               message += "\n#{error.values.first} (code #{error.values.last})"
             end if body.has_key? 'errors'
             raise BrightcoveException, message
@@ -109,13 +111,16 @@ 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)
@@ -133,6 +138,7 @@ module Encosion
               find_some(ids, options)
           end
         end
+        
 
         # Turns a hash into a query string and appends the token
         def queryize_args(args, type)
@@ -146,7 +152,10 @@ module Encosion
           end
           return args.collect { |key,value| "#{key.to_s}=#{value.to_s}" }.join('&')
         end
-
+      
     end
+    
+    
   end
+  
 end

data/lib/encosion/video.rb

@@ -1,43 +1,43 @@
 module Encosion
+  
   # Raised if you try to set an invalid economics value
-  class InvalidEconomicsValue < StandardError;
-  end;
-
+  class InvalidEconomicsValue < StandardError; end;
+  
   class Video < Base
-
+    
     ENUMS = { :economics => { :free => 'FREE', :ad_supported => 'AD_SUPPORTED'}}
-
-    attr_accessor(:name,
-                  :short_description,
+    
+    attr_accessor(:name, 
+                  :short_description, 
                   :long_description,
-                  :link_url,
-                  :link_text,
-                  :tags,
-                  :reference_id,
+                  :link_url, 
+                  :link_text, 
+                  :tags, 
+                  :reference_id, 
                   :economics,
                   :file)
-    attr_reader(:id,
-                :account_id,
-                :flv_url,
-                :creation_date,
-                :published_date,
-                :last_modified_date,
-                :video_still_url,
-                :thumbnail_url,
-                :length,
-                :plays_total,
-                :plays_trailing_week)
-
-    #
+      attr_reader(:id, 
+                  :account_id, 
+                  :flv_url,
+                  :creation_date, 
+                  :published_date, 
+                  :last_modified_date, 
+                  :video_still_url, 
+                  :thumbnail_url, 
+                  :length, 
+                  :plays_total, 
+                  :plays_trailing_week)
+    
+    # 
     # Class methods
     #
     class << self
-
+      
       # 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')
       #   Encosion::Video.find_by_reference_id('mycompany_1','mycompany_2','mycompany_3')
-
+      
       def find_by_reference_id(*args)
         options = extract_options(args)
         ids = args.flatten.compact.uniq
@@ -47,48 +47,48 @@ module Encosion
             raise AssetNotFound, "Couldn't find #{self.class} without a reference ID"
           when 1
             options.merge!({:reference_id => ids.first})
-            response = read('find_video_by_reference_id', options)
+            response = read('find_video_by_reference_id',options)
             return self.parse(response)
           else
             options.merge!({:reference_ids => ids.join(',')})
-            response = read('find_videos_by_reference_ids', options)
+            response = read('find_videos_by_reference_ids',options)
             return response['items'].collect { |item| self.parse(item) }
-        end
+          end
       end
-
+      
       # Find a video by text search. Invokes Brightcove Media API command 'find_videos_by_text'
       #   Encosion::Video.find_by_text('funny videos')
-
+      
       def find_by_text(*args)
         options = extract_options(args)
         text = args.flatten.compact.uniq
         raise AssetNotFound, "Couldn't find #{self.class} without text" if text == ''
         options.merge!({:text => text.first})
-        if response = read('find_videos_by_text', options)
+        if response = read('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)
-
+      
       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?
-        if response = read('find_related_videos', options)
+        if response = read('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')
-
+      
       def find_by_tags(*args)
         options = extract_options(args)
         tags = args.flatten.compact.uniq
@@ -98,53 +98,53 @@ module Encosion
             raise AssetNotFound, "Couldn't find #{self.class} without tags"
           else
             options.merge!({:and_tags => tags.join(',')})
-            if response = read('find_videos_by_tags', options)
+            if response = read('find_videos_by_tags',options)
               return response['items'].collect { |item| self.parse(item) }
             else
               return nil
             end
-        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 = write('get_upload_status', options)
+        
+        if response = write('get_upload_status',options)
           return response['result'].downcase.to_sym
         else
           return nil
         end
       end
-
-
+      
+      
       # the actual method that calls a get (user can use this directly if they want to call a method that's not included here)
-      def read(method, options)
+      def read(method,options)
         # options.merge!(Encosion.options)
         options.merge!({:token => Encosion.options[:read_token]}) unless options[:token]
-        get( Encosion.options[:server],
-             Encosion.options[:port],
-             Encosion.options[:secure],
-             Encosion.options[:read_path],
-             method,
-             options)
+        get(  Encosion.options[:server],
+              Encosion.options[:port],
+              Encosion.options[:secure],
+              Encosion.options[:read_path],
+              method,
+              options)
       end
-
-
+      
+      
       # the actual method that calls a post (user can use this directly if they want to call a method that's not included here)
-      def write(method, options)
+      def write(method,options)
         # options.merge!(Encosion.options)
         options.merge!({:token => Encosion.options[:write_token]}) unless options[:token]
         Video.post( Encosion.options[:server],
@@ -157,60 +157,57 @@ module Encosion
       end
 
       protected
-      # Find some videos by ids
-      def find_one(id, options)
-        options.merge!({:video_id => id})
-        response = read('find_video_by_id', options)
-        return self.parse(response)
-      end
-
-      # Find mutliple videos by id
-      def find_some(ids, options)
-        options.merge!({:video_ids => ids.join(',')})
-        response = read('find_videos_by_ids', options)
-        return response['items'].collect { |item| self.parse(item) }
-      end
-
-      # Find all videos
-      def find_all(options)
-        response = read('find_all_videos', options)
-
-        return response['items'].collect { |item| self.parse(item) }
-      end
-
-      def destroy(options)
-        response = read('delete_video', options)
-        return response['result']
-      end
-
-      # Creates a new Video object from a Ruby hash (used to create a video from a parsed API call)
-      def parse(obj)
-        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
+        # Find some videos by ids
+        def find_one(id, options)
+          options.merge!({:video_id => id})
+          response = read('find_video_by_id',options)
+          return self.parse(response)
         end
-      end
-
+      
+       
+        # Find mutliple videos by id
+        def find_some(ids, options)
+          options.merge!({:video_ids => ids.join(',')})
+          response = read('find_videos_by_ids',options)
+          return response['items'].collect { |item| self.parse(item) }
+        end
+      
+      
+        # Find all videos
+        def find_all(options)
+          response = read('find_all_videos', options)
+          return response['items'].collect { |item| self.parse(item) }
+        end
+        
+      
+        # Creates a new Video object from a Ruby hash (used to create a video from a parsed API call)
+        def parse(obj)
+          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
-
+        
     #
     # Instance methods
     #
@@ -234,14 +231,16 @@ module Encosion
       @plays_trailing_week = args[:plays_trailing_week]
       @file = args[:file]
     end
-
+    
+    
     # Saves a video to Brightcove. Returns the Brightcove ID for the video that was just uploaded.
     #   new_video = Encosion::Video.new(:file => File.new('/path/to/file'), :name => "My Awesome Video", :short_description => "A video of some awesome happenings", :tags => ['awesome','sweet'])
     #   brightcove_id = new_video.save(:token => '123abc')
+    
     def save(args={})
       # 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
+      options = args.merge({ 'video' => self.to_brightcove })   # take the parameters of this video and make them a valid video object for upload
       options.merge!({:token => Encosion.options[:write_token]}) unless options[:token]
       response = Video.post(Encosion.options[:server],
                             Encosion.options[:port],
@@ -250,13 +249,13 @@ module Encosion
                             'create_video',
                             options,
                             self)
-      return response['result'] # returns the Brightcove ID of the video that was just uploaded
+      return response['result']    # returns the Brightcove ID of the video that was just uploaded
     end
-
+    
+    
     # Output the video as JSON
     def to_json
-      {
-        :id => @id,
+      { :id => @id,
         :name => @name,
         :short_description => @short_description,
         :long_description => @long_description,
@@ -272,33 +271,34 @@ module Encosion
         :length => @length,
         :economics => @economics,
         :plays_total => @plays_total,
-        :plays_trailing_week => @plays_trailing_week
-      }.to_json
+        :plays_trailing_week => @plays_trailing_week }.to_json
     end
-
+    
+    
     # Outputs the video object into Brightcove's expected format
     def to_brightcove
-      {
-        'name' => @name,
+      { 'name' => @name,
         'shortDescription' => @short_description,
         'longDescription' => @long_description,
         'linkURL' => @link_url,
         'linkText' => @link_text,
         'tags' => @tags,
         'referenceId' => @reference_id,
-        'economics' => ENUMS[:economics][@economics]
-      }
+        'economics' => ENUMS[:economics][@economics] }
     end
-
+    
+    
     # Makes sure that the economics set on this video is one of a predetermined list
     def economics=(sym)
       unless sym.nil?
         unless ENUMS[:economics].has_key?(sym)
-          raise InvalidEconomicsValue, "A video's economics value must be one of #{ENUMS[:economics].collect { |key, value| key.inspect }.join(', ')}"
+          raise InvalidEconomicsValue, "A video's economics value must be one of #{ENUMS[:economics].collect { |key,value| key.inspect }.join(', ')}"
         else
           @economics = sym
         end
       end
     end
+    
   end
+  
 end

data/lib/encosion.rb

@@ -17,27 +17,27 @@ require 'encosion/playlist'
 require 'encosion/exceptions'
 
 module Encosion
-
-  VERSION = '0.3.0'
+  
+  VERSION = '0.3.1'
   LOGGER = Logger.new(STDOUT)
-
+  
   SERVER = 'api.brightcove.com'
   PORT = 80
   SECURE = false
   READ_PATH = '/services/library'
   WRITE_PATH = '/services/post'
   DEFAULT_OPTIONS = { :debug => false }
-
-  @options = {  :read_token => nil,
-                :write_token => nil,
-                :server => SERVER,
-                :port => PORT,
-                :secure => SECURE,
-                :read_path => READ_PATH,
+  
+  @options = {  :read_token => nil, 
+                :write_token => nil, 
+                :server => SERVER, 
+                :port => PORT, 
+                :secure => SECURE, 
+                :read_path => READ_PATH, 
                 :write_path => WRITE_PATH }
   attr_accessor :options
-
+  
   # make @options available so it can be set externally when using the library
   extend self
-
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: honkster-encosion
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Rob Cameron
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-06 00:00:00 -08:00
+date: 2009-11-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,7 +61,7 @@ files:
 - test/movie.mov
 - test/test_helper.rb
 has_rdoc: true
-homepage: http://github.com/cannikin/encosion
+homepage: http://github.com/honkster/encosion
 licenses: []
 
 post_install_message: