gingerice 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5aa2568c764a2f1d844124cfc9983d22ba4e06aa
+  data.tar.gz: 4ebbb86b37f1e2f43fba0d1aa02741fe76c0c0a3
+SHA512:
+  metadata.gz: fc8610f79b813b40fed1bec8127e1d807f380e257fe46299cdf265b8b163257aa16ad8096461df4e587e3bf407b37c8d5ebffcb17239e7b5cdb6a3c9a869c896
+  data.tar.gz: 7ecb04214a5f721e583aae3dc6d830acbcdc790096166e74f094799312f7f68379a45d634a7ac860e5d54268ee3b3a8f4ee68822c5d5b650efb7670398e8604f

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.markdown]
+indent_size = 4

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,74 @@
+# 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)
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gingerice'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gingerice
+
+## Usage
+
+    require 'gingerice'
+
+    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.",
+    #     "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 sick yesterday"
+
+    # output :
+    #
+    # Edwards was sick yesterday
+
+## 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
+
+## Thanks
+
+Thank you for [Ginger Proofreader](http://www.gingersoftware.com/) for such awesome service. Hope they will keep it free :)

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/gingerice

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File::join(File::dirname(File::dirname(__FILE__)), "lib"))
+
+require 'gingerice/parser'
+require 'gingerice/tool'
+
+STDOUT.puts(Gingerice::Tool.check(ARGV.shift)['result'])
+

data/gingerice.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gingerice/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gingerice"
+  spec.version       = Gingerice::VERSION
+  spec.authors       = ["Alif Rachmawadi"]
+  spec.email         = ["subosito@gmail.com"]
+  spec.description   = %q{Corrects spelling and grammar mistakes based on the context of complete sentences.}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/subosito/gingerice"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "addressable"
+end

data/lib/gingerice/parser.rb

@@ -0,0 +1,73 @@
+require 'open-uri'
+require 'addressable/uri'
+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'
+
+    attr_reader :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)
+    end
+
+    def parse(text)
+      uri = Addressable::URI.parse(api_endpoint)
+      uri.query_values = request_params.merge({ 'text' => text })
+
+      begin
+        open(uri) do |stream|
+          content = stream.read
+          data    = JSON.parse(content)
+
+          i = 0
+          result = ''
+          corrections = []
+
+          data.fetch('LightGingerTheTextResult', []).each do |r|
+            from = r['From']
+            to   = r['To']
+
+            if i <= from
+              result += text[i..from-1] unless from.zero?
+              result += r['Suggestions'][0]['Text']
+
+              corrections << {
+                'text'       => text[from..to],
+                'correct'    => r['Suggestions'][0]['Text'],
+                'definition' => r['Suggestions'][0]['Definition']
+              }
+            end
+
+            i = to+1
+          end
+
+          if i < text.length
+            result += text[i..-1]
+          end
+
+          { 'text' => text, 'result' => result, 'corrections' => corrections}
+        end
+      rescue Exception => e
+        raise StandardError, e.message
+      end
+    end
+
+    protected
+    def request_params
+      {
+        'lang' => lang,
+        'apiKey' => api_key,
+        'clientVersion' => api_version
+      }
+    end
+  end
+end
+

data/lib/gingerice/tool.rb

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

data/lib/gingerice/version.rb

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

data/lib/gingerice.rb

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

data/test/test_gingerice.rb

@@ -0,0 +1,38 @@
+require 'test/unit'
+require 'gingerice'
+
+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({
+      lang: 'ID',
+      api_endpoint: 'http://example.com/',
+      api_version: '1.0',
+      api_key: '123456'
+    })
+
+    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'
+  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
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: gingerice
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alif Rachmawadi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+    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:
+- subosito@gmail.com
+executables:
+- gingerice
+extensions: []
+extra_rdoc_files: []
+files:
+- .editorconfig
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.markdown
+- Rakefile
+- bin/gingerice
+- gingerice.gemspec
+- lib/gingerice.rb
+- lib/gingerice/parser.rb
+- lib/gingerice/tool.rb
+- lib/gingerice/version.rb
+- test/test_gingerice.rb
+homepage: https://github.com/subosito/gingerice
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Corrects spelling and grammar mistakes based on the context of complete sentences.
+test_files:
+- test/test_gingerice.rb