flickrmocks 0.8.15 → 0.9.0

data/lib/flickr_mocks/models/commons_institutions.rb

@@ -1,98 +1,108 @@
 
 module FlickrMocks
-  class CommonsInstitutions
-    attr_accessor :per_page,:current_page
-    
-    @defaults =  FlickrMocks::Models::Helpers.paging_defaults.clone
+  module Models
+    class CommonsInstitutions
+      attr_accessor :per_page,:current_page
+
+      class << self
+        attr_writer :defaults
+        def defaults
+          @defaults ||= FlickrMocks::Models::Helpers.paging_defaults().clone
+          @defaults
+        end
+      end
 
-    class << self
-      attr_accessor :defaults
-    end
+      def initialize(institutions,options={})
+        self.delegated_to_object = institutions
+        self.per_page = extract_per_page(options)
+        self.current_page = extract_current_page(options)
+      end
 
-    def initialize(institutions,options={})
-      self.delegated_to_object = institutions
-      self.per_page = options[:per_page]
-      self.current_page = options[:current_page]
-    end
+      # returns the sanitized value stored in :per_page key in the options hash.
+      def  extract_per_page(options)
+        Api::Sanitize.per_page_hash(options)
+      end
 
-    def default(value)
-      CommonsInstitutions.defaults[value.to_s.to_sym]
-    end
+      # returns the sanitized value stored in the :page key in the options hash.
+      def extract_current_page(options)
+        Api::Sanitize.page(options[:current_page] || options[:page])
+      end
 
-    def ==(other)
-      per_page == other.per_page and
-      current_page == other.current_page and
-      @delegated_to_object == other.instance_eval('@delegated_to_object')
-    end
+      # returns the default value stored in the
+      def default(value)
+        CommonsInstitutions.defaults[value.to_s.to_sym]
+      end
 
-    def initialize_copy(orig)
-      super
-      @delegated_to_object = @delegated_to_object.clone
-    end
-    
-    def delegated_instance_methods
-      FlickrMocks::Models::Helpers.array_accessor_methods
-    end
+      def ==(other)
+        per_page == other.per_page and
+          current_page == other.current_page and
+          @delegated_to_object == other.instance_eval('@delegated_to_object')
+      end
 
-    def method_missing(id,*args,&block)
-      return @delegated_to_object.send(id,*args,&block) if delegated_instance_methods.include?(id)
-      super
-    end
+      def initialize_copy(orig)
+        super
+        @delegated_to_object = @delegated_to_object.clone
+      end
 
-    alias :old_respond_to? :respond_to?
-    def respond_to?(method,type=false)
-      return true if delegated_instance_methods.include?(method)
-      old_respond_to?(method,type)
-    end
+      def delegated_instance_methods
+        FlickrMocks::Models::Helpers.array_accessor_methods
+      end
 
-    alias :old_methods :methods
-    def methods
-      delegated_instance_methods + old_methods
-    end
+      def method_missing(id,*args,&block)
+        return @delegated_to_object.send(id,*args,&block) if delegated_instance_methods.include?(id)
+        super
+      end
 
-    # custom cloning methods
-    def initialize_copy(orig)
-      super
-      @delegated_to_object = @delegated_to_object.map do |institution|
-        institution.clone
+      alias :old_respond_to? :respond_to?
+      def respond_to?(method,type=false)
+        return true if delegated_instance_methods.include?(method)
+        old_respond_to?(method,type)
       end
-    end
 
-    def total_entries
-      @delegated_to_object.size
-    end
+      alias :old_methods :methods
+      def methods
+        delegated_instance_methods + old_methods
+      end
 
-    def institutions
-      @delegated_to_object
-    end
+      # custom cloning methods
+      def initialize_copy(orig)
+        super
+        @delegated_to_object = @delegated_to_object.map do |institution|
+          institution.clone
+        end
+      end
 
-    def collection
-      ::WillPaginate::Collection.create(current_page, per_page, total_entries) do |obj|
-        start = (current_page-1)*per_page
-        obj.replace(institutions[start, per_page])
+      def total_entries
+        @delegated_to_object.size
       end
-    end
 
-    private
-    def delegated_to_object=(object)
-      raise ArgumentError, "FlickRaw::ResponseList expected" unless object.class == FlickRaw::ResponseList
-      @delegated_to_object = object.institution
-    end
+      def institutions
+        @delegated_to_object
+      end
 
