flickrie 1.5.0 → 1.5.1

data/lib/flickrie/base58.rb

@@ -0,0 +1,15 @@
+module Flickrie
+  module Base58
+    ALPHABET = '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ'.chars.to_a.freeze
+
+    def to_base58(value)
+      value = Integer(value)
+      begin
+        value, remainder = value.divmod(58)
+        result = ALPHABET[remainder] + (result || '')
+      end while value > 0
+
+      result
+    end
+  end
+end

data/lib/flickrie/callable.rb

@@ -0,0 +1,78 @@
+require 'flickrie/client'
+require 'flickrie/upload_client'
+require 'flickrie/middleware'
+require 'faraday_middleware'
+
+module Flickrie
+  module Callable
+    # This is for manual use (for example, if I haven't covered something yet, and you really need it).
+    # Here's an example:
+    #
+    #     response = Flickrie.client.get "flickr.photos.getInfo", :photo_id => 8423943
+    #     response.body['photo']['id']          # => 8423943
+    #     response.body['photo']['description'] # => "..."
+    #
+    #     Flickrie.client.post "flickr.photos.licenses.setLicense", :photo_id => 1241497, :license_id => 2
+    #
+    # For the full list of available API methods, see [this page](http://www.flickr.com/services/api/).
+    #
+    # @return [HTTP response] A Faraday HTTP response
+    def client
+      params = {
+        :url => 'http://api.flickr.com/services/rest',
+        :params => {
+          :format => 'json',
+          :nojsoncallback => '1',
+          :api_key => api_key
+        },
+        :request => {
+          :open_timeout => open_timeout || DEFAULTS[:open_timeout],
+          :timeout => timeout || DEFAULTS[:timeout]
+        }
+      }
+
+      @client ||=
+        Client.new(params) do |b|
+          b.use Middleware::Retry
+          b.use FaradayMiddleware::OAuth,
+            :consumer_key => api_key,
+            :consumer_secret => shared_secret,
+            :token => access_token,
+            :token_secret => access_secret
+
+          b.use Middleware::FixFlickrData
+          b.use Middleware::StatusCheck
+          b.use FaradayMiddleware::ParseJson
+          b.use Middleware::OAuthCheck
+
+          b.adapter :net_http
+        end
+    end
+
+    def upload_client
+      params = {
+        :url => 'http://api.flickr.com/services',
+        :request => {
+          :open_timeout => open_timeout || DEFAULTS[:open_timeout]
+        }
+      }
+
+      @upload_client ||=
+        UploadClient.new(params) do |b|
+          b.use Middleware::Retry
+          b.use FaradayMiddleware::OAuth,
+            :consumer_key => api_key,
+            :consumer_secret => shared_secret,
+            :token => access_token,
+            :token_secret => access_secret
+          b.request :multipart
+
+          b.use Middleware::UploadStatusCheck
+          b.use FaradayMiddleware::ParseXml
+          b.use Middleware::OAuthCheck
+
+          b.adapter :net_http
+        end
+    end
+  end
+end

data/lib/flickrie/client.rb

@@ -2,22 +2,20 @@ require 'faraday'
 
 module Flickrie
   class Client < Faraday::Connection
-    def get(method, params = {})
-      if params.delete(:include_sizes)
-        urls = Photo::FLICKR_SIZES.values.map { |s| "url_#{s}" }.join(',')
-        params[:extras] = [params[:extras], urls].compact.join(',')
-      end
-
-      super() do |req|
-        req.params[:method] = method
-        req.params.update(params)
-      end
-    end
-
-    def post(method, params = {})
-      super() do |req|
-        req.params[:method] = method
-        req.params.update(params)
+    # @!method get(method, params = {})
+    # @!method post(method, params = {})
+    [:get, :post].each do |http_method|
+      define_method(http_method) do |flickr_method, params = {}|
+        # (:include_sizes => true) --> (:extras => "url_sq,url_q,url_s,...")
+        if params.delete(:include_sizes)
+          urls = Photo::FLICKR_SIZES.values.map { |s| "url_#{s}" }.join(',')
+          params[:extras] = [params[:extras], urls].compact.join(',')
+        end
+
+        super() do |req|
+          req.params[:method] = flickr_method
+          req.params.update(params)
+        end
       end
     end
 
