pili 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6918ddfd702871e46a8c932baea8cbf0c16a457d
-  data.tar.gz: b2617beca716642aea1c4e3f9a0edb89e591ef88
+  metadata.gz: 1493919dcc89f8b6bb9168d6a1c9d85705274015
+  data.tar.gz: d438490de6ce1e2bdb4943633c7d360bf3e7e037
 SHA512:
-  metadata.gz: 02b7b8c625d8158361e548e301762057c78c2f7752e2cc2301a405453b1d15735c045df02ad5b798de5f46dadb4007cbcc3e3b7faca55da077048d15bd10c733
-  data.tar.gz: ecdc2ab510ab493bc3f55ac63b4c61f538ffa28dbb9d03ee8b146bd3e48442990956bc8ab6d3dd656a3c095182980a1b830d41192624bbc19a1f533ea5e9e77a
+  metadata.gz: 5a0be7f785b1b5250557cd773008bb2612fc041fdb4bd7a5cb96ca0dc24d9a96abb2c7f8bb883b3dcb984361297c6a0226ccad980149cbe106f2d2078b4d6d56
+  data.tar.gz: 8fc2c7a27ed24045fbcf499ec20b2dd826f5e7403bbe09132a379f614c61cea9414fd4982c700badf64819a4ec9c248b01b49974806e20311ba7773ab2017d55

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    pili (0.0.1)
+      httparty (~> 0.13.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.2)
+    multi_xml (0.5.5)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  pili!
+  rake (~> 10.0)

data/README.md

@@ -1,4 +1,102 @@
-pili-ruby
+# pili-ruby
 =========
 
 pili-io Ruby SDK
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pili'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pili
+
+## Usage
+
+### Initialize
+
+	require 'pili'
+	
+	Pili.setup! access_key: '<YOUR_APP_ACCESS_KEY>', 
+				secret_key: '<YOUR_APP_SECRET_KEY>'	
+#### with rails:
+
+You'll need to configure it in config/initializes/pili.rb
+
+
+### Create Stream
+
+	Pili.create_stream(hub_name)
+	
+	# with options
+	stream_options = {
+		title:				"test_name", 	# optional, default is auto-generated
+        publish_key:		"test_key",   	# optional, a secret key for signing the <publishToken>
+        publish_security: 	"dynamic"		# optional, can be "dynamic" or "static", default is "dynamic"
+	}
+
+	Pili.create_stream(hub_name, stream_options)
+
+### Get Stream
+
+	Pili.create_stream(stream_id)
+	
+### Update Stream
+
+	Pili.update_stream(stream_id, publish_key: publish_key, publish_security: publish_security)
+	
+### Get Stream List
+
+	Pili.stream_list(hub)
+	
+	# marker, limit: integer, optional
+	Pili.stream_list(hub, marker: marker, limit: limit)
+
+### Delete Stream
+
+	Pili.delete_stream(stream_id)
+	
+### Get Stream Segments
+	Pili.get_stream_segments(stream_id)
+	
+	# start, end: integer, optional
+	Pili.get_stream_segments(stream_id, start: timestamp, end: timestamp)
+
+### Get Stream Publish URL
+
+	Pili.get_stream_publish_url(stream_id, publish_key, publish_security)
+	Pili.get_stream_publish_url(stream_id, publish_key, publish_security, timestamp)
+	
+### Get Stream RTMP Live URL
+
+	Pili.get_stream_rtmp_live_url(stream_id)
+	Pili.get_stream_rtmp_live_url(stream_id, preset)
+
+### Get Stream HLS Live URL
+
+	Pili.get_stream_hls_live_url(stream_id)
+	Pili.get_stream_hls_live_url(stream_id, preset)
+	
+### Get Stream HLS Playback URL
+
+	Pili.get_stream_hls_playback_url(stream_id, start_second, end_second)
+	Pili.get_stream_hls_playback_url(stream_id, start_second, end_second, preset)
+	
+
+## Contributing
+
+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
+
+## Contributors
+
+See the [Contributors List](https://github.com/pili-io/pili-sdk-ruby/graphs/contributors).

data/Rakefile

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

data/lib/pili/auth.rb

@@ -0,0 +1,55 @@
+# coding: utf-8
+require 'openssl'
+require 'base64'
+require 'uri'
+
+module Pili
+  module Auth
+    class << self
+
+      def base64_url_encode(string)
+        Base64.encode64(string).tr("+/", "-_").gsub(/[\n\r]?/, "")
+      end
+
+      def digest(secret, bytes)
+        OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), secret, bytes)
+      end
+
+      def sign(secret, bytes)
+        base64_url_encode(digest(secret, bytes))
+      end
+
+      def generate_signature(options = {})
+        method        = options[:method]
+        url           = options[:url]
+        content_type  = options[:content_type]
+        body          = options[:body]
+
+        uri = URI.parse(url)
+
+        signature = "#{method} #{uri.path}"
+
+        query_string = uri.query
+
+        if !query_string.nil? && !query_string.empty?
+          signature += '?' + query_string
+        end
+
+        signature += "\nHost: #{uri.host}"
+
+        if !content_type.nil? && !content_type.empty? && content_type != "application/octet-stream"
+          signature += "\nContent-Type: #{content_type}"
+        end
+
+        signature += "\n\n"
+
+        if body.is_a?(Hash)
+          signature += body.to_json
+        end
+
+        return signature
+      end
+
+    end
+  end
+end

data/lib/pili/config.rb

@@ -0,0 +1,57 @@
+# coding: utf-8
+module Pili
+  module Config
+    class << self
+
+      DEFAULT_OPTIONS = {
+        :api_version        => "v1",
+        :api_scheme         => "http",
+        :api_host           => "pili.qiniuapi.com",
+
+        :rtmp_publish_host  => "pub.z1.glb.pili.qiniup.com",
+        :rtmp_play_host     => "live.z1.glb.pili.qiniucdn.com",
+        :hls_play_host      => "hls.z1.glb.pili.qiniuapi.com"#,
+
+        # :access_key         => "",
+        # :secret_key         => ""
+      }
+
+      REQUIRED_OPTION_KEYS = [:access_key, :secret_key]
+
+      attr_reader :settings
+
+      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 api_base_url
+        "#{settings[:api_scheme]}://#{settings[:api_host]}/#{settings[:api_version]}"
+      end
+
+      def access_key
+        settings[:access_key]
+      end
+
+      def secret_key
+        settings[:secret_key]
+      end
+
+      def rtmp_publish_host
+        settings[:rtmp_publish_host]
+      end
+
+      def rtmp_play_host
+        settings[:rtmp_play_host]
+      end
+
+      def hls_play_host
+        settings[:hls_play_host]
+      end
+
+    end
+  end
+end

data/lib/pili/http.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+require 'httparty'
+
+module Pili
+  class HTTP
+
+    include HTTParty
+    format :json
+
+    class << self
+
+      def api_get(url)
+        signature_options = {
+          :url => url,
+          :method => "GET"
+        }
+
+        encoded_sign = Auth.sign(Config.secret_key, Auth.generate_signature(signature_options))
+
+        headers = { "Authorization" => "Qiniu #{Config.access_key}:#{encoded_sign}" }
+
+        get(url, :headers => headers)
+      end
+
+
+      def api_post(url, body)
+        signature_options = {
+          :url => url,
+          :content_type => "application/json",
+          :method => "POST",
+          :body => body
+        }
+
+        encoded_sign = Auth.sign(Config.secret_key, Auth.generate_signature(signature_options))
+
+        headers = {
+          "Authorization" => "Qiniu #{Config.access_key}:#{encoded_sign}",
+          "Content-Type"  => "application/json"
+        }
+
+        post(url, :headers => headers, :body => body.to_json)
+      end
+
+
+      def api_delete(url)
+        signature_options = {
+          :url => url,
+          :method => "DELETE"
+        }
+
+        encoded_sign = Auth.sign(Config.secret_key, Auth.generate_signature(signature_options))
+
+        headers = { "Authorization" => "Qiniu #{Config.access_key}:#{encoded_sign}" }
+
+        delete(url, :headers => headers)
+      end
+
+
+    end
+
+  end
+end

data/lib/pili/utils.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+module Pili
+  module Utils
+    class << self
+
+      def blank?(arg)
+        arg.to_s.strip.length == 0
+      end
+
+    end
+  end
+end

data/lib/pili/version.rb

@@ -0,0 +1,3 @@
+module Pili
+  VERSION = "0.1.0"
+end

data/lib/pili.rb

