rufregle 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d01902f91959c64ce0f3334d38da418dd33c1c4
-  data.tar.gz: 7a0f370388656346b1f2964b41012f2235dfa2fa
+  metadata.gz: 6eb919aa0fe36fc1c440ae8a5d76b1fb9532c737
+  data.tar.gz: 2dd8d823e2b7240538ab7fde6724ed01a315ae27
 SHA512:
-  metadata.gz: 80b1931f5988d83ec52ad52e0462f17822f77e4c0229c8afbdd3ade3cc6f97a0f47c6b89e4e6a0fae912b9809d46436b084989e04ce19d5194b30b0f820b0556
-  data.tar.gz: 865292ad80b24d9e16e2b041c19e67e26a3e8e101f556bdc9fa4aec95761470559b136a8ca1e4fe1507f18aaf41ed55ed33a372edfef40757697f3be908b4427
+  metadata.gz: e4f3729a12d1932f0c2328b2683c16929fb1d3fc4b3d73be7546157ba2ae92763fc7803a36843c853d283ba6519b5694e3a9994939aa6fa0ded16b2a913227e9
+  data.tar.gz: 71842e72de45c627d523cc573b04a17e6cce37344d980de77c83eb15166f299d79ae4e9e436a1cc917cf40e79523249583c067996b23fe7d1f66728e0200f455

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+*~

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.2.0
+
+install: gem install test-unit
+
+deploy:
+  provider: rubygems
+  api_key: "23d97812d6f00a43c13d6f2f731afaf0."

data/README.md