@@ -82,7 +80,7 @@ module Flickrie
     end
 
     def get_media_counts(params = {})
-      get 'flickr.photos.getCounts', params
+      get 'flickr.photos.getCounts', ensure_utc(params)
     end
 
     def get_media_exif(media_id, params = {})
@@ -223,5 +221,15 @@ module Flickrie
         dup_params[:extras] = [dup_params[:extras], 'media'].compact.join(',')
       end
     end
+
+    def 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/instance.rb

@@ -2,6 +2,15 @@ module Flickrie
   class Instance
     attr_reader :access_token, :access_secret
 
+    def self.delegate(*attributes)
+      attributes.each do |attribute|
+        define_method(attribute) do
+          Flickrie.send(attribute)
+        end
+      end
+    end
+    delegate :api_key, :shared_secret, :open_timeout, :timeout, :pagination
+
     # Initializes a new authenticated instance. Example:
     #
     #     flickrie = Flickrie::Instance.new("ACCESS_TOKEN", "ACCESS_SECRET")
@@ -10,21 +19,7 @@ module Flickrie
       @access_token, @access_secret = access_token, access_secret
     end
 
-    # See {Flickrie.client} for more info.
-    def client
-      @client ||= Flickrie.new_client(access_token_hash)
-    end
-
+    include Callable
     include ApiMethods
-
-    private
-
-    def upload_client
-      @upload_client ||= Flickrie.new_upload_client(access_token_hash)
-    end
-
-    def access_token_hash
-      {:token => access_token, :secret => access_secret}
-    end
   end
 end

data/lib/flickrie/middleware.rb

@@ -12,7 +12,7 @@ module Flickrie
   end
 
   # Internal
-  module Middleware # :nodoc:
+  module Middleware
     class StatusCheck < Faraday::Response::Middleware
       def on_complete(env)
         if env[:body]['stat'] != 'ok'
@@ -40,26 +40,6 @@ module Flickrie
       end
     end
 
-    class Retry < Faraday::Middleware
-      def initialize(app, retries = 2)
-        @retries = retries
-        super(app)
-      end
-
-      def call(env)
-        retries = @retries
-        begin
-          @app.call(env)
-        rescue Faraday::Error::TimeoutError
-          if retries > 0
-            retries -= 1
-            retry
-          end
-          raise
-        end
-      end
-    end
-
     class ParseOAuthParams < FaradayMiddleware::ResponseMiddleware
       define_parser do |body|
         CGI.parse(body).inject({}) do |hash, (key, value)|
@@ -69,3 +49,6 @@ module Flickrie
     end
   end
 end
+
+require 'flickrie/middleware/retry'
+require 'flickrie/middleware/fix_flickr_data'

data/lib/flickrie/middleware/fix_flickr_data.rb

