urban_cli 1.1.0

data/test/fixtures/screens/definition.txt

@@ -0,0 +1,5 @@
+
+IMPROMPTU
+
+Something that is made up on the spot and given little time to gather and present. Usually referring to speeches that are given only a few minutes to prepare for.
+

data/test/fixtures/screens/definition_with_url.txt

@@ -0,0 +1,7 @@
+
+IMPROMPTU
+
+Something that is made up on the spot and given little time to gather and present. Usually referring to speeches that are given only a few minutes to prepare for.
+
+URL: http://www.urbandictionary.com/define.php?term=impromptu
+

data/test/fixtures/screens/definitions.txt

@@ -0,0 +1,9 @@
+
+IMPROMPTU
+
+Something that is made up on the spot and given little time to gather and present. Usually referring to speeches that are given only a few minutes to prepare for.
+
+On the spot
+
+Something that is made up on the spot.  Can also mean a speech that was made with little or no preparation.
+

data/test/fixtures/screens/help.txt

@@ -0,0 +1,19 @@
+Usage: urban [OPTION]... [PHRASE]
+Search http://urbandictionary.com for definitions of phrases
+
+Options:
+    -a, --all                   List all definitions
+    -r, --random                Return a random phrase and definition
+    -u, --url                   Print the definition's url after the definition
+    -h, --help                  Show this message
+    -v, --version               Show version information
+
+Examples:
+    urban cookie monster        Search for "cookie monster" and print its
+                                first definition
+    urban -a cookie monster     Search for "cookie monster" and print all of
+                                its available definitions
+    urban -r                    Print a random phrase and its first definition
+    urban -ra                   Print a random phrase and all of its available
+                                definitions
+

data/test/fixtures/screens/invalid_option_error.txt

@@ -0,0 +1,2 @@
+urban: invalid option: -b
+Try `urban --help' for more information.

data/test/fixtures/screens/missing_phrase_error.txt

@@ -0,0 +1 @@
+urban: no definitions found for SHFJKASDF.

data/test/fixtures/screens/no_internet_error.txt

@@ -0,0 +1 @@
+urban: no internet connection available.

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require "rubygems"
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/hell"
+require "urban"
+require "ostruct"
+
+class Urban::Test < Minitest::Test
+
+  def load_fixture(filename)
+    IO.read(File.expand_path("../fixtures/#{filename}", __FILE__))
+  end
+
+  def empty_entry
+    @empty_entry ||= Urban::Dictionary::Entry.new('shfjkasdf', nil, nil)
+  end
+
+  def test_entry
+    @test_entry ||= Urban::Dictionary::Entry.new(
+      "impromptu",
+      [
+        "Something that is made up on the spot and given little time to " +
+          "gather and present. Usually referring to speeches that are given " +
+          "only a few minutes to prepare for.",
+        "On the spot",
+        "Something that is made up on the spot.  " +
+          "Can also mean a speech that was made with little or no preparation."
+      ],
+      "http://www.urbandictionary.com/define.php?term=impromptu"
+    )
+  end
+
+end

data/test/urban/cli_test.rb

@@ -0,0 +1,154 @@
+require "test_helper"
+require "shellwords"
+require "urban/cli"
+
+class CLITest < Urban::Test
+
+  attr_accessor :program, :dictionary
+
+  def nothing; "" end
+
+  def assert_program_output(stdout, stderr, args)
+    assert_output stdout, stderr do
+      program.run(Shellwords.shellwords(args))
+    end
+  end
+
+  def setup
+    self.program = Urban::CLI.new
+    self.dictionary = Urban::Dictionary.new
+
+    program.dictionary = dictionary
+  end
+
+  class CLIArgumentParsingTest < CLITest
+
+    def assert_flag_is_set(name)
+      ["-#{name.chars.first}", "--#{name}"].each do |args|
+        options = program.send(:parse, [args])
+        assert options.send(name)
+      end
+    end
+
+    def test_defaults
+      options = program.send(:parse, [])
+      refute options.help
+      refute options.version
+      refute options.random
+      refute options.all
+      assert_empty options.phrase
+    end
+
+    def test_phrase
+      options = program.send :parse, ["foo bar"]
+      assert_equal "foo bar", options.phrase
+    end
+
+    def test_version_flag
+      assert_flag_is_set "version"
+    end
+
+    def test_random_flag
+      assert_flag_is_set "random"
+    end
+
+    def test_all_flag
+      assert_flag_is_set "all"
+    end
+
+    def test_url_flag
+      assert_flag_is_set "url"
+    end
+  end
+
+  class CLIRunnerStandardOutputTest < CLITest
+
+    def setup
+      super
+    end
+
+    def test_help_flag_prints_help
+      help_screen = load_fixture "screens/help.txt"
+      assert_program_output help_screen, nothing, nothing
+    end
+
+    def test_version_flag_prints_version
+      version_screen = "Urban #{Urban::VERSION} (c) Thomas Miller\n"
+      assert_program_output version_screen, nothing, "--version"
+    end
+
+    def test_random_flag_prints_single_definition
+      single_definition = load_fixture "screens/definition.txt"
+
+      dictionary.stub(:random, test_entry) do
+        assert_program_output single_definition, nothing, "--random"
+      end
+    end
+
+    def test_phrase_prints_single_definition
+      single_definition = load_fixture "screens/definition.txt"
+      dictionary.stub(:search, test_entry) do
+        assert_program_output single_definition, nothing, "impromptu"
+      end
+    end
+
+    def test_random_and_all_flag_prints_multiple_definitions
+      multiple_definitions = load_fixture "screens/definitions.txt"
+      dictionary.stub(:random, test_entry) do
+        assert_program_output multiple_definitions, nothing, "--all --random"
+      end
+    end
+
+    def test_phrase_and_all_flag_prints_multiple_definitions
+      multiple_definitions = load_fixture "screens/definitions.txt"
+      dictionary.stub(:search, test_entry) do
+        assert_program_output multiple_definitions, nothing, "--all impromptu"
+      end
+    end
+
+    def test_random_and_url_flag_prints_definition_with_url
+      definition_with_url = load_fixture "screens/definition_with_url.txt"
+      dictionary.stub(:random, test_entry) do
+        assert_program_output definition_with_url, nothing, "--url --random"
+      end
+    end
+
+    def test_phrase_and_url_flag_prints_definition_with_url
+      definition_with_url = load_fixture "screens/definition_with_url.txt"
+      dictionary.stub(:search, test_entry) do
+        assert_program_output definition_with_url, nothing, "--url impromptu"
+      end
+    end
+
+  end
+
+  class CLIRunnerErrorOutputTest < CLITest
+
+    def setup
+      super
+    end
+
+    def test_search_missing_phrase_prints_error
+      missing_phrase_error = load_fixture "screens/missing_phrase_error.txt"
+
+      dictionary.stub :search, empty_entry do
+        assert_program_output nothing, missing_phrase_error, "shfjkasdf"
+      end
+    end
+
+
+    def test_search_with_no_internet_prints_error
+      no_internet_error = load_fixture "screens/no_internet_error.txt"
+      raise_socket_error = Proc.new { raise SocketError }
+
+      dictionary.stub :search, raise_socket_error do
+        assert_program_output nothing, no_internet_error, "shfjkasdf"
+      end
+    end
+
+    def test_invalid_option_prints_help
+      invalid_option_error = load_fixture "screens/invalid_option_error.txt"
+      assert_program_output nothing, invalid_option_error, "-b"
+    end
+  end
+end

data/test/urban/dictionary_test.rb

@@ -0,0 +1,47 @@
+require "test_helper"
+require "urban/dictionary"
+
+class DictionaryTest < Urban::Test
+
+  attr_accessor :web_service, :dictionary, :response
+
+  def setup
+    self.web_service = MiniTest::Mock.new
+    self.dictionary = Urban::Dictionary.new
+
+    dictionary.web_service = web_service
+
+    self.response = OpenStruct.new(
+      :url => "http://www.urbandictionary.com/define.php?term=impromptu",
+      :stream => load_fixture("impromptu.html")
+    )
+  end
+
+  def test_process_extracts_elements_from_html
+    entry = dictionary.send(:process, response )
+    assert_equal(test_entry, entry)
+  end
+
+  def test_dictionary_calls_random
+    web_service.expect(:random, response)
+
+    assert_equal(test_entry, dictionary.random)
+    web_service.verify
+  end
+
+  def test_dictionary_calls_search
+   web_service.expect(:search, response, ['impromptu'])
+
+   assert_equal(test_entry, dictionary.search('impromptu'))
+   web_service.verify
+  end
+
+  def test_dictionary_returns_empty_for_missing_phrases
+    response.stream = load_fixture 'missing.html'
+    web_service.expect(:search, response, ['shfjkasdf'])
+
+    assert_equal(empty_entry, dictionary.search('shfjkasdf'))
+    web_service.verify
+  end
+
+end

data/test/urban/web_test.rb

@@ -0,0 +1,38 @@
+require "test_helper"
+require "urban/web"
+
+class WebTest < Urban::Test
+
+  attr_accessor :web_client
+
+  def setup
+    self.web_client = Urban::Web.new
+  end
+
+  def test_build_query_with_multiple_query_params
+    expected = "?term=bar&name=foo"
+    actual = web_client.send :build_query, { :term => :bar, :name => :foo }
+    assert_equal expected, actual
+  end
+
+  def test_build_uri_with_no_query_params
+    expected = "http://www.urbandictionary.com/test.php"
+    actual = web_client.send :build_uri, :test
+    assert_equal expected, actual
+  end
+
+  def test_build_uri_with_a_query_param
+    expected = "http://www.urbandictionary.com/test.php?term=foo"
+    actual = web_client.send :build_uri, :test, { :term => :foo }
+    assert_equal expected, actual
+  end
+
+  def test_build_response
+    response = OpenStruct.new :base_uri =>
+      "http://www.urbandictionary.com/define.php?term=impromptu"
+    expected = Urban::Web::Response.new response.base_uri, response
+    actual = web_client.send :build_response, response
+    assert_equal expected, actual
+  end
+
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: urban_cli
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Erik Nilsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: |-
+  Urban is a command line utility with an API to query definitions from Urban
+  Dictionary.
+email:
+- enilsen16@live.com
+executables:
+- urban
+extensions: []
+extra_rdoc_files:
+- HISTORY.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- ".gemtest"
+- HISTORY.rdoc
+- LICENSE
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/urban
+- lib/urban.rb
+- lib/urban/cli.rb
+- lib/urban/dictionary.rb
+- lib/urban/web.rb
+- test/fixtures/impromptu.html
+- test/fixtures/missing.html
+- test/fixtures/screens/definition.txt
+- test/fixtures/screens/definition_with_url.txt
+- test/fixtures/screens/definitions.txt
+- test/fixtures/screens/help.txt
+- test/fixtures/screens/invalid_option_error.txt
+- test/fixtures/screens/missing_phrase_error.txt
+- test/fixtures/screens/no_internet_error.txt
+- test/test_helper.rb
+- test/urban/cli_test.rb
+- test/urban/dictionary_test.rb
+- test/urban/web_test.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.rdoc
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Urban is a command line utility with an API to query definitions from Urban
+  Dictionary.
+test_files:
+- test/test_helper.rb
+- test/urban/cli_test.rb
+- test/urban/dictionary_test.rb
+- test/urban/web_test.rb