panda 0.3.0 → 0.4.0

data/Rakefile

@@ -26,6 +26,7 @@ require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.ruby_opts = ['-rrubygems']
 end
 
 Spec::Rake::SpecTask.new(:rcov) do |spec|

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/panda/api_authentication.rb

@@ -7,7 +7,7 @@ require 'base64'
 
 class Panda
   class ApiAuthentication
-    def self.authenticate(verb, request_uri, host, secret_key, params_given={})
+    def self.generate_signature(verb, request_uri, host, secret_key, params_given={})
       # Ensure all param keys are strings
       params = {}; params_given.each {|k,v| params[k.to_s] = v }
       
@@ -21,46 +21,26 @@ class Panda
       hmac = HMAC::SHA256.new( secret_key )
       hmac.update( string_to_sign )
       # chomp is important!  the base64 encoded version will have a newline at the end
-      signature = Base64.encode64(hmac.digest).chomp 
-
-      return signature
-		end
-		
-    # Insist on specific method of URL encoding, RFC3986. 
-    def self.url_encode(string)
-      # It's kinda like CGI.escape, except CGI.escape is encoding a tilde when
-      # it ought not to be, so we turn it back. Also space NEEDS to be %20 not +.
-      return CGI.escape(string).gsub("%7E", "~").gsub("+", "%20")
+      Base64.encode64(hmac.digest).chomp
     end
 
     # param keys should be strings, not symbols please. return a string joined
     # by & in canonical order. 
     def self.canonical_querystring(params)
       # I hope this built-in sort sorts by byte order, that's what's required. 
-      values = params.keys.sort.collect {|key|  [url_encode(key), url_encode(params[key])].join("=") }
-
-      return values.join("&")
-    end
-    
-    def self.add_params_to_request_uri(request_uri, params)
-      request_uri + '?' + hash_to_query(params)
-    end
-    # Insist on specific method of URL encoding, RFC3986. 
-    def self.url_encode(string)
-      string = string.to_s
-      # It's kinda like CGI.escape, except CGI.escape is encoding a tilde when
-      # it ought not to be, so we turn it back. Also space NEEDS to be %20 not +.
-      return CGI.escape(string).gsub("%7E", "~").gsub("+", "%20")
+      params.keys.sort.collect {|key| [url_encode(key), url_encode(params[key])].join("=") }.join("&")
     end
 
     # Turns a hash into a query string, returns the query string.
     # url-encodes everything to Amazon's specifications. 
     def self.hash_to_query(hash)
-      hash.collect do |key, value|
-
-        url_encode(key) + "=" + url_encode(value)
+      hash.collect{|key, value| url_encode(key) + "=" + url_encode(value) }.join("&")
+    end
 
-      end.join("&")
+    # It's kinda like CGI.escape, except CGI.escape is encoding a tilde when
+    # it ought not to be, so we turn it back. Also space NEEDS to be %20 not +.
+    def self.url_encode(string)
+      CGI.escape(string.to_s).gsub("%7E", "~").gsub("+", "%20")
     end
   end
 end

data/lib/panda/panda.rb

@@ -10,30 +10,26 @@ class Panda
     @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
+    query = signed_query("GET", request_uri, params)
+    @connection[request_uri + '?' + query].get
   end
 
   def post(request_uri, params)
-    append_authentication_params!("POST", request_uri, params)
-    @connection[request_uri].post(params)
+    @connection[request_uri].post(signed_params("POST", request_uri, params))
   end
 
   def put(request_uri, params)
-    append_authentication_params!("PUT", request_uri, params)
-    @connection[request_uri].put(params)
+    @connection[request_uri].put(signed_params("PUT", request_uri, 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
+    query = signed_query("DELETE", request_uri, params)
+    @connection[request_uri + '?' + query].delete
   end
   
   def authentication_params(verb, request_uri, params)
@@ -45,13 +41,20 @@ class Panda
     return auth_params
   end
   
-  def api_url
-    "http://#{@api_host}:#{@api_port}/#{@prefix}"
+  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)
+    auth_params['signature'] = ApiAuthentication.generate_signature(verb, request_uri, @api_host, @secret_key, params.merge(auth_params))
+    auth_params
   end
-  private
   
-  def append_authentication_params!(verb, request_uri, params)
-    auth_params = authentication_params(verb, request_uri, params)
-    params.merge!(auth_params)
+  def api_url
+    "http://#{@api_host}:#{@api_port}/#{@prefix}"
   end
 end

data/panda.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{panda}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["New Bamboo"]
-  s.date = %q{2010-02-22}
+  s.date = %q{2010-02-23}
   s.description = %q{Panda Client}
   s.email = %q{info@pandastream.com}
   s.extra_rdoc_files = [

data/spec/panda_spec.rb

@@ -4,7 +4,6 @@ describe Panda do
   before(:each) do
     FakeWeb.allow_net_connect = false
     @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.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
   
@@ -20,5 +19,28 @@ describe Panda do
     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
   
+  it "should create a signed version of the parameters" do
+    signed_params = @panda.signed_params('POST', 
+        '/videos.json', 
+        {"param1" => 'one', "param2" => 'two'}
+    )
+    signed_params.should == {
+      'access_key' => "my_access_key",
+      'timestamp' => "2009-11-04T17:54:11+00:00",
+      'cloud_id' => 'my_cloud_id',
+      'signature' => 'w66goW6Ve5CT9Ibbx3ryvq4XM8OfIfSZe5oapgZBaUs=',
+      'param1' => 'one',
+      'param2' => 'two'
+    }
+  end
+
+  it "should create a signed version of the parameters without additional arguments" do
+    @panda.signed_params('POST', '/videos.json').should == {
+      'access_key' => "my_access_key",
+      'timestamp' => "2009-11-04T17:54:11+00:00",
+      'cloud_id' => 'my_cloud_id',
+      'signature' => 'TI2n/dsSllxFhxcEShRGKWtDSqxu+kuJUPs335NavMo='
+    }
+  end
 
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - New Bamboo
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-22 00:00:00 +00:00
+date: 2010-02-23 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency