ud 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef94c79592b39fe5f56775e9d08eab3ea601db08
-  data.tar.gz: 3202e4b6ce4fe9bb52b2ef984c137f714d3091d4
+  metadata.gz: be08bba53ec9677e2382c7221afbdbe86daeeb2b
+  data.tar.gz: 2127476c4b657755e04cd5393a4bc58c852a6840
 SHA512:
-  metadata.gz: dd4694a3b5970d1073129ffa8078c5727e4246161bcbd2bde9c4b02b4a4fe09248d5d9ae8a5cf6fe31bca65f3b8f82676076bbeaea1d604e928a0f8011be62b0
-  data.tar.gz: bbeede97c81c1496c534fbf8c48771f0e2145ef11506d4cb8b0ff7a0dc9c76ef2d1b6c05fa08de5846ebe435666d4edca59e02fa69cb7cd6412173c576e50938
+  metadata.gz: ab2a0d140114d914a7a066219ad5e3fd2a93c8f20bb8be031900a779db2d4a5ba244f330b1d85e14a95134e7cc2213c1a8973e34f4a21f28d4dacb4234199452
+  data.tar.gz: f421052deba0e6a06f163450d1d5871c85cc68a33dabdc4234ea855dbbb006571114d336621251e2b378a9329127ebfc6cd4eba636650b7146cca418a6a16b10

data/bin/ud

@@ -2,10 +2,10 @@
 # -*- coding: UTF-8 -*-
 
 # clean interrupt
-trap('INT') { abort }
+trap("INT") { abort }
 
-require 'trollop'
-require 'ud'
+require "trollop"
+require "ud"
 
 opts = Trollop.options do
   version "ud #{UD.version}"
@@ -17,30 +17,24 @@ Usage:
 where [options] are:
 EOS
 
-  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 :browser, 'Open the results in a browser window', :short => '-b'
-  opt :up, 'Shortcut for \'-r 2\''
-
+  opt :count, "Limit the number of definitions", :type => :int, :default => 1, :short => "-n"
+  opt :random, "Print a random definition instead of searching", :short => "m"
+  opt :color, "Use colorized output", :default => true
+  opt :browser, "Open the results in a browser window", :short => "-b"
 end
 
-Trollop.die :ratio, 'must be non-negative' if opts[:ratio] < 0
-Trollop.die :count, 'must be non-negative' if opts[:count] < 0
-
-opts[:ratio] = 2 if opts[:up]
+Trollop.die :count, "must be non-negative" if opts[:count] < 0
 
-if ARGV.empty?
-  puts 'Error: No word provided. Use -h or --help to see the help.'
+if !opts[:random] && ARGV.empty?
+  puts "Error: No word provided. Use -h or --help to see the help."
   exit 1
 end
 
-term = ARGV.join(' ')
+term = ARGV.join " "
 
 if opts[:browser]
-  UD.open_url(term)
+  opts[:random] ? UD.open_random : UD.open_url(term)
 else
-  q = UD.query(ARGV.join(' '), opts)
+  q = opts[:random] ? UD.random(opts) : UD.query(ARGV.join(" "), opts)
   puts UD.format_results(q, opts[:color])
 end
-

data/lib/ud.rb

@@ -1,61 +1,83 @@
 # -*- coding: UTF-8 -*-
 
-require 'uri'
-require 'json'
-require 'open-uri'
+require "uri"
+require "json"
+require "open-uri"
 
-require File.dirname(__FILE__) + '/ud/formatting'
+require File.dirname(__FILE__) + "/ud/formatting"
 
 # This module provide some methods to scrape definitions from the Urban
 # Dictionary website.
 module UD
   class << self
-
     # @return [String] the current gem's version
     def version
-      '0.2.5'
+      "0.3.0"
     end
 
     # Get the search URL to query for a given term.
     # @param term [String] the term to search for. It must be a string, spaces
     #                      are allowed.
-    # @param api [Boolean] truthy if the API URL should be used.
+    # @param opts [Hash] options.
     # @return [String]
-    def search_url(term='', api=true)
-      param = URI.encode_www_form('term' => term)
+    def search_url(term, opts = {})
+      param = URI.encode_www_form("term" => term)
 
-      if api
+      if opts[:api] != false
         "http://api.urbandictionary.com/v0/define?#{param}"
       else
         "http://www.urbandictionary.com/define.php?#{param}"
       end
     end
 
+    # @param opts [Hash] options.
+    def random_url(opts = {})
+      if opts[:api] != false
+        "http://api.urbandictionary.com/v0/random"
+      else
+        "http://www.urbandictionary.com/random.php"
+      end
+    end
+
     # Open the search URL in the user's browser
     # @param term [String] the term to search for. It must be a string, spaces
     #                      are allowed.
     # @return [Nil]
