power_reviews 0.1.1

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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

@@ -0,0 +1,13 @@
+PowerReviews
+============
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2009 [name of plugin creator], released under the MIT license

data/Rakefile

@@ -0,0 +1,72 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+# require 'rake/gempackagetask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "power_reviews"
+    gemspec.summary = "Helps integrate Power Reviews into a rails site"
+    gemspec.description = "Tools and library for integrating Power Reviews into a rails website."
+    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 'fastercsv' 
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the power_reviews plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the power_reviews plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PowerReviews'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+# PKG_FILES = FileList[
+#   '[a-zA-Z]*',
+#   'generators/**/*',
+#   'lib/**/*',
+#   'rails/**/*',
+#   'test/**/*'
+# ]
+# 
+# spec = Gem::Specification.new do |s|
+#   s.name = 'power_reviews'
+#   s.version = "0.0.1"
+#   s.author = 'Beau Collins'
+#   s.email = 'beau_collins@k2sports.com'
+#   s.homepage = 'http://k2sports.com'
+#   s.platform = Gem::Platform::RUBY
+#   s.summary = s.description = "Helps integrate Power Reviews into a rails site"
+#   s.files = PKG_FILES.to_a
+#   s.require_path = "lib"
+#   s.has_rdoc = false
+#   s.extra_rdoc_files = ['README']
+#   s.add_runtime_dependency 'javan-whenever' # this is a github gem
+#   s.add_runtime_dependency 'fastercsv'
+# end
+
+# desc "Turn this plugin into a a gem."
+# Rake::GemPackageTask.new(spec) do |pkg|
+#   pkg.gem_spec = spec
+# end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/generators/power_reviews/USAGE

