flickrie 0.6.1 → 0.7.0

data/.gitignore

@@ -4,3 +4,4 @@ pkg/
 credentials.rb
 doc/
 .DS_Store
+spec/vcr_cassettes

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Flickrie changelog
 
+## Version 1.0.0
+
+- cover `flickr.photos.getFavorites` and `flickr.test.login`
+- change the way `flickr.photos.getContext` works (this is the part that is NOT backwards compatible)
+
+Before:
+```ruby
+context = Flickrie.get_photo_context(712472397)
+context['count'] # => 12
+context['prevphoto'] # => #<Photo: ...>
+context['nexphoto'] # => #<Photo: ...>
+```
+Now:
+```ruby
+context = Flickrie.get_photo_context(712472397)
+context.count # => 12
+context.previous # => #<Photo: ...>
+context.next # => #<Photo: ...>
+```
+
+- bug fixes (especially regarding the `Flickr::Instance`)
+
 ## Version 0.6.1
 
 - `Flickrie::Media::Ticket` is now called just `Flickrie::Ticket`

data/Gemfile

@@ -9,9 +9,3 @@ group :development, :test do
   gem "pry"
   gem "debugger"
 end
-
-group :test do
-  # This is to get rid of 'gem install minitest' messages
-  # in the tests
-  gem "minitest"
-end

data/README.md

@@ -138,7 +138,7 @@ puts "Visit this url to authenticate: #{url}"
 
 print "If you agreed, the code was displayed afterwards. Enter it: "
 code = gets.strip
-access_token = Flickrie::OAuth.get_access_token(code)
+access_token = Flickrie::OAuth.get_access_token(code, request_token)
 Flickrie.access_token = access_token.token
 Flickrie.access_secret = access_token.secret
 puts "You successfully authenticated!"
@@ -214,6 +214,19 @@ default.
 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.
 
