rginger 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adbc3bb7227958f6f9f449c93940496d359144df
+  data.tar.gz: 0c3f935ecf26185e41170e90c588b80cc00b248e
+SHA512:
+  metadata.gz: 8d682a2b2c11006ed5a13ec0cdc46ee5fa435171e096bb236d3d087d0eae9a7cd6d8ea61cb4701f4f824eb5072f5e5db4e0e561cbb746d67f941a7cbc34789a0
+  data.tar.gz: 859fe01d830dede34059a1003c51be8493216e392f159af26f6c96178e4e47da4fe385ea0987104535e02e83fad6b5313871505b76c2fa29eb45b700b19c57c9

data/Gemfile

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

data/README.md

@@ -0,0 +1,60 @@
+# RGinger
+
+RGinger takes an English sentence and gives correction and rephrasing suggestions for it using Ginger proofreading API. It can be used both as a Ruby library and a command line application.
+
+## Installation
+
+    $ gem install rginger
+
+## Command Line Usage
+
+### Usage
+
+    $ rginger [options] "input text"
+     
+
+### Options
+
+         --coloring, --no-coloring, -c:   Get colorful output (default: true)
+     --correction, --no-correction, -o:   Get suggestions for correcting the original
+                                          sentence (default: true)
+         --rephrase, --no-rephrase, -r:   Get suggestions for rephrasing the original
+                                          sentence (default: true)
+                         --version, -v:   Print version and exit
+                            --help, -h:   Show this message
+
+### Output Sample
+
+
+
+
+## Library Usage 
+
+    require 'rginger'
+    
+    ginger = RGinger::Parser.new
+    result = ginger.correct "I looking forward meet you"
+
+    # {"original"=>"I looking forward meet you",
+    # "data"=>
+    #  [{"old"=>"looking",
+    #    "from"=>2,
+    #    "to"=>8,
+    #    "reverse_from"=>-24,
+    #    "reverse_to"=>-18,
+    #    "new"=>"am looking"},
+    #   {"old"=>"meet",
+    #    "from"=>18,
+    #    "to"=>21,
+    #    "reverse_from"=>-8,
+    #    "reverse_to"=>-5,
+    #    "new"=>"to meet"}],
+    # "corrected"=>"I am looking forward to meet you"}
+
+### References
+
+Alif Rachmawadi's [Gingerice](https://github.com/subosito/gingerice) may be a better solution than RGinger for those who do not need colored command line output and "rephrase" functionality.
+
+### Thanks
+
+Ginger Software for the great software and services that support learners aspiring for skills of writing good English.

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/rginger

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+$:.unshift(File::join(File::dirname(File::dirname(__FILE__)), "lib"))
+
+require 'rginger'
+require 'trollop'
+require 'rainbow'
+
+opts = Trollop::options do
+  version RGinger::VERSION
+  banner <<-EOS
+RGinger uses Ginger proofreading API and acquires correction and rephrasing suggestions for input English sentence.
+
+Usage:
+       rginger [options] "input text"
+       where [options] are:
+EOS
+  
+  opt :coloring, "Get colorful output", :default => true
+  opt :correction, "Get suggestions for correcting the original sentence", :default => true
+  opt :rephrase, "Get suggestions for rephrasing the original sentence", :default => true
+end
+
+input_text = ARGV ? ARGV.join(" ").dup : ""
+
+Trollop::die "Input text needs to be given" if !input_text || /\A\s*\z/ =~ input_text
+Trollop::die "Either 'Correction' or 'Rephrase' option needs to be turned on" if !opts[:correction] && !opts[:rephrase]
+
+Sickill::Rainbow.enabled = false unless opts[:coloring]
+
+begin
+
+  ginger = RGinger::Parser.new
+  corrected = nil
+  
+  puts ""
+  
+  if opts[:correction]
+    result1 = ginger.correct(input_text)
+    data = result1["data"]
+    if !data.empty?
+      puts "ORIGINAL:".background(:blue)
+      print "\t"
+      onset = 0
+      data.each do |d|
+        reverse_from = d["reverse_from"]
+        reverse_to = d["reverse_to"]        
+        preceding = input_text[onset ... reverse_from]
+        marked = d["old"]
+        print preceding.bright
+        print marked.foreground(:red).underline.bright
+        onset = onset + preceding.length +  d["old"].length
+      end
+      puts input_text[onset .. -1].bright
+      
+      puts "CORRECTED:".background(:green)
+      print "\t"
+      onset = 0
+      data.each_with_index do |d, idx|
+        reverse_from = d["reverse_from"]
+        reverse_to = d["reverse_to"]        
+        preceding = input_text[onset ... reverse_from]
+        marked = d["new"]
+        print preceding.bright
+        print marked.foreground(:green).underline.bright
+        onset = onset + preceding.length + d["old"].length
+      end
+      puts input_text[onset .. -1].bright
+    else
+      puts "Original:".background(:blue)
+      puts "\t#{input_text}".bright
+      puts "CORRECTED:".background(:green)
+      puts "\tNo suggestion returned".foreground(:magenta)
+    end
+  else
+    puts "Original:".background(:cyan)
+    puts "\t#{input_text}".bright
+  end
+    
+  if opts[:rephrase]
+    input_text = corrected if corrected
+    result2 = ginger.rephrase(input_text)["alternatives"]
+    puts "ALTERNATIVES:".background(:cyan)
+    if !result2.empty?
+      result2.each do |r|
+        puts "\t" + r.bright
+      end
+    else
+      puts "\tNo suggestion returned".foreground(:magenta)
+    end
+  end
+  
+  puts ""  
+
+rescue Exception => e
+  puts e.message
+end

