lyracyst 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36f67dfe963fa4783cee935575cb1c2102f6d8c4
-  data.tar.gz: be91d0d61356c970bda520dd555076968e259bde
+  metadata.gz: 8723f57fb79a4ce8acbe30465686e5c04f8fd93c
+  data.tar.gz: 7ac5df788e079525c4bd72c53ebea08ca08cb23a
 SHA512:
-  metadata.gz: 8215028afaf58b54cdd9e7d9b816fda64fe1c11381af4815e3503be7fd4c451a0c9471a8c88b87ec3a0d454d17c02bc727eae1e7d05dd1739c2e08c4a707b4d9
-  data.tar.gz: 7c3fbcd3e37ef7d6358f36b113b0a6331f687f4a0e6841e5c2a03f6762184f8da866fd5064a5bdce5b399d944cd48dbab737db5102c5f2da8c0e17a97539aa4a
+  metadata.gz: 6b4fc7346156ff36f9080d1f211ed8a019dd1954510e4cfbc6861e13f933a02e45631989a18542738515ac41ca6346520c859f63033404aba25ce5e13884a961
+  data.tar.gz: b5f8385b1dcb2d6f20742d6bf75095d4618652a4b28f1d754024108d12f1ada0c90caacc99150e31baa18e8f5cd65ba8f5cf65d3f84d5430b3fd90295c642cba

data/bin/lyracyst

@@ -1,4 +1,10 @@
 #!/usr/bin/env ruby
+
+require 'commander/import'
+require 'lyracyst/fetch'
+require 'lyracyst/search'
+require 'lyracyst/version'
+
 # The program takes a search term and returns a list.
 # The list can be either definitions, related words,
 # rhymes, or all three at once.
@@ -6,238 +12,76 @@
 # Author::    Drew Prentice  (mailto:weirdpercent@gmail.com)
 # Copyright:: Copyright (c) 2014 Drew Prentice
 # License::   MIT
+module Lyracyst
+  environment = 'ruby'
+  program :name, 'lyracyst'
+  program :version, VERSION
+  program :description, 'A powerful word search tool that fetches definitions, related words, and rhymes.'
 
-require 'rubygems'
-require 'commander/import'
-#require 'configatron'
-require 'multi_json'
-#require 'nokogiri'
-require 'open-uri/cached'
-require 'wordnik'
-
-OpenURI::Cache.cache_path = 'tmp/open-uri'
-environment='ruby'
-result=''
-
-# Handles tasks related to fetching queries
-class Fetch
-
-  # Opens URL and returns the JSON response.
-  #
-  # @param url [String] The query URL
-  # @param result [String] The JSON response.
-  def search(url, result)
-    result=open(url).read
-  end
-
-  # Sets today's date and writes it with querycount to syncqc.json.
-  #
-  # @param dateint [Fixnum] Today's date in integer form.
-  # @param querycount [Fixnum] Number of daily queries in integer form.
-  def update(dateint, querycount)
-    qct={'date' => dateint, 'querycount' => querycount}
-    fo=File.open("json/synqc.json", "w+")
-    tofile=MultiJson.dump(qct)
-    fo.print tofile
-    fo.close
-  end
-
-  # Extracts related words from JSON response and prints them.
-  #
-  # @param x [Fixnum] Integer always set to zero.
-  # @param y [Fixnum] Number of items in resulta Array minus 1.
-  # @param resulta [Array] An array of values from JSON response.
-  def rel(x, y, resulta)
-    while x <= y
-      resultl=resulta[x]
-      list=resultl['list']
-      cat=list['category'].gsub(/\(|\)/, '')
-      puts "Related words: #{list['category']} - #{list['synonyms']}"
-      x+=1
+  command :get do |c|
+    c.syntax = 'lyracyst get word'
+    c.summary = 'Fetches all sources'
+    c.description = 'Searches definitions, related words, and rhymes for a given query'
+    c.example 'Fetches info about the word test', 'lyracyst get test'
+    #c.option = '--lang en_US', String, 'Sets search language'
+    #c.option = '--fmt json', String, 'Sets XML or JSON format'
+    c.action do |args, options|
+      #options.default :lang => 'en_US', :fmt => 'json'
+      lang = 'en_US'
+      fmt = 'json'
+      search = args[0]
+      fmt = 'json'
+      result = []
+      s = Lyracyst::Search.new
+      puts "Getting all for [#{search}]"
+      s.define(search)
+      s.related(search, result, lang, fmt)
+      s.rhyme(search, result)
     end
   end
 
-  # Submits search term and parameters to Altervista.
-  # searchlang can be de_DE, el_GR, en_US, es_ES, fr_FR,
-  # it_IT, no_NO, pt_PT, ro_RO, ru_RU, or sk_SK.
-  # dataoutput only takes 'json' right now. This method calls
-  # {Fetch#search} and {Fetch#update}.
-  #
-  # @param search [String] The word or phrase to search for.
-  # @param dateint [Fixnum] Today's date in integer form.
-  # @param result [String] The JSON response.
-  # @param environment [String] Execution environment, right now just ruby.
-  # @param querycount [Fixnum] Number of daily queries in integer form.
-  def submit(search, dateint, result, environment, querycount)
-    urlprefix='http://thesaurus.altervista.org/thesaurus/v1'
-    apikey=ENV['THESAURUS']
-    searchlang='en_US'
-    dataoutput='json'
-    url="#{urlprefix}?key=#{apikey}&word=#{search}&language=#{searchlang}&output=#{dataoutput}"
-    if environment == 'javascript'
-      url="#{url}&callback=synonymSearch"
+  command :define do |c|
+    c.syntax = 'lyracyst define word'
+    c.summary = 'Fetches definitions'
+    c.description = 'Uses the Wordnik API to get definitions'
+    c.example 'Uses the Wordnik API to get definitions of the word test', 'lyracyst define test'
+    c.action do |args, options|
+      search = args[0]
+      s = Lyracyst::Search.new
+      puts "Getting definitions for [#{search}]"
+      s.define(search)
     end
-    f=Fetch.new()
-    resultj=f.search(url, result)
-    resultp=MultiJson.load(resultj)
-    resulta=resultp['response']
-    x=0
-    y=resulta.length-1
-    f.rel(x, y, resulta)
-    querycount+=1
-    f.update(dateint, querycount)
   end
 
-  # Formats rhyme results, assumes a space means a
-  # word contraction, i.e. raison d'etre and inserts
-  # an apostrophe. Also removes Arpabet numbers.
-  #
-  # @param x [Fixnum] Integer always set to zero.
-  # @param y [Fixnum] Number of items in resulta Array minus 1.
-  # @param parse [String] The rhyming word to be formatted.
-  def parse(x, y, parse)
-    while x <= y
-      if parse[x] =~ / \d/
-        fix=parse[x]
-        parse[x]=fix.gsub(/ \d/ , "")
-      end
-      if parse[x] =~ / /
-        fix=parse[x]
-        parse[x]=fix.gsub(' ', "'")
-      end
-      print "#{parse[x]} "
-      x+=1
+  command :related do |c|
+    c.syntax = 'lyracyst related word'
+    c.summary = 'Fetches related words'
+    c.description = 'Uses the Altervista API to get related words'
+    c.example 'Uses the Altervista API to get words related to test', 'lyracyst related test'
+    #c.option = '--lang', String, 'Sets search language'
+    c.action do |args, options|
+      lang = 'en_US'
+      fmt = 'json'
+      search = args[0]
+      result = []
+      s = Lyracyst::Search.new
+      puts "Getting related words for [#{search}]"
+      s.related(search, result, lang, fmt)
     end
   end
-end
 
-# The Search class defines three methods for submitting queries.
-class Search
-  # Altervista.org's thesaurus service provides related words.
-  # The service limits each API key to 5000 queries a day. If
-  # maximum number of queries has been reached, this methods
-  # will exit. This method calls {Fetch#update} and {Fetch#submit}.
-  #
-  # @param search [String] The word or phrase to search for.
-  # @param result [String] The JSON response.
-  def related(search, result)
-    environment='ruby'; maxqueries=5000; querycount=0; t=Time.now; y=t.year.to_s; m=t.month; d=t.day;
-    if m < 10 then m="0#{m}" else  m=m.to_s; end
-    if d < 10 then d="0#{d}" else d=d.to_s; end
-    date="#{y}#{m}#{d}"
-    dateint=date.to_i
-    if File.exist?("json/synqc.json") == true
-      rl=File.readlines("json/synqc.json")
-      rl=rl[0]
-      loadrl=MultiJson.load(rl)
-      testdate=loadrl['date']
-      testcount=loadrl['querycount']
-      pdateint=testdate.to_i
-      if dateint > pdateint == true
-        f=Fetch.new()
-        f.update(dateint, querycount)
-      end
-    else
-      testcount=0
-    end
-    if testcount < maxqueries
-      f=Fetch.new()
-      f.submit(search, dateint, result, environment, querycount)
-    else
-      puts "Max queries per day has been reached."
-    end
-  end
-  # Wordnik.com's service provides definitions. The logger
-  # defaults to Rails.logger or Logger.new(STDOUT). Set to
-  # Logger.new('/dev/null') to disable logging.
-  #
-  # @param search [String] The word or phrase to search for.
-  def define(search)
-    apikey=ENV['WORDNIK']
-    Wordnik.configure do |cfg|
-      cfg.api_key=apikey
-      cfg.response_format='json'
-      cfg.logger = Logger.new('/dev/null')
+  command :rhyme do |c|
+    c.syntax = 'lyracyst rhyme word'
+    c.summary = 'Fetches rhymes'
+    c.description = 'Uses the ARPABET system to get rhymes'
+    c.example 'Uses the ARPABET system to get rhymes with test', 'lyracyst rhyme test'
+    c.option '--some-switch', 'Some switch that does something'
+    c.action do |args, options|
+      result = []
+      search = args[0]
+      s = Lyracyst::Search.new
+      puts "Getting rhymes for [#{search}]"
+      s.rhyme(search, result)
     end
