three_sixty 1.0.0

data/CHANGELOG

@@ -0,0 +1 @@
+3/22/2010 - Bundled existing code into formal gem hosted on Sorenson's gemcutter

data/Manifest

@@ -0,0 +1,25 @@
+CHANGELOG
+README
+Rakefile
+lib/sorenson/threesixty.rb
+lib/sorenson/threesixty/account.rb
+lib/sorenson/threesixty/account_summary.rb
+lib/sorenson/threesixty/asset.rb
+lib/sorenson/threesixty/asset_metrics.rb
+lib/sorenson/threesixty/base.rb
+lib/sorenson/threesixty/format_constraint.rb
+lib/sorenson/threesixty/rate_plan.rb
+lib/sorenson/threesixty/subaccount.rb
+lib/sorenson/threesixty/uploader.rb
+spec/account_spec.rb
+spec/account_summary_spec.rb
+spec/asset_metrics_spec.rb
+spec/asset_spec.rb
+spec/base_spec.rb
+spec/format_constraint_spec.rb
+spec/rate_plan_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/uploader_spec.rb
+tasks/rspec.rake
+Manifest

data/Rakefile

@@ -0,0 +1,21 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require 'rake'
+require 'rubygems'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'echoe'
+
+Echoe.new('three_sixty', '1.0.0') do |p|
+  p.description              = "Ruby bindings for Sorenson 360 Backend"
+  p.url                      = "https://github.com/sorenson/ThreeSixtyServices-Internal"
+  p.author                   = "Sorenson Media"
+  p.email                    = "video@sorensonmedia.com"
+  p.ignore_pattern           = ["tmp/*", "script/*"]
+  p.development_dependencies = %w(echoe rspec)
+end
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => :spec

data/lib/sorenson/threesixty/account.rb