data/lib/rginger/parser.rb

@@ -0,0 +1,122 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module RGinger
+  class Parser
+    def initialize
+    end
+  
+    def correct(input)
+
+      text = input.dup
+      results = {"original" => input, "data" => []}
+
+      if !text || text == ""
+        results["corrected" => text]
+        return results 
+      end
+
+      width = text.length
+      escaped = URI.escape(text)
+      url = "#{API_ENDPOINT}?lang=#{DEFAULT_LANG}&clientVersion=#{API_VERSION}&apiKey=#{API_KEY}&text=#{escaped}"
+
+      json_data = get_json(url)["LightGingerTheTextResult"] rescue {}
+
+      unless json_data.empty?
+        new_string = text
+        json_data.each do |r|
+          if r["Mistakes"].size == r["Suggestions"].size
+            r["Mistakes"].each_with_index do |m, i|
+              from         = m["From"]
+              to           = m["To"]
+              reverse_from = -(width - from)
+              reverse_to   = -(width - to)
+              old_item = new_string[reverse_from .. reverse_to]
+              new_item = r["Suggestions"][i]["Text"]
+              new_string[reverse_from .. reverse_to] = new_item
+              results["data"] << {
+                "old"          => old_item, 
+                "from"         => from, 
+                "to"           => to, 
+                "reverse_from" => reverse_from, 
+                "reverse_to"   => reverse_to,
+                "new"          => new_item,
+              }
+            end    
+          else
+            from         = r["From"]
+            to           = r["To"]
+            reverse_from = -(width - from)
+            reverse_to   = -(width - to)
+            old_item = new_string[reverse_from .. reverse_to]
+            new_item = r["Suggestions"][0]["Text"]
+            new_string[reverse_from .. reverse_to] = new_item rescue ""
+            results["data"] << {
+              "old"          => old_item, 
+              "from"         => from, 
+              "to"           => to, 
+              "reverse_from" => reverse_from, 
+              "reverse_to"   => reverse_to,
+              "new"          => new_item,
+            }
+          end
+          results["corrected"] = new_string
+        end
+      end
+      results
+    end
+ 
+    def rephrase(input)
+
+      text = input.dup
+      results = {"original" => input, "alternatives" => []}
+      return results if !text || text == ""
+
+      width = text.length
+      escaped = URI.escape(text)
+      url = "#{REPHRASE_ENDPOINT}?s=#{escaped}"
+
+      json_data = get_json(url)
+
+      unless json_data.empty? || json_data["Sentences"].empty?
+        results["alternatives"] = json_data["Sentences"].map{|s| s["Sentence"]}
+      end    
+      results
+    end
+    
+    :private
+    
+    def get_json(location, limit = 10)
+      raise ArgumentError, 'too many HTTP redirects' if limit == 0
+      uri = URI.parse(location)
+
+      begin
+        response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+          http.open_timeout = 5
+          http.read_timeout = 10
+          http.get(uri.request_uri)
+        end
+  
+        case response
+        when Net::HTTPSuccess
+          json = response.body
+          JSON.parse(json)
+        when Net::HTTPRedirection
+          location = response['location']
+          warn "redirected to #{location}"
+          # Recursive method call
+          get_json(location, limit - 1)
+        else
+          # Error
+          puts [uri.to_s, response.value].join(" : ")
+        end
+      rescue => e
+        # Error
+        puts [uri.to_s, e.class, e].join(" : ")
+      end
+    end
+    
+  end  
+    
+end

data/lib/rginger/version.rb

@@ -0,0 +1,3 @@
+module RGinger
+  VERSION = "0.1"
+end

data/lib/rginger.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+$:.unshift(File::join(File::dirname(__FILE__)))
+
+require 'pp'
+
+module RGinger
+  API_ENDPOINT      = 'http://services.gingersoftware.com/Ginger/correct/json/GingerTheText'
+  REPHRASE_ENDPOINT = 'http://ro.gingersoftware.com/rephrase/rephrase'
+  API_VERSION       = '2.0'
+  API_KEY           = '6ae0c3a0-afdc-4532-a810-82ded0054236'
+  DEFAULT_LANG      = 'US'
+end
+
+require 'rginger/parser'
+require 'rginger/version'

data/rginger.gemspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rginger/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rginger"
+  gem.version       = RGinger::VERSION
+  gem.authors       = ["Yoichiro Hasebe"]
+  gem.email         = ["yohasebe@gmail.com"]
+  gem.description   = "RGinger takes an English sentence and gives correction and rephrasing suggestions for it using Ginger proofreading API."
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/yohasebe/rginger"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|gem|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_dependency "trollop"
+  gem.add_dependency "rainbow"
+end
+

data/rginger.rb

@@ -0,0 +1,86 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+GINGER_API_ENDPOINT = 'http://services.gingersoftware.com/Ginger/correct/json/GingerTheText'
+GINGER_REPHRASE_ENDPOINT = 'http://ro.gingersoftware.com/rephrase/rephrase'
+GINGER_API_VERSION  = '2.0'
+GINGER_API_KEY      = '6ae0c3a0-afdc-4532-a810-82ded0054236'
+DEFAULT_LANG        = 'US'
+
+def get_json(location, limit = 10)
+  raise ArgumentError, 'too many HTTP redirects' if limit == 0
+  uri = URI.parse(location)
+  
+  begin
+    response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      http.open_timeout = 5
+      http.read_timeout = 10
+      http.get(uri.request_uri)
+    end
+    
+    case response
+    when Net::HTTPSuccess
+      json = response.body
+      JSON.parse(json)
+    when Net::HTTPRedirection
+      location = response['location']
+      warn "redirected to #{location}"
+      # Recursive method call
+      get_json(location, limit - 1)
+    else
+      # Error
+      puts [uri.to_s, response.value].join(" : ")
+    end
+  rescue => e
+    # Error
+    puts [uri.to_s, e.class, e].join(" : ")
+  end
+end
+
+puts "# => ORIGINAL"
+puts original = "I am suffring from a desease, amn't I"
+width = original.length
+corrected = []
+
+text = URI.escape(original)
+
+correction = "#{GINGER_API_ENDPOINT}?lang=#{DEFAULT_LANG}&clientVersion=#{GINGER_API_VERSION}&apiKey=#{GINGER_API_KEY}&text=#{text}"
+
+results = get_json(correction)["LightGingerTheTextResult"]
+
+if results.empty?
+  puts "# No need to correct"
+  a_better = original
+else
+  new_string = original
+  results.each do |r|
+    if r["Mistakes"].size == r["Suggestions"].size
+      r["Mistakes"].each_with_index do |m, i|
+        from = -(width - m["From"])
+        to   = -(width - m["To"])
+        new_string[from .. to] = r["Suggestions"][i]["Text"]
+      end    
+    else
+      from = -(width - r["From"])
+      to   = -(width - r["To"])
+      new_string[from .. to] = r["Suggestions"][0]["Text"] rescue ""
+    end
+  end
+  puts "# => CORRECTED"
+  puts a_better = new_string
+end
+
+text = URI.escape(a_better)
+
+rephrase = "#{GINGER_REPHRASE_ENDPOINT}?s=#{text}"
+results = get_json(rephrase)
+
+if results.empty? || results["Sentences"].empty?
+  puts "# No alternative expressions"
+else
+  puts "# => ALTERNATIVES"
+  results["Sentences"].each do |item|
+    puts item["Sentence"]
+  end
+end

data/test/test_rginger.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+$:.unshift(File::join(File::dirname(File.expand_path(File::dirname(__FILE__))), "lib"))
+
+require 'test/unit'
+require 'rginger'
+require 'pp'
+
+class TestRGinger < Test::Unit::TestCase
+  def setup
+    @ginger = RGinger::Parser.new
+    @text   = 'I wke up to teh poring rain.'
+    @corrected = 'I woke up to the pouring rain.'
+    @alternative = 'I woke up to pouring rain.'
+  end
+
+  def test_correcting_sentence
+    result = @ginger.correct(@text)
+
+    assert_equal @text, result['original']
+    assert_equal @corrected, result['corrected']
+    assert_equal 3, result['data'].size
+    assert_equal 2, result['data'].first['from']
+    assert_equal 4, result['data'].first['to']
+    assert_equal -26, result['data'].first['reverse_from']
+    assert_equal -24, result['data'].first['reverse_to']
+    assert_equal "wke", result['data'].first['old']
+    assert_equal "woke", result['data'].first['new']
+  end
+
+  def test_rephrasing_sentence
+    result = @ginger.rephrase(@corrected)
+    
+    assert_equal @corrected, result['original']
+    assert_equal 4, result['alternatives'].size
+    assert_equal @alternative, result['alternatives'].first
+  end
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rginger
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Yoichiro Hasebe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: trollop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  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: RGinger takes an English sentence and gives correction and rephrasing
+  suggestions for it using Ginger proofreading API.
+email:
+- yohasebe@gmail.com
+executables:
+- rginger
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- bin/rginger
+- lib/rginger.rb
+- lib/rginger/parser.rb
+- lib/rginger/version.rb
+- rginger.gemspec
+- rginger.rb
+- test/test_rginger.rb
+homepage: https://github.com/yohasebe/rginger
+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.1.10
+signing_key: 
+specification_version: 4
+summary: RGinger takes an English sentence and gives correction and rephrasing suggestions
+  for it using Ginger proofreading API.
+test_files:
+- test/test_rginger.rb