+## How to contribute
+
+I will be happy if you want to contribute. The procedure is nothing
+special, you just fork the project and send me a pull request.
+
+For your tests to be able to run, you should make a Flickr account, and
+get the API key and secret. You can get them [here](http://www.flickr.com/services/apps/create/apply).
+You also have to get the access token. You can do that by using my
+authentication system. After you have these four things, you have to
+assign them to environment variables named `FLICKR_API_KEY`,
+`FLICKR_SHARED_SECRET`, `FLICKR_ACCESS_TOKEN`, `FLICKR_ACCESS_SECRET`.
+Once you do that, you should be able to run tests.
+
 ## Cedits
 
 Special thanks to @**mislav**, my brother, he helped me really a lot
@@ -237,6 +250,7 @@ basis of this gem.
 "flickr.photos.getContext"              -> Flickrie.get_photo_context
 "flickr.photos.getCounts"               -> Flickrie.get_photos_counts
 "flickr.photos.getExif"                 -> Flickrie.get_photo_exif
+"flickr.photos.getFavorites"            -> Flickrie.get_photo_favorites
 "flickr.photos.getInfo"                 -> Flickrie.get_photo_info
 "flickr.photos.getSizes"                -> Flickrie.get_photo_sizes
 "flickr.photos.removeTag"               -> Flickrie.remove_photo_tag

data/Rakefile

@@ -1,22 +1,17 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-CURRENT_DIR = File.expand_path(File.dirname(__FILE__))
-
-task :test do
-  Dir["#{CURRENT_DIR}/test/**/*_test.rb"].each do |test_file|
-    system "bundle exec turn -Itest --require=test_helper #{test_file}"
+task :spec, :spec do |task, args|
+  command = "bundle exec rspec -I spec --require 'spec_helper'"
+  if args['spec'].nil?
+    system(command)
+  else
+    system(command + " spec/#{args['spec']}_spec.rb")
   end
 end
 
-namespace :test do
-  test_rbs = Dir["#{CURRENT_DIR}/test/*_test.rb"].
-    map { |t| [File.basename(t).chomp('_test.rb').to_sym, t] }.
-      each do |test_name, test_file|
-        task(test_name) do
-          system "bundle exec turn -Itest --require=test_helper #{test_file}"
-        end
-      end
+task :console do
+  system "bundle exec pry -I. --require 'flickrie' --require 'credentials'"
 end
 
 task :rdoc do

data/api_methods.md

@@ -115,7 +115,7 @@
 - ~~flickr.photos.getContext~~
 - ~~flickr.photos.getCounts~~
 - ~~flickr.photos.getExif~~
-- flickr.photos.getFavorites
+- ~~flickr.photos.getFavorites~~
 - ~~flickr.photos.getInfo~~
 - flickr.photos.getNotInSet
 - flickr.photos.getPerms

data/flickrie.gemspec

@@ -20,8 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "simple_oauth", '~> 0.1'
   gem.add_dependency "multi_xml", '~> 0.4'
 
-  gem.add_development_dependency "activesupport"
-  gem.add_development_dependency "turn"
+  gem.add_development_dependency "activesupport", '>= 3'
+  gem.add_development_dependency "rspec", '>= 2'
   gem.add_development_dependency "vcr"
-  gem.add_development_dependency "webmock"
 end

data/lib/flickrie/api_methods.rb

@@ -124,10 +124,20 @@ module Flickrie
       Video.from_exif(response.body['photo'])
     end
 
+    def get_photo_favorites(photo_id, params = {})
+      response = client.get_media_favorites(photo_id, params)
+      Photo.new(response.body['photo'])
+    end
+    def get_video_favorites(video_id, params = {})
+      response = client.get_media_favorites(video_id, params)
+      Video.new(response.body['photo'])
+    end
+
     def get_media_info(media_id, params = {})
       response = client.get_media_info(media_id, params)
       Media.from_info(response.body['photo'])
     end
+
     alias get_photo_info get_media_info
     alias get_video_info get_media_info
 
@@ -195,5 +205,12 @@ module Flickrie
     def videos_from_set(set_id, params = {})
       media_from_set(set_id, params.merge(:media => 'videos'))
     end
+
+    #--
+    # test
+    def test_login(params = {})
+      response = client.test_login(params)
+      User.from_test(response.body['user'])
+    end
   end
 end

data/lib/flickrie/client.rb

@@ -9,7 +9,7 @@ module Flickrie
       attributes.each do |attribute|
         define_method "#{attribute}=" do |value|
           instance_variable_set "@#{attribute}", value
-          @client = nil
+          @client = @upload_client = nil
         end
       end
     end
@@ -18,8 +18,12 @@ module Flickrie
     attr_accessor_with_client_reset :api_key, :shared_secret,
       :timeout, :open_timeout, :access_token, :access_secret
 
-    def client(access_token_hash = {})
-      @client ||= Client.new(params) do |conn|
+    def client
+      @client ||= new_client
+    end
+
+    def new_client(access_token_hash = {})
+      Client.new(params) do |conn|
         conn.use FaradayMiddleware::OAuth,
           :consumer_key => api_key,
           :consumer_secret => shared_secret,
@@ -154,6 +158,11 @@ module Flickrie
         {:photo_id => media_id}.merge(params)
     end
 
+    def get_media_favorites(media_id, params = {})
+      get 'flickr.photos.getFavorites',
+        {:photo_id => media_id}.merge(params)
+    end
+
     def get_media_info(media_id, params = {})
       get 'flickr.photos.getInfo',
         {:photo_id => media_id}.merge(params)
@@ -203,11 +212,18 @@ module Flickrie
         ensure_media({:photoset_id => set_id}.merge(params))
     end
 
+    #--
+    # test
+    def test_login(params = {})
+      get 'flickr.test.login', params
+    end
+
     private
 
     def ensure_media(params)
-      params[:extras] = [params[:extras], 'media'].compact.join(',')
-      params
+      params.dup.tap do |dup_params|
+        dup_params[:extras] = [dup_params[:extras], 'media'].compact.join(',')
+      end
     end
   end
 end

data/lib/flickrie/instance.rb

@@ -6,8 +6,13 @@ module Flickrie
       @access_token, @access_secret = access_token, access_secret
     end
 
-    def client;        Flickrie.client(access_token_hash)        end
-    def upload_client; Flickrie.upload_client(access_token_hash) end
+    def client
+      @client ||= Flickrie.new_client(access_token_hash)
+    end
+
+    def upload_client
+      @upload_client ||= Flickrie.new_upload_client(access_token_hash)
+    end
 
     include ApiMethods
 

data/lib/flickrie/license.rb

@@ -14,6 +14,8 @@ module Flickrie
           hash['id'] == argument
         end
         initialize(hash)
+      else
+        raise ArgumentError
       end
     end
 

data/lib/flickrie/location.rb

@@ -1,13 +1,12 @@
 module Flickrie
   class Location
-    attr_reader :latitude, :longitude, :accuracy, :context, :place_id,
-      :woeid
+    attr_reader :latitude, :longitude, :accuracy, :context, :place_id, :woeid
 
-    def neighbourhood; place('neighbourhood') end
-    def locality;      place('locality')      end
-    def county;        place('county')        end
-    def region;        place('region')        end
-    def country;       place('country')       end
+    def neighbourhood() place('neighbourhood') end
+    def locality()      place('locality')      end
+    def county()        place('county')        end
+    def region()        place('region')        end
+    def country()       place('country')       end
 
     def [](key)
       @info[key]
@@ -16,11 +15,14 @@ module Flickrie
     private
 
     def initialize(info = {})
+      raise ArgumentError if info.nil?
+
       @info = info
 
-      %w[latitude longitude accuracy context place_id woeid].each do |attribute|
+      %w[latitude longitude accuracy place_id woeid].each do |attribute|
         instance_variable_set "@#{attribute}", @info[attribute]
       end
+      @context = Integer(@info['context']) rescue nil
     end
 
     def place(place_name)

data/lib/flickrie/media/exif.rb

@@ -7,7 +7,7 @@ module Flickrie
         data['_content']
 
       rescue NoMethodError
-        raise Error, "The information about '#{key}' doesn't exist"
+        nil
       end
 
       def [](key)
@@ -15,6 +15,8 @@ module Flickrie
       end
 
       def initialize(info)
+        raise ArgumentError if info.nil?
+
         @info = info
       end
     end

data/lib/flickrie/media/tag.rb

@@ -1,9 +1,9 @@
 module Flickrie
   module Media
     class Tag
-      def id;      @info['id']       end
-      def raw;     @info['raw']      end
-      def content; @info['_content'] end
+      def id()      @info['id']       end
+      def raw()     @info['raw']      end
+      def content() @info['_content'] end
 
       def machine_tag?
         @info['machine_tag'].to_i == 1 if @info['machine_tag']

data/lib/flickrie/media/visibility.rb

@@ -1,16 +1,18 @@
 module Flickrie
   module Media
     class Visibility
-      def public?;   @info['ispublic'].to_i == 1 if @info['ispublic']   end
-      def friends?;  @info['isfriend'].to_i == 1 if @info['isfriend']   end
-      def family?;   @info['isfamily'].to_i == 1 if @info['isfamily']   end
-      def contacts?; @info['iscontact'].to_i == 1 if @info['iscontact'] end
+      def public?()   @info['ispublic'].to_i == 1 if @info['ispublic']   end
+      def friends?()  @info['isfriend'].to_i == 1 if @info['isfriend']   end
+      def family?()   @info['isfamily'].to_i == 1 if @info['isfamily']   end
+      def contacts?() @info['iscontact'].to_i == 1 if @info['iscontact'] end
 
       def [](key)
         @info[key]
       end
 
       def initialize(info)
+        raise ArgumentError if info.nil?
+
         @info = info
       end
     end

data/lib/flickrie/media.rb

@@ -7,16 +7,16 @@ require 'date'
 
 module Flickrie
   module Media
-    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 tags;           @info['tags']         end
-    def media_status;   @info['media_status'] end
-    def path_alias;     @info['pathalias']    end
-    def camera;         @info['camera']       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 media_status()   @info['media_status'] end
+    def path_alias()     @info['pathalias']    end
+
+    def camera() @info['camera'] end
     # ==== Example
     #
     #   photo.exif.get('Model') # => 'Canon PowerShot G12'
@@ -25,51 +25,34 @@ module Flickrie
     #   photo.exif.get('X-Resolution', :data => 'clean') # => '180 dpi'
     #   photo.exif.get('X-Resolution')                   # => '180 dpi'
     #
-    def exif;           @info['exif']         end
+    def exif() Exif.new(@info['exif']) rescue nil end
 
-    def views_count
-      @info['views'].to_i if @info['views']
-    end
-
-    def comments_count
-      @info['comments_count'].to_i if @info['comments_count']
-    end
-
-    def location
-      Location.new(@info['location']) if @info['location']
-    end
-
-    def machine_tags
-      tags.select { |tag| tag.machine_tag? } if tags
-    end
+    def views_count()    Integer(@info['views'])          rescue nil end
+    def comments_count() Integer(@info['comments_count']) rescue nil end
 
-    def geo_permissions
-      Visibility.new(@info['geoperms']) if @info['geoperms']
-    end
+    def location() Location.new(@info['location']) rescue nil end
+    def geo_permissions() Visibility.new(@info['geoperms']) rescue nil end
 
-    def license
-      License.new(@info['license']) if @info['license']
-    end
+    def tags() @info['tags'].map { |info| Tag.new(info) }     rescue nil end
+    def machine_tags() tags.select { |tag| tag.machine_tag? } rescue nil end
 
-    def posted_at;   Time.at(@info['dates']['posted'].to_i) if @info['dates']['posted']         end
-    def uploaded_at; Time.at(@info['dates']['uploaded'].to_i) if @info['dates']['uploaded']     end
-    def updated_at;  Time.at(@info['dates']['lastupdate'].to_i) if @info['dates']['lastupdate'] end
-    def taken_at;    DateTime.parse(@info['dates']['taken']).to_time if @info['dates']['taken'] end
+    def license() License.new(@info['license']) rescue nil end
 
-    def taken_at_granularity
-      @info['dates']['takengranularity'].to_i if @info['dates']['takengranularity']
-    end
+    def posted_at()   Time.at(Integer(@info['dates']['posted']))           rescue nil end
+    def uploaded_at() Time.at(Integer(@info['dates']['uploaded']))         rescue nil end
+    def updated_at()  Time.at(Integer(@info['dates']['lastupdate']))       rescue nil end
+    def taken_at()    DateTime.parse(@info['dates']['taken']).to_time      rescue nil end
+    def taken_at_granularity() Integer(@info['dates']['takengranularity']) rescue nil end
 
-    def owner
-      User.new(@info['owner']) if @info['owner']
-    end
+    def owner() User.new(@info['owner']) rescue nil end
 
-    def safety_level; @info['safety_level'].to_i if @info['safety_level'] end
+    def safety_level() Integer(@info['safety_level']) rescue nil end
 
-    def safe?;       safety_level <= 1 if safety_level end
-    def moderate?;   safety_level == 2 if safety_level end
-    def restricted?; safety_level == 3 if safety_level end
+    def safe?()       safety_level <= 1 if safety_level end
+    def moderate?()   safety_level == 2 if safety_level end
+    def restricted?() safety_level == 3 if safety_level end
 
+    # TODO: Take care about the url from #get_info
     def url
       if owner and id
         "http://www.flickr.com/photos/#{owner.nsid}/#{id}"
@@ -78,68 +61,65 @@ module Flickrie
       end
     end
 
-    def visibility
-      Visibility.new(@info['visibility']) if @info['visibility']
-    end
+    def visibility() Visibility.new(@info['visibility']) rescue nil end
 
-    def primary?; @info['isprimary'].to_i == 1 if @info['isprimary'] end
+    def primary?() Integer(@info['isprimary']) == 1 rescue nil end
 
-    def favorite?; @info['isfavorite'].to_i == 1 if @info['isfavorite'] end
+    def favorite?() Integer(@info['isfavorite']) == 1 rescue nil end
 
-    def can_comment?;  @info['editability']['cancomment'].to_i == 1 if @info['editability'] end
-    def can_add_meta?; @info['editability']['canaddmeta'].to_i == 1 if @info['editability'] end
+    def can_comment?()  Integer(@info['editability']['cancomment']) == 1 rescue nil end
+    def can_add_meta?() Integer(@info['editability']['canaddmeta']) == 1 rescue nil end
 
-    def can_everyone_comment?
-      @info['publiceditability']['cancomment'].to_i == 1 if @info['publiceditability']
-    end
+    def can_everyone_comment?()  Integer(@info['publiceditability']['cancomment']) == 1 rescue nil end
+    def can_everyone_add_meta?() Integer(@info['publiceditability']['canaddmeta']) == 1 rescue nil end
 
-    def can_everyone_add_meta?
-      @info['publiceditability']['canaddmeta'].to_i == 1 if @info['publiceditability']
-    end
+    def can_download?() Integer(@info['usage']['candownload']) == 1 rescue nil end
+    def can_blog?()     Integer(@info['usage']['canblog']) == 1     rescue nil end
+    def can_print?()    Integer(@info['usage']['canprint']) == 1    rescue nil end
+    def can_share?()    Integer(@info['usage']['canshare']) == 1    rescue nil end
 
-    def can_download?; @info['usage']['candownload'].to_i == 1 if @info['usage']['candownload'] end
-    def can_blog?;     @info['usage']['canblog'].to_i == 1     if @info['usage']['canblog']     end
-    def can_print?;    @info['usage']['canprint'].to_i == 1    if @info['usage']['canprint']    end
-    def can_share?;    @info['usage']['canshare'].to_i == 1    if @info['usage']['canshare']    end
+    def has_people?() Integer(@info['people']['haspeople']) == 1 rescue nil end
 
-    def has_people?; @info['people']['haspeople'].to_i == 1 if @info['people'] end
+    def faved?() Integer(@info['is_faved']) == 1 rescue nil end
 
-    def faved?; @info['is_faved'].to_i == 1 if @info['is_faved'] end
+    def notes() @info['notes']['note'].map { |hash| Note.new(hash) } rescue nil end
 
-    def notes
-      @info['notes']['note'].map { |hash| Note.new(hash) } if @info['notes']
-    end
+    def favorites() @info['person'].map { |info| User.new(info) } rescue nil end
 
     def [](key)
       @info[key]
     end
 
-    def get_info(info = nil)
-      info ||= Flickrie.client.get_media_info(id).body['photo']
+    def get_info(params = {}, info = nil)
+      info ||= Flickrie.client.get_media_info(id, params).body['photo']
+      @info.update(info)
 
-      info['title'] = info['title']['_content']
-      info['description'] = info['description']['_content']
-      info['comments_count'] = info.delete('comments')['_content']
-      info['dates']['uploaded'] = info.delete('dateuploaded')
-      info['tags'] = info['tags']['tag'].map { |info| Tag.new(info) }
+      # Fixes
+      @info['title'] = @info['title']['_content']
+      @info['description'] = @info['description']['_content']
+      @info['comments_count'] = @info.delete('comments')['_content']
+      @info['dates']['uploaded'] = @info.delete('dateuploaded')
+      @info['tags'] = @info['tags']['tag']
 
-      @info.update(info)
       self
     end
 
     def get_exif(params = {}, info = nil)
       info ||= Flickrie.client.get_media_exif(id, params).body['photo']
+      @info.update(info)
 
-      @info['camera'] = info['camera'] unless info['camera'].empty?
-      @info['exif'] = Exif.new(info['exif']) unless info['exif'].empty?
+      self
+    end
+
+    def get_favorites(params = {}, info = nil)
+      info ||= Flickrie.client.get_media_favorites(id, params).body['photo']
+      @info.update(info)
 
       self
     end
 
     def initialize(info = {})
       @info = info
-      @info['dates'] ||= {}
-      @info['usage'] ||= {}
     end
 
     module ClassMethods # :nodoc:
@@ -169,11 +149,16 @@ module Flickrie
             'taken' => info.delete('datetaken'),
             'takengranularity' => info.delete('datetakengranularity'),
           }
