flickrie 1.0.2 → 1.1.0

data/lib/flickrie/set.rb

@@ -1,74 +1,90 @@
 module Flickrie
   class Set
-    # @!parse attr_reader :id
+    # @!parse attr_reader \
+    #   :id, :secret, :server, :farm, :title, :description,
+    #   :primary_media_id, :views_count, :comments_count,
+    #   :photos_count, :videos_count, :media_count, :owner,
+    #   :can_comment?, :needs_interstitial?, :visibility_can_see_set?,
+    #   :created_at, :updated_at, :url, :hash
+
+    # @return [String]
     def id()          @info['id']          end
-    # @!parse attr_reader :secret
+    # @return [String]
     def secret()      @info['secret']      end
-    # @!parse attr_reader :server
+    # @return [String]
     def server()      @info['server']      end
-    # @!parse attr_reader :farm
+    # @return [Fixnum]
     def farm()        @info['farm']        end
-    # @!parse attr_reader :title
+    # @return [String]
     def title()       @info['title']       end
-    # @!parse attr_reader :description
+    # @return [String]
     def description() @info['description'] end
 
-    # @!parse attr_reader :primary_media_id
+    # @return [String]
     def primary_media_id() @info['primary'] end
     alias primary_photo_id primary_media_id
     alias primary_video_id primary_media_id
 
-    # @!parse attr_reader :views_count
+    # @return [Fixnum]
     def views_count()    Integer(@info['count_views'])    rescue nil end
-    # @!parse attr_reader :comments_count
+    # @return [Fixnum]
     def comments_count() Integer(@info['count_comments']) rescue nil end
-    # @!parse attr_reader :photos_count
+    # @return [Fixnum]
     def photos_count()   Integer(@info['count_photos'])   rescue nil end
-    # @!parse attr_reader :videos_count
+    # @return [Fixnum]
     def videos_count()   Integer(@info['count_videos'])   rescue nil end
-    # @!parse attr_reader :media_count
+    # @return [Fixnum]
     def media_count
       photos_count + videos_count rescue nil
     end
 
     # @return [Flickrie::User]
-    #
-    # @!parse attr_reader :owner
     def owner() User.new('nsid' => @info['owner']) if @info['owner'] end
 
     # Same as calling `Flickrie.photos_from_set(set.id)`.
-    def photos(params = {}) Flickrie.photos_from_set(id, params) end
+    #
+    # @return [Array<Flickrie::Photo>]
+    def photos(params = {})
+      Flickrie.photos_from_set(id, params)
+    end
     # Same as calling `Flickrie.videos_from_set(set.id)`.
-    def videos(params = {}) Flickrie.videos_from_set(id, params) end
+    #
+    # @return [Array<Flickrie::Video>]
+    def videos(params = {})
+      Flickrie.videos_from_set(id, params)
+    end
     # Same as calling `Flickrie.media_from_set(set.id)`.
-    def media(params = {})  Flickrie.media_from_set(id, params)  end
+    #
+    # @return [Array<Flickrie::Photo, Flickrie::Video>]
+    def media(params = {})
+      Flickrie.media_from_set(id, params)
+    end
 
-    # @!parse attr_reader :can_comment?
+    # @return [Boolean]
     def can_comment?() Integer(@info['can_comment']) == 1 rescue nil end
 
-    # @comment TODO: Figure out what this is
-    # @!parse attr_reader :needs_interstitial?
+    # @return [Boolean]
     def needs_interstitial?() Integer(@info['needs_interstitial']) == 1 rescue nil end
-    # @!parse attr_reader :visibility_can_see_set?
+    # @return [Boolean]
     def visibility_can_see_set?() Integer(@info['visibility_can_see_set']) == 1 rescue nil end
 
-    # @!parse attr_reader :created_at
+    # @return [Time]
     def created_at() Time.at(Integer(@info['date_create'])) rescue nil end