@@ -0,0 +1,183 @@
+module Sorenson
+  module ThreeSixty
+    class Account < Base
+
+      # Attributes
+      attr_accessor :sessionId, :token, :gotoJuiceURL, :username, :status, :customerId, :id, :ratePlanExpirationDate, :dateLastModified, :sorensonId, :lastLoginTime, :dateRetrieved, :totalAssetCount, :ratePlan, :goto360URL, :subaccountId
+      
+      # Class Methods
+
+      def self._login(url)
+        new(post_to(url))
+      end
+      
+      def self.login(username, password)
+        _login("/api/loginApi?username=#{CGI.escape(username.to_s)}&password=#{CGI.escape(password.to_s)}")
+      end
+      
+      def self.find(accountId, sessionId)
+        new(post_to("/api/getAccount?accountId=#{accountId}&sessionId=#{sessionId}"), sessionId)
+      end
+
+      def self.loginWithAccountId(accountId, sessionId)
+        _login("/api/loginApi?accountId=#{accountId}&sessionId=#{sessionId}")
+      end
+
+      def self.doesAccountExist(username)
+        data = post_to("/api/doesAccountExist?username=#{username}")
+        !!data['accountExists']
+      end
+
+      # Alias for doesAccountExist
+      def self.exists?(username)
+        doesAccountExist(username)
+      end
+      
+      def self.activateAccount(username)
+        data = post_to("/api/activateAccount?username=#{username}&vToken=#{token_for(username)}")
+        !!data['success']
+      end
+      
+      def self.activate!(username)
+        activateAccount(username)
+      end
+      
+      def self.deactivate!(username)
+        deactivateAccount(username)
+      end
+
+      def self.deactivateAccount(username)
+        data = post_to("/api/deactivateAccount?username=#{username}&vToken=#{token_for(username)}")
+        !!data['success']
+      end
+      
+      def self.createAccount(username, password, ratePlanId, activate = false)
+        data = post_to("/api/createAccount?vToken=#{token_for(username)}&username=#{username}&password=#{password}&ratePlanId=#{ratePlanId}")
+        result = !!data['success']
+        
+        if (result)
+          updatePasswordHack(username, password)
+        end
+        
+        if (result && activate && activate!(username))
+          result = login(username, password)
+        end
+        result
+      end
+      
+      def self.updatePasswordHack(username, password)
+        data = post_to("/api/updatePassword?username=#{username}&password=#{password}&sessionId=blah")
+        !!data['success']
+      end
+      
+      def self.allAccounts
+        data = post_to("/api/getAllAccounts")
+      end
+      
+      
+      # Instance Methods
+      
+      def initialize(data, sessionId = nil)
+        self.sessionId                = data['sessionId'] || sessionId
+        self.token                    = data['token']
+        self.subaccountId             = data['subaccountId']
+        self.goto360URL               = data['gotoJuiceURL']
+
+        # depricated
+        self.gotoJuiceURL             = data['gotoJuiceURL']
+
+        # account specific data
+        account                       = data['account']
+        if account
+          self.username               = account['username']
+          self.status                 = account['status']
+          self.customerId             = account['id']
+          self.id                     = account['id']
+          self.ratePlanExpirationDate = account['ratePlanExpirationDate']
+          self.dateLastModified       = account['dateLastModified']
+          self.sorensonId             = account['sorensonId']
+          self.lastLoginTime          = account['lastLoginTime']
+          self.dateRetrieved          = account['dateRetrieved']
+          self.totalAssetCount        = getAssetCount
+
+          self.ratePlan              = RatePlan.new(account['ratePlan']) if account['ratePlan']
+        end
+      end
+      
+      def getAssets(offset = nil, quantity = nil)
+        assets = Asset.find_all(self, offset, quantity)
+        return assets if self.subaccountId.blank?
+
+        assets.select {|a| a.subaccountId == self.subaccountId}
+      end
+      
+      def getAsset(id)
+        Asset.find(self, id)
+      end
+
+      def getAssetCount
+        data = post_to("/api/getMediaListSummary?accountId=#{id}&sessionId=#{sessionId}")
+        data['totalMediaCount']
+      end
+
+      def getTotalStorageUsed
+        data = post_to("/api/getTotalStorageUsed?accountId=#{id}&sessionId=#{sessionId}")
+        data['storageUsed']
+      end
+      
+      def getTotalPlays
+        data = post_to("/api/getTotalPlays?accountId=#{id}&sessionId=#{sessionId}")
+        data['totalPlays']
+      end
+      
+      def getStorageUsed(startDate, endDate)
+        data = post_to("/api/getStorageUsed?accountId=#{id}&startDate=#{startDate}&endDate=#{endDate}&sessionId=#{sessionId}")
+        data['storageUsed']
+      end
+
+      def getOverageAction
+        data = post_to("/api/getOverageAction?accountId=#{id}&sessionId=#{sessionId}")
+        data['overageAction']
+      end
+      
+      def updatePassword(password)
+        data = post_to("/api/updatePassword?username=#{username}&password=#{password}&sessionId=#{sessionId}")
+        !!data['success']
+      end
+
+      def updateUsername(newUsername)
+        data = post_to("/api/updateUsername?username=#{username}&newUsername=#{newUsername}&sessionId=#{sessionId}")
+        !!data['success']
+      end
+      
+      def getAccountMetrics
+        data = post_to("/api/getAccountMetrics?accountId=#{id}&sessionId=#{sessionId}")
+        data['accountMetricsList']
+      end
+      
+      def getAssetMetrics(startDate, endDate)
+        AssetMetrics.find(self, startDate, endDate)
+      end
+      
+      def emptyTrash
+        data = post_to("/api/emptyTrash?accountId=#{id}&sessionId=#{sessionId}")
+        data
+      end
+      
+      def createSubaccount(username, email, password)
+        data = post_to("/api/createSubaccount?accountId=#{id}&sessionId=#{sessionId}&username=#{username}&email=#{email}&password=#{password}")
+        data['success'] == 1
+      end
+      
+      def getSubaccounts
+        data = post_to("/api/getAllSubaccounts?accountId=#{id}&sessionId=#{sessionId}")
+        subaccounts = []
+        data['subaccounts'].each do |data|
+          subaccounts << Sorenson::ThreeSixty::Subaccount.new(self, data)
+        end
+        subaccounts
+      end
+
+    end
+  end
+end