-    define=Wordnik.word.get_definitions(search)
-    define.map { |defi|
-      text=defi['text']; att=defi['attributionText']; part=defi['partOfSpeech'];
-      puts "Definition: #{part} - #{text}"
-      #puts "Definition: #{part} - #{text} - #{att}" #With attribution to source
-    }
-  end
-
-  # ARPA created ARPABET decades ago to find words that
-  # rhyme. The technology is still quite relevant today.
-  # This program uses the Heroku app based on ARPABET.
-  #
-  # @param search [String] The word or phrase to search for.
-  def rhyme(search)
-    url="http://arpabet.heroku.com/words/#{search}"
-    f=Fetch.new()
-    result=f.search(url, result) #submit search query
-    parse=MultiJson.load(result)
-    print "Rhymes with: "
-    x=0
-    y=parse.length - 1
-    f.parse(x, y, parse)
-    print "\n"
-  end
-end
-
-program :name, 'lyracyst'
-program :version, '0.0.5'
-program :description, 'A powerful word search tool that fetches definitions, related words, and rhymes.'
-command :get do |c|
-  c.syntax = 'lyracyst get [options]'
-  c.summary = 'Fetches all sources'
-  c.description = 'Searches definitions, related words, and rhymes for a given query'
-  c.example 'Searches definitions, related words, and rhymes for a given query', 'lyracyst get test'
-  c.action do |args, options|
-    search=args[0]
-    s=Search.new
-    puts "Searching for [#{search}]:"
-    s.define(search)
-    s.related(search, result)
-    s.rhyme(search)
-  end
-end
-
-command :define do |c|
-  c.syntax = 'lyracyst define [options]'
-  c.summary = 'Fetches definitions'
-  c.description = 'Uses the Wordnik API to get definitions'
-  c.example 'Uses the Wordnik API to get definitions', 'lyracyst define test'
-  c.action do |args, options|
-    search=args[0]
-    s=Search.new
-    puts "Searching for [#{search}]:"
-    s.define(search)
-  end
-end
-
-command :related do |c|
-  c.syntax = 'lyracyst related [options]'
-  c.summary = 'Fetches related words'
-  c.description = 'Uses the Altervista API to get related words'
-  c.example 'Uses the Altervista API to get related words', 'lyracyst related test'
-  c.action do |args, options|
-    search=args[0]
-    s=Search.new
-    puts "Searching for [#{search}]:"
-    s.related(search)
-  end
-end
-
-command :rhyme do |c|
-  c.syntax = 'lyracyst rhyme [options]'
-  c.summary = 'Fetches rhymes'
-  c.description = 'Uses the ARPABET system to get rhymes'
-  c.example 'Uses the ARPABET system to get rhymes', 'lyracyst rhyme test'
-  c.action do |args, options|
-    search=args[0]
-    s=Search.new
-    puts "Searching for [#{search}]:"
-    s.rhyme(search)
   end
 end

data/lib/lyracyst.rb

@@ -1,4 +1,10 @@
 #!/usr/bin/env ruby
+
+require 'commander/import'
+require './lib/lyracyst/fetch.rb'
+require './lib/lyracyst/search.rb'
+require './lib/lyracyst/version.rb'
+
 # The program takes a search term and returns a list.
 # The list can be either definitions, related words,
 # rhymes, or all three at once.
@@ -6,238 +12,76 @@
 # Author::    Drew Prentice  (mailto:weirdpercent@gmail.com)
 # Copyright:: Copyright (c) 2014 Drew Prentice
 # License::   MIT