-    # @!parse attr_reader :updated_at
+    # @return [Time]
     def updated_at() Time.at(Integer(@info['date_update'])) rescue nil end
 
-    # @!parse attr_reader :url
-    def url
-      "http://www.flickr.com/photos/#{owner.nsid}/sets/#{id}"
-    end
+    # @return [String]
+    def url() "http://www.flickr.com/photos/#{owner.nsid}/sets/#{id}" rescue nil end
 
     def [](key) @info[key] end
-    # @!parse attr_reader :hash
+    # @return [Hash]
     def hash() @info end
 
     # Same as calling `Flickrie.get_set_info(set.id)`
-    def get_info(info = nil)
-      info ||= Flickrie.client.get_set_info(id).body['photoset']
+    #
+    # @return [self]
+    def get_info(params = {}, info = nil)
+      info ||= Flickrie.client.get_set_info(id, params).body['photoset']
       @info.update(info)
 
       # Fixes
@@ -85,7 +101,7 @@ module Flickrie
     end
 
     def self.from_info(info)
-      new.get_info(info)
+      new.get_info({}, info)
     end
 
     def self.from_user(info, user_nsid)

data/lib/flickrie/ticket.rb

@@ -1,20 +1,23 @@
 module Flickrie
   class Ticket
-    # @!parse attr_reader :id
+    # @!parse attr_reader \
+    #   :id, :media_id, :complete?, :imported_at, :hash
+
+    # @return [String]
     def id()       @info['id']      end
-    # @!parse attr_reader :media_id
+    # @return [String]
     def media_id() @info['photoid'] end
     alias photo_id media_id
     alias video_id media_id
 
-    # @!parse attr_reader :complete?
+    # @return [Boolean]
     def complete?() Integer(@info['complete']) == 1 rescue nil end
 
-    # @!parse attr_reader :imported_at
+    # @return [Time]
     def imported_at() Time.at(Integer(@info['imported'])) rescue nil end
 
     def [](key) @info[key] end
-    # @!parse attr_reader :hash
+    # @return [Hash]
     def hash() @info end
 
     private

data/lib/flickrie/user.rb

@@ -2,26 +2,32 @@ require 'date'
 
 module Flickrie
   class User
-    # @!parse attr_reader :id
+    # @!parse attr_reader \
+    #   :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
+
+    # @return [String]
     def id()           @info['id']          end
-    # @!parse attr_reader :nsid
+    # @return [String]
     def nsid()         @info['nsid']        end
-    # @!parse attr_reader :username
+    # @return [String]
     def username()     @info['username']    end
-    # @!parse attr_reader :real_name
+    # @return [String]
     def real_name()    @info['realname']    end
-    # @!parse attr_reader :location
+    # @return [String]
     def location()     @info['location']    end
-    # @!parse attr_reader :description
+    # @return [String]
     def description()  @info['description'] end
-    # @!parse attr_reader :path_alias
+    # @return [String]
     def path_alias()   @info['path_alias']  end
-    # @!parse attr_reader :icon_server
+    # @return [String]
     def icon_server()  @info['iconserver']  end
-    # @!parse attr_reader :icon_farm
+    # @return [Fixnum]
     def icon_farm()    @info['iconfarm']    end
 
-    # @!parse attr_reader :buddy_icon_url
+    # @return [String]
     def buddy_icon_url
       if icon_farm
         if icon_server.to_i > 0 && (nsid || id)
@@ -37,41 +43,77 @@ module Flickrie
     #     user.time_zone.offset # => "+01:00"
     #     user.time_zone.label  # => "Sarajevo, Skopje, Warsaw, Zagreb"
     #
-    # @!parse attr_reader :time_zone
+    # @return [Struct]
     def time_zone() Struct.new(:label, :offset).new(*@info['timezone'].values) rescue nil end
 