data/lib/sorenson/threesixty/account_summary.rb

@@ -0,0 +1,30 @@
+module Sorenson
+  module ThreeSixty
+    class AccountSummary < Base
+
+      # Attributes
+      attr_accessor :username, :status, :id, :ratePlanExpirationDate, :chosenRatePlan, :lastLoginTime
+      
+      # Class Methods
+      def self.getAccountSummaries
+        data = post_to("/api/getAllAccounts")
+        summaries = []
+        data['accounts'].each do |account|
+          summaries << AccountSummary.new(account)
+        end
+        summaries
+      end
+
+      # Instance Methods
+      
+      def initialize(data)
+        self.username               = data['username']
+        self.status                 = data['status']
+        self.id                     = data['id']
+        self.ratePlanExpirationDate = data['ratePlanExpirationDate']
+        self.chosenRatePlan         = data['chosenRatePlan']
+        self.lastLoginTime          = data['lastLoginTime']
+      end
+    end
+  end
+end

data/lib/sorenson/threesixty/asset.rb

@@ -0,0 +1,152 @@
+module Sorenson
+  module ThreeSixty
+    class Asset < Base
+      
+      # Attributes
+      attr_accessor :account, :encodeDate, :frameRate, :height, :dateLastModified, :videoBitrateMode, :mediaType, :id, :accountId, :numberOfViews, :presetXml, :application, :audioCodec, :permalinkLocation, :status, :description, :videoDuration, :abstractFileId, :versionId, :dateRetrieved, :audioDataRate, :audioBitrateMode, :videoCodec, :displayName, :name, :videoDataRate, :authorId, :width, :fileSize, :defaultEmbed, :thumbnailImageUrl, :filters, :embedList, :httpLocation, :directAssetUrl, :subaccountId, :videoGuid
+      
+      # Class Methods
+      def self.find_all(account, offset = nil, quantity = nil)
+        data = post_to("/api/getMediaList?offset=#{offset}&quantity=#{quantity}&accountId=#{account.id}&sessionId=#{account.sessionId}&status=Live&sort=uploadDate")
+        
+        assets = []
+        
+        data['mediaList'].each do |entry|
+          assets << Asset.new(account, entry) if account.subaccountId.blank? || account.subaccountId == entry['subaccountId']
+        end
+        
+        assets
+      end
+      
+      def self.find(account, id)
+        data = post_to("/api/getAsset?mguid=#{id}&sessionId=#{account.sessionId}")
+        Asset.new(account, data['media'].merge({'thumbLocation' => data['thumbLocation'], 'permalink' => data['permalinkLocation']}))
+      end
+      
+      def self.get_embed_codes(video_guid, sessionId, account)
+        data = post_to("/api/getAllEmbedcodes?vguid=#{video_guid}&sessionId=#{account.sessionId}")
+        data['embedList']
+      end
+
+      def self.get_streaming_server_url
+        "rtmp://cdnstreamingvideos.sorensonmedia.com/cfx/st" 
+      end
+        
+      # Instance Methods
+      def initialize(account, data)
+        self.account                = account
+        self.presetXml              = data['presetXml']
+        self.subaccountId           = data['subaccountId']
+        self.encodeDate             = data['encodeDate']
+        self.frameRate              = data['frameRate']
+        self.height                 = data['height']
+        self.dateLastModified       = data['dateLastModified']
+        self.videoBitrateMode       = data['videoBitrateMode']
+        self.mediaType              = data['mediaType']
+        self.id                     = data['id']
+        self.accountId              = data['accountId']
+        self.numberOfViews          = data['numberOfViews']
+        self.application            = data['application']
+        self.audioCodec             = data['audioCodec']
+        self.permalinkLocation      = data['permalink']
+        self.status                 = data['status']
+        self.description            = data['description']
+        self.videoDuration          = data['videoDuration']
+        self.abstractFileId         = data['abstractFileId']
+        self.versionId              = data['versionId']
+        self.dateRetrieved          = data['dateRetrieved']
+        self.audioDataRate          = data['audioDataRate']
+        self.audioBitrateMode       = data['audioBitrateMode']
+        self.videoCodec             = data['videoCodec']
+        self.displayName            = data['displayName']
+        self.name                   = data['name']
+        self.videoDataRate          = data['videoDataRate']
+        self.authorId               = data['authorId']
+        self.width                  = data['width']
+        self.fileSize               = data['fileSize']
+        self.thumbnailImageUrl      = data['thumbnail']['httpLocation'] if data['thumbnail']
+        self.thumbnailImageUrl      = data['thumbLocation'] if data['thumbLocation']
+        self.httpLocation           = data['httpLocation']
+        self.directAssetUrl         = "http://360.sorensonmedia.com/redirector/fetchFile?vguid=#{self.id}"
+        self.videoGuid              
+
+        self.filters = []
+        if data['filters']
+          data['filters'].each do |filter|
+            self.filters << filter['filterDescription']
+          end
+        end
+        
+        self.embedList = {}
+        get_embed_codes
+        
+        self.videoGuid = self.embedList.empty? ? nil : self.embedList.first[1].match(/videoGUID=(.*?)&/)[1]
+      end
+      
+      def get_streaming_video_path
+        data = post_to("/api/getPlayerData?vguid=#{self.videoGuid}&cms=true") 
+        data['media']['accessLocation']['s3KeyName']
+      end
+      
+      def delete
+        data = post_to("/api/deleteAsset?fileVersionId=#{id}&sessionId=#{account.sessionId}")
+      end
+
+      def deactivate
+        data = post_to("/api/deactivateAsset?fileVersionId=#{id}&sessionId=#{account.sessionId}")
+      end
+
+      def activate
+        data = post_to("/api/activateAsset?fileVersionId=#{id}&sessionId=#{account.sessionId}")
+      end
+      
+      def setName(name)
+        data = post_to("/api/setAssetName?fileVersionId=#{id}&newName=#{name}&sessionId=#{account.sessionId}")
+      end
+      
+      def setDescription(description)
+        data = post_to("/api/setAssetDescription?fileVersionId=#{id}&newDescription=#{description}&sessionId=#{account.sessionId}")
+      end
+
+      def setPassword(password)
+        data = nil
+        if password == '' || password.nil?
+          data = post_to("/api/removeAssetSecurity?fileVersionId=#{id}&security=#{password}&sessionId=#{account.sessionId}")
+        else
+          data = post_to("/api/setAssetSecurity?fileVersionId=#{id}&security=#{password}&sessionId=#{account.sessionId}")
+        end
+        data
+      end
+      
+      def getAllSubaccounts
+        data = post_to("/api/getAllSubaccount?accountId=#{id}&sessionId=#{sessionId}")
+        data
+      end
+            
+    private
+      def get_embed_codes
+        data = post_to("/api/getAllEmbedcodes?vguid=#{id}&sessionId=#{account.sessionId}")
+        
+        if data['embedList']
+          data['embedList'].each do |embed|
+            embed =~ /width="(\d+)"/
+            width = $1
+
+            embed =~ /height="(\d+)"/
+            height = $1
+            
+            ratio = (width.to_f / height.to_f)
+            
+            aspect = (ratio <= 1.33 ? 'Full Screen' : 'Widescreen')
+            
+            self.embedList["#{width}x#{height} - #{aspect}"] = embed
+            
+          end
+        end
+
+        self.defaultEmbed = data['defaultEmbed']
+      end
+      
+    end
+  end
+end

