panda 1.3.0 → 1.4.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+## 1.4.0 (...)
+
+Features:
+
+  - Replaced Restclient/json by Faraday/Yajl
+  - Added Cloud.create, Cloud.all
+  - Https support for heroku account
+  - Simpler heroku configure method
+  - Simpler configure method
+  - Url and screenshots method for video
+  - `create` method accepts a block
+  - Removed support for JSON format
+  
+Bugfixes:
+  - timestamp is UTC
+  - `to_json` method
+  - `create!` on associations was wrong
+
+## 1.3.0 (January 10, 2011)
+
+Features:
+
+  - Added support for https
+
+## 1.2.2 (December 08, 2010)
+
+Bugfixes:
+
+  - No more warnings about already initialized constants for JSON
+
+## 1.2.0 (November 25, 2010)
+
+Features:
+
+  - Added support for the notification api.
+  - Added support for path and url
+  
+## 1.1.0 (October 19, 2010)
+
+Bugfixes:
+
+  - Do not cache screenshot array anymore
+
+## 1.0.0 (August 05, 2010)
+
+- Simpler and smarter gem
+
+
+    
+    
+    
+    August 05, 2010

data/Gemfile

@@ -1,14 +1,2 @@
-source :rubygems
-
-group :development, :test do
-  
-  gem "ruby-hmac",">= 0.3.2"
-  gem "rest-client"
-  gem "json"
-
-  gem "jeweler"
-  gem "rake"
-  gem "rspec", "1.3.1"
-  gem "webmock", "1.6.1"
-
-end
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -15,30 +15,32 @@ Panda gem provides an interface to access the [Panda](http://pandastream.com) AP
 
 ### Creating an instance of the client
 
-    Panda.configure do |config|
-      config.access_key = "panda_access_key"
-      config.secret_key = "panda_secret_key"
-      config.cloud_id = "panda_cloud_id"
-      # config.api_host = "api.eu.pandastream.com" ## for EU accounts
-      # config.api_port = 80 ## to use http (default 443)
+    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 => ....})
 
-### Creating an instance using Heroku
+### Inside a Rails app with a main account or using Heroku Addon
 
