flickrie 1.2.0 → 1.3.0

data/README.md

@@ -232,8 +232,8 @@ default.
 
 ## Issues
 
-Please, feel free to post any issues that you're having, I will be happy
-to help. I will also be happy if you let me know about any bugs.
+Please, feel free to post any issues that you're having. You can also
+post feature requests.
 
 ## Cedits
 
@@ -250,6 +250,7 @@ basis of this gem.
 "flickr.people.getInfo"                 -> Flickrie.get_user_info
 "flickr.people.getPhotos"               -> Flickrie.photos_from_user
 "flickr.people.getPublicPhotos"         -> Flickrie.public_photos_from_user
+"flickr.people.getUploadStatus"         -> Flickrie.get_upload_status
 
 # photos
 "flickr.photos.addTags"                 -> Flickrie.add_photo_tags
@@ -261,6 +262,7 @@ basis of this gem.
 "flickr.photos.getExif"                 -> Flickrie.get_photo_exif
 "flickr.photos.getFavorites"            -> Flickrie.get_photo_favorites
 "flickr.photos.getInfo"                 -> Flickrie.get_photo_info
+"flickr.photos.getNotInSet"             -> Flickrie.photos_not_in_set
 "flickr.photos.getSizes"                -> Flickrie.get_photo_sizes
 "flickr.photos.removeTag"               -> Flickrie.remove_photo_tag
 "flickr.photos.search"                  -> Flickrie.search_photos