data/lib/sorenson/threesixty/asset_metrics.rb

@@ -0,0 +1,26 @@
+module Sorenson
+  module ThreeSixty
+    class AssetMetrics < Base
+      
+      attr_accessor :playTotal, :filePlayData, :playData
+
+      # Class Methods
+      def self.find(account, startDate, endDate)
+        data = post_to("/api/getAccountDashboardMetrics?accountId=#{account.id}&startDate=#{startDate}&endDate=#{endDate}")
+        AssetMetrics.new(data)
+      end
+      
+      # Instance Methods
+      def initialize(data)
+        self.playTotal                = data['playTotal']
+        self.filePlayData             = data['filePlayData']
+
+        self.playData = {}
+        data['playData'].each do |playData|
+          self.playData[playData['eventDay']] = playData['plays']
+        end
+      end
+
+    end
+  end
+end

data/lib/sorenson/threesixty/base.rb

@@ -0,0 +1,76 @@
+module Sorenson
+  module ThreeSixty
+    class InvalidServerResponse < Exception
+    end
+    
+    class Base
+      TOKEN_SALT = 'beachfr0nt'
+      @@debug   = false
+      @@use_ssl = false
+      
+      # Class Methods
+      def self.use_ssl?
+        !!@@use_ssl
+      end
+
+      def self.debug?
+        !!@@debug
+      end
+      
+      def self.use_ssl=(value)
+        @@use_ssl = value
+      end
+
+      def self.debug=(value)
+        @@debug = value
+      end
+      
+      def self.host
+        host = '360.sorensonmedia.com'
+        filename = '/var/tmp/360host'
+        if File.exist?(filename)
+          data = File.read(filename)
+          if data && data != ''
+            env = data.split("\n").first.strip
+            response = RestClient.get("http://www.sorensonmedia.com/internal/apis/360Env.php?env=#{env}").strip
+            host = response unless response == 'invalid option specified'
+          end
+        end
+
+        host
+      end
+      
+      def self.protocol
+        use_ssl? ? 'https://' : 'http://'
+      end
+      
+      def self.token_for(username)
+        Digest::SHA1.hexdigest(TOKEN_SALT + username)
+      end
+      
+      def self.post_to(url)
+        post_to_url = protocol + host + url
+        result = RestClient.post(post_to_url, {}).body
+
+        if debug?
+          puts '/// URL //////////////////////////////'
+          puts post_to_url
+          puts '/// DATA //////////////////////////////'
+          puts result
+        end
+
+        begin
+          JSON.parse(result)
+        rescue JSON::ParserError => e
+          raise InvalidServerResponse.new(e.message)
+        end
+      end
+      
+      # Instance Methods
+      def post_to(url)
+        self.class.post_to(url)
+      end
+      
+    end
+  end
+end