-    def per_page=(value)
-      @per_page = value.to_i == 0 ? default(:per_page) : value.to_i
-    end
+      def collection
+        ::WillPaginate::Collection.create(current_page, per_page, total_entries) do |obj|
+          start = (current_page-1)*per_page
+          obj.replace(institutions[start, per_page])
+        end
+      end
+      private
+      def delegated_to_object=(object)
+        raise ArgumentError, "FlickRaw::ResponseList expected" unless object.class == FlickRaw::ResponseList
+        @delegated_to_object = object.institution
+      end
 
-    def current_page=(page)
-      @current_page = sanitize_page(page) > max_page ? max_page : sanitize_page(page)
-    end
+      def per_page=(value)
+        @per_page = value.to_i == 0 ? default(:per_page) : value.to_i
+      end
 
-    def max_page
-      (total_entries  / @per_page.to_f).ceil == 0 ? 1 : (total_entries  / @per_page.to_f).ceil
-    end
+      def current_page=(page)
+        @current_page = Api::Sanitize.page(page).to_i > max_page ? max_page : Api::Sanitize.page(page).to_i
+      end
 
-    def sanitize_page(page)
-      page.to_i < 1 ? 1 : page.to_i
+      def max_page
+        (total_entries  / @per_page.to_f).ceil == 0 ? 1 : (total_entries  / @per_page.to_f).ceil
+      end
     end
   end
-end
+end

data/lib/flickr_mocks/models/helpers.rb

@@ -1,23 +1,30 @@
 module FlickrMocks
   module Models
-    module Helpers
 
+    # module contains methods that are used internally by the various class wrappers
+    # for the FlickRaw::Response and FlickRaw::ResponseList objects.
+    module Helpers
+      # returns list of array methods. These methods are often used for mimicking
+      # array like behavior to classes.
       def self.array_accessor_methods
         [:[], :first, :last,:empty?,:length,:size,:each,:each_index,
          :each_with_index,:map, :select, :keep_if,:at,:fetch, :reverse_each,
          :find_index, :index,:rindex, :collect,:values_at]
       end
 
+
+      # returns the default values for paging Flickr objects
       def self.paging_defaults
         {
-          :max_entries => 4000,
-          :per_page => 50,
-          :current_page => 1
+          :max_entries => ::FlickrMocks::Api.default(:max_entries).to_i,
+          :per_page => ::FlickrMocks::Api.default(:per_page).to_i,
+          :current_page => ::FlickrMocks::Api.default(:page).to_i
         }
       end
-
+      
+      # returns list of sizes that a Flickr photo can have
       def self.possible_sizes
-        [:square, :thumbnail, :small, :medium, :medium_640, :large, :original]
+        ::FlickrMocks::Api.default(:possible_sizes)
       end
     end
   end

data/lib/flickr_mocks/models/models.rb

@@ -0,0 +1,7 @@
+module FlickrMocks
+  # wrapper module that contains the classes that wrap the FlickRaw::Response and
+  # FlickRaw::ResponseList objects.
+  module Models
+
+  end
+end

data/lib/flickr_mocks/models/photo.rb

@@ -1,101 +1,102 @@
 module FlickrMocks
+  module Models
+    class Photo
+      def initialize(photo)
+        self.delegated_to_object = photo
+        @delegated_instance_methods = @delegated_to_object.methods(false).push(:flickr_type)
+        @extended_photo = photo.methods.include?(:originalsecret)
+      end
 
-  class Photo
-    def initialize(photo)
-      self.delegated_to_object = photo
-      @delegated_instance_methods = @delegated_to_object.methods(false).push(:flickr_type)
-      @extended_photo = photo.methods.include?(:originalsecret)
-    end
-
-    # Return urls for various sizes
-    def square
-      FlickRaw.url_s self
-    end
+      # Return urls for various sizes
+      def square
+        FlickRaw.url_s self
+      end
 
-    def original
-      respond_to?(:originalsecret) ? FlickRaw.url_o(self) : nil
-    end
+      def original
+        respond_to?(:originalsecret) ? FlickRaw.url_o(self) : nil
+      end
 
-    def thumbnail
-      FlickRaw.url_t self
-    end
+      def thumbnail
+        FlickRaw.url_t self
+      end
 
