panda 0.4.5 → 0.4.7

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 New Bamboo
+Copyright (c) 2010 New Bamboo Web Development Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -11,8 +11,8 @@ Panda gem provides an interface to access the [Panda](http://pandastream.com) AP
     require 'panda'
 
 ### Creating an instance of the client
-
-    panda = Panda.new({
+    
+    Panda.connect!({
       :cloud_id => 'cloud_id', 
       :access_key => 'access_key', 
       :secret_key => 'secret_key', 
@@ -20,8 +20,10 @@ Panda gem provides an interface to access the [Panda](http://pandastream.com) AP
     })
 
 ### Posting a video
-    
-    panda.post('/videos.json', {:source_url => 'http://www.example.com/original_video.mp4'})
+
+    Panda.post('/videos.json', {:file => File.open("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",
@@ -40,7 +42,7 @@ Panda gem provides an interface to access the [Panda](http://pandastream.com) AP
     
 ### Getting all videos
 
-    panda.get('/videos.json')
+    Panda.get('/videos.json')
     => [{"duration"=>14010,
       "created_at"=>"2010/01/13 16:45:29 +0000",
       "original_filename"=>"panda.mp4",
@@ -59,7 +61,7 @@ Panda gem provides an interface to access the [Panda](http://pandastream.com) AP
     
 ### Getting video encodings 
     
-    panda.get('/videos/0ee6b656-0063-11df-a433-1231390041c1/encodings.json')
+    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",
@@ -79,11 +81,11 @@ Panda gem provides an interface to access the [Panda](http://pandastream.com) AP
     
 ### Deleting a video encoding
 
-    panda.delete('/encodings/0f815986-0063-11df-a433-1231390041c1.json')
+    Panda.delete('/encodings/0f815986-0063-11df-a433-1231390041c1.json')
 
 ### Deleting a video
     
-    panda.delete('/videos/0ee6b656-0063-11df-a433-1231390041c1.json')
+    Panda.delete('/videos/0ee6b656-0063-11df-a433-1231390041c1.json')
 
 ## Generating signatures
 
@@ -91,13 +93,13 @@ All requests to your Panda cloud are signed using HMAC-SHA256, based on a timest
 
 To do this, a method `signed_params()` is supported:
 
-    panda.signed_params('POST', '/videos.json')
+    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'})
+    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=',

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.4.7

data/lib/panda/panda.rb

@@ -1,125 +1,144 @@
 require 'restclient'
 
 class Panda
-  attr_reader :api_host, :api_port, :access_key, :secret_key, :api_version
-  
-  DEFAULT_API_PORT=80
-  DEFAULT_API_HOST="api.pandastream.com"
+  def self.connect!(auth_params)
+    @@connection = Connection.new(auth_params)
+  end
   
-  def initialize(auth_params)
-    @api_version = 2
-    
-    if auth_params.class == String
-      init_from_url(auth_params)
-    else
-      init_from_hash(auth_params)
-    end
-    
-    @connection = RestClient::Resource.new(api_url)
+  def self.get(request_uri, params={})
+    @@connection.get(request_uri, params)
   end
 
+  def self.post(request_uri, params)
+    @@connection.post(request_uri, params)
+  end
 
-
-  def get(request_uri, params={})
-    rescue_restclient_exception do
-      query = signed_query("GET", request_uri, params)
-      body_of @connection[request_uri + '?' + query].get
-    end
+  def self.put(request_uri, params)
+    @@connection.put(request_uri, params)
   end
 
-  def post(request_uri, params)
-    rescue_restclient_exception do
-      body_of @connection[request_uri].post(signed_params("POST", request_uri, params))
-    end
+  def self.delete(request_uri, params={})
+    @@connection.delete(request_uri, params)
+  end
+  
+  def self.authentication_params(*params)
+    raise "Method deprecated. Please use signed_params instead."
+  end
+  
+  def self.signed_params(verb, request_uri, params = {}, timestamp_str = nil)
+    @@connection.signed_params(verb, request_uri, params, timestamp_str)
   end
+  
+  class Connection
+    attr_reader :api_host, :api_port, :access_key, :secret_key, :api_version
+  
+    DEFAULT_API_PORT=80
+    DEFAULT_API_HOST="api.pandastream.com"
+  
+    def initialize(auth_params)
+      @api_version = 2
+    
+      if auth_params.class == String
+        init_from_url(auth_params)
+      else
+        init_from_hash(auth_params)
+      end
+    
+      @connection = RestClient::Resource.new(api_url)
+    end
 
-  def put(request_uri, params)
-    rescue_restclient_exception do
-      body_of @connection[request_uri].put(signed_params("PUT", request_uri, params))
+    def get(request_uri, params={})
+      rescue_restclient_exception do
+        query = signed_query("GET", request_uri, params)
+        body_of @connection[request_uri + '?' + query].get
+      end
     end
-  end
 
-  def delete(request_uri, params={})
-    rescue_restclient_exception do
-      query = signed_query("DELETE", request_uri, params)
-      body_of @connection[request_uri + '?' + query].delete
+    def post(request_uri, params)
+      rescue_restclient_exception do
+        body_of @connection[request_uri].post(signed_params("POST", request_uri, params))
+      end
     end
-  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(6)
-    auth_params['signature'] = ApiAuthentication.authenticate(verb, request_uri, @api_host, @secret_key, params.merge(auth_params))
-    return auth_params
-  end
+    def put(request_uri, params)
+      rescue_restclient_exception do
+        body_of @connection[request_uri].put(signed_params("PUT", request_uri, params))
+      end
+    end
 
-  def signed_query(*args)
-    ApiAuthentication.hash_to_query(signed_params(*args))
-  end
+    def delete(request_uri, params={})
+      rescue_restclient_exception do
+        query = signed_query("DELETE", request_uri, params)
+        body_of @connection[request_uri + '?' + query].delete
+      end
+    end
 
-  def signed_params(verb, request_uri, params = {}, timestamp_str = nil)
-    auth_params = params
-    auth_params['cloud_id']   = @cloud_id
-    auth_params['access_key'] = @access_key
-    auth_params['timestamp']  = timestamp_str || Time.now.iso8601(6)
+    def signed_query(*args)
+      ApiAuthentication.hash_to_query(signed_params(*args))
+    end
+    
+    def signed_params(verb, request_uri, params = {}, timestamp_str = nil)
+      auth_params = params
+      auth_params['cloud_id']   = @cloud_id
+      auth_params['access_key'] = @access_key
+      auth_params['timestamp']  = timestamp_str || Time.now.iso8601(6)
+
+      params_to_sign = auth_params.reject{|k,v| ['file'].include?(k)}
+      auth_params['signature']  = ApiAuthentication.generate_signature(verb, request_uri, @api_host, @secret_key, params_to_sign)
+      auth_params
+    end
 
-    params_to_sign = auth_params.reject{|k,v| ['file'].include?(k)}
-    auth_params['signature']  = ApiAuthentication.generate_signature(verb, request_uri, @api_host, @secret_key, params_to_sign)
-    auth_params
-  end
+    def api_url
+      "http://#{@api_host}:#{@api_port}/#{@prefix}"
+    end
 
-  def api_url
-    "http://#{@api_host}:#{@api_port}/#{@prefix}"
-  end
+    def setup_bucket(params={})
+      granting_params = { :s3_videos_bucket => params[:bucket], :user_aws_key => params[:access_key], :user_aws_secret => params[:secret_key] }
+      put("/clouds/#{@cloud_id}.json", granting_params)
+    end
 
-  def setup_bucket(params={})
-    granting_params = { :s3_videos_bucket => params[:bucket], :user_aws_key => params[:access_key], :user_aws_secret => params[:secret_key] }
-    put("/clouds/#{@cloud_id}.json", granting_params)
-  end
+    private
 
-  private
+      def rescue_restclient_exception(&block)
+        begin
+          yield
+        rescue RestClient::Exception => e
+          e.http_body
+        end
+      end
 
-    def rescue_restclient_exception(&block)
-      begin
-        yield
-      rescue RestClient::Exception => e
-        e.http_body
+      # API change on rest-client 1.4
+      def body_of(response)
+        response.respond_to?(:body) ? response.body : response
       end
-    end
 
-    # API change on rest-client 1.4
-    def body_of(response)
-      response.respond_to?(:body) ? response.body : response
-    end
 
+      def init_from_url(url)
+        params = url.scan(/^([^:@]+):([^:@]+)@([^:@]+)(:[\d]+)?\/([^:@]+)$/).flatten
 
-    def init_from_url(url)
-      params = url.scan(/^([^:@]+):([^:@]+)@([^:@]+)(:[\d]+)?\/([^:@]+)$/).flatten
+        @access_key = params[0]
+        @secret_key = params[1]
+        @cloud_id   = params[4]
+        @api_host   = params[2]
 
-      @access_key = params[0]
-      @secret_key = params[1]
-      @cloud_id   = params[4]
-      @api_host   = params[2]
+        if params[3]
+          @api_port = params[3][1..-1]
+        else
+          @api_port = DEFAULT_API_PORT
+        end
+        @prefix     = "v#{@api_version}"
 
-      if params[3]
-        @api_port = params[3][1..-1]
-      else
-        @api_port = DEFAULT_API_PORT
       end
-      @prefix     = "v#{@api_version}"
-
-    end
 
-    def init_from_hash(hash_params)
-      params      = { :api_host => DEFAULT_API_HOST, :api_port => DEFAULT_API_PORT }.merge(hash_params)
+      def init_from_hash(hash_params)
+        params      = { :api_host => DEFAULT_API_HOST, :api_port => DEFAULT_API_PORT }.merge(hash_params)
 
-      @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}"
-    end
-end
+        @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}"
+      end
+  end
+end

data/panda.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{panda}
-  s.version = "0.4.5"
+  s.version = "0.4.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["New Bamboo"]
-  s.date = %q{2010-03-11}
+  s.date = %q{2010-03-18}
   s.description = %q{Panda Client}
   s.email = %q{info@pandastream.com}
   s.extra_rdoc_files = [
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/newbamboo/panda_gem}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Panda Client}
   s.test_files = [
     "spec/panda_spec.rb",
@@ -66,4 +66,3 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rest-client>, [">= 1.2"])
   end
 end
-

data/spec/panda_spec.rb

@@ -6,10 +6,7 @@ describe Panda do
     Time.stub!(:now).and_return(mock("time", :iso8601 => "2009-11-04T17:54:11+00:00"))
   end
 
-  describe "Connected with Hash" do
-    before(:each) do
-      @panda = Panda.new({"access_key" => "my_access_key", "secret_key" => "my_secret_key", "api_host" => "myapihost", "api_port" => 85, "cloud_id" => 'my_cloud_id' })
-    end
+  describe "Connected", :shared => true do
 
     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")
@@ -73,19 +70,31 @@ describe Panda do
 
       resource.stub!(:get).and_raise(e)
 
-      panda = Panda.new({"access_key" => "my_access_key", "secret_key" => "my_secret_key", "api_host" => "myapihost", "api_port" => 85, "cloud_id" => 'my_cloud_id' })
+      panda = Panda::Connection.new({"access_key" => "my_access_key", "secret_key" => "my_secret_key", "api_host" => "myapihost", "api_port" => 85, "cloud_id" => 'my_cloud_id' })
       panda.get("/videos").should == "abc"
     end
   end
   
   describe "Connected with a string url" do
     before(:each) do
-      @panda2 = Panda.new("f4676630-0522-11df-8148-1231350015b1:1ucba5EDJGf9aIl3/ve1klCkRQqiYZ1bzI+Dpvl3@myhost:85/eefa5d2cbe74289a500e62e2789347f3")
+      @panda = Panda::Connection.new("my_access_key:my_secret_key@myapihost:85/my_cloud_id")
     end
     
-    it "should make get request" do
-      FakeWeb.register_uri(:get, "http://myhost:85/v2/videos?timestamp=2009-11-04T17%3A54%3A11%2B00%3A00&signature=YcoBrpnRTwpgEpA%2FPO%2FMJr4d94suUqt5acQv67owUew%3D&access_key=f4676630-0522-11df-8148-1231350015b1&cloud_id=eefa5d2cbe74289a500e62e2789347f3", :body => "abc")
-      @panda2.get("/videos").should == "abc"
+    it_should_behave_like "Connected"
+  end
+  
+  describe "Panda.connect " do
+    before(:each) do
+      Panda.connect!({"access_key" => "my_access_key", "secret_key" => "my_secret_key", "api_host" => "myapihost", "api_port" => 85, "cloud_id" => 'my_cloud_id' })
+      @panda = Panda
     end
+   it_should_behave_like "Connected"
+  end
+  describe "Panda::Connection.new" do
+     before(:each) do
+       @panda = Panda::Connection.new({"access_key" => "my_access_key", "secret_key" => "my_secret_key", "api_host" => "myapihost", "api_port" => 85, "cloud_id" => 'my_cloud_id' })
+     end
+    it_should_behave_like "Connected"
   end
+  
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: panda
 version: !ruby/object:Gem::Version 
-  version: 0.4.5
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 7
+  version: 0.4.7
 platform: ruby
 authors: 
 - New Bamboo
@@ -9,59 +14,74 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-11 00:00:00 +00:00
+date: 2010-03-18 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: fakeweb
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: fakeweb-matcher
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: ruby-hmac
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 2
         version: 0.3.2
-    version: 
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rest-client
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
         version: "1.2"
-    version: 
+  type: :runtime
+  version_requirements: *id005
 description: Panda Client
 email: info@pandastream.com
 executables: []
@@ -98,18 +118,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Panda Client