@@ -0,0 +1,215 @@
+module Flickrie
+  module Middleware
+    class FixFlickrData < Faraday::Response::Middleware
+      def call(env)
+        response = @app.call(env)
+        fix_flickr_data!(response)
+        response
+      end
+
+      private
+
+      # Ugly, just normalizing the data
+      def fix_flickr_data!(response)
+        data = response.env[:body]
+        query = CGI.parse(response.env[:url].query)
+        flickr_method = query['method'].first
+
+        case flickr_method
+        # people
+        when 'flickr.people.findByUsername'
+          data['user']['username'] = data['user']['username']['_content']
+        when 'flickr.people.findByEmail'
+          data['user']['username'] = data['user']['username']['_content']
+        when 'flickr.people.getInfo'
+          %w[username realname location description profileurl mobileurl photosurl].each do |attribute|
+            data['person'][attribute] = data['person'][attribute]['_content']
+          end
+          %w[count firstdatetaken firstdate].each do |photo_attribute|
+            data['person']['photos'][photo_attribute] = data['person']['photos'][photo_attribute]['_content']
+          end
+        when 'flickr.test.login'
+          data['user']['username'] = data['user']['username']['_content']
+        when 'flickr.people.getUploadStatus'
+          data['user']['username'] = data['user']['username']['_content']
+          data['user']['upload_status'] = {
+            'bandwidth' => data['user'].delete('bandwidth'),
+            'filesize' => data['user'].delete('filesize'),
+            'sets' => data['user'].delete('sets'),
+            'videosize' => data['user'].delete('videosize'),
+            'videos' => data['user'].delete('videos')
+          }
+
+        # photos
+        when 'flickr.people.getPhotos'
+          fix_common!(data)
+        when 'flickr.people.getPublicPhotos'
+          fix_common!(data)
+        when 'flickr.photos.getInfo'
+          data['photo']['title'] = data['photo']['title']['_content']
+          data['photo']['description'] = data['photo']['description']['_content']
+          data['photo']['comments_count'] = data['photo'].delete('comments')['_content']
+          data['photo']['dates']['uploaded'] = data['photo'].delete('dateuploaded')
+          data['photo']['tags'] = data['photo']['tags']['tag']
+        when 'flickr.photosets.getPhotos'
+          data['photoset']['photo'].map! do |media_hash|
+            media_hash['owner'] = {
+              'id' => data['photoset']['owner'],
+              'nsid' => data['photoset']['owner'],
+              'username' => data['photoset']['ownername'],
+            }
+            fix_extras!(media_hash)
+            media_hash
+          end
+        when 'flickr.photos.getSizes'
+          data['sizes']['usage'] = {
+            'canblog'     => data['sizes']['canblog'],
+            'canprint'    => data['sizes']['canprint'],
+            'candownload' => data['sizes']['candownload']
+          }
+          data['sizes']['id'] = query['photo_id'].first
+          if data['sizes']['size'].find { |hash| hash['label'] == 'Video Player' }
+            # Video
+            data['sizes']['video'] ||= {}
+            data['sizes']['size'].each do |info|
+              case info['label']
+              when 'Video Player' then data['sizes']['video']['source_url'] = info['source']
+              when 'Site MP4'     then data['sizes']['video']['download_url'] = info['source']
+              when 'Mobile MP4'   then data['sizes']['video']['mobile_download_url'] = info['source']
+              end
+            end
+          else
+            flickr_sizes = {
+              'Square'       => Photo::FLICKR_SIZES['Square 75'],
+              'Large Square' => Photo::FLICKR_SIZES['Square 150'],
+              'Thumbnail'    => Photo::FLICKR_SIZES['Thumbnail'],
+              'Small'        => Photo::FLICKR_SIZES['Small 240'],
+              'Small 320'    => Photo::FLICKR_SIZES['Small 320'],
+              'Medium'       => Photo::FLICKR_SIZES['Medium 500'],
+              'Medium 640'   => Photo::FLICKR_SIZES['Medium 640'],
+              'Medium 800'   => Photo::FLICKR_SIZES['Medium 800'],
+              'Large'        => Photo::FLICKR_SIZES['Large 1024'],
+              'Large 1600'   => Photo::FLICKR_SIZES['Large 1600'],
+              'Large 2048'   => Photo::FLICKR_SIZES['Large 2048'],
+              'Original'     => Photo::FLICKR_SIZES['Original']
+            }
+            data['sizes']['size'].each do |size_info|
+              size_abbr = flickr_sizes[size_info['label']]
+              data['sizes']["width_#{size_abbr}"] = size_info['width']
+              data['sizes']["height_#{size_abbr}"] = size_info['height']
+              data['sizes']["url_#{size_abbr}"] = size_info['source']
+            end
+          end
+        when 'flickr.photos.search'
+          fix_common!(data)
+        when 'flickr.photos.getContactsPhotos'
+          data['photos']['photo'].each do |media_hash|
+            media_hash['ownername'] = media_hash.delete('username')
+          end
+          fix_common!(data)
+        when 'flickr.photos.getContactsPublicPhotos'
+          data['photos']['photo'].each do |media_hash|
+            media_hash['ownername'] = media_hash.delete('username')
+          end
+          fix_common!(data)
+        when 'flickr.photos.getNotInSet'
+          fix_common!(data)
+        when 'flickr.people.getPhotosOf'
+          fix_common!(data)
+        when 'flickr.photos.getPerms'
+          fix_visibility!(data['perms'])
+          data['perms']['permissions'] = {
+            'permcomment' => data['perms'].delete('permcomment'),
+            'permaddmeta' => data['perms'].delete('permaddmeta')
+          }
+        when 'flickr.photos.getRecent'
+          fix_common!(data)
+        when 'flickr.photos.getUntagged'
+          fix_common!(data)
+        when 'flickr.photos.getWithGeoData'
+          fix_common!(data)
+        when 'flickr.photos.getWithoutGeoData'
+          fix_common!(data)
+        when 'flickr.photos.recentlyUpdated'
+          fix_common!(data)
+
+        # photosets
+        when 'flickr.photosets.getInfo'
+          data['photoset']['title'] = data['photoset']['title']['_content']
+          data['photoset']['description'] = data['photoset']['description']['_content']
+        when 'flickr.photosets.getList'
+          data['photosets']['photoset'].map! do |set_hash|
+            set_hash['count_photos'] = set_hash.delete('photos')
+            set_hash['count_videos'] = set_hash.delete('videos')
+            set_hash['title'] = set_hash['title']['_content']
+            set_hash['description'] = set_hash['description']['_content']
+            set_hash['owner'] = query['user_id'].first
+            set_hash
+          end
+        end
+      end
+
+      def fix_extras!(hash)
+        if hash['iconserver'] or hash['iconfarm']
+          hash['owner'] ||= {}
+          hash['owner'].update \
+            'iconserver' => hash.delete('iconserver'),
+            'iconfarm' => hash.delete('iconfarm')
+        end
+
+        if hash['place_id']
+          geo_info = %w[latitude longitude accuracy context place_id woeid]
+          hash['location'] = geo_info.inject({}) do |location, geo|
+            location.update(geo => hash.delete(geo))
+          end
+          hash['geoperms'] = {
+            'isfamily' => hash['geo_is_family'],
+            'isfriend' => hash['geo_is_friend'],
+            'iscontact' => hash['geo_is_contact'],
+            'ispublic' => hash['geo_is_public']
+          }
+        end
+
+        if hash['tags']
+          hash['tags'] = hash['tags'].split(' ').map do |tag_content|
+            {'_content' => tag_content, 'machine_tag' => 0}
+          end
+        end
+        if hash['machine_tags']
+          hash['tags'] ||= []
+          hash['tags'] += hash.delete('machine_tags').split(' ').map do |tag_content|
+            {'_content' => tag_content, 'machine_tag' => 1}
+          end
+        end
+
+        hash['dates'] = {
+          'uploaded' => hash.delete('dateupload'),
+          'lastupdate' => hash.delete('lastupdate'),
+          'taken' => hash.delete('datetaken'),
+          'takengranularity' => hash.delete('datetakengranularity'),
+        }
+      end
+
+      def fix_visibility!(hash)
+        hash['visibility'] = {
+          'ispublic' => hash.delete('ispublic'),
+          'isfriend' => hash.delete('isfriend'),
+          'isfamily' => hash.delete('isfamily')
+        }
+      end
+
+      def fix_common!(hash)
+        hash['photos']['photo'].map! do |media_hash|
+          media_hash['owner'] = {
+            'id' => media_hash['owner'],
+            'nsid' => media_hash.delete('owner'),
+            'username' => media_hash.delete('ownername')
+          }
+          fix_extras!(media_hash)
+          fix_visibility!(media_hash)
+          media_hash
+        end
+      end
+    end
+  end
+end