lyracyst 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8723f57fb79a4ce8acbe30465686e5c04f8fd93c
-  data.tar.gz: 7ac5df788e079525c4bd72c53ebea08ca08cb23a
+  metadata.gz: 1fa76f61ab215f161aaef40ab5726c44fd692ec9
+  data.tar.gz: 71ca2a1f5adf2654c274a76d7459cd687aa5876b
 SHA512:
-  metadata.gz: 6b4fc7346156ff36f9080d1f211ed8a019dd1954510e4cfbc6861e13f933a02e45631989a18542738515ac41ca6346520c859f63033404aba25ce5e13884a961
-  data.tar.gz: b5f8385b1dcb2d6f20742d6bf75095d4618652a4b28f1d754024108d12f1ada0c90caacc99150e31baa18e8f5cd65ba8f5cf65d3f84d5430b3fd90295c642cba
+  metadata.gz: b8e42f4cd00aa09d5f365c6e658ea209226f519339da6b61282786dd2baa13ec3f85f870f01bf62e999a25bfc5c04c3e3dabdf28eb3eacb22f6e534a6424eb1e
+  data.tar.gz: 0b6d2b35be80197a39117348ad94dbe94426db3267348249898021c8c5240cfa1e4d31187974f4b2a020da54068d67637030a90981af5a7ef54e3a1f92cf4ffb

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+Changelog
+===
+
+Version 0.0.7 - Tests, Optimization, & More Cleanup
+- Better docs
+- Testing on more Ruby implementations
+- More restructuring of code and lib files
+- Transition from open-uri_cached to httpi
+- Support for multiple HTTP clients
+- More Cucumber features
+- multi_xml support for multiple XML parsers
+- XML parsing
+
+Version 0.0.6 - Module & Docs
+- Better documentation
+- Some rubocop cleanup
+- Lyracyst Module
+- Cucumber features w/ Aruba
+
+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

@@ -0,0 +1,22 @@
+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/bin/lyracyst

@@ -1,8 +1,11 @@
 #!/usr/bin/env ruby
+# coding: utf-8
 
 require 'commander/import'
-require 'lyracyst/fetch'
-require 'lyracyst/search'
+require 'lyracyst/define'
+require 'lyracyst/get'
+require 'lyracyst/relate'
+require 'lyracyst/rhyme'
 require 'lyracyst/version'
 
 # The program takes a search term and returns a list.
@@ -13,7 +16,8 @@ require 'lyracyst/version'
 # Copyright:: Copyright (c) 2014 Drew Prentice
 # License::   MIT
 module Lyracyst
-  environment = 'ruby'
+  # The platform this app is running on. For now only Ruby, plans for node.js version in the future.
+  ENVIRONMENT = 'ruby'
   program :name, 'lyracyst'
   program :version, VERSION
   program :description, 'A powerful word search tool that fetches definitions, related words, and rhymes.'
@@ -23,20 +27,17 @@ module Lyracyst
     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.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'
+      options.default :lang => 'en_US', :fmt => 'json'
+      lang = options.lang
+      fmt = options.fmt
       search = args[0]
-      fmt = 'json'
       result = []
-      s = Lyracyst::Search.new
+      g = Lyracyst::Get.new
       puts "Getting all for [#{search}]"
-      s.define(search)
-      s.related(search, result, lang, fmt)
-      s.rhyme(search, result)
+      g.get(search, result, lang, fmt)
     end
   end
 
@@ -45,28 +46,33 @@ module Lyracyst
     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.option '--fmt json', String, 'Sets XML or JSON format'
     c.action do |args, options|
+      options.default :fmt => 'json'
+      fmt = options.fmt
       search = args[0]
-      s = Lyracyst::Search.new
+      de = Lyracyst::Define.new
       puts "Getting definitions for [#{search}]"
-      s.define(search)
+      de.define(search, fmt)
     end
   end
 
-  command :related do |c|
-    c.syntax = 'lyracyst related word'
-    c.summary = 'Fetches related words'
+  command :relate do |c|
+    c.syntax = 'lyracyst relate word'
+    c.summary = 'Fetches relate 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.example 'Uses the Altervista API to get words related to test', 'lyracyst relate 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|
-      lang = 'en_US'
-      fmt = 'json'
+      options.default :lang => 'en_US', :fmt => 'json'
+      lang = options.lang
+      fmt = options.fmt
       search = args[0]
       result = []
-      s = Lyracyst::Search.new
+      re = Lyracyst::Relate.new
       puts "Getting related words for [#{search}]"