@@ -0,0 +1,16 @@
+Description:
+    For integrating power reviews into your Rails site. Handles the downloading of PowerReviews
+    zip files via FTP and provides helpers to display power reviews data in your site.
+    
+    Also provides an interface for creating a product data feed in CSV format to help making data
+    feeds easier.
+    
+    Uses whenever [http://github.com/javan/whenever] to provide a cron schedule.
+
+Example:
+    ./script/generate power_reviews
+
+    This will create:
+      config/power_reviews.yml
+      config/schedule.rb
+      config/initializer/power_reviews.rb

data/generators/power_reviews/power_reviews_generator.rb

@@ -0,0 +1,15 @@
+class PowerReviewsGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory "lib/tasks"
+      m.file 'lib/tasks/power_reviews_tasks.rake', 'lib/tasks/power_reviews_tasks.rake'
+      
+      m.directory "config/initializers"
+
+      m.file 'config/power_reviews.yml', 'config/power_reviews.yml', :collision => :skip
+      m.file 'config/initializers/power_reviews.rb', 'config/initializers/power_reviews.rb', :collision => :skip
+      m.file 'config/schedule.rb', 'config/schedule.rb'
+            
+    end
+  end
+end

data/generators/power_reviews/templates/config/initializers/power_reviews.rb

@@ -0,0 +1,20 @@
+# Unique for each merchant. Your merchant_group_id is located in the PowerReviews Dashboard > Merchant
+# Group Properties section.
+
+# PowerReviews::Config.merchant_group_id = 0
+
+# ID representing your website (default value is "1"). If you have multiple websites and would like to
+# integrate PowerReviews onto each site, we can set your account as a Master Merchant. This enables
+# review sharing and consolidated management among your different websites. When using the “Master
+# Merchant” configuration, you assign a different Site ID to each site that will have reviews. This ID
+# can be your own internal ID for the site or an ID assigned by PowerReviews. If you are implementing
+# a single merchant, please leave the default Site ID set to "1". The Site ID is configurable in the
+# Dashboard in the Merchant Properties section.
+
+# PowerReviews::Config.site_id = 1
+
+# Supply the Power Reviews feed processor with items to produce. Feed is an
+# instance of PowerReviews::Feed.
+# 
+# 
+# PowerReviews::Feed.processor = lambda { |feed| }

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

@@ -0,0 +1,16 @@
+# For retrieving the zip file from PowerReviews
+# 
+# 
+
+development:
+  protocol:   cp
+  zip:        test/k2skis.zip
+  done:       test/k2skis_done.txt
+  
+production:
+  protocol:   ftp
+  zip:        k2skis.zip
+  done:       k2skis_done.txt
+  # host:       partners.powerreviews.com
+  # username:   user
+  # password:   passy

data/generators/power_reviews/templates/config/schedule.rb

@@ -0,0 +1,3 @@
+every 1.day, :at => '4:30 am' do
+  rake 'power_reviews:sync'
+end

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

@@ -0,0 +1,21 @@
+# 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"
+  task :feed => :environment do
+    puts "Generating Power Reviews product feed"
+    PowerReviews::Feed.process
+    puts "Completed"
+  end
+  
+  desc "Copy the zip file from the ftp and unpack it"
+  task :sync => :environment do
+    puts "Fetching power review data"
+    PowerReviews::Sync.execute
+    puts "Completed"
+  end
+  
+end

data/lib/power_reviews/config.rb

@@ -0,0 +1,21 @@
+module PowerReviews
+  class Config
+    
+    def self.merchant_group_id
+      @@merchant_group_id
+    end
+
+    def self.merchant_group_id=id
+      @@merchant_group_id = id
+    end
+
+    def self.site_id
+      @@site_id
+    end
+    
+    def self.site_id=id
+      @@site_id = id
+    end
+    
+  end
+end

data/lib/power_reviews/feed.rb

@@ -0,0 +1,42 @@
+module PowerReviews
+  
+  # Collects the feed data then outputs to CSV file for delivery to the power review peeps
+  # Requires a proc that will find the data and populate
+  class Feed
+    
+    @@processor = nil
+    attr_reader :items
+    
+    def initialize
+      @items = Array.new
+    end
+    
+    # add an item to the feed
+    def << item
+      raise ArgumentError unless item.is_a?(FeedItem)
+      @items << item
+    end
+    
+    def self.processor=blk
+      @@processor = blk
+    end
+    
+    def self.process
+      feed = self.new
+      @@processor[feed] unless @@processor.nil?
+      feed.to_csv
+    end
+    
+    def to_csv
+      require 'fastercsv'
+      FasterCSV.open("#{RAILS_ROOT}/tmp/power_reviews.csv", 'w') do |csv|
+        csv << FeedItem.field_names
+        @items.each do |item|
+          csv << item.values
+        end
+      end
+    end
+    
+  end
+  
+end

data/lib/power_reviews/feed_item.rb

@@ -0,0 +1,36 @@
+module PowerReviews
+  
+  class FeedItem
+    
+    CATEGORY_SEPARATOR = " > "
+    
+    REQUIRED_FIELDS = [:product_url, :name, :description, :price, :image_url, :category, :page_id]
+    OPTIONAL_FIELDS = [:manufacturer_id, :shipping, :brand, :upc, :specifications, :in_stock,
+                      :affiliate_id, :affiliate_url, :add_to_cart_url, :page_id_variant]
+                      
+    FIELDS = REQUIRED_FIELDS + OPTIONAL_FIELDS
+    
+    FIELDS.each {|field| attr_accessor field }
+    
+    def initialize(attributes = {})
+      attributes ||= {}
+      attributes.each do |field, value|
+        self.send("#{field.to_s}=".intern, value)
+      end
+    end
+    
+    def category=cat
+      @category = cat.is_a?(Array) ? cat.join(CATEGORY_SEPARATOR) : cat.to_s
+    end
+    
+    def values
+      FIELDS.collect {|f| self.send(f) }
+    end
+    
+    def self.field_names
+      FIELDS.collect { |f| f.to_s }
+    end
+    
+  end
+  
+end

data/lib/power_reviews/protocols/base.rb

@@ -0,0 +1,36 @@
+module PowerReviews
+  module Protocols
+    
+    # This should provide the necessary actions for moving the zip
+    # and
+    class Base
+      
+      def initialize(config={})
+        @config = config || {}
+      end
+      
+      # Returns true if the done file is missing
+      def done?
+        true
+      end
+      
+      # Delete the done file
+      def done!
+        
+      end
+      
+      # Do the copying of the zip file to the preferred destination
+      def copy_zip(to)
+        puts 'This is the base class'
+      end
+      
+      
+      # do any cleanup necessary
+      def cleanup
+        
+      end
+      
+    end
+    
+  end
+end

data/lib/power_reviews/protocols/cp.rb

@@ -0,0 +1,21 @@
+module PowerReviews
+  module Protocols
+    class Cp < Base
+      
+      require 'fileutils'
+      
+      def done?
+        !File.exists?(@config['done'])
+      end
+      
+      def done!
+        File.delete(@config['done'])
+      end
+      
+      def copy_zip(to)
+        FileUtils.cp(@config['zip'], to)
+      end
+      
+    end
+  end
+end

data/lib/power_reviews/protocols/ftp.rb

@@ -0,0 +1,37 @@
+
+require "net/ftp"
+
+module PowerReviews
+  module Protocols
+    class Ftp < Base
+      
+      # Returns true if the done file is missing
+      def done?
+        !client.nlst.include?(@config['done'])
+      end
+      
+      # Delete the done file
+      def done!
+        client.delete(@config['done'])
+      end
+      
+      # Do the copying of the zip file to the preferred destination
+      def copy_zip(to)
+        client.getbinaryfile(@config['zip'], to)
+      end
+      
+      # do any cleanup necessary
+      def cleanup
+        @client.close
+      end
+      
+      def client
+        return @client unless @client.nil?
+        @client = Net::FTP.new(@config['host'])
+        @client.login(@config['username'], @config['password'])
+        @client
+      end
+      
+    end
+  end
+end

data/lib/power_reviews/routes.rb

@@ -0,0 +1,9 @@
+module PowerReviews #:nodoc:
+  module Routes
+    def power_reviews
+      @set.add_route("/reviews", {:controller => "power_reviews_controller", :action => "index"})
+    end
+  end
+end
+
+ActionController::Routing::RouteSet::Mapper.send :include, PowerReviews::Routes

data/lib/power_reviews/sync.rb

@@ -0,0 +1,43 @@
+require 'power_reviews/protocols/base'
+require 'power_reviews/protocols/cp'
+require 'power_reviews/protocols/ftp'
+
+module PowerReviews  
+  # Downloads the ftp file and stores it in the correct location unzipped
+  class Sync
+    require 'yaml'
+    require 'fileutils'
+    
+    PROTOCOLS = {
+      :cp => Protocols::Cp,
+      :ftp => Protocols::Ftp
+    }
+    
+    # Execute the necessary actions
+    def self.execute
+      self.start do |client, config|
+        
+        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
+        
+      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
+    end
+        
+  end
+  
+end

data/lib/power_reviews/view_helpers.rb

@@ -0,0 +1,62 @@
+module PowerReviews
+  module ViewHelpers
+      
+    def power_reviews_javascript_tag
+      javascript_include_tag('/system/pwr/engine/js/full')
+    end
+
+    def power_reviews_javascript_variables(options = {})
+      options = {
+        :locale => 'en_US',
+        :zip_location => '/system/',
+        :pr_style_sheet => ''
+      }.merge(options)
+      javascript_tag do
+        options.collect { |key, val| "var pr_#{key} =  '#{val}';" unless val.blank? }.compact!.join("\n")
+      end
+    end
+
+    def power_reviews_snippet(page_id, write_review_url, review_anchor = '#ReviewHeader')
+      javascript_tag do
+        <<-eos
+        POWERREVIEWS.display.snippet(document, {
+          pr_page_id : '#{page_id}',
+          pr_write_review : '#{write_review_url}',
+          pr_read_review : '#{review_anchor}'
+        });
+        eos
+      end
+    end
+
+    def power_reviews_display(page_id, write_review_url)
+      javascript_tag do
+        <<-eos
+        POWERREVIEWS.display.engine(document, {
+          pr_page_id : '#{page_id}',
+          pr_write_review : '#{write_review_url}'
+        });
+        eos
+      end
+    end
+  
+    def power_reviews_form(page_id, options = {})
+      options = {
+        :locale => '',
+        :site_id => PowerReviews::Config.site_id,
+        :merchant_group_id => PowerReviews::Config.merchant_group_id,
+        :source => 'web',
+        :merchant_user_id => '',
+        :merchant_user_email => '',
+        :promo_code => '',
+        :style_sheet => ''
+      }.merge(options)
+    
+      javascript_tag do
+        options.collect { |key, val| "var pr_#{key} = '#{val}';" unless val.blank? }.unshift("var pr_page_id = '#{page_id}';").compact!.join("\n")
+      end << javascript_include_tag('/system/pwr/engine/js/appLaunch')
+    
+    end
+  
+  end
+  
+end

data/lib/power_reviews.rb

@@ -0,0 +1,9 @@
+require 'power_reviews/config'
+
+require 'power_reviews/feed_item'
+require 'power_reviews/feed'
+
+require 'power_reviews/sync'
+require 'power_reviews/view_helpers'
+
+ActionView::Base.send :include, PowerReviews::ViewHelpers if defined? ActionView::Base

data/power_reviews.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{power_reviews}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Beau Collins"]
+  s.date = %q{2009-09-29}
+  s.description = %q{Tools and library for integrating Power Reviews into a rails website.}
+  s.email = %q{beaucollins@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "generators/power_reviews/USAGE",
+     "generators/power_reviews/power_reviews_generator.rb",
+     "generators/power_reviews/templates/config/initializers/power_reviews.rb",
+     "generators/power_reviews/templates/config/power_reviews.yml",
+     "generators/power_reviews/templates/config/schedule.rb",
+     "generators/power_reviews/templates/lib/tasks/power_reviews_tasks.rake",
+     "lib/power_reviews.rb",
+     "lib/power_reviews/config.rb",
+     "lib/power_reviews/feed.rb",
+     "lib/power_reviews/feed_item.rb",
+     "lib/power_reviews/protocols/base.rb",
+     "lib/power_reviews/protocols/cp.rb",
+     "lib/power_reviews/protocols/ftp.rb",
+     "lib/power_reviews/routes.rb",
+     "lib/power_reviews/sync.rb",
+     "lib/power_reviews/view_helpers.rb",
+     "power_reviews.gemspec",
+     "rails/init.rb",
+     "test/power_reviews_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/beaucollins/power_reviews}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Helps integrate Power Reviews into a rails site}
+  s.test_files = [
+    "test/power_reviews_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<javan-whenever>, [">= 0"])
+      s.add_runtime_dependency(%q<fastercsv>, [">= 0"])
+    else
+      s.add_dependency(%q<javan-whenever>, [">= 0"])
+      s.add_dependency(%q<fastercsv>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<javan-whenever>, [">= 0"])
+    s.add_dependency(%q<fastercsv>, [">= 0"])
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'power_reviews'

data/test/power_reviews_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+require 'power_reviews'
+
+class PowerReviewsTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  should "have itemdata with correct attributes" do
+    item = PowerReviews::FeedItem.new
+    assert PowerReviews::FeedItem::FIELDS.is_a?(Array)
+    PowerReviews::FeedItem::FIELDS.each {|f| assert item.respond_to?(f), "Item did not have attribute #{f}" }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'shoulda'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: power_reviews
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Beau Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: javan-whenever
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Tools and library for integrating Power Reviews into a rails website.
+email: beaucollins@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- generators/power_reviews/USAGE
+- generators/power_reviews/power_reviews_generator.rb
+- generators/power_reviews/templates/config/initializers/power_reviews.rb
+- generators/power_reviews/templates/config/power_reviews.yml
+- generators/power_reviews/templates/config/schedule.rb
+- generators/power_reviews/templates/lib/tasks/power_reviews_tasks.rake
+- lib/power_reviews.rb
+- lib/power_reviews/config.rb
+- lib/power_reviews/feed.rb
+- lib/power_reviews/feed_item.rb
+- lib/power_reviews/protocols/base.rb
+- lib/power_reviews/protocols/cp.rb
+- lib/power_reviews/protocols/ftp.rb
+- lib/power_reviews/routes.rb
+- lib/power_reviews/sync.rb
+- lib/power_reviews/view_helpers.rb
+- power_reviews.gemspec
+- rails/init.rb
+- test/power_reviews_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/beaucollins/power_reviews
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Helps integrate Power Reviews into a rails site
+test_files: 
+- test/power_reviews_test.rb
+- test/test_helper.rb