flickr-objects 0.2.0 → 0.3.0

data/lib/flickr/object/attribute_locations/photo.rb

@@ -0,0 +1,164 @@
+require "flickr/base_converter"
+
+module Flickr
+  class Object
+
+    class Photo
+
+      attributes.add_locations(
+        uploaded_at: [
+          -> { @attributes["dateuploaded"] },
+          -> { @attributes["dateupload"] },
+        ],
+        favorite: [
+          -> { @attributes["isfavorite"] },
+        ],
+        posted_at: [
+          -> { @attributes["dates"]["posted"] },
+        ],
+        taken_at: [
+          -> { @attributes["dates"]["taken"] },
+          -> { @attributes["datetaken"] }
+        ],
+        taken_at_granularity: [
+          -> { @attributes["dates"]["takengranularity"] },
+          -> { @attributes["datetakengranularity"] },
+        ],
+        updated_at: [
+          -> { @attributes["dates"]["lastupdate"] },
+          -> { @attributes["lastupdate"] },
+        ],
+        views_count: [
+          -> { @attributes["views"] },
+        ],
+        public_editability: [
+          -> { @attributes["publiceditability"] },
+        ],
+        comments_count: [
+          -> { @attributes["comments"]["_content"] },
+        ],
+        has_people: [
+          -> { @attributes["people"]["haspeople"] },
+        ],
+        safe: [
+          -> { safety_level <= 1 },
+        ],
+        moderate: [
+          -> { safety_level == 2 },
+        ],
+        restricted: [
+          -> { safety_level == 3 },
+        ],
+        notes: [
+          -> { @attributes["notes"]["note"] },
+        ],
+        tags: [
+          -> {
+            @attributes["tags"]["tag"].map do |hash|
+              hash.merge("photo_id" => id)
+            end
+          },
+          -> {
+            tags = @attributes["tags"].split(" ").map do |content|
+              {"_content" => content, "machine_tag" => 0}
+            end
+            machine_tags = @attributes["machine_tags"].split(" ").map do |content|
+              {"_content" => content, "machine_tag" => 1}
+            end
+
+            tags + machine_tags
+          },
+        ],
+        visibility: [
+          -> {
+            {
+              "ispublic" => @attributes.fetch("ispublic"),
+              "isfriend" => @attributes.fetch("isfriend"),
+              "isfamily" => @attributes.fetch("isfamily"),
+            }
+          }
+        ],
+        title: [
+          -> { @attributes["title"]["_content"] },
+        ],
+        description: [
+          -> { @attributes["description"]["_content"] },
+        ],
+        owner: [
+          -> {
+            if @attributes["owner"].is_a?(String)
+              {
+                "nsid"       => @attributes["owner"],
+                "username"   => @attributes["ownername"] || @attributes["username"],
+                "iconserver" => @attributes["iconserver"],
+                "iconfarm"   => @attributes["iconfarm"],
+              }
+            end
+          },
+        ],
+        path_alias: [
+          -> { @attributes["pathalias"] },
+        ],
+        location_visibility: [
+          -> { @attributes["geoperms"] },
+          -> {
+            {
+              "isfamily"  => @attributes.fetch("geo_is_family"),
+              "isfriend"  => @attributes.fetch("geo_is_friend"),
+              "iscontact" => @attributes.fetch("geo_is_contact"),
+              "ispublic"  => @attributes.fetch("geo_is_public"),
+            }
+          }
+        ],
+        location: [
+          -> {
+            {
+              "latitude"  => @attributes.fetch("latitude"),
+              "longitude" => @attributes.fetch("longitude"),
+              "accuracy"  => @attributes["accuracy"],
+              "context"   => @attributes["context"],
+              "place_id"  => @attributes["place_id"],
+              "woeid"     => @attributes["woeid"],
+            }
+          },
+        ],
+        available_sizes: [
+          -> {
+            sizes = Size.all.select do |size|
+              @attributes["url_#{size.abbreviation}"] or
+              @attributes["sizes"] && @attributes["sizes"]["size"].find { |h| h["label"] == size.label }
+            end
+
+            sizes.map(&:name)
+          },
+        ],
+        largest_size: [
+          -> { available_sizes.last },
+        ],
+        rotation: [
+          -> { @attributes["rotation"] },
+        ],
+        source_url: [
+          -> { @attributes["url_#{@size.abbreviation}"] },
+          -> { @attributes["sizes"]["size"].find { |hash| hash["label"] == @size.label }["source"] }
+        ],
+        height: [
+          -> { @attributes["height_#{@size.abbreviation}"] },
+          -> { @attributes["sizes"]["size"].find { |hash| hash["label"] == @size.label }["height"] }
+        ],
+        width: [
+          -> { @attributes["width_#{@size.abbreviation}"] },
+          -> { @attributes["sizes"]["size"].find { |hash| hash["label"] == @size.label }["width"] }
+        ],
+        url: [
+          -> { "http://www.flickr.com/photos/#{owner.id}/#{id}" if owner.id && id },
+        ],
+        short_url: [
+          -> { "http://flic.kr/p/#{BaseConverter.to_base58(id)}" if id },
+        ],
+      )
+
+    end
+
+  end
+end

