muck-services 0.1.47 → 3.0.0

data/.gitignore

@@ -26,4 +26,5 @@ coverage
 rdoc
 pkg
 pkg/*
-log/*
+log/*
+secrets.yml

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Tatemae.com
+Copyright (c) 2009-2010 Tatemae.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -4,35 +4,19 @@ Muck Raker gem to handle aggregation, recommendations and search.  It is recomme
 
 == Installation
 
-Be sure to add github as a gem source before proceeding as acts-as-taggable-on, mislav-will_paginate (and many other gems) live there.
-  gem sources -a http://gems.github.com
+Add muck services to your Gemfile:
+  gem 'muck-services'
 
-Install muck services:
-  sudo gem install muck-services
 
-Install muck raker:
-sudo gem install muck-raker
-  
-Installing muck services should install all of it's dependancies.  You can also install them manually:
-  sudo gem install httparty
-  sudo gem install mbleigh-acts-as-taggable-on
-  sudo gem install mislav-will_paginate
-  sudo gem install muck-feedbag
-  sudo gem install pauldix-feedzirra
-
-After install acts-as-taggable-on be sure to include the helper in application_helper.rb:
+After installing acts-as-taggable-on be sure to include the helper in application_helper.rb:
 
   module ApplicationHelper
     include TagsHelper
   end
 
-Add rake tasks to your Rakefile
-
-  require 'muck_services/tasks'
-
 Add routes
 Depending on which features you use from muck raker you may need to add additional routes to your application.  For example, 
-a user with has_muck_feeds and acts_as_muck_feed_owner the following routes would be required:
+a user with include MuckServices::Models::MuckFeedParent and include MuckServices::Models::MuckFeedOwner the following routes would be required:
 
   map.resources :users, :controller => 'muck/users' do |users|
     # have to map into the muck/identity_feeds controller or rails can't find the identity_feeds
@@ -44,20 +28,20 @@ a user with has_muck_feeds and acts_as_muck_feed_owner the following routes woul
 == Usage
 Muck raker aggregates data feeds and analyzes the results to make recommendations.
 
-=== environment.rb
-Add the following to environment.rb to include all the required gems:
+=== Gemfile
+Add the following to your Gemfile:
 
-  config.gem "muck-feedbag", :lib => "feedbag", :source => "http://gems.github.com"
-  config.gem "pauldix-feedzirra", :lib => 'feedzirra', :source => "http://gems.github.com"
-  config.gem 'muck-engine', :lib => 'muck_engine'
-  config.gem 'muck-users', :lib => 'muck_users'
-  config.gem 'muck-solr', :lib => 'acts_as_solr'
+  gem "muck-feedbag", :require => "feedbag"
+  gem "feedzirra"
+  gem 'muck-engine'
+  gem 'muck-users'
+  gem 'muck-solr', :require => 'acts_as_solr'
 
 The following are optional but almost always used so you may as well pull them in.
-  config.gem 'muck-comments', :lib => 'muck_comments'
-  config.gem 'muck-activities', :lib => 'muck_activities'
-  config.gem 'muck-shares', :lib => 'muck_shares'
-  config.gem 'muck-raker', :lib => 'muck_raker'
+  gem 'muck-comments'
+  gem 'muck-activities'
+  gem 'muck-shares'
+  gem 'muck-raker'
 
 === Database
 There are a number of rake tasks meant to help you get your database setup:
@@ -77,23 +61,23 @@ data with the user so that recommendations can be improved.
 muck-services uses muck-comments and muck-activities to add comments to entries in the 'visits' frame view.  You can omit these gems if you don't desire comments.
 muck-services also uses muck-shares and muck-activities to share entries with other users.  Again you can omit these gems if you don't desire the share capability.
 
-To turn on this functionality add these lines to your global_config.yml file:
-  inform_admin_of_global_feed: true   # If true then the 'admin_email' will recieve an email anytime a global feed (one that is not 
-                                      # attached to any object) is added.
-  enable_services_comments: true      # Enables or disables comments in the frame that wraps content as a user browses recommendation results
-  enable_services_shares: true        # Enables or disables sharing in the frame that wraps content as a user browses recommendation results
-
-To install these gems:
-  sudo gem install muck-comments
-  sudo gem install muck-activities
-  sudo gem install muck-shares
-
-If you enable comments you will need a comment model with 'acts_as_muck_services_comment':
+To turn on this functionality create an initializer:
+  MuckServices.configure.do |config|
+    config.inform_admin_of_global_feed = true   # If true then the 'admin_email' will recieve an email anytime a global feed (one that is not 
+                                                # attached to any object) is added.
+    config.enable_services_comments = true      # Enables or disables comments in the frame that wraps content as a user browses recommendation results
+    config.enable_services_shares = true        # Enables or disables sharing in the frame that wraps content as a user browses recommendation results
+    config.show_google_search = true            # Determines whether or not a google search is displayed on the topic page
+    config.load_feeds_on_server = false         # Determines whether feeds on a topic page are loaded on the server or the client.  Loading on the server can take a while
+    config.combine_feeds_on_server = false      # Combines feeds loaded on the server
+  end
+  
+If you enable comments you will need a comment model with 'include MuckServices::Models::MuckServicesComment':
 
-class Comment < ActiveRecord::Base
-  acts_as_muck_comment
-  acts_as_muck_services_comment
-end
+  class Comment < ActiveRecord::Base
+    include MuckComments::Models::MuckComment
+    include MuckServices::Models::MuckServicesComment
+  end
 
 === CSS
 Running rake muck:raker:sync will copy a default css file called muck-raker.css into your stylesheets directory.  
@@ -108,4 +92,4 @@ You will need to have mysql setup to run the migrations for the test database.
 
 
 
-Copyright (c) 2009 Tatemae.com, released under the MIT license
+Copyright (c) 2009-2010 Tatemae.com, released under the MIT license

data/Rakefile

@@ -1,14 +1,18 @@
 require 'rubygems'
 require 'rake'
-require 'rake/testtask'
 require 'rake/rdoctask'
+require 'rspec/core/rake_task'
 
-desc 'Default: run unit tests.'
-task :default => :test
+desc 'Default: run specs.'
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["--color", "-c", "-f progress", "-r test/rails_test/spec/spec_helper.rb"]
+  t.pattern = 'test/rails_test/spec/**/*_spec.rb'  
+end
 
 desc 'Translate this gem'
 task :translate do
