flickrie 0.6.0 → 0.6.1

data/.gitignore

@@ -2,3 +2,5 @@ TODO.md
 Gemfile.lock
 pkg/
 credentials.rb
+doc/
+.DS_Store

data/CHANGELOG.md

@@ -1,12 +1,16 @@
 # Flickrie changelog
 
+## Version 0.6.1
+
+- `Flickrie::Media::Ticket` is now called just `Flickrie::Ticket`
+
 ## Version 0.6.0
 
 - you can access the raw response hash with square brackets, if you notice I
-  didn't cover some part of it with methods. So, for example, `photo['id']`
-  will access the photo's ID.
+  didn't cover some part of it with methods. So, for example, after calling
+  `Flickrie.get_photo_info`, you can get the photo ID by calling `photo['id']`
 
-- when `Flickrie::Error` is raises, you can now access its `#code`
+- when `Flickrie::Error` is raised, you can now access its `#code`
   attribute. This makes better error handling, because error code
   is (supposed to be) unique, unlike the error message
 

data/README.md

@@ -94,28 +94,35 @@ photo.get_info
 photo.description # => "In this photo Peter said something really funny..."
 ```
 
-You'll also probably want to display these photos in your app.
+You'll also probably want to display these photos in your app. There are
+some neat methods available for you to help you out with this.
 
 ```ruby
 photo = Flickrie.get_photo_sizes(8232348)
 # or "photo.get_sizes" on an existing photo
 
