lyracyst 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52dc9e24fd2289f6afd97edaa876f8b0c3cc418a
-  data.tar.gz: 00e086cdbf93d6763e57f88e695e6861428681f7
+  metadata.gz: eb07368fe2368b27ee37ec8f70d7f2d2a148db91
+  data.tar.gz: 22429d86922fcb5e73fe5a98981923da40e8d46b
 SHA512:
-  metadata.gz: c2b5e8a37901f2f74819ae12eb5273e6b462cbe2db7f8da8b5bcaaf5a7c200c9fd9ce20eb486392f348c8576c009797bb7cfd37fa9ff9de1dd69aa1c435793b4
-  data.tar.gz: 8f18730e1c9ba61d752cd4474cf5a25ce7ae752b79f33f27ffd2c95f98cc5cd6618b32c26857d5830752b38971c4baac728fbc621cbd8ea731cda60d98dbe52b
+  metadata.gz: 500198b5c4ee3a14352f07b62f0efd98f01dc62506fc2e93d9e851278537824a3b16c389afbe3e94d4b3f0999c399615255753755c541d25ff424d6d57ea10ec
+  data.tar.gz: 00aa7522afc18725af26ae6076fe31d4376bb18877e07db6baccaac69e2adced4757103dc675923688b10b11998a6ddc6745c27bb2f68967969380ed5f15a750

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 Changelog
 ===
 
+Version 0.0.8 - Major Improvements
+- The biggest milestone yet!
+- Most Wordnik search functions now work
+- Removed Altervista related words in favor of using Wordnik
+- Migrated from [ARPABET](http://arpabet.heroku.com) to [Rhymebrain](http://rhymebrain.com/api.html) and using it to fetch rhymes, word info, and portmanteaus
+- Migrated from [commander](http://github.com/visionmedia/commander) to [gli](http://github.com/davetron5000/gli) for CLI interface
+- Configuration file for defaults (~/.lyracyst.yml)
+
 Version 0.0.7 - Tests, Optimization, & More Cleanup
 - Better docs
 - Testing on more Ruby implementations

data/bin/lyracyst

@@ -1,27 +1,80 @@
 #!/usr/bin/env ruby
 # coding: utf-8
+#%w(curb em-synchrony em-http eventmachine excon httpclient httpi net/http/persistent rainbow).map {|lib| require lib}
+#%w(json/ext json/pure multi_json oj yajl).map {|lib| require lib}
+#%w(libxml multi_xml ox rexml/document).map {|lib| require lib}
 require 'gli'
-require './lib/lyracyst/rhymebrain.rb'
-require './lib/lyracyst/version.rb'
-require './lib/lyracyst/wordnik.rb'
+require 'lyracyst/rhymebrain'
+require 'lyracyst/urban'
+require 'lyracyst/version'
+require 'lyracyst/wordnik'
+require 'xml-fu'
+module Lyracyst
+
+  HTTPI.log = false
+
+  # Optionally sets HTTP adapter with httpi. Supports [:httpclient,
+  # :curb, :em_http, :net_http_persistent, :excon, :rack]
+  #
+  # @param http [Symbol] The http adapter to use. Smart defaults.
+  def self.set_http(http)
+    HTTPI.adapter = http
+  end
+
+  # Optionally sets JSON adapter with multi_json. Supports [:oj,
+  # :yajl, :json_gem, :json_pure]
+  #
+  # @param mj [Symbol] The JSON adapter to use. Smart defaults.
+  def self.set_json(mj)
+    MultiJson.use(mj)
+  end
+
+  # Optionally sets XML adapter with multi_xml. Supports [:ox,
+  # :libxml, :nokogiri, :rexml]
+  #
+  # @param mx [Symbol] The XML adapter to use. Smart defaults.
+  def self.set_xml(mx)
+    MultiXml.parser = mx
+  end
+
+  # Prints colored element label.
+  #
+  # @param label [String] The label to print
+  def self.label(label)
+    print Rainbow('[').blue.bright
+    print Rainbow(label).green.bright
+    print Rainbow(']').blue.bright
+    print Rainbow('|').bright
+  end
+end
 
 include GLI::App
-program_desc 'A powerful word search tool that fetches definitions, related words, rhymes, and much more.'
+program_desc 'A powerful word search tool that fetches definitions, related words, rhymes, and much more. Rhymes are provided by rhymebrain.com.'
 config_file '.lyracyst.yml'
 version Lyracyst::VERSION
 
+desc 'Force overwrite'
+long_desc 'Overwrites existing JSON & XML files'
+switch [:f,:force]
+
 desc 'HTTP adapter'
 long_desc 'httpclient, curb, em_http, net_http_persistent, excon, rack'
-default_value :excon
+default_value :net_http_persistent
 arg_name 'http'
 flag [:h,:http]
 
 desc 'JSON adapter'
 long_desc 'oj, yajl, json_gem, json_pure'
-default_value :json_pure
+default_value :oj
 arg_name 'json'
 flag [:j,:json]
 
+desc 'Output file'
+long_desc 'filename.json or filename.xml'
+default_value nil
+arg_name 'outfile'
+flag [:o,:out]
+
 desc 'XML adapter'
 long_desc 'ox, libxml, nokogiri, rexml'
 default_value :rexml
@@ -46,7 +99,7 @@ command :define do |c|
     part = options[:p]
     params = {limit: 10, increl: false, canon: false, inctags: false}
     params[:defdict] = options[:defdict]
-    df = Lyracyst::Wordnik.new
+    df = Lyracyst::Wordnik::Define.new
     df.get_def(search, part, params)
   end
 end
@@ -69,7 +122,7 @@ command :example do |c|
     params = {incdups: false, canon: false}
     params[:skip] = skip
     params[:limit] = limit
-    ex = Lyracyst::Wordnik.new
+    ex = Lyracyst::Wordnik::Example.new
     ex.get_ex(search, params)
   end
 end
@@ -91,7 +144,7 @@ command :relate do |c|
     rellimit = options[:rell]
     params = {canon: false}
     params[:rellimit] = rellimit
-    ex = Lyracyst::Wordnik.new
+    ex = Lyracyst::Wordnik::Relate.new
     ex.get_rel(search, params, reltypes)
   end
 end
@@ -120,7 +173,7 @@ command :pronounce do |c|
     params = {canon: false}
     params[:source] = source
     params[:limit] = limit
-    pr = Lyracyst::Wordnik.new
+    pr = Lyracyst::Wordnik::Pronounce.new
     pr.get_pro(search, params, ptype)
   end
 end
@@ -143,7 +196,7 @@ command :hyphen do |c|
     params = {canon: false}
     if source != nil then params[:source] = source; end
     params[:limit] = limit
-    hyph = Lyracyst::Wordnik.new
+    hyph = Lyracyst::Wordnik::Hyphen.new
     hyph.get_hyph(search, params)
   end
 end
@@ -166,7 +219,7 @@ command :phrase do |c|
     params = {canon: false}
     params[:limit] = limit
     params[:wlmi] = wlmi
-    phra = Lyracyst::Wordnik.new
+    phra = Lyracyst::Wordnik::Phrase.new
     phra.get_phr(search, params)
   end
 end
@@ -177,12 +230,12 @@ command :origin do |c|
   c.action do |global_options,options,args|
     search = args[0]
     params = {canon: false}
-    orig = Lyracyst::Wordnik.new
+    orig = Lyracyst::Wordnik::Origin.new
     orig.get_et(search, params)
   end
 end
 
-desc 'Fetches rhymes from Rhymebrain'
+desc 'Fetches rhymes from Rhymebrain.com'
 arg_name 'word'
 command :rhyme do |c|
   c.desc 'ISO639-1 language code (optional). Eg. en, de, es, fr, ru'
@@ -200,12 +253,12 @@ command :rhyme do |c|
     params = {}
     params[:lang] = lang
     params[:max] = max
-    rhym = Lyracyst::Rhymebrain.new
+    rhym = Lyracyst::Rhymebrain::Rhyme.new
     rhym.get_rhyme(search, params)
   end
 end
 
-desc 'Fetches word info from Rhymebrain'
+desc 'Fetches word info from Rhymebrain.com'
 arg_name 'word'
 command :info do |c|
   c.desc 'ISO639-1 language code (optional). Eg. en, de, es, fr, ru'
@@ -223,12 +276,12 @@ command :info do |c|
     params = {}
     params[:lang] = lang
     params[:max] = max
-    info = Lyracyst::Rhymebrain.new
+    info = Lyracyst::Rhymebrain::Info.new
     info.get_info(search, params)
   end
 end
 
-desc 'Fetches combined words (portmanteaus) from Rhymebrain'
+desc 'Fetches combined words (portmanteaus) from Rhymebrain.com'
 arg_name 'word'
   command :combine do |c|
   c.desc 'ISO639-1 language code (optional). Eg. en, de, es, fr, ru'
@@ -246,41 +299,61 @@ arg_name 'word'
     params = {}
     params[:lang] = lang
     params[:max] = max
-    port = Lyracyst::Rhymebrain.new
+    port = Lyracyst::Rhymebrain::Combine.new
     port.get_port(search, params)
   end
 end
 
+desc 'Fetches definitions from Urban Dictionary'
+arg_name 'word'
+command :urban do |c|
+  c.action do |global_options,options,args|
+    search = args[0]
+    ur = Lyracyst::Urban::Define.new
+    ur.get_def(search)
+  end
+end
+
 pre do |global,command,options,args|
   # Pre logic here
   # Return true to proceed; false to abort and not call the
   # chosen command
   # Use skips_pre before a command to skip this block
   # on that command only
-  wn = Lyracyst::Wordnik.new
+  if global[:o] != nil
+    outfile = global[:o]
+    if outfile =~ /\w*\.json/
+      $fmt = :json
+    elsif outfile =~ /\w*.xml/
+      $fmt = :xml
+    else
+      puts 'Invalid file extension.'
+    end
+    $tofile = []
+  end
   http = global[:h]
   json = global[:j]
   xml = global[:x]
   if http.class != Symbol then http = http.to_sym; end
-  wn.set_http(http)
+  Lyracyst.set_http(http)
   if json.class != Symbol then json = json.to_sym; end
-  wn.set_json(json)
+  Lyracyst.set_json(json)
   if xml.class != Symbol then xml = xml.to_sym; end
-  wn.set_xml(xml)
+  Lyracyst.set_xml(xml)
   label = 'Global options'
-  wn.label(label)
-  print "- #{global} "
+  Lyracyst.label(label)
+  print "➜#{global}➜"
   label = 'Command'
-  wn.label(label)
-  print "- #{command.name} "
+  Lyracyst.label(label)
+  print "➜#{command.name}➜"
   label = 'Command options'
-  wn.label(label)
-  print "- #{options} "
+  Lyracyst.label(label)
+  print "➜#{options}➜"
   label = 'Args'
-  wn.label(label)
-  print "- #{args} "
+  Lyracyst.label(label)
+  print "➜#{args}➜"
   label =  'Bootstrapped'
-  wn.label(label)
+  Lyracyst.label(label)
   puts ''
   true
 end
@@ -289,9 +362,61 @@ post do |global,command,options,args|
   # Post logic here
   # Use skips_post before a command to skip this
   # block on that command only
-  wn = Lyracyst::Wordnik.new
-  label =  'Shutdown'
-  wn.label(label)
+  if $fmt != nil
+    outfile = global[:o]
+    if File.exist?(outfile) && global[:f] == true
+      if $fmt == :json
+        fo = File.open(outfile, 'w+')
+        fo.print MultiJson.dump($tofile)
+        fo.close
+      elsif $fmt == :xml
+        fo = File.open(outfile, 'w+')
+        fo.print '<?xml version="1.0" encoding="utf-8"?>'
+        fo.print XmlFu.xml($tofile)
+        fo.close
+      else
+        puts 'Invalid file extension.'
+      end
+      puts Rainbow("Word search was written to #{outfile}.").bright
+    end
+    if File.exist?(outfile) && global[:f] == false
+      puts Rainbow("#{outfile} exists. Overwrite? y/n ").bright
+      ans = gets
+      if ans =~ /y/
+        if $fmt == :json
+          fo = File.open(outfile, 'w+')
+          fo.print MultiJson.dump($tofile)
+          fo.close
+        elsif $fmt == :xml
+          fo = File.open(outfile, 'w+')
+          fo.print '<?xml version="1.0" encoding="utf-8"?>'
+          fo.print XmlFu.xml($tofile)
+          fo.close
+        else
+          puts 'Invalid file extension.'
+        end
+        puts Rainbow("Word search was written to #{outfile}.").bright
+      else
+        puts 'Please try again with a different filename.'
+      end
+    else
+      if $fmt == :json
+        fo = File.open(outfile, 'w+')
+        fo.print MultiJson.dump($tofile)
+        fo.close
+      elsif $fmt == :xml
+        fo = File.open(outfile, 'w+')
+        fo.print '<?xml version="1.0" encoding="utf-8"?>'
+        fo.print XmlFu.xml($tofile)
+        fo.close
+      else
+        puts 'Invalid file extension.'
+      end
+      puts Rainbow("Word search was written to #{outfile}.").bright
+    end
+  end
+  label = 'Shutdown'
+  Lyracyst.label(label)
   puts ''
 end
 
@@ -300,5 +425,4 @@ on_error do |exception|
   # return false to skip default error handling
   true
 end
-
 exit run(ARGV)

data/lib/lyracyst.rb

@@ -1,27 +1,80 @@
 #!/usr/bin/env ruby
 # coding: utf-8
+#%w(curb em-synchrony em-http eventmachine excon httpclient httpi net/http/persistent rainbow).map {|lib| require lib}
+#%w(json/ext json/pure multi_json oj yajl).map {|lib| require lib}
+#%w(libxml multi_xml ox rexml/document).map {|lib| require lib}
 require 'gli'
 require 'lyracyst/rhymebrain'
+require 'lyracyst/urban'
 require 'lyracyst/version'
 require 'lyracyst/wordnik'
+require 'xml-fu'
+module Lyracyst
+
+  HTTPI.log = false
+
+  # Optionally sets HTTP adapter with httpi. Supports [:httpclient,
+  # :curb, :em_http, :net_http_persistent, :excon, :rack]
+  #
+  # @param http [Symbol] The http adapter to use. Smart defaults.
+  def self.set_http(http)
+    HTTPI.adapter = http
+  end
+
+  # Optionally sets JSON adapter with multi_json. Supports [:oj,
+  # :yajl, :json_gem, :json_pure]
+  #
+  # @param mj [Symbol] The JSON adapter to use. Smart defaults.
+  def self.set_json(mj)
+    MultiJson.use(mj)
+  end
+
+  # Optionally sets XML adapter with multi_xml. Supports [:ox,
+  # :libxml, :nokogiri, :rexml]
+  #
+  # @param mx [Symbol] The XML adapter to use. Smart defaults.
+  def self.set_xml(mx)
+    MultiXml.parser = mx
+  end
+
+  # Prints colored element label.
+  #
+  # @param label [String] The label to print
+  def self.label(label)
+    print Rainbow('[').blue.bright
+    print Rainbow(label).green.bright
+    print Rainbow(']').blue.bright
+    print Rainbow('|').bright
+  end
+end
 
 include GLI::App
-program_desc 'A powerful word search tool that fetches definitions, related words, rhymes, and much more.'
+program_desc 'A powerful word search tool that fetches definitions, related words, rhymes, and much more. Rhymes are provided by rhymebrain.com.'
 config_file '.lyracyst.yml'
 version Lyracyst::VERSION
 
+desc 'Force overwrite'
+long_desc 'Overwrites existing JSON & XML files'
+switch [:f,:force]
+
 desc 'HTTP adapter'
 long_desc 'httpclient, curb, em_http, net_http_persistent, excon, rack'
-default_value :excon
+default_value :net_http_persistent
 arg_name 'http'
 flag [:h,:http]
 
 desc 'JSON adapter'
 long_desc 'oj, yajl, json_gem, json_pure'
-default_value :json_pure
+default_value :oj
 arg_name 'json'
 flag [:j,:json]
 
+desc 'Output file'
+long_desc 'filename.json or filename.xml'
+default_value nil
+arg_name 'outfile'
+flag [:o,:out]
+
 desc 'XML adapter'
 long_desc 'ox, libxml, nokogiri, rexml'
 default_value :rexml
@@ -46,7 +99,7 @@ command :define do |c|
     part = options[:p]
     params = {limit: 10, increl: false, canon: false, inctags: false}
     params[:defdict] = options[:defdict]
-    df = Lyracyst::Wordnik.new
+    df = Lyracyst::Wordnik::Define.new
     df.get_def(search, part, params)
   end
 end
@@ -69,7 +122,7 @@ command :example do |c|
     params = {incdups: false, canon: false}
     params[:skip] = skip
     params[:limit] = limit
-    ex = Lyracyst::Wordnik.new
+    ex = Lyracyst::Wordnik::Example.new
     ex.get_ex(search, params)
   end
 end
@@ -91,7 +144,7 @@ command :relate do |c|
     rellimit = options[:rell]
     params = {canon: false}
     params[:rellimit] = rellimit
-    ex = Lyracyst::Wordnik.new
+    ex = Lyracyst::Wordnik::Relate.new
     ex.get_rel(search, params, reltypes)
   end
 end
@@ -120,7 +173,7 @@ command :pronounce do |c|
     params = {canon: false}
     params[:source] = source
     params[:limit] = limit
-    pr = Lyracyst::Wordnik.new
+    pr = Lyracyst::Wordnik::Pronounce.new
     pr.get_pro(search, params, ptype)
   end
 end
@@ -143,7 +196,7 @@ command :hyphen do |c|
     params = {canon: false}
     if source != nil then params[:source] = source; end
     params[:limit] = limit
-    hyph = Lyracyst::Wordnik.new
+    hyph = Lyracyst::Wordnik::Hyphen.new
     hyph.get_hyph(search, params)
   end
 end
@@ -166,7 +219,7 @@ command :phrase do |c|
     params = {canon: false}
     params[:limit] = limit
     params[:wlmi] = wlmi
-    phra = Lyracyst::Wordnik.new
+    phra = Lyracyst::Wordnik::Phrase.new
     phra.get_phr(search, params)
   end
 end
@@ -177,12 +230,12 @@ command :origin do |c|
   c.action do |global_options,options,args|
     search = args[0]
     params = {canon: false}
-    orig = Lyracyst::Wordnik.new
+    orig = Lyracyst::Wordnik::Origin.new
     orig.get_et(search, params)
   end
 end
 
-desc 'Fetches rhymes from Rhymebrain'
+desc 'Fetches rhymes from Rhymebrain.com'
 arg_name 'word'
 command :rhyme do |c|
   c.desc 'ISO639-1 language code (optional). Eg. en, de, es, fr, ru'
@@ -200,12 +253,12 @@ command :rhyme do |c|
     params = {}
     params[:lang] = lang
     params[:max] = max
-    rhym = Lyracyst::Rhymebrain.new
+    rhym = Lyracyst::Rhymebrain::Rhyme.new
     rhym.get_rhyme(search, params)
   end
 end
 
-desc 'Fetches word info from Rhymebrain'
+desc 'Fetches word info from Rhymebrain.com'
 arg_name 'word'
 command :info do |c|
   c.desc 'ISO639-1 language code (optional). Eg. en, de, es, fr, ru'
@@ -223,12 +276,12 @@ command :info do |c|
     params = {}
     params[:lang] = lang
     params[:max] = max
-    info = Lyracyst::Rhymebrain.new
+    info = Lyracyst::Rhymebrain::Info.new
     info.get_info(search, params)
   end
 end
 
-desc 'Fetches combined words (portmanteaus) from Rhymebrain'
+desc 'Fetches combined words (portmanteaus) from Rhymebrain.com'
 arg_name 'word'
   command :combine do |c|
   c.desc 'ISO639-1 language code (optional). Eg. en, de, es, fr, ru'
@@ -246,41 +299,61 @@ arg_name 'word'
     params = {}
     params[:lang] = lang
     params[:max] = max
-    port = Lyracyst::Rhymebrain.new
+    port = Lyracyst::Rhymebrain::Combine.new
     port.get_port(search, params)
   end
 end
 
+desc 'Fetches definitions from Urban Dictionary'
+arg_name 'word'
+command :urban do |c|
+  c.action do |global_options,options,args|
+    search = args[0]
+    ur = Lyracyst::Urban::Define.new
+    ur.get_def(search)
+  end
+end
+
 pre do |global,command,options,args|
   # Pre logic here
   # Return true to proceed; false to abort and not call the
   # chosen command
   # Use skips_pre before a command to skip this block
   # on that command only
-  wn = Lyracyst::Wordnik.new
+  if global[:o] != nil
+    outfile = global[:o]
+    if outfile =~ /\w*\.json/
+      $fmt = :json
+    elsif outfile =~ /\w*.xml/
+      $fmt = :xml
+    else
+      puts 'Invalid file extension.'
+    end
+    $tofile = []
+  end
   http = global[:h]
   json = global[:j]
   xml = global[:x]
   if http.class != Symbol then http = http.to_sym; end
-  wn.set_http(http)
+  Lyracyst.set_http(http)
   if json.class != Symbol then json = json.to_sym; end
-  wn.set_json(json)
+  Lyracyst.set_json(json)
   if xml.class != Symbol then xml = xml.to_sym; end
-  wn.set_xml(xml)
+  Lyracyst.set_xml(xml)
   label = 'Global options'
-  wn.label(label)
-  print "- #{global} "
+  Lyracyst.label(label)
+  print "➜#{global}➜"
   label = 'Command'
-  wn.label(label)
-  print "- #{command.name} "
+  Lyracyst.label(label)
+  print "➜#{command.name}➜"
   label = 'Command options'
-  wn.label(label)
-  print "- #{options} "
+  Lyracyst.label(label)
+  print "➜#{options}➜"
   label = 'Args'
-  wn.label(label)
-  print "- #{args} "
+  Lyracyst.label(label)
+  print "➜#{args}➜"
   label =  'Bootstrapped'
-  wn.label(label)
+  Lyracyst.label(label)
   puts ''
   true
 end
@@ -289,9 +362,61 @@ post do |global,command,options,args|
   # Post logic here
   # Use skips_post before a command to skip this
   # block on that command only
-  wn = Lyracyst::Wordnik.new
-  label =  'Shutdown'
-  wn.label(label)
+  if $fmt != nil
+    outfile = global[:o]
+    if File.exist?(outfile) && global[:f] == true
+      if $fmt == :json
+        fo = File.open(outfile, 'w+')
+        fo.print MultiJson.dump($tofile)
+        fo.close
+      elsif $fmt == :xml
+        fo = File.open(outfile, 'w+')
+        fo.print '<?xml version="1.0" encoding="utf-8"?>'
+        fo.print XmlFu.xml($tofile)
+        fo.close
+      else
+        puts 'Invalid file extension.'
+      end
+      puts Rainbow("Word search was written to #{outfile}.").bright
+    end
+    if File.exist?(outfile) && global[:f] == false
+      puts Rainbow("#{outfile} exists. Overwrite? y/n ").bright
+      ans = gets
+      if ans =~ /y/
+        if $fmt == :json
+          fo = File.open(outfile, 'w+')
+          fo.print MultiJson.dump($tofile)
+          fo.close
+        elsif $fmt == :xml
+          fo = File.open(outfile, 'w+')
+          fo.print '<?xml version="1.0" encoding="utf-8"?>'
+          fo.print XmlFu.xml($tofile)
+          fo.close
+        else
+          puts 'Invalid file extension.'
+        end
+        puts Rainbow("Word search was written to #{outfile}.").bright
+      else
+        puts 'Please try again with a different filename.'
+      end
+    else
+      if $fmt == :json
+        fo = File.open(outfile, 'w+')
+        fo.print MultiJson.dump($tofile)
+        fo.close
+      elsif $fmt == :xml
+        fo = File.open(outfile, 'w+')
+        fo.print '<?xml version="1.0" encoding="utf-8"?>'
+        fo.print XmlFu.xml($tofile)
+        fo.close
+      else
+        puts 'Invalid file extension.'
+      end
+      puts Rainbow("Word search was written to #{outfile}.").bright
+    end
+  end
+  label = 'Shutdown'
+  Lyracyst.label(label)
   puts ''
 end
 
@@ -300,5 +425,4 @@ on_error do |exception|
   # return false to skip default error handling
   true
 end
-
 exit run(ARGV)