+module Lyracyst
+  environment = 'ruby'
+  program :name, 'lyracyst'
+  program :version, VERSION
+  program :description, 'A powerful word search tool that fetches definitions, related words, and rhymes.'
 
-require 'rubygems'
-require 'commander/import'
-#require 'configatron'
-require 'multi_json'
-#require 'nokogiri'
-require 'open-uri/cached'
-require 'wordnik'
-
-OpenURI::Cache.cache_path = 'tmp/open-uri'
-environment='ruby'
-result=''
-
-# Handles tasks related to fetching queries
-class Fetch
-
-  # Opens URL and returns the JSON response.
-  #
-  # @param url [String] The query URL
-  # @param result [String] The JSON response.
-  def search(url, result)
-    result=open(url).read
-  end
-
-  # Sets today's date and writes it with querycount to syncqc.json.
-  #
-  # @param dateint [Fixnum] Today's date in integer form.
-  # @param querycount [Fixnum] Number of daily queries in integer form.
-  def update(dateint, querycount)
-    qct={'date' => dateint, 'querycount' => querycount}
-    fo=File.open("json/synqc.json", "w+")
-    tofile=MultiJson.dump(qct)
-    fo.print tofile
-    fo.close
-  end
-
-  # Extracts related words from JSON response and prints them.
-  #
-  # @param x [Fixnum] Integer always set to zero.
-  # @param y [Fixnum] Number of items in resulta Array minus 1.
-  # @param resulta [Array] An array of values from JSON response.
-  def rel(x, y, resulta)
-    while x <= y
-      resultl=resulta[x]
-      list=resultl['list']
-      cat=list['category'].gsub(/\(|\)/, '')
-      puts "Related words: #{list['category']} - #{list['synonyms']}"
-      x+=1
+  command :get do |c|
+    c.syntax = 'lyracyst get word'
+    c.summary = 'Fetches all sources'
+    c.description = 'Searches definitions, related words, and rhymes for a given query'
+    c.example 'Fetches info about the word test', 'lyracyst get test'
+    #c.option = '--lang en_US', String, 'Sets search language'
+    #c.option = '--fmt json', String, 'Sets XML or JSON format'
+    c.action do |args, options|
+      #options.default :lang => 'en_US', :fmt => 'json'
+      lang = 'en_US'
+      fmt = 'json'
+      search = args[0]
+      fmt = 'json'
+      result = []
+      s = Lyracyst::Search.new
+      puts "Getting all for [#{search}]"
+      s.define(search)
+      s.related(search, result, lang, fmt)
+      s.rhyme(search, result)
     end
   end
 
-  # Submits search term and parameters to Altervista.
-  # searchlang can be de_DE, el_GR, en_US, es_ES, fr_FR,
-  # it_IT, no_NO, pt_PT, ro_RO, ru_RU, or sk_SK.
-  # dataoutput only takes 'json' right now. This method calls
-  # {Fetch#search} and {Fetch#update}.
-  #
-  # @param search [String] The word or phrase to search for.
-  # @param dateint [Fixnum] Today's date in integer form.
-  # @param result [String] The JSON response.
-  # @param environment [String] Execution environment, right now just ruby.
-  # @param querycount [Fixnum] Number of daily queries in integer form.
-  def submit(search, dateint, result, environment, querycount)
-    urlprefix='http://thesaurus.altervista.org/thesaurus/v1'
-    apikey=ENV['THESAURUS']
-    searchlang='en_US'
-    dataoutput='json'
-    url="#{urlprefix}?key=#{apikey}&word=#{search}&language=#{searchlang}&output=#{dataoutput}"
-    if environment == 'javascript'
-      url="#{url}&callback=synonymSearch"
+  command :define do |c|
+    c.syntax = 'lyracyst define word'
+    c.summary = 'Fetches definitions'
+    c.description = 'Uses the Wordnik API to get definitions'
+    c.example 'Uses the Wordnik API to get definitions of the word test', 'lyracyst define test'
+    c.action do |args, options|
+      search = args[0]
+      s = Lyracyst::Search.new
+      puts "Getting definitions for [#{search}]"
+      s.define(search)
     end
-    f=Fetch.new()
-    resultj=f.search(url, result)
-    resultp=MultiJson.load(resultj)
-    resulta=resultp['response']
-    x=0
-    y=resulta.length-1
-    f.rel(x, y, resulta)
-    querycount+=1
-    f.update(dateint, querycount)
   end
 