-photo.medium!(800)
-photo.size       # => "Medium 800"
-photo.source_url # => "http://farm8.staticflickr.com/7049/6946979188_25bb44852b_c.jpg"
-photo.width      # => 600
-photo.height     # => 800
-
-photo.small!(320)
-photo.size       # => "Small 320"
-photo.source_url # => "http://farm8.staticflickr.com/7049/6946979188_25bb44852b_n.jpg"
-photo.width      # => 240
-photo.width      # => 320
+photo.medium!(500)
+photo.size       # => "Medium 500"
+photo.source_url # => "http://farm8.staticflickr.com/7090/7093101501_9337f28800.jpg"
+photo.width      # => 375
+photo.height     # => 500
+
+photo.available_sizes # => ["Square 75", "Thumbnail", "Square 150", "Small 240", "Small 320", "Medium 500"]
+```
+
+So, in your ERB template you could do something like this (in Rails):
+
+```erb
+<%= image_tag photo.source_url, :size => "#{photo.width}x#{photo.height}" %>
 ```
 
 You can see the full list of available methods and attributes in the
-[documentation](http://rubydoc.info/gems/flickrie/0.1.2/frames). Also,
-be sure to check the [wiki](https://github.com/janko-m/flickrie/wiki) for some additional info and tips.
+[documentation](http://janko-m.github.com/flickrie/doc/Flickrie.html).
+For photos (and videos) have a look at the `Flickrie::Media` module,
+because it's included into `Flickrie::Photo` and `Flickrie::Video`, and most
+of the attributes are there.
+
+Also, be sure to check the [wiki](https://github.com/janko-m/flickrie/wiki) for some additional info and tips.
 
 ## Authentication
 

data/lib/flickrie/api_methods.rb

@@ -8,6 +8,7 @@ require 'flickrie/photo'
 require 'flickrie/video'
 require 'flickrie/set'
 require 'flickrie/media_count'
+require 'flickrie/ticket'
 
 module Flickrie
   module ApiMethods
@@ -31,18 +32,18 @@ module Flickrie
 
     #--
     # people
-    def find_user_by_email(email)
-      response = client.find_user_by_email(email)
+    def find_user_by_email(email, params = {})
+      response = client.find_user_by_email(email, params)
       User.from_find(response.body['user'])
     end
 
-    def find_user_by_username(username)
-      response = client.find_user_by_username(username)
+    def find_user_by_username(username, params = {})
+      response = client.find_user_by_username(username, params)
       User.from_find(response.body['user'])
     end
 
-    def get_user_info(user_nsid)
-      response = client.get_user_info(user_nsid)
+    def get_user_info(user_nsid, params = {})
+      response = client.get_user_info(user_nsid, params)
       User.from_info(response.body['person'])
     end
 
@@ -61,14 +62,14 @@ module Flickrie
 
     #--
     # photos
-    def add_media_tags(media_id, tags)
-      client.add_media_tags(media_id, tags)
+    def add_media_tags(media_id, tags, params = {})
+      client.add_media_tags(media_id, tags, params)
     end
     alias add_photo_tags add_media_tags
     alias add_video_tags add_media_tags
 
-    def delete_media(media_id)
-      client.delete_media(media_id)
+    def delete_media(media_id, params = {})
+      client.delete_media(media_id, params)
       media_id
     end
     alias delete_photo delete_media
@@ -98,22 +99,16 @@ module Flickrie
         select { |media| media.is_a?(Photo) }
     end
 
-    def get_media_context(media_id)
-      response = client.get_media_context(media_id)
+    def get_media_context(media_id, params = {})
+      response = client.get_media_context(media_id, params)
       Media.from_context(response.body)
     end
     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 = client.get_media_counts \
+        MediaCount.ensure_utc(params)
       response.body['photocounts']['photocount'].
         map { |info| MediaCount.new(info, params) }
     end
@@ -122,31 +117,31 @@ module Flickrie
 
     def get_photo_exif(photo_id, params = {})
       response = client.get_media_exif(photo_id, params)
-      Photo.from_exif(response.body['photo'].merge('media' => 'photo'))
+      Photo.from_exif(response.body['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'))
+      Video.from_exif(response.body['photo'])
     end
 
-    def get_media_info(media_id)
-      response = client.get_media_info(media_id)
+    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
 
-    def get_photo_sizes(photo_id)
-      response = client.get_media_sizes(photo_id)
+    def get_photo_sizes(photo_id, params = {})
+      response = client.get_media_sizes(photo_id, params)
       Photo.from_sizes(response.body['sizes'])
     end
-    def get_video_sizes(video_id)
-      response = client.get_media_sizes(video_id)
+    def get_video_sizes(video_id, params = {})
+      response = client.get_media_sizes(video_id, params)
       Video.from_sizes(response.body['sizes'])
     end
 
-    def remove_media_tag(tag_id)
-      client.remove_media_tag(tag_id)
+    def remove_media_tag(tag_id, params = {})
+      client.remove_media_tag(tag_id, params)
     end
     alias remove_photo_tag remove_media_tag
     alias remove_video_tag remove_media_tag
@@ -164,29 +159,29 @@ module Flickrie
 
     #--
     # photos.upload
-    def check_upload_tickets(tickets)
+    def check_upload_tickets(tickets, params = {})
       tickets = tickets.join(',') if tickets.respond_to?(:join)
-      response = client.check_upload_tickets(tickets)
+      response = client.check_upload_tickets(tickets, params)
       response.body['uploader']['ticket'].
-        map { |info| Media::Ticket.new(info) }
+        map { |info| Ticket.new(info) }
     end
 
     #--
     # licenses
-    def get_licenses
-      response = client.get_licenses
+    def get_licenses(params = {})
+      response = client.get_licenses(params)
       License.from_hash(response.body['licenses']['license'])
     end
 
     #--
     # photosets
-    def get_set_info(set_id)
-      response = client.get_set_info(set_id)
+    def get_set_info(set_id, params = {})
+      response = client.get_set_info(set_id, params)
       Set.from_info(response.body['photoset'])
     end
 
-    def sets_from_user(user_nsid)
-      response = client.sets_from_user(user_nsid)
+    def sets_from_user(user_nsid, params = {})
+      response = client.sets_from_user(user_nsid, params)
       Set.from_user(response.body['photosets']['photoset'], user_nsid)
     end
 

data/lib/flickrie/client.rb

@@ -14,6 +14,7 @@ module Flickrie
       end
     end
 
+    # :doc:
     attr_accessor_with_client_reset :api_key, :shared_secret,
       :timeout, :open_timeout, :access_token, :access_secret
 
@@ -98,31 +99,36 @@ module Flickrie
 
     #--
     # people
-    def find_user_by_email(email)
-      get 'flickr.people.findByEmail', :find_email => email
+    def find_user_by_email(email, params = {})
+      get 'flickr.people.findByEmail',
+        {:find_email => email}.merge(params)
     end
 
-    def find_user_by_username(username)
-      get 'flickr.people.findByUsername', :username => username
+    def find_user_by_username(username, params = {})
+      get 'flickr.people.findByUsername',
+        {:username => username}.merge(params)
     end
 
-    def get_user_info(user_nsid)
-      get 'flickr.people.getInfo', :user_id => user_nsid
+    def get_user_info(user_nsid, params = {})
+      get 'flickr.people.getInfo',
+        {:user_id => user_nsid}.merge(params)
     end
 
     def public_media_from_user(user_nsid, params = {})
-      params = {:user_id => user_nsid}.merge(params)
-      get 'flickr.people.getPublicPhotos', ensure_media(params)
+      get 'flickr.people.getPublicPhotos',
+        ensure_media({:user_id => user_nsid}.merge(params))
     end
 
     #--
     # photos
-    def add_media_tags(media_id, tags)
-      post 'flickr.photos.addTags', :photo_id => media_id, :tags => tags
+    def add_media_tags(media_id, tags, params = {})
+      post 'flickr.photos.addTags',
+        {:photo_id => media_id, :tags => tags}.merge(params)
     end
 
-    def delete_media(media_id)
-      post 'flickr.photos.delete', :photo_id => media_id
+    def delete_media(media_id, params = {})
+      post 'flickr.photos.delete',
+        {:photo_id => media_id}.merge(params)
     end
 
     def media_from_contacts(params = {})
@@ -130,12 +136,13 @@ module Flickrie
     end
 
     def public_media_from_user_contacts(user_nsid, params = {})
-      params = {:user_id => user_nsid}.merge(params)
-      get 'flickr.photos.getContactsPublicPhotos', ensure_media(params)
+      get 'flickr.photos.getContactsPublicPhotos',
+        ensure_media({:user_id => user_nsid}.merge(params))
     end
 
-    def get_media_context(media_id)
-      get 'flickr.photos.getContext', :photo_id => media_id
+    def get_media_context(media_id, params = {})
+      get 'flickr.photos.getContext',
+        {:photo_id => media_id}.merge(params)
     end
 
     def get_media_counts(params = {})
@@ -143,19 +150,23 @@ module Flickrie
     end
 
     def get_media_exif(media_id, params = {})
-      get 'flickr.photos.getExif', {:photo_id => media_id}.merge(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
+    def get_media_info(media_id, params = {})
+      get 'flickr.photos.getInfo',
+        {:photo_id => media_id}.merge(params)
     end
 
-    def get_media_sizes(media_id)
-      get 'flickr.photos.getSizes', :photo_id => media_id
+    def get_media_sizes(media_id, params = {})
+      get 'flickr.photos.getSizes',
+        {:photo_id => media_id}.merge(params)
     end
 
-    def remove_media_tag(tag_id)
-      post 'flickr.photos.removeTag', :tag_id => tag_id
+    def remove_media_tag(tag_id, params = {})
+      post 'flickr.photos.removeTag',
+        {:tag_id => tag_id}.merge(params)
     end
 
     def search_media(params = {})
@@ -164,29 +175,32 @@ module Flickrie
 
     #--
     # photos.upload
-    def check_upload_tickets(tickets)
-      get 'flickr.photos.upload.checkTickets', :tickets => tickets
+    def check_upload_tickets(tickets, params = {})
+      get 'flickr.photos.upload.checkTickets',
+        {:tickets => tickets}.merge(params)
     end
 
     #--
     # photos.licenses
-    def get_licenses
-      get 'flickr.photos.licenses.getInfo'
+    def get_licenses(params = {})
+      get 'flickr.photos.licenses.getInfo', params
     end
 
     #--
     # photosets
-    def get_set_info(set_id)
-      get 'flickr.photosets.getInfo', :photoset_id => set_id
+    def get_set_info(set_id, params = {})
+      get 'flickr.photosets.getInfo',
+        {:photoset_id => set_id}.merge(params)
     end
 
-    def sets_from_user(user_nsid)
-      get 'flickr.photosets.getList', :user_id => user_nsid
+    def sets_from_user(user_nsid, params = {})
+      get 'flickr.photosets.getList',
+        {:user_id => user_nsid}.merge(params)
     end
 
     def media_from_set(set_id, params = {})
-      params = {:photoset_id => set_id}.merge(params)
-      get 'flickr.photosets.getPhotos', ensure_media(params)
+      get 'flickr.photosets.getPhotos',
+        ensure_media({:photoset_id => set_id}.merge(params))
     end
 
     private

data/lib/flickrie/media.rb

@@ -1,7 +1,6 @@
 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'
@@ -187,8 +186,10 @@ module Flickrie
       end
 
       def from_user(hash)
-        hash['owner'] = hash['photo'].first['owner']
-        hash['ownername'] = hash['photo'].first['ownername']
+        if hash['photo'].first
+          hash['owner'] = hash['photo'].first['owner']
+          hash['ownername'] = hash['photo'].first['ownername']
+        end
         hash['photo'].each do |info|
           info['visibility'] = {
             'ispublic' => info.delete('ispublic'),

data/lib/flickrie/media_count.rb

@@ -28,5 +28,15 @@ module Flickrie
       @info = info
       @dates_kind = (params[:dates].nil? ? "mysql timestamp" : "unix timestamp")
     end
+
+    def self.ensure_utc(params)
+      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
+    end
   end
 end

data/lib/flickrie/ticket.rb

@@ -0,0 +1,24 @@
+module Flickrie
+  class Ticket
+    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 imported_at
+      Time.at(@info['imported'].to_i)
+    end
+
+    def [](key)
+      @info[key]
+    end
+
+    def initialize(info)
+      @info = info
+    end
+  end
+end

data/lib/flickrie/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickrie
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-07 00:00:00.000000000 Z
+date: 2012-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70306140464480 !ruby/object:Gem::Requirement
+  requirement: &70207108480240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70306140464480
+  version_requirements: *70207108480240
 - !ruby/object:Gem::Dependency
   name: simple_oauth
-  requirement: &70306157035920 !ruby/object:Gem::Requirement
+  requirement: &70207108479120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70306157035920
+  version_requirements: *70207108479120
 - !ruby/object:Gem::Dependency
   name: multi_xml
-  requirement: &70306157033800 !ruby/object:Gem::Requirement
+  requirement: &70207108476020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70306157033800
+  version_requirements: *70207108476020
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70306157033420 !ruby/object:Gem::Requirement
+  requirement: &70207108475000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70306157033420
+  version_requirements: *70207108475000
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70306157032800 !ruby/object:Gem::Requirement
+  requirement: &70207108473020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70306157032800
+  version_requirements: *70207108473020
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70306157032160 !ruby/object:Gem::Requirement
+  requirement: &70207108571500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70306157032160
+  version_requirements: *70207108571500
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70306157031740 !ruby/object:Gem::Requirement
+  requirement: &70207108570600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70306157031740
+  version_requirements: *70207108570600
 description: This gem is a nice wrapper for the Flickr API with an intuitive interface.
 email: janko.marohnic@gmail.com
 executables: []
@@ -112,12 +112,12 @@ files:
 - 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
+- lib/flickrie/ticket.rb
 - lib/flickrie/upload_client.rb
 - lib/flickrie/user.rb
 - lib/flickrie/version.rb

data/lib/flickrie/media/ticket.rb

@@ -1,26 +0,0 @@
-module Flickrie
-  module Media
-    class Ticket
-      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 imported_at
-        Time.at(@info['imported'].to_i)
-      end
-
-      def [](key)
-        @info[key]
-      end
-
-      def initialize(info)
-        @info = info
-      end
-    end
-  end
-end