-    Panda.configure(ENV['PANDASTREAM_URL'])
+Heroku will store your credentials as an environment variable called PANDASTREAM_URL. You can find more information on [Heroku config variable docs](http://docs.heroku.com/config-vars)
 
-### Inside a Rails app with a main account or using Heroku
-
-Config is stored in `config/panda.yml` or you must set an the PANDASTREAM_URL environment variable in your `/.bashrc` file (see the [Heroku config variable docs](http://docs.heroku.com/config-vars)).
-
-Use the following in your `config/initializers/panda.rb`:
+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](http://www.pandastream.com/docs/integrate_with_rails) 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](http://github.com/newbamboo/panda_uploader) jQuery plugin to upload the video (more details about this are in the [Integrating Panda with Ruby on Rails](http://pandastream.com/docs/integrate_with_rails) tutorial). Then you will want to get the video and screenshots urls of your encoding to display to your users.
@@ -346,7 +348,27 @@ The name of the profile can be found in your [Panda account](http://pandastream.
     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
@@ -368,17 +390,13 @@ The name of the profile can be found in your [Panda account](http://pandastream.
     cloud_two.profiles
     cloud_two.profiles.create(:preset_name => "h264")
     cloud_one.videos.create(:command => "ffmpeg -i $input_file$ -y $output_file$", ....)
-
-  You can also connect directly using Cloud.find
-    
-    cloud = Panda::Cloud.find("cloud_id_1", {:access_key => ..., :secret_key => ... })
     
 
 ## 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](http://github.com/newbamboo/panda_uploader).
+  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](http://github.com/newbamboo/panda_uploader).
 
-    To do this, a method `signed_params()` is supported:
+  To do this, a method `signed_params()` is supported:
 
         Panda.signed_params('POST', '/videos.json')
         # => {'access_key' => '8df50af4-074f-11df-b278-1231350015b1',
@@ -469,21 +487,9 @@ The name of the profile can be found in your [Panda account](http://pandastream.
     
     Panda.delete('/videos/0ee6b656-0063-11df-a433-1231390041c1.json')
 
-## Hash or JSON
-Since Panda 0.6, PandaGem returns a Hash by default. If you want PandaGem to return JSON do the following:
-
-    Panda.connect!({
-      :cloud_id => 'cloud_id',
-      :access_key => 'access_key',
-      :secret_key => 'secret_key',
-      :format => 'json'
-    })
-
-
 ## Use bundler to setup the test environment (1.0)
 
     bundler install
     rake spec
 
-
 Copyright (c) 2009-2010 New Bamboo. See LICENSE for details.

data/Rakefile

@@ -1,27 +1,9 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "panda"
-    gem.summary = %Q{Panda Client}
-    gem.description = %Q{Panda Client}
-    gem.email = "info@pandastream.com"
-    gem.homepage = "http://github.com/newbamboo/panda_gem"
-    gem.authors = ["New Bamboo"]
-    gem.add_dependency "ruby-hmac", ">= 0.3.2"
-    gem.add_dependency "rest-client", ">= 1.4"
-    gem.add_dependency "json", ">= 1.2"
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-desc "Run all the specs"
-task :spec do
-  system "bundle exec spec -O spec/spec.opts spec"
-end
-
-task :default => :spec
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc "Run all the specs"
+task :spec do
+  system "bundle exec rspec spec"
+end
+
+task :default => :spec

data/lib/panda.rb

@@ -1,22 +1,28 @@
+require 'panda/version'
 require 'panda/api_authentication'
 require 'panda/connection'
+require 'panda/config'
 require 'panda/modules/router'
 require 'panda/modules/finders'
 require 'panda/modules/builders'
+require 'panda/modules/destroyers'
 require 'panda/modules/associations'
 require 'panda/modules/updatable'
-require 'panda/modules/short_status'
+require 'panda/modules/viewable'
+require 'panda/modules/video_state'
 require 'panda/modules/cloud_connection'
 require 'panda/proxies/proxy'
 require 'panda/proxies/scope'
 require 'panda/proxies/encoding_scope'
 require 'panda/proxies/video_scope'
 require 'panda/proxies/profile_scope'
-require 'panda/error'
+require 'panda/adapters/adapter'
+require 'panda/adapters/faraday'
+require 'panda/errors'
 require 'panda/base'
 require 'panda/resources/resource'
 require 'panda/resources/cloud'
 require 'panda/resources/encoding'
 require 'panda/resources/profile'
 require 'panda/resources/video'
-require 'panda/panda'
+require 'panda/panda'

data/lib/panda/adapters/adapter.rb

@@ -0,0 +1,4 @@
+module Panda
+  module Adapter
+  end
+end

data/lib/panda/adapters/faraday.rb

@@ -0,0 +1,70 @@
+require 'faraday'
+require 'yajl/json_gem'
+
+module Panda
+  module Adapter
+    class Faraday
+      
+      def initialize(api_url)
+        @api_url = api_url
+      end
+      
+      def get(request_uri, params)
+        rescue_json_parsing do
+          response = connection.get do |req|
+            req.url File.join(connection.path_prefix, request_uri), params
+          end.body
+        end
+      end
+
+      def post(request_uri, params)
+        # multipart upload
+        if (f=params['file']) && f.is_a?(File)
+          params['file'] = ::Faraday::UploadIO.new(f.path, 'multipart/form-data')
+        end
+
+        rescue_json_parsing do
+          connection.post do |req|
+            req.url File.join(connection.path_prefix, request_uri)
+            req.body = params
+          end.body
+        end
+      end
+
+      def put(request_uri, params)
+        rescue_json_parsing do
+          connection.put do |req|
+            req.url File.join(connection.path_prefix, request_uri)
+            req.body = params
+          end.body
+        end
+      end
+
+      def delete(request_uri, params)
+        rescue_json_parsing do
+          connection.delete do |req|
+            req.url File.join(connection.path_prefix, request_uri), params
+          end.body
+        end
+      end
+      
+      private
+      
+      def connection
+        @conn ||= ::Faraday::Connection.new(:url => @api_url) do |builder|
+          builder.adapter :net_http
+          builder.response :yajl
+        end
+      end
+      
+      def rescue_json_parsing(&block)
+        begin
+          yield || raise(ServiceNotAvailable)
+        rescue ::Faraday::Error::ParsingError => e
+          raise(ServiceNotAvailable)
+        end
+      end
+      
+    end
+  end
+end

data/lib/panda/adapters/restclient.rb

@@ -0,0 +1,67 @@
+require 'restclient'
+require 'json' unless defined?(ActiveSupport::JSON) || defined?(JSON::JSON_LOADED)
+
+module Panda
+  module Adapter
+    class RestClient
+      
+      def initialize(api_url)
+        @api_url = api_url
+      end
+      
+      def get(request_uri, params)
+        rescue_json_parsing do
+          query = ApiAuthentication.hash_to_query(params)
+          hash_response connection[request_uri + '?' + query].get
+        end
+      end
+
+      def post(request_uri, params)
+        rescue_json_parsing do
+          hash_response connection[request_uri].post(params)
+        end
+      end
+
+      def put(request_uri, params)
+        rescue_json_parsing do
+          hash_response connection[request_uri].put(params)
+        end
+      end
+
+      def delete(request_uri, params)
+        rescue_json_parsing do
+          query = ApiAuthentication.hash_to_query(params)
+          hash_response connection[request_uri + '?' + query].delete
+        end
+      end
+
+      private
+      
+      def connection
+        @conn ||= ::RestClient::Resource.new(@api_url)
+      end
+      
+      def hash_response(response)
+        begin
+          if defined?(ActiveSupport::JSON)
+            ActiveSupport::JSON.decode(response)
+          else
+            JSON.parse(response)
+          end
+        rescue JSON::ParserError => e
+          raise ServiceNotAvailable.new
+        end
+      end
+      
+      def rescue_json_parsing(&block)
+        begin
+          yield
+        rescue ::RestClient::Exception => e
+          hash_response(e.http_body)
+        end
+      end
+      
+    end
+  end
+end
+    

data/lib/panda/api_authentication.rb

@@ -24,6 +24,8 @@ module Panda
       Base64.encode64(hmac.digest).chomp
     end
 
+    private
+
     # param keys should be strings, not symbols please. return a string joined
     # by & in canonical order. 
     def self.canonical_querystring(h)

data/lib/panda/base.rb

@@ -1,18 +1,22 @@
+require 'forwardable'
+
 module Panda
-  class Base    
+  class Base
     attr_accessor :attributes, :errors
+    extend Forwardable
+    
     include Panda::Router
+    include Panda::Builders
+    include Panda::Finders
+
+    def_delegators :attributes, :to_json
 
     def initialize(attributes = {})
-      init_load
+      clear_attributes
       load(attributes)
     end
 
     class << self
-      def id(this_id)
-        find(this_id)
-      end
-
       def sti_name
         "#{name.split('::').last}"
       end
@@ -26,11 +30,6 @@ module Panda
       id.nil?
     end
 
-    def delete
-      response = connection.delete(object_url_map(self.class.one_path))
-      !!response['deleted']
-    end
-
     def id
       attributes['id']
     end
@@ -44,41 +43,44 @@ module Panda
       self
     end
 
-    def to_json
-      attributes.to_json
-    end
-
     private
 
+    def load_and_reset(response)
+      load_response(response)
+    end
+    
     def perform_reload(args={})
       raise "RecordNotFound" if new?
 
-      url = self.class.object_url(self.class.one_path, :id => id)
+      url = self.class.create_rest_url(self.class.one_path, :id => id)
       response = connection.get(url)
-      init_load
       load_response(response.merge(args))
     end
 
-    def init_load
+    def clear_attributes
       @attributes = {}
       @changed_attributes = {}
       @errors = []
     end
 
     def load(attributes)
+      not_a_response = !(attributes['id'] || attributes[:id])
       attributes.each do |key, value|
         @attributes[key.to_s] = value
-        @changed_attributes[key.to_s] = value if !(attributes['id'] || attributes[:id])
+        @changed_attributes[key.to_s] = value if not_a_response
       end
       true
     end
 
     def load_response(response)
       if response['error'] || response['id'].nil?
-        !(@errors << Error.new(response))
+        @errors << APIError.new(response)
+        @loaded = false
       else
-        @errors=[]
+        clear_attributes
         load(response)
+        @changed_attributes = {};
+        @loaded = true
       end
     end