Gem for Panda, the video platform
Ruby
Pull request Compare This branch is 1 commit ahead, 63 commits behind pandastream:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
spec
.gitignore
.rspec
CHANGELOG.md
Gemfile
LICENSE
README.md
Rakefile
panda.gemspec

README.md

Panda

Panda gem provides an interface to access the Panda API from Ruby.

Installation

gem install panda

How to use it

require 'rubygems'
require 'panda'

Creating an instance of the client

Panda.configure do
  access_key "panda_access_key"
  secret_key "panda_secret_key"
  cloud_id "panda_cloud_id"
  # api_host "api.eu.pandastream.com" ## for EU accounts
  # api_port 80 ## to use http (default 443)
end

or Panda.configure({:access_key => ....})

Inside a Rails app with a main account or using Heroku Addon

Heroku will store your credentials as an environment variable called PANDASTREAM_URL. You can find more information on Heroku config variable docs

If you use a config file like config/panda.yml to support multiple environments, do the following in your config/initializers/panda.rb :

Panda.configure((ENV['PANDASTREAM_URL'] || YAML::load_file(File.join(File.dirname(__FILE__),"..", "panda.yml"))[RAILS_ENV]))

See the Rails How-to for more details.

Creating an instance using ONLY with Heroku Addon

If you don't use a config file and want to simply be setup, do the following (works only on heroku):

Panda.configure_heroku

Typical usage

In most cases you will have used the panda_uploader jQuery plugin to upload the video (more details about this are in the Integrating Panda with Ruby on Rails tutorial). Then you will want to get the video and screenshots urls of your encoding to display to your users.

The name of the profile can be found in your Panda account when editing an encoding cloud's profiles.

encodings = Panda::Video.find("1234").encodings
=> [...]

mp4_encoding = encodings.find_by_profile_name("h264")
ogg_encoding = encodings.find_by_profile_name("ogg")

mp4_encoding.url
=> "http://s3.amazonaws.com/my_panda_bucket/4567.mp4"

mp4_encoding.screenshots[4]
=> "http://s3.amazonaws.com/my_panda_bucket/4567_4.jpg"

ogg_encoding.url
=> "http://s3.amazonaws.com/my_panda_bucket/9876.ogg"

ogg_encoding.screenshots[4]
=> "http://s3.amazonaws.com/my_panda_bucket/9876_4.jpg"

Complete functionality

Videos

Find a video

video = Panda::Video.find("1234")
video.attributes
=> {
  "id"=>"1234",
  "original_filename"=>"panda.mp4",
  "source_url"=>"http://www.example.com/original_video.mp4",
  "extname"=>".mp4",
  "duration"=>14010,
  "audio_codec"=>"aac",
  "video_codec"=>"h264",
  "file_size" => "44000",
  "width"=>300,
  "height"=>240,
  "fps"=>29,
  "status"=>"success",
  "created_at"=>"2010/01/13 16:45:29 +0000",
  "updated_at"=>"2010/01/13 16:45:35 +0000"
}

video.id
=> "1234"

video.created_at
=>"2010/01/13 16:45:29 +0000"

video = Panda::Video.first

video = Panda::Video.find("fake_id")
=> raise: RecordNotFound: Couldn't find Video with ID=fake_id

video.to_json
=>"{\"duration\":14010,\"created_at\":\"2010/01/13 16:45:29 +0000\",\"original_filename\":\"panda.mp4\"....}"

video.processing?
=> false

video.fail?
=> false

video.success?
=> true

video.reload
=> <Panda::Video:0x1036fd660 ...>
Find encodings of a video
video = Panda::Video.find("1234")
video.encodings
=> [...]

video.encodings.profile("3456")
=> [...]

or

video.encodings.all(:profile_id => "3456")
=> [...]
Find all videos
videos = Panda::Video.all
=> [...]

videos.first.id
=> "3456"

videos = Panda::Video.page(2).per_page(20)

or

videos = Panda::Video.all(:page => 2, :per_page => 20)
videos.size
=> 20
Find all success videos
video = Panda::Video.status("success")
=> [...]

or

videos = Panda::Video.all(:status => "success")
=> [...]

status: success | processing | fail

Create a new video

from a source

video = Panda::Video.create(:source_url => "http://mywebsite.com/myvideo.mp4")

or

video = Panda::Video.new(:source_url => "http://mywebsite.com/myvideo.mp4")
video.create
=> true

# Note that you will need a movie file to test this. 
# You can grab http://panda-test-harness-videos.s3.amazonaws.com/panda.mp4