@@ -0,0 +1,142 @@
+# coding: utf-8
+require 'json'
+require 'httparty'
+require "pili/version"
+
+module Pili
+  autoload :Auth,   'pili/auth'
+  autoload :Config, 'pili/config'
+  autoload :HTTP,   'pili/http'
+  autoload :Utils,  'pili/utils'
+
+  class << self
+
+    def setup!(options = {})
+      Config.init(options)
+    end
+
+
+    def stream_list(hub, options = {})
+      url = Config.api_base_url + "/streams?hub=#{hub}"
+
+      url += "&marker=#{options[:marker]}" if options[:marker].is_a?(Fixnum)
+      url += "&limit=#{options[:limit]}"   if options[:limit].is_a?(Fixnum)
+
+      response = HTTP.api_get(url)
+      response.parsed_response
+    end
+
+
+    def create_stream(hub, options = {})
+      url = Config.api_base_url + "/streams"
+
+      body = {
+        :hub              => hub,
+        :title            => options[:title],
+        :publishKey       => options[:publish_key],
+        :publishSecurity  => options[:publish_security] == "static" ? "static" : "dynamic",
+        :clientIp         => options[:client_ip]
+      }
+
+      body.delete_if { |k, v| v.nil? }
+
+      response = HTTP.api_post(url, body)
+      response.parsed_response
+    end
+
+
+    def get_stream(stream_id)
+      url = Config.api_base_url + "/streams/" + stream_id
+      response = HTTP.api_get(url)
+      response.parsed_response
+    end
+
+
+    def update_stream(stream_id, options = {})
+      url = Config.api_base_url + "/streams/" + stream_id
+
+      body = {
+        :publishKey       => options[:publish_key],
+        :publishSecurity  => options[:publish_security] == "static" ? "static" : "dynamic",
+      }
+
+      body.delete_if { |k, v| v.nil? }
+
+      response = HTTP.api_post(url, body)
+      response.parsed_response
+    end
+
+
+    def delete_stream(stream_id)
+      url = Config.api_base_url + "/streams/" + stream_id
+      response = HTTP.api_delete(url)
+      response.parsed_response
+    end
+
+
+    def get_stream_segments(stream_id, options = {})
+      url = Config.api_base_url + "/streams/#{stream_id}/segments"
+
+      url += "?start=#{options[:start]}" if options[:start].is_a?(Fixnum)
+      url += "&end=#{options[:end]}"     if options[:end].is_a?(Fixnum)
+
+      response = HTTP.api_get(url)
+      response.parsed_response
+    end
+
+
+    def get_stream_publish_url(stream_id, publish_key, publish_security, nonce = nil)
+      nonce = nonce.to_i
+      nonce = (Time.now.to_f * 1000.0).to_i if nonce == 0
+
+      a = stream_id.split(".")
+      hub, title = a[1], a[2]
+
+      if publish_security == "static"
+        return "rtmp://#{Config.rtmp_publish_host}/#{hub}/#{title}?key=#{publish_key}"
+      else
+        token = Auth.sign(publish_key, "/#{hub}/#{title}?nonce=#{nonce}")
+        return "rtmp://#{Config.rtmp_publish_host}/#{hub}/#{title}?nonce=#{nonce}&token=#{token}"
+      end
+    end
+
+
+    def get_stream_rtmp_live_url(stream_id, preset = nil)
+      a = stream_id.split(".")
+      hub, title = a[1], a[2]
+
+      if Utils.blank? preset
+        return "rtmp://#{Config.rtmp_play_host}/#{hub}/#{title}"
+      else
+        return "rtmp://#{Config.rtmp_play_host}/#{hub}/#{title}@#{preset}"
+      end
+    end
+
+
+    def get_stream_hls_live_url(stream_id, preset = nil)
+      a = stream_id.split(".")
+      hub, title = a[1], a[2]
+
+      if Utils.blank? preset
+        return "http://#{Config.hls_play_host}/#{hub}/#{title}.m3u8"
+      else
+        return "http://#{Config.hls_play_host}/#{hub}/#{title}@#{preset}.m3u8"
+      end
+    end
+
+
+    def get_stream_hls_playback_url(stream_id, start_second, end_second, preset = nil)
+      a = stream_id.split(".")
+      hub, title = a[1], a[2]
+
+      if Utils.blank? preset
+        return "http://#{Config.hls_play_host}/#{hub}/#{title}.m3u8?start=#{start_second}&end=#{end_second}"
+      else
+        return "http://#{Config.hls_play_host}/#{hub}/#{title}@#{preset}.m3u8?start=#{start_second}&end=#{end_second}"
+      end
+    end
+
+
+  end
+
+end

data/pili.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pili/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pili"
+  spec.version       = Pili::VERSION
+  spec.authors       = ["Miclle"]
+  spec.email         = ["pili@qiniu.com"]
+  spec.summary       = %q{Pili SDK for Ruby.}
+  spec.description   = %q{Pili SDK for Ruby. https://github.com/pili-io/pili-sdk-ruby}
+  spec.homepage      = "https://github.com/pili-io/pili-sdk-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency 'httparty', '~> 0.13.3'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pili
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Miclle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: pili-io Ruby SDK.
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+description: Pili SDK for Ruby. https://github.com/pili-io/pili-sdk-ruby
 email:
 - pili@qiniu.com
 executables: []
@@ -46,8 +60,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
+- lib/pili.rb
+- lib/pili/auth.rb
+- lib/pili/config.rb
+- lib/pili/http.rb
+- lib/pili/utils.rb
+- lib/pili/version.rb
+- pili.gemspec
 homepage: https://github.com/pili-io/pili-sdk-ruby
 licenses:
 - MIT
@@ -71,5 +95,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: pili-io Ruby SDK.
+summary: Pili SDK for Ruby.
 test_files: []