picasa 0.4.0 → 0.4.1

data/README.md

@@ -10,6 +10,8 @@ gem install picasa
 
 ## Usage
 
+[Documentation](http://rubydoc.info/github/morgoth/picasa)
+
 ``` ruby
 client = Picasa::Client.new(user_id: "username@gmail.com")
 client.album.list

data/lib/picasa.rb

@@ -10,6 +10,7 @@ require "picasa/api/album"
 require "picasa/presenter/album"
 require "picasa/presenter/album_list"
 require "picasa/presenter/author"
+require "picasa/presenter/content"
 require "picasa/presenter/link"
 require "picasa/presenter/media"
 require "picasa/presenter/photo"

data/lib/picasa/api/album.rb

@@ -4,8 +4,8 @@ module Picasa
       attr_reader :user_id, :credentials
 
       # @param [Hash] credentials
-      #   @option options [String] :user_id google username/email
-      #   @option options [String] :password password for given username/email
+      # @option credentials [String] :user_id google username/email
+      # @option credentials [String] :password password for given username/email
       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"
@@ -16,7 +16,7 @@ module Picasa
 
       # Returns album list
       #
-      # @param [Hash] additional options included in request
+      # @param [Hash] options additional options included in request
       #
       # @return [Presenter::AlbumList]
       def list(options = {})
@@ -28,10 +28,10 @@ module Picasa
 
       # Returns photo list for given album
       #
-      # @param [String] id of album
-      # @param [Hash] additional options included in request
-      #   @option options [String, Integer] :max_results max number of returned results
-      #   @option options [String] :tag include photos with given tag only
+      # @param [String] album_id album id
+      # @param [Hash] options additional options included in request
+      # @option options [String, Integer] :max_results max number of returned results
+      # @option options [String] :tag include photos with given tag only
       #
       # @return [Presenter::Album]
       def show(album_id, options = {})

data/lib/picasa/client.rb

@@ -2,11 +2,21 @@ module Picasa
   class Client
     attr_reader :credentials
 
+    # @param [Hash] credentials
+    # @option credentials [String] :user_id google username/email
+    # @option credentials [String] :password password for given username/email
     def initialize(credentials = {})
       credentials[:user_id] || raise(ArgumentError, "You must specify user_id")
       @credentials = credentials
     end
 
+    # @return [API::Album]
+    #
+    # @example
+    #   client = Picasa::Client.new(user_id: "my.email@google.com")
+    #   album_list = client.album.list
+    #   album_list.title
+    #   # => "My album"
     def album
       API::Album.new(credentials)
     end

data/lib/picasa/presenter/album.rb

@@ -3,71 +3,88 @@ require "picasa/presenter/base"
 module Picasa
   module Presenter
     class Album < Base
+      # @return [Presenter::Author]
       def author
         @author ||= Author.new(safe_retrieve(parsed_body, "author"))
       end
 
+      # @return [Array<Presenter::Photo>]
       def entries
         @entries ||= array_wrap(safe_retrieve(parsed_body, "entry")).map { |photo| Photo.new(photo) }
       end
       alias :photos :entries
 
+      # @return [Array<Presenter::Link>]
       def links
         @links ||= safe_retrieve(parsed_body, "link").map { |link| Link.new(link) }
       end
 
+      # @return [Presenter::Media]
       def media
         @media ||= Media.new(safe_retrieve(parsed_body, "group"))
       end
 
+      # @return [DateTime]
       def published
         @published ||= map_to_date(safe_retrieve(parsed_body, "published"))
       end
 
+      # @return [DateTime]
       def updated
         @updated ||= map_to_date(safe_retrieve(parsed_body, "updated"))
       end
 
+      # @return [String]
       def title
         @title ||= safe_retrieve(parsed_body, "title")
       end
 
+      # @return [String]
       def summary
         @summary ||= safe_retrieve(parsed_body, "summary")
       end
 
+      # @return [String]
       def rights
         @rights ||= safe_retrieve(parsed_body, "rights")
       end
 
+      # @return [String]
       def id
         @id ||= array_wrap(safe_retrieve(parsed_body, "id"))[1]
       end
 
+      # @return [String]
       def name
         @name ||= safe_retrieve(parsed_body, "name")
       end
 
+      # @return [String]
       def location
         @location ||= safe_retrieve(parsed_body, "location")
       end
 
+      # @return [String]
       def access
         @access ||= safe_retrieve(parsed_body, "access")
       end
 
+      # @return [String]
       def timestamp
         @timestamp ||= safe_retrieve(parsed_body, "timestamp")
       end
 
+      # @return [String]
       def numphotos
         @numphotos ||= map_to_integer(safe_retrieve(parsed_body, "numphotos"))
       end
 
+      # @return [String]
       def user
         @user ||= safe_retrieve(parsed_body, "user")
       end
 
+      # @return [String]
       def nickname
         @nickname ||= safe_retrieve(parsed_body, "nickname")
       end

data/lib/picasa/presenter/album_list.rb

@@ -3,55 +3,68 @@ require "picasa/presenter/base"
 module Picasa
   module Presenter
     class AlbumList < Base
+      # @return [Presenter::Author]
       def author
         @author ||= Author.new(safe_retrieve(parsed_body, "author"))
       end
 
+      # @return [Array<Presenter::Album>]
       def entries
         @entries ||= array_wrap(safe_retrieve(parsed_body, "entry")).map { |entry| Album.new(entry) }
       end
       alias :albums :entries
 
+      # @return [Array<Presenter::Link>]
       def links
         @links ||= safe_retrieve(parsed_body, "link").map { |link| Link.new(link) }
       end
 
+      # @return [String]
       def title
         @title ||= safe_retrieve(parsed_body, "title")
       end
 
+      # @return [DateTime]
       def updated
         @updated ||= map_to_date(safe_retrieve(parsed_body, "updated"))
       end
 
+      # @return [String]
       def icon
         @icon ||= safe_retrieve(parsed_body, "icon")
       end
 
+      # @return [String]
       def generator
         @generator ||= safe_retrieve(parsed_body, "generator", "__content__")
       end
 
+      # @return [Integer]
       def total_results
         @total_results ||= map_to_integer(safe_retrieve(parsed_body, "totalResults"))
       end
 
+      # @return [Integer]
       def start_index
         @start_index ||= map_to_integer(safe_retrieve(parsed_body, "startIndex"))
       end
 
+      # @return [Integer]
       def items_per_page
         @items_per_page ||= map_to_integer(safe_retrieve(parsed_body, "itemsPerPage"))
       end
 
+      # @return [String]
       def user
         @user ||= safe_retrieve(parsed_body, "user")
       end
 
+      # @return [String]
       def nickname
         @nickname ||= safe_retrieve(parsed_body, "nickname")
       end
 
+      # @return [String]
       def thumbnail
         @thumbnail ||= safe_retrieve(parsed_body, "thumbnail")
       end

data/lib/picasa/presenter/author.rb

@@ -3,10 +3,12 @@ require "picasa/presenter/base"
 module Picasa
   module Presenter
     class Author < Base
+      # @return [String]
       def name
         @name ||= safe_retrieve(parsed_body, "name")
       end
 
+      # @return [String]
       def uri
         @uri ||= safe_retrieve(parsed_body, "uri")
       end

data/lib/picasa/presenter/content.rb

@@ -0,0 +1,17 @@
+require "picasa/presenter/base"
+
+module Picasa
+  module Presenter
+    class Content < Base
+      # @return [String]
+      def type
+        @type ||= safe_retrieve(parsed_body, "type")
+      end
+
+      # @return [String]
+      def src
+        @src ||= safe_retrieve(parsed_body, "src")
+      end
+    end
+  end
+end

data/lib/picasa/presenter/link.rb

@@ -3,14 +3,17 @@ require "picasa/presenter/base"
 module Picasa
   module Presenter
     class Link < Base
+      # @return [String]
       def rel
         @rel ||= safe_retrieve(parsed_body, "rel")
       end
 
+      # @return [String]
       def type
         @type ||= safe_retrieve(parsed_body, "type")
       end
 
+      # @return [String]
       def href
         @href ||= safe_retrieve(parsed_body, "href")
       end

data/lib/picasa/presenter/media.rb

@@ -3,22 +3,27 @@ require "picasa/presenter/base"
 module Picasa
   module Presenter
     class Media < Base
+      # @return [Array<Presenter::Thumbnail>]
       def thumbnails
         @thumbnails ||= array_wrap(safe_retrieve(parsed_body, "thumbnail")).map { |thumbnail| Thumbnail.new(thumbnail) }
       end
 
+      # @return [String]
       def credit
         @credit ||= safe_retrieve(parsed_body, "credit")
       end
 
+      # @return [String]
       def description
         @description ||= safe_retrieve(parsed_body, "description")
       end
 
+      # @return [String]
       def keywords
         @keywords ||= safe_retrieve(parsed_body, "keywords")
       end
 
+      # @return [String]
       def title
         @title ||= safe_retrieve(parsed_body, "title", "__content__")
       end

data/lib/picasa/presenter/photo.rb

@@ -3,74 +3,97 @@ require "picasa/presenter/base"
 module Picasa
   module Presenter
     class Photo < Base
+      # @return [Array<Presenter::Link>]
       def links
         @links ||= safe_retrieve(parsed_body, "link").map { |link| Link.new(link) }
       end
 
+      # @return [Presenter::Media]
       def media
         @media ||= Media.new(safe_retrieve(parsed_body, "group"))
       end
 
+      # @return [Presenter::Content]
+      def content
+        @content ||= Content.new(safe_retrieve(parsed_body, "content"))
+      end
+
+      # @return [String]
       def id
         @id ||= array_wrap(safe_retrieve(parsed_body, "id"))[1]
       end
 
+      # @return [DateTime]
       def published
         @published ||= map_to_date(safe_retrieve(parsed_body, "published"))
       end
 
+      # @return [DateTime]
       def updated
         @updated ||= map_to_date(safe_retrieve(parsed_body, "updated"))
       end
 
+      # @return [String]
       def title
         @title ||= safe_retrieve(parsed_body, "title")
       end
 
+      # @return [String]
       def summary
         @summary ||= safe_retrieve(parsed_body, "summary")
       end
 
+      # @return [String]
       def album_id
         @album_id ||= safe_retrieve(parsed_body, "albumid")
       end
 
+      # @return [String]
       def access
         @access ||= safe_retrieve(parsed_body, "access")
       end
 
+      # @return [Integer]
       def width
         @width ||= map_to_integer(safe_retrieve(parsed_body, "width"))
       end
 
+      # @return [Integer]
       def height
         @height ||= map_to_integer(safe_retrieve(parsed_body, "height"))
       end
 
+      # @return [Integer]
       def size
         @size ||= map_to_integer(safe_retrieve(parsed_body, "size"))
       end
 
+      # @return [String]
       def checksum
         @checksum ||= safe_retrieve(parsed_body, "checksum")
       end
 
+      # @return [String]
       def timestamp
         @timestamp ||= safe_retrieve(parsed_body, "timestamp")
       end
 
+      # @return [Integer]
       def image_version
         @image_version ||= map_to_integer(safe_retrieve(parsed_body, "imageVersion"))
       end
 
+      # @return [true, false, nil]
       def commenting_enabled
         @commenting_enabled ||= map_to_boolean(safe_retrieve(parsed_body, "commentingEnabled"))
       end
 
+      # @return [Integer]
       def comment_count
         @comment_count ||= map_to_integer(safe_retrieve(parsed_body, "commentCount"))
       end
 
+      # @return [String]
       def license
         @license ||= safe_retrieve(parsed_body, "license", "__content__")
       end

data/lib/picasa/presenter/thumbnail.rb

@@ -3,14 +3,17 @@ require "picasa/presenter/base"
 module Picasa
   module Presenter
     class Thumbnail < Base
+      # @return [String]
       def url
         @url ||= safe_retrieve(parsed_body, "url")
       end
 
+      # @return [String]
       def width
         @width ||= map_to_integer(safe_retrieve(parsed_body, "width"))
       end
 
+      # @return [String]
       def height
         @height ||= map_to_integer(safe_retrieve(parsed_body, "height"))
       end

data/lib/picasa/version.rb

@@ -1,3 +1,3 @@
 module Picasa
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/test/presenter/content_test.rb

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require "helper"
+
+describe Picasa::Presenter::Content do
+  before do
+    body = MultiXml.parse(fixture("presenters/album_show.xml"))
+    @content = Picasa::Presenter::Content.new(body["feed"]["entry"][0]["content"])
+  end
+
+  it "has src" do
+    expected = "https://lh4.googleusercontent.com/-O0AOpTAPGBQ/SMU_j4ADl9I/AAAAAAAAAFs/DRnmROPuRVU/Kashmir%252520range.jpg"
+    assert_equal expected, @content.src
+  end
+
+  it "has type" do
+    assert_equal "image/jpeg", @content.type
+  end
+end

data/test/presenter/photo_test.rb

@@ -11,6 +11,11 @@ describe Picasa::Presenter::Photo do
     assert_equal 5, @photo.links.size
   end
 
+  it "has content src" do
+    expected = "https://lh4.googleusercontent.com/-O0AOpTAPGBQ/SMU_j4ADl9I/AAAAAAAAAFs/DRnmROPuRVU/Kashmir%252520range.jpg"
+    assert_equal expected, @photo.content.src
+  end
+
   it "has media credit" do
     assert_equal "Wojciech Wnętrzak", @photo.media.credit
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picasa
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
+date: 2012-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_xml
@@ -81,6 +81,7 @@ files:
 - lib/picasa/presenter/album_list.rb
 - lib/picasa/presenter/author.rb
 - lib/picasa/presenter/base.rb
+- lib/picasa/presenter/content.rb
 - lib/picasa/presenter/link.rb
 - lib/picasa/presenter/media.rb
 - lib/picasa/presenter/photo.rb
@@ -114,6 +115,7 @@ files:
 - test/presenter/album_test.rb
 - test/presenter/author_test.rb
 - test/presenter/base_test.rb
+- test/presenter/content_test.rb
 - test/presenter/link_test.rb
 - test/presenter/media_test.rb
 - test/presenter/photo_test.rb