pili 1.3.1 → 1.5.0

data/example/example.rb

@@ -0,0 +1,181 @@
+require 'pili'
+
+# Replace with your keys here
+ACCESS_KEY  = 'Qiniu_AccessKey'
+SECRETE_KEY = 'Qiniu_SecretKey'
+
+# Replace with your hub name
+HUB_NAME = 'Pili_Hub_Name' # The Hub must be exists before use
+
+# Change API host as necessary
+# pili.qiniuapi.com as deafult
+# pili-lte.qiniuapi.com is the latest RC version
+Pili::Config.init api_host: 'pili-lte.qiniuapi.com'
+
+
+# Instantiate an Pili hub
+credentials = Pili::Credentials.new(ACCESS_KEY, SECRETE_KEY)
+hub = Pili::Hub.new(credentials, HUB_NAME)
+puts "Hub initialize =>\n#{hub.inspect}\n\n"
+
+
+# hub
+
+# Create a new Stream
+begin
+  title = nil            # optional, default is auto-generated
+  publish_key = nil      # optional, a secret key for signing the <publishToken>
+  publish_security = nil # optional, can be "dynamic" or "static", default is "dynamic"
+
+  # stream = hub.create_stream()
+  # or
+  stream = hub.create_stream(title: title, publish_key: publish_key, publish_security: publish_security)
+  puts "Hub create_stream() =>\n#{stream.inspect}\n\n"
+rescue Exception => e
+  puts "Hub create_stream() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+
+# Get a Stream
+begin
+  stream = hub.get_stream(stream.id)
+  puts "Hub get_stream() =>\n#{stream.inspect}\n\n"
+rescue Exception => e
+  puts "Hub get_stream() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+
+# List streams
+begin
+  marker = nil # optional
+  limit  = nil # optional
+  title  = nil # optional
+  streams = hub.list_streams(marker: marker, limit: limit, title: title)
+  puts "Hub list_streams() =>\n#{streams.inspect}\n\n"
+rescue Exception => e
+  puts "Hub list_streams() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+
+# Stream
+
+# To JSON String
+json_string = stream.to_json()
+puts "Stream stream.to_json() =>\n#{json_string}\n\n"
+
+
+# Update a Stream
+begin
+  publish_key = "new_secret_words" # optional, a secret key for signing the <publishToken>
+  publish_security = "static"      # optional, can be "dynamic" or "static", default is "dynamic"
+  disabled = nil                   # optional, can be true or false
+  stream = stream.update(publish_key: publish_key, publish_security: publish_security, disabled: disabled)
+  puts "Stream update() =>\n#{stream.inspect}\n\n"
+rescue Exception => e
+  puts "Stream update() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+
+# Disable a Stream
+begin
+  stream = stream.disable()
+  puts "Stream disable() =>\n#{stream.inspect}\n\n"
+rescue Exception => e
+  puts "Stream disable() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+
+# Enable a Stream
+begin
+  stream = stream.enable()
+  puts "Stream enable() =>\n#{stream.inspect}\n\n"
+rescue Exception => e
+  puts "Stream enable() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+
+# Get stream status
+begin
+  status_info = stream.status()
+  puts "Stream status() =>\n#{status_info.inspect}\n\n"
+rescue Exception => e
+  puts "Stream status() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+
+# Generate RTMP publish URL
+publish_url = stream.rtmp_publish_url()
+puts "Stream rtmp_publish_url() =>\n#{publish_url}\n\n"
+
+
+# Generate RTMP live play URLs
+urls = stream.rtmp_live_urls()
+puts "Stream rtmp_live_urls() =>\n#{urls.inspect}\n\n"
+
+
+# Generate HLS live play URLs
+urls = stream.hls_live_urls()
+puts "Stream hls_live_urls() =>\n#{urls.inspect}\n\n"
+
+
+# Generate HTTP-FLV live play URLs
+urls = stream.http_flv_live_urls()
+puts "Stream http_flv_live_urls() =>\n#{urls.inspect}\n\n"
+
+
+# Get stream segments
+begin
+  start_time = nil  # optional, integer, in second, unix timestamp
+  end_time   = nil  # optional, integer, in second, unix timestamp
+  limit      = nil  # optional, uint
+  segments = stream.segments(start_time: start_time, end_time: end_time, limit: limit)
+  puts "Stream segments() =>\n#{segments.inspect}\n\n"
+rescue Exception => e
+  puts "Stream segments() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+
+# Generate HLS playback URLs
+start_time = 1440196065    # required, integer, in second, unix timestamp
+end_time   = 1440196105    # required, integer, in second, unix timestamp
+urls = stream.hls_playback_urls(start_time, end_time)
+puts "Stream hls_playback_urls() =>\n#{urls.inspect}\n\n"
+
+
+
+# Snapshot
+begin
+  name       = "imageName.jpg" # required, string
+  format     = "jpg"           # required, string
+  options = {
+    :time       => 1440067100, # optional, int64, in second, unix timestamp
+    :notify_url => nil         # optional
+  }
+  result = stream.snapshot(name, format, options)
+  puts "Stream snapshot() =>\n#{result.inspect}\n\n"
+rescue Exception => e
+  puts "Stream snapshot() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+
+# Save Stream as
+begin
+  name       = "videoName.mp4" # required, string
+  format     = "mp4"           # required, string
+  start_time = 1440067100      # required, int64, in second, unix timestamp
+  end_time   = 1440068104      # required, int64, in second, unix timestamp
+  notify_url = nil             # optional
+  result = stream.save_as(name, format, start_time, end_time, notify_url)
+  puts "Stream save_as() =>\n#{result.inspect}\n\n"
+rescue Exception => e
+  puts "Stream save_as() failed. Caught exception:\n#{e.http_body}\n\n"
+end
+
+
+# Delete a stream
+begin
+  result = stream.delete()
+  puts "Stream delete() =>\n#{result.inspect}\n\n"
+rescue Exception => e
+  puts "Stream delete() failed. Caught exception:\n#{e.http_body}\n\n"
+end