-    # @!parse attr_reader :photos_url
-    def photos_url()  @info['photosurl']  || "http://www.flickr.com/photos/#{nsid || id}" end
-    # @!parse attr_reader :profile_url
-    def profile_url() @info['profileurl'] || "http://www.flickr.com/people/#{nsid || id}" end
-    # @!parse attr_reader :mobile_url
+    # @return [String]
+    def photos_url()  @info['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
+    # @return [String]
     def mobile_url()  @info['mobileurl'] end
 
-    # @!parse attr_reader :first_taken
+    # @return [Time]
     def first_taken() DateTime.parse(@info['photos']['firstdatetaken']).to_time rescue nil end
-    # @!parse attr_reader :first_uploaded
+    # @return [Time]
     def first_uploaded() Time.at(Integer(@info['photos']['firstdate'])) rescue nil end
 
-    # @!parse attr_reader :favorited_at
+    # @return [Time]
     def favorited_at() Time.at(Integer(@info['favedate'])) rescue nil end
 
-    # @!parse attr_reader :media_count
+    # @return [Fixnum]
     def media_count() Integer(@info['photos']['count']) rescue nil end
     alias photos_count media_count
     alias videos_count media_count
 
-    # @comment TODO: public videos, media and without public
-    # The same as calling `Flickrie.public_photos_from_user(user.nsid)`
-    def public_photos(params = {}) Flickrie.public_photos_from_user(nsid || id, params) end
+    # Same as calling `Flickrie.public_photos_from_user(user.nsid)`.
+    #
+    # @return [Array<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>]
+    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>]
+    def public_media(params = {})
+      Flickrie.public_media_from_user(nsid || id, params)
+    end
 
-    # @!parse attr_reader :pro?
+    # Same as calling `Flickrie.photos_from_user(user.nsid)`.
+    #
+    # @return [Array<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>]
+    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>]
+    def media(params = {})
+      Flickrie.media_from_user(nsid || id, params)
+    end
+
+    # @return [Boolean]
     def pro?() Integer(@info['ispro']) == 1 rescue nil end
 
     def [](key) @info[key] end
-    # @!parse attr_reader :hash
+    # @return [Hash]
     def hash() @info 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)

data/lib/flickrie/version.rb

@@ -1,3 +1,3 @@
 module Flickrie
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/flickrie/video.rb

@@ -1,30 +1,36 @@
 module Flickrie
   class Video
     include Media
+    # @!parse attr_reader \
+    #   :ready?, :failed?, :pending?, :duration, :width, :height,
+    #   :source_url, :download_url, :mobile_download_url
 
-    # @!parse attr_reader :ready?
+    # @return [Boolean]
     def ready?()   Integer(@video['ready']) == 1   rescue nil end
-    # @!parse attr_reader :failed?
+    # @return [Boolean]
     def failed?()  Integer(@video['failed']) == 1  rescue nil end
-    # @!parse attr_reader :pending?
+    # @return [Boolean]
     def pending?() Integer(@video['pending']) == 1 rescue nil end
 
-    # @!parse attr_reader :duration
+    # @return [Fixnum]
     def duration() Integer(@video['duration']) rescue nil end
 
-    # @!parse attr_reader :width
+    # @return [Fixnum]
     def width()  Integer(@video['width'])  rescue nil end
-    # @!parse attr_reader :height
+    # @return [Fixnum]
     def height() Integer(@video['height']) rescue nil end
 
-    # @!parse attr_reader :source_url
+    # @return [String]
     def source_url()          @video['source_url']          end
-    # @!parse attr_reader :download_url
+    # @return [String]
     def download_url()        @video['download_url']        end
-    # @!parse attr_reader :mobile_download_url
+    # @return [String]
     def mobile_download_url() @video['mobile_download_url'] end
 
-    # This fetches the {#source\_url}, {#download\_url} and the {#mobile\_download\_url}
+    # This fetches the {#source\_url}, {#download\_url} and the {#mobile\_download\_url}.
+    # Same as calling `Flickrie.get_video_sizes(video.id)`
+    #
+    # @return [self]
     def get_sizes(params = {}, info = nil)
       info ||= Flickrie.client.get_media_sizes(id, params).body['sizes']
       @info['usage'] ||= {}