data/lib/sorenson/threesixty/format_constraint.rb

@@ -0,0 +1,36 @@
+module Sorenson
+  module ThreeSixty
+    class FormatConstraint < Base
+
+      attr_accessor :id, :name, :displayName, :defaultVideoDuration, :maxVideoDuration, :defaultFrameRate, :maxFrameRate, :maxWidth, :defaultWidth, :ratePlanId, :maxHeight, :defaultHeight, :defaultAudioDataRate, :maxAudioDataRate, :dateRetrieved, :defaultVideoDataRate, :maxVideoDataRate, :thumbnailGenerationMethod, :defaultAudioCodec, :defaultVideoCodec, :audioBitRateMode, :videoBitRateMode, :mediaType, :ratePlan
+
+      def initialize(ratePlan, data)
+        self.ratePlan                  = ratePlan
+        self.id                        = data['id']
+        self.name                      = data['name']
+        self.displayName               = data['displayName']
+        self.defaultVideoDuration      = data['defaultVideoDuration']
+        self.maxVideoDuration          = data['maxVideoDuration']
+        self.defaultFrameRate          = data['defaultFrameRate']
+        self.maxFrameRate              = data['maxFrameRate']
+        self.maxWidth                  = data['maxWidth']
+        self.defaultWidth              = data['defaultWidth']
+        self.ratePlanId                = data['ratePlanId']
+        self.maxHeight                 = data['maxHeight']
+        self.defaultHeight             = data['defaultHeight']
+        self.defaultAudioDataRate      = data['defaultAudioDataRate']
+        self.maxAudioDataRate          = data['maxAudioDataRate']
+        self.dateRetrieved             = data['dateRetrieved']
+        self.defaultVideoDataRate      = data['defaultVideoDataRate']
+        self.maxVideoDataRate          = data['maxVideoDataRate']
+        self.thumbnailGenerationMethod = data['thumbnailGenerationMethod']
+        self.defaultAudioCodec         = data['defaultAudioCodec']
+        self.defaultVideoCodec         = data['defaultVideoCodec']
+        self.audioBitRateMode          = data['audioBitRateMode']
+        self.videoBitRateMode          = data['videoBitRateMode']
+        self.mediaType                 = data['mediaType']
+      end
+      
+    end
+  end
+end

data/lib/sorenson/threesixty/rate_plan.rb

@@ -0,0 +1,63 @@
+module Sorenson
+  module ThreeSixty
+    class RatePlan < Base
+
+      attr_accessor :id, :displayName, :ratePlanType, :maxThumbnailsPerVideo, :setupCost, :monthlyCost, :allowedStreams, :basePlan, :dateLastModified, :dateRetrieved, :streamingOverageAllowed, :storageOverageAllowed, :allowedStreamingMBytes, :allowedStorageMBytes, :allowedSourceMediaTypes, :allowedOutputMediaTypes, :annualCost, :formatConstraints, :sorensonSku
+      
+      # Class Methods
+      def self.getBaseRatePlans
+        data = post_to('/api/getBaseRatePlans')
+        rate_plans = []
+        data['baseRatePlans'].each do |rate_plan|
+          rate_plans << RatePlan.new(rate_plan)
+        end
+        rate_plans
+      end
+      
+      def self.getAllRatePlans
+        data = post_to("/api/getAllRatePlans")
+        rate_plans = []
+        data['ratePlans'].each do |rate_plan|
+          rate_plans << RatePlan.new(rate_plan)
+        end
+        rate_plans
+      end
+      
+      def self.getRatePlan(id)
+        data = post_to("/api/getRatePlan?ratePlanId=#{id}")
+        RatePlan.new(data['ratePlanData'])
+      end
+      
+      # Instance Methods
+      def initialize(data)
+        self.id                       = data['id']
+        self.displayName              = data['displayName']
+        self.ratePlanType             = data['ratePlanType']
+        self.maxThumbnailsPerVideo    = data['maxThumbnailsPerVideo']
+        self.setupCost                = data['setupCost']
+        self.monthlyCost              = data['monthlyCost']
+        self.annualCost               = data['annualCost']
+        self.allowedStreams           = data['allowedStreams']
+        self.basePlan                 = data['basePlan']
+        self.dateLastModified         = data['dateLastModified']
+        self.dateRetrieved            = data['dateRetrieved']
+        self.streamingOverageAllowed  = data['streamingOverageAllowed']
+        self.storageOverageAllowed    = data['storageOverageAllowed']
+        self.allowedStreamingMBytes   = data['allowedStreamingMBytes']
+        self.allowedStorageMBytes     = data['allowedStorageMBytes']
+        self.allowedSourceMediaTypes  = data['allowedSourceMediaTypes'] # multi param
+        self.allowedOutputMediaTypes  = data['allowedOutputMediaTypes'] # multi param
+        self.sorensonSku              = data['sorensonSku']
+
+        self.formatConstraints = []
+        
+        if data['formatConstraints']
+          data['formatConstraints'].each do |f|
+            self.formatConstraints << FormatConstraint.new(self, f)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/sorenson/threesixty/subaccount.rb

@@ -0,0 +1,34 @@
+module Sorenson
+  module ThreeSixty
+    class Subaccount < Base
+
+      # Attributes
+      attr_accessor :account, :id, :username, :status, :accountId, :email, :dateRetrieved
+      
+      # Class Methods
+
+      # Instance Methods
+      
+      def initialize(account, data)
+        self.account                  = account
+        self.username                 = data['username']
+        self.id                       = data['id']
+        self.status                   = data['status']
+        self.accountId                = data['accountId']
+        self.email                    = data['email']
+        self.dateRetrieved            = data['dateRetrieved']
+      end
+      
+      def activate!
+        data = post_to("/api/setSubaccountStatus?subaccountId=#{id}&status=Live&sessionId=#{account.sessionId}")
+        data['success'] == 1
+      end
+      
+      def deactivate!
+        data = post_to("/api/setSubaccountStatus?subaccountId=#{id}&status=Retired&sessionId=#{account.sessionId}")
+        data['success'] == 1
+      end
+      
+    end
+  end
+end