dm_cloud 0.0.1 → 0.0.3

data/README.md

@@ -1,4 +1,4 @@
-# DmCloud
+# DMCloud
 
 I created this gem to simplify request and responses from DailyMotion Cloud API.
 With this gem, you can :
@@ -23,9 +23,9 @@ Or install it yourself as:
 
 ## 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 ``
+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 `lib/dm_cloud/signing.rb`.  
 
     # DAILYMOTION CLOUD SETTINGS
     require 'dm_cloud'
@@ -39,23 +39,60 @@ You can note the securitylevel, for more information about it, take a look at ``
       :security_level =>  DMC_SECURITY_LEVEL
     })
 
-
-
-Second part, how to get you embed url :
+Description of security levels :
+
+  *  **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.  
+  
+
+Second part, get you embed url :  
+It will return a string containing the iframe with the DailyMotion Cloud player.  
 
     DMCloud::Streaming.embed('your video id looks like a secret key')
 
-Or how to get your direct url :
+Or how to get your direct url :  
+It will return a string containing the direct link to your file.  
 
     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.
+The next parts will come soon, just need some time to finish it  
+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.
+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`)

data/lib/dm_cloud/builder/media.rb

@@ -0,0 +1,132 @@
+module DMCloud
+  module Builder
+    module Media
+      def self.create(url = '', assets_names = [], meta = {})
+        request = Hash.new
+
+        request['url'] = url
+
+        if not meta.empty?
+          request['meta'] = {}
+          request['meta']['author'] = meta[:author] if meta[:author]
+          request['meta']['author'] = meta[:title] if meta[:title]
+        end
+
+        request['assets_names'] = assets_names if not assets_names.empty?
+
+        request.rehash
+      end
+      
+      def self.info(media_id, assets_names = ['source'], fields = {})
+        raise StandardError, "missing :media_id in params" unless media_id
+        request = Hash.new
+
+        puts 'media_id :' + media_id
+
+        # the media id
+        request['id'] = media_id
+        request['fields'] = []
+
+
+        # requested media meta datas
+        fields[:meta].each { |value| request['fields'] << "meta.#{value}" } if fields[:meta].present?
+
+        #the creation date as a unix timestamp
+        request['fields'] << 'created' if fields[:created]
+
+        # the url of the embed player
+        request['fields'] << 'embed_url' if fields[:embed_url]
+
+        # the ratio of the video frame as a float (eg: 16/9, 4/3, etc).
+        request['fields'] << 'frame_ratio' if fields[:frame_ratio]
+        # the worldwide statistics on the number of views
+        # request['fields'] << 'stats.global.last_week' if fields[:stats][:global]
+
+        # TODO: handle statistics request per country
+        # fields[:stats].each { |key| request << "meta.#{key.to_s}" } if fields[:meta].present?
+        # request['stats'][COUNTRY_CODE][TIME_INTERVAL] : the statistics on the number of views in a specific country (eg: stats.fr.total, stats.us.last_week, etc...)
+        # request['extended_stats'][COUNTRY_CODE][TIME_INTERVAL]
+
+        assets_names = ['source'] if assets_names.nil?
+        if not fields[:assets]
+          request = all_assets_fields(request, assets_names)
+        else
+          assets_names.each do |name|
+            fields[:assets].each { |value| request << "assets.#{name}.#{value.to_s}" }
+          end
+        end
+        
+        request
+      end
+      
+      def self.list(fields = {})
+        # raise StandardError, "missing :media_id in params" unless media_id
+        request = Hash.new
+
+        request['fields'] = []
+        # requested media meta datas
+        fields[:meta].each { |key| request << "meta.#{key.to_s}" } if fields[:meta].present?
+
+        #the creation date as a unix timestamp
+        request['fields'] << 'created' if fields[:created]
+
+        # the url of the embed player
+        request['fields'] << 'embed_url' if fields[:embed_url]
+
+        # the ratio of the video frame as a float (eg: 16/9, 4/3, etc).
+        request['fields'] << 'frame_ratio' if fields[:frame_ratio]
+
+        # TODO: handle global statistics request in another module
+        # the worldwide statistics on the number of views
+        # request << 'stats.global.last_week' if fields[:stats][:global]
+
+        # TODO: handle statistics request per country
+        # fields[:stats].each { |key| request << "meta.#{key.to_s}" } if fields[:meta].present?
+        # request['stats'][COUNTRY_CODE][TIME_INTERVAL] : the statistics on the number of views in a specific country (eg: stats.fr.total, stats.us.last_week, etc...)
+        # request['extended_stats'][COUNTRY_CODE][TIME_INTERVAL]
+        
+         assets_names = ['source'] if assets_names.nil?
+          if not fields[:assets]
+            request = all_assets_fields(request, assets_names)
+          else
+            assets_names.each do |name|
+              fields[:assets].each { |value| request << "assets.#{name}.#{value.to_s}" }
+            end
+          end
+
+          request
+      end
+
+
+      protected
+        # This method exclude stats, but return all information for a media (video or images)
+        def self.all_assets_fields(request, assets_names)
+          assets_names.each do |name|
+            request['fields'] << "assets.#{name}.download_url"
+            request['fields'] << "assets.#{name}.status"
+            request['fields'] << "assets.#{name}.container"
+            request['fields'] << "assets.#{name}.duration"
+            request['fields'] << "assets.#{name}.global_bitrate"
+            request['fields'] << "assets.#{name}.video_codec"
+            request['fields'] << "assets.#{name}.video_width"
+            request['fields'] << "assets.#{name}.video_height"
+            request['fields'] << "assets.#{name}.video_bitrate"
+            request['fields'] << "assets.#{name}.video_rotation"
+            request['fields'] << "assets.#{name}.video_fps"
+            request['fields'] << "assets.#{name}.video_fps_mode"
+            request['fields'] << "assets.#{name}.video_aspect"
+            request['fields'] << "assets.#{name}.video_interlaced"
+            request['fields'] << "assets.#{name}.audio_codec"
+            request['fields'] << "assets.#{name}.audio_bitrate"
+            request['fields'] << "assets.#{name}.audio_nbr_channel"
+            request['fields'] << "assets.#{name}.audio_samplerate"
+            request['fields'] << "assets.#{name}.created"
+            request['fields'] << "assets.#{name}.file_extension"
+            request['fields'] << "assets.#{name}.file_size"
+          end
+          request
+        end
+
+    end
+  end
+end

data/lib/dm_cloud/media.rb

@@ -1,3 +1,5 @@
+require 'dm_cloud/builder/media'
+
 module DMCloud
   class Media
     # Creates a new media object.
@@ -13,14 +15,14 @@ module DMCloud
     #       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"
+    def self.create(options)
+      call_type = "media.create"
 
       params = {
-        call: call,
-        args: DMCloud::Builder::Media.create(args)
+        :call =>  call_type,
+        args: Builder::Media.create(options)
       }
-      DMCloud::Request.execute(call, params)
+      DMCloud::Request.execute(call_type, params)
     end
     
     # Delete a media object with all its associated assets.
@@ -29,43 +31,55 @@ module DMCloud
     #   id (media ID) – (required) the id of the media object you want to delete.
     # Return :
     #   Nothing
-    def self.delete
-      call = "media.delete"
+    def self.delete(media_id)
+      call_type = "media.delete"
 
       params = {
-        call: call,
+        :call =>  call_type,
         args: { id: media_id}
       }
-      DMCloud::Request.execute(call, params)
+      DMCloud::Request.execute(call_type, params)
     end
     
-    def self.info(fields = [])
-      call = "media.info"
+    # 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.
+    def self.info(media_id, assets_names = ['source'], fields = [])
+      call_type = "media.info"
 
       params = {
-        call: call,
-        args: DMCloud::Builder::Media.info(fields)
+        :call =>  call_type,
+        args: DMCloud::Builder::Media.info(media_id, assets_names, fields)
       }
-      DMCloud::Request.execute(call, params)
+      DMCloud::Request.execute(call_type, params)
     end
     
-    # Gives information about a given media object.
+    # Returns a paginated list of media info structures.
+    # You must specify the fields you want to retrieve.
+    # The fields are described in the documentation of the method info.
     # 
-    # 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
+    # Parameters: 
+    #   options:
+    #     fields (Array) – (optional default return all informations) the fields to retrieve
+    #     page (Integer) – (optional) the page number, default: 1
+    #     per_page (Integer) – (optional) the number of objet per page, default: 10
+    #     Returns:  
+    #     an object with information for the pagination and the result of the query.
     def self.list(options = {})
-      call = "media.list"
+      call_type = "media.list"
+
       page = options[:page].present? ? options[:page] : 1
       per_page = options[:per_page].present? ? options[:per_page] : 10
 
       params = {
-        call: call,
+        :call =>  call_type,
         args: DMCloud::Builder::Media.list(options)
       }
-      DMCloud::Request.execute(call, params)
+      DMCloud::Request.execute(call_type, params)
     end
     
   end

data/lib/dm_cloud/request.rb

@@ -1,13 +1,38 @@
+require 'net/http'
+
 module DMCloud
   class Request
     
+    DAILYMOTION_API = 'http://api.dmcloud.net/api'
+    
+    def self.send_request(params)
+      puts 'params : ' + params.to_yaml
+      @uri = URI.parse(DAILYMOTION_API)
+
+      http    = Net::HTTP.new(@uri.host, @uri.port)
+      request = Net::HTTP::Post.new(@uri.request_uri)
+      # request.basic_auth @uri.user, @uri.password
+      request.content_type = 'application/json'
+      request.body = params.to_json
+      
+      puts 'request : ' + request.to_yaml
+      
+      http.request(request).body
+      
+    end
+    
     
     def self.execute(call, params = {})
-      request = DMCloud.identify(params)
+      request = DMCloud::Signing.identify(params)
       params.merge!({'auth' => request})
-      result = DMCloud::Request.new(params)
-      DMCloud::Response.parse(call, result)
+      result = send_request(params)
+      parse_response(result)
     end
     
+    def self.parse_response(result)
+      puts 'result : ' + result.to_yaml
+    end
+    
+    
   end
 end

data/lib/dm_cloud/signing.rb

@@ -1,5 +1,24 @@
 module DMCloud
   class Signing
+    # Generate auth token for request from Media
+    # Params:
+    #   request: A hash of params generated from Media methods and Media::MetaData
+    # Result :
+    #   return a string which contain the auth token for the request
+    #   <url>?auth=<expires>-<sec>-<nonce>-<md5sum>[-<pub-sec-data>]
+    def self.identify(request)
+      user_id  = DMCloud.config[:user_key]
+      api_key  = DMCloud.config[:secret_key]
+      
+      normalized_request = normalize(request).to_s
+      params = user_id + normalized_request + api_key
+      
+      checksum = Digest::MD5.hexdigest(params)
+      auth_token = user_id + ':' + checksum
+
+      auth_token
+    end
+    
     # 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:
@@ -142,5 +161,11 @@ module DMCloud
       end
       result
     end
+    
+    def self.normalize(params)
+      str = params.to_json.to_s
+      str.gsub!(/[^A-Za-z0-9]/, '')
+      str
+    end
   end
 end

data/lib/dm_cloud/version.rb

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

data/lib/dm_cloud.rb

@@ -36,14 +36,6 @@ module DMCloud
     @@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}"
@@ -58,9 +50,9 @@ module DMCloud
         class_variable_get(cv)
       end
     end
-
-    create_has_library :treaming
   
+    create_has_library :streaming
+    create_has_library :media
   
     class << self
       # Load a object saved on a file.
@@ -76,8 +68,9 @@ module DMCloud
     end
   
   autoload(:Streaming, 'dm_cloud/streaming')
-
-
+  autoload(:Media, 'dm_cloud/media')
+  autoload(:Request, 'dm_cloud/request')
+  autoload(:Signing, 'dm_cloud/signing')
 end
 
-Dir.glob('dm_cloud/**/*.rb').each{ |m| require File.dirname(__FILE__) + '/dm_cloud/' + m }
+# Dir.glob('dm_cloud/**/*.rb').each{ |m| require File.dirname(__FILE__) + '/dm_cloud/' + m }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dm_cloud
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -26,6 +26,7 @@ files:
 - Rakefile
 - dm_cloud.gemspec
 - lib/dm_cloud.rb
+- lib/dm_cloud/builder/media.rb
 - lib/dm_cloud/media.rb
 - lib/dm_cloud/request.rb
 - lib/dm_cloud/signing.rb