-      s.related(search, result, lang, fmt)
+      re.relate(search, result, lang, fmt)
     end
   end
 
@@ -75,13 +81,12 @@ module Lyracyst
     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|
+    c.action do |args|
       result = []
       search = args[0]
-      s = Lyracyst::Search.new
+      rh = Lyracyst::Rhyme.new
       puts "Getting rhymes for [#{search}]"
-      s.rhyme(search, result)
+      rh.rhyme(search, result)
     end
   end
 end

data/lib/lyracyst.rb

@@ -1,8 +1,11 @@
 #!/usr/bin/env ruby
+# coding: utf-8
 
 require 'commander/import'
-require './lib/lyracyst/fetch.rb'
-require './lib/lyracyst/search.rb'
+require './lib/lyracyst/define.rb'
+require './lib/lyracyst/get.rb'
+require './lib/lyracyst/relate.rb'
+require './lib/lyracyst/rhyme.rb'
 require './lib/lyracyst/version.rb'
 
 # The program takes a search term and returns a list.
@@ -13,7 +16,8 @@ require './lib/lyracyst/version.rb'
 # Copyright:: Copyright (c) 2014 Drew Prentice
 # License::   MIT
 module Lyracyst
-  environment = 'ruby'
+  # The platform this app is running on. For now only Ruby, plans for node.js version in the future.
+  ENVIRONMENT = 'ruby'
   program :name, 'lyracyst'
   program :version, VERSION
   program :description, 'A powerful word search tool that fetches definitions, related words, and rhymes.'
@@ -23,20 +27,17 @@ module Lyracyst
     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.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'
+      options.default :lang => 'en_US', :fmt => 'json'
+      lang = options.lang
+      fmt = options.fmt
       search = args[0]
-      fmt = 'json'
       result = []
-      s = Lyracyst::Search.new
+      g = Lyracyst::Get.new
       puts "Getting all for [#{search}]"
-      s.define(search)
-      s.related(search, result, lang, fmt)
-      s.rhyme(search, result)
+      g.get(search, result, lang, fmt)
     end
   end
 
@@ -45,28 +46,33 @@ module Lyracyst
     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.option '--fmt json', String, 'Sets XML or JSON format'
     c.action do |args, options|
+      options.default :fmt => 'json'
+      fmt = options.fmt
       search = args[0]
-      s = Lyracyst::Search.new
+      de = Lyracyst::Define.new
       puts "Getting definitions for [#{search}]"
-      s.define(search)
+      de.define(search, fmt)
     end
   end
 
-  command :related do |c|
-    c.syntax = 'lyracyst related word'
-    c.summary = 'Fetches related words'
+  command :relate do |c|
+    c.syntax = 'lyracyst relate word'
+    c.summary = 'Fetches relate 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.example 'Uses the Altervista API to get words related to test', 'lyracyst relate 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|
-      lang = 'en_US'
-      fmt = 'json'
+      options.default :lang => 'en_US', :fmt => 'json'
+      lang = options.lang
+      fmt = options.fmt
       search = args[0]
       result = []
-      s = Lyracyst::Search.new
+      re = Lyracyst::Relate.new
       puts "Getting related words for [#{search}]"
-      s.related(search, result, lang, fmt)
+      re.relate(search, result, lang, fmt)
     end
   end
 
@@ -75,13 +81,12 @@ module Lyracyst
     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|
+    c.action do |args|
       result = []
       search = args[0]
-      s = Lyracyst::Search.new
+      rh = Lyracyst::Rhyme.new
       puts "Getting rhymes for [#{search}]"
-      s.rhyme(search, result)
+      rh.rhyme(search, result)
     end
   end
 end

data/lib/lyracyst/define.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+require 'wordnik'
+
+module Lyracyst
+  # The Wordnik class defines methods for interacting with The
+  # Wordnik API.
+  class Define
+    # 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.
+    # @param fmt [String] The response format, json or xml.
+    def define(search, fmt)
+      apikey = ENV['WORDNIK']
+      Wordnik.configure do |cfg|
+        cfg.api_key = apikey
+        cfg.response_format = fmt
+        cfg.logger = Logger.new('/dev/null')
+      end
+      defi = Wordnik.word.get_definitions(search)
+      if defi != ''
+        defi.map { |d|
+          text = d['text']
+          # att = d['attributionText']
+          part = d['partOfSpeech']
+          puts "Definition: #{part} - #{text}"
+          # puts "Definition: #{part} - #{text} - #{att}" # With attribution
+        }
+      else
+        puts 'Wordnik returned an empty string.'
+      end
+    end
+  end
+end

