ud 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2134c365e3c168e488e70bd92781de30d419787b
-  data.tar.gz: 41f9521a67fcbd7a13af576b72ad0487b912634e
+  metadata.gz: 6c17aeb74c72f8713fd49862c33fa292f256174d
+  data.tar.gz: f1964b4cf50361f5b2765aee3e136cc96d806c61
 SHA512:
-  metadata.gz: 046591e9726d26e77674979759936e8337a0048b4102db0493edec4431d47796f61171d6ff4f767c237568245bcd5c8052c87c5208918a9503c43a4ce6f5361a
-  data.tar.gz: 323c6c600173bf87c696dd26a1ae4e66649223728ff760c69544b2c98891a534cefea349f4f2ba3d84b8878970e5137d85c0aefbbf3426db81e662beb58fcdf0
+  metadata.gz: cf6a6865b51c9ae2aebd9a063d365b3457aad7aa7a946c706eceb46b299ffcf4a36e981c1d85ee0352693d4c92de840314be300dda31cc9b87742aca105929f4
+  data.tar.gz: e69cc02df921261f58893efb090f8debae155845d4a144f658ad79f1ce15090a9c4903d037bb728cf5a5b9fcd0f16e447b566ecf35566301c71cf364dd79ea92

data/bin/ud

@@ -14,7 +14,7 @@ Usage:
 where [options] are:
 EOS
 
-  opt :ratio, 'Filter by upvotes/downvotes ratio', :type => :float, :default => 0.0
+  opt :ratio, 'Filter by upvotes/downvotes ratio', :type => :float, :default => 0.0, :short => '-r'
   opt :count, 'Limit the number of definitions', :type => :int, :default => 1, :short => '-n'
   opt :color, 'Use colorized output', :default => true
   opt :up, 'Shortcut for \'-r 2\''

data/lib/ud.rb

@@ -4,112 +4,67 @@
 require 'uri'
 require 'json'
 require 'open-uri'
-require 'nokogiri'
 
 require File.dirname(__FILE__) + '/ud/formatting'
 
 # This module provide some methods to scrape definitions from the Urban
 # Dictionary website.
 module UD
+  class << self
 
-  # The current version of the module
-  def UD.version
-    '0.1.3'
-  end
-
-  # Get the search URL to query for a given term.
-  # [term] the term to search for. It must be a string, spaces are allowed
-  def UD.search_url(term='')
-    param = URI.encode_www_form('term' => term)
-    "http://www.urbandictionary.com/define.php?#{param}"
-  end
-
-  # Get the thumbs (up/down) for a list of definitions' ids.
-  # This is an helper for internal usage.
-  def UD.thumbs(ids)
-
-    param = URI.encode_www_form('ids' => ids.join(','))
-    json = open "http://api.urbandictionary.com/v0/uncacheable?#{param}"
-
-    response = JSON.parse(json.read)
-    thumbs   = {}
-
-    response['thumbs'].each do |t|
-
-      thumbs[t['defid']] = {
-        :up   => t['thumbs_up'],
-        :down => t['thumbs_down']
-      }
-
+    def version
+      '0.2.0'
     end
 
-    thumbs
-  end
-
-  # Get the text of an element. This is an helper for internal usage.
-  def UD.text(el)
-    el.text.strip.gsub(/\r/, "\n")
-  rescue
-    ''
-  end
-
-  # Query the website and return a list of definitions for the provided term.
-  # This list may be empty if there's no result. It only scraps the first
-  # page of results.
-  # [term] the term to search for
-  # [opts] options. This is used by the command-line tool. +:count+ is the
-  # maximum number of results to return, +:ratio+ is the minimum
-  # upvotes/downvotes ratio. Other options may be added in the future.
-  def UD.query(term, *opts)
-
-    opts = {:count => 1, :ratio => 0.0}.merge(opts[0] || {})
-
-    return [] if opts[:count] <= 0
-
-    url = search_url(term)
-    doc = Nokogiri::HTML(open(url))
-
-    return [] unless doc.css('#not_defined_yet').empty?
-
-    words = doc.css('#entries .box')
-    ids   = words.take(opts[:count]).map do |w|
-      w.css('.thumb.up').first.attr('data-defid')
+    # Get the search URL to query for a given term.
+    # [term] the term to search for. It must be a string, spaces are allowed
+    def search_url(term='')
+      param = URI.encode_www_form('term' => term)
+      "http://api.urbandictionary.com/v0/define?#{param}"
     end
 