-    def small
-      FlickRaw.url_m self
-    end
+      def small
+        FlickRaw.url_m self
+      end
 
-    def medium
-      FlickRaw.url self
-    end
+      def medium
+        FlickRaw.url self
+      end
 
-    def large
-      FlickRaw.url_b self
-    end
+      def large
+        FlickRaw.url_b self
+      end
 
-    def medium_640
-      FlickRaw.url_z self
-    end
+      def medium_640
+        FlickRaw.url_z self
+      end
 
-    def owner_url
-      FlickRaw.url_photopage self
-    end
+      def owner_url
+        FlickRaw.url_photopage self
+      end
 
 
-    def owner_id
-      case owner
-      when String then owner
-      else
-        return owner.nsid if owner.respond_to?(:nsid)
-        return owner.to_s
+      def owner_id
+        case owner
+        when String then owner
+        else
+          return owner.nsid if owner.respond_to?(:nsid)
+          return owner.to_s
+        end
       end
-    end
 
-    def photo_id
-      id
-    end
+      def photo_id
+        id
+      end
 
-    def usable?
-      license.to_i > 3
-    end
+      def usable?
+        license.to_i > 3
+      end
 
-    def ==(other)
-      @delegated_to_object == other.instance_eval('@delegated_to_object')
-    end
+      def ==(other)
+        @delegated_to_object == other.instance_eval('@delegated_to_object')
+      end
 
-    def initialize_copy(orig)
-      super
-      @delegated_to_object = @delegated_to_object.clone
-    end
+      def initialize_copy(orig)
+        super
+        @delegated_to_object = @delegated_to_object.clone
+      end
 
-    def delegated_instance_methods
-      @delegated_instance_methods
-    end
+      def delegated_instance_methods
+        @delegated_instance_methods
+      end
 
 
-    def method_missing(id,*args,&block)
-      return @delegated_to_object.send(id,*args,&block) if delegated_instance_methods.include?(id)
-      return medium_640 if id.to_sym == :'medium 640'
-      super
-    end
+      def method_missing(id,*args,&block)
+        return @delegated_to_object.send(id,*args,&block) if delegated_instance_methods.include?(id)
+        return medium_640 if id.to_sym == :'medium 640'
+        super
+      end
 
-    alias :old_respond_to? :respond_to?
-    def respond_to?(method,type=false)
-      return true if method.to_sym == :'medium 640'
-      return true if delegated_instance_methods.include?(method)
-      old_respond_to?(method,type)
-    end
+      alias :old_respond_to? :respond_to?
+      def respond_to?(method,type=false)
+        return true if method.to_sym == :'medium 640'
+        return true if delegated_instance_methods.include?(method)
+        old_respond_to?(method,type)
+      end
 
-    alias :old_methods :methods
-    def methods
-      delegated_instance_methods + old_methods
-    end
+      alias :old_methods :methods
+      def methods
+        delegated_instance_methods + old_methods
+      end
 
 
-    private
-    def delegated_to_object=(object)
-      raise ArgumentError, "FlickRaw::ResponseList expected" if object.class == FlickRaw::ResponseList
-      raise ArgumentError, 'FlickRaw::Response expected' unless object.class ==  FlickRaw::Response
-      @delegated_to_object = object
+      private
+      def delegated_to_object=(object)
+        raise ArgumentError, "FlickRaw::ResponseList expected" if object.class == FlickRaw::ResponseList
+        raise ArgumentError, 'FlickRaw::Response expected' unless object.class ==  FlickRaw::Response
+        @delegated_to_object = object
+      end
     end
   end
 end

data/lib/flickr_mocks/models/photo_details.rb

@@ -1,90 +1,92 @@
 module FlickrMocks
-  class PhotoDetails
-    attr_reader :dimensions
+  module Models
+    class PhotoDetails
+      attr_reader :dimensions
     
-    def initialize(photo,dimensions)
-      self.dimensions = dimensions
-      self.delegated_to_object=  photo
-      raise ArgumentError 'owner id for photo did not match owner id for at least one size' unless valid_owner_for_dimensions?
-    end
-
-    def author
-      owner_name.empty? ? owner_username : owner_name
-    end
-
-    def owner_name
-      self.owner.realname
-    end
+      def initialize(photo,dimensions)
+        self.dimensions = dimensions
+        self.delegated_to_object=  photo
+        raise ArgumentError 'owner id for photo did not match owner id for at least one size' unless valid_owner_for_dimensions?
+      end
+
+      def author
+        owner_name.empty? ? owner_username : owner_name
+      end
+
+      def owner_name
+        self.owner.realname
+      end
     
-    def owner_username
-      self.owner.username
-    end
+      def owner_username
+        self.owner.username
+      end
     
-    def dimensions
-      @dimensions
-    end
+      def dimensions
+        @dimensions
+      end
 
-    def photo
-      @delegated_to_object
-    end
+      def photo
+        @delegated_to_object
+      end
 
-    def possible_sizes
-      FlickrMocks::Models::Helpers.possible_sizes
-    end
+      def possible_sizes
+        FlickrMocks::Models::Helpers.possible_sizes
+      end
 
-    def ==(other)
-      return false unless other.class == PhotoDetails
-      (dimensions == other.dimensions) && (@delegated_to_object == other.instance_eval('@delegated_to_object'))
-    end
+      def ==(other)
+        return false unless other.class == PhotoDetails
+        (dimensions == other.dimensions) && (@delegated_to_object == other.instance_eval('@delegated_to_object'))
+      end
 
-    # metaprogramming methods
-    def method_missing(id,*args,&block)
-      return dimensions.sizes.send(id,*args,&block) if array_accessor_methods.include?(id)
-      return @delegated_to_object.send(id,*args,&block) if delegated_instance_methods.include?(id)
-      super
-    end
+      # metaprogramming methods
+      def method_missing(id,*args,&block)
+        return dimensions.sizes.send(id,*args,&block) if array_accessor_methods.include?(id)
+        return @delegated_to_object.send(id,*args,&block) if delegated_instance_methods.include?(id)
+        super
+      end
 
-    alias :old_respond_to? :respond_to?
-    def respond_to?(method,type=false)
-      delegated_instance_methods.include?(method) || old_respond_to?(method)
-    end
+      alias :old_respond_to? :respond_to?
+      def respond_to?(method,type=false)
+        delegated_instance_methods.include?(method) || old_respond_to?(method)
+      end
 
-    alias :old_methods :methods
-    def methods
-      delegated_instance_methods + old_methods
-    end
+      alias :old_methods :methods
+      def methods
+        delegated_instance_methods + old_methods
+      end
 
-    def delegated_instance_methods
-      @delegated_to_object.delegated_instance_methods + array_accessor_methods + [:owner_id] + possible_sizes
-    end
+      def delegated_instance_methods
+        @delegated_to_object.delegated_instance_methods + array_accessor_methods + [:owner_id] + possible_sizes
+      end
 
-    # custom cloning methods
-    def initialize_copy(orig)
-      super
-      @dimensions = @dimensions.clone
-      @delegated_to_object = @delegated_to_object.clone
-    end
+      # custom cloning methods
+      def initialize_copy(orig)
+        super
+        @dimensions = @dimensions.clone
+        @delegated_to_object = @delegated_to_object.clone
+      end
 
 
 
-    private
-    def dimensions=(object)
-      @dimensions = object.class == PhotoSizes ?  object : PhotoSizes.new(object)
-    end
+      private
+      def dimensions=(object)
+        @dimensions = object.class == PhotoSizes ?  object : PhotoSizes.new(object)
+      end
 
-    def delegated_to_object=(object)
-      @delegated_to_object = object.is_a?(Photo) ?  object : Photo.new(object)
-    end
+      def delegated_to_object=(object)
+        @delegated_to_object = object.is_a?(Photo) ?  object : Photo.new(object)
+      end
 
-    def valid_owner_for_dimensions?
-      dimensions.map do |size|
-        photo.id == size.id
-      end.inject(true) do |prev,cur| prev && cur end
-    end
+      def valid_owner_for_dimensions?
+        dimensions.map do |size|
+          photo.id == size.id
+        end.inject(true) do |prev,cur| prev && cur end
+      end
 
-    def array_accessor_methods
-      FlickrMocks::Models::Helpers.array_accessor_methods
-    end
+      def array_accessor_methods
+        FlickrMocks::Models::Helpers.array_accessor_methods
+      end
 
+    end
   end
 end