gingerice 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dde01477e6f0cfef54d8495b7593f5abb5b56e57
-  data.tar.gz: 5777944483946d2208c517e0c213adad14981f32
+  metadata.gz: 6087ed695413b5137a1bbb35d6c1c83a0bad3f3e
+  data.tar.gz: 41acc2f5e49bc2552b7836abd17effdf5629d647
 SHA512:
-  metadata.gz: 6e636c071cddbbdf6b1022aeb1262d7bea389af150f0d182b4639d3ad400b404100a657cffc78aa87d11e7b8ef2f09dc4069264316cd40ca35ff58695bb97218
-  data.tar.gz: 9e8c3053ca3cab867e50a763d3ab09422dd122a1a88a2101da2f16e254cc79839189c6ed87d4918e3b2f01bbbc4175803c5b1b9b16f1b57a089f67fbd388f357
+  metadata.gz: a5a6e945f6fe1150fe33ea6cff165975c199f198e9560918472f7b5c68a3527b72617f372403266ba79dace2115c5c1e18802e656f494029d52efb58610f8583
+  data.tar.gz: 3e16022c40bd5ccdbe91913e1ac3b8f5e95de6883f2868c46ec4da4d3026ce5c89081d0b4aa9204d43a9cd344da14524c7918ea4a04b9a132304142bbff8f141

data/README.markdown

@@ -6,79 +6,98 @@ Ruby wrapper of Ginger Proofreader which corrects spelling and grammar mistakes
 
 Add this line to your application's Gemfile:
 
-    gem 'gingerice'
+```ruby
+gem 'gingerice'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install gingerice
+```bash
+$ gem install gingerice
+```
 
 ## Usage
 
-    require 'gingerice'
-
-    text = 'The smelt of fliwers bring back memories.'
-
-    parser = Gingerice::Parser.new
-    parser.parse text
-
-    # output:
-    #
-    # => {
-    #            "text" => "The smelt of fliwers bring back memories.",
-    #          "result" => "The smell of flowers brings back memories.",
-    #     "corrections" => [
-    #         [0] {
-    #                   "text" => "smelt",
-    #                "correct" => "smell",
-    #             "definition" => nil
-    #         },
-    #         [1] {
-    #                   "text" => "fliwers",
-    #                "correct" => "flowers",
-    #             "definition" => "a plant cultivated for its blooms or blossoms"
-    #         },
-    #         [2] {
-    #                   "text" => "bring",
-    #                "correct" => "brings",
-    #             "definition" => nil
-    #         }
-    #     ]
-    # }
+```ruby
+require 'gingerice'
+
+text = 'The smelt of fliwers bring back memories.'
+
+parser = Gingerice::Parser.new
+parser.parse text
+
+```
+
+```
+# output:
+
+{
+           "text" => "The smelt of fliwers bring back memories.",
+         "result" => "The smell of flowers brings back memories.",
+    "corrections" => [
+        [0] {
+                  "text" => "smelt",
+               "correct" => "smell",
+            "definition" => nil
+        },
+        [1] {
+                  "text" => "fliwers",
+               "correct" => "flowers",
+            "definition" => "a plant cultivated for its blooms or blossoms"
+        },
+        [2] {
+                  "text" => "bring",
+               "correct" => "brings",
+            "definition" => nil
+        }
+    ]
+}
+```
 
 This gem also provides executable which can be executed:
 
-    % gingerice "Edwards will be sck yesterday"
+```bash
+$ gingerice "Edwards will be sck yesterday"
+```
 
-    # output :
-    #
-    # Edwards was sick 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"
-    #         }
-    #     ]
-    # }
+```bash
+$ 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
 
@@ -88,6 +107,10 @@ Or if you want verbose output you can add `--verbose` or `-v` argument:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Ports
+
+- Python library by @Azd325: https://github.com/Azd325/gingerit
+
 ## Thanks
 
 Thank you for [Ginger Proofreader](http://www.gingersoftware.com/) for such awesome service. Hope they will keep it free :)

data/gingerice.gemspec

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

data/lib/gingerice.rb

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

data/lib/gingerice/command.rb

@@ -6,21 +6,18 @@ require 'gingerice/version'
 module Gingerice
   class Command
 
-    attr_reader :args, :oparser
+    attr_reader :args, :args_parser, :options
 
     def initialize(args)
       @args = args
-    end
+      @args << '-h' if @args.empty?
 
-    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
+      @options     = Gingerice::Parser.default_options.merge({ :verbose => false })
+      @args_parser = args_parser
+    end
 
-      @oparser = OptionParser.new do |opt|
+    def args_parser
+      OptionParser.new do |opt|
         opt.banner = 'Usage: gingerice [options] "some texts"'
 
         opt.on("--api-endpoint API_ENDPOINT", "Set API endpoint") do |endpoint|
@@ -28,7 +25,7 @@ module Gingerice
         end
 
         opt.on("--api-version API_VERSION", "Set API version") do |version|
-          options[:api_endpoint] = version
+          options[:api_version] = version
         end
 
         opt.on("--api-key API_KEY", "Set API key") do |api_key|
@@ -44,30 +41,31 @@ module Gingerice
         end
 
         opt.on("--version", "Show version") do
-          puts Gingerice::VERSION
-          exit
+          options[:show] = :version
         end
 
         opt.on_tail("-h", "--help", "Show this message") do
-          puts opt
-          exit
+          options[:show] = :help
         end
-      end
 
-      @oparser.parse!(args)
-      options
+        opt.parse!(args)
+      end
     end
 
     def execute
-      options = processor
+      if options.has_key?(:show)
 
-      if args.empty?
-        puts oparser
-      else
-        parser_options = options.reject { |key, value| key == :verbose }
+        case options[:show]
+        when :help
+          puts args_parser
+        when :version
+          puts "Gingerice: #{Gingerice::VERSION}"
+        end
 
-        parser   = Parser.new(parser_options)
-        response = parser.parse(args.last)
+      else
+        parser_opts = options.select { |k, _| Parser.default_options.keys.include?(k) }
+        parser      = Parser.new(parser_opts)
+        response    = parser.parse(args.last)
 
         if options[:verbose]
           ap response

data/lib/gingerice/parser.rb

@@ -4,18 +4,17 @@ require 'json'
 
 module Gingerice
   class Parser
-    GINGER_ENDPOINT = 'http://services.gingersoftware.com/Ginger/correct/json/GingerTheText'
-    GINGER_VERSION  = '2.0'
-    GINGER_API_KEY  = '6ae0c3a0-afdc-4532-a810-82ded0054236'
-    DEFAULT_LANG    = 'US'
+    GINGER_API_ENDPOINT = 'http://services.gingersoftware.com/Ginger/correct/json/GingerTheText'
+    GINGER_API_VERSION  = '2.0'
+    GINGER_API_KEY      = '6ae0c3a0-afdc-4532-a810-82ded0054236'
+    DEFAULT_LANG        = 'US'
 
-    attr_reader :lang, :api_key, :api_version, :api_endpoint
+    attr_accessor :lang, :api_key, :api_version, :api_endpoint
 
     def initialize(options = {})
-      @lang         = options.fetch(:lang, DEFAULT_LANG)
-      @api_key      = options.fetch(:api_key, GINGER_API_KEY)
-      @api_version  = options.fetch(:api_version, GINGER_VERSION)
-      @api_endpoint = options.fetch(:api_endpoint, GINGER_ENDPOINT)
+      merge_options(options).each do |key, value|
+        send("#{key}=", value)
+      end
     end
 
     def parse(text)
@@ -31,7 +30,24 @@ module Gingerice
       end
     end
 
+    def self.default_options
+      {
+        :api_endpoint => Gingerice::Parser::GINGER_API_ENDPOINT,
+        :api_version  => Gingerice::Parser::GINGER_API_VERSION,
+        :api_key      => Gingerice::Parser::GINGER_API_KEY,
+        :lang         => Gingerice::Parser::DEFAULT_LANG
+      }
+    end
+
     protected
+    def merge_options(options)
+      options.select! do |key, _|
+        Parser.default_options.include?(key)
+      end
+
+      Parser.default_options.merge(options)
+    end
+
     def response_processor(text, content)
       data = JSON.parse(content)
       i = 0
@@ -49,7 +65,9 @@ module Gingerice
           corrections << {
             'text'       => text[from..to],
             'correct'    => r['Suggestions'][0]['Text'],
-            'definition' => r['Suggestions'][0]['Definition']
+            'definition' => r['Suggestions'][0]['Definition'],
+            'start'      => from,
+            'length'     => to.to_i - from.to_i + 1
           }
         end
 
@@ -65,8 +83,8 @@ module Gingerice
 
     def request_params
       {
-        'lang' => lang,
-        'apiKey' => api_key,
+        'lang'          => lang,
+        'apiKey'        => api_key,
         'clientVersion' => api_version
       }
     end

data/lib/gingerice/version.rb

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

data/test/test_gingerice.rb

@@ -1,5 +1,12 @@
+require 'simplecov'
 require 'coveralls'
-Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start
 
 require 'stringio'
 module Kernel
@@ -14,7 +21,6 @@ module Kernel
 end
 
 require 'test/unit'
-require 'gingerice/parser'
 require 'gingerice/command'
 
 class TestGingerice < Test::Unit::TestCase
@@ -30,8 +36,8 @@ class TestGingerice < Test::Unit::TestCase
   end
 
   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_ENDPOINT, @parser.api_endpoint
+    assert_equal Gingerice::Parser::GINGER_API_VERSION, @parser.api_version
     assert_equal Gingerice::Parser::GINGER_API_KEY, @parser.api_key
     assert_equal Gingerice::Parser::DEFAULT_LANG, @parser.lang
   end
@@ -50,6 +56,8 @@ class TestGingerice < Test::Unit::TestCase
     assert_equal text, result['text']
     assert_equal 'The smell of flowers brings back memories.', result['result']
     assert_equal 3, result['corrections'].count
+    assert_equal 4, result['corrections'].first['start']
+    assert_equal 5, result['corrections'].first['length']
   end
 
   def test_exceptions
@@ -57,7 +65,7 @@ class TestGingerice < Test::Unit::TestCase
     assert_equal 'getaddrinfo: Name or service not known', exception.message
   end
 
-  def test_command_usage
+  def test_command_simple_output
     output = capture_stdout do
       command = Gingerice::Command.new(["Edwards will be sck yesterday"])
       command.execute
@@ -65,12 +73,56 @@ class TestGingerice < Test::Unit::TestCase
     assert_equal "Edwards was sick yesterday\n", output.string
   end
 
-  def test_command_help
+  def test_command_verbose_output
+    output = capture_stdout do
+      command = Gingerice::Command.new(["-v", "He flyed to Jakarta"])
+      command.execute
+    end
+    assert_match 'corrections', output.string
+  end
+
+  def test_command_help_usage
     output = capture_stdout do
       command = Gingerice::Command.new([])
       command.execute
     end
     assert_match "Usage:", output.string
   end
+
+  def test_command_show_version
+    output = capture_stdout do
+      command = Gingerice::Command.new(['--version'])
+      command.execute
+    end
+    assert_equal "Gingerice: #{Gingerice::VERSION}\n", output.string
+  end
+
+  def test_command_arg_api_endpoint
+    command = Gingerice::Command.new(['--api-endpoint', 'http://example.id/'])
+    options = command.options
+
+    assert_equal "http://example.id/", options[:api_endpoint]
+  end
+
+  def test_command_arg_api_version
+    command = Gingerice::Command.new(['--api-version', '1.0'])
+    options = command.options
+
+    assert_equal "1.0", options[:api_version]
+  end
+
+  def test_command_arg_api_key
+    command = Gingerice::Command.new(['--api-key', '123456'])
+    options = command.options
+
+    assert_equal "123456", options[:api_key]
+  end
+
+  def test_command_arg_lang
+    command = Gingerice::Command.new(['--lang', 'ID'])
+    options = command.options
+
+    assert_equal "ID", options[:lang]
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gingerice
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Alif Rachmawadi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-04-30 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: simplecov
+  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: coveralls
   requirement: !ruby/object:Gem::Requirement