-          info['usage'] = {}
 
           unless info['tags'].nil?
             info['tags'] = info['tags'].split(' ').map do |tag_content|
-              Tag.new('_content' => tag_content)
+              {'_content' => tag_content, 'machine_tag' => 0}
+            end
+          end
+          unless info['machine_tags'].nil?
+            info['tags'] ||= []
+            info['tags'] += info.delete('machine_tags').split(' ').map do |tag_content|
+              {'_content' => tag_content, 'machine_tag' => 1}
             end
           end
 
@@ -182,7 +167,7 @@ module Flickrie
       end
 
       def from_info(info)
-        new('media' => info['media']).get_info(info)
+        new('media' => info['media']).get_info({}, info)
       end
 
       def from_user(hash)
@@ -202,7 +187,7 @@ module Flickrie
       end
 
       def from_sizes(info)
-        new.get_sizes(info)
+        new.get_sizes({}, info)
       end
 
       def from_search(hash)

data/lib/flickrie/media_count.rb

@@ -2,9 +2,7 @@ require 'date'
 
 module Flickrie
   class MediaCount
-    def value
-      @info['count'].to_i
-    end
+    def value() Integer(@info['count']) rescue nil end
 
     def date_range
       dates =
@@ -13,8 +11,8 @@ module Flickrie
           [DateTime.parse(@info['fromdate']).to_time,
            DateTime.parse(@info['todate']).to_time]
         when "unix timestamp"
-          [Time.at(@info['fromdate'].to_i),
-           Time.at(@info['todate'].to_i)]
+          [Time.at(Integer(@info['fromdate'])),
+           Time.at(Integer(@info['todate']))]
         end
 
       dates.first..dates.last