panda 0.1.0 → 0.2.0

data/README.md

@@ -0,0 +1,94 @@
+# Panda
+
+Panda gem provides an interface to access the [Panda](http://api.pandastream.com) API from Ruby.
+
+## Installation
+
+sudo gem install panda -s http://gemcutter.org
+
+## How to use it
+
+
+	require 'panda'
+
+
+### Connecting to Panda
+
+	Panda.connect!({
+		:cloud_id => 'cloud_id', 
+		:access_key => 'access_key', 
+		:secret_key => 'secret_key', 
+		:api_host => 'api.pandastream.com'
+	})
+
+### Posting a video
+	
+	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",
+	 "thumbnail_position"=>nil,
+	 "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",
+	  "thumbnail_position"=>nil,
+	  "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",
+	  "lock_version"=>7,
+	  "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 a video encoding
+
+	Panda.delete('/encodings/0f815986-0063-11df-a433-1231390041c1.json')
+
+### Deleting a video
+	
+	Panda.delete('/videos/0ee6b656-0063-11df-a433-1231390041c1.json')
+	
+	
+Copyright
+---------
+
+Copyright (c) 2009-2010 New Bamboo. See LICENSE for details.

data/Rakefile

@@ -11,9 +11,11 @@ begin
     gem.homepage = "http://github.com/newbamboo/panda_gem"
     gem.authors = ["New Bamboo"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "fakeweb"
+    gem.add_development_dependency "fakeweb-matcher"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
     gem.add_dependency "ruby-hmac", ">= 0.3.2" 
-    gem.add_dependency "rest-client", ">= 1.0.3"
+    gem.add_dependency "rest-client", ">= 1.2"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -35,13 +37,3 @@ end
 task :spec => :check_dependencies
 
 task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "panda #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/panda.rb

@@ -1,7 +1,6 @@
 require 'rubygems'
 require 'hmac'
+require 'restclient'
 
-$:.unshift File.dirname(__FILE__) + '/panda'
-
-require 'api_authentication'
-require 'video'
+require 'panda/api_authentication'
+require 'panda/panda'

data/lib/panda/api_authentication.rb

@@ -12,7 +12,7 @@ module Panda
       
       query_string = canonical_querystring(params)
       
-      string_to_sign = verb + "\n" + 
+      string_to_sign = verb.to_s.upcase + "\n" + 
           host.downcase + "\n" +
           request_uri + "\n" +
           query_string

data/lib/panda/panda.rb

@@ -0,0 +1,59 @@
+module Panda
+  class << self
+    
+    def connect!(auth_params={})
+      params = {:api_host => 'api.pandastream.com', :api_port => 80 }.merge(auth_params)
+      
+      @api_version = 2
+      @cloud_id = params["cloud_id"] || params[:cloud_id]
+      @access_key = params["access_key"] || params[:access_key]
+      @secret_key = params["secret_key"] || params[:secret_key]
+      @api_host = params["api_host"] || params[:api_host]
+      @api_port = params["api_port"] || params[:api_port]
+      
+      @prefix = params["prefix_url"] || "v#{@api_version}"
+      
+      @connection = RestClient::Resource.new(api_url)
+    end
+    
+    def get(request_uri, params={})
+      append_authentication_params!("GET", request_uri, params)
+      @connection[ApiAuthentication.add_params_to_request_uri(request_uri, params)].get
+    end
+
+    def post(request_uri, params)
+      append_authentication_params!("POST", request_uri, params)
+      @connection[request_uri].post(params)
+    end
+
+    def put(request_uri, params)
+      append_authentication_params!("PUT", request_uri, params)
+      @connection[request_uri].put(params)
+    end
+
+    def delete(request_uri, params={})
+      append_authentication_params!("DELETE", request_uri, params)
+      @connection[ApiAuthentication.add_params_to_request_uri(request_uri, params)].delete
+    end
+    
+    def authentication_params(verb, request_uri, params)
+      auth_params = {}
+      auth_params['cloud_id'] = @cloud_id
+      auth_params['access_key'] = @access_key
+      auth_params['timestamp'] = Time.now.iso8601
+      auth_params['signature'] = ApiAuthentication.authenticate(verb, request_uri, @api_host, @secret_key, params.merge(auth_params))
+      return auth_params
+    end
+    
+    def api_url
+      "http://#{@api_host}:#{@api_port}/#{@prefix}"
+    end
+    private
+    
+    def append_authentication_params!(verb, request_uri, params)
+      auth_params = authentication_params(verb, request_uri, params)
+      params.merge!(auth_params)
+    end
+
+  end
+end

data/panda.gemspec

@@ -5,26 +5,26 @@
 
 Gem::Specification.new do |s|
   s.name = %q{panda}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["New Bamboo"]
-  s.date = %q{2009-11-04}
+  s.date = %q{2010-01-15}
   s.description = %q{Panda Client}
   s.email = %q{bambinos@new-bamboo.co.uk}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "lib/panda.rb",
      "lib/panda/api_authentication.rb",
-     "lib/panda/video.rb",
+     "lib/panda/panda.rb",
      "log/debug.log",
      "panda.gemspec",
      "spec/panda_spec.rb",
@@ -47,17 +47,23 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb-matcher>, [">= 0"])
       s.add_runtime_dependency(%q<ruby-hmac>, [">= 0.3.2"])
-      s.add_runtime_dependency(%q<rest-client>, [">= 1.0.3"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.2"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<fakeweb-matcher>, [">= 0"])
       s.add_dependency(%q<ruby-hmac>, [">= 0.3.2"])
-      s.add_dependency(%q<rest-client>, [">= 1.0.3"])
+      s.add_dependency(%q<rest-client>, [">= 1.2"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<fakeweb-matcher>, [">= 0"])
     s.add_dependency(%q<ruby-hmac>, [">= 0.3.2"])
-    s.add_dependency(%q<rest-client>, [">= 1.0.3"])
+    s.add_dependency(%q<rest-client>, [">= 1.2"])
   end
 end
 

data/spec/panda_spec.rb

@@ -1,7 +1,23 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "Panda" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe Panda do
+  before(:each) do
+    FakeWeb.allow_net_connect = false
+    Panda.connect!({"access_key" => "my_access_key", "secret_key" => "my_secret_key", "api_host" => "myapihost", "api_port" => 85, "cloud_id" => 'my_cloud_id' })
+    Time.stub!(:now).and_return(mock("time", :iso8601 => "2009-11-04T17:54:11+00:00"))
   end
+  
+  
+  it "should make get request with signed request to panda server" do
+    FakeWeb.register_uri(:get, "http://myapihost:85/v2/videos?timestamp=2009-11-04T17%3A54%3A11%2B00%3A00&signature=CxSYPM65SeeWH4CE%2FLcq7Ny2NtwxlpS8QOXG2BKe4p8%3D&access_key=my_access_key&cloud_id=my_cloud_id", :body => "abc")
+    Panda.get("/videos").should == "abc"
+  end
+
+  it "should make delete request with signed request to panda server" do
+    FakeWeb.register_uri(:delete, "http://myapihost:85/v2/videos/1?timestamp=2009-11-04T17%3A54%3A11%2B00%3A00&signature=t0IYclDXgjZFRYaMf0Gbg%2B5vOqp7q8QQRN8tlQ3bk8Q%3D&access_key=my_access_key&cloud_id=my_cloud_id", :query => {})
+    Panda.delete("/videos/1").should
+    FakeWeb.should have_requested(:delete, "http://myapihost:85/v2/videos/1?timestamp=2009-11-04T17%3A54%3A11%2B00%3A00&signature=t0IYclDXgjZFRYaMf0Gbg%2B5vOqp7q8QQRN8tlQ3bk8Q%3D&access_key=my_access_key&cloud_id=my_cloud_id")
+  end
+  
+
 end

data/spec/spec_helper.rb

@@ -4,6 +4,9 @@ require 'panda'
 require 'spec'
 require 'spec/autorun'
 
+require 'fakeweb'
+require 'fakeweb_matcher'
+
 Spec::Runner.configure do |config|
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: panda
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - New Bamboo
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-04 00:00:00 +00:00
+date: 2010-01-15 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.9
     version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb-matcher
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: ruby-hmac
   type: :runtime
@@ -40,7 +60,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.3
+        version: "1.2"
     version: 
 description: Panda Client
 email: bambinos@new-bamboo.co.uk
@@ -50,16 +70,16 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/panda.rb
 - lib/panda/api_authentication.rb
-- lib/panda/video.rb
+- lib/panda/panda.rb
 - log/debug.log
 - panda.gemspec
 - spec/panda_spec.rb

data/README.rdoc

@@ -1,13 +0,0 @@
-= Panda
-
-== Usage
-
-sudo gem install panda
-
-require 'panda'
-Panda.connect!('access_key', 'secret_key', 'localhost', 5678)
-Panda.get('/videos')
-
-== Copyright
-
-Copyright (c) 2009 New Bamboo. See LICENSE for details.

data/lib/panda/video.rb

@@ -1,86 +0,0 @@
-require 'rubygems'
-require 'rest_client'
-require 'api_authentication'
-
-module Panda
-  class << self
-    attr_writer :rest_client_options
-    attr_reader :connection
-    
-    def connect!(access_key, secret_key, api_host='api.pandastream.com', api_port=80)
-      @api_version = 2
-      @access_key = access_key
-      @secret_key = secret_key
-      @api_host = api_host
-      @api_port = api_port
-      @rest_client_options = {}
-      
-      # raise Exception.new("You must supply a :secret_key") unless @secret_key
-      
-      @connection = RestClient::Resource.new(api_url)
-    end
-    
-    def api_url
-      "http://#{@api_host}:#{@api_port}/v#{@api_version}"
-    end
-    
-    # NOTE: get params, MUST be given as the params hash, not as part of the url string
-    def get(request_uri, params={})
-      params = authenticate("GET", request_uri, params)
-      puts ApiAuthentication.add_params_to_request_uri(request_uri, params)
-      RestClient::Resource.new(concat_urls(api_url, ApiAuthentication.add_params_to_request_uri(request_uri, params))).get
-    end
-
-    def post(request_uri, params)
-      params = authenticate("POST", request_uri, params)
-      RestClient::Resource.new(concat_urls(api_url, request_uri)).post(params)
-    end
-
-    def put(request_uri, params)
-      params = authenticate("PUT", request_uri, params)
-      RestClient::Resource.new(concat_urls(api_url, request_uri)).put(params)
-    end
-
-    def delete(request_uri, params={})
-      params = authenticate("DELETE", request_uri, params)
-      puts ApiAuthentication.add_params_to_request_uri(request_uri, params)
-      RestClient::Resource.new(concat_urls(api_url, ApiAuthentication.add_params_to_request_uri(request_uri, params))).delete
-    end
-    
-    # From rest-client/lib/restclient/resource.rb
-    
-    def concat_urls(url, suburl)   # :nodoc:
-			url = url.to_s
-			suburl = suburl.to_s
-			if url.slice(-1, 1) == '/' or suburl.slice(0, 1) == '/'
-				url + suburl
-			else
-				"#{url}/#{suburl}"
-			end
-		end
-		
-    # Authentication
-    
-    def authenticate(verb, request_uri, params)
-      params['access_key'] = @access_key
-      params['timestamp'] = Time.now.iso8601
-      params['signature'] = ApiAuthentication.authenticate(verb, request_uri, @api_host, @secret_key, params)
-      return params
-  end
-
-  end
-  
-  # class AccountKeyNotSet < PandaError; end
-  # 
-  # # 4xx Client Error
-  # class ClientError < ConnectionError; end # :nodoc:
-  # 
-  # # 401 Unauthorized
-  # class UnauthorizedAccess < ClientError; end # :nodoc
-  # 
-  # # 404 Not Found
-  # class VideoNotFound < ClientError; end # :nodoc:
-  # 
-  # # 5xx Server Error
-  # class ServerError < ConnectionError; end # :nodoc:
-end