lyracyst 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58a980e0fde9e3c2924a28c3a7e72968564aa7be
+  data.tar.gz: 600427e32f40f28b791473e20d391e76c8368e75
+SHA512:
+  metadata.gz: 00f2d7c0a6753333c51600dd6b4614bc80652e6bdd0df08bce169965468d3c1abe0210922424dd609163a0a70a784e3d2ae261dbd009303b957a73fc34aa0e76
+  data.tar.gz: ff477c269a4f9bcd9aad42aa2c27b0dd2c40596f8f7227873e879007faadf37e3af4010766584938b02e8bc313a7d8de2857de878cdb768aae4ca8b3b4e4f1fc

data/bin/lyracyst

@@ -0,0 +1,186 @@
+#!/usr/bin/env ruby
+
+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' #transparent caching
+environment='ruby'
+result=''
+program :name, 'lyracyst'
+program :version, '0.0.1'
+program :description, 'A powerful word search tool that fetches definitions, related words, and rhymes.'
+#search='test' # (urlencoded string)
+#print "Enter a word: " #change commenting here to convert between command line and test modes
+class Fetch
+  def search(url, result)
+    result=open(url).read #submit search query
+  end
+  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
+  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
+    end
+  end
+  def submit(search, dateint, result, environment, querycount)
+    urlprefix='http://thesaurus.altervista.org/thesaurus/v1'
+    #apikey=File.readlines('keys/thesaurus.key') #search API key, get one at http://thesaurus.altervista.org/mykey
+    #apikey=apikey[0].chomp
+    apikey=ENV['THESAURUS'] #access thru ENV vars for safe Travis builds
+    searchlang='en_US' # it_IT, fr_FR, de_DE, en_US, el_GR, es_ES, de_DE, no_NO, pt_PT, ro_RO, ru_RU, sk_SK
+    dataoutput='json' # xml or json (default xml)
+    url="#{urlprefix}?key=#{apikey}&word=#{search}&language=#{searchlang}&output=#{dataoutput}"
+    if environment == 'javascript' # (requires output=json)
+      url="#{url}&callback=synonymSearch"
+    end
+    f=Fetch.new()
+    resultj=f.search(url, result) #submit search query
+    resultp=MultiJson.load(resultj)
+    resulta=resultp['response']
+    x=0
+    y=resulta.length-1
+    f.rel(x, y, resulta)
+    querycount+=1 #increment daily queries
+    f.update(dateint, querycount)
+  end
+  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
+    end
+  end
+end
+class Search
+  def related(search, result) # Each thesaurus.altervista.org application can perform upto 5000 queries per day.
+    environment='ruby'; maxqueries=5000; querycount=0; t=Time.now; y=t.year.to_s; m=t.month; d=t.day; #declarations
+    if m < 10 then m="0#{m}" else  m=m.to_s; end #2-digits #FIXME < not valid?
+    if d < 10 then d="0#{d}" else d=d.to_s; end
+    date="#{y}#{m}#{d}"
+    dateint=date.to_i
+    #pd=Date.parse(date)
+    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 #track date changes
+        f=Fetch.new()
+        f.update(dateint, querycount)
+      end
+    else
+      testcount=0
+    end
+    if testcount < maxqueries #make sure we don't abuse the service
+      f=Fetch.new()
+      f.submit(search, dateint, result, environment, querycount)
+    else
+      puts "Max queries per day has been reached."
+    end
+  end
+  def define(search)
+    #apikey=File.readlines('keys/wordnik.key') #search API key, get one at http://developer.wordnik.com/
+    #apikey=apikey[0].chomp
+    apikey=ENV['WORDNIK'] #access thru ENV vars for safe Travis builds
+    Wordnik.configure do |cfg|
+      cfg.api_key=apikey
+      cfg.response_format='json'
+      cfg.logger = Logger.new('/dev/null') #defaults to Rails.logger or Logger.new(STDOUT). Set to Logger.new('/dev/null') to disable logging.
+    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
+  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
+
+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.option '--some-switch', 'Some switch that does something' # it_IT, fr_FR, de_DE, en_US, el_GR, es_ES, de_DE, no_NO, pt_PT, ro_RO, ru_RU, sk_SK
+  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/changelog.md

@@ -0,0 +1,12 @@
+Changelog
+===
+
+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/lib/lyracyst.rb

@@ -0,0 +1,186 @@
+#!/usr/bin/env ruby
+
+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' #transparent caching
+environment='ruby'
+result=''
+program :name, 'lyracyst'
+program :version, '0.0.1'
+program :description, 'A powerful word search tool that fetches definitions, related words, and rhymes.'
+#search='test' # (urlencoded string)
+#print "Enter a word: " #change commenting here to convert between command line and test modes
+class Fetch
+  def search(url, result)
+    result=open(url).read #submit search query
+  end
+  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
+  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
+    end
+  end
+  def submit(search, dateint, result, environment, querycount)
+    urlprefix='http://thesaurus.altervista.org/thesaurus/v1'
+    #apikey=File.readlines('keys/thesaurus.key') #search API key, get one at http://thesaurus.altervista.org/mykey
+    #apikey=apikey[0].chomp
+    apikey=ENV['THESAURUS'] #access thru ENV vars for safe Travis builds
+    searchlang='en_US' # it_IT, fr_FR, de_DE, en_US, el_GR, es_ES, de_DE, no_NO, pt_PT, ro_RO, ru_RU, sk_SK
+    dataoutput='json' # xml or json (default xml)
+    url="#{urlprefix}?key=#{apikey}&word=#{search}&language=#{searchlang}&output=#{dataoutput}"
+    if environment == 'javascript' # (requires output=json)
+      url="#{url}&callback=synonymSearch"
+    end
+    f=Fetch.new()
+    resultj=f.search(url, result) #submit search query
+    resultp=MultiJson.load(resultj)
+    resulta=resultp['response']
+    x=0
+    y=resulta.length-1
+    f.rel(x, y, resulta)
+    querycount+=1 #increment daily queries
+    f.update(dateint, querycount)
+  end
+  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
+    end
+  end
+end
+class Search
+  def related(search, result) # Each thesaurus.altervista.org application can perform upto 5000 queries per day.
+    environment='ruby'; maxqueries=5000; querycount=0; t=Time.now; y=t.year.to_s; m=t.month; d=t.day; #declarations
+    if m < 10 then m="0#{m}" else  m=m.to_s; end #2-digits #FIXME < not valid?
+    if d < 10 then d="0#{d}" else d=d.to_s; end
+    date="#{y}#{m}#{d}"
+    dateint=date.to_i
+    #pd=Date.parse(date)
+    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 #track date changes
+        f=Fetch.new()
+        f.update(dateint, querycount)
+      end
+    else
+      testcount=0
+    end
+    if testcount < maxqueries #make sure we don't abuse the service
+      f=Fetch.new()
+      f.submit(search, dateint, result, environment, querycount)
+    else
+      puts "Max queries per day has been reached."
+    end
+  end
+  def define(search)
+    #apikey=File.readlines('keys/wordnik.key') #search API key, get one at http://developer.wordnik.com/
+    #apikey=apikey[0].chomp
+    apikey=ENV['WORDNIK'] #access thru ENV vars for safe Travis builds
+    Wordnik.configure do |cfg|
+      cfg.api_key=apikey
+      cfg.response_format='json'
+      cfg.logger = Logger.new('/dev/null') #defaults to Rails.logger or Logger.new(STDOUT). Set to Logger.new('/dev/null') to disable logging.
+    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
+  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
+
+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.option '--some-switch', 'Some switch that does something' # it_IT, fr_FR, de_DE, en_US, el_GR, es_ES, de_DE, no_NO, pt_PT, ro_RO, ru_RU, sk_SK
+  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/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/readme.md

@@ -0,0 +1,87 @@
+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)[![Dependency Status](https://gemnasium.com/weirdpercent/lyracyst.png)](https://gemnasium.com/weirdpercent/lyracyst)[![Code Climate](https://codeclimate.com/github/weirdpercent/lyracyst.png)](https://codeclimate.com/github/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.
+
+### Features
+
+- Open URI fetching w/ transparent caching
+- Definitions from Wordnik
+- Rhymes from arpabet.heroku.com
+- Related words from thesaurus.altervista.org
+- XML & JSON parsing
+- Export wordlists matching search criteria
+
+### Usage
+
+    bundle install
+    rake
+
+### Code Example
+
+    s=Search.new
+    s.nik(search) # Wordnik definitions
+    s.syn(search) # Altervista synonyms
+    s.rhy(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
+
+### 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

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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: lyracyst
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Drew Prentice
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: open-uri-cached
+  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: wordnik
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.12'
+description: Search Wordnik, thesaurus.altervista.org, and Arpabet from the command
+  line.
+email:
+- weirdpercent@gmail.com
+executables:
+- lyracyst
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/lyracyst
+- changelog.md
+- lib/lyracyst.rb
+- license.md
+- readme.md
+- scaffold.md
+homepage: http://github.com/weirdpercent/lyracyst
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A powerful word search tool that fetches definitions, related words, and
+  rhymes.
+test_files: []
+has_rdoc: