picasa 0.5.4 → 0.6.0

data/.gitignore

@@ -4,6 +4,8 @@
 .bundle
 .config
 .yardoc
+.rbenv-version
+.rbenv-gemsets
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -3,13 +3,8 @@ notifications:
 rvm:
   - 1.8.7
   - 1.9.3
-env:
-  - XML_PARSER=rexml
-  - XML_PARSER=nokogiri
-  - XML_PARSER=libxml
-  # does not work yet
-  # - XML_PARSER=ox
 
-matrix:
-  allow_failures:
-    - env: XML_PARSER=rexml
+env:
+  - JSON_PARSER=oj
+  - JSON_PARSER=yajl
+  - JSON_PARSER=json_pure

data/Gemfile

@@ -7,7 +7,7 @@ gem "rake"
 gem "minitest", "3.5.0", :platform => :ruby_18
 gem "debugger", :platform => :ruby_19
 
-# xml parsers
-gem "nokogiri"
-gem "libxml-ruby"
-gem "ox"
+# JSON parsers
+gem "oj"
+gem "yajl-ruby"
+gem "json_pure"

data/README.md

@@ -37,7 +37,7 @@ client = Picasa::Client.new(user_id: "some.user@gmail.com", password: "secret")
 Or by setting custom authorization header, i.e. taken from OAuth authentication:
 
 ```ruby
-client = Picasa::Client.new(user_id: "some.user@gmail.com", authorization_header: "OAuth token")
+client = Picasa::Client.new(user_id: "some.user@gmail.com", authorization_header: "Bearer access-token")
 ```
 
 ### Proxy
@@ -78,18 +78,9 @@ If you run out of quota and want to resize images to fit Picasa free storage lim
 thor imagery:resize path-to-folder-with-photos
 ```
 
-## Caveats
+### Boost
 
-Currently picasa wont work with `ox` xml parser.
-
-Using `rexml` parser wont return `etag` attribute properly.
-
-I recommend to use `libxml` or `nokogiri`.
-You can set it by:
-
-```ruby
-MultiXml.parser = :libxml
-```
+Picasa uses gzipped requests to speedup fetching results. Benchmarks are available on [Vinicius Teles gist](https://gist.github.com/4012466)
 
 ## Continuous Integration
 [![Build Status](https://secure.travis-ci.org/morgoth/picasa.png)](http://travis-ci.org/morgoth/picasa)
@@ -102,6 +93,7 @@ MultiXml.parser = :libxml
 * [Javier Guerra](https://github.com/javierg)
 * [Eiichi Takebuchi](https://github.com/GRGSIBERIA)
 * [TADA Tadashi](https://github.com/tdtds)
+* [Vinicius Teles](https://github.com/viniciusteles)
 
 ## Copyright
 

data/extra/Thorfile

@@ -1,9 +1,6 @@
 require "picasa"
 require "thread"
 
-# Temporary requirement
-MultiXml.parser = :libxml
-
 class Imagery < Thor
   include Thor::Actions
 

data/lib/picasa.rb

@@ -1,8 +1,7 @@
-require "multi_xml"
-
 require "picasa/version"
 require "picasa/utils"
 require "picasa/exceptions"
+require "picasa/http"
 require "picasa/connection"
 require "picasa/client"
 require "picasa/file"
@@ -25,9 +24,3 @@ require "picasa/presenter/photo"
 require "picasa/presenter/tag"
 require "picasa/presenter/tag_list"
 require "picasa/presenter/thumbnail"
-
-module Picasa
-  API_URL      = "https://picasaweb.google.com"
-  API_AUTH_URL = "https://www.google.com"
-  API_VERSION  = "2"
-end

data/lib/picasa/api/album.rb

@@ -13,10 +13,10 @@ module Picasa
       #
       # @return [Presenter::AlbumList]
       def list(options = {})
-        uri = URI.parse("/data/feed/api/user/#{user_id}")
-        response = Connection.new.get(:path => uri.path, :query => options, :headers => auth_header)
+        path = "/data/feed/api/user/#{user_id}"
+        response = Connection.new.get(:path => path, :query => options, :headers => auth_header)
 
-        Presenter::AlbumList.new(MultiXml.parse(response.body)["feed"])
+        Presenter::AlbumList.new(response.parsed_response["feed"])
       end
 
       # Returns photo list for given album
@@ -30,10 +30,10 @@ module Picasa
       # @return [Presenter::Album]
       # @raise [NotFoundError] raised when album cannot be found
       def show(album_id, options = {})
-        uri = URI.parse("/data/feed/api/user/#{user_id}/albumid/#{album_id}")
-        response = Connection.new.get(:path => uri.path, :query => options, :headers => auth_header)
+        path = "/data/feed/api/user/#{user_id}/albumid/#{album_id}"
+        response = Connection.new.get(:path => path, :query => options, :headers => auth_header)
 
-        Presenter::Album.new(MultiXml.parse(response.body)["feed"])
+        Presenter::Album.new(response.parsed_response["feed"])
       end
 
       # Creates album
@@ -52,10 +52,10 @@ module Picasa
         params[:access] ||= "private"
 
         template = Template.new(:new_album, params)
-        uri = URI.parse("/data/feed/api/user/#{user_id}")
-        response = Connection.new.post(:path => uri.path, :body => template.render, :headers => auth_header)
+        path = "/data/feed/api/user/#{user_id}"
+        response = Connection.new.post(:path => path, :body => template.render, :headers => auth_header)
 
-        Presenter::Album.new(MultiXml.parse(response.body)["entry"])
+        Presenter::Album.new(response.parsed_response["entry"])
       end
 
       # Destroys given album
@@ -69,8 +69,8 @@ module Picasa
       # @raise [PreconditionFailedError] raised when ETag does not match
       def destroy(album_id, options = {})
         headers = auth_header.merge({"If-Match" => options.fetch(:etag, "*")})
-        uri = URI.parse("/data/entry/api/user/#{user_id}/albumid/#{album_id}")
-        Connection.new.delete(:path => uri.path, :headers => headers)
+        path = "/data/entry/api/user/#{user_id}/albumid/#{album_id}"
+        Connection.new.delete(:path => path, :headers => headers)
         true
       end
       alias :delete :destroy

data/lib/picasa/api/base.rb

@@ -7,9 +7,6 @@ module Picasa
       # @option credentials [String] :user_id google username/email
       # @option credentials [String] :authorization_header header for authenticating requests
       def initialize(credentials = {})
-        if MultiXml.parser.to_s == "MultiXml::Parsers::Ox"
-          raise StandardError, "MultiXml parser is set to :ox - picasa gem will not work with it currently, use one of: :libxml, :nokogiri, :rexml"
-        end
         @user_id  = credentials.fetch(:user_id)
         @authorization_header = credentials[:authorization_header]
       end

data/lib/picasa/api/comment.rb

@@ -19,10 +19,9 @@ module Picasa
         path << "/albumid/#{album_id}" if album_id
         path << "/photoid/#{photo_id}" if photo_id
 
-        uri = URI.parse(path)
-        response = Connection.new.get(:path => uri.path, :query => options.merge(:kind => "comment"), :headers => auth_header)
+        response = Connection.new.get(:path => path, :query => options.merge(:kind => "comment"), :headers => auth_header)
 
-        Presenter::CommentList.new(MultiXml.parse(response.body)["feed"])
+        Presenter::CommentList.new(response.parsed_response["feed"])
       end
 
       # Creates a comment for a photo.
@@ -42,10 +41,9 @@ module Picasa
 
         template = Template.new("new_comment", params)
 
-        uri = URI.parse(path)
-        response = Connection.new.post(:path => uri.path, :body => template.render, :headers => auth_header)
+        response = Connection.new.post(:path => path, :body => template.render, :headers => auth_header)
 
-        Presenter::Comment.new(MultiXml.parse(response.body)["entry"])
+        Presenter::Comment.new(response.parsed_response["entry"])
       end
 
       # Removes a comment from given photo.
@@ -60,8 +58,8 @@ module Picasa
         album_id = params.delete(:album_id) || raise(ArgumentError, "You must specify album_id")
         photo_id = params.delete(:photo_id) || raise(ArgumentError, "You must specify photo_id")
 
-        uri = URI.parse("/data/entry/api/user/#{user_id}/albumid/#{album_id}/photoid/#{photo_id}/commentid/#{comment_id}")
-        Connection.new.delete(:path => uri.path, :headers => auth_header)
+        path = "/data/entry/api/user/#{user_id}/albumid/#{album_id}/photoid/#{photo_id}/commentid/#{comment_id}"
+        Connection.new.delete(:path => path, :headers => auth_header)
         true
       end
       alias :delete :destroy

data/lib/picasa/api/photo.rb

@@ -13,19 +13,19 @@ module Picasa
       # @option options [String] :binary binary data (i.e. File.open("my-photo.png", "rb").read)
       # @option options [String] :content_type ["image/jpeg", "image/png", "image/bmp", "image/gif"] content type of given image
       def create(album_id, params = {})
-        file = params[:file_path] ? File.new(params.delete(:file_path)) : nil
+        file = params[:file_path] ? File.new(params.delete(:file_path)) : File::Null.new
         params[:boundary]     ||= "===============PicasaRubyGem=="
-        params[:title]        ||= (file && file.name) || raise(ArgumentError.new("title must be specified"))
-        params[:binary]       ||= (file && file.binary) || raise(ArgumentError.new("binary must be specified"))
-        params[:content_type] ||= (file && file.content_type) || raise(ArgumentError.new("content_type must be specified"))
+        params[:title]        ||= file.name || raise(ArgumentError.new("title must be specified"))
+        params[:binary]       ||= file.binary || raise(ArgumentError.new("binary must be specified"))
+        params[:content_type] ||= file.content_type || raise(ArgumentError.new("content_type must be specified"))
 
         template = Template.new(:new_photo, params)
         headers = auth_header.merge({"Content-Type" => "multipart/related; boundary=\"#{params[:boundary]}\""})
 
-        uri = URI.parse("/data/feed/api/user/#{user_id}/albumid/#{album_id}")
-        response = Connection.new.post(:path => uri.path, :body => template.render, :headers => headers)
+        path = "/data/feed/api/user/#{user_id}/albumid/#{album_id}"
+        response = Connection.new.post(:path => path, :body => template.render, :headers => headers)
 
-        Presenter::Photo.new(MultiXml.parse(response.body)["entry"])
+        Presenter::Photo.new(response.parsed_response["entry"])
       end
 
       # Destroys given photo
@@ -40,8 +40,8 @@ module Picasa
       # @raise [PreconditionFailedError] raised when ETag does not match
       def destroy(album_id, photo_id, options = {})
         headers = auth_header.merge({"If-Match" => options.fetch(:etag, "*")})
-        uri = URI.parse("/data/entry/api/user/#{user_id}/albumid/#{album_id}/photoid/#{photo_id}")
-        Connection.new.delete(:path => uri.path, :headers => headers)
+        path = "/data/entry/api/user/#{user_id}/albumid/#{album_id}/photoid/#{photo_id}"
+        Connection.new.delete(:path => path, :headers => headers)
         true
       end
       alias :delete :destroy

data/lib/picasa/api/tag.rb

@@ -19,10 +19,9 @@ module Picasa
         path << "/albumid/#{album_id}" if album_id
         path << "/photoid/#{photo_id}" if photo_id
 
-        uri = URI.parse(path)
-        response = Connection.new.get(:path => uri.path, :query => options.merge(:kind => "tag"), :headers => auth_header)
+        response = Connection.new.get(:path => path, :query => options.merge(:kind => "tag"), :headers => auth_header)
 
-        Presenter::TagList.new(MultiXml.parse(response.body)["feed"])
+        Presenter::TagList.new(response.parsed_response["feed"])
       end
 
       # Creates a tag for a photo.
@@ -42,10 +41,9 @@ module Picasa
 
         template = Template.new("new_tag", params)
 
-        uri = URI.parse(path)
-        response = Connection.new.post(:path => uri.path, :body => template.render, :headers => auth_header)
+        response = Connection.new.post(:path => path, :body => template.render, :headers => auth_header)
 
-        Presenter::Tag.new(MultiXml.parse(response.body)["entry"])
+        Presenter::Tag.new(response.parsed_response["entry"])
       end
 
       # Removes a tag from given photo.
@@ -60,8 +58,8 @@ module Picasa
         album_id = params.delete(:album_id) || raise(ArgumentError, "You must specify album_id")
         photo_id = params.delete(:photo_id) || raise(ArgumentError, "You must specify photo_id")
 
-        uri = URI.parse("/data/entry/api/user/#{user_id}/albumid/#{album_id}/photoid/#{photo_id}/tag/#{tag_id}")
-        Connection.new.delete(:path => uri.path, :headers => auth_header)
+        path = "/data/entry/api/user/#{user_id}/albumid/#{album_id}/photoid/#{photo_id}/tag/#{tag_id}"
+        Connection.new.delete(:path => path, :headers => auth_header)
         true
       end
       alias :delete :destroy

data/lib/picasa/client.rb

@@ -63,7 +63,7 @@ module Picasa
     # @return [String]
     def authenticate
       response = Connection.new.post(
-        :host => API_AUTH_URL,
+        :host => HTTP::API_AUTH_URL,
         :headers => {"Content-Type" => "application/x-www-form-urlencoded"},
         :path => "/accounts/ClientLogin",
         :body => Utils.inline_query(
@@ -71,7 +71,7 @@ module Picasa
           "Email"       => user_id,
           "Passwd"      => password,
           "service"     => "lh2",
-          "source"      => "ruby-gem-v#{VERSION}"
+          "source"      => "ruby-gem-picasa-v#{VERSION}"
         )
       )
 

data/lib/picasa/connection.rb

@@ -1,6 +1,3 @@
-require "net/https"
-require "uri"
-
 module Picasa
   class Connection
     # @param [Hash] params request arguments
@@ -9,13 +6,9 @@ module Picasa
     # @option params [String] :query request url query
     # @option params [String] :headers request headers
     def get(params = {})
-      params[:host]    ||= API_URL
-      params[:headers] ||= {}
-      params[:query]   ||= {}
-
-      path = path_with_query(params[:path], params[:query])
-      request = Net::HTTP::Get.new(path, headers.merge(params[:headers]))
-      handle_response(http(params[:host]).request(request))
+      # FIXME: how to add headers to default ones instead of replacing?
+      params[:headers] = Picasa::HTTP.headers.merge(params[:headers]) if params.has_key?(:headers)
+      exec_request(params) { |uri, options| HTTP.get(uri, options) }
     end
 
     # @param [Hash] params request arguments
@@ -25,12 +18,10 @@ module Picasa
     # @option params [String] :query request url query
     # @option params [String] :headers request headers
     def post(params = {})
-      params[:host]    ||= API_URL
       params[:headers] ||= {}
-
-      request = Net::HTTP::Post.new(params[:path], headers.merge(params[:headers]))
-      request.body = params[:body]
-      handle_response(http(params[:host]).request(request))
+      params[:headers]["Content-Type"] ||= "application/atom+xml"
+      params[:headers] = Picasa::HTTP.headers.merge(params[:headers])
+      exec_request(params) { |uri, options| HTTP.post(uri, options) }
     end
 
     # @param [Hash] params request arguments
@@ -39,36 +30,24 @@ module Picasa
     # @option params [String] :query request url query
     # @option params [String] :headers request headers
     def delete(params = {})
-      params[:host]    ||= API_URL
-      params[:headers] ||= {}
-
-      request = Net::HTTP::Delete.new(params[:path], headers.merge(params[:headers]))
-      handle_response(http(params[:host]).request(request))
-    end
-
-    def path_with_query(path, query = {})
-      path = path + "?" + Utils.inline_query(query) unless query.empty?
-      URI.parse(path).to_s
+      params[:headers] = Picasa::HTTP.headers.merge(params[:headers]) if params.has_key?(:headers)
+      exec_request(params) { |uri, options| HTTP.delete(uri, options) }
     end
 
     private
 
-    def http(url = API_URL)
-      uri = URI.parse(url)
-
-      if proxy?
-        http = Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password).new(uri.host, uri.port)
-      else
-        http = Net::HTTP.new(uri.host, uri.port)
-      end
-      http.use_ssl = true
-      http
+    def exec_request(params, &block)
+      uri = "#{params.delete(:host)}#{params.delete(:path)}"
+      params.delete_if { |key, value| value.nil? || value.empty? }
+      handle_response(yield(uri, params))
     end
 
     def handle_response(response)
       case response.code.to_i
       when 200...300
         response
+      when 400
+        raise BadRequestError.new(response.body, response)
       when 403
         raise ForbiddenError.new(response.body, response)
       when 404
@@ -79,21 +58,5 @@ module Picasa
         raise ResponseError.new(response.body, response)
       end
     end
-
-    def headers
-      {
-        "User-Agent"    => "ruby-gem-v#{VERSION}",
-        "GData-Version" => API_VERSION,
-        "Content-Type"  => "application/atom+xml"
-      }
-    end
-
-    def proxy_uri
-      @proxy_uri ||= URI.parse(ENV["https_proxy"] || ENV["HTTPS_PROXY"])
-    end
-
-    def proxy?
-      ENV.has_key?("https_proxy") || ENV.has_key?("HTTPS_PROXY")
-    end
   end
 end

data/lib/picasa/exceptions.rb

@@ -15,6 +15,7 @@ module Picasa
     end
   end
 
+  class BadRequestError < ResponseError; end
   class NotFoundError < ResponseError; end
   class ForbiddenError < ResponseError; end
   class PreconditionFailedError < ResponseError; end

data/lib/picasa/file.rb

@@ -1,5 +1,13 @@
 module Picasa
   class File
+    class Null
+      def path; end
+      def name; end
+      def extension; end
+      def binary; end
+      def content_type; end
+    end
+
     attr_reader :path
 
     def initialize(path)

data/lib/picasa/http.rb

@@ -0,0 +1,28 @@
+require "httparty"
+require "uri"
+
+module Picasa
+  class HTTP
+    include HTTParty
+
+    API_URL      = "https://picasaweb.google.com"
+    API_AUTH_URL = "https://www.google.com"
+    API_VERSION  = "2"
+
+    def self.proxy
+      proxy_uri = URI.parse(ENV["https_proxy"] || ENV["HTTPS_PROXY"] || "")
+      [proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password]
+    end
+
+    format         :json
+    default_params :alt => :json
+
+    headers        "User-Agent"      => "ruby-gem-picasa-v#{VERSION} (gzip)",
+                   "GData-Version"   => API_VERSION,
+                   "Accept-Encoding" => "gzip, deflate"
+
+    base_uri       API_URL
+
+    http_proxy     *proxy
+  end
+end