-  file = File.join(File.dirname(__FILE__), 'locales', 'en.yml')
+  file = File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml')
   system("babelphish -o -y #{file}")
   path = File.join(File.dirname(__FILE__), 'app', 'views', 'services_mailer')
   system("babelphish -o -h #{path} -l en")
@@ -18,8 +22,8 @@ begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |t|
     #t.libs << 'lib'
-    t.libs << 'test/rails_root/lib'
-    t.pattern = 'test/rails_root/test/**/*_test.rb'
+    t.libs << 'test/rails_test/lib'
+    t.pattern = 'test/rails_test/test/**/*_test.rb'
     t.verbose = true
     t.output_dir = 'coverage'
     t.rcov_opts << '--exclude "gems/*"'
@@ -30,14 +34,6 @@ rescue LoadError
   end
 end
 
-desc 'Test muck-services.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test/rails_root/test'
-  t.pattern = 'test/rails_root/test/**/*_test.rb'
-  t.verbose = true
-end
-
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
@@ -45,16 +41,18 @@ begin
     gem.summary = "Feeds, aggregations and services for muck"
     gem.description = "This gem contains the rails specific code for dealing with feeds, aggregations and recommendations.  It is meant to work with the muck-raker gem."
     gem.email = "justin@tatemae.com"
-    gem.homepage = "http://github.com/tatemae/muck-services"
+    gem.homepage = "http://github.com/tatemae/muck_services"
     gem.authors = ["Joel Duffin", "Justin Ball"]
     gem.add_dependency "acts-as-taggable-on"
     gem.add_dependency "will_paginate"
     gem.add_dependency "httparty"
     gem.add_dependency "nokogiri"
+    gem.add_dependency "hpricot"
     gem.add_dependency "muck-feedbag"
     gem.add_dependency "river"
     gem.add_dependency "overlord"
     gem.add_dependency "feedzirra"
+    gem.add_dependency "muck-raker"
     gem.add_dependency "muck-engine"
     gem.add_dependency "muck-users"
     gem.add_dependency "muck-comments"
@@ -63,7 +61,7 @@ begin
     gem.files.exclude "public/images/service_icons/source/*"
     gem.files.exclude "test/*"
     gem.test_files.exclude 'test/feed_archive/**'
