muck-services 0.1.2

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tatemae.com
+
+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,100 @@
+= Muck Services
+Muck Services adds functionality that aggregates, searches and analyzes data from many different web sources.  This gem works in conjunction with the 
+Muck Raker gem to handle aggregation, recommendations and search.  It is recommended that you install both gems together.
+
+== 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
+
+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:
+
+  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:
+
+  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
+    users.resources :identity_feeds, :controller => 'muck/identity_feeds'
+    users.resources :feeds, :controller => 'muck/feeds'
+    users.resources :aggregations, :controller => 'muck/aggregations'
+  end
+  
+== 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:
+
+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'
+# 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'
+
+
+
+=== Identity Feeds
+Specific feeds can be attached to objects.  For example, a user might produce a blog or a flickr photo stream.  The identity feed system associated the resulting
+data with the user so that recommendations can be improved.
+
+== Notes
+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:
+  enable_raker_comments: true
+  enable_raker_shares: true
+
+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':
+
+class Comment < ActiveRecord::Base
+  acts_as_muck_comment
+  acts_as_muck_services_comment
+end
+
+=== CSS
+Running rake muck:raker:sync will copy a default css file called muck-raker.css into your stylesheets directory.  
+You can include that file in your layout or copy it and modify it to meet your needs. 
+(Don't change the file as each time you run rake muck:raker:sync it will overwrite any changes you might have made.)
+
+=== Frame css
+There is an example css file for the framed page in frame.css.
+
+=== Testing
+You will need to have mysql setup to run the migrations for the test database.  Muck raker has a few customizations which require mysql.
+
+
+
+Copyright (c) 2009 Tatemae.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,84 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Translate this gem'
+task :translate do
+  file = File.join(File.dirname(__FILE__), '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")
+end
+
+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.verbose = true
+    t.output_dir = 'coverage'
+    t.rcov_opts << '--exclude "gems/*"'
+  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
+
+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
+
+task :test => :check_dependencies
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "muck-services"
+    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.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 "feedbag"
+    gem.add_dependency "river"
+    gem.add_dependency "overlord"
+    gem.add_dependency "feedzirra"
+    gem.add_dependency "muck-engine"
+    gem.add_dependency "muck-users"
+    gem.add_dependency "muck-comments"
+    gem.add_development_dependency "shoulda"
+    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 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: sudo gem install jeweler"
+end
+
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "muck_services #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

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

@@ -0,0 +1,40 @@
+class Admin::Muck::FeedsController < Admin::Muck::BaseController
+
+  unloadable
+
+  def index
+    @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 }
+    end
+  end
+
+  def update
+    feed = Feed.find(params[:id])
+    if params[:status] == 'approve'
+      approve(feed)
+      flash[:notice] = t('muck.services.feed_validated_message')
+    elsif params[:status] == 'ban'
+      ban(feed)
+      flash[:notice] = t('muck.services.feed_banned_message')
+    end
+    respond_to do |format|
+      format.html { redirect_to admin_feeds_path }
+    end
+  end
+
+  protected
+  
+    def ban(feed)
+      feed.entries.destroy_all
+      feed.status = MuckServices::Status::BANNED
+      feed.save!
+    end
+
+    def approve(feed)
+      feed.status = MuckServices::Status::APPROVED
+      feed.save!
+    end
+  
+end

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

@@ -0,0 +1,13 @@
+class Admin::Muck::OaiEndpointsController < Admin::Muck::BaseController
+
+  unloadable
+  
+  def index
+    @oai_endpoints = OaiEndpoint.by_newest.paginate(:page => @page, :per_page => @per_page)
+    respond_to do |format|
+      format.html { render :template => 'admin/oai_endpoints/index' }
+      format.xml  { render :xml => @oai_endpoints.to_xml }
+    end
+  end
+
+end

data/app/controllers/muck/aggregation_feeds_controller.rb

@@ -0,0 +1,43 @@
+class Muck::AggregationFeedsController < ApplicationController
+
+  unloadable
+  
+  before_filter :login_required
+
+  def destroy
+    @aggregation_feed = AggregationFeed.find(params[:id]) rescue nil if params[:id] && params[:id].to_i > 0
+    @aggregation_feed ||= AggregationFeed.find_by_feed_id_and_aggregation_id(params[:feed_id], params[:aggregation_id])
+    @aggregation = @aggregation_feed.aggregation
+    if has_aggregation_permission?
+      @aggregation_feed.destroy
+      respond_to do |format|
+        message = I18n.t('muck.services.feed_remove')
+        format.html do
+          flash[:notice] = message
+          redirect_to polymorphic_url([@aggregation.ownable, @aggregation])
+        end
+        format.json { render :json => { :success => true, :message => message }.as_json }
+        format.xml  { head :ok }
+      end
+    end
+  end
+
+  protected
+  
+    def has_aggregation_permission?
+      if !@aggregation.can_edit?(current_user)
+        message = I18n.t('muck.services.cant_modify_aggregation')
+        respond_to do |format|
+          format.html do
+            flash[:notice] = message
+            redirect_to polymorphic_url([@aggregation.ownable, @aggregation])
+          end
+          format.js { render(:update) {|page| page.alert message} }
+          format.json { render :json => { :success => false, :message => message }.as_json }
+        end
+      else
+        true
+      end
+    end
+  
+end

data/app/controllers/muck/aggregations_controller.rb

@@ -0,0 +1,234 @@
+class Muck::AggregationsController < ApplicationController
+
+  unloadable
+  
+  #before_filter :adjust_format_for_iphone
+  
+  require 'cgi'
+  
+  before_filter :login_required, :except => [:index, :show, :preview, :rss_discovery]
+  before_filter :get_owner, :only => [:index, :preview, :new, :create]
+  before_filter :check_user_permissions, :only => [:create]
+  before_filter :get_aggregation, :only => [:destroy, :edit, :update, :show, :rss_discovery]
+  before_filter :has_aggregation_permission?, :only => [:destroy, :edit, :update]
+  before_filter :setup_feed_display_variables, :only => [:preview, :update]
+  def index
+    if @parent
+      @aggregations = @parent.aggregations.by_title
+    else
+      @aggregations = Aggregation.newest
+    end
+    respond_to do |format|
+      format.html { render(:template => 'aggregations/index') }
+      format.iphone { render(:template => 'aggregations/index') }
+    end
+  end
+  
+  def rss_discovery
+    @feeds = @aggregation.feeds
+    render :template => 'aggregations/rss_discovery'
+  end
+  
+  def show
+    @page_title = @aggregation.title
+    
+    @photo_feeds = @aggregation.photo_feeds
+    @video_feeds = @aggregation.video_feeds
+    @bookmark_feeds = @aggregation.bookmark_feeds
+    @music_feeds = @aggregation.music_feeds
+    @general_feeds = @aggregation.general_feeds
+    
+    if GlobalConfig.render_feeds_client_side
+      
+    elsif GlobalConfig.render_feeds_server_side
+      @feeds = @aggregation.feeds
+    else
+      @entries = @aggregation.feeds.entries.paginate(:page => @page, :per_page => @per_page)
+    end
+    respond_to do |format|
+      format.html { render(:template => 'aggregations/show') }
+      format.opml { render(:layout => false) }
+      format.rss {}
+    end
+  end
+  
+  def preview
+    if params[:terms].blank?
+      flash[:error] = I18n.t('muck.services.no_terms_error')
+      redirect_to new_polymorphic_url([@parent, :aggregation])
+    else
+      terms = params[:terms]
+      terms = terms.join(' ') if terms.is_a?(Array)
+      
+      #@feeds = Service.build_tag_feeds(terms, current_user, params[:service_ids])
+      
+      @photo_feeds = Service.build_photo_feeds(terms, current_user)
+      @video_feeds = Service.build_video_feeds(terms, current_user)
+      @bookmark_feeds = Service.build_bookmark_feeds(terms, current_user)
+      @music_feeds = Service.build_music_feeds(terms, current_user)
+      @general_feeds = Service.build_general_feeds(terms, current_user)
+
+      @discovered_feeds = Overlord::GoogleFeedRequest.find_feeds(terms)
+      @title = terms.titleize
+      @terms = terms
+      
+      @aggregation = Aggregation.new(:title => @title, :terms => @terms)
+
+      respond_to do |format|
+        format.html { render :template => 'aggregations/preview' }
+      end
+    end
+  end
+
+  def new
+    @page_title = I18n.t('muck.services.new_aggregation')
+    @service_categories = ServiceCategory.sorted.find(:all, :include => [:tag_services])
+    respond_to do |format|
+      format.html { render :template => 'aggregations/new' }
+    end
+  end
+  
+  def create
+    @aggregation = Aggregation.create(params[:aggregation])
+    @parent.aggregations << @aggregation if @parent # associate the parent if present
+    
+    # build a list of feeds and associate them with the aggregation
+    @aggregation.add_feeds(current_user, params[:service_ids])
+    @aggregation.add_feeds_by_uri(current_user, params[:uris])
+
+    respond_to do |format|
+      flash[:notice] = I18n.t('muck.services.add_feeds_to_aggregation', :title => @aggregation.title)
+      format.html { redirect_to(edit_aggregation_path(@aggregation)) }
+      format.xml  { render :xml => @aggregation, :status => :created, :location => @aggregation }
+    end
+
+  rescue ActiveRecord::RecordInvalid => ex
+    respond_to do |format|
+      format.html { render :action => "aggregations/new" }
+      format.xml  { render :xml => @aggregation.errors }
+    end
+  end
+  
+  def edit
+    setup_edit
+    respond_to do |format|
+      format.html { render :template => 'aggregations/edit' }
+    end
+  end
+
+  def update
+    if params[:aggregation]
+      @aggregation.update_attributes!(params[:aggregation])
+      flash[:notice] = I18n.t('muck.services.aggregation_updated')
+    end
+    @feeds = []
+    if params[:uri]
+      @feeds = Feed.feeds_from_uri(params[:uri], current_user)
+      @aggregation.safe_add_feeds(@feeds)
+    elsif params[:service_ids]
+      @aggregation.terms = @aggregation.terms + ",#{params[:terms]}"
+      @aggregation.save!
+      @feeds = @aggregation.add_feeds(current_user, params[:service_ids])
+    end
+    
+    message = I18n.t('muck.services.no_feeds_found') if @feeds.blank?
+    
+    respond_to do |format|
+      format.html { redirect_to edit_polymorphic_url([@aggregation.ownable, @aggregation]) }
+      format.xml  { head :ok }
+      format.json do
+        render :json => { :aggregation => @aggregation,
+                          :feeds => @feeds,
+                          :message => message,
+                          :success => true,
+                          :html => get_google_feed_html }.as_json
+      end
+    end
+  rescue ActiveRecord::RecordInvalid => ex
+    respond_to do |format|
+      format.html do
+        setup_edit
+        render :template => "aggregations/edit"
+      end
+      format.json { render :json => { :aggregation => @aggregation, 
+                                      :feeds => @feeds, 
+                                      :message => ex.to_s, 
+                                      :success => false, 
+                                      :html => '' }.as_json }
+      format.xml  { render :xml => @aggregation.errors }
+    end
+  end
+
+  def destroy
+    @aggregation = Aggregation.find(params[:id])
+    @aggregation.destroy
+    respond_to do |format|
+      flash[:notice] = I18n.t('muck.services.aggregation_deleted', :title => @aggregation.title)
+      format.html { redirect_to polymorphic_url([@aggregation.ownable, :aggregations]) }
+      format.xml  { head :ok }
+    end
+  end
+
+  protected
+    
+    def setup_edit
+      @feeds = @aggregation.all_feeds
+      setup_feed_display_variables
+      @service_categories = ServiceCategory.sorted.find(:all, :include => [:tag_services])
+      @page_title = I18n.t('muck.services.edit_aggregation_title', :title => @aggregation.title)
+    end
+    
+    def get_owner
+      @parent = get_parent
+    end
+    
+    def check_user_permissions
+      unless has_permission?
+        permission_denied
+      end
+    end
+    
+    def get_aggregation
+      @aggregation = Aggregation.find(params[:id])
+    end
+    
+    def has_aggregation_permission?
+      if !@aggregation.can_edit?(current_user)
+        message = I18n.t('muck.services.cant_modify_aggregation')
+        respond_to do |format|
+          format.html do
+            flash[:notice] = message
+            redirect_back_or_default current_user
+          end
+          format.js { render(:update) {|page| page.alert message} }
+        end
+      end
+    end
+    
+    def has_permission?
+      if @parent.blank?
+        admin?
+      else
+        @parent.can_edit?(current_user)
+      end
+    end
+  
+    def setup_feed_display_variables
+      @show_controls = show_controls?
+      @number_of_items = 4
+      @number_of_images = 6
+      @number_of_videos = 6
+    end
+    
+    # determines whether or not to show admin controls (ie save aggregation)
+    def show_controls?
+      logged_in?
+    end
+    
+    def get_google_feed_html
+      render_as_html do
+        render_to_string(:partial => 'aggregations/feeds')
+      end
+    end
+    
+end