Contents

##
# NPR::Entity::Image
#
module NPR
  module Entity
    class Image < Base
      attr_accessor :id, :type, :width, :src, :hasBorder, :link
      shallow_attribute "title", "caption", "producer", "copyright"
      has_many "crops", :key => "crop", :class_name => NPR::Entity::Crop
      has_one "enlargement", :class_name => NPR::Entity::Enlargement
      has_one "provider", :class_name => NPR::Entity::Provider


      # NOTE that the "link" attribute here is not cast into a Link
      # object, and the "url" parameter is ignored. Instead, just
      # calling +image.link+ will return the URL parameter.
      def initialize(json)
        @id        = json["id"].to_i
        @type      = json["type"]
        @width     = json["width"].to_i
        @src       = json["src"]
        @hasBorder = json["hasBorder"] == "true"

        if json["link"]
          @link = json["link"]["url"]
        end

        extract_shallow_attributes(json)
        create_relations(json)
      end


      # Find a crop by its type.
      #
      # Arguments:
      #
      # * (String) type - the type of crop you're looking for
      #
      #
      # Examples:
      #
      #   image.crop("enlargement") #=> NPR::Entity::Crop
      #   image.crop("missing")     #=> nil
      #
      # Returns: An NPR::Entity::Crop, or nil if none found.
      def crop(type)
        self.crops.find { |c| c.type == type }
      end


      # Determine if this image is the primary image (as defined by NPR).
      #
      # Returns: Boolean
      def primary?
        @type == "primary"
      end


      # Determine if this image is the standard image (as defined by NPR).
      #
      # Returns: Boolean
      def standard?
        @type == "standard"
      end
    end # Image
  end # Entity
end # NPR

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
npr-3.0.0	lib/npr/entity/image.rb
npr-2.0.2	lib/npr/entity/image.rb
npr-2.0.1	lib/npr/entity/image.rb
npr-2.0.0	lib/npr/entity/image.rb
npr-1.2.0	lib/npr/entity/image.rb