-    thumbs = thumbs(ids)
-
-    if opts[:ratio] > 0
-      ids.delete_if do |id|
-        t = thumbs[id.to_i] || {:up => 1, :down => 1}
-        (t[:up] / t[:down].to_f) < opts[:ratio]
-      end
+    # Get the text of an element. This is an helper for internal usage.
+    def text(el)
+      el.text.strip.gsub(/\r/, "\n")
+    rescue
+      ''
     end
 
-    ids.map do |id|
-
-      box = doc.css(".add_to_list[data-defid=\"#{id}\"]").first.parent
-
-      word = text box.css(".word > a").first
-      t    = thumbs[id.to_i] || {}
-
-      {
-        :id => id,
-        :word => word,
-        :definition => text(box.css('.definition')),
-        :example => text(box.css('.example')),
-        :upvotes => t[:up],
-        :downvotes => t[:down]
-
-      }
-
+    # Query the website and return a list of definitions for the provided term.
+    # This list may be empty if there's no result.
+    # [term] the term to search for
+    # [opts] options. This is used by the command-line tool. +:count+ is the
+    # maximum number of results to return, +:ratio+ is the minimum
+    # upvotes/downvotes ratio. Other options may be added in the future.
+    def query(term, *opts)
+
+      opts = {:count => 1, :ratio => 0.0}.merge(opts[0] || {})
+
+      return [] if opts[:count] <= 0
+
+      resp = JSON.parse(open(search_url term).read, :symbolize_names => true)
+
+      resp[:list].map do |res|
+        {
+          :id         => res[:defid],
+          :word       => res[:word],
+          :author     => res[:author],
+          :permalink  => res[:permalink],
+          :definition => res[:definition].strip,
+          :example    => res[:example].strip,
+          :upvotes    => res[:thumbs_up],
+          :downvotes  => res[:thumbs_down]
+        }
+      end.keep_if do |d|
+        d[:upvotes]/[d[:downvotes], 0.1].max.to_f >= opts[:ratio]
+      end.take opts[:count]
     end
 
-  end
+    # Format results for output
+    # [results] this must be an array of results, as returned by +UD.query+.
+    def format_results(results, color=true)
+      UD::Formatting.text(results, color)
+    end
 
-  # Format results for output
-  # [results] this must be an array of results, as returned by +UD.query+.
-  def UD.format_results(results, color=true)
-    UD::Formatting.text(results, color)
   end
-
 end

data/lib/ud/formatting.rb

@@ -3,10 +3,11 @@
 
 module UD
   module Formatting
+    class << self
 
     # Fit a text in a given width (number of chars). It returns
     # a list of lines of text.
-    def self.fit(txt, width=79)
+    def fit(txt, width=79)
       return [] if width < 1
 
       # from http://stackoverflow.com/a/7567210/735926
@@ -18,7 +19,7 @@ module UD
     # the beginning of each element.
     # [txt] The text to tab, may be a string or a list of strings
     # [width] The width (number of spaces) of a tab
-    def self.tab(txt, width=4)
+    def tab(txt, width=4)
       width = 0 if width < 0
 
       tab = ' ' * width
@@ -30,7 +31,7 @@ module UD
 
     # Format results for text output (e.g. in the terminal)
     # [results] this must be an array of results, as returned by +UD.query+.
-    def self.text(results, color=true)
+    def text(results, color=true)
       require 'colored' if color
 
       results.map do |r|
@@ -61,5 +62,6 @@ module UD
       end.join("\n")
     end
 
