gingerice 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5aa2568c764a2f1d844124cfc9983d22ba4e06aa
-  data.tar.gz: 4ebbb86b37f1e2f43fba0d1aa02741fe76c0c0a3
+  metadata.gz: dde01477e6f0cfef54d8495b7593f5abb5b56e57
+  data.tar.gz: 5777944483946d2208c517e0c213adad14981f32
 SHA512:
-  metadata.gz: fc8610f79b813b40fed1bec8127e1d807f380e257fe46299cdf265b8b163257aa16ad8096461df4e587e3bf407b37c8d5ebffcb17239e7b5cdb6a3c9a869c896
-  data.tar.gz: 7ecb04214a5f721e583aae3dc6d830acbcdc790096166e74f094799312f7f68379a45d634a7ac860e5d54268ee3b3a8f4ee68822c5d5b650efb7670398e8604f
+  metadata.gz: 6e636c071cddbbdf6b1022aeb1262d7bea389af150f0d182b4639d3ad400b404100a657cffc78aa87d11e7b8ef2f09dc4069264316cd40ca35ff58695bb97218
+  data.tar.gz: 9e8c3053ca3cab867e50a763d3ab09422dd122a1a88a2101da2f16e254cc79839189c6ed87d4918e3b2f01bbbc4175803c5b1b9b16f1b57a089f67fbd388f357

data/README.markdown

@@ -1,4 +1,4 @@
-# Gingerice [![Gem Version](https://badge.fury.io/rb/gingerice.png)](http://badge.fury.io/rb/gingerice) [![Build Status](https://travis-ci.org/subosito/gingerice.png)](https://travis-ci.org/subosito/gingerice) [![Coverage Status](https://coveralls.io/repos/subosito/gingerice/badge.png)](https://coveralls.io/r/subosito/gingerice)
+# Gingerice [![Gem Version](https://badge.fury.io/rb/gingerice.png)](http://badge.fury.io/rb/gingerice) [![Build Status](https://travis-ci.org/subosito/gingerice.png)](https://travis-ci.org/subosito/gingerice) [![Coverage Status](https://coveralls.io/repos/subosito/gingerice/badge.png)](https://coveralls.io/r/subosito/gingerice) [![Dependency Status](https://gemnasium.com/subosito/gingerice.png)](https://gemnasium.com/subosito/gingerice) [![Code Climate](https://codeclimate.com/github/subosito/gingerice.png)](https://codeclimate.com/github/subosito/gingerice)
 
 Ruby wrapper of Ginger Proofreader which corrects spelling and grammar mistakes based on the context of complete sentences by comparing each sentence to billions of similar sentences from the web.
 
@@ -20,34 +20,30 @@ Or install it yourself as:
 
     require 'gingerice'
 
-    text   = 'The smelt of fliwers bring back memories.'
+    text = 'The smelt of fliwers bring back memories.'
 
     parser = Gingerice::Parser.new
     parser.parse text
 
-    # or you can:
-    #
-    # Gingerice::Tool.check text
-
     # output:
     #
     # => {
-    #     "text" => "The smelt of fliwers bring back memories.",
-    #     "result" => "The smell of flowers brings back memories.",
+    #            "text" => "The smelt of fliwers bring back memories.",
+    #          "result" => "The smell of flowers brings back memories.",
     #     "corrections" => [
     #         [0] {
-    #                 "text" => "smelt",
-    #             "correct" => "smell",
+    #                   "text" => "smelt",
+    #                "correct" => "smell",
     #             "definition" => nil
     #         },
     #         [1] {
-    #                 "text" => "fliwers",
-    #             "correct" => "flowers",
+    #                   "text" => "fliwers",
+    #                "correct" => "flowers",
     #             "definition" => "a plant cultivated for its blooms or blossoms"
     #         },
     #         [2] {
-    #                 "text" => "bring",
-    #             "correct" => "brings",
+    #                   "text" => "bring",
+    #                "correct" => "brings",
     #             "definition" => nil
     #         }
     #     ]
@@ -55,12 +51,35 @@ Or install it yourself as:
 
 This gem also provides executable which can be executed:
 
-    % gingerice "Edwards will be sick yesterday"
+    % gingerice "Edwards will be sck yesterday"
 
     # output :
     #
     # Edwards was sick yesterday
 
+Or if you want verbose output you can add `--verbose` or `-v` argument:
+
+    % gingerice --verbose "Edwards will be sck yesterday"
+
+    # output:
+    #
+    # {
+    #            "text" => "Edwards will be sck yesterday",
+    #          "result" => "Edwards was sick yesterday",
+    #     "corrections" => [
+    #         [0] {
+    #                   "text" => "will be",
+    #                "correct" => "was",
+    #             "definition" => nil
+    #         },
+    #         [1] {
+    #                   "text" => "sck",
+    #                "correct" => "sick",
+    #             "definition" => "affected by an impairment of normal physical or mental function"
+    #         }
+    #     ]
+    # }
+
 ## Contributing
 
 1. Fork it
@@ -72,3 +91,4 @@ This gem also provides executable which can be executed:
 ## Thanks
 
 Thank you for [Ginger Proofreader](http://www.gingersoftware.com/) for such awesome service. Hope they will keep it free :)
+

data/bin/gingerice

@@ -2,8 +2,8 @@
 
 $:.unshift(File::join(File::dirname(File::dirname(__FILE__)), "lib"))
 
-require 'gingerice/parser'
-require 'gingerice/tool'
+require 'gingerice/command'
 
-STDOUT.puts(Gingerice::Tool.check(ARGV.shift)['result'])
+command = Gingerice::Command.new(ARGV)
+command.execute
 

data/gingerice.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "coveralls"
 
   spec.add_dependency "addressable"
+  spec.add_dependency "awesome_print"
 end

data/lib/gingerice.rb

@@ -1,2 +1,3 @@
 require 'gingerice/version'
 require 'gingerice/parser'
+require 'gingerice/command'

data/lib/gingerice/command.rb

@@ -0,0 +1,81 @@
+require 'optparse'
+require 'awesome_print'
+require 'gingerice/parser'
+require 'gingerice/version'
+
+module Gingerice
+  class Command
+
+    attr_reader :args, :oparser
+
+    def initialize(args)
+      @args = args
+    end
+
+    def processor
+      options = {}
+      options[:api_endpoint] = Gingerice::Parser::GINGER_ENDPOINT
+      options[:api_version] = Gingerice::Parser::GINGER_VERSION
+      options[:api_key] = Gingerice::Parser::GINGER_API_KEY
+      options[:lang] = Gingerice::Parser::DEFAULT_LANG
+      options[:verbose] = false
+
+      @oparser = OptionParser.new do |opt|
+        opt.banner = 'Usage: gingerice [options] "some texts"'
+
+        opt.on("--api-endpoint API_ENDPOINT", "Set API endpoint") do |endpoint|
+          options[:api_endpoint] = endpoint
+        end
+
+        opt.on("--api-version API_VERSION", "Set API version") do |version|
+          options[:api_endpoint] = version
+        end
+
+        opt.on("--api-key API_KEY", "Set API key") do |api_key|
+          options[:api_key] = api_key
+        end
+
+        opt.on("--lang LANG", "Set language, currently support 'US' only") do |lang|
+          options[:lang] = lang
+        end
+
+        opt.on("-v", "--verbose", "Verbose output") do
+          options[:verbose] = true
+        end
+
+        opt.on("--version", "Show version") do
+          puts Gingerice::VERSION
+          exit
+        end
+
+        opt.on_tail("-h", "--help", "Show this message") do
+          puts opt
+          exit
+        end
+      end
+
+      @oparser.parse!(args)
+      options
+    end
+
+    def execute
+      options = processor
+
+      if args.empty?
+        puts oparser
+      else
+        parser_options = options.reject { |key, value| key == :verbose }
+
+        parser   = Parser.new(parser_options)
+        response = parser.parse(args.last)
+
+        if options[:verbose]
+          ap response
+        else
+          puts response["result"]
+        end
+      end
+    end
+  end
+end
+

data/lib/gingerice/parser.rb

@@ -24,43 +24,45 @@ module Gingerice
 
       begin
         open(uri) do |stream|
-          content = stream.read
-          data    = JSON.parse(content)
-
-          i = 0
-          result = ''
-          corrections = []
+          response_processor(text, stream.read)
+        end
+      rescue Exception => e
+        raise StandardError, e.message
+      end
+    end
 
-          data.fetch('LightGingerTheTextResult', []).each do |r|
-            from = r['From']
-            to   = r['To']
+    protected
+    def response_processor(text, content)
+      data = JSON.parse(content)
+      i = 0
+      result = ''
+      corrections = []
 
-            if i <= from
-              result += text[i..from-1] unless from.zero?
-              result += r['Suggestions'][0]['Text']
+      data.fetch('LightGingerTheTextResult', []).each do |r|
+        from = r['From']
+        to   = r['To']
 
-              corrections << {
-                'text'       => text[from..to],
-                'correct'    => r['Suggestions'][0]['Text'],
-                'definition' => r['Suggestions'][0]['Definition']
-              }
-            end
+        if i <= from
+          result += text[i..from-1] unless from.zero?
+          result += r['Suggestions'][0]['Text']
 
-            i = to+1
-          end
+          corrections << {
+            'text'       => text[from..to],
+            'correct'    => r['Suggestions'][0]['Text'],
+            'definition' => r['Suggestions'][0]['Definition']
+          }
+        end
 
-          if i < text.length
-            result += text[i..-1]
-          end
+        i = to+1
+      end
 
-          { 'text' => text, 'result' => result, 'corrections' => corrections}
-        end
-      rescue Exception => e
-        raise StandardError, e.message
+      if i < text.length
+        result += text[i..-1]
       end
+
+      { 'text' => text, 'result' => result, 'corrections' => corrections}
     end
 
-    protected
     def request_params
       {
         'lang' => lang,

data/lib/gingerice/version.rb

@@ -1,3 +1,3 @@
 module Gingerice
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/test_gingerice.rb

@@ -1,38 +1,76 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'stringio'
+module Kernel
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    return out
+  ensure
+    $stdout = STDOUT
+  end
+end
+
 require 'test/unit'
-require 'gingerice'
+require 'gingerice/parser'
+require 'gingerice/command'
 
 class TestGingerice < Test::Unit::TestCase
   def setup
     @parser = Gingerice::Parser.new
-  end
 
-  def test_default_settings
-    assert_equal @parser.api_endpoint, Gingerice::Parser::GINGER_ENDPOINT
-    assert_equal @parser.api_version, Gingerice::Parser::GINGER_VERSION
-    assert_equal @parser.api_key, Gingerice::Parser::GINGER_API_KEY
-    assert_equal @parser.lang, Gingerice::Parser::DEFAULT_LANG
-  end
-
-  def test_override_settings
-    custom_parser = Gingerice::Parser.new({
+    @custom_parser = Gingerice::Parser.new({
       lang: 'ID',
-      api_endpoint: 'http://example.com/',
+      api_endpoint: 'http://example.id/',
       api_version: '1.0',
       api_key: '123456'
     })
+  end
 
-    assert_equal custom_parser.lang, 'ID'
-    assert_equal custom_parser.api_endpoint, 'http://example.com/'
-    assert_equal custom_parser.api_version, '1.0'
-    assert_equal custom_parser.api_key, '123456'
+  def test_default_settings
+    assert_equal Gingerice::Parser::GINGER_ENDPOINT, @parser.api_endpoint
+    assert_equal Gingerice::Parser::GINGER_VERSION, @parser.api_version
+    assert_equal Gingerice::Parser::GINGER_API_KEY, @parser.api_key
+    assert_equal Gingerice::Parser::DEFAULT_LANG, @parser.lang
+  end
+
+  def test_override_settings
+    assert_equal 'ID', @custom_parser.lang
+    assert_equal 'http://example.id/', @custom_parser.api_endpoint
+    assert_equal '1.0', @custom_parser.api_version
+    assert_equal '123456', @custom_parser.api_key
   end
 
   def test_parsed_results
     text   = 'The smelt of fliwers bring back memories.'
     result = @parser.parse(text)
 
-    assert_equal result['text'], text
-    assert_equal result['result'], 'The smell of flowers brings back memories.'
-    assert_equal result['corrections'].count, 3
+    assert_equal text, result['text']
+    assert_equal 'The smell of flowers brings back memories.', result['result']
+    assert_equal 3, result['corrections'].count
+  end
+
+  def test_exceptions
+    exception = assert_raise(StandardError) { @custom_parser.parse('Hllo') }
+    assert_equal 'getaddrinfo: Name or service not known', exception.message
+  end
+
+  def test_command_usage
+    output = capture_stdout do
+      command = Gingerice::Command.new(["Edwards will be sck yesterday"])
+      command.execute
+    end
+    assert_equal "Edwards was sick yesterday\n", output.string
+  end
+
+  def test_command_help
+    output = capture_stdout do
+      command = Gingerice::Command.new([])
+      command.execute
+    end
+    assert_match "Usage:", output.string
   end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gingerice
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alif Rachmawadi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Corrects spelling and grammar mistakes based on the context of complete
   sentences.
 email:
@@ -70,8 +98,8 @@ files:
 - bin/gingerice
 - gingerice.gemspec
 - lib/gingerice.rb
+- lib/gingerice/command.rb
 - lib/gingerice/parser.rb
-- lib/gingerice/tool.rb
 - lib/gingerice/version.rb
 - test/test_gingerice.rb
 homepage: https://github.com/subosito/gingerice

data/lib/gingerice/tool.rb

@@ -1,11 +0,0 @@
-module Gingerice
-  class Tool
-    class << self
-      def check(text, lang = 'US')
-        parser = Parser.new(lang: lang)
-        parser.parse(text)
-      end
-    end
-  end
-end
-