@@ -44,6 +50,8 @@ module Flickrie
     end
 
     # Same as calling `Flickrie.get_video_info(video.id)`.
+    #
+    # @return [self]
     def get_info(params = {}, info = nil)
       super
       @video = @info['video']
@@ -55,7 +63,7 @@ module Flickrie
 
     def initialize(info = {})
       super
-      @video = {}
+      @video = info['video'] || {}
     end
   end
 end

data/spec/custom_matchers.rb

@@ -0,0 +1,51 @@
+RSpec::Matchers.define :correspond_to do |hash_or_value|
+  match { |object| test_recursively(object, hash_or_value) }
+
+  def test_recursively(object, hash_or_value)
+    if hash_or_value.is_a?(Hash)
+      iterate(object, hash_or_value) do |actual, expected|
+        actual.should == expected
+      end
+    else
+      object.should eq(hash_or_value)
+    end
+  end
+
+  def iterate(object, the_rest, &block)
+    the_rest.each do |key, value|
+      if value.is_a?(Hash)
+        iterate(object.send(key), value, &block)
+      else
+        yield [object.send(key), value]
+      end
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "expected: #{expected.first}\n got: #{actual}\n"
+  end
+end
+
+RSpec::Matchers.define :be_a_number do
+  match { |object| object.instance_of?(Fixnum) }
+end
+
+RSpec::Matchers.define :be_a_boolean do
+  match { |object| object == true or object == false }
+end
+
+RSpec::Matchers.define :be_a_media do
+  match do |object|
+    object.instance_of?(Flickrie::Photo) \
+      or
+    object.instance_of?(Flickrie::Video)
+  end
+end
+
+RSpec::Matchers.define :be_a_photo do
+  match { |object| object.instance_of?(Flickrie::Photo) }
+end
+
+RSpec::Matchers.define :be_a_video do
+  match { |object| object.instance_of?(Flickrie::Video) }
+end

data/spec/flickrie/api_methods_spec.rb

@@ -1,43 +1,124 @@
 require 'spec_helper'
 
 describe Flickrie::ApiMethods do
-  it "should upload and delete correctly", :vcr, :cassette => "upload and delete" do
-    media_id = Flickrie.upload(PHOTO_PATH)
-    Flickrie.public_media_from_user(USER_NSID).map(&:id).should include(media_id)
-    Flickrie.delete_media(media_id)
-    Flickrie.public_media_from_user(USER_NSID).map(&:id).should_not include(media_id)
+  context "upload" do
+    it "should upload", :vcr do
+      photo_id = Flickrie.upload(PHOTO_PATH)
+      expect { Flickrie.delete_photo(photo_id) }.to_not raise_error
+    end
+
+    it "should upload asynchronously", :vcr do
+      ticket_id = Flickrie.upload(PHOTO_PATH, :async => 1)
+      ticket = Flickrie.check_upload_tickets(ticket_id).first
+      until ticket.complete?
+        ticket = Flickrie.check_upload_tickets(ticket_id).first
+      end
+      expect { Flickrie.delete_photo(ticket.photo_id) }.to_not raise_error
+    end
+
+    it "should replace", :vcr do
+      begin
+        photo_id = Flickrie.upload(PHOTO_PATH)
+        Flickrie.replace(PHOTO_PATH, photo_id)
+      rescue => error
+        error.message.should == "Not a pro account"
+      ensure
+        Flickrie.delete_photo(photo_id)
+      end
+    end
   end
 
