flickrie 0.0.1

data/lib/flickrie.rb

@@ -0,0 +1,98 @@
+require 'flickrie/client'
+require 'flickrie/license'
+require 'flickrie/user'
+require 'flickrie/media'
+require 'flickrie/photo'
+require 'flickrie/video'
+require 'flickrie/set'
+
+module Flickrie
+  class << self
+    # people
+    def find_user_by_email(email)
+      response = client.find_user_by_email(email)
+      User.from_find(response.body['user'])
+    end
+
+    def find_user_by_username(username)
+      response = client.find_user_by_username(username)
+      User.from_find(response.body['user'])
+    end
+
+    def get_user_info(user_nsid)
+      response = client.get_user_info(user_nsid)
+      User.from_info(response.body['person'])
+    end
+
+    def public_media_from_user(user_nsid, params = {})
+      response = client.public_media_from_user(user_nsid, params)
+      Media.from_user(response.body['photos'])
+    end
+    def public_photos_from_user(user_nsid, params = {})
+      public_media_from_user(user_nsid, params).select do |media|
+        media.is_a?(Photo)
+      end
+    end
+    def public_videos_from_user(user_nsid, params = {})
+      public_media_from_user(user_nsid, params).select do |media|
+        media.is_a?(Video)
+      end
+    end
+
+    # photos
+    def get_media_info(media_id)
+      response = client.get_media_info(media_id)
+      Media.from_info(response.body['photo'])
+    end
+    alias get_photo_info get_media_info
+    alias get_video_info get_media_info
+
+    def get_photo_sizes(photo_id)
+      response = client.get_media_sizes(photo_id)
+      Photo.from_sizes(response.body['sizes'])
+    end
+    def get_video_sizes(video_id)
+      response = client.get_media_sizes(video_id)
+      Video.from_sizes(response.body['sizes'])
+    end
+
+    def search_media(search_params = {})
+      response = client.search_media(search_params)
+      Media.from_search(response.body['photos'])
+    end
+    def search_photos(search_params = {})
+      search_media(search_params.merge(:media => 'photos'))
+    end
+    def search_videos(search_params = {})
+      search_media(search_params.merge(:media => 'videos'))
+    end
+
+    # licenses
+    def get_licenses
+      response = client.get_licenses
+      License.from_hash(response.body['licenses']['license'])
+    end
+
+    # photosets
+    def get_set_info(set_id)
+      response = client.get_set_info(set_id)
+      Set.from_info(response.body['photoset'])
+    end
+
+    def sets_from_user(user_nsid)
+      response = client.sets_from_user(user_nsid)
+      Set.from_user(response.body['photosets']['photoset'], user_nsid)
+    end
+
+    def media_from_set(set_id, params = {})
+      response = client.media_from_set(set_id, params)
+      Media.from_set(response.body['photoset'])
+    end
+    def photos_from_set(set_id, params = {})
+      media_from_set(set_id, params.merge(:media => 'photos'))
+    end
+    def videos_from_set(set_id, params = {})
+      media_from_set(set_id, params.merge(:media => 'videos'))
+    end
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+require 'test/unit'
+require 'flickrie/client'
+
+class ClientTest < Test::Unit::TestCase
+  def setup
+    Flickrie.api_key = ENV['FLICKR_API_KEY']
+    @client = Flickrie.client
+    @set_id = 72157629851991663
+    @media_id = 7093038981
+    @user_nsid = '67131352@N04'
+  end
+
+  def test_internals
+    assert_equal ENV['FLICKR_API_KEY'], Flickrie.api_key
+    assert_instance_of Flickrie::Client, @client
+  end
+
+  def test_api_calls
+    assert_nothing_raised do
+      # people
+      @client.find_user_by_email('janko.marohnic@gmail.com')
+      @client.find_user_by_username('Janko Marohnić')
+      @client.get_user_info(@user_nsid)
+      @client.public_media_from_user(@user_nsid)
+
+      # photos
+      @client.get_media_info(@media_id)
+      @client.get_media_sizes(@media_id)
+      @client.search_media(:user_id => @user_nsid)
+
+      # licenses
+      @client.get_licenses
+
+      # photosets
+      @client.get_set_info(@set_id)
+      @client.sets_from_user(@user_nsid)
+      @client.media_from_set(@set_id)
+    end
+  end
+end

data/test/license_test.rb

@@ -0,0 +1,30 @@
+require 'test/unit'
+require 'flickrie'
+
+Flickrie::License.instance_eval do
+  def public_response_array
+    response_array
+  end
+end
+
+class LicenseTest < Test::Unit::TestCase
+  def setup
+    Flickrie.api_key = ENV['FLICKR_API_KEY']
+  end
+
+  def test_licenses_staying_the_same
+    licenses_array = Flickrie.client.get_licenses.body['licenses']['license']
+    assert_equal licenses_array.sort_by { |hash| hash['id'] },
+      Flickrie::License.public_response_array
+  end
+
+  def test_get_licenses
+    licenses = Flickrie.get_licenses
+
+    licenses.each do |license|
+      assert_includes ('0'..'8'), license.id
+      assert_instance_of String, license.name
+      assert_instance_of String, license.url
+    end
+  end
+end

data/test/location_test.rb

@@ -0,0 +1,21 @@
+require 'test/unit'
+require 'flickrie/location'
+
+class LocationTest < Test::Unit::TestCase
+  def test_attributes_returning_nil
+    location = Flickrie::Location.new
+
+    assert_nil location.latitude
+    assert_nil location.longitude
+    assert_nil location.accuracy
+    assert_nil location.context
+    assert_nil location.place_id
+    assert_nil location.woeid
+
+    assert_nil location.neighbourhood
+    assert_nil location.locality
+    assert_nil location.county
+    assert_nil location.region
+    assert_nil location.country
+  end
+end

data/test/media_test.rb

@@ -0,0 +1,309 @@
+# encoding: utf-8
+require 'test/unit'
+require 'flickrie'
+
+Flickrie::Photo.instance_eval do
+  def public_new(*args)
+    new(*args)
+  end
+end
+
+class MediaTest < Test::Unit::TestCase
+  def setup
+    Flickrie.api_key = ENV['FLICKR_API_KEY']
+    @media_id = 6946979188
+    @set_id = 72157629851991663
+    @user_nsid = '67131352@N04'
+
+    # license,date_upload,date_taken,owner_name,icon_server,original_format,last_update,geo,tags,machine_tags,o_dims,views,media,path_alias,url_sq,url_q,url_t,url_s,url_n,url_m,url_z,url_c,url_l,url_o
+    @all_extras = %w[license date_upload date_taken owner_name
+      icon_server original_format last_update geo tags machine_tags
+      o_dims views media path_alias
+      url_sq url_q url_t url_s url_n url_m url_z url_c url_l url_o]
+  end
+
+  def test_get_media_info
+    get_info_assertions(Flickrie.get_media_info(@media_id))
+    get_info_assertions(Flickrie::Photo.public_new('id' => @media_id.to_s).get_info)
+  end
+
+  def get_info_assertions(media)
+    assert_equal '6946979188', media.id
+    assert_equal '25bb44852b', media.secret
+    assert_equal '7049', media.server
+    assert_equal 8, media.farm
+    assert_equal 'IMG_0796', media.title
+    assert_equal 'luka', media.tags
+    assert_equal '', media.machine_tags
+    assert_equal 1, media.views_count
+    assert_equal 1, media.comments_count
+    assert_equal '0', media.license.id
+    assert_equal 0, media.safety_level
+    assert_equal 90, media.rotation
+    assert_equal 'Test', media.description
+    assert_not_nil media.url
+
+    # Time
+    assert_instance_of Time, media.uploaded_at
+    assert_instance_of Time, media.updated_at
+    assert_instance_of Time, media.taken_at
+    assert_equal 0, media.taken_at_granularity
+    assert_instance_of Time, media.posted_at
+
+    # Owner
+    assert_equal '67131352@N04', media.owner.nsid
+    assert_equal 'Janko Marohnić', media.owner.username
+    assert_equal 'Janko Marohnić', media.owner.real_name
+    assert_equal 'Zagreb, Croatia', media.owner.location
+    assert_equal '5464', media.owner.icon_server
+    assert_equal 6, media.owner.icon_farm
+    refute media.owner.buddy_icon_url.empty?
+
+    # Predicates
+    assert_equal true, media.visibility.public?
+    assert_equal false, media.visibility.friends?
+    assert_equal false, media.visibility.family?
+    assert_equal nil, media.visibility.contacts?
+
+    assert_equal false, media.can_comment?
+    assert_equal false, media.can_add_meta?
+    assert_equal true, media.can_everyone_comment?
+    assert_equal false, media.can_everyone_add_meta?
+
+    assert_equal true, media.can_download?
+    assert_equal false, media.can_blog?
+    assert_equal false, media.can_print?
+    assert_equal false, media.can_share?
+
+    assert_equal false, media.has_people?
+
+    assert_equal true, media.safe?
+    assert_equal false, media.moderate?
+    assert_equal false, media.restricted?
+
+    assert_equal false, media.favorite?
+
+    assert_equal true, media.geo_permissions.public?
+    assert_equal false, media.geo_permissions.contacts?
+    assert_equal false, media.geo_permissions.friends?
+    assert_equal false, media.geo_permissions.family?
+
+    # Notes
+    note = media.notes.first
+    assert_equal '72157629487842968', note.id
+    assert_equal '67131352@N04', note.author.nsid
+    assert_equal 'Janko Marohnić', note.author.username
+    assert_equal [316, 0], note.coordinates
+    assert_equal [59, 50], [note.width, note.height]
+    assert_equal 'Test', note.content
+
+    # Location
+    location = media.location
+
+    assert_equal 45.807258, location.latitude
+    assert_equal 15.967599, location.longitude
+    assert_equal '11', location.accuracy
+    assert_equal '0', location.context
+
+    assert_equal nil, location.neighbourhood
+    assert_equal 'Zagreb', location.locality.name
+    assert_equal '00j4IylZV7scWik', location.locality.place_id
+    assert_equal '851128', location.locality.woeid
+    assert_equal 'Zagreb', location.county.name
+    assert_equal '306dHrhQV7o6jm.ZUQ', location.county.place_id
+    assert_equal '15022257', location.county.woeid
+    assert_equal 'Grad Zagreb', location.region.name
+    assert_equal 'Js1DU.pTUrpBCIKhVw', location.region.place_id
+    assert_equal '20070170', location.region.woeid
+    assert_equal 'Croatia', location.country.name
+    assert_equal 'FunRCI5TUb6a6soTyw', location.country.place_id
+    assert_equal '23424843', location.country.woeid
+
+    assert_equal '00j4IylZV7scWik', location.place_id
+    assert_equal '851128', location.woeid
+  end
+
+  def test_media_from_set
+    media = Flickrie.media_from_set(@set_id, :extras => @all_extras).
+      find { |media| media.id.to_i == @media_id }
+
+    assert_equal '6946979188', media.id
+    assert_equal '25bb44852b', media.secret
+    assert_equal '7049', media.server
+    assert_equal 8, media.farm
+    assert_equal 'IMG_0796', media.title
+    assert_equal 'luka', media.tags
+    assert_equal '', media.machine_tags
+    assert_equal 1, media.views_count
+    assert_equal '0', media.license.id
+    assert_equal true, media.primary?
+    assert_not_nil media.url
+    assert_equal 'ready', media.media_status
+
+    # Time
+    assert_instance_of Time, media.uploaded_at
+    assert_instance_of Time, media.updated_at
+    assert_instance_of Time, media.taken_at
+    assert_equal 0, media.taken_at_granularity
+
+    # Location
+    assert_equal 45.807258, media.location.latitude
+    assert_equal 15.967599, media.location.longitude
+    assert_equal '11', media.location.accuracy
+    assert_equal '0', media.location.context.to_s
+    assert_equal '00j4IylZV7scWik', media.location.place_id
+    assert_equal '851128', media.location.woeid
+    assert_equal true, media.geo_permissions.public?
+    assert_equal false, media.geo_permissions.contacts?
+    assert_equal false, media.geo_permissions.friends?
+    assert_equal false, media.geo_permissions.family?
+
+    # Owner
+    assert_equal '67131352@N04', media.owner.nsid
+    assert_equal 'Janko Marohnić', media.owner.username
+    assert_equal '5464', media.owner.icon_server
+    assert_equal 6, media.owner.icon_farm
+    refute media.owner.buddy_icon_url.empty?
+  end
+
+  def test_public_media_from_user
+    media = Flickrie.public_media_from_user(@user_nsid, :extras => @all_extras).
+      find { |media| media.id.to_i == @media_id }
+
+    assert_equal '6946979188', media.id
+    assert_equal '25bb44852b', media.secret
+    assert_equal '7049', media.server
+    assert_equal 8, media.farm
+    assert_equal 'IMG_0796', media.title
+    assert_equal 'luka', media.tags
+    assert_equal '', media.machine_tags
+    assert_equal 1, media.views_count
+    assert_equal '0', media.license.id
+    assert_not_nil media.url
+    assert_equal 'ready', media.media_status
+
+    # Time
+    assert_instance_of Time, media.uploaded_at
+    assert_instance_of Time, media.updated_at
+    assert_instance_of Time, media.taken_at
+    assert_equal 0, media.taken_at_granularity
+
+    # Location
+    assert_equal 45.807258, media.location.latitude
+    assert_equal 15.967599, media.location.longitude
+    assert_equal '11', media.location.accuracy
+    assert_equal '0', media.location.context.to_s
+    assert_equal '00j4IylZV7scWik', media.location.place_id
+    assert_equal '851128', media.location.woeid
+    assert_equal true, media.geo_permissions.public?
+    assert_equal false, media.geo_permissions.contacts?
+    assert_equal false, media.geo_permissions.friends?
+    assert_equal false, media.geo_permissions.family?
+
+    # Owner
+    assert_equal '67131352@N04', media.owner.nsid
+    assert_equal 'Janko Marohnić', media.owner.username
+    assert_equal '5464', media.owner.icon_server
+    assert_equal 6, media.owner.icon_farm
+    refute media.owner.buddy_icon_url.empty?
+
+    # Visibility (This is the difference from Flickrie.media_from_set)
+    assert_equal true, media.visibility.public?
+    assert_equal false, media.visibility.friends?
+    assert_equal false, media.visibility.family?
+    assert_equal nil, media.visibility.contacts?
+  end
+
+  def test_search_media
+    media = Flickrie.search_media(:user_id => @user_nsid, :extras => @all_extras).
+      find { |media| media.id.to_i == @media_id }
+
+    assert_equal '6946979188', media.id
+    assert_equal '25bb44852b', media.secret
+    assert_equal '7049', media.server
+    assert_equal 8, media.farm
+    assert_equal 'IMG_0796', media.title
+    assert_equal 'luka', media.tags
+    assert_equal '', media.machine_tags
+    assert_equal 1, media.views_count
+    assert_equal '0', media.license.id
+    assert_not_nil media.url
+    assert_equal 'ready', media.media_status
+
+    # Time
+    assert_instance_of Time, media.uploaded_at
+    assert_instance_of Time, media.updated_at
+    assert_instance_of Time, media.taken_at
+    assert_equal 0, media.taken_at_granularity
+
+    # Location
+    assert_equal 45.807258, media.location.latitude
+    assert_equal 15.967599, media.location.longitude
+    assert_equal '11', media.location.accuracy
+    assert_equal '0', media.location.context.to_s
+    assert_equal '00j4IylZV7scWik', media.location.place_id
+    assert_equal '851128', media.location.woeid
+    assert_equal true, media.geo_permissions.public?
+    assert_equal false, media.geo_permissions.contacts?
+    assert_equal false, media.geo_permissions.friends?
+    assert_equal false, media.geo_permissions.family?
+
+    # Owner
+    assert_equal '67131352@N04', media.owner.nsid
+    assert_equal 'Janko Marohnić', media.owner.username
+    assert_equal '5464', media.owner.icon_server
+    assert_equal 6, media.owner.icon_farm
+    refute media.owner.buddy_icon_url.empty?
+
+    # Visibility (This is the difference from Flickrie.media_from_set)
+    assert_equal true, media.visibility.public?
+    assert_equal false, media.visibility.friends?
+    assert_equal false, media.visibility.family?
+    assert_equal nil, media.visibility.contacts?
+  end
+
+  def test_methods_returning_nil
+    media = Flickrie::Photo.new
+
+    assert_nil media.id
+    assert_nil media.secret
+    assert_nil media.server
+    assert_nil media.farm
+    assert_nil media.title
+    assert_nil media.description
+    assert_nil media.tags
+    assert_nil media.machine_tags
+    assert_nil media.media_status
+    assert_nil media.path_alias
+    assert_nil media.views_count
+    assert_nil media.comments_count
+    assert_nil media.location
+    assert_nil media.geo_permissions
+    assert_nil media.license
+    assert_nil media.posted_at
+    assert_nil media.uploaded_at
+    assert_nil media.updated_at
+    assert_nil media.taken_at
+    assert_nil media.taken_at_granularity
+    assert_nil media.owner
+    assert_nil media.safety_level
+    assert_nil media.safe?
+    assert_nil media.moderate?
+    assert_nil media.restricted?
+    assert_nil media.url
+    assert_nil media.visibility
+    assert_nil media.primary?
+    assert_nil media.favorite?
+    assert_nil media.can_comment?
+    assert_nil media.can_add_meta?
+    assert_nil media.can_everyone_comment?
+    assert_nil media.can_everyone_add_meta?
+    assert_nil media.can_download?
+    assert_nil media.can_blog?
+    assert_nil media.can_print?
+    assert_nil media.can_share?
+    assert_nil media.has_people?
+    assert_nil media.notes
+    assert_nil media.media_status
+  end
+end

data/test/photo_test.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+require 'test/unit'
+require 'flickrie'
+
+Flickrie::Photo.instance_eval do
+  def public_new(*args)
+    new(*args)
+  end
+end
+
+class PhotoTest < Test::Unit::TestCase
+  def setup
+    Flickrie.api_key = ENV['FLICKR_API_KEY']
+    @photo_id = 6946979188
+    @set_id = 72157629851991663
+    @user_nsid = '67131352@N04'
+
+    # license,date_upload,date_taken,owner_name,icon_server,original_format,last_update,geo,tags,machine_tags,o_dims,views,media,path_alias,url_sq,url_q,url_t,url_s,url_n,url_m,url_z,url_c,url_l,url_o
+    @all_extras = %w[license date_upload date_taken owner_name
+      icon_server original_format last_update geo tags machine_tags
+      o_dims views media path_alias
+      url_sq url_q url_t url_s url_n url_m url_z url_c url_l url_o]
+  end
+
+  def test_photos_from_set
+    photo = Flickrie.photos_from_set(@set_id, :extras => @all_extras).
+      find { |photo| photo.id.to_i == @photo_id }
+
+    assert_sizes(photo)
+  end
+
+  def test_public_photos_from_user
+    photo = Flickrie.public_photos_from_user(@user_nsid, :extras => @all_extras).
+      find { |photo| photo.id.to_i == @photo_id }
+
+    assert_sizes(photo, :exclude => ['Square 150', 'Small 320', 'Medium 800'])
+  end
+
+  def test_get_photo_sizes
+    get_sizes_assertions(Flickrie.get_photo_sizes(@photo_id))
+    get_sizes_assertions(Flickrie::Photo.public_new('id' => @photo_id.to_s).get_sizes)
+  end
+
+  def get_sizes_assertions(photo)
+    assert_equal true, photo.can_download?
+    assert_equal false, photo.can_blog?
+    assert_equal false, photo.can_print?
+
+    assert_sizes(photo)
+  end
+
+  def test_search_photos
+    photo = Flickrie.search_photos(:user_id => @user_nsid, :extras => @all_extras).
+      find { |photo| photo.id.to_i == @photo_id }
+
+    assert_sizes(photo)
+  end
+
+  def assert_sizes(photo, options = {})
+    options[:exclude] ||= []
+    [
+      [[photo.square(75), photo.square75],   ['Square 75', '75x75']],
+      [[photo.thumbnail],                    ['Thumbnail', '75x100']],
+      [[photo.square(150), photo.square150], ['Square 150', '150x150']],
+      [[photo.small(240), photo.small240],   ['Small 240', '180x240']],
+      [[photo.small(320), photo.small320],   ['Small 320', '240x320']],
+      [[photo.medium(500), photo.medium500], ['Medium 500', '375x500']],
+      [[photo.medium(640), photo.medium640], ['Medium 640', '480x640']],
+      [[photo.medium(800), photo.medium800], ['Medium 800', '600x800']],
+      [[photo.large(1024), photo.large1024], ['Large 1024', '768x1024']]
+    ].
+      reject { |_, expected_values| options[:exclude].include?(expected_values.first) }.
+      each do |photos, expected_values|
+        flickr_size, size = expected_values
+        photos.each do |photo|
+          assert_equal flickr_size, photo.size
+          assert_equal size, "#{photo.width}x#{photo.height}", "Non bang versions"
+          refute photo.source_url.empty?
+        end
+      end
+
+    [
+      [[proc { photo.square!(75) }, proc { photo.square75! }],   ['Square 75', '75x75']],
+      [[proc { photo.thumbnail! }],                              ['Thumbnail', '75x100']],
+      [[proc { photo.square!(150) }, proc { photo.square150! }], ['Square 150', '150x150']],
+      [[proc { photo.small!(240) }, proc { photo.small240! }],   ['Small 240', '180x240']],
+      [[proc { photo.small!(320) }, proc { photo.small320! }],   ['Small 320', '240x320']],
+      [[proc { photo.medium!(500) }, proc { photo.medium500! }], ['Medium 500', '375x500']],
+      [[proc { photo.medium!(640) }, proc { photo.medium640! }], ['Medium 640', '480x640']],
+      [[proc { photo.medium!(800) }, proc { photo.medium800! }], ['Medium 800', '600x800']],
+      [[proc { photo.large!(1024) }, proc { photo.large1024! }], ['Large 1024', '768x1024']]
+    ].
+      reject { |_, expected_values| options[:exclude].include?(expected_values.first) }.
+      each do |proks, expected_values|
+        flickr_size, size = expected_values
+        proks.each do |prok|
+          prok.call
+          assert_equal flickr_size, photo.size
+          assert_equal size, "#{photo.width}x#{photo.height}", "Bang versions"
+          refute photo.source_url.empty?
+        end
+      end
+  end
+
+  def test_methods_returning_nil
+    photo = Flickrie::Photo.new
+
+    assert_nil photo.width
+    assert_nil photo.height
+    assert_nil photo.source_url
+    assert_nil photo.rotation
+    assert_equal [], photo.available_sizes
+    assert_equal nil, photo.size
+
+    [
+      photo.square(75), photo.square(150), photo.thumbnail,
+      photo.small(240), photo.small(320), photo.medium(500),
+      photo.medium(640), photo.medium(800), photo.large(1024),
+      photo.original, photo.square75, photo.square150,
+      photo.small240, photo.small320, photo.medium500,
+      photo.medium640, photo.medium800, photo.large1024,
+      photo.largest
+    ].
+      each do |photo|
+        assert_nil photo.source_url
+        assert_nil photo.width
+        assert_nil photo.height
+      end
+
+    [
+      proc { photo.square!(75) }, proc { photo.square!(150) },
+      proc { photo.thumbnail! }, proc { photo.small!(240) },
+      proc { photo.small!(320) }, proc { photo.medium!(500) },
+      proc { photo.medium!(640) }, proc { photo.medium!(800) },
+      proc { photo.large!(1024) }, proc { photo.original! },
+      proc { photo.square75! }, proc { photo.square150! },
+      proc { photo.small240! }, proc { photo.small320! },
+      proc { photo.medium500! }, proc { photo.medium640! },
+      proc { photo.medium800! }, proc { photo.large1024! },
+      proc { photo.largest! }
+    ].
+      each do |prok|
+        prok.call
+        assert_nil photo.source_url
+        assert_nil photo.width
+        assert_nil photo.height
+      end
+  end
+end