-    def open_url(term='')
-      system open_cmd, search_url(term, false)
+    def open_url(term)
+      system open_cmd, search_url(term, :api => false)
+    end
+
+    # Open a random definition URL in the user's browser
+    # @return [Nil]
+    def open_random
+      system open_cmd, random_url(:api => false)
     end
 
     # Query the website and return a list of definitions for the provided term.
     # This list may be empty if there's no result.
     # @param term [String] the term to search for
     # @param opts [Hash] 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.
+    #                    +:count+ is the maximum number of results to return
     # @return [Array<Hash>]
-    def query(term, *opts)
+    def query(term, opts = {})
+      parse_response(open(search_url(term)).read, opts)
+    end
 
-      opts = {:count => 1, :ratio => 0.0}.merge(opts[0] || {})
+    def random(opts = {})
+      parse_response(open(random_url).read, opts)
+    end
+
+    # @param opts [Hash] options. This is used by the command-line tool.
+    #                    +:count+ is the maximum number of results to return
+    # @return [Array<Hash>]
+    def parse_response(text, opts = {})
+      opts = { :count => 1 }.merge(opts || {})
 
       return [] if opts[:count] <= 0
 
-      resp = JSON.parse(open(search_url term).read, :symbolize_names => true)
+      resp = JSON.parse(text, :symbolize_names => true)
 