-  it "should upload asynchronously correctly", :vcr, :cassette => "asynchronous upload" do
-    ticket_id = Flickrie.upload(PHOTO_PATH, :async => 1)
-    begin
-      ticket = Flickrie.check_upload_tickets([ticket_id]).first
-    end until ticket.complete?
-    photo_id = ticket.photo_id
-    Flickrie.get_photo_info(photo_id).id.should eq(photo_id)
-    Flickrie.delete_photo(photo_id)
+  context "people" do
+    it "should get media from user", :vcr do
+      Flickrie.media_from_user(USER_NSID).first.id.should_not be_nil
+      Flickrie.photos_from_user(USER_NSID).first.id.should_not be_nil
+      Flickrie.videos_from_user(USER_NSID).first.id.should_not be_nil
+    end
+
+    it "should get public media from user", :vcr do
+      Flickrie.public_media_from_user(USER_NSID).first.id.should_not be_nil
+      Flickrie.public_photos_from_user(USER_NSID).first.id.should_not be_nil
+      Flickrie.public_videos_from_user(USER_NSID).first.id.should_not be_nil
+    end
   end
 
-  it "should replace correctly", :vcr, :cassette => "replace" do
-    begin
-      id = Flickrie.upload(PHOTO_PATH)
-      Flickrie.replace(PHOTO_PATH, id)
-    rescue => exception
-      exception.code.should eq(1) # Not a pro account
-    ensure
-      Flickrie.delete_media(id)
+  # Here I test the media/photo/video aliases of the API methods (because I don't test them elsewhere)
+  context "photos" do
+    it "should add and remove tags", :vcr do
+      %w[media photo video].each do |word|
+        id = eval "#{word.upcase}_ID"
+        media = Flickrie.send("get_#{word}_info", id)
+        tags_before_change = media.tags.join(' ')
+        Flickrie.send("add_#{word}_tags", id, "janko")
+        media.get_info
+        media.tags.join(' ').should eq([tags_before_change, "janko"].join(' '))
+        tag_id = media.tags.find { |tag| tag.content == "janko" }.id
+        Flickrie.send("remove_#{word}_tag", tag_id)
+        media.get_info
+        media.tags.join(' ').should eq(tags_before_change)
+      end
+    end
+
+    it "should get from contacts", :vcr do
+      params = {:include_self => 1, :single_photo => 1}
+      Flickrie.media_from_contacts(params).first.id.should_not be_nil
+      Flickrie.photos_from_contacts(params).first.id.should_not be_nil
+      # Flickrie.videos_from_contacts(params).first.id.should_not be_nil
+    end
+
+    it "should get public from user contacts", :vcr do
+      params = {:include_self => 1, :single_photo => 1}
+      Flickrie.public_media_from_user_contacts(USER_NSID, params).first.id.should_not be_nil
+      Flickrie.public_photos_from_user_contacts(USER_NSID, params).first.id.should_not be_nil
+      # Flickrie.public_videos_from_user_contacts(USER_NSID, params).each { |object| object.should be_a_video }
+    end
+
+    it "should get context", :vcr do
+      Flickrie.get_media_context(MEDIA_ID).count.should_not be_nil
+      Flickrie.get_photo_context(PHOTO_ID).count.should_not be_nil
+      Flickrie.get_photo_context(VIDEO_ID).count.should_not be_nil
+    end
+
+    it "should get counts", :vcr do
+      dates = [DateTime.parse("19th May 2009"), DateTime.parse("19th May 2012")]
+      Flickrie.get_media_counts(:taken_dates => dates.join(',')).first.value.should_not be_nil
+      Flickrie.get_photos_counts(:taken_dates => dates.join(',')).first.value.should_not be_nil
+      Flickrie.get_videos_counts(:taken_dates => dates.join(',')).first.value.should_not be_nil
+    end
+
+    it "should get exif", :vcr do
+      Flickrie.get_photo_exif(PHOTO_ID).exif.should_not be_nil
+      Flickrie.get_video_exif(VIDEO_ID).exif.should_not be_nil
+    end
+
+    it "should get favorites", :vcr do
+      Flickrie.get_photo_favorites(PHOTO_ID).favorites.should_not be_nil
+      Flickrie.get_video_favorites(PHOTO_ID).favorites.should_not be_nil
+    end
+
+    it "should get info", :vcr do
+      Flickrie.get_media_info(MEDIA_ID).id.should_not be_nil
+      Flickrie.get_photo_info(PHOTO_ID).id.should_not be_nil
+      Flickrie.get_video_info(VIDEO_ID).id.should_not be_nil
+    end
+
+    it "should get sizes", :vcr do
+      Flickrie.get_photo_sizes(PHOTO_ID).size.should_not be_nil
+      Flickrie.get_video_sizes(VIDEO_ID).download_url.should_not be_nil
+    end
+
+    it "should search", :vcr do
+      Flickrie.search_media(:user_id => USER_NSID).first.id.should_not be_nil
+      Flickrie.search_photos(:user_id => USER_NSID).first.id.should_not be_nil
+      Flickrie.search_videos(:user_id => USER_NSID).first.id.should_not be_nil
     end
   end
 