@@ -284,6 +286,10 @@ basis of this gem.
 
 You can see the changelog [here](https://github.com/janko-m/flickrie/blob/master/CHANGELOG.md).
 
+## Social
+
+You can follow me on Twitter, I'm **@m_janko**.
+
 ## License
 
 [MIT](https://github.com/janko-m/flickrie/blob/master/LICENSE)

data/lib/flickrie/api_methods.rb

@@ -1,17 +1,3 @@
-require 'flickrie/middleware'
-require 'flickrie/client'
-require 'flickrie/upload_client'
-require 'flickrie/oauth'
-require 'flickrie/license'
-require 'flickrie/user'
-require 'flickrie/media'
-require 'flickrie/photo'
-require 'flickrie/video'
-require 'flickrie/set'
-require 'flickrie/media_count'
-require 'flickrie/ticket'
-require 'flickrie/core_ext'
-
 module Flickrie
   module ApiMethods
     # For uploading photos and videos to Flickr. Example:
@@ -93,7 +79,7 @@ module Flickrie
     # Fetches photos and videos from the Flickr user with the given NSID.
     #
     # @param nsid [String]
-    # @return [Array<Flickrie::Photo, Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
     # @api_method [flickr.people.getPhotos](http://www.flickr.com/services/api/flickr.people.getPhotos.html)
     #
     # @note This method requires authentication with "read" permissions.
@@ -104,7 +90,7 @@ module Flickrie
     # Fetches photos from the Flickr user with the given NSID.
     #
     # @param nsid [String]
-    # @return [Array<Flickrie::Photo>]
+    # @return [Flickrie::Collection<Flickrie::Photo>]
     # @api_method [flickr.people.getPhotos](http://www.flickr.com/services/api/flickr.people.getPhotos.html)
     #
     # @note This method requires authentication with "read" permissions.
@@ -115,7 +101,7 @@ module Flickrie
     # Fetches videos from the Flickr user with the given NSID.
     #
     # @param nsid [String]
-    # @return [Array<Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Video>]
     # @api_method [flickr.people.getPhotos](http://www.flickr.com/services/api/flickr.people.getPhotos.html)
     #
     # @note This method requires authentication with "read" permissions.
@@ -128,7 +114,7 @@ module Flickrie
     # NSID.
     #
     # @param nsid [String]
-    # @return [Array<Flickrie::Photo, Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
     # @api_method [flickr.people.getPublicPhotos](http://www.flickr.com/services/api/flickr.people.getPublicPhotos.html)
     def public_media_from_user(nsid, params = {})
       response = client.public_media_from_user(nsid, params)
@@ -137,7 +123,7 @@ module Flickrie
     # Fetches public photos from the Flickr user with the given NSID.
     #
     # @param nsid [String]
-    # @return [Array<Flickrie::Photo>]
+    # @return [Flickrie::Collection<Flickrie::Photo>]
     # @api_method [flickr.people.getPublicPhotos](http://www.flickr.com/services/api/flickr.people.getPublicPhotos.html)
     def public_photos_from_user(nsid, params = {})
       public_media_from_user(nsid, params).
@@ -146,13 +132,25 @@ module Flickrie
     # Fetches public videos from the Flickr user with the given NSID.
     #
     # @param nsid [String]
-    # @return [Array<Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Video>]
     # @api_method [flickr.people.getPublicPhotos](http://www.flickr.com/services/api/flickr.people.getPublicPhotos.html)
     def public_videos_from_user(nsid, params = {})
       public_media_from_user(nsid, params).
         select { |media| media.is_a?(Video) }
     end
 
+    # Returns the upload status of the user who is currently authenticated.
+    #
+    # @return [Flickrie::User]
+    # @api_method [flickr.people.getUploadStatus](http://www.flickr.com/services/api/flickr.people.getUploadStatus.html)
+    # @see Flickrie::User#upload_status
+    #
+    # @note This method requires authentication with "read" permissions.
+    def get_upload_status(params = {})
+      response = client.get_upload_status(params)
+      User.from_upload_status(response.body['user'])
+    end
+
     # Add tags to the photo/video with the given ID.
     #
     # @param media_id [String, Fixnum]
@@ -185,7 +183,7 @@ module Flickrie
     # Fetches photos and videos from contacts of the user who authenticated.
     #
     # @param params [Hash] Options for this API method (see the link below under "Flickr API method")
-    # @return [Array<Flickrie::Photo, Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
     # @api_method [flickr.photos.getContactsPhotos](http://www.flickr.com/services/api/flickr.photos.getContactsPhotos.html)
     #
     # @note This method requires authentication with "read" permissions.
@@ -196,7 +194,7 @@ module Flickrie
     # Fetches photos from contacts of the user who authenticated.
     #
     # @param params [Hash] Options for this API method (see the link below under "Flickr API method")
-    # @return [Array<Flickrie::Photo>]
+    # @return [Flickrie::Collection<Flickrie::Photo>]
     # @api_method [flickr.photos.getContactsPhotos](http://www.flickr.com/services/api/flickr.photos.getContactsPhotos.html)
     #
     # @note This method requires authentication with "read" permissions.
@@ -206,7 +204,7 @@ module Flickrie
     # Fetches videos from contacts of the user who authenticated.
     #
     # @param params [Hash] Options for this API method (see the link below under "Flickr API method")
-    # @return [Array<Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Video>]
     # @api_method [flickr.photos.getContactsPhotos](http://www.flickr.com/services/api/flickr.photos.getContactsPhotos.html)
     #
     # @note This method requires authentication with "read" permissions.
@@ -219,6 +217,7 @@ module Flickrie
     #
     # @param nsid [String]
     # @param params [Hash] Options for this API method (see the link below under "Flickr API method")
+    # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
     # @api_method [flickr.photos.getContactsPublicPhotos](http://www.flickr.com/services/api/flickr.photos.getContactsPublicPhotos.html)
     def public_media_from_user_contacts(nsid, params = {})
       response = client.public_media_from_user_contacts(nsid, params)
@@ -229,6 +228,7 @@ module Flickrie
     #
     # @param nsid [String]
     # @param params [Hash] Options for this API method (see the link below under "Flickr API method")
+    # @return [Flickrie::Collection<Flickrie::Photo>]
     # @api_method [flickr.photos.getContactsPublicPhotos](http://www.flickr.com/services/api/flickr.photos.getContactsPublicPhotos.html)
     def public_photos_from_user_contacts(nsid, params = {})
       public_media_from_user_contacts(nsid, params).
@@ -239,10 +239,11 @@ module Flickrie
     #
     # @param nsid [String]
     # @param params [Hash] Options for this API method (see the link below under "Flickr API method")
+    # @return [Flickrie::Collection<Flickrie::Video>]
     # @api_method [flickr.photos.getContactsPublicPhotos](http://www.flickr.com/services/api/flickr.photos.getContactsPublicPhotos.html)
     def public_videos_from_user_contacts(nsid, params = {})
       public_media_from_user_contacts(nsid, params).
-        select { |media| media.is_a?(Photo) }
+        select { |media| media.is_a?(Video) }
     end
 
     # Fetches context of the photo/video with the given ID. Example:
@@ -358,6 +359,38 @@ module Flickrie
     alias get_photo_info get_media_info
     alias get_video_info get_media_info
 
+    # Fetches photos and videos from the authenticated user
+    # that are not in any set.
+    #
+    # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
+    # @api_method [flickr.photos.getNotInSet](http://www.flickr.com/services/api/flickr.photos.getNotInSet.html)
+    #
+    # @note This method requires authentication with "read" permissions.
+    def media_not_in_set(params = {})
+      response = client.media_not_in_set(params)
+      Media.from_not_in_set(response.body['photos'])
+    end
+    # Fetches photos from the authenticated user
+    # that are not in any set.
+    #
+    # @return [Flickrie::Collection<Flickrie::Photo>]
+    # @api_method [flickr.photos.getNotInSet](http://www.flickr.com/services/api/flickr.photos.getNotInSet.html)
+    #
+    # @note This method requires authentication with "read" permissions.
+    def photos_not_in_set(params = {})
+      media_not_in_set(params.merge(:media => "photos"))
+    end
+    # Fetches videos from the authenticated user
+    # that are not in any set.
+    #
+    # @return [Flickrie::Collection<Flickrie::Video>]
+    # @api_method [flickr.photos.getNotInSet](http://www.flickr.com/services/api/flickr.photos.getNotInSet.html)
+    #
+    # @note This method requires authentication with "read" permissions.
+    def videos_not_in_set(params = {})
+      media_not_in_set(params.merge(:media => "videos"))
+    end
+
     # Fetches the sizes of the photo with the given ID. Example:
     #
     #     photo = Flickrie.get_photo_sizes(242348)
@@ -370,7 +403,7 @@ module Flickrie
     # @api_method [flickr.photos.getSizes](http://www.flickr.com/services/api/flickr.photos.getSizes.html)
     def get_photo_sizes(photo_id, params = {})
       response = client.get_media_sizes(photo_id, params)
-      Photo.from_sizes(response.body['sizes'])
+      Photo.from_sizes(response.body['sizes'].merge('id' => photo_id.to_s))
     end
     # Fetches the sizes of the video with the given ID. Example:
     #
@@ -382,7 +415,7 @@ module Flickrie
     # @api_method [flickr.photos.getSizes](http://www.flickr.com/services/api/flickr.photos.getSizes.html)
     def get_video_sizes(video_id, params = {})
       response = client.get_media_sizes(video_id, params)
-      Video.from_sizes(response.body['sizes'])
+      Video.from_sizes(response.body['sizes'].merge('id' => video_id.to_s))
     end
 
     # Remove the tag with the given ID
@@ -402,7 +435,7 @@ module Flickrie
     # Fetches photos and videos matching a certain criteria.
     #
     # @param search_params [Hash] Options for searching (see the link below under "Flickr API method")
-    # @return [Array<Flickrie::Photo, Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
     # @api_method [flickr.photos.search](http://www.flickr.com/services/api/flickr.photos.search.html)
     def search_media(search_params = {})
       response = client.search_media(search_params)
@@ -411,7 +444,7 @@ module Flickrie
     # Fetches photos matching a certain criteria.
     #
     # @param search_params [Hash] Options for searching (see the link below under "Flickr API method")
-    # @return [Array<Flickrie::Photo>]
+    # @return [Flickrie::Collection<Flickrie::Photo>]
     # @api_method [flickr.photos.search](http://www.flickr.com/services/api/flickr.photos.search.html)
     def search_photos(search_params = {})
       search_media(search_params.merge(:media => 'photos'))
@@ -419,7 +452,7 @@ module Flickrie
     # Fetches videos matching a certain criteria.
     #
     # @param search_params [Hash] Options for searching (see the link below under "Flickr API method")
-    # @return [Array<Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Video>]
     # @api_method [flickr.photos.search](http://www.flickr.com/services/api/flickr.photos.search.html)
     def search_videos(search_params = {})
       search_media(search_params.merge(:media => 'videos'))
@@ -468,7 +501,7 @@ module Flickrie
     # Fetches sets from a user with the given NSID.
     #
     # @param nsid [String]
-    # @return [Array<Flickrie::Set>]
+    # @return [Flickrie::Collection<Flickrie::Set>]
     # @api_method [flickr.photosets.getList](http://www.flickr.com/services/api/flickr.photosets.getList.html)
     def sets_from_user(nsid, params = {})
       response = client.sets_from_user(nsid, params)
@@ -479,7 +512,7 @@ module Flickrie
     #
     # @param set_id [String]
     # @param params [Hash] Options for this API method (see the link below under "Flickr API method")
-    # @return [Array<Flickrie::Photo, Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
     # @api_method [flickr.photosets.getPhotos](http://www.flickr.com/services/api/flickr.photosets.getPhotos.html)
     def media_from_set(set_id, params = {})
       response = client.media_from_set(set_id, params)
@@ -489,7 +522,7 @@ module Flickrie
     #
     # @param set_id [String]
     # @param params [Hash] Options for this API method (see the link below under "Flickr API method")
-    # @return [Array<Flickrie::Photo>]
+    # @return [Flickrie::Collection<Flickrie::Photo>]
     # @api_method [flickr.photosets.getPhotos](http://www.flickr.com/services/api/flickr.photosets.getPhotos.html)
     def photos_from_set(set_id, params = {})
       media_from_set(set_id, params.merge(:media => 'photos'))
@@ -498,7 +531,7 @@ module Flickrie
     #
     # @param set_id [String]
     # @param params [Hash] Options for this API method (see the link below under "Flickr API method")
-    # @return [Array<Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Video>]
     # @api_method [flickr.photosets.getPhotos](http://www.flickr.com/services/api/flickr.photosets.getPhotos.html)
     def videos_from_set(set_id, params = {})
       media_from_set(set_id, params.merge(:media => 'videos'))

data/lib/flickrie/client.rb

@@ -42,6 +42,10 @@ module Flickrie
         ensure_media({:user_id => nsid}.merge(params))
     end
 
+    def get_upload_status(params = {})
+      get 'flickr.people.getUploadStatus', params
+    end
+
     # photos
     def add_media_tags(media_id, tags, params = {})
       post 'flickr.photos.addTags',
@@ -86,6 +90,10 @@ module Flickrie
         {:photo_id => media_id}.merge(params)
     end
 
+    def media_not_in_set(params = {})
+      get 'flickr.photos.getNotInSet', ensure_media(params)
+    end
+
     def get_media_sizes(media_id, params = {})
       get 'flickr.photos.getSizes',
         {:photo_id => media_id}.merge(params)

data/lib/flickrie/collection.rb

@@ -0,0 +1,39 @@
+if Flickrie.pagination == :will_paginate
+  require 'will_paginate/collection'
+end
+
+module Flickrie
+  # You can think of this as a richer Array. It defines some pagination attributes
+  # (you can evem use it with [will_paginate](https://github.com/mislav/will_paginate),
+  # see {Flickrie.pagination}). It also has the method {#find} which finds by ID
+  # (just like ActiveRecord).
+  class Collection < (defined?(WillPaginate) ? WillPaginate::Collection : Array)
+    attr_reader :current_page, :per_page, :total_entries, :total_pages
+
+    def initialize(params)
+      hash = params[:pagination]
+      if defined?(WillPaginate)
+        @current_page = WillPaginate::PageNumber(Integer(hash['page']))
+      else
+        @current_page = Integer(hash['page'])
+      end
+      @per_page = Integer(hash['per_page'] || hash['perpage'])
+      @total_entries = Integer(hash['total'])
+      @total_pages = Integer(hash['pages'])
+
+      Array.instance_method(:initialize).bind(self).call(params[:array])
+    end
+
+    # Finds an object by ID (just like ActiveRecord does). This is just a
+    # shorthand for
+    #
+    #     find { |object| object.id == id }
+    def find(id = nil)
+      if block_given?
+        super
+      else
+        super() { |object| object.id == id.to_s }
+      end
+    end
+  end
+end

data/lib/flickrie/core_ext.rb

@@ -1,8 +1,4 @@
 class Hash
-  def deep_merge(other_hash)
-    dup.deep_merge!(other_hash)
-  end
-
   def deep_merge!(other_hash)
     other_hash.each_pair do |k,v|
       tv = self[k]
@@ -10,4 +6,17 @@ class Hash
     end
     self
   end
+
+  def deep_merge(other_hash)
+    dup.deep_merge!(other_hash)
+  end
+
+  def except!(*keys)
+    keys.each { |key| delete(key) }
+    self
+  end
+
+  def except(*keys)
+    self.dup.except!(*keys)
+  end
 end

data/lib/flickrie/media/class_methods.rb

@@ -3,14 +3,18 @@ module Flickrie
     # @private
     module ClassMethods
       def from_set(hash)
-        hash['photo'].map do |individual_hash|
+        hash['photo'].map! do |individual_hash|
           individual_hash['owner'] = {
+            'id' => hash['owner'],
             'nsid' => hash['owner'],
             'username' => hash['ownername'],
           }
           fix_extras(individual_hash)
           new(individual_hash)
         end
+
+        Collection.new :array => hash.delete('photo'),
+                       :pagination => hash
       end
 
       def from_info(hash)
@@ -19,8 +23,9 @@ module Flickrie
       end
 
       def from_user(hash)
-        hash['photo'].map do |individual_hash|
+        hash['photo'].map! do |individual_hash|
           individual_hash['owner'] = {
+            'id' => individual_hash['owner'],
             'nsid' => individual_hash.delete('owner'),
             'username' => individual_hash.delete('ownername')
           }
@@ -28,6 +33,9 @@ module Flickrie
           fix_visibility(individual_hash)
           new(individual_hash)
         end
+
+        Collection.new :array => hash.delete('photo'),
+                       :pagination => hash
       end
 
       def from_sizes(hash)
@@ -55,6 +63,10 @@ module Flickrie
           count, previous_photo, next_photo
       end
 
+      def from_not_in_set(hash)
+        from_user(hash)
+      end
+
       def fix_extras(hash)
         if hash['iconserver'] or hash['iconfarm']
           hash['owner'] ||= {}

data/lib/flickrie/media.rb

@@ -18,7 +18,7 @@ module Flickrie
     #   :url, :visibility, :primary?, :favorite?, :can_comment?,
     #   :can_add_meta?, :can_everyone_comment?, :can_everyone_add_meta?,
     #   :can_download?, :can_blog?, :can_print?, :can_share?,
-    #   :has_people?, :faved?, :notes, :favorites, :hash
+    #   :has_people?, :faved?, :notes, :favorites, :hash, :short_url
 
     # @return [String]
     def id()             @hash['id']           end
@@ -100,6 +100,10 @@ module Flickrie
         "http://www.flickr.com" + @hash['url']
       end
     end
+    # @return [String]
+    def short_url
+      "http://flic.kr/p/#{to_base58(id)}" rescue nil
+    end
 
     # @return [Flickrie::Media::Visibility]
     def visibility() Visibility.new(@hash['visibility']) rescue nil end
@@ -181,5 +185,19 @@ module Flickrie
     def initialize(hash = {})
       @hash = hash
     end
+
+    private
+
+    BASE58_ALPHABET = '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ'.chars.to_a.freeze
+
+    def to_base58(id)
+      id = Integer(id)
+      begin
+        id, remainder = id.divmod(58)
+        result = BASE58_ALPHABET[remainder] + (result || '')
+      end while id > 0
+
+      result
+    end
   end
 end

data/lib/flickrie/set.rb

@@ -43,19 +43,19 @@ module Flickrie
 
     # Same as calling `Flickrie.photos_from_set(set.id)`.
     #
-    # @return [Array<Flickrie::Photo>]
+    # @return [Flickrie::Collection<Flickrie::Photo>]
     def photos(params = {})
       Flickrie.photos_from_set(id, params)
     end
     # Same as calling `Flickrie.videos_from_set(set.id)`.
     #
-    # @return [Array<Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Video>]
     def videos(params = {})
       Flickrie.videos_from_set(id, params)
     end
     # Same as calling `Flickrie.media_from_set(set.id)`.
     #
-    # @return [Array<Flickrie::Photo, Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
     def media(params = {})
       Flickrie.media_from_set(id, params)
     end

data/lib/flickrie/user/upload_status.rb

@@ -0,0 +1,54 @@
+module Flickrie
+  class User
+    class UploadStatus
+      # @!parse attr_reader :bandwidth, :maximum_photo_size,
+      #   :maximum_video_size, :videos_uploaded, :videos_remaining,
+      #   :sets_created, :sets_remaining
+
+      # Returns the monthly bandwidth. Example:
+      #
+      #     user.bandwidth.maximum    # => 300
+      #     user.bandwidth.used       # => 120
+      #     user.bandwidth.remaining  # => 180
+      #     user.bandwidth.unlimited? # => false
+      #
+      # All numbers are in megabytes
+      #
+      # @return [Class]
+      def bandwidth
+        bandwidth = Class.new do
+          def maximum()   @hash['maxkb'].to_f / 1024       end
+          def used()      @hash['usedkb'].to_f / 1024      end
+          def remaining() @hash['remainingkb'].to_f / 1024 end
+
+          def unlimited?()  @hash['unlimited'].to_i == 1 end
+
+          def initialize(hash)
+            raise ArgumentError if hash.nil?
+            @hash = hash
+          end
+        end
+
+        bandwidth.new(@hash['bandwidth']) rescue nil
+      end
+
+      # @return [Fixnum] In megabytes
+      def maximum_photo_size() Integer(@hash['filesize']['maxmb'])   rescue nil end
+      # @return [Fixnum] In megabytes
+      def maximum_video_size() Integer(@hash['videosize']['maxmb'])  rescue nil end
+      # @return [Fixnum]
+      def videos_uploaded()    Integer(@hash['videos']['uploaded'])  rescue nil end
+      # @return [Fixnum]
+      def videos_remaining()   Integer(@hash['videos']['remaining']) rescue nil end
+      # @return [Fixnum]
+      def sets_created()       Integer(@hash['sets']['created'])     rescue nil end
+      # @return [Fixnum, String]
+      def sets_remaining()     @hash['sets']['remaining']            rescue nil end
+
+      def initialize(hash)
+        raise ArgumentError if hash.nil?
+        @hash = hash
+      end
+    end
+  end
+end

data/lib/flickrie/user.rb

@@ -1,4 +1,5 @@
 require 'date'
+require 'flickrie/user/upload_status'
 
 module Flickrie
   class User
@@ -6,26 +7,27 @@ module Flickrie
     #   :id, :nsid, :username, :real_name, :location, :description,
     #   :path_alias, :icon_server, :icon_farm, :buddy_icon_url,
     #   :time_zone, :photos_url, :profile_url, :mobile_url,
-    #   :first_taken, :favorited_at, :media_count, :pro?, :hash
+    #   :first_taken, :favorited_at, :media_count, :pro?, :hash,
+    #   :upload_status
 
     # @return [String]
-    def id()           @info['id']          end
+    def id()           @hash['id']          end
     # @return [String]
-    def nsid()         @info['nsid']        end
+    def nsid()         @hash['nsid']        end
     # @return [String]
-    def username()     @info['username']    end
+    def username()     @hash['username']    end
     # @return [String]
-    def real_name()    @info['realname']    end
+    def real_name()    @hash['realname']    end
     # @return [String]
-    def location()     @info['location']    end
+    def location()     @hash['location']    end
     # @return [String]
-    def description()  @info['description'] end
+    def description()  @hash['description'] end
     # @return [String]
-    def path_alias()   @info['path_alias']  end
+    def path_alias()   @hash['path_alias']  end
     # @return [String]
-    def icon_server()  @info['iconserver']  end
+    def icon_server()  @hash['iconserver']  end
     # @return [Fixnum]
-    def icon_farm()    @info['iconfarm']    end
+    def icon_farm()    @hash['iconfarm']    end
 
     # @return [String]
     def buddy_icon_url
@@ -44,110 +46,131 @@ module Flickrie
     #     user.time_zone.label  # => "Sarajevo, Skopje, Warsaw, Zagreb"
     #
     # @return [Struct]
-    def time_zone() Struct.new(:label, :offset).new(*@info['timezone'].values) rescue nil end
+    def time_zone() Struct.new(:label, :offset).new(*@hash['timezone'].values) rescue nil end
 
     # @return [String]
-    def photos_url()  @info['photosurl']  || "http://www.flickr.com/photos/#{nsid || id}" if nsid || id end
+    def photos_url()  @hash['photosurl']  || "http://www.flickr.com/photos/#{nsid || id}" if nsid || id end
     # @return [String]
-    def profile_url() @info['profileurl'] || "http://www.flickr.com/people/#{nsid || id}" if nsid || id end
+    def profile_url() @hash['profileurl'] || "http://www.flickr.com/people/#{nsid || id}" if nsid || id end
     # @return [String]
-    def mobile_url()  @info['mobileurl'] end
+    def mobile_url()  @hash['mobileurl'] end
 
     # @return [Time]
-    def first_taken() DateTime.parse(@info['photos']['firstdatetaken']).to_time rescue nil end
+    def first_taken() DateTime.parse(@hash['photos']['firstdatetaken']).to_time rescue nil end
     # @return [Time]
-    def first_uploaded() Time.at(Integer(@info['photos']['firstdate'])) rescue nil end
+    def first_uploaded() Time.at(Integer(@hash['photos']['firstdate'])) rescue nil end
 
     # @return [Time]
-    def favorited_at() Time.at(Integer(@info['favedate'])) rescue nil end
+    def favorited_at() Time.at(Integer(@hash['favedate'])) rescue nil end
 
     # @return [Fixnum]
-    def media_count() Integer(@info['photos']['count']) rescue nil end
+    def media_count() Integer(@hash['photos']['count']) rescue nil end
     alias photos_count media_count
     alias videos_count media_count
 
     # Same as calling `Flickrie.public_photos_from_user(user.nsid)`.
     #
-    # @return [Array<Flickrie::Photo>]
+    # @return [Flickrie::Collection<Flickrie::Photo>]
     def public_photos(params = {})
       Flickrie.public_photos_from_user(nsid || id, params)
     end
     # Same as calling `Flickrie.public_videos_from_user(user.nsid)`.
     #
-    # @return [Array<Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Video>]
     def public_videos(params = {})
       Flickrie.public_videos_from_user(nsid || id, params)
     end
     # Same as calling `Flickrie.public_media_from_user(user.nsid)`.
     #
-    # @return [Array<Flickrie::Photo, Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
     def public_media(params = {})
       Flickrie.public_media_from_user(nsid || id, params)
     end
 
     # Same as calling `Flickrie.photos_from_user(user.nsid)`.
     #
-    # @return [Array<Flickrie::Photo>]
+    # @return [Flickrie::Collection<Flickrie::Photo>]
     def photos(params = {})
       Flickrie.photos_from_user(nsid || id, params)
     end
     # Same as calling `Flickrie.videos_from_user(user.nsid)`.
     #
-    # @return [Array<Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Video>]
     def videos(params = {})
       Flickrie.videos_from_user(nsid || id, params)
     end
     # Same as calling `Flickrie.media_from_user(user.nsid)`.
     #
-    # @return [Array<Flickrie::Photo, Flickrie::Video>]
+    # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
     def media(params = {})
       Flickrie.media_from_user(nsid || id, params)
     end
 
     # @return [Boolean]
-    def pro?() Integer(@info['ispro']) == 1 rescue nil end
+    def pro?() Integer(@hash['ispro']) == 1 rescue nil end
 
-    def [](key) @info[key] end
+    # Returns the upload status of the user.
+    #
+    # @return [Flickrie::User::UploadStatus]
+    def upload_status() UploadStatus.new(@hash['upload_status']) rescue nil end
+
+    def [](key) @hash[key] end
     # @return [Hash]
-    def hash() @info end
+    def hash() @hash end
 
     # The same as calling `Flickrie.get_user_info(user.nsid)`
     #
     # @return [self]
-    def get_info(params = {}, info = nil)
-      info ||= Flickrie.client.get_user_info(nsid || id, params).body['person']
-      @info.update(info)
-
-      %w[username realname location description profileurl
-         mobileurl photosurl].each do |attribute|
-        @info[attribute] = @info[attribute]['_content']
-      end
-      %w[count firstdatetaken firstdate].each do |photo_attribute|
-        @info['photos'][photo_attribute] = @info['photos'][photo_attribute]['_content']
-      end
+    def get_info(params = {})
+      hash = Flickrie.client.get_user_info(nsid || id, params).body['person']
+      self.class.fix_info(hash)
+      @hash.update(hash)
 
       self
     end
 
     private
 
-    def initialize(info = {})
-      raise ArgumentError if info.nil?
+    def initialize(hash = {})
+      raise ArgumentError if hash.nil?
 
-      @info = info
+      @hash = hash
     end
 
-    def self.from_info(info)
-      new.get_info({}, info)
+    def self.from_info(hash)
+      fix_info(hash)
+      new(hash)
     end
 
-    def self.from_find(info)
-      info['username'] = info['username']['_content']
-      new(info)
+    def self.from_find(hash)
+      hash['username'] = hash['username']['_content']
+      new(hash)
     end
 
-    def self.from_test(info)
-      from_find(info)
+    def self.from_test(hash)
+      from_find(hash)
+    end
+
+    def self.from_upload_status(hash)
+      hash['username'] = hash['username']['_content']
+      hash['upload_status'] = {
+        'bandwidth' => hash.delete('bandwidth'),
+        'filesize' => hash.delete('filesize'),
+        'sets' => hash.delete('sets'),
+        'videosize' => hash.delete('videosize'),
+        'videos' => hash.delete('videos')
+      }
+      new(hash)
+    end
+
+    def self.fix_info(hash)
+      %w[username realname location description profileurl
+         mobileurl photosurl].each do |attribute|
+        hash[attribute] = hash[attribute]['_content']
+      end
+      %w[count firstdatetaken firstdate].each do |photo_attribute|
+        hash['photos'][photo_attribute] = hash['photos'][photo_attribute]['_content']
+      end
     end
   end
 end

data/lib/flickrie/version.rb

@@ -1,3 +1,3 @@
 module Flickrie
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/flickrie.rb

@@ -61,6 +61,30 @@ module Flickrie
     #   [omniauth-flickr](https://github.com/timbreitkreutz/omniauth-flickr) strategy
     attr_accessor :access_token, :access_secret
 
+    # If you're in a web application, and you want pagination with
+    # [will_paginate](https://github.com/mislav/will_paginate), you can specify it here.
+    #
+    #     Flickrie.pagination = :will_paginate
+    #
+    # Now let's assume you have a collection of photos
+    #
+    #     @photos = Flickrie.photos_from_set(2734243, :per_page => 20, :page => params[:page])
+    #
+    # This collection is now paginated. You can now call in your ERB template:
+    #
+    # ```erb
+    # <%= will_paginate @photos %>
+    # ```
+    #
+    # If you're using this, be sure to include the 'will_paginate' gem in your
+    # `Gemfile`.
+    #
+    # {Flickrie::Collection} has some basic pagination attributes by itself,
+    # these are independent of any pagination library.
+    #
+    # @see Flickrie::Collection
+    attr_accessor :pagination
+
     [
       :api_key, :shared_secret, :timeout,
       :open_timeout, :access_token, :access_secret
@@ -153,9 +177,20 @@ module Flickrie
 end
 
 require 'flickrie/api_methods'
+require 'flickrie/core_ext'
 
 module Flickrie
+  autoload :Collection, 'flickrie/collection'
+  autoload :License,    'flickrie/license'
+  autoload :User,       'flickrie/user'
+  autoload :Media,      'flickrie/media'
+  autoload :Photo,      'flickrie/photo'
+  autoload :Video,      'flickrie/video'
+  autoload :Set,        'flickrie/set'
+  autoload :MediaCount, 'flickrie/media_count'
+  autoload :Ticket,     'flickrie/ticket'
+  autoload :Instance,   'flickrie/instance'
+  autoload :OAuth,      'flickrie/oauth'
+
   extend ApiMethods
 end
-
-require 'flickrie/instance'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickrie
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000 Z
+date: 2012-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70097994385000 !ruby/object:Gem::Requirement
+  requirement: &70354735471460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *70097994385000
+  version_requirements: *70354735471460
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70097994381440 !ruby/object:Gem::Requirement
+  requirement: &70354735469600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,10 +38,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *70097994381440
+  version_requirements: *70354735469600
 - !ruby/object:Gem::Dependency
   name: simple_oauth
-  requirement: &70097994393820 !ruby/object:Gem::Requirement
+  requirement: &70354735467340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -49,10 +49,10 @@ dependencies:
         version: '0.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70097994393820
+  version_requirements: *70354735467340
 - !ruby/object:Gem::Dependency
   name: multi_xml
-  requirement: &70097994389540 !ruby/object:Gem::Requirement
+  requirement: &70354735466580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -60,10 +60,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70097994389540
+  version_requirements: *70354735466580
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70097994402680 !ruby/object:Gem::Requirement
+  requirement: &70354740714520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -71,10 +71,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70097994402680
+  version_requirements: *70354740714520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70097994408960 !ruby/object:Gem::Requirement
+  requirement: &70354740713980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -82,10 +82,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70097994408960
+  version_requirements: *70354740713980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70097994407960 !ruby/object:Gem::Requirement
+  requirement: &70354740713460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -96,10 +96,10 @@ dependencies:
         version: '3'
   type: :development
   prerelease: false
-  version_requirements: *70097994407960
+  version_requirements: *70354740713460
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70097994405700 !ruby/object:Gem::Requirement
+  requirement: &70354740712620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -107,7 +107,7 @@ dependencies:
         version: '2.1'
   type: :development
   prerelease: false
-  version_requirements: *70097994405700
+  version_requirements: *70354740712620
 description: This gem wraps the Flickr API with a nice object-oriented interface.
 email: janko.marohnic@gmail.com
 executables: []
@@ -116,6 +116,7 @@ extra_rdoc_files: []
 files:
 - lib/flickrie/api_methods.rb
 - lib/flickrie/client.rb
+- lib/flickrie/collection.rb
 - lib/flickrie/core_ext.rb
 - lib/flickrie/instance.rb
 - lib/flickrie/license.rb
@@ -133,6 +134,7 @@ files:
 - lib/flickrie/set.rb
 - lib/flickrie/ticket.rb
 - lib/flickrie/upload_client.rb
+- lib/flickrie/user/upload_status.rb
 - lib/flickrie/user.rb
 - lib/flickrie/version.rb
 - lib/flickrie/video.rb
@@ -161,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2517221758157184130
+      hash: -4020731564119486214
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11