yandex-translator 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1de77f641e2fa9133334e7e60841e6af74c22153
-  data.tar.gz: 996c9c7c4195d9f40ea4f77c36407b684a3f4a63
+  metadata.gz: 74895efb7c9206b03ded8f1927b9512a0d69af21
+  data.tar.gz: 6be39b5b2a8d6acb79054df43a2732a1dfc6471b
 SHA512:
-  metadata.gz: 206cd4c86dc0c21ee5d03cdae3506c97daeb22ff92c05c536cae6b0b7051db7c7f929bfa8ea654914858496207c50153f1ada8571fa87e84beceafe2ec997d16
-  data.tar.gz: 1ec94ecd1aa8ee8f838f43a6cf35a2354a798ca3adbb206fdc2236ed28b7edaef41825f9b10f4c998486fb56aa9b16e25047cefdba10daa006d81a7ebc76e7e2
+  metadata.gz: 9049203db833860d1bebd8c2a6e102551c4d9107b271144f70149ebe15b5f925b4a6ee4e6d98153dd5180f8107d6c2c3720ef1a95398e35863f2b2df7b283a46
+  data.tar.gz: 19e47931a2437cfcb2c76f1ced5c8c7c9f55ee56817255c6b63ae8d5ea8a2549d901a6b394dcd1e3927aac710999693043d03d80e4b4145892028b9f653ed5f3

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.swp
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -1,3 +1,5 @@
+[![Code Climate](https://codeclimate.com/repos/5255368456b102667402265a/badges/cc0cf62aa85959503fc1/gpa.png)](https://codeclimate.com/repos/5255368456b102667402265a/feed)
+
 # Yandex::Translator
 
 Library for Yandex Translate API | Библиотека для API Яндекс.Переводчика
@@ -19,28 +21,34 @@ Or install it yourself as:
 
 ## Usage
 
-First, set your api key:
+First, create translator using your api key:
+
+```ruby
+  translator = Yandex::Translator.new('your.key')
+```
+
+To get list of possible translation directions use #langs method:
 
 ```ruby
-  Yandex::Translator.set_api_key('API_KEY')
+  translator.langs
 ```
 
 To determine language text use detect method:
 
 ```ruby
-  Yandex::Translator.detect('Hello, world!')
+  translator.detect 'Hello, world!'
 ```
 To translate text use translate method:
 
 ```ruby
-  Yandex::Translator.translate('Car', 'ru')
+  translator.translate 'Car', from: 'ru'
 ```
 
 In this case Yandex automatically detect text language.
 If you want to set text language manually add third parameter
 
 ```ruby
-  Yandex::Translator.translate('Car', 'ru', 'en')
+  translator.translate 'Car', from: 'ru', to: 'en'
 ```
 
 ## Contributing

data/lib/yandex-translator.rb

@@ -1,84 +1,7 @@
-# encoding: UTF-8
-
-require "yandex-translator/version"
-require "httparty"
+require 'yandex/translator/version'
+require 'httparty'
+require 'yandex/translator'
 
 module Yandex
-  module Translator
-
-    class TranslationError < StandardError; end
-    class ApiError < StandardError; end
-
-    class Translation
-      include HTTParty
-      base_uri 'https://translate.yandex.net/api/v1.5/tr'
-
-
-      def self.api_key=(key)
-        @@api_key = key
-      end
-
-      def detect_lang(text)
-        options = {}
-        options[:query] = { :text => text, :key => @@api_key }
-        language = self.class.get("/detect", options)
-        if language["DetectedLang"]
-          language["DetectedLang"]["lang"]
-        else
-          check_api_errors(language)
-        end
-      end
-
-      def translate(text, to_language, from_language)
-        lang = from_language.nil? ? to_language : "#{from_language}-#{to_language}"
-        options = {}
-        options[:query] = { :lang => lang, :text => text, :key => @@api_key }
-        translation = self.class.get("/translate", options)
-        raise TranslationError.new("Can't translate text to #{to_language}") if translation["Translation"].nil?
-        case translation["Translation"]["code"].to_i
-          when 200
-            translation["Translation"]["text"]
-          when 413
-            raise TranslationError.new("Text too long")
-          when 422
-            raise TranslationError.new("Can't translate text")
-          when 501
-            raise TranslationError.new("Can't translate text to #{to_language}")
-          else
-            check_api_errors(translation)
-        end
-      end
-
-      private
-
-      def check_api_errors(responce)
-        case responce["Translation"]["code"].to_i
-          when 401
-            ApiError.new("Invalid api key")
-          when 402
-            ApiError.new("Api key blocked")
-          when 403
-            ApiError.new("Daily request limit exceeded")
-          when 404
-            ApiError.new("Daily char limit exceeded")
-          else
-            raise TranslationError.new("Try again later")
-        end
-      end
-
-    end
-
-    def self.set_api_key(key)
-      Translation.api_key = key
-    end
-
-    def self.detect(text = '')
-      Translation.new.detect_lang(text)
-    end
-
-    def self.translate(text, to_language, from_language = nil)
-      Translation.new.translate(text, to_language, from_language)
-    end
-
-  end
+  class ApiError < StandardError; end
 end

data/lib/yandex/translator.rb

@@ -0,0 +1,71 @@
+module Yandex
+  class Translator
+    include HTTParty
+    base_uri 'https://translate.yandex.net/api/v1.5/tr.json'
+
+    attr_reader :api_key
+
+    class << self # backwards compatability
+      attr_reader :api_key, :translator
+
+      def api_key=(key)
+        @api_key = key
+        @translator = new(api_key)
+      end
+
+      def get_langs
+        translator.get_langs
+      end
+
+      def translate(text, *lang)
+        translator.translate(text, *lang)
+      end
+
+      def detect(text)
+        translator.detect(text)
+      end
+
+      private :translator
+    end
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def langs
+      @langs ||= visit('/getLangs')['dirs']
+    end
+    alias_method :get_langs, :langs
+
+    def detect(text)
+      lang = visit('/detect', text: text)['lang']
+      lang == '' ? nil : lang
+    end
+
+    def translate(text, *lang)
+      if lang.last.is_a?(Hash)
+        lang_options = lang.last
+        lang = [lang_options[:to], lang_options[:from]].compact
+      end
+
+      options = { text: text, lang: lang.reverse.join('-') }
+
+      result = visit('/translate', options)['text']
+
+      result.size == 1 ? result.first : result
+    end
+
+    def visit(address, options = {})
+      response = self.class.post address, body: options.merge(key: api_key)
+      check_errors(response)
+      response
+    end
+
+    private
+
+    def check_errors(response)
+      return if response['code'].to_i == 200
+      fail ApiError, response['message']
+    end
+  end
+end

data/lib/yandex/translator/version.rb

@@ -0,0 +1,5 @@
+module Yandex
+  class Translator
+    VERSION = '0.3.0'
+  end
+end

data/spec/lib/yandex/translator_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe Yandex::Translator do
+  let(:api_key) { 'secret' }
+
+  subject(:translator) { Yandex::Translator.new(api_key) }
+
+  describe '::translate' do
+    before do
+      expect_any_instance_of(Yandex::Translator).to receive(:translate)
+      Yandex::Translator.api_key = api_key
+    end
+
+    it 'calls translate method on instace object' do
+      Yandex::Translator.translate('Bar', 'ru', 'en')
+    end
+  end
+
+  describe '::get_langs' do
+    before do
+      expect_any_instance_of(Yandex::Translator).to receive(:get_langs)
+      Yandex::Translator.api_key = api_key
+    end
+
+    it 'calls translate method on instace object' do
+      Yandex::Translator.get_langs
+    end
+  end
+
+  describe '::detect' do
+    before do
+      expect_any_instance_of(Yandex::Translator).to receive(:detect)
+      Yandex::Translator.api_key = api_key
+    end
+
+    it 'calls translate method on instace object' do
+      Yandex::Translator.detect('Car')
+    end
+  end
+
+
+
+  describe '#translate' do
+    let(:translate_url) { 'https://translate.yandex.net/api/v1.5/tr.json/translate' }
+    let(:translate_request_body) { "text=Car&lang=ru&key=#{api_key}" }
+    let(:translate_response_body) do
+      '{"code":200, "lang": "en-ru", "text": ["Автомобиль"]}'
+    end
+
+    let!(:translate_request) do
+      stub_request(:post, translate_url)
+        .with(body: translate_request_body)
+        .to_return(
+          body: translate_response_body,
+          headers: {'Content-Type' => 'application/json'}
+        )
+    end
+
+    it 'triggers correct yandex translation url' do
+      translator.translate('Car', 'ru')
+      expect(translate_request).to have_been_made.once
+    end
+
+    it 'returns translalation' do
+      expect(translator.translate('Car', 'ru')).to eq 'Автомобиль'
+    end
+
+    it 'accepts options' do
+      translator.translate('Car', from: :ru)
+      expect(translate_request).to have_been_made.once
+    end
+
+    context 'with two languages' do
+      let(:translate_request_body) { "text=Car&lang=en-ru&key=#{api_key}" }
+
+      it 'accepts options' do
+        translator.translate('Car', from: :en, to: :ru)
+        expect(translate_request).to have_been_made.once
+      end
+
+      it 'accepts languages list' do
+        translator.translate('Car', :ru, :en)
+        expect(translate_request).to have_been_made.once
+      end
+    end
+
+    context 'when server responds with invalid "lang" parameter error' do
+      let(:translate_request_body) { "text=Car&lang=ru-ru&key=#{api_key}" }
+
+      let(:translation_url) do
+        'https://translate.yandex.net/api/v1.5/tr.json/translate?' \
+        "key=#{api_key}&lang=ru-ru&text=Car"
+      end
+
+      let(:translate_response_body) do
+        '{"code": 401,  "message": "API key is invalid"}'
+      end
+
+      it 'returns translation error' do
+        expect{
+          translator.translate('Car', 'ru', 'ru')
+        }.to raise_error(Yandex::ApiError, "API key is invalid")
+      end
+    end
+  end
+
+  describe '#detect' do
+    let(:detect_url) { "https://translate.yandex.net/api/v1.5/tr.json/detect" }
+    let(:detect_request_body) { "text=Car&key=#{api_key}" }
+    let(:decect_response_body) { '{"code": 200, "lang": "en"}' }
+    let!(:detect_request) do
+      stub_request(:post, detect_url)
+      .with(body: detect_request_body)
+      .to_return(
+        body: decect_response_body,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    it 'hits correct url' do
+      translator.detect('Car')
+      expect(detect_request).to have_been_made.once
+    end
+
+    it 'returns detected language' do
+      expect(translator.detect('Car')).to eq 'en'
+    end
+
+    context 'when response does not contains any language' do
+      let(:decect_response_body) { '{"code": 200, "lang": ""}' }
+
+      it 'returns nil' do
+        expect(translator.detect('Car')).to be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,6 +4,5 @@ require 'webmock/rspec'
 include WebMock
 
 RSpec.configure do |config|
-  config.color_enabled = true
-  config.formatter     = 'documentation'
-end
+
+end

data/yandex-translator.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'yandex-translator/version'
+require 'yandex/translator/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "yandex-translator"
@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = ""
 
   gem.add_dependency "httparty"
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec', '~> 3.1'
   gem.add_development_dependency 'webmock'
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: yandex-translator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Artur Egorov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   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'
 description: Library for Yandex Translate API
@@ -59,15 +59,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/yandex-translator.rb
-- lib/yandex-translator/version.rb
+- lib/yandex/translator.rb
+- lib/yandex/translator/version.rb
+- spec/lib/yandex/translator_spec.rb
 - spec/spec_helper.rb
-- spec/yandex-translator_spec.rb
 - yandex-translator.gemspec
 homepage: ''
 licenses: []
@@ -78,21 +79,20 @@ 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.rc.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Yandex Translate API
 test_files:
+- spec/lib/yandex/translator_spec.rb
 - spec/spec_helper.rb
-- spec/yandex-translator_spec.rb
-has_rdoc: 

data/lib/yandex-translator/version.rb

@@ -1,5 +0,0 @@
-module Yandex
-  module Translator
-    VERSION = "0.1.0"
-  end
-end

data/spec/yandex-translator_spec.rb

@@ -1,59 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-
-describe Yandex::Translator do
-
-  before do
-    Yandex::Translator.set_api_key(ENV['API_KEY'])
-  end
-
-  it "shoud return right translation" do
-    stub_request(:get, "https://translate.yandex.net/api/v1.5/tr/translate?key=#{ENV['API_KEY']}&lang=ru&text=Car").
-      to_return(:body => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Translation code=\"200\" lang=\"en-ru\"><text>Автомобиль</text></Translation>")
-    Yandex::Translator.translate("Car", "ru").should == "Автомобиль"
-  end
-
-  it "should return translation error when translate to the same language" do
-    stub_request(:get, "https://translate.yandex.net/api/v1.5/tr/translate?key=#{ENV['API_KEY']}&lang=ru-ru&text=Car").
-      to_return(:body => "TrService1: Invalid parameter 'lang'" )
-    expect{
-      Yandex::Translator.translate("Car", "ru", "ru")
-    }.to raise_error(Yandex::Translator::TranslationError, "Can't translate text to ru")
-  end
-
-  it "should return translation error when translate from unknown language" do
-    stub_request(:get, "https://translate.yandex.net/api/v1.5/tr/translate?key=#{ENV['API_KEY']}&lang=unknown-ru&text=Car").
-      to_return(:body => "TrService1: Invalid parameter 'lang'" )
-    expect{
-      Yandex::Translator.translate("Car", "ru", "unknown")
-    }.to raise_error(Yandex::Translator::TranslationError, "Can't translate text to ru")
-  end
-
-  it "should return translation error when translate to unknown language" do
-    stub_request(:get, "https://translate.yandex.net/api/v1.5/tr/translate?key=#{ENV['API_KEY']}&lang=ru-unknown&text=Car").
-      to_return(:body => "TrService1: Invalid parameter 'lang'" )
-    expect{
-      Yandex::Translator.translate("Car", "unknown", "ru")
-    }.to raise_error(Yandex::Translator::TranslationError, "Can't translate text to unknown")
-  end
-
-  it "shoud detect en language" do
-    stub_request(:get, "https://translate.yandex.net/api/v1.5/tr/detect?key=#{ENV['API_KEY']}&text=Car").
-      to_return(:body => "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<DetectedLang code=\"200\" lang=\"en\"/>" )
-    Yandex::Translator.detect("Car").should == "en"
-  end
-
-  it "shoud detect ru language" do
-    stub_request(:get, "https://translate.yandex.net/api/v1.5/tr/detect?key=#{ENV['API_KEY']}&text=Автомобиль").
-      to_return(:body => "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<DetectedLang code=\"200\" lang=\"ru\"/>" )
-    Yandex::Translator.detect("Автомобиль").should == "ru"
-  end
-
-  it "shoud not detect any language" do
-    stub_request(:get, "https://translate.yandex.net/api/v1.5/tr/detect?key=#{ENV['API_KEY']}&text=CarАвто").
-      to_return(:body => "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<DetectedLang code=\"200\" lang=\"\"/>" )
-    Yandex::Translator.detect("CarАвто").should be_nil
-  end
-
-end