lentil 0.0.1.pre

data/lib/lentil/popularity_calculator.rb

@@ -0,0 +1,63 @@
+module Lentil
+  class PopularityCalculator
+
+    # Takes image object and returns a popularity score
+    #
+    # @param [object] image object with image data
+    #
+    # @return [integer] popularity score of image
+    def calculate_popularity(image)
+
+      # A staff like is worth 10 points
+      if (image.staff_like === false)
+        staff_like_points = 0
+      else
+        staff_like_points = 10
+      end
+
+      # likes have diminishing returns
+      # 10 likes is 13 points
+      # 100 likes is 25 points
+      if image.like_votes_count > 0
+        like_vote_points = Math::log(image.like_votes_count, 1.2).round
+      else
+        like_vote_points = 0
+      end
+
+      # if an image has fewer than 5 battle rounds this is 0
+      # 5 or more and the points awarded is the win_pct/2
+      if image.win_pct and image.wins_count + image.losses_count > 4
+        battle_points = (image.win_pct/2).round
+      else
+        battle_points = 0
+      end
+
+      battle_points + like_vote_points + staff_like_points
+
+    end
+
+    # Takes an image id and updates its popularity score
+    #
+    # @param [integer] id of image to update defaults to :all
+    #
+    # @return [boolean] success/failure of update
+    def update_image_popularity_score(image_to_update = :all)
+
+      def get_score_write_to_db(image)
+        popularity_score = calculate_popularity(image)
+        image.update_attribute(:popular_score, popularity_score)
+      end
+
+      if image_to_update == :all
+        images = Lentil::Image.find(image_to_update)
+        images.each  do |image|
+          get_score_write_to_db(image)
+        end
+      elsif image_to_update.kind_of?(Integer)
+          image = Lentil::Image.find(image_to_update)
+          get_score_write_to_db(image)
+      end
+    end
+
+  end
+end

data/lib/lentil/version.rb

@@ -0,0 +1,3 @@
+module Lentil
+  VERSION = "0.0.1.pre"
+end

data/lib/tasks/auto_annotate_models.rake

@@ -0,0 +1,20 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if(Rails.env.development?)
+  task :set_annotation_options do
+    ENV['position_in_class']    = "before"
+    ENV['position_in_fixture']  = "before"
+    ENV['position_in_factory']  = "before"
+    ENV['show_indexes']         = "true"
+    ENV['include_version']      = "false"
+    ENV['exclude_tests']        = "false"
+    ENV['exclude_fixtures']     = "false"
+    ENV['ignore_model_sub_dir'] = "false"
+    ENV['skip_on_db_migrate']   = "false"
+    ENV['format_rdoc']          = "false"
+    ENV['format_markdown']      = "false"
+    ENV['no_sort']              = "false"
+    ENV['force']                = "false"
+  end
+end

data/lib/tasks/image_services.rake

