flickrie 1.5.0 → 1.5.1

data/lib/flickrie/middleware/retry.rb

@@ -0,0 +1,23 @@
+module Flickrie
+  module Middleware
+    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
+  end
+end

data/lib/flickrie/{location.rb → objects/location.rb}

@@ -6,13 +6,13 @@ module Flickrie
     #   :country, :place_id, :woeid, :hash
 
     # @return [Fixnum]
-    def latitude()  @info['latitude']  end
+    def latitude()  @hash['latitude']  end
     # @return [Fixnum]
-    def longitude() @info['longitude'] end
+    def longitude() @hash['longitude'] end
     # @return [String]
-    def accuracy()  @info['accuracy']  end
+    def accuracy()  @hash['accuracy']  end
     # @return [Fixnum]
-    def context()   Integer(@info['context']) rescue nil end
+    def context()   Integer(@hash['context']) rescue nil end
 
     # Returns a struct with attributes `#name`, `#place_id` and `#woeid`
     #
@@ -36,31 +36,31 @@ module Flickrie
     def country()       new_area('country')       end
 
     # @return [String]
-    def place_id() @info['place_id'] end
+    def place_id() @hash['place_id'] end
     # @return [String]
-    def woeid()    @info['woeid']    end
+    def woeid()    @hash['woeid']    end
 
-    def [](key) @info[key] end
+    def [](key) @hash[key] end
     # Returns the raw hash from the response. Useful if something isn't available by methods.
     #
     # @return [Hash]
-    def hash() @info end
+    def hash() @hash end
 
     private
 
-    def initialize(info = {})
-      raise ArgumentError if info.nil?
-      @info = info
+    def initialize(hash)
+      raise ArgumentError if hash.nil?
+      @hash = hash
     end
 
     def new_area(area_name)
-      if @info[area_name]
+      if @hash[area_name]
         area_class = Class.new(Struct.new(:name, :place_id, :woeid)) do
           def to_s
             name
           end
         end
-        info = @info[area_name]
+        info = @hash[area_name]
         area_class.new(info['_content'], info['place_id'], info['woeid'])
       end
     end

data/lib/flickrie/{media.rb → objects/media.rb}

@@ -1,9 +1,8 @@
-require 'flickrie/media/class_methods'
-require 'flickrie/media/visibility'
-require 'flickrie/media/note'
-require 'flickrie/media/tag'
-require 'flickrie/media/exif'
-require 'flickrie/location'
+require 'flickrie/objects/media/visibility'
+require 'flickrie/objects/media/note'
+require 'flickrie/objects/media/tag'
+require 'flickrie/objects/media/exif'
+require 'flickrie/objects/location'
 require 'date'
 
 module Flickrie
@@ -61,7 +60,7 @@ module Flickrie
     def geo_permissions() Visibility.new(@hash['geoperms']) rescue nil end
 
     # @return [Array<Flickrie::Media::Tag>]
-    def tags() @hash['tags'].map { |info| Tag.new(info) }     rescue nil end
+    def tags() @hash['tags'].map { |info| Tag.new(info, @api_caller) }     rescue nil end
     # @return [Array<Flickrie::Media::Tag>]
     def machine_tags() tags.select { |tag| tag.machine_tag? } rescue nil end
 
@@ -80,7 +79,7 @@ module Flickrie
     def taken_at_granularity() Integer(@hash['dates']['takengranularity']) rescue nil end
 
     # @return [Flickrie::User]
-    def owner() User.new(@hash['owner']) rescue nil end
+    def owner() User.new(@hash['owner'], @api_caller) if @hash['owner'] end
 
     # @return [Fixnum]
     def safety_level() Integer(@hash['safety_level']) rescue nil end
@@ -145,14 +144,14 @@ module Flickrie
     def faved?() Integer(@hash['is_faved']) == 1 rescue nil end
 
     # @return [Array<Flickrie::Media::Note>]
-    def notes() @hash['notes']['note'].map { |info| Note.new(info) } rescue nil end
+    def notes() @hash['notes']['note'].map { |info| Note.new(info, @api_caller) } rescue nil end
 
     # @return [Integer]
     def content_type() Integer(@hash['content_type']) rescue nil end
 
     # @return [Flickrie::Collection<Flickrie::User>]
     def favorites
-      collection = @hash['person'].map { |info| User.new(info) }
+      collection = @hash['person'].map { |info| User.new(info, @api_caller) }
       Collection.new(@hash).replace(collection)
     rescue
       nil
@@ -168,8 +167,7 @@ module Flickrie
     #
     # @return [self]
     def get_info(params = {})
-      media = Flickrie.send("get_#{media_type}_info", id, params)
-      @hash.deep_merge!(media.hash)
+      @hash.deep_merge!(@api_caller.send("get_#{media_type}_info", id, params).hash)
       self
     end
 
@@ -177,8 +175,7 @@ module Flickrie
     #
     # @return [self]
     def get_exif(params = {})
-      media = Flickrie.send("get_#{media_type}_exif", id, params)
-      @hash.deep_merge!(media.hash)
+      @hash.deep_merge!(@api_caller.send("get_#{media_type}_exif", id, params).hash)
       self
     end
 
@@ -186,13 +183,13 @@ module Flickrie
     #
     # @return [self]
     def get_favorites(params = {})
-      media = Flickrie.send("get_#{media_type}_favorites", id, params)
-      @hash.deep_merge!(media.hash)
+      @hash.deep_merge!(@api_caller.send("get_#{media_type}_favorites", id, params).hash)
       self
     end
 
-    def initialize(hash = {})
+    def initialize(hash, api_caller)
       @hash = hash
+      @api_caller = api_caller
     end
 
     private
@@ -201,16 +198,24 @@ module Flickrie
       self.class.name.split('::').last.downcase
     end
 
-    BASE58_ALPHABET = '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ'.chars.to_a.freeze
+    module ClassMethods
+      def new_collection(hash, api_caller)
+        collection = hash.delete('photo').map { |info| new(info, api_caller) }
+        Collection.new(hash).replace(collection)
+      end
+    end
+    extend ClassMethods
 
-    def to_base58(id)
-      id = Integer(id)
-      begin
-        id, remainder = id.divmod(58)
-        result = BASE58_ALPHABET[remainder] + (result || '')
-      end while id > 0
+    # @private
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
 
-      result
+    # @private
+    def self.new(hash, api_caller)
+      eval(hash['media'].capitalize).new(hash, api_caller)
     end
+
+    include Base58
   end
 end

data/lib/flickrie/{media → objects/media}/note.rb

@@ -6,34 +6,33 @@ module Flickrie
       #   :height, :hash
 
       # @return [String]
-      def id() @info['id'] end
+      def id() @hash['id'] end
       # @return [Flickrie::User]
-      def author() User.new('nsid' => @info['author'], 'username' => @info['authorname']) end
+      def author() User.new({'nsid' => @hash['author'], 'username' => @hash['authorname']}, @api_caller) end
       # @return [String]
-      def content() @info['_content'] end
+      def content() @hash['_content'] end
       # Returns a 2-element array, representing a point.
       #
       # @return [Array<Fixnum>]
-      def coordinates() [@info['x'].to_i, @info['y'].to_i] end
+      def coordinates() [@hash['x'].to_i, @hash['y'].to_i] end
       # @return [Fixnum]
-      def width() @info['w'].to_i end
+      def width() @hash['w'].to_i end
       # @return [Fixnum]
-      def height() @info['h'].to_i end
+      def height() @hash['h'].to_i end
 
       def to_s
         content
       end
 
-      def [](key) @info[key] end
+      def [](key) @hash[key] end
       # @return [Fixnum]
-      def hash() @info end
+      def hash() @hash end
 
       private
 
-      def initialize(info)
-        raise ArgumentError if info.nil?
-
-        @info = info
+      def initialize(hash, api_caller)
+        @hash = hash
+        @api_caller = api_caller
       end
     end
   end

data/lib/flickrie/{media → objects/media}/tag.rb

@@ -5,30 +5,31 @@ module Flickrie
       #   :id, :raw, :content, :machine_tag?, :author, :hash
 
       # @return [String]
-      def id()      @info['id']       end
+      def id()      @hash['id']       end
       # @return [String]
-      def raw()     @info['raw']      end
+      def raw()     @hash['raw']      end
       # @return [String]
-      def content() @info['_content'] end
+      def content() @hash['_content'] end
 
       # @return [Boolean]
       def machine_tag?
-        @info['machine_tag'].to_i == 1 if @info['machine_tag']
+        @hash['machine_tag'].to_i == 1 if @hash['machine_tag']
       end
 
       # @return [Flickrie::User]
       def author
-        User.new('nsid' => @info['author']) if @info['author']
+        User.new({'nsid' => @hash['author']}, @api_caller) if @hash['author']
       end
 
-      def [](key) @info[key] end
+      def [](key) @hash[key] end
       # @return [Hash]
-      def hash() @info end
+      def hash() @hash end
 
       private
 
-      def initialize(info)
-        @info = info
+      def initialize(hash, api_caller)
+        @hash = hash
+        @api_caller = api_caller
       end
 
       def to_s

data/lib/flickrie/objects/media/visibility.rb

@@ -0,0 +1,28 @@
+module Flickrie
+  module Media
+    class Visibility
+      # @!parse attr_reader \
+      #   :public?, :friends?, :family?, :contacts?, :hash
+
+      # @return [Boolean]
+      def public?()   @hash['ispublic'].to_i == 1 if @hash['ispublic']   end
+      # @return [Boolean]
+      def friends?()  @hash['isfriend'].to_i == 1 if @hash['isfriend']   end
+      # @return [Boolean]
+      def family?()   @hash['isfamily'].to_i == 1 if @hash['isfamily']   end
+      # @return [Boolean]
+      def contacts?() @hash['iscontact'].to_i == 1 if @hash['iscontact'] end
+
+      def [](key) @hash[key] end
+      # @return [Hash]
+      def hash() @hash end
+
+      private
+
+      def initialize(hash)
+        raise ArgumentError if hash.nil?
+        @hash = hash
+      end
+    end
+  end
+end

data/lib/flickrie/objects/media_context.rb

@@ -0,0 +1,17 @@
+module Flickrie
+  class MediaContext
+    # @return [Fixnum]
+    attr_reader :count
+    # @return [Flickrie::Photo, Flickrie::Video]
+    attr_reader :previous
+    # @return [Flickrie::Photo, Flickrie::Video]
+    attr_reader :next
+
+    def initialize(hash, api_caller)
+      count = hash['count']['_content'].to_i
+      previous = Media.new(hash['prevphoto'], api_caller) rescue nil
+      next_ = Media.new(hash['nextphoto'], api_caller) rescue nil
+      @count, @previous, @next = count, previous, next_
+    end
+  end
+end

data/lib/flickrie/objects/media_count.rb

@@ -0,0 +1,46 @@
+require 'date'
+
+module Flickrie
+  class MediaCount
+    # @!parse attr_reader \
+    #   :value, :date_range, :from, :to, :hash
+
+    def value() Integer(@hash['count']) rescue nil end
+
+    # @return [Range]
+    def date_range
+      dates = []
+      ['fromdate', 'todate'].each do |key|
+        if @hash[key] == @hash[key].to_i.to_s
+          dates << Time.at(Integer(@hash[key]))
+        else
+          dates << DateTime.parse(@hash[key]).to_time
+        end
+      end
+
+      dates.first..dates.last
+    end
+    alias time_interval date_range
+
+    # @return [Time]
+    def from() date_range.begin end
+    # @return [Time]
+    def to()   date_range.end   end
+
+    def [](key) @hash[key] end
+    # Returns the raw hash from the response. Useful if something isn't available by methods.
+    #
+    # @return [Hash]
+    def hash() @hash end
+
+    private
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def self.new_collection(hash)
+      hash['photocount'].map { |info| new(info) }
+    end
+  end
+end

data/lib/flickrie/{photo.rb → objects/photo.rb}

@@ -116,14 +116,13 @@ module Flickrie
     #
     # @return [self]
     def get_sizes(params = {})
-      photo = Flickrie.get_photo_sizes(id, params)
-      @hash.deep_merge!(photo.hash)
+      @hash.deep_merge!(@api_caller.get_photo_sizes(id, params).hash)
       largest!
     end
 
     private
 
-    def initialize(info = {})
+    def initialize(*args)
       super
       @size = largest_size
     end

data/lib/flickrie/{set.rb → objects/set.rb}

@@ -39,25 +39,25 @@ module Flickrie
     end
 
     # @return [Flickrie::User]
-    def owner() User.new('nsid' => @hash['owner']) if @hash['owner'] end
+    def owner() User.new({'nsid' => @hash['owner']}, @api_caller) if @hash['owner'] end
 
     # Same as calling `Flickrie.photos_from_set(set.id)`.
     #
     # @return [Flickrie::Collection<Flickrie::Photo>]
     def photos(params = {})
-      Flickrie.photos_from_set(id, params)
+      @api_caller.photos_from_set(id, params)
     end
     # Same as calling `Flickrie.videos_from_set(set.id)`.
     #
     # @return [Flickrie::Collection<Flickrie::Video>]
     def videos(params = {})
-      Flickrie.videos_from_set(id, params)
+      @api_caller.videos_from_set(id, params)
     end
     # Same as calling `Flickrie.media_from_set(set.id)`.
     #
     # @return [Flickrie::Collection<Flickrie::Photo, Flickrie::Video>]
     def media(params = {})
-      Flickrie.media_from_set(id, params)
+      @api_caller.media_from_set(id, params)
     end
 
     # @return [Boolean]
@@ -84,40 +84,19 @@ module Flickrie
     #
     # @return [self]
     def get_info(params = {})
-      hash ||= Flickrie.client.get_set_info(id, params).body['photoset']
-      self.class.fix_info(hash)
-      @hash.update(hash)
-
+      @hash.deep_merge!(@api_caller.get_set_info(id, params).hash)
       self
     end
 
     private
 
-    def initialize(hash = {})
+    def initialize(hash, api_caller)
       @hash = hash
+      @api_caller = api_caller
     end
 
-    def self.from_info(hash)
-      fix_info(hash)
-      new(hash)
-    end
-
-    def self.fix_info(hash)
-      hash['title'] = hash['title']['_content']
-      hash['description'] = hash['description']['_content']
-    end
-
-    def self.from_user(hash, user_nsid)
-      collection = hash.delete('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'] = user_nsid
-
-        new(set_hash)
-      end
-
+    def self.new_collection(hash, api_caller)
+      collection = hash.delete('photoset').map { |info| new(info, api_caller) }
       Collection.new(hash).replace(collection)
     end
   end