dinosaurus 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dinosaurus.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Tuite
+
+MIT License
+
+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,31 @@
+# Dinosaurus
+
+Ruby wrapper for the [Big Huge Labs Thesaurus](http://words.bighugelabs.com/) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dinosaurus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dinosaurus
+
+## Usage
+
+require "dnosaurus"
+
+results = Dinosaurus.lookup('word')
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/dinosaurus.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dinosaurus/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Tuite"]
+  gem.email         = ["dtuite@gmail.com"]
+  gem.description   = %q{Ruby wrapper for the Big Huge Thesaurus APIs.}
+  gem.summary       = %q{Lookup synonyms, antonyms etc. using the Big Huge Thesaurus API.}
+  gem.homepage      = "http://words.bighugelabs.com"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "dinosaurus"
+  gem.require_paths = ["lib"]
+  gem.version       = Dinosaurus::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "vcr"
+
+  gem.add_dependency "httparty"
+end

data/lib/dinosaurus.rb

@@ -0,0 +1,10 @@
+require "dinosaurus/logging"
+require "dinosaurus/configuration"
+require "dinosaurus/thesaurus"
+require "dinosaurus/version"
+
+module Dinosaurus
+  def self.lookup(word)
+    Dinosaurus::Thesaurus.lookup(word)
+  end
+end

data/lib/dinosaurus/configuration.rb

@@ -0,0 +1,28 @@
+# Enable setting and getting of configuration options.
+#
+# Example:
+#
+#   This can now be used under config/initializers/dinosaurus.rb
+#   Dinosaurus.configure do |config|
+#     config.api_key = 'dfskljkf'
+#   end
+
+module Dinosaurus
+  class Configuration
+    DEFAULT_LOG_LEVEL = 'info'
+
+    attr_accessor :api_key, :log_level
+
+    def initialize
+      self.log_level = DEFAULT_LOG_LEVEL
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/dinosaurus/logging.rb

@@ -0,0 +1,26 @@
+require "logger"
+
+module Logging
+  def logger
+    Logging.logger
+  end
+
+  def self.logger
+    unless @logger
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logging.infer_level
+    end
+    @logger
+  end
+
+  # infer a suitable Log level from the ENVIRONMENT variable
+  # Can pass in an environment value for testing purposes
+  def self.infer_level(level = nil)
+    level = level || Dinosaurus.configuration.log_level
+    case level
+    when 'debug' then Logger::DEBUG
+    when 'warn' then Logger::WARN
+    else Logger::INFO # default
+    end
+  end
+end

data/lib/dinosaurus/railties.rb

@@ -0,0 +1,7 @@
+module Dinosaurus
+  class Railties < ::Rails::Railtie
+    initializer 'Rails logger' do
+      Dinosaurus::Logging.logger = Rails.logger
+    end
+  end
+end

data/lib/dinosaurus/thesaurus.rb

@@ -0,0 +1,29 @@
+require "httparty"
+require "json"
+
+module Dinosaurus
+  class Thesaurus
+    include HTTParty
+    base_uri "words.bighugelabs.com"
+    format :json
+
+
+    def self.lookup(word)
+      res = get(url_for(word))
+
+      if res.code == 200
+        { text: word, results: JSON.parse(res.body) }
+      else
+        warning = "DINOSAURUS_WARNING: #{res.code}. WORD: #{word}."
+        Logging.logger.warn(warning)
+        { text: word }
+      end
+    end
+
+  private
+
+    def self.url_for(word)
+      "/api/2/" + Dinosaurus.configuration.api_key + '/' + word + '/json'
+    end
+  end
+end

data/lib/dinosaurus/version.rb

@@ -0,0 +1,3 @@
+module Dinosaurus
+  VERSION = "0.0.1"
+end

data/spec/dinosaurus/thesaurus_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe Dinosaurus::Thesaurus do
+  subject { Dinosaurus::Thesaurus }
+
+  it "should return results" do
+    VCR.use_cassette('word') do
+      results = subject.lookup('word')[:results]
+      results["noun"]["syn"].should include("news")
+    end
+  end
+
+  it "should return the lookup word" do
+    VCR.use_cassette('word') do
+      subject.lookup('word')[:text].should == 'word'
+    end
+  end
+
+  it "should log errors" do
+    subject.stub(:get) { stub(code: 500) }
+    Logging.logger.should_receive(:warn)
+
+    VCR.use_cassette('word') do
+      subject.lookup('word')
+    end
+  end
+end

data/spec/fixtures/vcr_cassettes/word.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://words.bighugelabs.com/api/2/<API_KEY>/word/json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.1.19
+      Date:
+      - Sun, 22 Jul 2012 17:29:10 GMT
+      Content-Type:
+      - text/javascript
+      Content-Length:
+      - '736'
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.3.10-1ubuntu3.2
+      Set-Cookie:
+      - PHPSESSID=k1cu7dsr9cdlrd6utgpr5efel2; path=/; domain=words.bighugelabs.com
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+    body:
+      encoding: US-ASCII
+      string: ! '{"noun":{"syn":["news","intelligence","tidings","discussion","give-and-take","parole","word
+        of honor","Son","Word","Logos","password","watchword","countersign","Bible","Christian
+        Bible","Book","Good Book","Holy Scripture","Holy Writ","Scripture","Word of
+        God","arcanum","computer memory unit","hypostasis","hypostasis of Christ","info","information","language","language
+        unit","linguistic unit","oral communication","order","positive identification","promise","religious
+        text","religious writing","sacred text","sacred writing","secret","speech","speech
+        communication","spoken communication","spoken language","statement","voice
+        communication"]},"verb":{"syn":["give voice","formulate","phrase","articulate","evince","express","show"]}}'
+    http_version: 
+  recorded_at: Sun, 22 Jul 2012 17:29:10 GMT
+recorded_with: VCR 2.2.0

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# Require application.
+require "dinosaurus"
+
+# Require testing dependencies.
+require "vcr"
+
+# An API Key must b supplied in order to regenerate VCR casettes. 
+# THis is a testing account API key.
+API_KEY = 'c5aedd41d31e32f3597100dd5b0d0163'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock # or :fakeweb
+  c.ignore_hosts '127.0.0.1', 'localhost'
+
+  if API_KEY 
+    c.filter_sensitive_data('<API_KEY>') { API_KEY }
+  end
+end
+
+Dinosaurus.configure do |c|
+  c.api_key = API_KEY
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: dinosaurus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Tuite
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70239728703440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70239728703440
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70239728702020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70239728702020
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70239728699900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70239728699900
+description: Ruby wrapper for the Big Huge Thesaurus APIs.
+email:
+- dtuite@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dinosaurus.gemspec
+- lib/dinosaurus.rb
+- lib/dinosaurus/configuration.rb
+- lib/dinosaurus/logging.rb
+- lib/dinosaurus/railties.rb
+- lib/dinosaurus/thesaurus.rb
+- lib/dinosaurus/version.rb
+- spec/dinosaurus/thesaurus_spec.rb
+- spec/fixtures/vcr_cassettes/word.yml
+- spec/spec_helper.rb
+homepage: http://words.bighugelabs.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Lookup synonyms, antonyms etc. using the Big Huge Thesaurus API.
+test_files:
+- spec/dinosaurus/thesaurus_spec.rb
+- spec/fixtures/vcr_cassettes/word.yml
+- spec/spec_helper.rb