@@ -0,0 +1,129 @@
+namespace :lentil do
+  namespace :image_services do
+    namespace :instagram do
+
+      desc "Fetch and import recent images from Instagram that are tagged with the default tag"
+      task :fetch_by_tag => :environment do
+
+        begin
+          harvester = Lentil::InstagramHarvester.new
+          new_image_count = 0
+          harvestable_tags = Lentil::Tag.harvestable.collect {|tag| tag.name}
+          raise "No tags in harvestable tagsets" if harvestable_tags.empty?
+
+          harvestable_tags.each do |tag|
+            instagram_metadata = harvester.fetch_recent_images_by_tag(tag)
+            new_image_count += harvester.save_instagram_load(instagram_metadata).size
+          end
+
+          puts "#{new_image_count} new images added"
+        rescue => e
+          Rails.logger.error e.message
+          raise e
+        end
+      end
+    end
+
+    desc "Fetch and save image files to the directory specified in the applicaton config"
+    task :save_image_files, [:number_of_images, :image_service, :base_directory] => :environment do |t, args|
+
+      args.with_defaults(:number_of_images => 50, :image_service => 'Instagram')
+
+      base_dir = args[:base_directory] || Lentil::Engine::APP_CONFIG["base_image_file_dir"] || nil
+
+      raise "Base directory is required" unless base_dir
+
+      num_to_harvest = args[:number_of_images].to_i
+
+      Lentil::Service.where(:name => args[:image_service]).first.images.where(:file_harvested_date => nil).
+        order("file_harvest_failed ASC").limit(num_to_harvest).each do |image|
+        begin
+          raise "Desination directory does not exist or is not a directory: #{base_dir}" unless File.directory?(base_dir)
+
+          image_file_path = "#{base_dir}/#{image.service.name}"
+
+          if !File.exist?(image_file_path)
+            Dir.mkdir(image_file_path)
+          else
+            raise "Service directory is not a directory: #{image_file_path}" unless File.directory?(image_file_path)
+          end
+        rescue => e
+          Rails.logger.error e.message
+          raise e
+        end
+
+        begin
+          harvester = Lentil::InstagramHarvester.new
+          image_data = harvester.harvest_image_data(image)
+          # TODO: Currently expects JPEG
+          image_file_path += "/#{image.external_identifier}.jpg"
+          raise "Image file already exists, will not overwrite" if File.exist?(image_file_path)
+
+          File.open(image_file_path, "wb") do |f|
+            f.write image_data
+          end
+
+          image.file_harvested_date = DateTime.now
+          image.save
+          puts "Harvested image #{image.id}"
+        rescue => e
+          image.file_harvest_failed += 1
+          image.save
+          Rails.logger.error e.message
+          puts e.message
+        end
+      end
+    end
+
+    desc "Test whether image file can still be retrieved"
+    task :test_image_files, [:number_of_images, :image_service] => :environment do |t, args|
+      args.with_defaults(:number_of_images => 10, :image_service => 'Instagram')
+
+      num_to_check = args[:number_of_images].to_i
+
+      Lentil::Service.unscoped.where(:name => args[:image_service]).first.images.
+        where("(file_last_checked IS NULL) OR (file_last_checked < :day)", {:day => 1.day.ago}).
+        where("failed_file_checks < 10").
+        order("file_last_checked ASC").limit(num_to_check).each do |image|
+          harvester = Lentil::InstagramHarvester.new
+          image_check = harvester.test_remote_image(image)
+
+          if image_check
+            image.failed_file_checks = 0
+          elsif image_check == false
+            image.failed_file_checks += 1
+          end
+
+          image.file_last_checked = DateTime.now
+          image.save
+      end
+    end
+
+    desc "Submit donor agreement as a comment on a given number of approved images.
+          Currently, image must have been in the system for at least a week"
+    task :submit_donor_agreements, [:number_of_images, :image_service] => :environment do |t, args|
+      args.with_defaults(:number_of_images => 1, :image_service => 'Instagram')
+      num_to_harvest = args[:number_of_images].to_i
+
+      Lentil::Service.where(:name => args[:image_service]).first.images.approved.where("images.created_at < :week", {:week => 1.week.ago}).
+              where(:do_not_request_donation => false).
+              where(:donor_agreement_submitted_date => nil).order("donor_agreement_failed ASC").
+              limit(num_to_harvest).each do |image|
+        begin
+          donor_agreement = Lentil::Engine::APP_CONFIG["donor_agreement_text"] || nil
+          raise "donor_agreement_text must be defined in application config" unless donor_agreement
+          harvester = Lentil::InstagramHarvester.new
+          harvester.leave_image_comment(image, donor_agreement)
+          image.donor_agreement_submitted_date = DateTime.now
+          image.save
+          puts "Left donor agreement on image #{image.id}"
+        rescue => e
+          image.donor_agreement_failed += 1
+          image.save
+          Rails.logger.error e.message
+          puts e.message
+        end
+      end
+    end
+  end
+end

data/lib/tasks/lentil_tasks.rake

@@ -0,0 +1,10 @@
+namespace :lentil do
+
+  desc 'create a dummy admin user in development'
+  task :dummy_admin_user => :environment do
+    if Lentil::AdminUser.find_by_email('admin@example.com').blank?
+      Lentil::AdminUser.create!(:email => 'admin@example.com', :password => 'password', :password_confirmation => 'password')
+    end
+  end
+
+end

data/lib/tasks/popularity.rake

@@ -0,0 +1,16 @@
+namespace :lentil do
+  namespace :popularity do
+    desc "Calculate value of popularity score from battle, staff picks, and like votes"
+    task :update_score => :environment do
+
+      begin
+        popularity_calculator = Lentil::PopularityCalculator.new
+        updated_score_count = popularity_calculator.update_image_popularity_score().size
+        puts "#{updated_score_count} image popularity scores updated"
+      rescue => e
+        Rails.logger.error e.message
+        raise e
+      end
+    end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.