-  # Formats rhyme results, assumes a space means a
-  # word contraction, i.e. raison d'etre and inserts
-  # an apostrophe. Also removes Arpabet numbers.
-  #
-  # @param x [Fixnum] Integer always set to zero.
-  # @param y [Fixnum] Number of items in resulta Array minus 1.
-  # @param parse [String] The rhyming word to be formatted.
-  def parse(x, y, parse)
-    while x <= y
-      if parse[x] =~ / \d/
-        fix=parse[x]
-        parse[x]=fix.gsub(/ \d/ , "")
-      end
-      if parse[x] =~ / /
-        fix=parse[x]
-        parse[x]=fix.gsub(' ', "'")
-      end
-      print "#{parse[x]} "
-      x+=1
+  command :related do |c|
+    c.syntax = 'lyracyst related word'
+    c.summary = 'Fetches related words'
+    c.description = 'Uses the Altervista API to get related words'
+    c.example 'Uses the Altervista API to get words related to test', 'lyracyst related test'
+    #c.option = '--lang', String, 'Sets search language'
+    c.action do |args, options|
+      lang = 'en_US'
+      fmt = 'json'
+      search = args[0]
+      result = []
+      s = Lyracyst::Search.new
+      puts "Getting related words for [#{search}]"
+      s.related(search, result, lang, fmt)
     end
   end
-end
 
-# The Search class defines three methods for submitting queries.
-class Search
-  # Altervista.org's thesaurus service provides related words.
-  # The service limits each API key to 5000 queries a day. If
-  # maximum number of queries has been reached, this methods
-  # will exit. This method calls {Fetch#update} and {Fetch#submit}.
-  #
-  # @param search [String] The word or phrase to search for.
-  # @param result [String] The JSON response.
-  def related(search, result)
-    environment='ruby'; maxqueries=5000; querycount=0; t=Time.now; y=t.year.to_s; m=t.month; d=t.day;
-    if m < 10 then m="0#{m}" else  m=m.to_s; end
-    if d < 10 then d="0#{d}" else d=d.to_s; end
-    date="#{y}#{m}#{d}"
-    dateint=date.to_i
-    if File.exist?("json/synqc.json") == true
-      rl=File.readlines("json/synqc.json")
-      rl=rl[0]
-      loadrl=MultiJson.load(rl)
-      testdate=loadrl['date']
-      testcount=loadrl['querycount']
-      pdateint=testdate.to_i
-      if dateint > pdateint == true
-        f=Fetch.new()
-        f.update(dateint, querycount)
-      end
-    else
-      testcount=0
-    end
-    if testcount < maxqueries
-      f=Fetch.new()
-      f.submit(search, dateint, result, environment, querycount)
-    else
-      puts "Max queries per day has been reached."
-    end
-  end
-  # Wordnik.com's service provides definitions. The logger
-  # defaults to Rails.logger or Logger.new(STDOUT). Set to
-  # Logger.new('/dev/null') to disable logging.
-  #
-  # @param search [String] The word or phrase to search for.
-  def define(search)
-    apikey=ENV['WORDNIK']
-    Wordnik.configure do |cfg|
-      cfg.api_key=apikey
-      cfg.response_format='json'
-      cfg.logger = Logger.new('/dev/null')
+  command :rhyme do |c|
+    c.syntax = 'lyracyst rhyme word'
+    c.summary = 'Fetches rhymes'
+    c.description = 'Uses the ARPABET system to get rhymes'
+    c.example 'Uses the ARPABET system to get rhymes with test', 'lyracyst rhyme test'
+    c.option '--some-switch', 'Some switch that does something'
+    c.action do |args, options|
+      result = []
+      search = args[0]
+      s = Lyracyst::Search.new
+      puts "Getting rhymes for [#{search}]"
+      s.rhyme(search, result)
     end
