flickrie 0.6.1 → 0.7.0

data/lib/flickrie/photo.rb

@@ -6,8 +6,8 @@ module Flickrie
 
     SIZES = {
       'Square 75'  => 'sq',
-      'Square 150' => 'q',
       'Thumbnail'  => 't',
+      'Square 150' => 'q',
       'Small 240'  => 's',
       'Small 320'  => 'n',
       'Medium 500' => 'm',
@@ -17,68 +17,70 @@ module Flickrie
       'Original'   => 'o'
     }
 
-    def square!(number); @size = "Square #{number}"; self end
-    def thumbnail!;      @size = "Thumbnail";        self end
-    def small!(number);  @size = "Small #{number}";  self end
-    def medium!(number); @size = "Medium #{number}"; self end
-    def large!(number);  @size = "Large #{number}";  self end
-    def original!;       @size = "Original";         self end
-
-    def square(number); dup.square!(number) end
-    def thumbnail;      dup.thumbnail!      end
-    def small(number);  dup.small!(number)  end
-    def medium(number); dup.medium!(number) end
-    def large(number);  dup.large!(number)  end
-    def original;       dup.original!       end
-
-    [75, 150].each do |n|
-      define_method("square#{n}!") { square!(n) }
-      define_method("square#{n}") { square(n) }
-    end
-    [240, 320].each do |n|
-      define_method("small#{n}!") { small!(n) }
-      define_method("small#{n}") { small(n) }
-    end
-    [500, 640, 800].each do |n|
-      define_method("medium#{n}!") { medium!(n) }
-      define_method("medium#{n}") { medium(n) }
-    end
-    [1024].each do |n|
-      define_method("large#{n}!") { large!(n) }
-      define_method("large#{n}") { large(n) }
-    end
-
-    def largest!; @size = largest_size; self end
-    def largest;  dup.largest! end
+    def square!(number) @size = "Square #{number}"; self end
+    def thumbnail!()    @size = "Thumbnail";        self end
+    def small!(number)  @size = "Small #{number}";  self end
+    def medium!(number) @size = "Medium #{number}"; self end
+    def large!(number)  @size = "Large #{number}";  self end
+    def original!()     @size = "Original";         self end
+
+    def square(number) dup.square!(number) end
+    def thumbnail()    dup.thumbnail!      end
+    def small(number)  dup.small!(number)  end
+    def medium(number) dup.medium!(number) end
+    def large(number)  dup.large!(number)  end
+    def original()     dup.original!       end
+
+    #--
+    # Alternate size methods
+    def square75()   square(75)   end
+    def square75!()  square!(75)  end
+    def square150()  square(150)  end
+    def square150!() square!(150) end
+    def small240()   small(240)   end
+    def small240!()  small!(240)  end
+    def small320()   small(320)   end
+    def small320!()  small!(320)  end
+    def medium500()  medium(500)  end
+    def medium500!() medium!(500) end
+    def medium640()  medium(640)  end
+    def medium640!() medium!(640) end
+    def medium800()  medium(800)  end
+    def medium800!() medium!(800) end
+    def large1024()  large(1024)  end
+    def large1024!() large!(1024) end
+
+    def largest!() @size = largest_size; self end
+    def largest()  dup.largest! end
 
     def available_sizes
-      SIZES.select { |_, s| @info["url_#{s}"] }.keys
+      SIZES.select { |_,v| @info["url_#{v}"] }.keys
     end
 
-    def width;      @info["width_#{size_abbr}"].to_i if @info["width_#{size_abbr}"]   end
-    def height;     @info["height_#{size_abbr}"].to_i if @info["height_#{size_abbr}"] end
-
-    def source_url; @info["url_#{size_abbr}"] end
+    def width()  Integer(@info["width_#{size_abbr}"])  rescue nil end
+    def height() Integer(@info["height_#{size_abbr}"]) rescue nil end
+    def source_url() @info["url_#{size_abbr}"] end
 
-    def rotation; @info['rotation'].to_i if @info['rotation'] end
+    def rotation() Integer(@info['rotation']) rescue nil end
 
-    def get_sizes(info = nil)
-      info ||= Flickrie.client.get_media_sizes(id).body['sizes']
+    def get_sizes(params = {}, info = nil)
+      info ||= Flickrie.client.get_media_sizes(id, params).body['sizes']
+      @info['usage'] ||= {}
       @info['usage'].update \
         'canblog'     => info['canblog'],
         'canprint'    => info['canprint'],
         'candownload' => info['candownload']
       flickr_sizes = {
-        'Square' => 'sq',
-        'Large Square' => 'q',
-        'Thumbnail' => 't',
-        'Small' => 's',
-        'Small 320' => 'n',
-        'Medium' => 'm',
-        'Medium 640' => 'z',
-        'Medium 800' => 'c',
-        'Large' => 'l',
-        'Original' => 'o'
+        'Square'       => SIZES['Square 75'],
+        'Large Square' => SIZES['Square 150'],
+        'Thumbnail'    => SIZES['Thumbnail'],
+        'Small'        => SIZES['Small 240'],
+        'Small 320'    => SIZES['Small 320'],
+        'Medium'       => SIZES['Medium 500'],
+        'Medium 640'   => SIZES['Medium 640'],
+        'Medium 800'   => SIZES['Medium 800'],
+        'Large'        => SIZES['Large 1024'],
+        'Original'     => SIZES['Original']
       }
       info['size'].each do |size_info|
         size_abbr = flickr_sizes[size_info['label']]
@@ -87,8 +89,7 @@ module Flickrie
         @info["url_#{size_abbr}"] = size_info['source']
       end
 
-      @size = largest_size
-      self
+      largest!
     end
 
     private

data/lib/flickrie/set.rb

@@ -1,39 +1,43 @@
 module Flickrie
   class Set
-    def id;          @info['id']          end
-    def secret;      @info['secret']      end
-    def server;      @info['server']      end
-    def farm;        @info['farm']        end
-    def title;       @info['title']       end
-    def description; @info['description'] end
-
-    def primary_media_id; @info['primary'] end
+    def id()          @info['id']          end
+    def secret()      @info['secret']      end
+    def server()      @info['server']      end
+    def farm()        @info['farm']        end
+    def title()       @info['title']       end
+    def description() @info['description'] end
+
+    def primary_media_id() @info['primary'] end
     alias primary_photo_id primary_media_id
     alias primary_video_id primary_media_id
 
-    def views_count; @info['count_views'].to_i if @info['count_views'] end
-    def comments_count; @info['count_comments'].to_i if @info['count_comments'] end
-    def photos_count; @info['count_photos'].to_i if @info['count_photos'] end
-    def videos_count; @info['count_videos'].to_i if @info['count_videos'] end
-    def media_count; photos_count + videos_count rescue nil end
+    def views_count()    Integer(@info['count_views'])    rescue nil end
+    def comments_count() Integer(@info['count_comments']) rescue nil end
+    def photos_count()   Integer(@info['count_photos'])   rescue nil end
+    def videos_count()   Integer(@info['count_videos'])   rescue nil end
+    def media_count
+      photos_count + videos_count rescue nil
+    end
 
-    def owner; User.new('nsid' => @info['owner']) if @info['owner'] end
+    def owner() User.new('nsid' => @info['owner']) if @info['owner'] end
 
-    def photos(params = {}); Flickrie.photos_from_set(id, params) end
-    def videos(params = {}); Flickrie.videos_from_set(id, params) end
-    def media(params = {});  Flickrie.media_from_set(id, params)  end
+    def photos(params = {}) Flickrie.photos_from_set(id, params) end
+    def videos(params = {}) Flickrie.videos_from_set(id, params) end
+    def media(params = {})  Flickrie.media_from_set(id, params)  end
 
-    def can_comment?; @info['can_comment'].to_i == 1 if @info['can_comment'] end
+    def can_comment?() Integer(@info['can_comment']) == 1 rescue nil end
 
     #--
     # TODO: Figure out what this is
