someter 0.0.2

data/Manifest

@@ -0,0 +1,9 @@
+Manifest
+README
+Rakefile
+lib/aggregate.rb
+lib/dimension.rb
+lib/review.rb
+lib/someter.rb
+lib/test.rb
+someter.rb

data/README

@@ -0,0 +1,22 @@
+A gem that parses html pages looking for someter data and transforming it to json
+
+* install :
+ 
+	gem install someter
+    
+	Note : you need to install nokogiri (gem install nokogiri)
+ 
+* use : 
+
+	sm = SoMeter.new(:string =>string_to_parse)
+
+or :
+
+	sm = SoMeter.new(:url =>valide_url)
+
+
+* print data in json format :
+
+	puts sm.to_json
+	
+* for a more complete example, see : lib/test.rb

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('someter', '0.0.2') do |p|
+  p.description    = "A gem that parses html pages looking for someter data and transforming it to json"
+  p.url            = "http://github.com/addame/socialmeter"
+  p.author         = "Mehdi Adda"
+  p.email          = "mehdi.adda @nospam@ gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = ['nokogiri']
+end

data/lib/aggregate.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+class Aggregate
+  attr_accessor :dimension, :item, :aggs
+  
+  def to_json
+     to_h.to_json
+  end
+  
+  def to_h
+   {:dimension =>@dimension, :item=>@item, :aggs=>@aggs }
+  end
+  
+  # parse the nokogiri doc and extract the aggregation properties it contains
+  def self.parse(agg_doc)
+    a = self.new
+    # extract the item and dimension names 
+    [:item, :dimension].each do |arg|
+      agg_doc.css(".#{arg.to_s}").each { |elem| 
+        a.send("#{arg.to_s}=", elem.inner_text)
+      }
+    end    
+   
+    # extract aggregation values and the associated types (functions)
+    a.aggs = [];agg_doc.css('.aggs > .func').each do |vs| 
+      dimension_type  = vs[:class].gsub(/func /,'')
+      dimension_value = vs.inner_text
+      a.aggs << {:function=> dimension_type, :value => dimension_value}
+    end
+    #puts "aggregation object : #{a.aggs.to_s}"
+    return a
+  end  
+end

data/lib/dimension.rb

@@ -0,0 +1,49 @@
+require 'nokogiri'
+require 'json'
+
+class Dimension
+  attr_accessor :name, :type, :values, :best, :worst, :min, :max, :step_to_best,
+    :step_to_worst
+  
+  def to_json
+    h = to_h
+    h.to_json
+  end
+  
+  def to_h
+    h = {}
+    h[:type]=@type unless @type.nil?
+    h[:values]=@values unless @values.nil? or @values.empty?
+    h[:best]=@best unless @best.nil?
+    h[:worst]=@worst unless @worst.nil?
+    h[:min]=@min unless @min.nil?
+    h[:max]=@max unless @max.nil?
+    h[:step_to_best]=@step_to_best unless @step_to_best.nil?
+    h[:step_to_worst]=@step_to_worst unless @step_to_worst.nil?
+    {@name=>h}
+  end
+  
+  # parse the nokogiri doc and extract the dimension propreties it contains
+  def self.parse(dim_doc)
+    d = self.new
+    
+    # extract dimension name
+    d.name = dim_doc[:id]
+    
+    # extract dimension type
+    dim_doc.css('.type').each { |t| d.type =  t.inner_text}
+    
+    # extract dimension type
+    d.values = [];dim_doc.css('.values > .value').each { |vs| d.values << vs.inner_text}
+    
+    # extract the remaining properties of the dimension
+    [:type, :best, :worst, :min, :max, :step_to_best,:step_to_worst].each do |arg|
+      dim_doc.css(".#{arg.to_s}").each do |elem| 
+        d.send("#{arg}=", elem.inner_text)
+      end
+    end
+    #puts "dimension object : #{d.name.to_s}"
+    return d    
+  end
+  
+end

data/lib/review.rb

@@ -0,0 +1,3 @@
+class Review
+  attr_accessor :dimensions, :aggregates 
+end

data/lib/someter.rb

@@ -0,0 +1,75 @@
+# crawl a webpage and extract review data and transforms it to json
+
+require 'nokogiri'
+require 'dimension'
+require 'review'
+require 'aggregate'
+require 'json'
+
+class SoMeter
+  
+  attr_accessor :reviews, :url, :string, :doc
+  
+  def initialize(options) 
+    @url = options[:url] unless options[:url].nil? 
+    @string = options[:string] unless options[:string].nil? 
+    if(!@url.nil?)
+      @doc = nokogiri_doc
+    elsif(!@string.nil?)
+      @doc = Nokogiri::HTML(@string.force_encoding('utf-8'))
+    end
+    so_meter_it
+  end
+  
+  def print_reviews  
+  end
+
+  def print_review(index)  
+      
+  end  
+  
+  def to_json
+    @reviews.to_json
+  end
+ 
+  def print
+    puts @reviews[:dimensions].to_s
+    puts @reviews[:aggregates].to_s
+  end
+  
+  
+  private 
+
+  def so_meter_it
+    @reviews = {}
+    #@reviews[:dimensions] = dimensions 
+    #puts "@reviews[:dimensions] = #{@reviews[:dimensions]}"
+    @reviews[:aggregates] = aggregates 
+    #puts "@reviews[:aggregates] = #{@reviews[:aggregates]}"
+  end
+  
+ 
+  
+  def dimensions
+    dims = []
+    @doc.css('.someter.dimension').each { |dim| 
+      dims << Dimension.parse(dim) 
+     }
+     return dims
+  end
+
+  def aggregates 
+    aggs = []
+    @doc.css('.someter.aggregates').each { |agg| 
+      aggs << Aggregate.parse(agg) 
+    }
+    return aggs
+  end
+  
+  def nokogiri_doc
+    f = open(@url)
+    f.rewind
+    Nokogiri::HTML(f.readlines.join("\n").force_encoding('utf-8'))
+  end
+    
+end