from a local file

video = Panda::Video.create(:file => File.new("/home/me/panda.mp4"))

or

video = Panda::Video.new(:file => File.new("/home/me/panda.mp4"))
video.create
=> true

Delete a video

Panda::Video.delete("1234")

or

video = Panda::Video.find("1234")
video.delete
=> true

Encodings

Find an encoding
encoding = Panda::Encoding.find("4567")
encoding.attributes
=> {
  "id"=>"4567",
  "video_id"=>"1234",
  "extname"=>".mp4",
  "encoding_progress"=>60,
  "encoding_time"=>3,
  "file_size" => "25000",
  "width"=>300,
  "height"=>240,
  "profile_id"=>"6789",
  "status"=>"success",
  "started_encoding_at"=>"2010/01/13 16:47:35 +0000",
  "created_at"=>"2010/01/13 16:45:30 +0000",
  "updated_at"=>"2010/01/13 16:47:40 +0000"
}

encoding.encoding_progress
=> 60

encoding.processing?
=> false

encoding.fail?
=> false

encoding.success?
=> true

encoding.video.original_filename
=> "panda.mp4"

encoding = Panda::Encoding.first
Find all encodings of a video
encodings = Panda::Encoding.page(4)

or

encodings = Panda::Encoding.all(:page => 4)
=> [...]

encodings = Panda::Encoding.video(video_id)
=> [...]

encoding = Panda::Encoding.video(video_id).profile_name("h264").first

or

encoding = Panda::Encoding.find_by :video_id => "video_id", :profile_name => "h264"
encoding.encoding_time
=> 3

profile = encodings.first.profile
profile.title
=> "H264 profile"
Find all success encodings
encodings = Panda::Encoding.video("1234").status("success")
or
encodings = Panda::Encoding.all(:video_id => "1234", :status => "success")
=> [...]

or

video = Panda::Video.find("1234")
video.encodings.status("success")

status: success | processing | fail
Retrieve the encoding
encoding = Panda::Encoding.find("4567")
encoding.url
=> "http://s3.amazonaws.com/my_panda_bucket/4567.mp4"

encoding.screenshots[0]
=> "http://s3.amazonaws.com/my_panda_bucket/4567_1.jpg"
Create a new encoding
encoding = Panda::Encoding.create(:video_id => 1234, :profile_id => 6789)

or

video = Panda::Video.find("123")
encoding = video.encodings.create(:profile => "profile_id")
Delete an encoding
Panda::Encoding.delete("4567")

or

encoding = Panda::Encoding.find("4567")
encoding.delete
=> true

Profiles

Find a profile
profile = Panda::Profile.find("6789")
Find all profiles
profiles = Panda::Profile.all
Create a profile
profile = Panda::Profile.create(:preset_name => "h264")
profile = Panda::Profile.create(:command => "ffmpeg -i $input_file$ -y $output_file$", ....)
Update a profile
profile = Panda::Profile.find("6789")
profile.width = 320
profile.height = 280
profile.save
=> true

profile.id = "fake_profile_id"
profile.save
=> false

profile.errors.last.to_s
=> RecordNotFound: Couldn't find Profile with ID=fake_profile_id
Delete a profile
Panda::Profile.delete("4567")

or

profile = Panda::Profile.find("6789")
profile.delete
=> true
All encoding of a profile
profile = Panda::Profile.find("6789")
profile.encodings
=> [...]

profile.encodings.status("success")
or
profile.encodings.all(:status => "success")
=> [...]

Clouds

Find a cloud

cloud = Panda::Cloud.find(234324)
cloud.id
=> 234324
Find all clouds
clouds = Panda::Cloud.all
clouds.size
=> 2
Create a cloud
cloud = Panda::Cloud.create :aws_access_key => 'mys3key', :aws_secret_key => 'mys3secret', :s3_videos_bucket => 'myexistingbucket'
cloud.id
=> 1234

Using multiple clouds

By default Cloud.id uses options defined with: Panda.configure do .. end

cloud_one = Panda::Cloud.find("cloud_id_1")
cloud_two = Panda::Cloud.find("cloud_id_2")

cloud_one.profiles
cloud_two.profiles.find("profile_id")

cloud_two.videos
cloud_two.videos.status("success")
cloud_two.videos.all(:status => "success")
cloud_two.videos.all(:page => 2)

cloud_one.videos.find("video_id_1")
cloud_two.videos.find("video_id_2")

