previews 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+results.html
+pkg
+html
+.bundle
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in previews.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ivan K.
+
+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.md

@@ -0,0 +1,12 @@
+# previews
+Read user reviews of linux packages.
+
+**Author:**  Ivan K.
+
+[Source on Github](https://github.com/divout/previews)
+
+## Installation:
+    gem install previews
+## Usage:
+    previews vlc --sort-rating asc --lang es
+Type `previews --help` for full list of options.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'bundler'
+require 'rake/clean'
+require 'rake/testtask'
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/tc_*.rb'
+end
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:test,:features]

data/bin/previews

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+$LOAD_PATH << File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'optparse'
+require 'previews'
+
+HEADERS = { 'origin'               => 'Origin',
+            'rating'               => 'Rating',
+            'app_name'             => 'Application Name',
+            'language'             => 'Language',
+            'reviewer_username'    => 'Username',
+            'reviewer_displayname' => 'From',
+            'summary'              => 'Summary',
+            'review_text'          => 'Review',
+            'version'              => 'Version',
+            'date_created'         => 'Date',
+            'package_name'         => 'Package Name',
+            'distroseries'         => 'distroseries' }
+
+options = {
+  :fields          => ['rating', 'reviewer_displayname', 'summary', 'review_text'],
+  :release         => 'oneiric',
+  :locale          => 'en',
+  :package         => ARGV[0],
+  :system_less     => true,
+  :sort_field      => nil,
+  :sort_direction  => nil
+}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: previews PACKAGE [options]'
+
+  opts.separator ""
+  opts.separator "Options:"
+
+  sort_options = ['asc', 'desc', 'ASC', 'DESC']
+  opts.on('-d', '--sort-date DIRECTION', sort_options, 'Sort reviews by date. DIRECTION could be DESC or ASC') do |direction|
+    options[:sort_field]      = 'date_created'
+    options[:sort_direction]  = direction.downcase
+  end
+
+  opts.on('-t', '--sort-rating DIRECTION', sort_options, 'Sort reviews by rating. DIRECTION could be DESC or ASC') do |direction|
+    options[:sort_field]      = 'rating'
+    options[:sort_direction]  = direction.downcase
+  end
+
+  opts.on('-u', '--sort-usefulness DIRECTION', sort_options, 'Sort reviews by usefulness. DIRECTION could be DESC or ASC', 'Default is DESC') do |direction|
+    options[:sort_field]      = 'usefulness'
+    options[:sort_direction]  = direction.downcase
+  end
+
+  opts.on('-s', '--[no-]less', 'Set `less` for displaying reviews. By default it is true') do |less|
+    options[:system_less] = less
+  end
+  opts.on('-l', '--lang LANGUAGE', "Set language of reviews. Default is #{options[:locale]}") do |locale|
+    options[:locale] = locale
+  end
+
+  opts.on('-r', '--release RELEASE', "Set the release for package. Default is #{options[:release]}" ) do |release|
+    options[:release] = release
+  end
+
+  opts.on('-f', '--fields A,B,C', Array, 'Set the fields you want to display.', "Available fields: #{HEADERS.keys.join(', ')}") do |fields|
+    options[:fields] = fields.map(&:strip)
+  end
+
+  opts.on( '-h', '--help', 'Show this message' ) do
+    puts opts
+    exit
+  end
+
+  if ARGV.empty?
+    puts opts
+    exit
+  end
+end.parse!
+
+reviews = Previews::PackageReviews.new(options[:locale], options[:release], options[:package]).reviews
+reviews.parse_date_time
+reviews.sort_with!(options[:sort_field], options[:sort_direction]) if options[:sort_field]
+reviews.replace_rating_with("★", "☆")
+reviews.print_with(options[:fields], options[:system_less])

data/features/previews.feature

@@ -0,0 +1,11 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "previews"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes no options
+    And the banner should document that this app takes no arguments

data/features/step_definitions/previews_steps.rb

@@ -0,0 +1 @@
+# Put your step defintions here

data/features/support/env.rb

@@ -0,0 +1,9 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+end

data/lib/previews.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+require 'json'
+require 'net/http'
+require 'previews/version'
+require 'previews/array'
+require 'previews/hirb_vertical_table'
+
+module Previews
+  class PackageReviews
+    def initialize(locale, release, package)
+      @url    = "http://reviews.ubuntu.com/reviews/api/1.0/reviews/filter/#{locale}/ubuntu/#{release}/any/#{package}/"
+      @reviews = []
+    end
+
+    # Return Array of Hases
+    def reviews
+      download_reviews
+      @reviews.flatten!
+
+      @reviews
+    end
+
+    private
+    # Get all reviews
+    # Return Array of Hashes
+    def download_reviews
+      page = 1
+      loop do
+        @reviews << download_page(page)
+        break if @reviews.last.empty?
+        page += 1
+      end
+    end
+
+    # Get the one page of reviews.
+    # Return Array of Hashes
+    def download_page(page_number)
+      print '.'
+      JSON.parse(Net::HTTP.get(URI(@url + "page/#{page_number}/")))
+    end
+  end
+end

data/lib/previews/array.rb

@@ -0,0 +1,41 @@
+class Array
+  # Using Hirb to print reviews.
+  # :fields is fields to display
+  # print out :vertical table
+  # HEADERS is Hash of headers
+  # passing system_less as a option
+  def print_with(fields, system_less)
+    extend Hirb::Console
+    table self, :fields      => fields,
+                :vertical    => true,
+                :headers     => HEADERS,
+                :system_less => system_less
+  end
+
+  # By default reviews sorted by usefulness. We can reverse it to sort by ascending
+  # For others fields we sorting by comparing each element of Array
+  def sort_with!(field, direction)
+    self          if 'usefulness' == field && 'desc' == direction
+    self.reverse! if 'usefulness' == field && 'asc'  == direction
+    if 'asc' == direction
+      self.sort! { |review1, review2| review1[field] <=> review2[field]}
+    elsif 'desc' == direction
+      self.sort! { |review1, review2| review2[field] <=> review1[field]}
+    end
+  end
+
+  # Parses all 'date_created' fields to DateTime object
+  def parse_date_time
+    self.each do |review|
+      review['date_created'] = DateTime.parse(review['date_created'])
+    end
+  end
+
+  # Replace each review's rating into some symbols
+  # Usage: array.replace_rating_with("★", "☆")
+  def replace_rating_with(up, empty)
+    self.each do |review|
+      review['rating'] = up * review['rating'] + empty * (5 - review['rating'])
+    end
+  end
+end

data/lib/previews/hirb_vertical_table.rb

@@ -0,0 +1,30 @@
+require 'hirb'
+
+class Hirb::Helpers::VerticalTable < Hirb::Helpers::Table
+  # Method should return an Array
+  def render_rows
+    i = 0
+    rows = ''
+    longest_header = Hirb::String.size @headers.values.sort_by {|e| Hirb::String.size(e) }.last
+    delimiter = "-" * longest_header
+    @rows.map do |row|
+      row = "\n#{delimiter} #{i+1}. review #{delimiter}\n" +
+      @fields.map {|f|
+        if !@options[:hide_empty] || (@options[:hide_empty] && !row[f].empty?)
+          "#{Hirb::String.rjust(@headers[f], longest_header)}: #{row[f]}"
+        else
+          nil
+        end
+      }.compact.join("\n")
+      i+= 1
+      rows += row
+    end
+    rows = "#{@rows.size} review(s)" + rows
+    if @options[:system_less] && system("which less 2>&1 > /dev/null")
+      IO.popen('less', 'w') { |io| io.puts rows }
+      []
+    else
+      [rows]
+    end
+  end
+end

data/lib/previews/version.rb

@@ -0,0 +1,3 @@
+module Previews
+  VERSION = "0.0.2"
+end

data/previews.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "previews/version"
+
+Gem::Specification.new do |s|
+  s.name        = "previews"
+  s.version     = Previews::VERSION
+  s.authors     = ["Ivan K"]
+  s.email       = ["divout@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Read user reviews of linux packages.}
+  s.description = %q{previews lets you read user reviews of linux packages from your console.}
+
+  s.rubyforge_project = "previews"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('aruba')
+  s.add_development_dependency('rake','~> 0.9.2')
+  s.add_dependency('methadone')
+  s.add_dependency('hirb', '~> 0.6.0')
+end

data/test/tc_something.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class TestSomething < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: previews
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Ivan K
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &16007560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16007560
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &16007020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16007020
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &16005920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *16005920
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: &16005460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *16005460
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: &16004920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *16004920
+description: previews lets you read user reviews of linux packages from your console.
+email:
+- divout@gmail.com
+executables:
+- previews
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/previews
+- features/previews.feature
+- features/step_definitions/previews_steps.rb
+- features/support/env.rb
+- lib/previews.rb
+- lib/previews/array.rb
+- lib/previews/hirb_vertical_table.rb
+- lib/previews/version.rb
+- previews.gemspec
+- test/tc_something.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: previews
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Read user reviews of linux packages.
+test_files: []