+    end
   end
 end

data/tests/query_tests.rb

@@ -5,106 +5,92 @@ require File.dirname(__FILE__) + '/fake_responses'
 
 class UD_Formatting_test < Test::Unit::TestCase
 
-  ROOT_URL = 'http://www.urbandictionary.com'
+  ROOT_URL = 'http://api.urbandictionary.com/v0/define'
+
+  def setup
+    @foo, @bar = [
+      {
+        :id => 1,
+        :author => 'a1',
+        :permalink => 'http://example.com/1',
+        :word => 'foo',
+        :definition => 'A',
+        :example => 'AA',
+        :upvotes => 42,
+        :downvotes => 17
+
+      },
+      {
+        :id => 2,
+        :author => 'a2',
+        :permalink => 'http://example.com/2',
+        :word => 'bar',
+        :definition => 'B',
+        :example => 'BB',
+        :upvotes => 17,
+        :downvotes => 42
+      }
+    ]
+  end
 
   # == UD#search_url == #
 
   def test_search_url_empty_term
     assert_equal(
-      "#{ROOT_URL}/define.php?term=",
+      "#{ROOT_URL}?term=",
       UD.search_url())
       assert_equal(
-        "#{ROOT_URL}/define.php?term=",
+        "#{ROOT_URL}?term=",
         UD.search_url(''))
   end
 
   def test_search_url_spaces_in_term
     assert_equal(
-      "#{ROOT_URL}/define.php?term=a+b",
+      "#{ROOT_URL}?term=a+b",
       UD.search_url('a b'))
   end
 
   def test_search_url_encode_special_chars
     assert_equal(
-      "#{ROOT_URL}/define.php?term=%3D",
+      "#{ROOT_URL}?term=%3D",
       UD.search_url('='))
   end
 
   def test_search_url
     assert_equal(
-      "#{ROOT_URL}/define.php?term=foo",
+      "#{ROOT_URL}?term=foo",
       UD.search_url('foo'))
   end
 
-  # == UD#thumbs == #
-
-  def test_thumbs_no_ids
-    assert_equal({}, UD.thumbs([]))
-  end
-
-  def test_thumbs_one_id
-    assert_equal({42 =>{:up => 2, :down => 1}}, UD.thumbs([42]))
-  end
-
   # == UD#query == #
 
   def test_query_no_results
-    assert_equal([], UD.query('nothing'))
+    assert_equal([], UD.query('fooo'))
   end
 
   def test_query_two_results
 
     expected = [
-      {
-        :id => '1',
-        :word => 'foo',
-        :definition => 'A',
-        :example => 'AA',
-        :upvotes => 1,
-        :downvotes => 1
-
-      },
-      {
-        :id => '2',
-        :word => 'bar',
-        :definition => 'B',
-        :example => 'BB',
-        :upvotes => 2,
-        :downvotes => 1
-      }
+      @foo, @bar
     ]
 
-    assert_equal(expected, UD.query('two', :count => 2))
+    assert_equal(expected, UD.query('two_results', :count => 2))
   end
 
   def test_query_count
     expected = [
-      {
-        :id => '1',
-        :word => 'foo',
-        :definition => 'A',
-        :example => 'AA',
-        :upvotes => 1,
-        :downvotes => 1
-      }
+      @foo
     ]
 
-    assert_equal(expected, UD.query('two', :count => 1))
+    assert_equal(expected, UD.query('two_results', :count => 1))
   end
 
   def test_query_ratio
     expected = [
-      {
-        :id => '2',
-        :word => 'bar',
-        :definition => 'B',
-        :example => 'BB',
-        :upvotes => 2,
-        :downvotes => 1
-      }
+      @foo
     ]
 
-    assert_equal(expected, UD.query('two', :count => 10, :ratio => 1.5))
+    assert_equal(expected, UD.query('two_results', :count => 10, :ratio => 1.5))
   end
 
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ud
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Baptiste Fontaine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-12 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.9
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.9
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement