power_reviews 0.1.1 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2a2e183b2e2a588ad0b7f13a74d761b3d4f5583
+  data.tar.gz: dd366a763d0c19fe4bd17e5eaeeb1aef0b0d3789
+SHA512:
+  metadata.gz: 6bbbedf27521de7be69d7bb136477ea5535a4d38c2c848eab439ee84dd2f083b256838c3a517223325e07ef328af649802783daec374b0f08d2a6a4eb9515c23
+  data.tar.gz: de26c90d3c0cdcc72d339421a71df29a2ea8b7ed8332dfea6656ce45231a1dd6d00d655ff76def731678ff04a6e56e65234230dd657360a1a94f30f5c29534ae

data/README

@@ -1,13 +1,73 @@
-PowerReviews
-============
+= PowerReviews
 
-Introduction goes here.
+Integrates the third party PowerReviews service with Ruby. Currently focused on Ruby on Rails
+but includes some tools to aid in non-rails tasks like data feed generation and automated
+zip downloads/uploads.
 
+== Dependencies
 
-Example
-=======
+PowerReviews gem requires FasterCSV[http://fastercsv.rubyforge.org/] for csv generation and
+Whenever[http://www.github.com/javan/whenever] for managing your crontab. It also requires that
+a native +zip+ tool be installed.
 
-Example goes here.
+  which zip
+  # /usr/bin/zip
 
+== Getting Started
 
-Copyright (c) 2009 [name of plugin creator], released under the MIT license
+Step one, install the gem.
+
+In your rails environment file:
+
+  config.gem 'power_reviews', :source => 'http://gems.k2sportsdev.com'
+  
+Then
+
+  rake gems:install
+  
+or from your shell:
+
+  gem install power_reviews --source=http://gems.k2sportsdev.com
+  
+With the gem installed it's now time to generate the necessary files in your rails project.
+From the root of your rails project run:
+
+  script/generate power_reviews
+  
+Which will output:
+
+  exists  lib/tasks
+  create  lib/tasks/power_reviews_tasks.rake
+  exists  config/initializers
+  create  config/power_reviews.yml
+  create  config/initializers/power_reviews.rb
+  create  config/schedule.rb
+
+=== Power Reviews configuration
+
+Define which files the PowerReviews::Sync class will be looking for when doing its nigtly download
+of files, like the database.yml file in your rails configuration you can have a different configuration
+for each environment. In this example, for development PowerReviews will use the local filesystem instead
+of connection to the ftp server with the live data.
+
+[+:protocol+]   is the type of sync client you wish to use +:cp+ or +:ftp+
+[+:zip+l]        the zip file you will receive from Power Reviews
+
+  development:
+    protocol:   cp
+    zip:        test/brand.zip
+    done:       test/brand_done.txt
+    datafeed:   tmp/brand_feed.zip
+  
+  production:
+    protocol:   ftp
+    zip:        brand.zip
+    done:       brand_done.txt
+    data_feed:  brand_data.zip
+    host:       partners.powerreviews.com
+    username:   user
+    password:   passy
+
+== Example
+
+Copyright (c) 2009 K2 Sports, released under the MIT license

data/Rakefile

@@ -12,11 +12,13 @@ begin
     gemspec.email = "beaucollins@gmail.com"
     gemspec.homepage = "http://github.com/beaucollins/power_reviews"
     gemspec.authors = ["Beau Collins"]
-    gemspec.add_runtime_dependency 'javan-whenever'
+    gemspec.add_runtime_dependency 'whenever'
     gemspec.add_runtime_dependency 'fastercsv' 
+    gemspec.add_development_dependency 'activesupport'
+    gemspec.add_development_dependency 'shoulda'
   end
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler not available. Install it with: gem install jeweler"
 end
 
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.3.2

data/generators/power_reviews/templates/config/power_reviews.yml

@@ -1,4 +1,4 @@
-# For retrieving the zip file from PowerReviews
+# For retrieving the zip file from PowerReviews and delivering your updated data feed
 # 
 # 
 
@@ -6,11 +6,13 @@ development:
   protocol:   cp
   zip:        test/k2skis.zip
   done:       test/k2skis_done.txt
+  datafeed:   test/k2skis_data.zip
   
 production:
   protocol:   ftp
   zip:        k2skis.zip
   done:       k2skis_done.txt
-  # host:       partners.powerreviews.com
-  # username:   user
-  # password:   passy
+  data_feed:  k2skis_data.zip
+  host:       partners.powerreviews.com
+  username:   user
+  password:   passy

data/generators/power_reviews/templates/lib/tasks/power_reviews_tasks.rake

@@ -1,19 +1,13 @@
-# desc "Explaining what the task does"
-# task :power_reviews do
-#   # Task goes here
-# end
 namespace :power_reviews do
   
-  desc "Generates the product data feed in csv format"
+  desc "Outputs the PowerReviews feed in CSV format"
   task :feed => :environment do
-    puts "Generating Power Reviews product feed"
-    PowerReviews::Feed.process
-    puts "Completed"
+    puts PowerReviews::Feed.process
   end
   
-  desc "Copy the zip file from the ftp and unpack it"
+  desc "Copy the zip file from the ftp and unpack it then deliver the product feed"
   task :sync => :environment do
-    puts "Fetching power review data"
+    puts "Syncing PowerReviews data"
     PowerReviews::Sync.execute
     puts "Completed"
   end

data/lib/power_reviews/config.rb

@@ -1,20 +1,31 @@
 module PowerReviews
   class Config
     
-    def self.merchant_group_id
-      @@merchant_group_id
-    end
+    class << self
+      def merchant_group_id
+        @merchant_group_id
+      end
 
-    def self.merchant_group_id=id
-      @@merchant_group_id = id
-    end
+      def merchant_group_id=id
+        @merchant_group_id = id
+      end
 
-    def self.site_id
-      @@site_id
-    end
+      def site_id
+        @site_id
+      end
     
-    def self.site_id=id
-      @@site_id = id
+      def site_id=id
+        @site_id = id
+      end
+      
+      def review_data_path
+        @review_data_path || 'public/system/pwr'
+      end
+      
+      def review_data_path=path
+        @review_data_path = path
+      end
+      
     end
     
   end

data/lib/power_reviews/feed.rb

@@ -1,3 +1,5 @@
+require "faster_csv"
+
 module PowerReviews
   
   # Collects the feed data then outputs to CSV file for delivery to the power review peeps
@@ -28,8 +30,7 @@ module PowerReviews
     end
     
     def to_csv
-      require 'fastercsv'
-      FasterCSV.open("#{RAILS_ROOT}/tmp/power_reviews.csv", 'w') do |csv|
+      @csv ||= FasterCSV.generate do |csv|
         csv << FeedItem.field_names
         @items.each do |item|
           csv << item.values

data/lib/power_reviews/protocols/base.rb

@@ -24,6 +24,9 @@ module PowerReviews
         puts 'This is the base class'
       end
       
+      def copy_data_feed(from)
+        puts 'This is the base class'
+      end
       
       # do any cleanup necessary
       def cleanup

data/lib/power_reviews/protocols/cp.rb

@@ -16,6 +16,10 @@ module PowerReviews
         FileUtils.cp(@config['zip'], to)
       end
       
+      def copy_data_feed(from)
+        # do nothing, leave the zip where it is
+      end
+      
     end
   end
 end

data/lib/power_reviews/protocols/ftp.rb

@@ -20,6 +20,11 @@ module PowerReviews
         client.getbinaryfile(@config['zip'], to)
       end
       
+      # Puts the data_feed on the specified ftp server
+      def copy_data_feed(from)
+        client.putbinaryfile(from, @config['data_feed'])
+      end
+      
       # do any cleanup necessary
       def cleanup
         @client.close

data/lib/power_reviews/review_data.rb

@@ -0,0 +1,100 @@
+require 'find'
+require 'rexml/document'
+
+module PowerReviews
+  
+  class ReviewData
+    
+    class MissingData < StandardError; end;
+    
+    DATA_FILES = ['review_data_complete', 'review_data_summary']
+    
+    class << self
+      
+      # retrieve the summary data for the given page_id
+      def summary(page_id)
+        document.summary(page_id)
+      rescue MissingData
+        nil
+      end
+      
+      def reload!
+        @document = nil
+      end
+      
+      protected
+      
+        def document
+          @document ||= new
+        end
+            
+    end
+    
+    
+    # initializes a new ReviewData document
+    def initialize(search_path=nil)
+      @search_path = search_path || PowerReviews::Config.review_data_path
+    end
+    
+    def summary(page_id)
+      node = nil
+      summary_data.elements.each("//pageid") do |e|
+        node = e.parent if e.get_text == page_id
+      end
+      !node.nil? ? Summary.new(node) : nil
+    end
+    
+    def summary_data
+      @summary_data ||= read_document('review_data_summary')
+    end
+    
+    def product_data
+      @product_data ||= read_document('review_data_complete')
+    end
+    
+    protected
+    
+      def read_document(name)
+        REXML::Document.new(File.new(xml_documents[name]))
+      end
+    
+      def xml_documents
+        return @files unless @files.nil?
+        files = {}
+        Find.find(@search_path) do |path|
+          bn = File.basename(path, '.xml')
+          files[bn] = path if DATA_FILES.include?(bn)
+        end
+        missing = DATA_FILES.select { |f| files[f].blank? }
+        raise MissingData, "missing Power Reviews xml: #{missing.collect {|f| f + ".xml"}.join(', ')}" unless missing.empty?
+        @files = files
+        @files
+      end
+      
+    class Summary
+      
+      attr_reader :full_name, :average_rating, :reviews
+      
+      def initialize(element)
+        @element = element
+        @full_name = text_for_element('name')
+        @average_rating = text_for_element('average_rating_decimal').to_s.to_f
+        @reviews = text_for_element('fullreviews').to_s.to_i
+      end
+      
+      protected
+      
+        def text_for_element(name)
+          element = nil
+          @element.each_element(name) { |e| element = e if element.nil? }
+          element.nil? ? '' : element.get_text
+        end
+      
+      
+    end
+      
+    
+  end
+  
+  
+end

data/lib/power_reviews/sync.rb

@@ -1,6 +1,7 @@
 require 'power_reviews/protocols/base'
 require 'power_reviews/protocols/cp'
 require 'power_reviews/protocols/ftp'
+require 'power_reviews/feed'
 
 module PowerReviews  
   # Downloads the ftp file and stores it in the correct location unzipped
@@ -13,29 +14,44 @@ module PowerReviews
       :ftp => Protocols::Ftp
     }
     
-    # Execute the necessary actions
-    def self.execute
-      self.start do |client, config|
+    class << self
+    
+      # Execute the necessary actions
+      def execute
+        self.start do |client, config|
         
-        zip_path = "#{RAILS_ROOT}/public/system/reviews.zip"
+          zip_path = "#{Rails.root}/public/system/reviews.zip"
         
-        unless client.done?
-          FileUtils.mkdir_p(File.dirname(zip_path))
-          # we need the correct path to be setup
-          client.copy_zip(zip_path)
-          `cd #{File.dirname(zip_path)} && unzip -o #{zip_path}`
-          client.done!
-        end
+          unless client.done?
+            FileUtils.mkdir_p(File.dirname(zip_path))
+            # we need the correct path to be setup
+            client.copy_zip(zip_path)
+            `cd #{File.dirname(zip_path)} && unzip -o #{zip_path}`
+            client.done!
+          end
         
+          # zip up the powerreviews data tell the client to store it
+          data_path = "#{RAILS_ROOT}/tmp/review_data.csv"
+          File.open(data_path, 'w') do |f|
+            f.puts PowerReviews::Feed.process
+          end
+          client.copy_data_feed(data_path)
+        
+        end
       end
-    end
 
-    # Given the environment loads up the yaml file and creates a new instance
-    def self.start
-      config = YAML::load(File.open("#{RAILS_ROOT}/config/power_reviews.yml"))[RAILS_ENV] || {}
-      syncer = PROTOCOLS[config.delete('protocol').intern].new(config)
-      yield syncer, config
-      syncer.cleanup
+      # Given the environment loads up the yaml file and creates a new instance
+      def start
+        config = self.configure
+        syncer = PROTOCOLS[config.delete('protocol').intern].new(config)
+        yield syncer, config
+        syncer.cleanup
+      end
+      
+      def configure
+        @config ||= YAML::load(File.open("#{RAILS_ROOT}/config/power_reviews.yml"))[Rails.env] || {}
+      end
+    
     end
         
   end

data/lib/power_reviews/view_helpers.rb

@@ -1,10 +1,51 @@
 module PowerReviews
   module ViewHelpers
+    
+    # generates hReview compatible HTML for the given page_id
+    # renders the content as HTML at render time instead of relying
+    # on the Power Reviews javascript library to render the review content
+    def power_reviews_hreview(page_id, &blk)
+      
+      summary = PowerReviews::ReviewData.summary(page_id)
+      
+      if block_given?
+        yield summary unless summary.nil?
+      elsif !summary.nil?
       
-    def power_reviews_javascript_tag
-      javascript_include_tag('/system/pwr/engine/js/full')
+        <<-review
+        <div class='hreview-aggregate'>
+          <span class="item">
+            <span class="fn">#{summary.full_name}</span>
+          </span>
+          <span class="rating">
+            <span class="average">#{summary.average_rating}</span>
+          </span>
+          based on
+          <span class="count">#{summary.reviews}</span> user reviews.
+        </div>
+        review
+      else
+        ''
+      end
+    end
+    
+    # Includes the power reviews javascript, optionally provide the path to
+    # the javascript file if not installed in the default location
+    def power_reviews_javascript_tag(path_to_file = '/system/pwr/engine/js/full')
+      unless @power_reviews_javascript_needed.nil?
+        javascript_include_tag(path_to_file)
+      end
     end
 
+    # Generates the javascript variables for a page that will be rendering
+    # PowerReviews elements
+    # 
+    # Options:
+    # 
+    # +:locale+ - default: en_US
+    # +:zip_location+ - where Power Reviews data is stored default: /system/
+    # +:pr_style_sheet - Location of custom Power Reviews stylesheet default: "" (empty string)
+    # 
     def power_reviews_javascript_variables(options = {})
       options = {
         :locale => 'en_US',
@@ -15,31 +56,65 @@ module PowerReviews
         options.collect { |key, val| "var pr_#{key} =  '#{val}';" unless val.blank? }.compact!.join("\n")
       end
     end
-
+    
+    # Generates JavaScript to display the Power Reviews "snippet" element. Will show a summary
+    # of the reviews for the given +page_id+.
+    # 
+    # Arguments:
+    # +page_id+ - the identifier for the product
+    # +write_review_url+ - the url to link to a page where the user can author a review
+    # +review_ancor+ - the url or anchor that links to the full reviews. Default: "#ReviewHeader"
     def power_reviews_snippet(page_id, write_review_url, review_anchor = '#ReviewHeader')
+      @power_reviews_javascript_needed = true
       javascript_tag do
         <<-eos
-        POWERREVIEWS.display.snippet(document, {
-          pr_page_id : '#{page_id}',
-          pr_write_review : '#{write_review_url}',
-          pr_read_review : '#{review_anchor}'
-        });
+        if(POWERREVIEWS){
+          POWERREVIEWS.display.snippet(document, {
+            pr_page_id : '#{page_id}',
+            pr_write_review : '#{write_review_url}',
+            pr_read_review : '#{review_anchor}'
+          });
+        }
         eos
       end
     end
-
+    
+    # Displays the full reviews for the given +page_id+
+    # 
+    # Arguments:
+    # +page_id+ - The identifier for the item to show reviews for
+    # +write_review_url+ - A url for a page where the user can write a review for the given product
     def power_reviews_display(page_id, write_review_url)
+      @power_reviews_javascript_needed = true
       javascript_tag do
         <<-eos
-        POWERREVIEWS.display.engine(document, {
-          pr_page_id : '#{page_id}',
-          pr_write_review : '#{write_review_url}'
-        });
+        if(POWERREVIEWS){
+          POWERREVIEWS.display.engine(document, {
+            pr_page_id : '#{page_id}',
+            pr_write_review : '#{write_review_url}'
+          });
+        }
         eos
       end
     end
   
+    # Generates the javascript that renders the PowerReviews authoring form.
+    # 
+    # Arguments:
+    # +page_id+ - The id of the item being reviewd
+    # 
+    # Options:
+    # +:locale+ default ""
+    # +:site_id+ default: PowerReviews::Config.site_id
+    # +:merchant_group_id+ default: PowerReviews::Config.merchant_group_id
+    # +:source+ default: 'web'
+    # +:merchant_user_id+ default: ''
+    # +:merchant_user_email+ default: ''
+    # +:promo_code+ default: ''
+    # +:style_sheet+ default: ''
+    
     def power_reviews_form(page_id, options = {})
+      @power_reviews_javascript_needed = true
       options = {
         :locale => '',
         :site_id => PowerReviews::Config.site_id,

data/lib/power_reviews.rb

@@ -1,4 +1,5 @@
 require 'power_reviews/config'
+require 'power_reviews/review_data'
 
 require 'power_reviews/feed_item'
 require 'power_reviews/feed'