dm_cloud 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dm_cloud.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeremy Mortelette
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# DmCloud
+
+I created this gem to simplify request and responses from DailyMotion Cloud API.
+With this gem, you can :
+- get generated embed code as a string
+- get direct access url to your files (I used this to provide video flux to TV-connected application)
+- (I'm working on ) video creation, delete, paginated lists and video informations (a/v encodings, bitrate, video lenght...)
+- (I'm working on ) CRUD on videos' meta-data
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dm_cloud'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dm_cloud
+
+## Usage
+
+First, your will need to specify your :user_id, :api_key and your security level.
+I used a file in `APP_ROOT/config/initializers/conf.rb`.
+You can note the securitylevel, for more information about it, take a look at ``
+
+    # DAILYMOTION CLOUD SETTINGS
+    require 'dm_cloud'
+    DMC_USER_ID = 'your user id'
+    DMC_SECRET = 'your api key'
+    DMC_SECURITY_LEVEL = :none
+    
+    DMCloud.configure( { 
+      :user_key    =>     DMC_USER_ID,
+      :secret_key =>      DMC_SECRET,
+      :security_level =>  DMC_SECURITY_LEVEL
+    })
+
+
+
+Second part, how to get you embed url :
+
+    DMCloud::Streaming.embed('your video id looks like a secret key')
+
+Or how to get your direct url :
+
+    DMCloud::Streaming.url('your video id', ['asset_name'], {options})
+
+The next parts will come soon, just need some time to finish its and create corresponding tests.
+
+## Contributing
+
+Your welcome to share and enhance this gem. 
+This is my first one (and not the last one) but I know some mistakes might be done by myself.
+I do my best and I'm open to all ideas or comments about my work.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dm_cloud.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dm_cloud/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dm_cloud"
+  gem.version       = DMCloud::VERSION
+  gem.authors       = ["Jeremy Mortelette"]
+  gem.email         = ["mortelette.jeremy@gmail.com"]
+  gem.description   = 'This gem will simplify usage of DailyMotion Cloud API, it represent api in ruby style, with automated handler for search and upload files'
+  gem.summary       = 'Simplify DailyMotion Cloud API usage'
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/dm_cloud/media.rb

@@ -0,0 +1,72 @@
+module DMCloud
+  class Media
+    # Creates a new media object.
+    # This method can either create an empty media object
+    # or also download a media with the url paramater
+    # and use it as the source to encode the ASSET_NAME listed in assets_names
+    # Params :
+    #   args: 
+    #     url: SCHEME://USER:PASSWORD@HOSTNAME/MY/PATH/FILENAME.EXTENSION (could be ftp or http)
+    #     author: an author name
+    #     title: a title for the film
+    #     assets_names: (Array) – (optional) the list of ASSET_NAME you want to transcode,
+    #       when you set this parameter you must also set the url parameter
+    # Return :
+    #   media_id: return the media id of the object
+    def self.create(media_id)
+      call = "media.create"
+
+      params = {
+        call: call,
+        args: DMCloud::Builder::Media.create(args)
+      }
+      DMCloud::Request.execute(call, params)
+    end
+    
+    # Delete a media object with all its associated assets.
+    # 
+    # Parameters: 
+    #   id (media ID) – (required) the id of the media object you want to delete.
+    # Return :
+    #   Nothing
+    def self.delete
+      call = "media.delete"
+
+      params = {
+        call: call,
+        args: { id: media_id}
+      }
+      DMCloud::Request.execute(call, params)
+    end
+    
+    def self.info(fields = [])
+      call = "media.info"
+
+      params = {
+        call: call,
+        args: DMCloud::Builder::Media.info(fields)
+      }
+      DMCloud::Request.execute(call, params)
+    end
+    
+    # Gives information about a given media object.
+    # 
+    # Params :
+    #   media_id: (media ID) – (required) the id of the new media object.
+    #   fields (Array) – (required) the list of fields to retrieve.
+    # Returns:	a multi-level structure containing about the media related to the requested fields.
+    Return type:	Object
+    def self.list(options = {})
+      call = "media.list"
+      page = options[:page].present? ? options[:page] : 1
+      per_page = options[:per_page].present? ? options[:per_page] : 10
+
+      params = {
+        call: call,
+        args: DMCloud::Builder::Media.list(options)
+      }
+      DMCloud::Request.execute(call, params)
+    end
+    
+  end
+end

data/lib/dm_cloud/request.rb

@@ -0,0 +1,13 @@
+module DMCloud
+  class Request
+    
+    
+    def self.execute(call, params = {})
+      request = DMCloud.identify(params)
+      params.merge!({'auth' => request})
+      result = DMCloud::Request.new(params)
+      DMCloud::Response.parse(call, result)
+    end
+    
+  end
+end

data/lib/dm_cloud/signing.rb

@@ -0,0 +1,146 @@
+module DMCloud
+  class Signing
+    # To sign a URL, the client needs a secret shared with Dailymotion Cloud.
+    # This secret is call client secret and is available in the back-office interface.
+    # Params:
+    #   expires: An expiration timestamp.
+    #   sec-level: A security level mask.
+    #   url-no-query: The URL without the query-string.
+    #   nonce: A 8 characters-long random alphanumeric lowercase string to make the signature unique.
+    #   secret: The client secret.
+    #   sec-data: If sec-level doesn’t have the DELEGATED bit activated,
+    #     this component contains concatenated informations 
+    #     for all activated sec levels.
+    #   pub-sec-data: Some sec level data have to be passed in clear in the signature.
+    #     To generate this component the parameters are serialized using x-www-form-urlencoded, compressed with gzip and encoded in base64.
+    # Result :
+    #   return a string which contain the signed url like 
+    #   <url>?auth=<expires>-<sec>-<nonce>-<md5sum>[-<pub-sec-data>]
+    def self.sign(stream)
+      raise StandardError, "missing :stream in params" unless stream
+      security = security(DMCloud.config[:security_level])
+      sec_data = security_data(DMCloud.config[:security_level])
+
+      base = { 
+        :sec_level => security(DMCloud.config[:security_level]),
+        :url_no_query => stream,
+        :expires => (Time.now + 1.hour).to_i,
+        :nonce => SecureRandom.hex(16)[0,8],
+        :secret => DMCloud.config[:secret_key]
+      }
+      base.merge!(:sec_data => sec_data, :pub_sec_data => sec_data) unless sec_data.nil?
+      puts base
+      digest_struct = build_digest_struct(base)
+
+      check_sum = Digest::MD5.hexdigest(digest_struct)
+
+      signed_url = [base[:expires], base[:sec_level], base[:nonce], check_sum].compact
+      signed_url.merge!(:pub_sec_data => sec_data) unless sec_data.nil?
+      
+      puts signed_url
+      
+      signed_url = signed_url.join('-')
+      signed_url
+    end
+    
+    # Prepare datas for signing
+    # Params :
+    #   base : contains media id and others for url signing
+    def self.build_digest_struct(base)
+      result = []
+      base.each_pair { |key, value| result << value }
+      result.join('')
+    end
+
+    # The client must choose a security level for the signature.
+    # Security level defines the mechanism used by Dailymotion Cloud architecture
+    # to ensure the signed URL will be used by a single end-user.
+    # Params :
+    #   type :
+    #     None: The signed URL will be valid for everyone
+    #     ASNUM: The signed URL will only be valid for the AS of the end-user.
+    #       The ASNUM (for Autonomous System Number) stands for the network identification,
+    #       each ISP have a different ASNUM for instance.
+    #     IP: The signed URL will only be valid for the IP of the end-user.
+    #       This security level may wrongly block some users
+    #       which have their internet access load-balanced between several proxies.
+    #       This is the case in some office network or some ISPs.
+    #     User-Agent: Used in addition to one of the two former levels, 
+    #       this level a limit on the exact user-agent of the end-user.
+    #       This is more secure but in some specific condition may lead to wrongly blocked users.
+    #     Use Once: The signed URL will only be usable once.
+    #       Note: should not be used with stream URLs.
+    #     Country: The URL can only be queried from specified countrie(s).
+    #       The rule can be reversed to allow all countries except some.
+    #     Referer: The URL can only be queried 
+    #       if the Referer HTTP header contains a specified value.
+    #       If the URL contains a Referer header with a different value,
+    #       the request is refused. If the Referer header is missing,
+    #       the request is accepted in order to prevent from false positives as some browsers, 
+    #       anti-virus or enterprise proxies may remove this header.
+    #     Delegate: This option instructs the signing algorithm 
+    #       that security level information won’t be embeded into the signature
+    #       but gathered and lock at the first use.
+    # Result :
+    #   Return a string which contain the signed url like 
+    #   http://cdn.dmcloud.net/route/<user_id>/<media_id>/<asset_name>.<asset_extension>?auth=<auth_token>
+    def self.security(type = nil)
+      type = :none unless type
+      type = type.to_sym if type.class == String
+      
+      result = case type
+        when :none
+          0 # None
+        when :delegate
+          1 << 0  # None
+        when :asnum
+          1 << 1  # The number part of the end-user AS prefixed by the ‘AS’ string (ie: as=AS41690)
+        when :ip
+          1 << 2  # The end-user quad dotted IP address (ie: ip=195.8.215.138)
+        when :user_agent
+          1 << 3  # The end-user browser user-agent (parameter name is ua)
+        when :use_once
+          1 << 4  # None
+        when :country
+          1 << 5  # A list of 2 characters long country codes in lowercase by comas. If the list starts with a dash, the rule is inverted (ie: cc=fr,gb,de or cc=-fr,it). This data have to be stored in pub-sec-data component
+        when :referer
+          1 << 6  # A list of URL prefixes separated by spaces stored in the pub-sec-data component (ex: rf=http;//domain.com/a/+http:/domain.com/b/).
+      end
+      result
+    end
+
+    def self.security_data(type, value = nil)
+      type = type.to_sym if type.class == String
+      
+      result = case type
+        when :asnum
+          "as=#{value}"  # The number part of the end-user AS prefixed by the ‘AS’ string (ie: as=AS41690)
+        when :ip
+          "ip=#{value}"  # The end-user quad dotted IP address (ie: ip=195.8.215.138)
+        when :user_agent
+          "ua=#{value}"  # The end-user browser user-agent (parameter name is ua)
+        when :country
+          "cc=#{value}"  # A list of 2 characters long country codes in lowercase by comas. If the list starts with a dash, the rule is inverted (ie: cc=fr,gb,de or cc=-fr,it). This data have to be stored in pub-sec-data component
+        when :referer
+          "rf=#{value}"  # A list of URL prefixes separated by spaces stored in the pub-sec-data component (ex: rf=http;//domain.com/a/+http:/domain.com/b/).
+        else
+          nil
+      end
+      result
+    end
+
+    def self.security_pub_sec_data(type, value)
+      type = type.to_sym if type.class == String
+      
+      result = case type
+        when :country
+          "cc=#{value}"  # A list of 2 characters long country codes in lowercase by comas. If the list starts with a dash, the rule is inverted (ie: cc=fr,gb,de or cc=-fr,it). This data have to be stored in pub-sec-data component
+        when :referer
+          "rf=#{value}"  # A list of URL prefixes separated by spaces stored in the pub-sec-data component (ex: rf=http;//domain.com/a/+http:/domain.com/b/).
+        else
+          nil
+      end
+      result
+    end
+  end
+end

data/lib/dm_cloud/streaming.rb

@@ -0,0 +1,67 @@
+require "time"
+require "openssl"
+require "base64"
+require 'digest/md5'
+
+module DMCloud
+  class Streaming
+      # Default URL to get embed content ou direct url
+      DIRECT_STREAM = '[PROTOCOL]://cdn.dmcloud.net/route/[USER_ID]/[MEDIA_ID]/[ASSET_NAME].[ASSET_EXTENSION]'
+      EMBED_STREAM = '[PROTOCOL]://api.dmcloud.net/embed/[USER_ID]/[MEDIA_ID]?auth=[AUTH_TOKEN]&skin=[SKIN_ID]'
+      EMBED_IFRAME = '<iframe width=[WIDTH] height=[HEIGHT] frameborder="0" scrolling="no" src="[EMBED_URL]"></iframe>'
+      # Get embeded player
+      # Params :
+      #   media_id: this is the id of the media (eg: 4c922386dede830447000009)
+      #   options:
+      #     skin_id: (optional) the id of the custom skin for the video player
+      #     width: (optional) the width for the video player frame
+      #     height: (optional) the height for the video player frame
+      # Result :
+      #   return a string which contain the signed url like 
+      #   <iframe width="848" height="480" frameborder="0" scrolling="no" src="http://api.dmcloud.net/embed/<user_id>/<media_id>?auth=<auth_token>&skin=<skin_id>"></iframe>
+      def self.embed(media_id, options = {})
+        raise StandardError, "missing :media_id in params" unless media_id
+        
+        skin_id = options[:skin_id].present? ? options[:skin_id]  : 'modern1'
+        width   = options[:width].present?   ? options[:width]    : '848'
+        height  = options[:height].present?  ? options[:height]   : '480'
+        
+        stream = EMBED_STREAM
+        stream.gsub!('[PROTOCOL]', DMCloud.config[:protocol])
+        stream.gsub!('[USER_ID]', DMCloud.config[:user_key])
+        stream.gsub!('[MEDIA_ID]', media_id)
+        stream.gsub!('[SKIN_ID]', skin_id)
+        stream += '?auth=[AUTH_TOKEN]'.gsub!('[AUTH_TOKEN]', DMCloud::Signing.sign(stream))
+
+        frame = EMBED_IFRAME
+        frame.gsub!('[WIDTH]', width)
+        frame.gsub!('[HEIGHT]', height)
+        frame.gsub!('[EMBED_URL]', stream)
+        frame
+      end
+      
+      # Get media url for direct link to the file on DailyMotion Cloud
+      # Params :
+      #   media_id: this is the id of the media (eg: 4c922386dede830447000009)
+      #   asset_name: the name of the asset you want to stream (eg: mp4_h264_aac)
+      #   asset_extension: the extension of the asset, most of the time it is the first part of the asset name (eg: mp4)
+      # Result :
+      #   return a string which contain the signed url like
+      #   http://cdn.dmcloud.net/route/<user_id>/<media_id>/<asset_name>.<asset_extension>?auth=<auth_token>
+      def self.url(media_id, asset_name, asset_extension = nil)
+        asset_extension = asset_name.split('_').first unless asset_extension
+
+        raise StandardError, "missing :media_id in params" unless media_id
+        raise StandardError, "missing :asset_name in params" unless asset_name
+
+        stream = DIRECT_STREAM
+        stream.gsub!('[PROTOCOL]', DMCloud.config[:protocol])
+        stream.gsub!('[USER_ID]', DMCloud.config[:user_key])
+        stream.gsub!('[MEDIA_ID]', media_id)
+        stream.gsub!('[ASSET_NAME]', asset_name)
+        stream.gsub!('[ASSET_EXTENSION]', asset_extension)
+        stream += '?auth=[AUTH_TOKEN]'.gsub!('[AUTH_TOKEN]', DMCloud::Signing.sign(stream))
+        stream
+      end
+  end
+end

data/lib/dm_cloud/version.rb

@@ -0,0 +1,3 @@
+module DMCloud
+  VERSION = "0.0.1"
+end

data/lib/dm_cloud.rb

@@ -0,0 +1,83 @@
+require "dm_cloud/version"
+require 'yaml'
+  
+module DMCloud
+  
+  # Configuration defaults
+  @@config = {
+    :security_level =>  'none',
+    :protocol => 'http'
+  }
+
+  YAML_INITIALIZER_PATH = File.dirname(__FILE__)
+  @valid_config_keys = @@config.keys
+
+  # Configure through hash
+  def self.configure(opts = {})
+    opts.each {|k,v| @@config[k.to_sym] = v } # if @valid_config_keys.include? k.to_sym}
+  end
+
+  # Configure through yaml file
+  def self.configure_with(yaml_file_path = nil)
+    yaml_file_path = YAML_INITIALIZER_PATH  unless yaml_file_path
+    begin
+      config = YAML::load(IO.read(path_to_yaml_file))
+    rescue Errno::ENOENT
+      log(:warning, "YAML configuration file couldn't be found. Using defaults."); return
+    rescue Psych::SyntaxError
+      log(:warning, "YAML configuration file contains invalid syntax. Using defaults."); return
+    end
+
+    configure(config)
+  end
+
+  def self.config
+    @@config = configure unless @@config
+    @@config
+  end
+  
+  def self.identify(request)
+    user_id  = @@config[:user_id]
+    api_key  = @@config[:api_key]
+    checksum = md5(user_id + normalize(request) + api_key)
+    
+    auth_token = user_id + ':' + checksum
+  end
+  
+  def self.create_has_library(library)
+      define_singleton_method("has_#{library}?") do
+        cv="@@#{library}"
+        if !class_variable_defined? cv
+          begin 
+            require library.to_s
+            class_variable_set(cv,true)
+          rescue LoadError
+            class_variable_set(cv,false)
+          end
+        end
+        class_variable_get(cv)
+      end
+    end
+
+    create_has_library :treaming
+  
+  
+    class << self
+      # Load a object saved on a file.
+      def load(filename)
+        if File.exists? filename
+          o=false
+          File.open(filename,"r") {|fp| o=Marshal.load(fp) }
+          o
+        else
+          false
+        end
+      end
+    end
+  
+  autoload(:Streaming, 'dm_cloud/streaming')
+
+
+end
+
+Dir.glob('dm_cloud/**/*.rb').each{ |m| require File.dirname(__FILE__) + '/dm_cloud/' + m }

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: dm_cloud
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Mortelette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-25 00:00:00.000000000 Z
+dependencies: []
+description: This gem will simplify usage of DailyMotion Cloud API, it represent api
+  in ruby style, with automated handler for search and upload files
+email:
+- mortelette.jeremy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dm_cloud.gemspec
+- lib/dm_cloud.rb
+- lib/dm_cloud/media.rb
+- lib/dm_cloud/request.rb
+- lib/dm_cloud/signing.rb
+- lib/dm_cloud/streaming.rb
+- lib/dm_cloud/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simplify DailyMotion Cloud API usage
+test_files: []