data/lib/pili/api.rb

@@ -5,70 +5,115 @@ module Pili
   module API
     class << self
 
-      def get(access_key, secret_key, url)
-        signature_options = {
-          :url => url,
-          :method => "GET"
+      def create_stream(credentials, hub_name, options = {})
+        url = "/streams"
+
+        body = {
+          :hub              => hub_name,
+          :title            => options[:title],
+          :publishKey       => options[:publish_key],
+          :publishSecurity  => options[:publish_security] == "static" ? "static" : "dynamic",
+          :clientIp         => options[:client_ip]
         }
 
-        encoded_sign = Auth.sign(secret_key, Auth.generate_signature(signature_options))
+        body.delete_if { |k, v| v.nil? }
 
-        headers = { "Authorization" => "Qiniu #{access_key}:#{encoded_sign}" }
+        Stream.new credentials, RPC.post(credentials, url, body)
+      end
+
+
+      def get_stream(credentials, stream_id)
+        url = "/streams/" + stream_id
+        Stream.new credentials, RPC.get(credentials, url)
+      end
 
-        response = HTTParty.get(url, :headers => headers)
 
-        if response.code == 200
-          response.parsed_response
-        else
-          raise ResponseError.new("Pili API Request Error", response)
+      def list_streams(credentials, hub_name, options = {})
+        url = "/streams?hub=#{hub_name}"
+
+        url += "&marker=#{options[:marker]}" unless Utils.blank?(options[:marker])
+        url += "&limit=#{options[:limit]}"   if options[:limit].is_a?(Fixnum)
+        url += "&title=#{options[:title]}"   unless Utils.blank?(options[:title])
+
+        streams = []
+
+        RPC.get(credentials, url)["items"].each do |item|
+          streams << Stream.new(credentials, item)
         end
+
+        streams
       end
 
 
-      def post(access_key, secret_key, url, body)
-        signature_options = {
-          :url => url,
-          :content_type => "application/json",
-          :method => "POST",
-          :body => body
-        }
+      def get_stream_status(credentials, stream_id)
+        url = "/streams/#{stream_id}/status"
+        RPC.get(credentials, url)
+      end
 
-        encoded_sign = Auth.sign(secret_key, Auth.generate_signature(signature_options))
 
-        headers = {
-          "Authorization" => "Qiniu #{access_key}:#{encoded_sign}",
-          "Content-Type"  => "application/json"
-        }
+      def update_stream(credentials, stream_id, options = {})
+        url = "/streams/" + stream_id
 
-        response = HTTParty.post(url, :headers => headers, :body => body.to_json)
+        body = {}
+        body[:publishKey]      = options[:publish_key]
+        body[:publishSecurity] = options[:publish_security] == "static" ? "static" : "dynamic"
+        body[:disabled]        = options[:disabled]
 
-        if response.code == 200
-          response.parsed_response
-        else
-          raise ResponseError.new("Pili API Request Error", response)
-        end
+        body.delete_if { |k, v| v.nil? }
+
+        Stream.new credentials, RPC.post(credentials, url, body)
       end
 
 
-      def delete(access_key, secret_key, url)
-        signature_options = {
-          :url => url,
-          :method => "DELETE"
-        }
+      def delete_stream(credentials, stream_id)
+        url = "/streams/" + stream_id
+        RPC.delete(credentials, url)
+      end
 
-        encoded_sign = Auth.sign(secret_key, Auth.generate_signature(signature_options))
 
-        headers = { "Authorization" => "Qiniu #{access_key}:#{encoded_sign}" }
+      def get_stream_segments(credentials, stream_id, options = {})
+        url = "/streams/#{stream_id}/segments"
 
-        response = HTTParty.delete(url, :headers => headers)
+        url += "?start=#{options[:start]}" if options[:start].is_a?(Fixnum)
+        url += "&end=#{options[:end]}"     if options[:end].is_a?(Fixnum)
+        url += "&limit=#{options[:limit]}" if options[:limit].is_a?(Fixnum)
 
-        if response.code == 204
-          response.parsed_response
-        else
-          raise ResponseError.new("Pili API Request Error", response)
-        end
+        response = RPC.get(credentials, url)
+        response["segments"] || []
+      end
+
+
+      def save_stream_as(credentials, stream_id, name, format, start_time, end_time, notify_url = nil)
+        url = "/streams/" + stream_id + "/saveas"
+
+        body = {}
+        body[:name]      = name
+        body[:format]    = format
+        body[:start]     = start_time
+        body[:end]       = end_time
+        body[:notifyUrl] = notify_url
+
+        body.delete_if { |k, v| v.nil? }
+
+        RPC.post(credentials, url, body)
       end
 
+
+      def snapshot(credentials, stream_id, name, format, options = {})
+        url = "/streams/" + stream_id + '/snapshot'
+
+        body = {}
+        body[:name]      = name
+        body[:format]    = format
+        body[:time]      = options[:time]
+        body[:notifyUrl] = options[:notify_url]
+
+        body.delete_if { |k, v| v.nil? }
+
+        RPC.post(credentials, url, body)
+      end
+
+
     end
   end
 end

data/lib/pili/config.rb

@@ -3,20 +3,23 @@ module Pili
   module Config
     class << self
 
-      API_SCHEME  = "http"
-      API_HOST    = "pili.qiniuapi.com"
-      API_VERSION = "v1"
+      @@settings = {
+        :api_scheme  => "http",
+        :api_host    => "pili.qiniuapi.com",
+        :api_version => "v1",
+        :origin      => "ORIGIN"
+      }
 
-      # def init(options = {})
-      #   @settings = DEFAULT_OPTIONS.merge!(options)
-      #   REQUIRED_OPTION_KEYS.each do |opt|
-      #     raise("You did not provide both required args. Please provide the #{opt}.") unless @settings.has_key?(opt)
-      #   end
-      #   @settings
-      # end
+      def init(options = {})
+        @@settings.merge!(options)
+      end
 
       def api_base_url
-        "#{API_SCHEME}://#{API_HOST}/#{API_VERSION}"
+        "#{@@settings[:api_scheme]}://#{@@settings[:api_host]}/#{@@settings[:api_version]}"
+      end
+
+      def origin
+        @@settings[:origin]
       end
 
     end

data/lib/pili/{auth.rb → credentials.rb}

@@ -4,7 +4,17 @@ require 'base64'
 require 'uri'
 
 module Pili
-  module Auth
+  class Credentials
+
+    attr_reader :access_key, :secret_key
+
+
+    def initialize(access_key, secret_key)
+      @access_key = access_key
+      @secret_key = secret_key
+    end
+
+
     class << self
 
       def base64_url_encode(string)

data/lib/pili/hub.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+module Pili
+  class Hub
+
+    attr_reader :credentials, :hub_name
+
+
+    def initialize(credentials, hub_name)
+      @credentials = credentials
+      @hub_name   = hub_name
+    end
+
+
+    def create_stream(options = {})
+      API.create_stream(@credentials, @hub_name, options)
+    end
+
+
+    def get_stream(stream_id)
+      API.get_stream(@credentials, stream_id)
+    end
+
+
+    def list_streams(options = {})
+      API.list_streams(@credentials, @hub_name, options)
+    end
+
+  end
+end

data/lib/pili/rpc.rb

@@ -0,0 +1,80 @@
+# coding: utf-8
+require 'httparty'
+
+module Pili
+  module RPC
+    class << self
+
+      def get(credentials, url)
+        url = Config.api_base_url + url
+
+        signature_options = {
+          :url => url,
+          :method => "GET"
+        }
+
+        encoded_sign = Credentials.sign(credentials.secret_key, Credentials.generate_signature(signature_options))
+
+        headers = { "Authorization" => "Qiniu #{credentials.access_key}:#{encoded_sign}" }
+
+        response = HTTParty.get(url, :headers => headers)
+
+        if response.code == 200
+          response.parsed_response
+        else
+          raise ResponseError.new("Pili API Request Error", response)
+        end
+      end
+
+
+      def post(credentials, url, body)
+        url = Config.api_base_url + url
+
+        signature_options = {
+          :url => url,
+          :content_type => "application/json",
+          :method => "POST",
+          :body => body
+        }
+
+        encoded_sign = Credentials.sign(credentials.secret_key, Credentials.generate_signature(signature_options))
+
+        headers = {
+          "Authorization" => "Qiniu #{credentials.access_key}:#{encoded_sign}",
+          "Content-Type"  => "application/json"
+        }
+
+        response = HTTParty.post(url, :headers => headers, :body => body.to_json)
+
+        if response.code == 200
+          response.parsed_response
+        else
+          raise ResponseError.new("Pili API Request Error", response)
+        end
+      end
+
+
+      def delete(credentials, url)
+        url = Config.api_base_url + url
+
+        signature_options = {
+          :url => url,
+          :method => "DELETE"
+        }
+
+        encoded_sign = Credentials.sign(credentials.secret_key, Credentials.generate_signature(signature_options))
+
+        headers = { "Authorization" => "Qiniu #{credentials.access_key}:#{encoded_sign}" }
+
+        response = HTTParty.delete(url, :headers => headers)
+
+        if response.code == 204
+          response.parsed_response
+        else
+          raise ResponseError.new("Pili API Request Error", response)
+        end
+      end
+
+    end
+  end
+end

data/lib/pili/stream.rb

@@ -2,16 +2,12 @@
 module Pili
   class Stream
 
-    LIVE_URL_ORIGIN_KEY = "ORIGIN"
-
-    attr_reader :client
-    attr_reader :id, :created_at, :updated_at, :title, :hub, :profiles, :hosts
-
+    attr_reader :credentials, :id, :created_at, :updated_at, :title, :hub, :profiles, :hosts
     attr_accessor :publish_key, :publish_security, :disabled
 
 
-    def initialize(client, options = {})
-      @client           = client
+    def initialize(credentials, options = {})
+      @credentials      = credentials
       @id               = options["id"]
       @title            = options["title"]
       @hub              = options["hub"]
@@ -27,46 +23,32 @@ module Pili
 
 
     def status
-      url = Config.api_base_url + "/streams/#{@id}/status"
-      API.get(@client.access_key, @client.secret_key, url)
+      API.get_stream_status(@credentials, @id)
     end
 
 
     def update(options = {})
-      url = Config.api_base_url + "/streams/" + @id
-
-      body = {}
-      body[:publishKey]      = options[:publish_key]
-      body[:publishSecurity] = options[:publish_security] == "static" ? "static" : "dynamic"
-      body[:disabled]        = options[:disabled]
+      API.update_stream(@credentials, @id, self.to_h.merge!(options))
+    end
 
-      body.delete_if { |k, v| v.nil? }
 
-      stream = API.post(@client.access_key, @client.secret_key, url, body)
+    def enable
+      API.update_stream(@credentials, @id, disabled: false)
+    end
 
-      @publish_key      = stream["publishKey"]
-      @publish_security = stream["publishSecurity"]
-      @disabled         = stream["disabled"]
-      @updated_at       = stream["updatedAt"]
 
-      self
+    def disable
+      API.update_stream(@credentials, @id, disabled: true)
     end
 
 
     def delete
-      url = Config.api_base_url + "/streams/" + @id
-      API.delete(@client.access_key, @client.secret_key, url)
+      API.delete_stream(@credentials, @id)
     end
 
 
     def segments(options = {})
-      url = Config.api_base_url + "/streams/#{@id}/segments"
-
-      url += "?start=#{options[:start]}" if options[:start].is_a?(Fixnum)
-      url += "&end=#{options[:end]}"     if options[:end].is_a?(Fixnum)
-
-      response = API.get(@client.access_key, @client.secret_key, url)
-      response["segments"] || []
+      API.get_stream_segments(@credentials, @id, options)
     end
 
 
@@ -77,19 +59,32 @@ module Pili
         return "rtmp://#{rtmp_publish_host}/#{@hub}/#{@title}?key=#{@publish_key}"
       else
         nonce = Time.now.to_i
-        token = Auth.sign(publish_key, "/#{@hub}/#{@title}?nonce=#{nonce}")
+        token = Credentials.sign(publish_key, "/#{@hub}/#{@title}?nonce=#{nonce}")
         return "rtmp://#{rtmp_publish_host}/#{@hub}/#{@title}?nonce=#{nonce}&token=#{token}"
       end
     end
 
 
     def rtmp_live_urls
-      rtmp_play_host = @hosts["play"]["rtmp"]
+      live_rtmp_host = @hosts["live"]["rtmp"]
 
-      urls = { LIVE_URL_ORIGIN_KEY => "rtmp://#{rtmp_play_host}/#{@hub}/#{@title}" }
+      urls = { Config.origin => "rtmp://#{live_rtmp_host}/#{@hub}/#{@title}" }
 
       @profiles.each do |profile|
-        urls[profile] = "rtmp://#{rtmp_play_host}/#{@hub}/#{@title}@#{profile}"
+        urls[profile] = "rtmp://#{live_rtmp_host}/#{@hub}/#{@title}@#{profile}"
+      end
+
+      urls
+    end
+
+
+    def http_flv_live_urls
+      live_http_host = @hosts["live"]["http"]
+
+      urls = { Config.origin => "http://#{live_http_host}/#{@hub}/#{@title}.flv" }
+
+      @profiles.each do |profile|
+        urls[profile] = "http://#{live_http_host}/#{@hub}/#{@title}@#{profile}.flv"
       end
 
       urls
@@ -97,12 +92,12 @@ module Pili
 
 
     def hls_live_urls
-      hls_play_host = @hosts["play"]["hls"]
+      live_http_host = @hosts["live"]["http"]
 
-      urls = { LIVE_URL_ORIGIN_KEY => "http://#{hls_play_host}/#{@hub}/#{@title}.m3u8" }
+      urls = { Config.origin => "http://#{live_http_host}/#{@hub}/#{@title}.m3u8" }
 
       @profiles.each do |profile|
-        urls[profile] = "http://#{hls_play_host}/#{@hub}/#{@title}@#{profile}.m3u8"
+        urls[profile] = "http://#{live_http_host}/#{@hub}/#{@title}@#{profile}.m3u8"
       end
 
       urls
@@ -110,12 +105,12 @@ module Pili
 
 
     def hls_playback_urls(start_second, end_second)
-      hls_play_host = @hosts["play"]["hls"]
+      playback_http_host = @hosts["playback"]["http"]
 
-      urls = { LIVE_URL_ORIGIN_KEY => "http://#{hls_play_host}/#{@hub}/#{@title}.m3u8?start=#{start_second}&end=#{end_second}" }
+      urls = { Config.origin => "http://#{playback_http_host}/#{@hub}/#{@title}.m3u8?start=#{start_second}&end=#{end_second}" }
 
       @profiles.each do |profile|
-        urls[profile] = "http://#{hls_play_host}/#{@hub}/#{@title}@#{profile}.m3u8?start=#{start_second}&end=#{end_second}"
+        urls[profile] = "http://#{playback_http_host}/#{@hub}/#{@title}@#{profile}.m3u8?start=#{start_second}&end=#{end_second}"
       end
 
       urls
@@ -138,19 +133,30 @@ module Pili
     end
 
 
-    def save_as(name, format, start_time, end_time, options = {})
-      url = Config.api_base_url + "/streams/" + @id + "/saveas"
+    def snapshot(name, format, options = {})
+      API.snapshot(@credentials, @id, name, format, options)
+    end
+
 
-      body = {}
-      body[:name]      = name
-      body[:start]     = start_time
-      body[:end]       = end_time
-      body[:format]    = format
-      body[:notifyUrl] = options[:notify_url]
+    def save_as(name, format, start_time, end_time, notify_url = nil)
+      API.save_stream_as(@credentials, @id, name, format, start_time, end_time, notify_url)
+    end
 
-      body.delete_if { |k, v| v.nil? }
 
-      API.post(@client.access_key, @client.secret_key, url, body)
+    def to_h
+      {
+        credentials:      @credentials,
+        id:               @id,
+        title:            @title,
+        hub:              @hub,
+        profiles:         @profiles,
+        publish_key:      @publish_key,
+        publish_security: @publish_security,
+        disabled:         @disabled,
+        hosts:            @hosts,
+        created_at:       @created_at,
+        updated_at:       @updated_at
+      }
     end
 
   end