-    define=Wordnik.word.get_definitions(search)
-    define.map { |defi|
-      text=defi['text']; att=defi['attributionText']; part=defi['partOfSpeech'];
-      puts "Definition: #{part} - #{text}"
-      #puts "Definition: #{part} - #{text} - #{att}" #With attribution to source
-    }
-  end
-
-  # ARPA created ARPABET decades ago to find words that
-  # rhyme. The technology is still quite relevant today.
-  # This program uses the Heroku app based on ARPABET.
-  #
-  # @param search [String] The word or phrase to search for.
-  def rhyme(search)
-    url="http://arpabet.heroku.com/words/#{search}"
-    f=Fetch.new()
-    result=f.search(url, result) #submit search query
-    parse=MultiJson.load(result)
-    print "Rhymes with: "
-    x=0
-    y=parse.length - 1
-    f.parse(x, y, parse)
-    print "\n"
-  end
-end
-
-program :name, 'lyracyst'
-program :version, '0.0.5'
-program :description, 'A powerful word search tool that fetches definitions, related words, and rhymes.'
-command :get do |c|
-  c.syntax = 'lyracyst get [options]'
-  c.summary = 'Fetches all sources'
-  c.description = 'Searches definitions, related words, and rhymes for a given query'
-  c.example 'Searches definitions, related words, and rhymes for a given query', 'lyracyst get test'
-  c.action do |args, options|
-    search=args[0]
-    s=Search.new
-    puts "Searching for [#{search}]:"
-    s.define(search)
-    s.related(search, result)
-    s.rhyme(search)
-  end
-end
-
-command :define do |c|
-  c.syntax = 'lyracyst define [options]'
-  c.summary = 'Fetches definitions'
-  c.description = 'Uses the Wordnik API to get definitions'
-  c.example 'Uses the Wordnik API to get definitions', 'lyracyst define test'
-  c.action do |args, options|
-    search=args[0]
-    s=Search.new
-    puts "Searching for [#{search}]:"
-    s.define(search)
-  end
-end
-
-command :related do |c|
-  c.syntax = 'lyracyst related [options]'
-  c.summary = 'Fetches related words'
-  c.description = 'Uses the Altervista API to get related words'
-  c.example 'Uses the Altervista API to get related words', 'lyracyst related test'
-  c.action do |args, options|
-    search=args[0]
-    s=Search.new
-    puts "Searching for [#{search}]:"
-    s.related(search)
-  end
-end
-
-command :rhyme do |c|
-  c.syntax = 'lyracyst rhyme [options]'
-  c.summary = 'Fetches rhymes'
-  c.description = 'Uses the ARPABET system to get rhymes'
-  c.example 'Uses the ARPABET system to get rhymes', 'lyracyst rhyme test'
-  c.action do |args, options|
-    search=args[0]
-    s=Search.new
-    puts "Searching for [#{search}]:"
-    s.rhyme(search)
   end
 end

data/lib/lyracyst/fetch.rb

@@ -0,0 +1,83 @@
+# -*- encoding: utf-8 -*-
+#!/usr/bin/env ruby
+# require 'configatron'
+require 'multi_json'
+require 'open-uri/cached'
+
+module Lyracyst
+# Handles tasks related to fetching queries
+  class Fetch
+    # Opens URL and returns the JSON response.
+    #
+    # @param url [String] The query URL
+    # @param result [String] The JSON response.
+    def search(url, result)
+      OpenURI::Cache.cache_path = 'tmp/open-uri'
+      uri = URI.parse(url)
+      status = uri.open.meta[:status]
+      if status[0] == '200'
+        result = uri.open.read
+        return result
+      else
+        puts "HTTP Status #{status[0]} #{status[1]}"
+      end
+    end
+    # Sets today's date and writes it with querycount to syncqc.json.
+    #
+    # @param dateint [Fixnum] Today's date in integer form.
+    # @param querycount [Fixnum] Number of daily queries in integer form.
+    def update(dateint, querycount)
+      qct = { 'date' => dateint, 'querycount' => querycount }
+      if File.exist?('json/synqc.json') == true
+        fo = File.open('json/synqc.json', "w+")
+      else
+        fo = File.new('json/synqc.json', "w+")
+      end
+      tofile = MultiJson.dump(qct)
+      fo.print tofile
+      fo.close
+    end
+    # Extracts related words from JSON response and prints them.
+    #
+    # @param x [Fixnum] Integer always set to zero.
+    # @param y [Fixnum] Number of items in resulta Array minus 1.
+    # @param resulta [Array] An array of values from JSON response.
+    def rel(x, y, resulta)
+      while x <= y
+        resultl = resulta[x]
+        list = resultl['list']
+        puts "Related words: #{list['category'].gsub(/\(|\)/, '')} - #{list['synonyms']}"
+        x += 1
+      end
+    end
+    # Submits search term and parameters to Altervista.
+    # lang can be de_DE, el_GR, en_US, es_ES, fr_FR,
+    # it_IT, no_NO, pt_PT, ro_RO, ru_RU, or sk_SK.
+    # fmt only takes 'json' right now. This method calls
+    # {Fetch#search}, {Fetch#rel} and {Fetch#update}.
+    #
+    # @param search [String] The word or phrase to search for.
+    # @param dateint [Fixnum] Today's date.
+    # @param result [String] The JSON response.
+    # @param querycount [Fixnum] Number of queries today.
+    # @param lang [String] Search language code
+    # @param fmt [String] json or xml, currently just json.
+    def submit(search, dateint, result, querycount, lang, fmt)
+      urlprefix = 'http://thesaurus.altervista.org/thesaurus/v1'
+      apikey = ENV['THESAURUS']
+      url = "#{urlprefix}?key=#{apikey}&word=#{search}&language=#{lang}&output=#{fmt}"
+      #if environment == 'javascript'
+        #url = "#{url}&callback=synonymSearch"
+      #end
+      f = Lyracyst::Fetch.new
+      resultj = f.search(url, result)
+      resultp = MultiJson.load(resultj)
+      resulta = resultp['response']
+      x = 0
+      y = resulta.length - 1
+      f.rel(x, y, resulta)
+      querycount += 1
+      #f.update(dateint, querycount) # FIXME Won't run in Aruba/Cucumber
+    end
+  end
+end

