flickrmocks 0.8.5

data/.autotest

@@ -0,0 +1,36 @@
+# Example taken from:  http://blog.davidchelimsky.net/category/autotest/
+#  	January 15th, 2008 entry
+#	
+#
+# Autotest.add_hook :initialize do |at|
+#  at.add_mapping(%r%^plugins/acts_as_currency/lib/.*\.rb$%) {
+#    at.files_matching %r%^spec/models/product_spec\.rb$% +
+#    at.files_matching %r%^plugins/acts_as_currency/spec/.*_spec\.rb$%
+#  }
+#end
+#
+# add_mapping: adds key/value pair to a hash that maps regexps to procs.
+#
+# Whenever autotest detects a file has changed it looks for a regexp that
+#	matches that file and runs ALL the files associated with the matching
+#	regular expression.
+#
+# In the example below any change to the plugins file directory will
+#	trigger all the specs in the plugin directory to run as well 
+#	as the spec for the product model.
+
+require 'autotest/timestamp'
+require 'autotest/restart'
+
+require 'test_notifier/runner/autotest'
+
+Autotest.add_hook(:initialize) do |at|
+  %w{.git .svn .hg tmp log doc .DS_Store ._* vendor nbproject}.each { |exception| autotest.add_exception(exception) }
+  
+  at.clear_mappings    # take out the default (test/test*rb)
+  
+  at.add_mappings %r%^lib/% do 
+  	at.files_matching %r%^spec/*/*_spec.rb% 
+  end
+end
+

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+nbproject
+config.yml

data/.rspec

@@ -0,0 +1,3 @@
+--color
+#--format documentation 
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2004-2010 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,59 @@
+== Welcome to FlickrMocks
+
+FlickrMocks makes it possible to Marshal responses generated from the FLickRaw
+gem. This is useful for Mocking/Stubbing the Flickr interface for testing
+purposes.
+
+The FlickRaw::Response and FlickRaw::ResponseList objects can not be Marshaled
+because they contain singleton's.
+
+== Getting Started
+
+1. Install flickrmocks:
+       <tt>gem install flickrmocks</tt>
+
+2. require 'flickrmocks'
+
+3. You should be able to Marshal/Unmarshal FlickRaw::Response and FlickRaw::ResponseList
+	classes. 
+
+	FlickRaw.api_key = 'xxx your flickr api key goes here'
+	a = flickr.photos.search :tags => 'dog'
+	b = Marshal.dump(a)
+	
+	Marshal.load(b) 
+		
+== Rails Installation (Test::Unit)
+
+Specify the gem dependency in your config/environment.rb file:
+
+  Rails::Initializer.run do |config|
+    config.gem "flickrmocks", :lib => "flickrmocks"
+  end
+
+Then:
+
+  $ rake gems:install
+  $ rake gems:unpack
+
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+
+== License
+
+FlickrMocks is released under the MIT license.
+
+== Copyright
+
+Copyright (c) 2010 Takaltoo.

data/Rakefile

@@ -0,0 +1,76 @@
+require 'rubygems'
+require 'rake'
+require File.expand_path(File.dirname(__FILE__) + '/lib/flickrmocks')
+
+# include all tasks
+Dir.glob("tasks/*.rb").each do |file|
+  require File.expand_path(File.dirname(__FILE__) + "/#{file}")
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "flickrmocks"
+    gem.summary = %Q{Enables FlickRaw responses to be Marshaled.}
+    gem.description = %Q{FlickrMocks makes it possible to Marshal responses 
+			 generated from the FLickRaw gem. This is useful for 
+			 Mocking/Stubbing the Flickr interface for testing purposes.
+		         The FlickRaw::Response and FlickRaw::ResponseList objects can 
+			 not be Marshaled because they contain singleton's.}
+    gem.email = "pouya@lavabit.com"
+    gem.homepage = "http://github.com/takaltoo/flickrmocks"
+    gem.authors = ["Takaltoo"]
+
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 2.10"
+    gem.add_development_dependency "rspec", ">=2.0.0.beta.22"
+    gem.add_development_dependency "capybara"
+    #gem.add_development_dependency 'ruby-debug19', :require => 'ruby-debug'
+    gem.add_development_dependency 'factory_girl_rails', ">=1.0"
+    gem.add_development_dependency 'faker','>=0.3.1'
+
+    gem.add_dependency "flickraw", ">=0.8.2"
+    gem.add_dependency 'chronic'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "flickrmocks #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+

data/VERSION

@@ -0,0 +1 @@
+0.8.5

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/flickrmocks.gemspec

@@ -0,0 +1,155 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{flickrmocks}
+  s.version = "0.8.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Takaltoo"]
+  s.date = %q{2010-11-08}
+  s.description = %q{FlickrMocks makes it possible to Marshal responses 
+			 generated from the FLickRaw gem. This is useful for 
+			 Mocking/Stubbing the Flickr interface for testing purposes.
+		         The FlickRaw::Response and FlickRaw::ResponseList objects can 
+			 not be Marshaled because they contain singleton's.}
+  s.email = %q{pouya@lavabit.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".autotest",
+     ".document",
+     ".gitignore",
+     ".rspec",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "autotest/discover.rb",
+     "flickrmocks.gemspec",
+     "lib/flickr_mocks/api/api.rb",
+     "lib/flickr_mocks/api/flickr.rb",
+     "lib/flickr_mocks/api/helpers.rb",
+     "lib/flickr_mocks/api/options.rb",
+     "lib/flickr_mocks/api/sanitize.rb",
+     "lib/flickr_mocks/fixtures.rb",
+     "lib/flickr_mocks/flickraw/custom_clone.rb",
+     "lib/flickr_mocks/flickraw/custom_compare.rb",
+     "lib/flickr_mocks/flickraw/custom_marshal.rb",
+     "lib/flickr_mocks/flickraw/flickraw.rb",
+     "lib/flickr_mocks/helpers.rb",
+     "lib/flickr_mocks/models/helpers.rb",
+     "lib/flickr_mocks/models/photo.rb",
+     "lib/flickr_mocks/models/photo_details.rb",
+     "lib/flickr_mocks/models/photo_dimensions.rb",
+     "lib/flickr_mocks/models/photo_search.rb",
+     "lib/flickr_mocks/models/photo_size.rb",
+     "lib/flickr_mocks/models/photo_sizes.rb",
+     "lib/flickr_mocks/models/photos.rb",
+     "lib/flickr_mocks/stubs.rb",
+     "lib/flickr_mocks/version.rb",
+     "lib/flickrmocks.rb",
+     "spec/api/api_spec.rb",
+     "spec/api/flickr_spec.rb",
+     "spec/api/helper_spec.rb",
+     "spec/api/options_spec.rb",
+     "spec/api/sanitize_spec.rb",
+     "spec/base/fixtures_spec.rb",
+     "spec/base/flickraw/custom_clone_spec.rb",
+     "spec/base/flickraw/custom_compare_spec.rb",
+     "spec/base/flickraw/custom_marshal_spec.rb",
+     "spec/base/helpers_spec.rb",
+     "spec/base/stubs_spec.rb",
+     "spec/base/version_spec.rb",
+     "spec/fixtures/author_photos.marshal",
+     "spec/fixtures/empty_photos.marshal",
+     "spec/fixtures/expected_methods.marshal",
+     "spec/fixtures/interesting_photos.marshal",
+     "spec/fixtures/photo.marshal",
+     "spec/fixtures/photo_details.marshal",
+     "spec/fixtures/photo_size.marshal",
+     "spec/fixtures/photo_sizes.marshal",
+     "spec/fixtures/photos.marshal",
+     "spec/models/helpers_spec.rb",
+     "spec/models/photo_details_spec.rb",
+     "spec/models/photo_dimensions_spec.rb",
+     "spec/models/photo_search_spec.rb",
+     "spec/models/photo_size_spec.rb",
+     "spec/models/photo_sizes_spec.rb",
+     "spec/models/photo_spec.rb",
+     "spec/models/photos_spec.rb",
+     "spec/shared_examples/array_accessor.rb",
+     "spec/shared_examples/collection.rb",
+     "spec/shared_examples/image_url_helpers.rb",
+     "spec/shared_examples/size_accessor.rb",
+     "spec/spec_helper.rb",
+     "tasks/fixtures.rb"
+  ]
+  s.homepage = %q{http://github.com/takaltoo/flickrmocks}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Enables FlickRaw responses to be Marshaled.}
+  s.test_files = [
+    "spec/shared_examples/array_accessor.rb",
+     "spec/shared_examples/size_accessor.rb",
+     "spec/shared_examples/collection.rb",
+     "spec/shared_examples/image_url_helpers.rb",
+     "spec/models/helpers_spec.rb",
+     "spec/models/photo_details_spec.rb",
+     "spec/models/photo_size_spec.rb",
+     "spec/models/photo_sizes_spec.rb",
+     "spec/models/photos_spec.rb",
+     "spec/models/photo_dimensions_spec.rb",
+     "spec/models/photo_spec.rb",
+     "spec/models/photo_search_spec.rb",
+     "spec/api/api_spec.rb",
+     "spec/api/flickr_spec.rb",
+     "spec/api/options_spec.rb",
+     "spec/api/sanitize_spec.rb",
+     "spec/api/helper_spec.rb",
+     "spec/base/stubs_spec.rb",
+     "spec/base/helpers_spec.rb",
+     "spec/base/version_spec.rb",
+     "spec/base/flickraw/custom_clone_spec.rb",
+     "spec/base/flickraw/custom_compare_spec.rb",
+     "spec/base/flickraw/custom_marshal_spec.rb",
+     "spec/base/fixtures_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 2.10"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.22"])
+      s.add_development_dependency(%q<capybara>, [">= 0"])
+      s.add_development_dependency(%q<factory_girl_rails>, [">= 1.0"])
+      s.add_development_dependency(%q<faker>, [">= 0.3.1"])
+      s.add_runtime_dependency(%q<flickraw>, [">= 0.8.2"])
+      s.add_runtime_dependency(%q<chronic>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 2.10"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.22"])
+      s.add_dependency(%q<capybara>, [">= 0"])
+      s.add_dependency(%q<factory_girl_rails>, [">= 1.0"])
+      s.add_dependency(%q<faker>, [">= 0.3.1"])
+      s.add_dependency(%q<flickraw>, [">= 0.8.2"])
+      s.add_dependency(%q<chronic>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 2.10"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.22"])
+    s.add_dependency(%q<capybara>, [">= 0"])
+    s.add_dependency(%q<factory_girl_rails>, [">= 1.0"])
+    s.add_dependency(%q<faker>, [">= 0.3.1"])
+    s.add_dependency(%q<flickraw>, [">= 0.8.2"])
+    s.add_dependency(%q<chronic>, [">= 0"])
+  end
+end
+

data/lib/flickr_mocks/api/api.rb

@@ -0,0 +1,42 @@
+module FlickrMocks
+
+  class Api
+    @defaults = {
+      :per_page => '200',
+      :license => '4,5,6,7',
+      :media => 'photos',
+      :extras => 'license',
+      :tag_mode => 'any',
+      :flickr_tag_modes => ['any','all']
+    }
+  
+    class << self
+      attr_accessor :defaults
+    end
+
+    def self.photos(params)
+      photos = Api.flickr_photos(params)
+      PhotoSearch.new photos,Api.search_params(params)
+    end
+
+    def self.photo_details(params)
+      photo = Api.flickr_photo(params)
+      sizes = Api.flickr_photo_sizes(params)
+      @this = @photo = PhotoDetails.new(photo,sizes)
+    end
+
+    def self.photo(params)
+      Photo.new Api.flickr_photo(params)
+    end
+
+    def self.photo_sizes(params)
+      PhotoSizes.new Api.flickr_photo_sizes(params)
+    end
+
+    def self.interesting_photos(params)
+      photos = Api.flickr_interestingness(params)
+      PhotoSearch.new photos,Api.interesting_params(params)
+    end
+
+  end
+end

data/lib/flickr_mocks/api/flickr.rb

@@ -0,0 +1,27 @@
+module FlickrMocks
+
+  class Api
+    # Not required for testing, simple wrappers for flickr* methods
+    def self.flickr_photos(params)
+      flickr.photos.search self.search_options(params)
+    end
+
+    def self.flickr_photo(params)
+      flickr.photos.getInfo self.photo_options(params)
+    end
+
+    def self.flickr_photo_sizes(params)
+      flickr.photos.getSizes self.photo_options(params)
+    end
+
+    def self.flickr_interestingness(params)
+      flickr.interestingness.getList self.interesting_options(params)
+    end
+
+    def self.flickr_author(params)
+      flickr.photos.search self.author_options(params)
+    end
+  end
+end
+  
+

data/lib/flickr_mocks/api/helpers.rb

@@ -0,0 +1,19 @@
+module FlickrMocks
+  class Api
+    # default control values
+    def self.default(value)
+      Api.defaults[value.to_sym]
+    end
+
+    def self.time(date=nil)
+      begin
+        date = Chronic.parse(date).strftime('%Y-%m-%d')
+        date ? date : Chronic.parse('yesterday').strftime('%Y-%m-%d')
+      rescue
+        Chronic.parse('yesterday').strftime('%Y-%m-%d')
+      end
+    end
+
+
+  end
+end

data/lib/flickr_mocks/api/options.rb

@@ -0,0 +1,55 @@
+module FlickrMocks
+  class Api
+    def self.search_options(params)
+      return {
+        :tags => self.sanitize_tags(params[:search_terms]),
+        :user_id =>  params[:owner_id],
+        :per_page =>  self.sanitize_per_page(params),
+        :page =>  self.sanitize_page(params),
+        :license => self.default(:license),
+        :media => self.default(:media),
+        :extras => self.default(:extras),
+        :tag_mode => self.sanitize_tag_mode(params)
+      }
+    end
+
+    def self.interesting_options(params)
+      return {
+        :date => self.sanitize_time(params),
+        :per_page => self.sanitize_per_page(params),
+        :page =>  self.sanitize_page(params),
+        :extras => self.default(:extras)
+      }
+    end
+
+    def self.photo_options(params)
+      {
+        :photo_id => params[:photo_id] || params[:id] || nil,
+        :secret => params[:photo_secret] || params[:secret] || nil
+      }
+    end
+
+    def self.author_options(params)
+      options = self.search_options(params)   
+      options.delete :tags
+      options
+    end
+
+    def self.search_params(params)
+      return {
+        :search_terms => self.sanitize_tags(params[:search_terms]),
+        :owner_id => self.sanitize_tags(params[:owner_id]),
+        :base_url => params[:base_url]
+      }
+    end
+
+    def self.interesting_params(params)
+      return {
+        :date => params[:date],
+        :base_url => params[:base_url]
+      }
+    end
+  end
+
+ 
+end

data/lib/flickr_mocks/api/sanitize.rb

@@ -0,0 +1,29 @@
+module FlickrMocks
+  class Api
+    def self.sanitize_tags(value=nil)
+      value.nil? ? value : value.downcase.split(',').map.each do |v| v.strip end.join(',')
+    end
+
+    def self.sanitize_per_page(params={})
+      params[:per_page] || params[:perpage] || self.default(:per_page)
+    end
+
+    def self.sanitize_page(params={})
+      [nil,0,'0'].include?(params[:page]) ? '1' : params[:page].to_i.to_s
+    end
+
+    def self.sanitize_tag_mode(params={})
+      self.default(:flickr_tag_modes).include?(params[:tag_mode].to_s.downcase.strip) ?
+        params[:tag_mode].to_s.downcase.strip : self.default(:tag_mode)
+    end
+
+    def self.sanitize_time(params={})
+      date = params[:date]
+      case date
+      when Time then date.strftime('%Y-%m-%d')
+      when String then self.time(date)
+      else self.time('yesterday')
+      end
+    end
+  end
+end

data/lib/flickr_mocks/fixtures.rb

@@ -0,0 +1,35 @@
+require 'ostruct'
+
+module FlickrMocks
+  class Fixtures
+    attr_accessor :photos,:interesting_photos,:author_photos,:photo,:photo_details,
+                      :photo_sizes,:photo_size,:expected_methods,:empty_photos
+
+    def initialize
+      @photos = load_fixture(:photos)
+      @interesting_photos = load_fixture(:interesting_photos)
+      @author_photos = load_fixture(:author_photos)
+
+      @photo = load_fixture(:photo)
+      @photo_details= load_fixture(:photo_details)
+      
+      @photo_sizes = load_fixture(:photo_sizes)
+      @photo_size = load_fixture(:photo_size)
+      
+      @empty_photos = load_fixture(:empty_photos)
+
+      @expected_methods = load_fixture(:expected_methods)
+    end
+
+    def self.repository
+      File.expand_path(File.dirname(__FILE__) + '/../../spec/fixtures') + '/'
+    end
+
+    private
+    def load_fixture(file)
+      fname = Fixtures.repository + file.to_s + '.marshal'
+      FlickrMocks::Helpers.load fname
+    end
+
+  end
+end

data/lib/flickr_mocks/flickraw/custom_clone.rb

@@ -0,0 +1,19 @@
+module FlickrMocks
+
+  module CustomClone
+
+    def initialize_copy(orig)
+      super
+      cloned = @h.clone
+      @h = cloned.each_pair do |key,value|
+        case value
+        when Fixnum then next
+        when String then cloned[key] = value.clone
+        when Array then cloned[key] = value.clone.map do |elem| elem.clone end
+        when FlickRaw::Response then cloned[key] = value.clone
+        end
+      end
+    end
+  end
+
+end

data/lib/flickr_mocks/flickraw/custom_compare.rb

@@ -0,0 +1,25 @@
+module FlickrMocks
+
+  module CustomCompare
+    def ==(other)
+      return false if other.nil?
+      return false unless other.is_a?(self.class)
+      case other
+      when FlickRaw::Response then compare_response(other)
+      else self == other
+      end
+    end
+
+    private
+    def compare_response(other)
+      self.methods(false).map do |method|
+        return false unless other.respond_to?(method)
+        self.send(method) == other.send(method)
+      end.inject(true) do |previous,current|
+        previous && current
+      end
+    end
+
+
+  end
+end