data/lib/lyracyst/get.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+module Lyracyst
+  #The Get class defines a method to search all sources.
+  class Get
+    # Get searches each source with the same query.
+    #
+    # @param search [String] The word to search for.
+    # @param result [Array] The response array.
+    # @param lang [String] The search language.
+    # @param fmt [String] The response format, json or xml.
+    def get(search, result, lang, fmt)
+      de = Lyracyst::Define.new
+      re = Lyracyst::Relate.new
+      rh = Lyracyst::Rhyme.new
+      de.define(search, fmt)
+      re.relate(search, result, lang, fmt)
+      result = []
+      rh.rhyme(search, result)
+    end
+  end
+end

data/lib/lyracyst/relate.rb

@@ -0,0 +1,171 @@
+# coding: utf-8
+require 'httpi'
+require 'multi_json'
+require 'multi_xml'
+
+module Lyracyst
+  # The Relate class defines methods for interacting with the
+  # Altervista API.
+  class Relate
+    # 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 method
+    # 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 {Related#update} and {Related#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] Results format, json or xml.
+    def relate(search, result, lang, fmt)
+      max = 5000
+      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']
+        querycount = loadrl['querycount']
+        pdateint = testdate.to_i
+        if dateint > pdateint == true
+          re = Lyracyst::Relate.new
+          #re.update(dateint, querycount)
+        end
+      else
+        querycount = 0
+        new = { 'date' => dateint, 'querycount' => querycount }
+        #fo = File.open('json/synqc.json', "w+") # FIXME json dir operations fail in Cucumber
+        #tofile = MultiJson.dump(new)
+        #fo.print tofile
+        #fo.close
+      end
+      if querycount < max
+        urlprefix = 'http://thesaurus.altervista.org/thesaurus/v1'
+        apikey = ENV['THESAURUS']
+        url = "#{urlprefix}?key=#{apikey}&word=#{search}&language=#{lang}&output=#{fmt}"
+        re = Lyracyst::Relate.new
+        re.submit(url, dateint, result, querycount)
+      else
+        puts 'Max queries per day for related words has been reached.'
+      end
+    end
+    # Opens URL and returns response. HTTPI supports multiple HTTP
+    # clients, and selects the 'best' in the following order:
+    # httpclient, curb, em_http, excon, net_http, net_http_persistent.
+    # For C extensions, curb is recommended. For pure Ruby, use excon.
+    # You can specify a client to use like this:
+    # request = HTTPI::Request.new(url)
+    # HTTPI.get(request, :curb)
+    #
+    # @param url [String] The query URL
+    # @param result [Array] The response
+    # @param rtype [String] Results format, json or xml.
+    def http(url, result, rtype)
+      request = HTTPI::Request.new(url)
+      HTTPI.log = false
+      request = HTTPI.get(request)
+      if request.code == 200
+        if request.headers['Content-Type'] =~ /json/
+          rtype = 'json'
+          result = request.body
+        elsif request.headers['Content-Type'] =~ /xml/
+          rtype = 'xml'
+          result = request.body
+        else
+          puts "HTTP Content Type #{request.headers['Content-Type']}"
+        end
+      else
+        puts "HTTP Status #{request.code}"
+        puts "HTTP Body #{request.body}"
+      end
+      return result, rtype
+    end
+    # Parses a JSON response into a Ruby object. multi_json supports
+    # multiple JSON parsers, and selects the 'best' in the following order:
+    # oj, yajl, json, json_pure, okjson. For C extensions, oj is recommended.
+    # For pure Ruby, use json_pure. This method calls {Related#extract}.
+    #
+    # @param result [String] The response body.
+    def pjson(result)
+      resulta = MultiJson.load(result)
+      resulta = resulta['response']
+      re = Lyracyst::Relate.new
+      re.extract(resulta)
+    end
+    # Parses a XML response into a Ruby object. multi_xml supports
+    # multiple XML parsers, and selects the 'best' in the following order:
+    # ox, libxml, nokogiri, rexml. For C extensions, ox is recommended. For
+    # pure Ruby, use REXML. This method calls {Related#extract}.
+    #
+    # @param result [String] The response body.
+    def pxml(result)
+      resulta = MultiXml.parse(result)
+      resulta = resulta['response']
+      re = Lyracyst::Relate.new
+      re.extract(resulta)
+    end
+    # Extracts related words from the response and prints them.
+    #
+    # @param resulta [Array] An array of values from the response.
+    def extract(resulta)
+      x = 0
+      y = resulta.length - 1
+      while x <= y
+        item=resulta[x]
+        item=item['list']
+        puts "Related words: #{item['category'].gsub(/\(|\)/, '')} - #{item['synonyms']}"
+        x += 1
+      end
+    end
+    # Submits search term and parameters to Altervista.
+    # This method calls {Related#http}, {Related#pjson},
+    # {Related#pxml} and {Related#update}.
+    #
+    # @param url [String] The assembled search URL.
+    # @param dateint [Fixnum] Today's date.
+    # @param result [String] The JSON response.
+    # @param querycount [Fixnum] Number of queries today.
+    def submit(url, dateint, result, querycount)
+      #if ENVIRONMENT == 'javascript'
+        #url = "#{url}&callback=synonymSearch"
+      #end
+      re = Lyracyst::Relate.new
+      rtype = ''
+      result = re.http(url, result, rtype)
+      rtype = result[1]
+      result = result[0]
+      if rtype == 'json'
+        re.pjson(result)
+      elsif rtype == 'xml'
+        re.pxml(result)
+      else
+        puts "Invalid data format."
+      end
+      querycount += 1
+      #re.update(dateint, querycount)
+    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
+  end
+end

data/lib/lyracyst/rhyme.rb

@@ -0,0 +1,48 @@
+# coding: utf-8
+require 'httpi'
+require 'multi_json'
+module Lyracyst
+  # The Rhyme class uses the ARPABET Heroku app to fetch rhymes.
+  class Rhyme
+    # 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 {Rhyme#http}.
+    #
+    # @param search [String] The word or phrase to search for.
+    def rhyme(search, result)
+      url = "http://arpabet.heroku.com/words/#{search}"
+      rh = Lyracyst::Rhyme.new
+      rtype = ''
+      result = rh.http(url, result)
+      resulta = MultiJson.load(result)
+      print "Rhymes with: "
+      resulta.map { |x|
+        print " #{x}"
+      }
+      print "\n"
+    end
+    # Opens URL and returns response. HTTPI supports multiple HTTP
+    # clients, and selects the 'best' in the following order:
+    # httpclient, curb, em_http, excon, net_http, net_http_persistent.
+    # For C extensions, curb is recommended. For pure Ruby, use excon.
+    # You can specify a client to use like this:
+    # request = HTTPI::Request.new(url)
+    # HTTPI.get(request, :curb)
+    #
+    # @param url [String] The query URL
+    # @param result [Array] The response
+    def http(url, result)
+      request = HTTPI::Request.new(url)
+      HTTPI.log = false
+      request = HTTPI.get(request)
+      if request.code == 200
+        result = request.body
+      else
+        puts "HTTP Status #{request.code}"
+        puts "HTTP Body #{request.body}"
+      end
+      return result
+    end
+  end
+end

data/lib/lyracyst/version.rb

@@ -1,4 +1,5 @@
+# coding: utf-8
 module Lyracyst
   # Semantic program version
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: lyracyst
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Drew Prentice
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-26 00:00:00.000000000 Z
+date: 2014-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: commander
+  name: httpi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: configatron
+  name: methadone
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -53,33 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
-  name: open-uri-cached
+  name: multi_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !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'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: wordnik
   requirement: !ruby/object:Gem::Requirement
@@ -136,25 +122,87 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: spinach
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Search Wordnik, thesaurus.altervista.org, and Arpabet from the command
   line.
-email:
-- weirdpercent@gmail.com
+email: weirdpercent@gmail.com
 executables:
 - lyracyst
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.md
 - bin/lyracyst
 - lib/lyracyst.rb
-- lib/lyracyst/fetch.rb
-- lib/lyracyst/search.rb
+- lib/lyracyst/define.rb
+- lib/lyracyst/get.rb
+- lib/lyracyst/relate.rb
+- lib/lyracyst/rhyme.rb
 - lib/lyracyst/version.rb
 homepage: http://github.com/weirdpercent/lyracyst
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |-
+  Thanks for using lyracyst!
+  Please get necessary API keys as shown in:
+  http://github.com/weirdpercent/lyracyst
 rdoc_options: []
 require_paths:
 - lib
@@ -167,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2

data/lib/lyracyst/fetch.rb

@@ -1,83 +0,0 @@
-# -*- 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

@@ -1,92 +0,0 @@
-# -*- 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