-      resp[:list].map do |res|
+      results = resp[:list].map do |res|
         {
           :id         => res[:defid],
           :word       => res[:word],
@@ -64,11 +86,11 @@ module UD
           :definition => res[:definition].strip,
           :example    => res[:example].strip,
           :upvotes    => res[:thumbs_up],
-          :downvotes  => res[:thumbs_down]
+          :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
+
+      results.take opts[:count]
     end
 
     # Format results for output
@@ -76,7 +98,7 @@ module UD
     #                        +UD.query+.
     # @param color [Boolean] colored output
     # @return [String]
-    def format_results(results, color=true)
+    def format_results(results, color = true)
       UD::Formatting.text(results, color)
     end
 

data/lib/ud/formatting.rb

@@ -1,63 +1,61 @@
 # -*- coding: UTF-8 -*-
 
 module UD
-
   # Formatting tools for {UD.query}'s output
   module Formatting
     class << self
-
-    # Fit a text in a given width (number of chars).
-    # @param txt [String]
-    # @param width [Integer] maximum width
-    # @return [Array] list of lines of text
-    def fit(txt, width=79)
-      return [] if width < 1
-
-      # from http://stackoverflow.com/a/7567210/735926
-      r = /(.{1,#{width}})(?:\s|$)/m
-      txt.split("\n").map { |l| l.scan(r) }.flatten
-    end
-
-    # Add a tab at the beginning of a text. If it's a list, add a tab at
-    # the beginning of each element.
-    # @param txt [String] The text to tab, may be a string or a list of strings
-    # @param width [Integer] tab width
-    # @return [String]
-    def tab(txt, width=4)
-      width = 0 if width < 0
-
-      tab = ' ' * width
-
-      return tab + txt if txt.is_a?(String)
-
-      txt.map { |l| tab + l }
-    end
-
-    # Format results for text output (e.g. in the terminal)
-    # @param results [Array<Hash>] this must be an array of results, as
-    #                              returned by {UD.query}.
-    # @param color [Boolean] colored output
-    # @return [String]
-    def text(results, color=true)
-      require 'colored' if color
-
-      results.map do |r|
-
-        word  = r[:word]
-        upvotes = r[:upvotes]
-        downvotes = r[:downvotes]
-
-        if (color)
-          word      = word.bold
-          upvotes   = upvotes.to_s.green
-          downvotes = downvotes.to_s.red
-        end
-
-        votes = "#{upvotes}/#{downvotes}"
-        definition = tab(fit(r[:definition], 75)).join("\n")
-        example    = tab(fit(r[:example], 75)).join("\n")
-
-        <<-EOD
+      # Fit a text in a given width (number of chars).
+      # @param txt [String]
+      # @param width [Integer] maximum width
+      # @return [Array] list of lines of text
+      def fit(txt, width = 79)
+        return [] if width < 1
+
+        # from http://stackoverflow.com/a/7567210/735926
+        r = /(.{1,#{width}})(?:\s|$)/m
+        txt.split("\n").map { |l| l.scan(r) }.flatten
+      end
+
+      # Add a tab at the beginning of a text. If it's a list, add a tab at
+      # the beginning of each element.
+      # @param txt [String] The text to tab, may be a string or a list of
+      #                     strings
+      # @param width [Integer] tab width
+      # @return [String]
+      def tab(txt, width = 4)
+        return txt if width <= 0
+
+        tab = " " * width
+
+        return tab + txt if txt.is_a? String
+
+        txt.map { |l| tab + l }
+      end
+
+      # Format results for text output (e.g. in the terminal)
+      # @param results [Array<Hash>] this must be an array of results, as
+      #                              returned by {UD.query}.
+      # @param color [Boolean] colored output
+      # @return [String]
+      def text(results, color = true)
+        require "colored" if color
+
+        results.map do |r|
+          word = r[:word]
+          upvotes = r[:upvotes]
+          downvotes = r[:downvotes]
+
+          if color
+            word      = word.bold
+            upvotes   = upvotes.to_s.green
+            downvotes = downvotes.to_s.red
+          end
+
+          votes = "#{upvotes}/#{downvotes}"
+          definition = tab(fit(r[:definition], 75)).join "\n"
+          example    = tab(fit(r[:example], 75)).join "\n"
+
+          <<-EOD
 * #{word} (#{votes}):
 
 #{definition}
@@ -66,11 +64,9 @@ module UD
 #{example}
 
 
-        EOD
-
-      end.join("\n")
-    end
-
+          EOD
+        end.join "\n"
+      end
     end
   end
 end

data/tests/query_tests.rb

@@ -37,12 +37,11 @@ class UD_Query_test < Test::Unit::TestCase
   # == UD#search_url == #
 
   def test_search_url_empty_term
-    assert_equal("#{API_URL}?term=", UD.search_url())
     assert_equal("#{API_URL}?term=", UD.search_url(''))
   end
 
   def test_search_url_empty_term_nonapi
-    assert_equal("#{ROOT_URL}?term=", UD.search_url('', false))
+    assert_equal("#{ROOT_URL}?term=", UD.search_url('', :api => false))
   end
 
   def test_search_url_spaces_in_term
@@ -57,6 +56,12 @@ class UD_Query_test < Test::Unit::TestCase
     assert_equal("#{API_URL}?term=foo", UD.search_url('foo'))
   end
 
+  # == UD#random_url == #
+
+  def test_random_url
+    assert_equal("http://api.urbandictionary.com/v0/random", UD.random_url)
+  end
+
   # == UD#query == #
 
   def test_query_no_results
@@ -70,9 +75,5 @@ class UD_Query_test < Test::Unit::TestCase
   def test_query_count
     assert_equal([@foo], UD.query('two_results', :count => 1))
   end
-
-  def test_query_ratio
-    assert_equal([@foo], UD.query('two_results', :count => 10, :ratio => 1.5))
-  end
 end
 

data/tests/tests.rb

@@ -1,15 +1,19 @@
 #! /usr/bin/env ruby
 # -*- coding: UTF-8 -*-
 
-require 'coveralls'
-Coveralls.wear!
+ci = ENV["CI"] || ENV["CONTINUOUS_INTEGRATION"]
+
+if ci
+  require 'coveralls'
+  Coveralls.wear!
+end
 
 require 'test/unit'
 require 'simplecov'
 
 test_dir = File.expand_path( File.dirname(__FILE__) )
 
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter if ci
 SimpleCov.start { add_filter '/tests/' }
 
 require 'ud'
@@ -26,6 +30,26 @@ class UDTests < Test::Unit::TestCase
     assert(UD.version =~ /^\d+\.\d+\.\d+/)
   end
 
+  # == UD#open_cmd (private) == #
+
+  def test_ud_open_cmd
+    os = RbConfig::CONFIG["host_os"]
+
+    RbConfig::CONFIG["host_os"] = "darwin"
+    assert_equal "open", UD.send(:open_cmd)
+
+    RbConfig::CONFIG["host_os"] = "linux"
+    assert_equal "xdg-open", UD.send(:open_cmd)
+
+    RbConfig::CONFIG["host_os"] = "bsd"
+    assert_equal "xdg-open", UD.send(:open_cmd)
+
+    RbConfig::CONFIG["host_os"] = "cygwin"
+    assert_equal "start", UD.send(:open_cmd)
+
+    RbConfig::CONFIG["host_os"] = os
+  end
+
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ud
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Baptiste Fontaine
@@ -12,25 +12,25 @@ cert_chain:
   -----BEGIN CERTIFICATE-----
   MIIDaDCCAlCgAwIBAgIBATANBgkqhkiG9w0BAQUFADA9MRAwDgYDVQQDDAdiYXRp
   Zm9uMRUwEwYKCZImiZPyLGQBGRYFeWFob28xEjAQBgoJkiaJk/IsZAEZFgJmcjAe
-  Fw0xNDA4MjQxMTM5NTJaFw0xNTA4MjQxMTM5NTJaMD0xEDAOBgNVBAMMB2JhdGlm
+  Fw0xNTEyMjMwMTExMTZaFw0xNjEyMjIwMTExMTZaMD0xEDAOBgNVBAMMB2JhdGlm
   b24xFTATBgoJkiaJk/IsZAEZFgV5YWhvbzESMBAGCgmSJomT8ixkARkWAmZyMIIB
-  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn3uOgWl+FwXIjDdCay28i6cK
-  FxHWhHoS/mH9pkXzSGVctEKP2fulie6MkIvrLCP5M6TpByeaBjcJjZPadrou1FIc
-  Yc/O14jYjaKTqfMxpzgNfGzDdBgBo0QZ9rcHjORetdIZdUSDaZjPtI1aGS6eBMsh
-  W2X6GxL4UQ1kH0Lyg7iPYAH5RHnD3+G+S28iOPFfRLFzm4fwJp1k7URiiSyOHTDp
-  B0ZehKKrW/ibCaRMYp2VoCamcim4de1VA6CTOaYSShueqThE18n1HM6aprihziyM
-  04yIpo80/unO6JxlsUFdBjsb5d7oJSqPJ6/OfcFnyXa/VRm+Ed9d6PTwZvL7YwID
-  AQABo3MwcTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUWyH3xMx1
-  8I5NLncgNEC0ZlDRKegwGwYDVR0RBBQwEoEQYmF0aWZvbkB5YWhvby5mcjAbBgNV
-  HRIEFDASgRBiYXRpZm9uQHlhaG9vLmZyMA0GCSqGSIb3DQEBBQUAA4IBAQAaTVya
-  CGgojxBwUoadCCIsFheGsXvSFhikkXYNXy0VxEYr8BaTfGwzYh9c9T5N+Y5Mu5MW
-  WegqwIwRhIu6Rg7huqJ7TK50pVDF0yrZcsxvWjOfd3clblBHjKGQx5Mbu7LVNGKE
-  +QNdTAwYVTAA8wXHpxk200cHb9xz4e9ANpb4lonGuPz8jKmb/A7Z1M5QD6zStG8l
-  sTlVAhA/LZiC9gL9LtW8Iq7o7xRFhxNPKWHu6JVThH9i16eli+JignOJbGna7C40
-  QnOQb8zHyNL+gq2m/mnZGrSehx+6AujokjOfHbmivYMfDATOQQx0eIBI18IhacZm
-  42WxhhIV2bwDtd77
+  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0en8u9i10EQtkp3SUnXnXo0W
+  UISZyvp2kS22c2/FXYg566dtfkp3pwBOZi3gvRYAKpmXAwbynOANdm2bfzQiG+Br
+  0966dfY0SIbFuhaueJ8JUm5o/nxxCiKxuvCFs5899SJxyzmD3NNVzjTdrSU6UTgx
+  Q7K/r2MRYxBmPBbi8wdxyP1Ko36o9BJdLNrUiAVec1VXOlqA9Iw8CyrlG3V1snNl
+  efNVzZ+sMCkR73IyxRRwRgPws2jo2/8LfKcL+J3mz4ekBs4PoyOCWCnPlpBjAwkx
+  OzzDCjpxYbn/SYNHC8MxVdgap7jEX75ogkfpGOrAEdiPASnc2nFKqbJNxX7hCQID
+  AQABo3MwcTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU2BKQg2pq
+  izVT9CkLdQo+nHNlvpQwGwYDVR0RBBQwEoEQYmF0aWZvbkB5YWhvby5mcjAbBgNV
+  HRIEFDASgRBiYXRpZm9uQHlhaG9vLmZyMA0GCSqGSIb3DQEBBQUAA4IBAQBkPKEW
+  urPeZb+IHuqWMqpzL/42fU4QuVUYDswLq+V0tXwnHo+okAq00Xh0yr0OaDBvm0mW
+  al9ZGC0RzaSQa+9mPd0t39oaWdtY7TOxQX3OC3vxdZ794gqyQgNxOmajFl22NY01
+  vxMAeZOu+IC5s2pQyUG0Gsq2sRbquW1mj8OC8KI3WWcECqGFOIOdXYTsqVqhwcN1
+  OpgZkC/pnOJanbP2ex2OHjlwFlpQ2PPAhoIG3mU1HEYXBZuP7+DUgNNgpopX83A5
+  0df+9hsqme8UngbwGqM1XgU4dUlXNaoHejAm/d9IrRPvqE2oFsS9ytHShth2bC43
+  LPBfw/xSG5R4RjMC
   -----END CERTIFICATE-----
-date: 2015-05-17 00:00:00.000000000 Z
+date: 2016-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,14 +52,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Urban Dictionary unofficial scrapper