data/lib/flickr/object/attribute_locations/set.rb

@@ -0,0 +1,53 @@
+module Flickr
+  class Object
+
+    class Set
+
+      attributes.add_locations(
+        owner: [
+          -> {
+            if @attributes["owner"]
+              {
+                "id"       => @attributes["owner"],
+                "username" => @attributes["username"],
+              }
+            end
+          },
+        ],
+        url: [
+          -> { "http://www.flickr.com/photos/#{owner.id}/sets/#{id}" },
+        ],
+        photos_count: [
+          -> { @attributes["photos"] },
+          -> { @attributes["count_photos"] },
+        ],
+        views_count: [
+          -> { @attributes["count_views"] },
+        ],
+        comments_count: [
+          -> { @attributes["count_comments"] },
+        ],
+        title: [
+          -> { @attributes["title"]["_content"] },
+        ],
+        description: [
+          -> { @attributes["description"]["_content"] },
+        ],
+        permissions: [
+          -> { {"can_comment" => @attributes["can_comment"]} },
+        ],
+        created_at: [
+          -> { @attributes["date_create"] },
+        ],
+        updated_at: [
+          -> { @attributes["date_update"] },
+        ],
+        primary_photo: [
+          -> { {"id" => @attributes.fetch("primary")} },
+        ],
+      )
+
+    end
+
+  end
+end

data/lib/flickr/object/attribute_locations/upload_ticket.rb

@@ -0,0 +1,30 @@
+module Flickr
+  class Object
+
+    class UploadTicket
+
+      attributes.add_locations(
+        status: [
+          -> { @attributes["complete"] },
+        ],
+        complete: [
+          -> { status == 1 },
+        ],
+        failed: [
+          -> { status == 2 },
+        ],
+        invalid: [
+          -> { @attributes["invalid"] || 0},
+        ],
+        valid: [
+          -> { not invalid? },
+        ],
+        photo: [
+          -> { {"id" => @attributes.fetch("photoid")} },
+        ],
+      )
+
+    end
+
+  end
+end

data/lib/flickr/object/attribute_locations/visibility.rb

@@ -0,0 +1,24 @@
+module Flickr
+  class Object
+
+    class Visibility
+
+      attributes.add_locations(
+        public: [
+          -> { @attributes["ispublic"] },
+        ],
+        friends: [
+          -> { @attributes["isfriend"] },
+        ],
+        family: [
+          -> { @attributes["isfamily"] },
+        ],
+        contacts: [
+          -> { @attributes["iscontact"] },
+        ],
+      )
+
+    end
+
+  end
+end

data/lib/flickr/object/list/kaminari.rb

@@ -0,0 +1,30 @@
+require "kaminari"
+require "kaminari/models/array_extension"
+
+module Flickr
+  class Object
+
+    class List < Kaminari::PaginatableArray
+
+      ##
+      # @private
+      #
+      def initialize(attributes)
+        raise ArgumentError, "attributes should not be nil" if attributes.nil?
+
+        @attributes = attributes
+        super([], offset: current_page, limit: per_page, total_count: total_entries)
+      end
+
+      ##
+      # @private
+      #
+      def populate(objects)
+        replace(objects)
+        self
+      end
+
+    end
+
+  end
+end

data/lib/flickr/object/list/normal.rb

@@ -0,0 +1,27 @@
+module Flickr
+  class Object
+
+    class List < Array
+
+      ##
+      # @private
+      #
+      def initialize(attributes)
+        raise ArgumentError, "attributes should not be nil" if attributes.nil?
+
+        @attributes = attributes
+        super()
+      end
+
+      ##
+      # @private
+      #
+      def populate(objects)
+        replace(objects)
+        self
+      end
+
+    end
+
+  end
+end

data/lib/flickr/object/list/will_paginate.rb

