flickrie 0.4.1 → 0.5.0

data/flickrie.gemspec

@@ -2,22 +2,23 @@
 require File.expand_path('../lib/flickrie/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Janko Marohnić"]
-  gem.email         = ["janko.marohnic@gmail.com"]
+  gem.author        = "Janko Marohnić"
+  gem.email         = "janko.marohnic@gmail.com"
   gem.description   = %q{This gem is a nice wrapper for the Flickr API with an intuitive interface.}
   gem.summary       = %q{The reason why I did this gem is because the other ones either weren't well maintained, or they were too literal in the sense that the response from the API call wasn't processed almost at all. It doesn't seem too bad at first, but after a while you realize it's not pretty. So I wanted to make it pretty :)}
   gem.homepage      = "https://github.com/janko-m/flickrie"
 
   gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "flickrie"
   gem.require_paths = ["lib"]
   gem.version       = Flickrie::VERSION
 
-  gem.add_dependency 'faraday_middleware'
-  gem.add_dependency 'simple_oauth'
-  gem.add_dependency 'multi_xml'
+  gem.license       = "MIT"
+
+  gem.add_dependency "faraday_middleware"
+  gem.add_dependency "simple_oauth"
+  gem.add_dependency "multi_xml"
 
   gem.add_development_dependency "activesupport"
 end

data/lib/flickrie/api_methods.rb

@@ -7,6 +7,7 @@ require 'flickrie/media'
 require 'flickrie/photo'
 require 'flickrie/video'
 require 'flickrie/set'
+require 'flickrie/media_count'
 
 module Flickrie
   module ApiMethods
@@ -102,6 +103,30 @@ module Flickrie
     alias get_photo_context get_media_context
     alias get_video_context get_media_context
 
+    def get_media_counts(params = {})
+      response = client.get_media_counts(
+        params.dup.tap do |hash|
+          if hash[:taken_dates].is_a?(String)
+            hash[:taken_dates] = hash[:taken_dates].split(',').
+              map { |date| DateTime.parse(date) }.
+              map(&:to_time).map(&:getutc).join(',')
+          end
+        end)
+      response.body['photocounts']['photocount'].
+        map { |info| MediaCount.new(info, params) }
+    end
+    alias get_photos_counts get_media_counts
+    alias get_videos_counts get_media_counts
+
+    def get_photo_exif(photo_id, params = {})
+      response = client.get_media_exif(photo_id, params)
+      Photo.from_exif(response.body['photo'].merge('media' => 'photo'))
+    end
+    def get_video_exif(video_id, params = {})
+      response = client.get_media_exif(video_id, params)
+      Video.from_exif(response.body['photo'].merge('media' => 'video'))
+    end
+
     def get_media_info(media_id)
       response = client.get_media_info(media_id)
       Media.from_info(response.body['photo'])
@@ -137,7 +162,7 @@ module Flickrie
 
     # photos.upload
     def check_upload_tickets(tickets)
-      tickets = tickets.join(',') if tickets.is_a?(Array)
+      tickets = tickets.join(',') if tickets.respond_to?(:join)
       response = client.check_upload_tickets(tickets)
       response.body['uploader']['ticket'].
         map { |info| Media::Ticket.new(info) }

data/lib/flickrie/client.rb

@@ -128,6 +128,14 @@ module Flickrie
       get 'flickr.photos.getContext', :photo_id => media_id
     end
 
+    def get_media_counts(params = {})
+      get 'flickr.photos.getCounts', params
+    end
+
+    def get_media_exif(media_id, params = {})
+      get 'flickr.photos.getExif', {:photo_id => media_id}.merge(params)
+    end
+
     def get_media_info(media_id)
       get 'flickr.photos.getInfo', :photo_id => media_id
     end

data/lib/flickrie/media.rb

@@ -2,6 +2,7 @@ require 'flickrie/media/visibility'
 require 'flickrie/media/note'
 require 'flickrie/media/tag'
 require 'flickrie/media/ticket'
+require 'flickrie/media/exif'
 require 'flickrie/location'
 require 'date'
 
@@ -16,6 +17,16 @@ module Flickrie
     def tags;           @info['tags']         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'
+    #
+    #   photo.exif.get('X-Resolution', :data => 'raw')   # => '180'
+    #   photo.exif.get('X-Resolution', :data => 'clean') # => '180 dpi'
+    #   photo.exif.get('X-Resolution')                   # => '180 dpi'
+    #
+    def exif;           @info['exif']         end
 
     def views_count
       @info['views'].to_i if @info['views']
@@ -125,6 +136,15 @@ module Flickrie
       self
     end
 
+    def get_exif(params = {}, info = nil)
+      info ||= Flickrie.client.get_media_exif(id, params).body['photo']
+
+      @info['camera'] = info['camera'] unless info['camera'].empty?
+      @info['exif'] = Exif.new(info['exif']) unless info['exif'].empty?
+
+      self
+    end
+
     def initialize(info = {})
       @info = info
       @info['dates'] ||= {}
@@ -217,6 +237,10 @@ module Flickrie
 
         hash
       end
+
+      def from_exif(info)
+        new.get_exif({}, info)
+      end
     end
     extend(ClassMethods)
 

data/lib/flickrie/media/exif.rb

@@ -0,0 +1,18 @@
+module Flickrie
+  module Media
+    class Exif
+      def get(key, options = {})
+        hash = @info.find { |hash| hash['label'] == key }
+        data = hash[options[:data]] || hash['clean'] || hash['raw']
+        data['_content']
+
+      rescue NoMethodError
+        raise Error, "The information about '#{key}' doesn't exist"
+      end
+
+      def initialize(info)
+        @info = info
+      end
+    end
+  end
+end

data/lib/flickrie/media_count.rb

@@ -0,0 +1,28 @@
+require 'date'
+
+module Flickrie
+  class MediaCount
+    def value
+      @info['count'].to_i
+    end
+
+    def date_range
+      dates =
+        case @dates_kind
+        when "mysql timestamp"
+          [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)]
+        end
+
+      dates.first..dates.last
+    end
+
+    def initialize(info, params)
+      @info = info
+      @dates_kind = (params[:dates].nil? ? "mysql timestamp" : "unix timestamp")
+    end
+  end
+end

data/lib/flickrie/version.rb

@@ -1,3 +1,3 @@
 module Flickrie
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/test/license_test.rb

@@ -1,5 +1,4 @@
 require 'test'
-require 'flickrie'
 
 Flickrie::License.instance_eval do
   def public_response_array

data/test/location_test.rb

@@ -1,5 +1,4 @@
 require 'test'
-require 'flickrie/location'
 
 class LocationTest < Test::Unit::TestCase
   def test_attributes_returning_nil

data/test/media_count_test.rb

@@ -0,0 +1,17 @@
+require 'test'
+
+class MediaCountTest < Test::Unit::TestCase
+  def test_get_media_count
+    dates = [DateTime.parse("1st March 2012"), DateTime.parse("5th May 2012")].map(&:to_time)
+
+    count = Flickrie.get_media_counts(:taken_dates => dates.join(',')).first
+    assert_instance_of Fixnum, count.value
+    assert_equal dates.first, count.date_range.begin
+    assert_equal dates.last, count.date_range.end
+
+    count = Flickrie.get_media_counts(:dates => dates.map(&:to_i).join(',')).first
+    assert_instance_of Fixnum, count.value
+    assert_equal dates.first, count.date_range.begin
+    assert_equal dates.last, count.date_range.end
+  end
+end

data/test/media_test.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 require 'test'
-require 'flickrie'
 
 Flickrie::Photo.instance_eval do
   def public_new(*args)

data/test/oauth_test.rb

@@ -1,6 +1,5 @@
 require 'test/unit'
-require 'flickrie/client'
-require 'flickrie/oauth'
+require 'flickrie'
 
 class OAuthTest < Test::Unit::TestCase
   def test_raising_errors

data/test/photo_test.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 require 'test'
-require 'flickrie'
 
 Flickrie::Photo.instance_eval do
   def public_new(*args)
@@ -164,6 +163,19 @@ class PhotoTest < Test::Unit::TestCase
     Flickrie.delete_photo(photo_id)
   end
 
+  def test_get_photo_exif
+    [
+      Flickrie.get_photo_exif(@photo_id),
+      Flickrie::Photo.public_new('id' => @photo_id).get_exif
+    ].
+      each do |photo|
+        assert_equal "Canon PowerShot G12", photo.camera
+        assert_equal "180 dpi", photo.exif.get('X-Resolution')
+        assert_equal "180 dpi", photo.exif.get('X-Resolution', :data => 'clean')
+        assert_equal "180",     photo.exif.get('X-Resolution', :data => 'raw')
+      end
+  end
+
   def test_other_api_calls
     # add_photo_tags, get_photo_info, remove_photo_tag,
     # search_photos, photos_from_contacts

data/test/set_test.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 require 'test'
-require 'flickrie'
 
 Flickrie::Set.instance_eval do
   def public_new(*args)

data/test/test.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'flickrie/client'
+require 'flickrie'
 
 Flickrie.api_key = ENV['FLICKR_API_KEY']
 Flickrie.shared_secret = ENV['FLICKR_SHARED_SECRET']

data/test/user_test.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 require 'test'
-require 'flickrie'
 
 Flickrie::User.instance_eval do
   def public_new(*args)

data/test/video_test.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 require 'test'
-require 'flickrie'
 
 Flickrie::Video.instance_eval do
   def public_new(*args)