cloud_two.profiles
cloud_two.profiles.create(:preset_name => "h264")
cloud_one.videos.create(:command => "ffmpeg -i $input_file$ -y $output_file$", ....)

Generating signatures

All requests to your Panda cloud are signed using HMAC-SHA256, based on a timestamp and your Panda secret key. This is handled transparently. However, sometimes you will want to generate only this signature, in order to make a request by means other than this library. This is the case when using the JavaScript panda_uploader.

To do this, a method signed_params() is supported:

    Panda.signed_params('POST', '/videos.json')
    # => {'access_key' => '8df50af4-074f-11df-b278-1231350015b1',
    # 'cloud_id' => 'your-cloud-id',
    # 'signature' => 'LejCdm0O83+jk6/Q5SfGmk14WTO1pB6Sh6Z5eA2w5C0=',
    # 'timestamp' => '2010-02-26T15:01:46.221513'}

    Panda.signed_params('GET', '/videos.json', {'some_params' => 'some_value'})
    # => {'access_key' => '8df50af4-074f-11df-b278-1231350015b1',
    #  'cloud_id' => 'your-cloud-id',
    #  'signature' => 'uHnGZ+kI9mT3C4vW71Iop9z2N7UKCv38v2l2dvREUIQ=',
    #  'some_param' => 'some_value',
    #  'timestamp' => '2010-02-26T15:04:27.039620'}

Old Panda way, still works

Creating an instance of the client

Panda.connect!({
  :cloud_id => 'cloud_id', 
  :access_key => 'access_key', 
  :secret_key => 'secret_key', 
  :api_host => 'api.pandastream.com' # This may change depending on the region
})

Posting a video

Panda.post('/videos.json', {:file => File.new("panda.mp4")}) # Note that you will need a movie file to test this. You can grab http://panda-test-harness-videos.s3.amazonaws.com/panda.mp4

Panda.post('/videos.json', {:source_url => 'http://www.example.com/original_video.mp4'})
=>{"duration"=>nil,
 "created_at"=>"2010/01/15 14:48:42 +0000",
 "original_filename"=>"panda.mp4",
 "updated_at"=>"2010/01/15 14:48:42 +0000",
 "source_url"=>"http://www.example.com/original_video.mp4",
 "id"=>"12fce296-01e5-11df-ae37-12313902cc92",
 "extname"=>".mp4",
 "audio_codec"=>nil,
 "height"=>nil,
 "upload_redirect_url"=>nil,
 "fps"=>nil,
 "video_codec"=>nil,
 "status"=>"processing",
 "width"=>nil}

Getting all videos

Panda.get('/videos.json')
=> [{"duration"=>14010,
  "created_at"=>"2010/01/13 16:45:29 +0000",
  "original_filename"=>"panda.mp4",
  "updated_at"=>"2010/01/13 16:45:35 +0000",
  "source_url"=>"http://www.example.com/original_video.mp4",
  "id"=>"0ee6b656-0063-11df-a433-1231390041c1",
  "extname"=>".mp4",
  "audio_codec"=>"aac",
  "height"=>240,
  "upload_redirect_url"=>nil,
  "fps"=>29,
  "video_codec"=>"h264",
  "status"=>"success",
  "width"=>300}]

Getting video encodings

Panda.get('/videos/0ee6b656-0063-11df-a433-1231390041c1/encodings.json')
=> [{"encoder_id"=>nil,
  "created_at"=>"2010/01/13 16:45:30 +0000",
  "video_id"=>"0ee6b656-0063-11df-a433-1231390041c1",
  "video_url"=> 
      "http://s3.amazonaws.com/panda-videos/0f815986-0063-11df-a433-1231390041c1.flv",
  "started_encoding_at"=>"2010/01/13 16:47:35 +0000",
  "updated_at"=>"2010/01/13 16:47:40 +0000",
  "extname"=>".flv",
  "encoding_progress"=>87,
  "encoding_time"=>3,
  "id"=>"0f815986-0063-11df-a433-1231390041c1",
  "height"=>240,
  "status"=>"success",
  "profile_id"=>"00182830-0063-11df-8c8a-1231390041c1",
  "width"=>300}]

Deleting an encoding

Panda.delete('/encodings/0f815986-0063-11df-a433-1231390041c1.json')

Deleting a video

Panda.delete('/videos/0ee6b656-0063-11df-a433-1231390041c1.json')

Use bundler to setup the test environment (1.0)

bundler install
rake spec

Copyright (c) 2009-2010 New Bamboo. See LICENSE for details.