-  it "should manipulate tags correctly", :vcr, :cassette => "tag manipulation" do
-    media = Flickrie.get_media_info(PHOTO_ID)
-    tags_before_change = media.tags.join(' ')
-    Flickrie.add_media_tags(PHOTO_ID, "janko")
-    media.get_info
-    media.tags.join(' ').should eq([tags_before_change, "janko"].join(' '))
-    tag_id = media.tags.find { |tag| tag.content == "janko" }.id
-    Flickrie.remove_media_tag(tag_id)
-    media.get_info
-    media.tags.join(' ').should eq(tags_before_change)
+  context "photosets" do
+    it "should get media", :vcr do
+      Flickrie.media_from_set(SET_ID).first.id.should_not be_nil
+      Flickrie.photos_from_set(SET_ID).first.id.should_not be_nil
+      Flickrie.videos_from_set(SET_ID).first.id.should_not be_nil
+    end
   end
 end

data/spec/flickrie/error_spec.rb

@@ -1,17 +1,15 @@
 require 'spec_helper'
 
 describe Flickrie::Error do
-  before(:all) do
-    Flickrie.api_key = nil
-  end
-
   context "a request was made and failed" do
     it "should be raised", :vcr do
+      Flickrie.api_key = nil
       expect { Flickrie.get_licenses }.to raise_error(described_class)
       expect { Flickrie.upload(PHOTO_PATH) }.to raise_error(described_class)
     end
 
     it "should have #code attribute present", :vcr do
+      Flickrie.api_key = nil
       begin
         Flickrie.get_licenses
       rescue => exception

data/spec/flickrie/instance_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
 
 describe Flickrie::Instance do
-  it "should be able to call API methods", :vcr, :cassette => "calling api methods" do
-    # this is to see if the client and upload_client were reset
-    Flickrie.get_photo_info(PHOTO_ID)
-    id = Flickrie.upload(PHOTO_PATH)
-    Flickrie.delete_photo(id)
-    Flickrie.access_token = Flickrie.access_secret = nil
+  context "client is already initialized" do
+    it "should be able to call API methods", :vcr do
+      # this is to see if the client and upload_client were reset
+      Flickrie.get_photo_info(PHOTO_ID)
+      id = Flickrie.upload(PHOTO_PATH)
+      Flickrie.delete_photo(id)
+      Flickrie.access_token = Flickrie.access_secret = nil
 
-    instance = Flickrie::Instance.new(ENV['FLICKR_ACCESS_TOKEN'], ENV['FLICKR_ACCESS_SECRET'])
-    user = instance.test_login
-    user.username.should eq(USER_USERNAME)
-    id = instance.upload(PHOTO_PATH)
-    instance.delete_photo(id)
+      instance = Flickrie::Instance.new(ENV['FLICKR_ACCESS_TOKEN'], ENV['FLICKR_ACCESS_SECRET'])
+      user = instance.test_login
+      user.username.should eq(USER_USERNAME)
+    end
   end
 end