data/lib/test.rb

@@ -0,0 +1,119 @@
+require 'someter'  
+
+
+string_to_parse = <<END_STR 
+<div>
+<!--taste rating dimension-->
+<span class="someter dimension" id="taste">
+	<span class="type">integer</span><!--optional if
+        step_to_best, min and max are specified-->
+	<span class="min">0</span>
+	<span class="max">10</span>
+	<span class="best">10</span><!--optional-->
+	<span class="worst">0</span><!--optional-->
+	<span class="step_to_best">+1</span><!--optional-->
+	<span class="step_to_worst">-1</span><!--optional-->
+</span>
+
+<!--dressing rating dimension-->
+<span class="someter dimension" id="dressing">
+	<span class="type">integer</span><!--optional if
+        step_to_best, min and max are specified-->
+	<span class="min">0</span>
+	<span class="max">10</span>
+	<span class="best">10</span><!--optional-->
+	<span class="worst">0</span><!--optional-->
+	<span class="step_to_best">+1</span><!--optional-->
+	<span class="step_to_worst">-1</span><!--optional-->
+</span>
+
+<!--dough rating dimension-->
+<span class="someter dimension" id="dough">
+	<span class="type">integer</span><!--optional if
+        step_to_best, min and max are specified-->
+	<span class="min">0</span>
+	<span class="max">3</span>
+	<span class="best">0</span><!--optional-->
+	<span class="worst">3</span><!--optional-->
+	<span class="step_to_best">+1</span><!--optional-->
+	<span class="step_to_worst">-1</span><!--optional-->
+</span>
+
+<!--looking rating dimension-->
+<span class="someter dimension" id="looking">
+	<span class="type">string</span><!--optional if
+        step_to_best, min and max are specified-->
+    <span class="values">
+        <span class="value">ugly</span>
+        <span class="value">not to bad</span>
+        <span class="value">good</span>
+        <span class="value">very good</span>
+    </span>
+	<span class="best">very good</span><!--optional-->
+	<span class="worst">ugly</span><!--optional-->
+</span>
+
+<div class="someter aggregates">
+    <span class="item">L'Amourita Pizza</span>
+    <span class="dimension">taste</span>    
+    <span class="aggs">
+        Taste: average
+        <span class="func average">6</span>		
+        based on
+        <span class="func ratings">24</span>,
+        maximum
+        <span class="func max">8</span>
+	</span>	
+</div>
+<div class="someter aggregates">
+    <span class="item">L'Amourita Pizza</span>
+    <span class="dimension">dressing</span>        
+    <span class="aggs">
+        Dressing: average
+        <span class="func average">7</span>		
+        based on
+        <span class="func ratings">24</span>,
+        maximum
+        <span class="func max">10</span>
+	</span>
+</div>
+<div class="someter aggregates">
+    <span class="item">L'Amourita Pizza</span>
+    <span class="dimension">dough</span>        
+    <span class="aggs">
+        Dough: average
+        <span class="func average">1</span>		
+        based on
+        <span class="func ratings">24</span>,
+        maximum
+        <span class="func max">3</span>
+	</span>
+</div>
+<div class="someter aggregates">
+    <span class="item">L'Amourita Pizza</span>
+    <span class="dimension">looking</span>        
+    <span class="aggs">
+        Looking: average
+        <span class="func average">good</span>		
+        based on
+        <span class="func ratings">24</span>,
+        maximum
+        <span class="func max">very good</span>
+	</span>
+</div>
+</div>
+END_STR
+
+
+
+def write_to_file(message)
+  File.open('test.txt', 'a') do |f2|
+    f2.puts message
+  end
+end
+
+
+sm = SoMeter.new(:string =>string_to_parse)
+
+#puts sm.to_js
+write_to_file sm.to_json

data/someter.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{someter}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mehdi Adda"]
+  s.date = %q{2010-07-15}
+  s.description = %q{A gem that parses html pages looking for someter data and transforming it to json}
+  s.email = %q{mehdi.adda @nospam@ gmail.com}
+  s.extra_rdoc_files = ["README", "lib/aggregate.rb", "lib/dimension.rb", "lib/review.rb", "lib/someter.rb", "lib/test.rb"]
+  s.files = ["Manifest", "README", "Rakefile", "lib/aggregate.rb", "lib/dimension.rb", "lib/review.rb", "lib/someter.rb", "lib/test.rb", "someter.rb", "someter.gemspec"]
+  s.homepage = %q{http://github.com/addame/socialmeter}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Someter", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{someter}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A gem that parses html pages looking for someter data and transforming it to json}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<nokogiri>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+  end
+end

data/someter.rb

@@ -0,0 +1,4 @@
+require 'lib/review'
+require 'lib/someter'
+require 'lib/aggregate'
+require 'lib/dimension'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: someter
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Mehdi Adda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A gem that parses html pages looking for someter data and transforming it to json
+email: mehdi.adda @nospam@ gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- lib/aggregate.rb
+- lib/dimension.rb
+- lib/review.rb
+- lib/someter.rb
+- lib/test.rb
+files: 
+- Manifest
+- README
+- Rakefile
+- lib/aggregate.rb
+- lib/dimension.rb
+- lib/review.rb
+- lib/someter.rb
+- lib/test.rb
+- someter.rb
+- someter.gemspec
+has_rdoc: true
+homepage: http://github.com/addame/socialmeter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Someter
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: someter
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A gem that parses html pages looking for someter data and transforming it to json
+test_files: []
+