muck-raker 0.1.26 → 0.1.27

data/.gitignore

@@ -27,3 +27,4 @@ pkg/*
 coverage
 rdoc
 pkg
+test/feed_archive

data/README.rdoc

@@ -22,11 +22,42 @@ After install acts-as-taggable-on be sure to include the helper in application_h
     include TagsHelper
   end
 
-
 Add rake tasks to your Rakefile
 
   require 'muck_raker/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'
+  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'
+
+
+
+=== 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-raker 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-raker 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.
@@ -40,11 +71,15 @@ To install these gems:
   sudo gem install muck-activities
   sudo gem install muck-shares
 
+If you enable comments you will need a comment model with 'acts_as_muck_raker_comment':
 
-== Example
-
+class Comment < ActiveRecord::Base
+  acts_as_muck_comment
+  acts_as_muck_raker_comment
+end
 
-== Development
+=== 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.

data/VERSION

@@ -1 +1 @@
-0.1.26
+0.1.27

data/app/controllers/muck/feeds_controller.rb

@@ -51,7 +51,13 @@ class Muck::FeedsController < ApplicationController
     after_create_response(@feed.save)
   end
 
-
+  def edit
+    @feed = Feed.find(params[:id])
+    respond_to do |format|
+      format.html { render :template => 'feeds/edit', :layout => 'popup' }
+    end
+  end
+  
   def update
     @feed = Feed.find(params[:id])
     after_update_response(@feed.update_attributes(params[:feed]))
@@ -124,5 +130,5 @@ class Muck::FeedsController < ApplicationController
         format.xml  { head :ok }
       end
     end
-  
+    
 end

data/app/controllers/muck/identity_feeds_controller.rb

@@ -0,0 +1,154 @@
+class Muck::IdentityFeedsController < ApplicationController
+  
+  unloadable
+  
+  before_filter :get_owner, :only => [:index, :new, :create]
+  before_filter :has_permission?, :only => [:index, :new, :create]
+  
+  before_filter :get_identity_feed, :only => [:destroy, :update]
+  before_filter :has_identity_feed_permission?, :only => [:destroy, :update]
+  
+  def index
+    @service_categories = ServiceCategory.sorted.find(:all, :include => [:identity_services])
+    @user_services = @parent.identity_feeds.find(:all, :include => [{:feed => :service}])
+    respond_to do |format|
+      format.html { render :template => 'identity_feeds/index' }
+    end
+  end
+  
+  def new
+    @service = Service.find(params[:service_id])
+    @feed = Feed.new
+    respond_to do |format|
+      format.html { render :template => 'identity_feeds/new' }
+      format.pjs { render :text => get_new_html(@service, @parent, @feed) }
+    end
+  end
+  
+  def create
+    @service = Service.find(params[:service_id])
+    @feed = Feed.new(:uri => params[:uri], :login => params[:username])
+    feeds = Feed.create_service_feeds(@service, params[:uri], params[:username], params[:password], current_user.id)
+    if feeds.blank?
+      success = false
+      if params[:username]
+        message = I18n.t('muck.raker.no_feeds_from_username')
+      else
+        message = I18n.t('muck.raker.no_feeds_at_uri')
+      end
+    else
+      success, messages = add_feeds_to_parent(@parent, feeds)
+      message = messages.join('<br />')
+    end
+    respond_to do |format|
+      format.html do
+        flash[:notice] = message if message
+        redirect_to polymorphic_url([@parent, :identity_feeds]) 
+      end
+      format.pjs do
+        flash[:notice] = message if message
+        render :template => 'identity_feeds/new', :layout => false
+      end
+      format.json do
+        render :json => {:parent => @parent, :service => @service, :feeds => feeds, :success => success, :message => message }.as_json
+      end
+    end
+  end
+  
+  def edit
+    @identity_feed = IdentityFeed.find(params[:id])
+    respond_to do |format|
+      format.html { render :template => 'identity_feeds/edit' }
+      format.pjs { render :text => get_edit_html(@identity_feed) }
+    end
+  end
+  
+  def update
+  end
+  
+  def destroy
+    feed = @identity_feed.feed
+    @identity_feed.destroy
+    feed.delete_if_unused(current_user) # Delete the feed if there are no references to it
+    respond_to do |format|
+      format.html do
+        flash[:notice] = t("muck.raker.identity_feed_removed")
+        redirect_to polymorphic_url([@identity_feed.ownable, :identity_feeds]) 
+      end
+      format.js do
+        render(:update) do |page|
+          page << "jQuery('##{@identity_feed.dom_id}').fadeOut();"
+        end
+      end
+      format.json do
+        render :json => { :success => true,
+                          :identity_feed => @identity_feed,
+                          :message => t("muck.raker.identity_feed_removed") }
+      end
+    end
+  end
+  
+  protected
+    
+    def get_owner
+      setup_parent('service')
+    end
+    
+    def get_identity_feed
+      @identity_feed = IdentityFeed.find(params[:id])
+    end
+    
+    def has_identity_feed_permission?
+      if !@identity_feed.can_edit?(current_user)
+        message = I18n.t('muck.raker.cant_modify_identity_feed')
+        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?
+      @parent.can_edit?(current_user)
+    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
+    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
+    end
+    
+    def add_feeds_to_parent(parent, feeds)
+      messages = []
+      success = false
+      feeds.each do |feed|
+        begin
+          parent.own_feeds << feed
+          success = true
+          if params[:username]
+            messages << I18n.t('muck.raker.successfully_added_username_feed', :service => feed.title || @service.name)
+          else
+            messages << I18n.t('muck.raker.successfully_added_uri_feed', :service => @service.name, :uri => feed.title || params[:uri])
+          end
+        rescue ActiveRecord::RecordInvalid => ex
+          if ex.to_s == 'Validation failed: Feed has already been taken'
+            if params[:username]
+              messages << I18n.t('muck.raker.already_added_username_feed', :service => feed.title || @service.name, :username => params[:username])
+            else
+              messages << I18n.t('muck.raker.already_added_uri_feed', :service => @service.name, :uri => feed.title || params[:uri])
+            end
+          end
+        end
+      end
+      [success, messages]
+    end
+end

data/app/controllers/muck/visits_controller.rb

@@ -8,8 +8,14 @@ class Muck::VisitsController < ApplicationController
     @entry = Entry.find(params[:id])
     @page_title = @entry.title
     @resource_uri = @entry.resource_uri
-    @comments = @entry.comments.by_newest if GlobalConfig.enable_raker_comments
     @share = Share.new(:title => @entry.title, :uri => @resource_uri, :entry_id => @entry.id) if GlobalConfig.enable_raker_shares
+
+    if GlobalConfig.enable_raker_comments
+      # Show the activities related to this entry
+      @activities = @entry.activities.oldest.only_public.find(:all, :include => ['comments'])
+      @comment_count = @activities.length + @activities.inject(0) {|n,activity| activity.comments.length + n }
+    end
+    
     respond_to do |format|
       format.html { render :template => 'visits/show', :layout => 'frame' }
       format.pjs { render :template => 'visits/show', :layout => false }

data/app/helpers/muck_raker_services_helper.rb

@@ -0,0 +1,117 @@
+module MuckRakerServicesHelper
+  
+  # Render a summary of all services for the given parent.  The parent should 'acts_as_muck_feed_owner' 
+  def services_summary(parent)
+    identity_feeds = parent.identity_feeds.find(:all, :include => [{:feed => :service}])
+    render :partial => 'services/summary', :locals => { :identity_feeds => identity_feeds }
+  end
+  
+  # Render a view with all services in categories.
+  # service_categories: Results from a query to service_categories.  For performance try something like this:
+  #                     ServiceCategory.sorted.find(:all, :include => [:identity_services])
+  # title: Optional title.  Default is 'Available Services' - from I18n.t('muck.raker.available_services')
+  # css: Optional css to be added to the div that surrounds the categories
+  def service_categories(service_categories, title = nil, css = '')
+    render :partial => 'identity_feeds/service_categories', :locals => { :service_categories => service_categories, :css => css, :title => title }
+  end
+  
+  # Render a view with the user's registered services.
+  # identity_feeds: Results from a query to service_categories.  For performance try something like this:
+  #                 @user.identity_feeds.find(:all, :include => [{:feed => :service}])
+  # title: Optional title.  Default is 'My Services' - from I18n.t('muck.raker.my_services')
+  # css: Optional css to be added to the div that surrounds the categories
+  def services_for_user(identity_feeds, title = nil, css = '')
+    render :partial => 'identity_feeds/services_for_user', :locals => { :identity_feeds => identity_feeds, :css => css, :title => title, :edit => false }
+  end
+  
+  # Render an edit view with the user's registered services.
+  # identity_feeds: Results from a query to service_categories.  For performance try something like this:
+  #                 @user.identity_feeds.find(:all, :include => [{:feed => :service}])
+  # title: Optional title.  Default is 'My Services' - from I18n.t('muck.raker.my_services')
+  # css: Optional css to be added to the div that surrounds the categories
+  def services_for_user_edit(identity_feeds, title = nil, css = '')
+    render :partial => 'identity_feeds/services_for_user', :locals => { :identity_feeds => identity_feeds, :css => css, :title => title, :edit => true }
+  end
+  
+  # Renders an icon for the given service
+  # Name is the name of the image file associated with the service
+  # Size can be one of 16, 24, 48 or 60.
+  def service_icon(name, size = 24)
+    %Q{<img src="/images/service_icons/#{size}/#{name}" />}
+  end
+  
+  def service_image(name, size = 24)
+    %Q{/images/service_icons/#{size}/#{name}}
+  end
+  
+  # Renders name and icon for the service
+  def service_title(service)
+    %Q{<div class="identity-service-title" #{service_icon_background(service)}>#{service_prompt(service)}</div>}
+  end
+  
+  # By default renders Service username e.g. Flickr username
+  # If the service has a 'prompt' set it will look for a value in the localization
+  # files.  For example, setting service.prompt to 'blog_url' will cause this method
+  # to look for a translation at muck.raker.blog_url and will pass the name of the service
+  # using 'service' so your translation might look like:
+  # muck.raker.blog_url: "Blog Url" or
+  # muck.raker.facebook_prompt: "{{service}} Feeds"
+  def service_prompt(service)
+    if @service.prompt.blank?
+      I18n.t('muck.raker.service_username', :service => @service.name)
+    else
+      I18n.t("muck.raker.#{@service.prompt}", :service => @service.name)
+    end
+  end
+  
+  # Renders a link for a new user service with class 'lightbox' or optional css set on the link.
+  def service_lightbox(parent, service, link_css = 'lightbox', wrapper = 'li')
+    path = new_polymorphic_url([parent, :identity_feed], :service_id => service.to_param)
+    service_link(path, service, link_css, wrapper, nil, nil, "#{service.name.parameterize}-link")
+  end
+
+  # Renders a link for editing a user feed with class 'lightbox' or optional css set on the link.
+  def service_lightbox_edit(parent, identity_feed, link_css = 'lightbox', wrapper = nil)
+    path = edit_polymorphic_url([parent, identity_feed])
+    link_text = identity_feed.feed.title unless identity_feed.feed.title.blank?
+    service_link(path, identity_feed.feed.service, link_css, wrapper, link_text)
+  end
+  
+  def service_external_link(identity_feed, link_css = nil, wrapper = nil)
+    path = identity_feed.feed.display_uri || identity_feed.feed.uri
+    link_text = identity_feed.feed.title unless identity_feed.feed.title.blank?
+    service_link(path, identity_feed.feed.service, link_css, wrapper, link_text, 'blank')
+  end
+  
+  # Renders a delete button for an identity_feed
+  def service_delete(identity_feed, button_type = :button, button_text = t("muck.general.delete"))
+    render :partial => 'shared/delete', :locals => { :delete_object => identity_feed, 
+                                                     :button_type => button_type,
+                                                     :button_text => button_text,
+                                                     :form_class => 'identity-feed-delete',
+                                                     :delete_path => identity_feed_path(identity_feed, :format => 'js') }
+  end
+  
+  # Renders a service link optionally wrapping it in the specified element
+  def service_link(path, service, link_css, wrapper, link_text = nil, target = nil, id = nil)
+    link = %Q{<a #{'id=' + id if id} href="#{path}" #{service_icon_background(service)} #{'target=' + target if target} class="service-link #{link_css}">#{link_text || service.name}</a>}
+    if wrapper
+      content_tag wrapper, link, :class => 'identity-service' 
+    else
+      link
+    end
+  end
+  
+  def service_icon_background(service)
+    %Q{style="background: transparent url('#{service_image(service.icon, 24)}') no-repeat scroll left top;"}
+  end
+  
+  def url_by_identity_feed(owner, identity_feed, service)
+    if identity_feed
+      polymorphic_url([owner, @identity_feed], :service_id => service.to_param)
+    else
+      polymorphic_url([owner, :identity_feeds], :service_id => service.to_param)
+    end
+  end
+  
+end

data/app/models/aggregation.rb

@@ -0,0 +1,17 @@
+class Aggregation < ActiveRecord::Base
+  
+  # ##########################################################
+  # # adds a feed to an aggregation and saves the feed
+  # def add_feed_to_aggregation(aggregation, feed)
+  #   if aggregation.feeds.include?(feed)
+  #     self.already_feeds.push(feed)
+  #   else
+  #     if feed.save # have to save here so that feed has an id.  Without id can't associate with aggregation
+  #       feed.aggregations << aggregation
+  #       self.added_feeds.push(feed )
+  #     end
+  #   end
+  #   feed.save
+  # end
+
+end

data/app/models/amazon.rb

@@ -0,0 +1,59 @@
+require 'openssl'
+
+class Amazon
+  
+  # Do we have support for the SHA-256 Secure Hash Algorithm?
+  # Note that Module#constants returns Strings in Ruby 1.8 and Symbols in 1.9.
+  DIGEST_SUPPORT = OpenSSL::Digest.constants.include?('SHA256') || OpenSSL::Digest.constants.include?(:SHA256)
+
+  # Requests are authenticated using the SHA-256 Secure Hash Algorithm.
+  DIGEST = OpenSSL::Digest::Digest.new('sha256') if DIGEST_SUPPORT
+
+  ECS_TO_RSS_WISHLIST = "http://www.folksemantic.com/ecs_to_rss-wishlist.xslt"
+  
+  AMAZON_SITES = {
+    :ca => 'http://ecs.amazonaws.ca/onca/xml',
+    :de => 'http://ecs.amazonaws.de/onca/xml',
+    :fr => 'http://ecs.amazonaws.fr/onca/xml',
+    :jp => 'http://ecs.amazonaws.jp/onca/xml',
+    :uk => 'http://ecs.amazonaws.co.uk/onca/xml',
+    :us => 'http://ecs.amazonaws.com/onca/xml'
+  }
+
+  AMAZON_XSLT_SITES = {
+    :ca => 'http://xml-ca.amznxslt.com/onca/xml',
+    :de => 'http://xml-de.amznxslt.com/onca/xml',
+    :fr => 'http://xml-fr.amznxslt.com/onca/xml',
+    :jp => 'http://xml-jp.amznxslt.com/onca/xml',
+    :uk => 'http://xml-uk.amznxslt.com/onca/xml',
+    :us => 'http://xml-us.amznxslt.com/onca/xml'
+  }
+  
+  # Sign an amazon query
+  # Requires openssl and that GlobalConfig.amazon_secret_access_key be defined.
+  # Based on ruby-aaws and documentation here
+  # http://www.caliban.org/ruby/ruby-aws/
+  # http://docs.amazonwebservices.com/AWSECommerceService/latest/DG/index.html?RequestAuthenticationArticle.html
+  # Parameters
+  # query:    The query to be signed
+  def self.sign_query(uri, query, amazon_secret_access_key)
+    raise 'SHA-256 not available in this version of openssl.  Cannot sign Amazon requests.' unless DIGEST_SUPPORT
+    query << "&Timestamp=#{Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')}"
+    new_query = query.split('&').collect{|param| "#{param.split('=')[0]}=#{url_encode(param.split('=')[1])}"}.sort.join('&')
+    to_sign = "GET\n%s\n%s\n%s" % [uri.host, uri.path, new_query]
+    hmac = OpenSSL::HMAC.digest(DIGEST, amazon_secret_access_key, to_sign)
+    base64_hmac = [hmac].pack('m').chomp
+    signature = url_encode(base64_hmac)
+    new_query << "&Signature=#{signature}"
+  end
+  
+  # Encode a string, such that it is suitable for HTTP transmission.
+  def self.url_encode(string)
+    return '' if string.nil?
+    # Shamelessly plagiarised from Wakou Aoyama's cgi.rb, but then altered slightly to please AWS.
+    string.gsub( /([^a-zA-Z0-9_.~-]+)/ ) do
+      '%' + $1.unpack( 'H2' * $1.bytesize ).join( '%' ).upcase
+    end
+  end
+  
+end

data/app/models/amazon_request.rb

@@ -0,0 +1,83 @@
+class AmazonRequest
+  include HTTParty
+  format :xml
+  
+  # Initialize Amazon Request.  Obtain valid Amazon credentials from your developer account
+  # Parameters:
+  # amazon_access_key_id:     Valid Amazon access key
+  # amazon_secret_access_key: Valid Amazon secret access key
+  # amazon_associate_tag:     Valid Amazon associates tag (optional)
+  # locale:                   Locale for the specific amazon site to use valid values are :ca, :de, :fr, :jp, :uk, :us (optional, default is us)
+  def initialize(amazon_access_key_id, amazon_secret_access_key, amazon_associate_tag = nil, locale = :us)
+    @amazon_access_key_id = amazon_access_key_id
+    @amazon_secret_access_key = amazon_secret_access_key
+    @amazon_associate_tag = amazon_associate_tag
+    @locale = locale
+  end
+  
+  # Generate rss feeds for the give email
+  # Parameters:
+  # email:    email for which to find feeds.
+  def get_amazon_feeds(email)
+    wishlists = get_customer_wishlists(email)
+    if !wishlists.blank?
+      wishlist_ids = wishlists.collect{|list| list['ListId']}
+      generate_wishlist_rss(wishlist_ids)
+    end
+  end
+  
+  # Get matching id for the given email
+  # Parameters:
+  # email:  customer's email.
+  def get_customer_id(email)
+    query = "Operation=CustomerContentSearch&Email=#{email}"
+    result = make_request(query)
+    if result['CustomerContentSearchResponse']['Customers']['TotalResults'].to_i > 0
+      result['CustomerContentSearchResponse']['Customers']['Customer'][0]
+    end
+  end
+  
+  # Get information for the given customer id
+  def get_customer_information(customer_id)
+    query = "Operation=CustomerContentLookup&ResponseGroup=CustomerLists&CustomerId=#{customer_id}"
+    make_request(query)
+  end
+
+  # Get customer's wishlist ids
+  def get_customer_wishlists(email)
+    query = "Operation=ListSearch&ListType=WishList&Email=#{email}"
+    result = make_request(query)
+    result['ListSearchResponse']['Lists']['List']
+  end
+  
+  def generate_wishlist_rss(wishlist_ids)
+    feeds = []
+    wishlist_ids.each do |wishlist_id|
+      query = "Operation=ListLookup&ListType=WishList&ListId=#{wishlist_id}&ResponseGroup=ItemAttributes,ListItems,ListInfo,Offers&Sort=DateAdded&Style=#{Amazon::ECS_TO_RSS_WISHLIST}"
+      feeds << make_xslt_request(query)
+    end
+    feeds
+  end
+  
+  protected
+    def make_request(query)
+      add_required_params(query)
+      uri = Amazon::AMAZON_SITES[@locale]
+      signed_query = Amazon.sign_query(URI.parse(uri), query, @amazon_secret_access_key)
+      AmazonRequest.get(uri, :query => signed_query)
+    end
+    
+    def make_xslt_request(query)
+      add_required_params(query)
+      uri = Amazon::AMAZON_XSLT_SITES[@locale]
+      signed_query = Amazon.sign_query(URI.parse(uri), query, @amazon_secret_access_key)
+      "#{uri}?#{signed_query}"
+    end
+    
+    def add_required_params(query)
+      query << "&Service=AWSECommerceService"
+      query << "&AWSAccessKeyId=#{@amazon_access_key_id}"
+      query << "&AssociateTag=#{@amazon_associate_tag}" if @amazon_associate_tag
+      query << "&Version=2009-07-01"
+    end
+end

data/app/models/click.rb

@@ -9,14 +9,6 @@
 #  requester         :string(255)
 #  user_agent        :string(2083)
 #
-# Indexes
-#
-#  index_clicks_on_recommendation_id  (recommendation_id)
-#  index_clicks_on_referrer           (referrer)
-#  index_clicks_on_requester          (requester)
-#  index_clicks_on_user_agent         (user_agent)
-#  index_clicks_on_when               (when)
-#
 
 class Click < ActiveRecord::Base
 end

data/app/models/entry.rb

@@ -42,7 +42,8 @@ class Entry < ActiveRecord::Base
   
   belongs_to :feed
   belongs_to :language
-  
+  has_many :activities, :as => :attachable, :dependent => :destroy
+  has_many :attentions, :dependent => :destroy
   acts_as_commentable
   acts_as_taggable