@@ -0,0 +1,31 @@
+require "will_paginate/collection"
+
+module Flickr
+  class Object
+
+    class List < WillPaginate::Collection
+
+      ##
+      # @private
+      #
+      def initialize(attributes)
+        raise ArgumentError, "attributes should not be nil" if attributes.nil?
+
+        @attributes = attributes
+        @attributes = {"page" => 1, "per_page" => 1, "total" => 1} if @attributes.empty?
+
+        super(current_page, per_page, total_entries)
+      end
+
+      ##
+      # @private
+      #
+      def populate(objects)
+        replace(objects)
+        self
+      end
+
+    end
+
+  end
+end

data/lib/flickr/object/list.rb

@@ -0,0 +1,87 @@
+require "flickr/object/list/#{Flickr.pagination || "normal"}"
+require "flickr/attributes"
+
+module Flickr
+  class Object
+
+    ##
+    # Flickr offers pagination when returning collection responses, so this
+    # class encapsulates this data, and also provides useful finder methods,
+    # similar to ActiveRecord's.
+    #
+    class List
+
+      extend Flickr::Attributes
+
+      attribute :current_page,  Integer
+      attribute :per_page,      Integer
+      attribute :total_pages,   Integer
+      attribute :total_entries, Integer
+
+      ##
+      # @see Flickr::Object#attributes
+      #
+      attr_reader :attributes
+
+      ##
+      # If block is given, does a regular Enumerable#find, otherwise finds by
+      # ID(s).
+      #
+      # @param id_or_ids [String, Array<String>] ID(s) of the object(s) to find.
+      # @return [Flickr::Object, Array<Flickr::Object>, nil]
+      #
+      def find(id_or_ids = nil)
+        return super if block_given?
+
+        if id_or_ids.is_a?(Enumerable)
+          id_or_ids.map { |id| find(id) }
+        else
+          find_by(id: id_or_ids.to_s)
+        end
+      end
+
+      ##
+      # Finds by a hash of attributes. Supports nesting (see the example).
+      #
+      # @param attributes [Hash] Attributes by which to search.
+      # @return [Flickr::Object, nil]
+      # @example
+      #   photos.find_by(id: "1", owner: {username: "janko"})
+      #
+      def find_by(attributes)
+        find { |object| object.matches?(attributes) }
+      end
+
+      ##
+      # Filters by a hash of attributes. Supports nesting (see the example).
+      #
+      # @param attributes [Hash] Attributes by which to search
+      # @return [Array<Flickr::Object>]
+      # @example
+      #   photos.filter(owner: {username: "janko"})
+      #
+      def filter(attributes)
+        select { |object| object.matches?(attributes) }
+      end
+
+      ##
+      # @deprecated It provides #find_by_<attribute> methods, but they are now
+      #   deprecated in favor of the obviously superior {#find_by} (repeating
+      #   ActiveRecord's mistake :P).
+      #
+      def method_missing(name, *args, &block)
+        if name.to_s =~ /find_by_\w+/
+          Flickr.deprecation_warn "#find_by_<attribute>(<value>) is deprecated; use #find_by(:<attribute> => <value>) instead"
+          attribute_name = name[/(?<=find_by_)\w+/]
+          find { |object| object.send(attribute_name) == args.first }
+        else
+          super
+        end
+      end
+
+    end
+
+  end
+end
+
+require_relative "attribute_locations/list"

data/lib/flickr/object/location.rb

@@ -0,0 +1,35 @@
+module Flickr
+  class Object
+
+    class Location < Flickr::Object
+
+      class Area < Flickr::Object
+
+        attribute :name,     String
+        attribute :place_id, String
+        attribute :woe_id,   String
+
+      end
+
+      attribute :latitude,      Float
+      attribute :longitude,     Float
+      attribute :accuracy,      Integer
+      attribute :context,       Integer
+      attribute :place_id,      String
+      attribute :woe_id,        String
+
+      attribute :indoors,       Boolean
+      attribute :outdoors,      Boolean
+
+      attribute :neighbourhood, Area
+      attribute :locality,      Area
+      attribute :county,        Area
+      attribute :region,        Area
+      attribute :country,       Area
+
+    end
+
+  end
+end
+
+require_relative "attribute_locations/location"

data/lib/flickr/object/permissions.rb

@@ -0,0 +1,18 @@
+module Flickr
+  class Object
+
+    class Permissions < Flickr::Object
+
+      attribute :can_comment,  Boolean
+      attribute :can_add_meta, Boolean
+      attribute :can_download, Boolean
+      attribute :can_blog,     Boolean
+      attribute :can_print,    Boolean
+      attribute :can_share,    Boolean
+
+    end
+
+  end
+end
+
+require_relative "attribute_locations/permissions"

data/lib/flickr/object/person/upload_status.rb

@@ -0,0 +1,22 @@
+module Flickr
+  class Object
+    class Person
+
+      class UploadStatus < Flickr::Object
+
+        class Month < Object
+          attribute :maximum,   Integer
+          attribute :used,      Integer
+          attribute :remaining, Integer
+        end
+
+        attribute :current_month,      Month
+        attribute :maximum_photo_size, Integer
+
+      end
+
+    end
+  end
+end
+
+require_relative "../attribute_locations/person/upload_status"

data/lib/flickr/object/person.rb

@@ -0,0 +1,93 @@
+module Flickr
+  class Object
+
+    class Person < Flickr::Object
+
+      autoload_names :UploadStatus
+
+      attribute :id,                   String
+      attribute :nsid,                 String
+      attribute :username,             String
+      attribute :real_name,            String
+      attribute :location,             String
+      attribute :time_zone,            Hash
+      attribute :description,          String
+      attribute :has_pro_account,      Boolean
+
+      attribute :icon_server,          Integer
+      attribute :icon_farm,            Integer
+      attribute :buddy_icon_url,       String
+
+      attribute :photos_url,           String
+      attribute :profile_url,          String
+      attribute :mobile_url,           String
+
+      attribute :first_photo_taken,    Time
+      attribute :first_photo_uploaded, Time
+      attribute :favorited_at,         Time
+
+      attribute :photos_count,         Integer
+      attribute :photo_views_count,    Integer
+
+      attribute :path_alias,           String
+
+      ##
+      # @return [self]
+      # @see Flickr::Api::Person#get_info
+      #
+      def get_info!(params = {})
+        person = api.get_info(id, params)
+        update(person.attributes)
+      end
+
+      ##
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @see Flickr::Api::Person#get_photos
+      #
+      def get_photos(params = {})
+        api.get_photos(id, params)
+      end
+      alias photos get_photos
+
+      ##
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @see Flickr::Api::Person#get_photos_of
+      #
+      def get_photos_of(params = {})
+        api.get_photos_of(id, params)
+      end
+      alias photos_of get_photos_of
+
+      ##
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @see Flickr::Api::Person#get_public_photos
+      #
+      def get_public_photos(params = {})
+        api.get_public_photos(id, params)
+      end
+      alias public_photos get_public_photos
+
+      ##
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @see Flickr::Api::Person#get_public_photos_from_contacts
+      #
+      def get_public_photos_from_contacts(params = {})
+        api.get_public_photos_from_contacts(id, params)
+      end
+      alias public_photos_from_contacts get_public_photos_from_contacts
+
+      ##
+      # @return [Flickr::Object::List<Flickr::Object::Set>]
+      # @see Flickr::Api::Person#get_sets
+      #
+      def get_sets(params = {})
+        api.get_sets(id, params)
+      end
+      alias sets get_sets
+
+    end
+
+  end
+end
+
+require_relative "attribute_locations/person"

data/lib/flickr/object/photo/exif.rb

@@ -0,0 +1,35 @@
+module Flickr
+  class Object
+    class Photo
+
+      class Exif < Flickr::Object
+
+        class Item < Object
+          attribute :tagspace,    String
+          attribute :tagspace_id, String
+          attribute :tag,         String
+          attribute :label,       String
+          attribute :raw,         String
+          attribute :clean,       String
+        end
+
+        attribute :items,  List[Item]
+
+        ##
+        # Fetches the item with the given label and grabs the value.
+        #
+        # @param label [String] Label of the exif data
+        # @return [String]
+        #
+        def [](label)
+          item = items.find { |item| item.label == label }
+          item.clean || item.raw
+        end
+
+      end
+
+    end
+  end
+end
+
+require_relative "../attribute_locations/photo/exif"

data/lib/flickr/object/photo/note.rb

@@ -0,0 +1,20 @@
+module Flickr
+  class Object
+    class Photo
+
+      class Note < Flickr::Object
+
+        attribute :id,          String
+        attribute :author,      Person
+        attribute :coordinates, Array[Integer]
+        attribute :width,       Integer
+        attribute :height,      Integer
+        attribute :content,     String
+
+      end
+
+    end
+  end
+end
+
+require_relative "../attribute_locations/photo/note"