@@ -0,0 +1,74 @@
+Rufregle
+-----
+[![Version](http://img.shields.io/gem/v/rufregle.svg)](https://rubygems.org/gems/rufregle)[![Build Status](https://travis-ci.org/CristianOliveiraDaRosa/rufregle.svg)](https://travis-ci.org/CristianOliveiraDaRosa/rufregle)
+
+Ruby Free Google Translate gem or Rufregle
+
+Simple unofficial free google translate library.
+
+#How it works?
+
+It uses an alternative google url to request the translate that's why this lib may have performance issues.
+Recommended to use only in prototypes applications.
+
+###Is it free?
+
+Yes.
+
+###Should I use it in my Production Application?
+
+Maybe. You need performance?
+
+
+#Using
+More simple than that?
+
+Installing gem
+```
+$  gem install rufregle
+
+```
+
+Using on code:
+```
+result = Rufregle.new.translate("Hello World", "en", "pt")
+p "#{result[:translated]}"
+```
+
+# Tests
+Runing all tests
+
+```
+rake test
+```
+
+### Integration
+```
+rake integration_test
+```
+
+### Unit Tests
+```
+rake integration_test
+```
+
+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. Submit a pull request
+
+After that include your name in "Authors" section!
+
+** Pull Request should have unit tests **
+
+License
+====
+  This project is under MIT licence
+
+Authors
+=====
+
+Cristian Oliveira - www.cristianoliveira.com.br

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake/testtask'
+
+UNIT_TEST_PATTERN = 'test/unit/**/*_test.rb'
+INTEGRATION_TEST_PATTERN = 'test/integration/**/*_test.rb'
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList[UNIT_TEST_PATTERN]
+end
+
+Rake::TestTask.new(:unit_test) do |t|
+  t.test_files = FileList[UNIT_TEST_PATTERN]
+end
+
+Rake::TestTask.new(:integration_test) do |t|
+  t.test_files = FileList[INTEGRATION_TEST_PATTERN]
+end
+
+desc "Run tests"
+task :default => :test

data/lib/translators/free_google/extractor.rb

@@ -0,0 +1,26 @@
+module FreeGoogle
+  ##
+  # Responsible for extract translated result from a received raw text
+
+  class Extractor
+    ENCODE = 'utf-8'
+
+    ##
+    # Extract translation
+    # @param rawdata [String] Raw text without formating
+    # @return [String] Translated text
+    #
+    #   Example of how raw data look like:
+    #   [[["Olá","Hello",,,10]],,"en"]
+    #
+
+    def extract(rawdata)
+      return "" if rawdata.nil? || rawdata.empty?
+
+      encoded = rawdata.force_encoding(ENCODE)
+      translations = encoded[/\["(.*?)","/]
+
+      translations[2..-4]
+    end
+  end
+end

data/lib/translators/free_google/factory.rb

@@ -0,0 +1,17 @@
+require_relative 'extractor'
+require_relative 'requester'
+require_relative 'translator'
+
+##
+# Responsible for create instance of {FreeGoogle::Translator}
+# It holds all dependencies for this creation
+
+module FreeGoogle
+  class Factory
+    def self.create()
+      extractor = FreeGoogle::Extractor.new
+      http_requester = FreeGoogle::Requester.new
+      FreeGoogle::Translator.new(extractor, http_requester)
+    end
+  end
+end

data/lib/translators/free_google/requester.rb

@@ -0,0 +1,17 @@
+require 'open-uri'
+require 'net/http'
+
+##
+# Responsible for HTTP requests
+module FreeGoogle
+  class Requester
+
+    ##
+    # Http request using GET method.
+
+    def request(url)
+      url = URI::encode(url)
+      Net::HTTP.get(URI.parse(url))
+    end
+  end
+end

data/lib/translators/free_google/translator.rb

@@ -0,0 +1,25 @@
+##
+# Implementation of Translator using alternative URL API to request translations
+
+module FreeGoogle
+  class Translator
+
+    GOOGLE_URL_API = "https://translate.google.com/translate_a/"
+    GOOGLE_PARAMS  = "single?client=z&sl=%s&tl=%s-CN&ie=UTF-8&oe=UTF-8&dt=t&dt=rm&q=%s"
+
+    def initialize(extractor, http_requester)
+      @translation_extractor = extractor
+      @http_requester = http_requester
+    end
+
+    def translate(text_to_translate, language_from, language_to)
+      parameters = GOOGLE_PARAMS % [ language_from, language_to , text_to_translate]
+      url = GOOGLE_URL_API + parameters
+
+      raw_data = @http_requester.request(url)
+      translated = @translation_extractor.extract(raw_data)
+
+      {translated: translated, original: text_to_translate}
+    end
+  end
+end

data/lib/translators/translator.rb

@@ -0,0 +1,16 @@
+##
+# A Blueprint of how a Translator class must be.
+
+class Translator
+  ##
+  # Return a translated text of a given +text+ +from+ language +to+ another language
+  #
+  # @param text [String] text to be translated.
+  # @param from [String] language from
+  # @param to [String] language to
+  # @return [String] translated text
+
+  def translate(text, from, to)
+    raise "Method do_translate must be implemented"
+  end
+end

data/rufregle.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = 'rufregle'
+  s.version     = '2.0.1'
+  s.date        = '2015-09-19'
+  s.summary     = "Free google translate!"
+  s.description = "Simple Free google translate."
+  s.authors     = ["Cristian Oliveira"]
+  s.email       = 'contato@cristianoliveira.com.br'
+  s.files       = `git ls-files`.split($/)
+  s.homepage    = 'https://github.com/CristianOliveiraDaRosa/rufregle'
+  s.license     = 'MIT'
+end

data/test/integration/rufregle_test.rb

@@ -0,0 +1,62 @@
+#!/bin/env ruby
+# encoding: utf-8
+
+require 'test/unit'
+require_relative '../../lib/rufregle.rb'
+require_relative '../../lib/translators/free_google/factory.rb'
+
+class RufregleTest < Test::Unit::TestCase
+
+  def test_english_to_portuguese_hello
+    #given
+    word = "Hello"
+    expected = "Olá"
+
+    #when
+    result = Rufregle.new.translate(word, :en , :pt)
+
+    #then
+    assert_equal(expected, result[:translated])
+  end
+
+  def test_english_to_portuguese_hello_get_original
+    #given
+    word = "Hello"
+    expected = "Hello"
+
+    #when
+    result = Rufregle.new.translate(expected, :en , :pt)
+
+    #then
+    assert_equal(expected, result[:original])
+  end
+
+  def test_prhase_translate
+    #given
+    phrase = "Isso é uma frase traduzida"
+    expected = "This is a translated phrase"
+
+    #when
+    result = Rufregle.new.translate(phrase, :pt, :en)
+
+    #then
+    assert_equal(expected, result[:translated])
+  end
+
+  def test_given_new_translator
+    #given
+    phrase = "Isso é uma frase traduzida"
+    expected = "This is a translated phrase"
+    translator = FreeGoogle::Factory.create()
+    rufregle = Rufregle.new
+
+    #when
+    rufregle.translator = translator
+    result = rufregle.translate(phrase, :pt, :en)
+
+    #then
+    assert_equal(expected, result[:translated])
+  end
+
+
+end

data/test/unit/rufregle_test.rb

@@ -0,0 +1,36 @@
+require 'test/unit'
+require_relative '../../lib/rufregle'
+require_relative '../../lib/rufregle'
+
+class RufregleTest < Test::Unit::TestCase
+
+  def setup
+    @translator = StubedTranslator.new
+    @rufregle = Rufregle.new
+    @rufregle.translator = @translator
+  end
+
+  def test_it_should_raise_error
+    assert_raise RuntimeError do @rufregle.translate(nil, nil, nil) end
+    assert_raise RuntimeError do @rufregle.translate("", "", "") end
+    assert_raise RuntimeError do @rufregle.translate("aaa", "", "") end
+    assert_raise RuntimeError do @rufregle.translate("aaa", "aaa", "") end
+  end
+
+  def test_it_should_not_raise_error
+    # given
+    translation = "Text translated"
+    @translator.result = translation
+
+    # then
+    assert_equal translation, @rufregle.translate("aaa", "aaa", "aaa")
+  end
+
+  class StubedTranslator
+    attr_accessor :result
+
+    def translate(text, from, to)
+      return @result
+    end
+  end
+end

data/test/unit/translators/freegoogle/extractor_test.rb

@@ -0,0 +1,53 @@
+require 'test/unit'
+require_relative '../../../../lib/translators/free_google/extractor'
+
+##
+# Tests for {FreeGoogle::Extractor}
+
+class ExtractorTest < Test::Unit::TestCase
+
+  def setup
+    @translation_extractor = FreeGoogle::Extractor.new
+  end
+
+  def test_it_should_return_empty_string
+    assert_equal "", @translation_extractor.extract("")
+    assert_equal "", @translation_extractor.extract(nil)
+  end
+
+  def test_it_should_return_only_the_translation_text
+    # given
+    rawdata = '[["translation","original",,,10]'
+    expected = "translation"
+
+    # when
+    result =  @translation_extractor.extract(rawdata)
+
+    # then
+    assert_equal expected, result
+  end
+
+  def test_it_should_ignore_inside_quotes
+    # given
+    rawdata = '[["translation\'s","original",,,10]'
+    expected = "translation\'s"
+
+    # when
+    result =  @translation_extractor.extract(rawdata)
+
+    # then
+    assert_equal expected, result
+  end
+
+  def test_it_should_ignore_inside_double_quotes
+    # given
+    rawdata = '[["this has it "", bla bla","original",,,10]'
+    expected = 'this has it "", bla bla'
+
+    # when
+    result =  @translation_extractor.extract(rawdata)
+
+    # then
+    assert_equal expected, result
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufregle
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Cristian Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-09-19 00:00:00.000000000 Z
 dependencies: []
 description: Simple Free google translate.
 email: contato@cristianoliveira.com.br
@@ -16,7 +16,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- README.md
+- Rakefile
 - lib/rufregle.rb
+- lib/translators/free_google/extractor.rb
+- lib/translators/free_google/factory.rb
+- lib/translators/free_google/requester.rb
+- lib/translators/free_google/translator.rb
+- lib/translators/translator.rb
+- rufregle-0.0.2.gem
+- rufregle-1.0.2.gem
+- rufregle.gemspec
+- test/integration/rufregle_test.rb
+- test/unit/rufregle_test.rb
+- test/unit/translators/freegoogle/extractor_test.rb
 homepage: https://github.com/CristianOliveiraDaRosa/rufregle
 licenses:
 - MIT
@@ -37,8 +52,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Free google translate!
 test_files: []
+has_rdoc: