flickrie 0.6.1 → 0.7.0

data/spec/media_spec.rb

@@ -0,0 +1,271 @@
+# encoding: utf-8
+
+describe Flickrie::Media do
+  before(:all) do
+    @attributes = {
+      :id => PHOTO_ID,
+      :secret => '25bb44852b',
+      :server => '7049',
+      :farm => 8,
+      :title => 'IMG_0796',
+      :description => 'Test',
+      :media_status => 'ready',
+      :path_alias => nil,
+      :camera => 'Canon PowerShot G12',
+      :views_count => 2,
+      :comments_count => 1,
+      :location => {
+        :latitude => 45.807258,
+        :longitude => 15.967599,
+        :accuracy => '11',
+        :context => 0,
+        :neighbourhood => nil,
+        :locality => {
+          :name => 'Zagreb',
+          :place_id => '00j4IylZV7scWik',
+          :woeid => '851128'
+        },
+        :county => {
+          :name => 'Zagreb',
+          :place_id => '306dHrhQV7o6jm.ZUQ',
+          :woeid => '15022257'
+        },
+        :region => {
+          :name => 'Grad Zagreb',
+          :place_id => 'Js1DU.pTUrpBCIKhVw',
+          :woeid => '20070170'
+        },
+        :country => {
+          :name => 'Croatia',
+          :place_id => 'FunRCI5TUb6a6soTyw',
+          :woeid => '23424843'
+        },
+        :place_id => '00j4IylZV7scWik',
+        :woeid => '851128'
+      },
+      :geo_permissions => {
+        :public? => true,
+        :contacts? => false,
+        :friends? => false,
+        :family? => false
+      },
+      :tags => {
+        :first => {
+          :content => 'luka',
+          :author => {
+            :nsid => USER_NSID
+          },
+          :raw => 'luka',
+          :machine_tag? => false
+        }
+      },
+      :machine_tags => [],
+      :license => {:id => '0'},
+      :taken_at_granularity => 0,
+      :owner => {
+        :nsid => USER_NSID,
+        :username => "Janko Marohnić",
+        :real_name => "Janko Marohnić",
+        :location => "Zagreb, Croatia",
+        :icon_server => "5464",
+        :icon_farm => 6
+      },
+
+      :safety_level => 0,
+      :safe? => true,
+      :moderate? => false,
+      :restricted? => false,
+
+      :visibility => {
+        :public? => true,
+        :family? => false,
+        :friends? => false,
+        :contacts? => nil
+      },
+      :favorite? => false,
+
+      :can_comment? => false,
+      :can_add_meta? => false,
+      :can_everyone_comment? => true,
+      :can_everyone_add_meta? => false,
+
+      :can_download? => true,
+      :can_blog? => false,
+      :can_print? => false,
+      :can_share? => false,
+
+      :has_people? => false,
+      :faved? => false,
+      :notes => {
+        :first => {
+          :id => '72157629487842968',
+          :author => {
+            :nsid => '67131352@N04',
+            :username => 'Janko Marohnić'
+          },
+          :coordinates => [316, 0],
+          :width => 59,
+          :height => 50,
+          :content => 'Test'
+        }
+      }
+    }
+  end
+
+  context "get info" do
+    use_vcr_cassette "media/get_info"
+
+    it "should have all attributes correctly set" do
+      [
+        Flickrie.get_media_info(PHOTO_ID),
+        Flickrie::Photo.public_new('id' => PHOTO_ID).get_info,
+        Flickrie::Video.public_new('id' => PHOTO_ID).get_info
+      ].
+        each do |media|
+          [
+            :id, :secret, :server, :farm, :title, :description,
+            :views_count, :comments_count, :location, :geo_permissions,
+            :tags, :machine_tags, :license, :taken_at_granularity, :owner,
+            :safety_level, :safe?, :moderate?, :restricted?, :visibility,
+            :favorite?, :can_comment?, :can_add_meta?, :can_everyone_comment?,
+            :can_everyone_add_meta?, :can_download?, :can_blog?,
+            :can_print?, :can_share?, :has_people?, :notes
+          ].
+            each { |attribute| test_attribute(media, attribute) }
+
+          # other
+          media.url.empty?.should be_false
+          media['id'].should eq(PHOTO_ID)
+
+          # time
+          [:posted_at, :uploaded_at, :updated_at, :taken_at].each do |time_attribute|
+            media.send(time_attribute).should be_an_instance_of(Time)
+          end
+        end
+    end
+  end
+
+  shared_context "common" do
+    def test_common_attributes(media)
+      [
+        :id, :secret, :server, :farm, :title, :media_status, :views_count,
+        :geo_permissions, :machine_tags, :license, :taken_at_granularity
+      ].
+        each { |attribute| test_attribute(media, attribute) }
+
+      # the incomplete ones
+      test_attribute(media, :location, @attributes[:location].except(:locality, :county, :region, :country))
+      test_attribute(media.tags, :first, @attributes[:tags][:first].except(:author, :raw, :machine_tag?))
+      test_attribute(media, :owner, @attributes[:owner].except(:real_name, :location))
+
+      # other
+      media.url.empty?.should be_false
+
+      # time
+      [:uploaded_at, :updated_at, :taken_at].each do |time_attribute|
+        media.send(time_attribute).should be_an_instance_of(Time)
+      end
+    end
+  end
+
+  context "from set" do
+    include_context "common"
+    use_vcr_cassette "media/from_set"
+
+    it "should have all attributes correctly set" do
+      media = Flickrie.media_from_set(SET_ID, :extras => EXTRAS).
+        find { |media| media.id == PHOTO_ID }
+      test_common_attributes(media)
+      media.primary?.should be_true
+    end
+  end
+
+  context "public from user" do
+    include_context "common"
+    use_vcr_cassette "media/public_from_user"
+
+    it "should have all attributes correctly set" do
+      media = Flickrie.public_media_from_user(USER_NSID, :extras => EXTRAS).
+        find { |media| media.id == PHOTO_ID }
+      test_common_attributes(media)
+      test_attribute(media, :visibility)
+    end
+  end
+
+  context "search" do
+    include_context "common"
+    use_vcr_cassette "media/search"
+
+    it "should have all attributes correctly set" do
+      media = Flickrie.search_media(:user_id => USER_NSID, :extras => EXTRAS).
+        find { |media| media.id == PHOTO_ID }
+      test_common_attributes(media)
+      test_attribute(media, :visibility)
+    end
+  end
+
+  context "from contacts" do
+    use_vcr_cassette "media/from_contacts"
+
+    it "should have all attributes correctly set" do
+      params = {:include_self => 1, :single_photo => 1}
+      [
+        @flickrie.media_from_contacts(params).first,
+        @flickrie.public_media_from_user_contacts(USER_NSID, params).first
+      ].
+        each do |media|
+          media.id.should eq('7093101501')
+          media.secret.should eq('9337f28800')
+          media.server.should eq('7090')
+          media.farm.should eq(8)
+          media.owner.nsid.should eq(USER_NSID)
+          media.owner.username.should eq('Janko Marohnić')
+          media.title.should eq('IMG_0917')
+          test_attribute(media, :visibility)
+          media.media_status.should eq('ready')
+        end
+    end
+  end
+
+  context "get context" do
+    use_vcr_cassette "media/get_context"
+
+    it "should have all attributes correctly set" do
+      context = Flickrie.get_media_context(PHOTO_ID)
+      context['count'].should eq(98)
+      context['prevphoto'].title.should eq('IMG_0795')
+      context['prevphoto'].url.should_not be_empty
+      context['prevphoto'].faved?.should be_false
+    end
+  end
+
+  context "blank media" do
+    it "should have all attributes equal to nil" do
+      attributes = Flickrie::Media.instance_methods -
+        Object.instance_methods -
+        [:[], :get_info, :get_exif, :get_favorites]
+
+      media = Flickrie::Photo.public_new
+      attributes.each do |attribute|
+        media.send(attribute).should be_nil
+      end
+    end
+  end
+
+  context "get exif" do
+    use_vcr_cassette "media/get_exif"
+
+    it "should get exif correctly" do
+      [
+        Flickrie.get_photo_exif(PHOTO_ID),
+        Flickrie::Photo.public_new('id' => PHOTO_ID).get_exif
+      ].
+        each do |photo|
+          photo.camera.should eq('Canon PowerShot G12')
+          photo.exif.get('X-Resolution').should eq('180 dpi')
+          photo.exif.get('X-Resolution', :data => 'clean').should eq('180 dpi')
+          photo.exif.get('X-Resolution', :data => 'raw').should eq('180')
+        end
+    end
+  end
+end