@@ -73,6 +72,18 @@ class VideoTest < Test::Unit::TestCase
     Flickrie.delete_video(video_id)
   end
 
+  def test_get_video_exif
+    [
+      Flickrie.get_video_exif(@video_id),
+      Flickrie::Video.public_new('id' => @video_id).get_exif
+    ].
+      each do |video|
+        assert_nil video.camera
+        assert_nil video.exif
+      end
+  end
+
+
   def test_other_api_calls
     # add_video_tags, remove_video_tag,
     # search_videos, videos_from_contacts,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickrie
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-05 00:00:00.000000000 Z
+date: 2012-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70287090746520 !ruby/object:Gem::Requirement
+  requirement: &70351778281200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70287090746520
+  version_requirements: *70351778281200
 - !ruby/object:Gem::Dependency
   name: simple_oauth
-  requirement: &70287090746080 !ruby/object:Gem::Requirement
+  requirement: &70351778280580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70287090746080
+  version_requirements: *70351778280580
 - !ruby/object:Gem::Dependency
   name: multi_xml
-  requirement: &70287090745640 !ruby/object:Gem::Requirement
+  requirement: &70351778273820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70287090745640
+  version_requirements: *70351778273820
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70287090745060 !ruby/object:Gem::Requirement
+  requirement: &70351778272820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70287090745060
+  version_requirements: *70351778272820
 description: This gem is a nice wrapper for the Flickr API with an intuitive interface.
-email:
-- janko.marohnic@gmail.com
+email: janko.marohnic@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -68,6 +67,76 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- api_methods.md
+- doc/Flickrie.html
+- doc/Flickrie/.DS_Store
+- doc/Flickrie/ApiMethods.html
+- doc/Flickrie/Client.html
+- doc/Flickrie/Error.html
+- doc/Flickrie/Instance.html
+- doc/Flickrie/License.html
+- doc/Flickrie/Location.html
+- doc/Flickrie/Media.html
+- doc/Flickrie/Media/ClassMethods.html
+- doc/Flickrie/Media/Count.html
+- doc/Flickrie/Media/Exif.html
+- doc/Flickrie/Media/Note.html
+- doc/Flickrie/Media/Tag.html
+- doc/Flickrie/Media/Ticket.html
+- doc/Flickrie/Media/Visibility.html
+- doc/Flickrie/MediaCount.html
+- doc/Flickrie/OAuth.html
+- doc/Flickrie/OAuth/AccessToken.html
+- doc/Flickrie/OAuth/Error.html
+- doc/Flickrie/OAuth/ParseResponseParams.html
+- doc/Flickrie/OAuth/RequestToken.html
+- doc/Flickrie/OAuth/StatusCheck.html
+- doc/Flickrie/OAuth/Token.html
+- doc/Flickrie/OAuthStatusCheck.html
+- doc/Flickrie/Photo.html
+- doc/Flickrie/Set.html
+- doc/Flickrie/StatusCheck.html
+- doc/Flickrie/UploadClient.html
+- doc/Flickrie/UploadStatusCheck.html
+- doc/Flickrie/User.html
+- doc/Flickrie/Video.html
+- doc/Gemfile.html
+- doc/LICENSE.html
+- doc/Rakefile.html
+- doc/created.rid
+- doc/images/add.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/navigation.js
+- doc/js/search.js
+- doc/js/search_index.js
+- doc/js/searcher.js
+- doc/rdoc.css
+- doc/table_of_contents.html
 - flickrie.gemspec
 - lib/flickrie.rb
 - lib/flickrie/api_methods.rb
@@ -76,10 +145,12 @@ files:
 - lib/flickrie/license.rb
 - lib/flickrie/location.rb
 - lib/flickrie/media.rb
+- lib/flickrie/media/exif.rb
 - lib/flickrie/media/note.rb
 - lib/flickrie/media/tag.rb
 - lib/flickrie/media/ticket.rb
 - lib/flickrie/media/visibility.rb
+- lib/flickrie/media_count.rb
 - lib/flickrie/oauth.rb
 - lib/flickrie/photo.rb
 - lib/flickrie/set.rb
@@ -90,6 +161,7 @@ files:
 - test/instance_test.rb
 - test/license_test.rb
 - test/location_test.rb
+- test/media_count_test.rb
 - test/media_test.rb
 - test/oauth_test.rb
 - test/photo.jpg
@@ -100,7 +172,8 @@ files:
 - test/video.mov
 - test/video_test.rb
 homepage: https://github.com/janko-m/flickrie
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -130,6 +203,7 @@ test_files:
 - test/instance_test.rb
 - test/license_test.rb
 - test/location_test.rb
+- test/media_count_test.rb
 - test/media_test.rb
 - test/oauth_test.rb
 - test/photo.jpg