-    gem.test_files.exclude 'test/rails_root/public/images/*'
+    gem.test_files.exclude 'test/rails_test/public/images/*'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.47
+3.0.0

data/app/controllers/admin/muck/feeds_controller.rb

@@ -3,7 +3,7 @@ class Admin::Muck::FeedsController < Admin::Muck::BaseController
   unloadable
 
   def index
-    @feeds = Aggregation.global_feeds(params[:order], params[:asc]).paginate(:page => @page, :per_page => @per_page)
+    @feeds = Feed.find(:all, :order => (params[:order] || 'created_at') + (params[:asc] == 'false' ? ' DESC' : ' ASC') + ', title', :include => [:default_language]).paginate(:page => @page, :per_page => @per_page)
     respond_to do |format|
       format.html { render :template => 'admin/feeds/index' }
       format.xml  { render :xml => @feeds.to_xml }

data/app/controllers/muck/aggregations_controller.rb

@@ -16,7 +16,7 @@ class Muck::AggregationsController < ApplicationController
     if @parent
       @aggregations = @parent.aggregations.by_title
     else
-      @aggregations = Aggregation.newest
+      @aggregations = Aggregation.by_newest
     end
     render(:template => 'aggregations/index')
     # respond_to do |format|
@@ -39,9 +39,9 @@ class Muck::AggregationsController < ApplicationController
     @music_feeds = @aggregation.music_feeds
     @general_feeds = @aggregation.general_feeds
     
-    if GlobalConfig.render_feeds_client_side
+    if MuckServices.configuration.render_feeds_client_side
       
-    elsif GlobalConfig.render_feeds_server_side
+    elsif MuckServices.configuration.render_feeds_server_side
       @feeds = @aggregation.feeds
     else
       @entries = @aggregation.feeds.entries.paginate(:page => @page, :per_page => @per_page)
@@ -227,9 +227,7 @@ class Muck::AggregationsController < ApplicationController
     end
     
     def get_google_feed_html
-      render_as_html do
-        render_to_string(:partial => 'aggregations/feeds')
-      end
+      render_to_string(:partial => 'aggregations/feeds')
     end
     
 end

data/app/controllers/muck/feed_previews_controller.rb

@@ -4,11 +4,7 @@ class Muck::FeedPreviewsController < ApplicationController
 
   def new
     respond_to do |format|
-      format.pjs do
-        render_as_html do
-          render :template => 'feed_previews/new', :layout => false
-        end
-      end
+      format.pjs { render :template => 'feed_previews/new', :layout => false }
       format.html { render :template => 'feed_previews/new' }
     end
   end
@@ -17,11 +13,7 @@ class Muck::FeedPreviewsController < ApplicationController
     @feed = Feed.new(params[:feed])
     @feeds = Feed.gather_information(@feed.uri).compact
     respond_to do |format|
-      format.pjs do
-        render_as_html do
-          render :template => 'feed_previews/select_feeds', :layout => false
-        end
-      end
+      format.pjs { render :template => 'feed_previews/select_feeds', :layout => false }
       format.html { render :template => 'feed_previews/select_feeds' }
     end
   end

data/app/controllers/muck/feeds_controller.rb

@@ -6,7 +6,7 @@ class Muck::FeedsController < ApplicationController
   before_filter :get_owner, :except => ['index', 'show']
   
   def index
-    @feeds = Aggregation.global_feeds(params[:order], params[:asc]).paginate(:page => @page, :per_page => @per_page)
+    @feeds = Feed.find(:all, :conditions => 'status >= 0', :order => (params[:order] || 'title') + (params[:asc] == 'false' ? ' DESC' : ' ASC') + ', title', :include => [:default_language]).paginate(:page => @page, :per_page => @per_page)
     respond_to do |format|
       format.html { render :template => 'feeds/index' }
       format.xml  { render :xml => @feeds.to_xml }

data/app/controllers/muck/identity_feeds_controller.rb

@@ -123,15 +123,11 @@ class Muck::IdentityFeedsController < ApplicationController
     end
     
     def get_new_html(service, parent, feed)
-      render_as_html do
-        render_to_string(:partial => 'identity_feeds/form', :locals => { :service => service, :parent => parent, :feed => feed })
-      end
+      render_to_string(:partial => 'identity_feeds/form', :locals => { :service => service, :parent => parent, :feed => feed })
     end
     
     def get_edit_html(identity_feed)
-      render_as_html do
-        render_to_string(:partial => 'identity_feeds/form', :locals => { :service => identity_feed.feed.service, :parent => identity_feed.ownable, :feed => identity_feed.feed })
-      end
+      render_to_string(:partial => 'identity_feeds/form', :locals => { :service => identity_feed.feed.service, :parent => identity_feed.ownable, :feed => identity_feed.feed })
     end
     
     def add_feeds_to_parent(parent, feeds)

data/app/controllers/muck/topics_controller.rb

@@ -155,9 +155,9 @@ class Muck::TopicsController < ApplicationController
       @number_of_images = 12
       @number_of_videos = 6
       
-      @show_google_search = GlobalConfig.show_google_search
-      @show_combined = GlobalConfig.combine_feeds_on_server
-      @load_feeds_on_server = GlobalConfig.load_feeds_on_server
+      @show_google_search = MuckServices.configuration.show_google_search
+      @show_combined = MuckServices.configuration.combine_feeds_on_server
+      @load_feeds_on_server = MuckServices.configuration.load_feeds_on_server
     end
     
 end

data/app/controllers/muck/visits_controller.rb

@@ -8,12 +8,12 @@ class Muck::VisitsController < ApplicationController
     @entry = Entry.find(params[:id])
     @page_title = @entry.title
     @resource_uri = @entry.resource_uri
-    @share = Share.new(:title => @entry.title, :uri => @resource_uri, :entry_id => @entry.id) if GlobalConfig.enable_services_shares
+    @share = Share.new(:title => @entry.title, :uri => @resource_uri, :entry_id => @entry.id) if MuckServices.configuration.enable_services_shares
     @recommendations = @entry.related_entries.top
 
-    if GlobalConfig.enable_services_comments
+    if MuckServices.configuration.enable_services_comments
       # Show the activities related to this entry
-      @activities = @entry.activities.oldest.only_public.find(:all, :include => ['comments'])
+      @activities = @entry.activities.by_oldest.is_public.find(:all, :include => ['comments'])
       @comment_count = @activities.length + @activities.inject(0) {|n,activity| activity.comments.length + n }
     end
     

data/app/helpers/muck_services_feeds_helper.rb

@@ -14,18 +14,18 @@ module MuckServicesFeedsHelper
 
   def feed_contributor_link(feed)
     if feed.contributor_id.nil?
-#      admin = Feed.find_by_login('admin')
+      admin = Feed.find_by_login('admin')
       'unknown'
     else
       link_to feed.contributor.display_name, profile_path(feed.contributor)
     end
   end
 
-  def sort_feeds_url(current_order, current_asc, new_order, admin = false)
+  def sort_feeds_link(current_order, current_asc, new_order, admin = false)
     if admin == true
       admin_feeds_url(:order => new_order, :asc => (current_order == new_order && (current_asc == 'true' || current_asc == nil)) ? 'false' : 'true')
     else
-      feeds_url(:order => new_order, :asc => (current_order == new_order && (current_asc == 'false' || current_asc == nil)) ? 'true' : 'false')
+      feeds_url(:order => new_order, :asc => (current_order == new_order && (current_asc == 'true' || current_asc == nil)) ? 'false' : 'true')
     end
   end
 

data/app/helpers/muck_services_service_helper.rb

@@ -1,6 +1,6 @@
 module MuckServicesServiceHelper
   
-  # Render a summary of all services for the given parent.  The parent should 'acts_as_muck_feed_owner' 
+  # Render a summary of all services for the given parent.  The parent should 'include MuckServices::Models::MuckFeedOwner' 
   def services_summary(parent)
     identity_feeds = parent.identity_feeds.find(:all, :include => [{:feed => :service}])
     render :partial => 'services/summary', :locals => { :identity_feeds => identity_feeds }
@@ -49,7 +49,7 @@ module MuckServicesServiceHelper
   # to look for a translation at muck.services.blog_url and will pass the name of the service
   # using 'service' so your translation might look like:
   # muck.services.blog_url: "Blog Url" or
-  # muck.services.facebook_prompt: "{{service}} Feeds"
+  # muck.services.facebook_prompt: "%{service} Feeds"
   def service_prompt(service)
     if @service.prompt.blank?
       I18n.t('muck.services.service_username', :service => @service.name)

data/app/models/aggregation.rb

@@ -26,25 +26,11 @@ class Aggregation < ActiveRecord::Base
   has_many :feeds, :through => :aggregation_feeds
   has_many :oai_endpoints, :through => :aggregation_feeds
   
-  named_scope :by_title, :order => "title ASC"
-  named_scope :recent, lambda { { :conditions => ['created_at > ?', 1.week.ago] } }
-  named_scope :newest, :order => "created_at DESC"
-
-
-  def self.global_feeds(order_field = 'title', ascending = 'true')
-    allowed_fields = ['languages.english_name','status','entries_count','harvested_from_title','last_harvested_at','created_at','feed_contributor']
-    order_direction = (ascending == 'false' ? ' DESC' : ' ASC')
-    order_by = allowed_fields.include?(order_field) ? (order_field  + order_direction + ', title') : ('title ' + order_direction)
-
-    Feed.find_by_sql("SELECT users.id feed_contributor_id, users.login feed_contributor, languages.english_name default_language_name, feeds.*, aggregation_id <=> 1 FROM aggregations " +
-            "INNER JOIN aggregation_feeds ON aggregations.id = aggregation_feeds.aggregation_id " +
-            "RIGHT OUTER JOIN feeds ON aggregation_feeds.feed_id = feeds.id " +
-            "INNER JOIN languages ON feeds.default_language_id = languages.id " +
-            "LEFT OUTER JOIN users ON feeds.contributor_id = users.id " +
-#            "WHERE aggregations.title = 'global_feeds' AND feeds.status >= 0 " +
-          "ORDER BY #{order_by}")
-  end
+  scope :by_title, order("title ASC")
+  scope :newer_than, lambda { |*args| where("created_at > ?", args.first || DateTime.now) }
+  scope :by_newest, order("created_at DESC")
 
+    
   # Builds and then adds feeds for a given terms
   # user:         User to be associated with each feed.  Default is nil which makes each feed global.
   # service_ids:  An array of service ids.  Nil will generate a feed for every available service.

data/app/models/entry.rb

@@ -49,9 +49,9 @@ class Entry < ActiveRecord::Base
     end
   end
 
-  acts_as_commentable
+  include MuckComments::Models::MuckCommentable
   acts_as_taggable
-  acts_as_muck_recommendation
+  include MuckServices::Models::MuckRecommendation
   
   @@min_secs_tracked = 5
   @@max_secs_tracked = 120

data/app/models/feed.rb

@@ -50,17 +50,15 @@ class Feed < ActiveRecord::Base
   belongs_to :default_language, :class_name => 'Language', :foreign_key => 'default_language_id'
   belongs_to :service
   
-  named_scope :banned, :conditions => ["status = ?", MuckServices::Status::BANNED]
-  named_scope :valid, :conditions => "status >= 0", :include => [:default_language]
-  named_scope :by_title, :order => "title ASC", :include => [:default_language]
-  named_scope :recent, lambda { { :conditions => ['created_at > ?', 1.week.ago] } }
-  named_scope :by_newest, :order => "created_at DESC", :include => [:default_language]
+  scope :banned, where("status = ?", MuckServices::Status::BANNED)
+  scope :valid, where("status >= 0").includes(:default_language)
+  scope :by_title, order("title ASC").includes(:default_language)
+  scope :newer_than, lambda { |*args| where("created_at > ?", args.first || DateTime.now) }
+  scope :by_newest, order("created_at DESC").includes(:default_language)
 
   attr_protected :status, :last_requested_at, :last_harvested_at, :harvest_interval, :failed_requests,
                  :created_at, :updated_at, :entries_changed_at, :entries_count, :contributor_id
   
-  # named_scope :ready_to_harvest, lambda { |*args| { :conditions => [ "feeds.last_harvested_at < ?", args.first || 1.day.ago.end_of_day ] } }
-
   def banned?
     self.status == MuckServices::Status::BANNED
   end
@@ -70,8 +68,8 @@ class Feed < ActiveRecord::Base
   end
 
   def inform_admin
-    if GlobalConfig.inform_admin_of_global_feed && global?
-      ServicesMailer.deliver_notification_feed_added(self) # Global feed.  Email the admin to let them know a feed has been added
+    if MuckServices.configuration.inform_admin_of_global_feed && global?
+      ServicesMailer.notification_feed_added(self).deliver # Global feed.  Email the admin to let them know a feed has been added
     end
   end