data/spec/oauth_spec.rb

@@ -0,0 +1,22 @@
+describe Flickrie::OAuth do
+  context "incorrect credentials" do
+    use_vcr_cassette "oauth/incorrect_credentials"
+
+    it "should raise exceptions" do
+      Flickrie.api_key = "foo"
+      Flickrie.shared_secret = "foo"
+
+      expect { Flickrie::OAuth.get_request_token }.
+        to raise_error(Flickrie::OAuth::Error)
+
+      Flickrie.api_key = ENV['FLICKR_API_KEY']
+      expect { Flickrie::OAuth.get_request_token }.
+        to raise_error(Flickrie::OAuth::Error)
+
+      Flickrie.shared_secret = ENV['FLICKR_SHARED_SECRET']
+      request_token = Flickrie::OAuth.get_request_token
+      expect { Flickrie::OAuth.get_access_token("foo", request_token) }.
+        to raise_error(Flickrie::OAuth::Error)
+    end
+  end
+end

data/spec/photo_spec.rb

@@ -0,0 +1,137 @@
+SIZES = ['Square 75', 'Thumbnail', 'Square 150', 'Small 240', 'Small 320',
+  'Medium 500', 'Medium 640', 'Medium 800', 'Large 1024']
+
+describe Flickrie::Photo do
+  def test_sizes(photo)
+    # TODO: simplify this
+    # non-bang versions
+    [
+      [[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']]
+    ].
+      each do |photos, expected_values|
+        flickr_size, size = expected_values
+        photos.each do |photo|
+          photo.size.should eq(flickr_size)
+          [photo.width, photo.height].join('x').should eq(size)
+          photo.source_url.should_not be_empty
+        end
+      end
+
+    # bang versions
+    [
+      [[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']]
+    ].
+      each do |blocks, expected_values|
+        flickr_size, size = expected_values
+        blocks.each do |block|
+          result_photo = block.call
+          [result_photo, photo].each do |photo|
+            photo.size.should eq(flickr_size)
+            [photo.width, photo.height].join('x').should eq(size)
+            photo.source_url.should_not be_empty
+          end
+        end
+      end
+  end
+
+  context "get sizes" do
+    use_vcr_cassette "photo/get_sizes"
+
+    it "should have attributes correctly set" do
+      [
+        Flickrie.get_photo_sizes(PHOTO_ID),
+        Flickrie::Photo.public_new('id' => PHOTO_ID).get_sizes
+      ].
+        each do |photo|
+          photo.can_download?.should be_true
+          photo.can_blog?.should be_false
+          photo.can_print?.should be_false
+
+          test_sizes(photo)
+          photo.available_sizes.should eq(SIZES)
+        end
+    end
+  end
+
+  context "search" do
+    use_vcr_cassette "photo/search"
+
+    it "should have all sizes available" do
+      photo = Flickrie.search_photos(:user_id => USER_NSID, :extras => EXTRAS).
+        find { |photo| photo.id == PHOTO_ID }
+      photo.available_sizes.should eq(SIZES)
+    end
+  end
+
+  context "get info" do
+    use_vcr_cassette "photo/get_info"
+
+    it "should have all attributes correctly set" do
+      photo = Flickrie.get_photo_info(PHOTO_ID)
+      photo.rotation.should eq(90)
+    end
+  end
+
+  context "blank" do
+    it "should have all attributes equal to nil" do
+      photo = Flickrie::Photo.public_new
+
+      photo.width.should be_nil
+      photo.height.should be_nil
+      photo.source_url.should be_nil
+      photo.rotation.should be_nil
+      photo.available_sizes.should be_empty
+      photo.size.should be_nil
+
+      [
+        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|
+          photo.source_url.should be_nil
+          photo.width.should be_nil
+          photo.height.should be_nil
+        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
+          photo.source_url.should be_nil
+          photo.width.should be_nil
+          photo.height.should be_nil
+        end
+    end
+  end
+end

data/spec/set_spec.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+describe Flickrie::Set do
+  before(:all) do
+    @attributes = {
+      :id => SET_ID,
+      :secret => '25bb44852b',
+      :server => '7049',
+      :farm => 8,
+      :title => 'Speleologija',
+      :description => 'Slike sa škole speleologije Velebit.',
+      :primary_media_id => PHOTO_ID,
+      :primary_photo_id => PHOTO_ID,
+      :primary_video_id => PHOTO_ID,
+      :views_count => 0,
+      :comments_count => 0,
+      :photos_count => 97,
+      :videos_count => 1,
+      :media_count => 98,
+      :owner => {
+        :nsid => USER_NSID
+      },
+      :can_comment? => false,
+    }
+  end
+
+  def test_common_attributes(set)
+    @attributes.keys.each do |attribute|
+      test_attribute(set, attribute)
+    end
+
+    set.photos.all? { |photo| photo.is_a?(Flickrie::Photo) }.should be_true
+    set.videos.all? { |video| video.is_a?(Flickrie::Video) }.should be_true
+    set.media.all? do |media|
+      media.is_a?(Flickrie::Photo) or media.is_a?(Flickrie::Video)
+    end.should be_true
+
+    set.created_at.should be_an_instance_of(Time)
+    set.updated_at.should be_an_instance_of(Time)
+
+    set.url.should_not be_empty
+  end
+
+  context "get info" do
+    use_vcr_cassette "set/get_info"
+
+    it "should have all attributes correctly set" do
+      [
+        Flickrie.get_set_info(SET_ID),
+        Flickrie::Set.public_new('id' => SET_ID).get_info
+      ].
+        each do |set|
+          test_common_attributes(set)
+        end
+    end
+  end
+
+  context "from user" do
+    use_vcr_cassette "set/from_user"
+
+    it "should have all attributes correctly set" do
+      set = Flickrie.sets_from_user(USER_NSID).find { |set| set.id == SET_ID }
+      test_common_attributes(set)
+      set.needs_interstitial?.should be_false
+      set.visibility_can_see_set?.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,68 @@
+require 'flickrie'
+require 'vcr'
+require 'active_support/core_ext/hash/except'
+begin
+  require 'debugger'
+rescue LoadError
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/vcr_cassettes'
+  config.hook_into :faraday
+  config.default_cassette_options = {:record => :new_episodes}
+end
+
+module RSpecHelpers
+  def test_attribute(object, attribute, hash = nil)
+    expectation = hash || @attributes[attribute]
+    unless expectation.is_a?(Hash)
+      object.send(attribute).should eq(expectation)
+    else
+      iterate(object.send(attribute), expectation) do |actual, expected|
+        actual.should eq(expected)
+      end
+    end
+  end
+
+  def iterate(object, rest, &block)
+    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
+end
+
+RSpec.configure do |config|
+  config.extend VCR::RSpec::Macros
+  config.include RSpecHelpers
+  config.before(:all) do
+    Flickrie.api_key = ENV['FLICKR_API_KEY']
+    Flickrie.shared_secret = ENV['FLICKR_SHARED_SECRET']
+    # so that I can use the '@instance' object when I want to make authenticated API calls
+    @flickrie = Flickrie::Instance.new(ENV['FLICKR_ACCESS_TOKEN'], ENV['FLICKR_ACCESS_SECRET'])
+  end
+end
+
+PHOTO_PATH = File.join(File.expand_path(File.dirname(__FILE__)), 'files/photo.jpg').freeze
+PHOTO_ID = '6946979188'.freeze
+VIDEO_ID = '7093038981'.freeze
+SET_ID = '72157629851991663'.freeze
+USER_NSID = '67131352@N04'.freeze
+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].join(',').freeze
+# for copying:
+#   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
+
+klasses = [Flickrie::Set, Flickrie::Photo, Flickrie::Video, Flickrie::User, Flickrie::Location]
+klasses.each do |klass|
+  klass.instance_eval do
+    def public_new(*args)
+      new(*args)
+    end
+  end
+end

data/spec/user_spec.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+describe Flickrie::User do
+  context "get info" do
+    use_vcr_cassette "user/get_info"
+
+    it "should have all attributes correctly set" do
+      [
+        Flickrie.get_user_info(USER_NSID),
+        Flickrie::User.public_new('nsid' => USER_NSID).get_info
+      ].
+        each do |user|
+          user.id.should eq(USER_NSID)
+          user.nsid.should eq(USER_NSID)
+          user.username.should eq('Janko Marohnić')
+          user.real_name.should eq('Janko Marohnić')
+          user.location.should eq('Zagreb, Croatia')
+          user.time_zone['label'].should eq('Sarajevo, Skopje, Warsaw, Zagreb')
+          user.time_zone['offset'].should eq('+01:00')
+          description = "I'm a programmer, and I'm gonna program a badass Ruby library for Flickr."
+          user.description.should eq(description)
+
+          user.profile_url.should_not be_empty
+          user.mobile_url.should_not be_empty
+          user.photos_url.should_not be_empty
+
+          user.icon_server.should eq('5464')
+          user.icon_farm.should eq(6)
+          user.buddy_icon_url.should_not be_empty
+
+          user.pro?.should be_false
+
+          user.first_taken.should be_an_instance_of(Time)
+          user.first_uploaded.should be_an_instance_of(Time)
+
+          user.media_count.should eq(98)
+        end
+    end
+  end
+
+  context "find by username or email" do
+    use_vcr_cassette "user/find_by_username_or_email"
+
+    it "should have all attributes correctly set" do
+      [
+        Flickrie.find_user_by_username('Janko Marohnić'),
+        Flickrie.find_user_by_email('janko.marohnic@gmail.com')
+      ].
+        each do |user|
+          user.id.should eq(USER_NSID)
+          user.nsid.should eq(USER_NSID)
+          user.username.should eq('Janko Marohnić')
+        end
+    end
+  end
+end

data/spec/video_spec.rb

@@ -0,0 +1,54 @@
+describe Flickrie::Video do
+  context "get info" do
+    use_vcr_cassette "video/get_info"
+
+    it "should have all attributes correctly set" do
+      video = Flickrie.get_video_info(VIDEO_ID)
+
+      video.ready?.should be_true
+      video.failed?.should be_false
+      video.pending?.should be_false
+
+      video.duration.should eq(16)
+      video.width.should eq(352)
+      video.height.should eq(288)
+
+      video.source_url.should be_nil
+      video.download_url.should be_nil
+      video.mobile_download_url.should be_nil
+    end
+  end
+
+  context "get sizes" do
+    use_vcr_cassette "video/get_sizes"
+
+    it "should have all attributes correctly set" do
+      [
+        Flickrie.get_video_sizes(VIDEO_ID),
+        Flickrie::Video.public_new('id' => VIDEO_ID).get_sizes
+      ].
+        each do |video|
+          video.can_download?.should be_true
+          video.can_blog?.should be_false
+          video.can_blog?.should be_false
+
+          video.source_url.should_not be_empty
+          video.download_url.should_not be_empty
+          video.mobile_download_url.should_not be_empty
+        end
+    end
+  end
+
+  context "blank" do
+    it "should have attributes equal to nil" do
+      video = Flickrie::Video.public_new
+      [
+        :ready?, :failed?, :pending?, :duration, :width, :height,
+        :source_url, :download_url, :mobile_download_url
+      ].
+        each do |attribute|
+          video.send(attribute).should be_nil
+        end
+    end
+  end
+end