-    def needs_interstitial?; @info['needs_interstitial'].to_i == 1 end
-    def visibility_can_see_set?; @info['visibility_can_see_set'].to_i == 1 end
+    def needs_interstitial?() Integer(@info['needs_interstitial']) == 1 rescue nil end
+    def visibility_can_see_set?() Integer(@info['visibility_can_see_set']) == 1 rescue nil end
 
-    def created_at; Time.at(@info['date_create'].to_i) end
-    def updated_at; Time.at(@info['date_update'].to_i) end
+    def created_at() Time.at(Integer(@info['date_create'])) rescue nil end
+    def updated_at() Time.at(Integer(@info['date_update'])) rescue nil end
 
-    def url; "http://www.flickr.com/photos/#{owner.nsid}/sets/#{id}" end
+    def url
+      "http://www.flickr.com/photos/#{owner.nsid}/sets/#{id}"
+    end
 
     def [](key)
       @info[key]
@@ -41,10 +45,12 @@ module Flickrie
 
     def get_info(info = nil)
       info ||= Flickrie.client.get_set_info(id).body['photoset']
-      info['title'] = info['title']['_content']
-      info['description'] = info['description']['_content']
       @info.update(info)
 
+      # Fixes
+      @info['title'] = @info['title']['_content']
+      @info['description'] = @info['description']['_content']
+
       self
     end
 

data/lib/flickrie/ticket.rb

@@ -1,17 +1,13 @@
 module Flickrie
   class Ticket
-    def id; @info['id'] end
-    def media_id; @info['photoid'] end
+    def id()       @info['id']      end
+    def media_id() @info['photoid'] end
     alias photo_id media_id
     alias video_id media_id
 
-    def complete?
-      @info['complete'].to_i == 1
-    end
+    def complete?() Integer(@info['complete']) == 1 rescue nil end
 
-    def imported_at
-      Time.at(@info['imported'].to_i)
-    end
+    def imported_at() Time.at(Integer(@info['imported'])) rescue nil end
 
     def [](key)
       @info[key]

data/lib/flickrie/upload_client.rb

@@ -1,7 +1,11 @@
 module Flickrie
   class << self
-    def upload_client(access_token_hash = {})
-      @upload_client ||= UploadClient.new(upload_params) do |conn|
+    def upload_client
+      @upload_client ||= new_upload_client
+    end
+
+    def new_upload_client(access_token_hash = {})
+      UploadClient.new(upload_params) do |conn|
         conn.use FaradayMiddleware::OAuth,
           :consumer_key => api_key,
           :consumer_secret => shared_secret,
@@ -11,6 +15,7 @@ module Flickrie
 
         conn.use UploadStatusCheck
         conn.use FaradayMiddleware::ParseXml
+        conn.use OAuthStatusCheck
 
         conn.adapter Faraday.default_adapter
       end

data/lib/flickrie/user.rb

@@ -2,19 +2,19 @@ require 'date'
 
 module Flickrie
   class User
-    def id;           @info['id']          end
-    def nsid;         @info['nsid']        end
-    def username;     @info['username']    end
-    def real_name;    @info['realname']    end
-    def location;     @info['location']    end
-    def time_zone;    @info['timezone']    end
-    def description;  @info['description'] end
-    def profile_url;  @info['profileurl']  end
-    def mobile_url;   @info['mobileurl']   end
-    def photos_url;   @info['photosurl']   end
-    def path_alias;   @info['path_alias']  end
-    def icon_server;  @info['iconserver']  end
-    def icon_farm;    @info['iconfarm']    end
+    def id()           @info['id']          end
+    def nsid()         @info['nsid']        end
+    def username()     @info['username']    end
+    def real_name()    @info['realname']    end
+    def location()     @info['location']    end
+    def time_zone()    @info['timezone']    end
+    def description()  @info['description'] end
+    def profile_url()  @info['profileurl']  end
+    def mobile_url()   @info['mobileurl']   end
+    def photos_url()   @info['photosurl']   end
+    def path_alias()   @info['path_alias']  end
+    def icon_server()  @info['iconserver']  end
+    def icon_farm()    @info['iconfarm']    end
 
     def buddy_icon_url
       if icon_farm
@@ -26,36 +26,29 @@ module Flickrie
       end
     end
 
-    def first_taken
-      if @info['photos'] and @info['photos']['firstdatetaken']
-        DateTime.parse(@info['photos']['firstdatetaken']).to_time
-      end
-    end
+    def first_taken() DateTime.parse(@info['photos']['firstdatetaken']).to_time rescue nil end
+    def first_uploaded() Time.at(Integer(@info['photos']['firstdate'])) rescue nil end
 
-    def first_uploaded
-      if @info['photos'] and @info['photos']['firstdate']
-        Time.at(@info['photos']['firstdate'].to_i)
-      end
-    end
+    def favorited_at() Time.at(Integer(@info['favedate'])) rescue nil end
 
-    def media_count
-      if @info['photos'] and @info['photos']['count']
-        @info['photos']['count'].to_i
-      end
+    def favorited_at
+      Time.at(@info['favedate'].to_i)
     end
 
-    def public_photos; Flickrie.public_photos_from_user(nsid) end
+    def media_count() Integer(@info['photos']['count']) rescue nil end
+    alias photos_count media_count
+    alias videos_count media_count
 
-    def pro?
-      @info['ispro'].to_i == 1 if @info['ispro']
-    end
+    def public_photos() Flickrie.public_photos_from_user(nsid) end
+
+    def pro?() Integer(@info['ispro']) == 1 rescue nil end
 
     def [](key)
       @info[key]
     end
 
-    def get_info(info = nil)
-      info ||= Flickrie.client.get_user_info(nsid).body['person']
+    def get_info(params = {}, info = nil)
+      info ||= Flickrie.client.get_user_info(nsid, params).body['person']
       @info.update(info)
 
       %w[username realname location description profileurl
@@ -72,16 +65,22 @@ module Flickrie
     private
 
     def initialize(info = {})
+      raise ArgumentError if info.nil?
+
       @info = info
     end
 
     def self.from_info(info)
-      new.get_info(info)
+      new.get_info({}, info)
     end
 
     def self.from_find(info)
       info['username'] = info['username']['_content']
       new(info)
     end
+
+    def self.from_test(info)
+      from_find(info)
+    end
   end
 end

data/lib/flickrie/version.rb

@@ -1,3 +1,3 @@
 module Flickrie
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/lib/flickrie/video.rb

@@ -2,21 +2,22 @@ module Flickrie
   class Video
     include Media
 
-    def ready?;   @video['ready'].to_i == 1 if @video['ready']     end
-    def failed?;  @video['failed'].to_i == 1 if @video['failed']   end
-    def pending?; @video['pending'].to_i == 1 if @video['pending'] end
+    def ready?()   Integer(@video['ready']) == 1   rescue nil end
+    def failed?()  Integer(@video['failed']) == 1  rescue nil end
+    def pending?() Integer(@video['pending']) == 1 rescue nil end
 
-    def duration; @video['duration'].to_i if @video['duration'] end
+    def duration() Integer(@video['duration']) rescue nil end
 
-    def width;  @video['width'].to_i if @video['width']   end
-    def height; @video['height'].to_i if @video['height'] end
+    def width()  Integer(@video['width'])  rescue nil end
+    def height() Integer(@video['height']) rescue nil end
 
-    def source_url;          @video['source_url']          end
-    def download_url;        @video['download_url']        end
-    def mobile_download_url; @video['mobile_download_url'] end
+    def source_url()          @video['source_url']          end
+    def download_url()        @video['download_url']        end
+    def mobile_download_url() @video['mobile_download_url'] end
 
-    def get_sizes(info = nil)
-      info ||= Flickrie.client.get_media_sizes(id).body['sizes']
+    def get_sizes(params = {}, info = nil)
+      info ||= Flickrie.client.get_media_sizes(id, params).body['sizes']
+      @info['usage'] ||= {}
       @info['usage'].update \
         'canblog'     => info['canblog'],
         'canprint'    => info['canprint'],
@@ -32,7 +33,7 @@ module Flickrie
       self
     end
 
-    def get_info(info = nil)
+    def get_info(params = {}, info = nil)
       super
       @video = @info['video']
 

data/spec/api_methods_spec.rb

@@ -0,0 +1,43 @@
+describe Flickrie::ApiMethods do
+  it "should have certain methods working" do
+    VCR.use_cassette "api_methods/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)
+    end
+
+    VCR.use_cassette "api_methods/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)
+    end
+
+    VCR.use_cassette "api_methods/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)
+      end
+    end
+
+    VCR.use_cassette "api_methods/tags" 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)
+    end
+  end
+end

data/spec/error_spec.rb

@@ -0,0 +1,32 @@
+describe Flickrie::Error do
+  before(:all) do
+    Flickrie.api_key = nil
+  end
+
+  context "was raised" do
+    use_vcr_cassette "error/was_raised"
+
+    it "should be raised when the request failed" do
+      expect { Flickrie.get_licenses }.to raise_error(described_class)
+      expect { Flickrie.upload(PHOTO_PATH) }.to raise_error(described_class)
+    end
+  end
+
+  context "code" do
+    use_vcr_cassette "error/code"
+
+    it "should have #code attribute present" do
+      begin
+        Flickrie.get_licenses
+      rescue => exception
+        exception.code.should eq(100)
+      end
+
+      begin
+        Flickrie.upload(PHOTO_PATH)
+      rescue => exception
+        exception.code.should eq(100)
+      end
+    end
+  end
+end

data/spec/instance_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+describe Flickrie::Instance do
+  context "calling api methods" do
+    use_vcr_cassette "instance/calling_api_methods"
+
+    it "should be able to call API methods" do
+      # this is to see if the client and upload_client were reset
+      Flickrie.get_photo_info(PHOTO_ID)
+      Flickrie.access_token = ENV['FLICKR_ACCESS_TOKEN']
+      Flickrie.access_secret = ENV['FLICKR_ACCESS_SECRET']
+      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("Janko Marohnić")
+      id = instance.upload(PHOTO_PATH)
+      instance.delete_photo(id)
+    end
+  end
+end

data/spec/license_spec.rb

@@ -0,0 +1,15 @@
+describe Flickrie::License do
+  context "get licenses" do
+    use_vcr_cassette "license/get"
+
+    it "should have all attributes correctly set" do
+      licenses = Flickrie.get_licenses
+
+      licenses.each do |license|
+        ('0'..'8').should cover(license.id)
+        license.name.should be_an_instance_of(String)
+        license.url.should be_an_instance_of(String)
+      end
+    end
+  end
+end

data/spec/location_spec.rb

@@ -0,0 +1,11 @@
+describe Flickrie::Location do
+  context "blank" do
+    it "should have all attributes equal to nil" do
+      location = Flickrie::Location.public_new
+      attributes = location.methods - Object.instance_methods - [:[]]
+      attributes.each do |attribute|
+        location.send(attribute).should be_nil
+      end
+    end
+  end
+end

data/spec/media_count_spec.rb

@@ -0,0 +1,18 @@
+describe Flickrie::MediaCount do
+  context "get" do
+    use_vcr_cassette "media_count/get"
+
+    it "should have correctly set all attributes" do
+      dates = [DateTime.parse("1st March 2012"), DateTime.parse("5th May 2012")].map(&:to_time)
+      [
+        @flickrie.get_media_counts(:taken_dates => dates.join(',')).first,
+        @flickrie.get_media_counts(:dates => dates.map(&:to_i).join(',')).first
+      ].
+        each do |count|
+          count.value.should be_an_instance_of(Fixnum)
+          count.date_range.begin.should eq(dates.first)
+          count.date_range.end.should eq(dates.last)
+        end
+    end
+  end
+end