data/lib/lyracyst/search.rb

@@ -0,0 +1,92 @@
+# -*- encoding: utf-8 -*-
+#!/usr/bin/env ruby
+# require 'configatron'
+require 'multi_json'
+require 'wordnik'
+
+module Lyracyst
+  # Defines three methods for submitting queries.
+  class Search
+    # Altervista.org's thesaurus service provides related words.
+    # The service limits each API key to 5000 queries a day. If
+    # maximum number of queries has been reached, this methods
+    # will exit. Search language can be it_IT, fr_FR, de_DE,
+    # en_US, el_GR, es_ES, de_DE, no_NO, pt_PT, ro_RO, ru_RU,
+    # sk_SK. This method calls {Fetch#update} and {Fetch#submit}.
+    #
+    # @param search [String] The word or phrase to search for.
+    # @param result [Array] The JSON response.
+    # @param lang [String] Search language code.
+    # @param fmt [String] json or xml, currently just json.
+    def related(search, result, lang, fmt)
+      environment = 'ruby'
+      maxqueries = 5000
+      querycount = 0
+      t = Time.now
+      y = t.year.to_s
+      m = t.month
+      d = t.day
+      if m < 10 then m = "0#{m}" else  m = m.to_s; end
+      if d < 10 then d = "0#{d}" else d = d.to_s; end
+      date = "#{y}#{m}#{d}"
+      dateint = date.to_i
+      if File.exist?('json/synqc.json') == true
+        rl = File.readlines('json/synqc.json')
+        rl = rl[0]
+        loadrl = MultiJson.load(rl)
+        testdate = loadrl['date']
+        testcount = loadrl['querycount']
+        pdateint = testdate.to_i
+        if dateint > pdateint == true
+          f = Lyracyst::Fetch.new
+          f.update(dateint, querycount)
+        end
+      else
+        testcount = 0
+      end
+      if testcount < maxqueries
+        f = Lyracyst::Fetch.new
+        f.submit(search, dateint, result, querycount, lang, fmt)
+      else
+        puts 'Max queries per day has been reached.'
+      end
+    end
+    # Wordnik.com's service provides definitions. The logger
+    # defaults to Rails.logger or Logger.new(STDOUT). Set to
+    # Logger.new('/dev/null') to disable logging.
+    #
+    # @param search [String] The word or phrase to search for.
+    def define(search)
+      apikey = ENV['WORDNIK']
+      Wordnik.configure do |cfg|
+        cfg.api_key = apikey
+        cfg.response_format = 'json'
+        cfg.logger = Logger.new('/dev/null')
+      end
+      define = Wordnik.word.get_definitions(search)
+      if define != ''
+        define.map { |defi|
+          text = defi['text']
+          # att = defi['attributionText']
+          part = defi['partOfSpeech']
+          puts "Definition: #{part} - #{text}"
+          # puts "Definition: #{part} - #{text} - #{att}" #With attribution
+        }
+      else
+        puts 'Wordnik returned an empty string.'
+      end
+    end
+    # ARPA created ARPABET decades ago to find words that
+    # rhyme. The technology is still quite relevant today.
+    # This program uses the Heroku app based on ARPABET.
+    # This method calls {Fetch#search}.
+    #
+    # @param search [String] The word or phrase to search for.
+    def rhyme(search, result)
+      url = "http://arpabet.heroku.com/words/#{search}"
+      f = Lyracyst::Fetch.new
+      result = f.search(url, result)
+      puts "Rhymes with: #{result}"
+    end
+  end
+end

data/lib/lyracyst/version.rb

@@ -0,0 +1,4 @@
+module Lyracyst
+  # Semantic program version
+  VERSION = '0.0.6'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lyracyst
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Drew Prentice
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: configatron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: wordnik
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.12'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Search Wordnik, thesaurus.altervista.org, and Arpabet from the command
   line.
 email:
@@ -76,11 +146,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/lyracyst
-- changelog.md
 - lib/lyracyst.rb
-- license.md
-- readme.md
-- scaffold.md
+- lib/lyracyst/fetch.rb
+- lib/lyracyst/search.rb
+- lib/lyracyst/version.rb
 homepage: http://github.com/weirdpercent/lyracyst
 licenses:
 - MIT

data/changelog.md

@@ -1,17 +0,0 @@
-Changelog
-===
-
-Version 0.0.5 - Basic documentation
-- Command-line interface works
-- No more Code Climate because it doesn't like commander gem
-- Fixed /bin executable
-
-Version 0.0.1 - Feature complete
-- Ruby environment works
-- Secure Travis build works
-- JSON data handling works
-- Definitions work
-- Related words work
-- Thesaurus daily query limit enforced
-- Rhymes work
-- Improved Code Climate

data/license.md

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-========
-
-**Copyright (c) 2014 Drew Prentice**
-
-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

@@ -1,94 +0,0 @@
-lyracyst
-===
-
-[![lyracyst](lyra.jpg)](http://en.wikipedia.org/wiki/File:Lyra_constellation_detail_long_exposure.jpg)
-
-Constellation Lyra photo by [Scott Roy Atwood](http://en.wikipedia.org/wiki/File:Lyra_constellation_detail_long_exposure.jpg)
-
-[![Build Status](https://travis-ci.org/weirdpercent/lyracyst.png?branch=master)](https://travis-ci.org/weirdpercent/lyracyst)[![Gem Version](https://badge.fury.io/rb/lyracyst.svg)](http://badge.fury.io/rb/lyracyst)[![Dependency Status](https://gemnasium.com/weirdpercent/lyracyst.png)](https://gemnasium.com/weirdpercent/lyracyst)
-
-A powerful word search tool for writers of all kinds.
-
-### Synopsis
-
-Search [Wordnik](http://www.wordnik.com/), [thesaurus.altervista.org](http://thesaurus.altervista.org/), and [Arpabet](http://en.wikipedia.org/wiki/Arpabet) from the command line. Get API search keys as follows:
-Altervista - http://thesaurus.altervista.org/mykey
-Wordnik - http://developer.wordnik.com/
-Put them in environment variables THESAURUS and WORDNIK respectively. Adding these to .bashrc or .zshrc is the easiest way.
-
-### Features
-
-- Open URI fetching w/ transparent caching
-- Definitions from Wordnik
-- Rhymes from arpabet.heroku.com
-- Related words from thesaurus.altervista.org
-- JSON parsing
-
-### Usage
-
-    gem install lyracyst
-    lyracyst get test
-
-### Code Example
-
-    s=Search.new
-    s.define(search) # Wordnik definitions
-    s.related(search, result) # Altervista related words
-    s.rhyme(search) # Arpabet rhymes
-
-### Motivation
-
-I do a lot of writing and I wanted a tool for constructing song lyrics, poetry, and stories that rock.
-
-### Tests
-
-    TODO
-
-### Developers
-
-    bundle install
-    rake lyracyst:get[test]
-
-### Contributing workflow
-
-Here’s how we suggest you go about proposing a change to this project:
-
-1. [Fork this project][fork] to your account.
-2. [Create a branch][branch] for the change you intend to make.
-3. Make your changes to your fork.
-4. [Send a pull request][pr] from your fork’s branch to our `master` branch.
-
-Using the web-based interface to make changes is fine too, and will help you
-by automatically forking the project and prompting to send a pull request too.
-
-[fork]: http://help.github.com/forking/
-[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository
-[pr]: http://help.github.com/pull-requests/
-
-### License
-
-The MIT License (MIT)
-
-**Copyright (c) 2014 Drew Prentice**
-
-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.**
-
-### Gratitude
-
-Many thanks to all contributors to the gems used in this project!

data/scaffold.md

@@ -1,14 +0,0 @@
-### Generate eye-popping scaffolds for rails
-
-    rails g beautiful_scaffold scaffoldname title:string id:integer calc:float about:text cost:price rainbow:color doc:richtext markup:wysiwyg
-
-Types available:
-
-- integer
-- float
-- text
-- string
-- price
-- color
-- richtext
-- wysiwyg