yandex-translator-api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46d9608bcfdc944f75b0b5f4df553b3db20cef4a
-  data.tar.gz: ead7ffaf10b823fa0fae61c843374c37fedcef42
+  metadata.gz: f9c69bfa8ce26b71f8dbce328bb54b5ec6a31e32
+  data.tar.gz: ce99603a1859fafc89485608a750b7ae7383a3e6
 SHA512:
-  metadata.gz: 67c3ed3b8634f8f1108e6d0a495f97555fe6a16ee84c9308a2d23cb7778385e8ac6c9bc5cff63c8f2dba55a888320f0cb23f1240b807c229601008a30f3681a2
-  data.tar.gz: 43d444a507b52c87a0f588c7421be5835994360fb51b0a40f8f5cc325a1b7558d4e4b938a5ae3c0d4fddcc781a5ffe62b4182a63e5c87a2bf3a2f823f698e027
+  metadata.gz: 9c20185398da0e5e784c8dbf33ff91ed47f62853afdec1939f920f94967579b615c1abdc7b38a44aa6745518c5acb8626dc06005f7747e19903f17cc89196790
+  data.tar.gz: e80d06c8d20eb76498693fc30e5e6a22932d35a354170ccd5a4e24c7caeead36ad5bc5b79dc863bf4e31c794db5b3632a94cd0888d70eb5e886f4d55f64cacb0

data/.rspec

@@ -1,2 +1,3 @@
+--require spec_helper
 --format documentation
 --color

data/.rubocop.yml

@@ -0,0 +1,46 @@
+AllCops:
+  Exclude:
+    - bin/*
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Layout/IndentationWidth:
+  Width: 4
+
+Layout/CaseIndentation:
+  EnforcedStyle: case
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: true
+
+Layout/AlignHash:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/FormatStringToken:
+  EnforcedStyle: template

data/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
 group :test do
     gem 'rspec'
     gem 'webmock'

data/README.md

@@ -23,7 +23,8 @@ Or install it yourself as:
 Create Translator object.
 
 ```ruby
-  translator = Yandex::Translator.new('api_key')
+  require 'yandex'
+  translator = Yandex::Translator.new(api_key: 'api_key')
 ```
 
 ### Langs
@@ -36,6 +37,18 @@ Request for getting possible translation directions is #langs.
 
     It returns array of possible translations or error.
 
+#### Responces
+
+```ruby
+  {
+    "dirs"=>[
+      "az-ru",
+      "be-bg",
+      "en-ru"
+    ]
+  }
+```
+
 ### Detect
 
 Request for detecting language of the text is #detect.
@@ -48,6 +61,20 @@ Request for detecting language of the text is #detect.
     text - text for detecting, required param
     hint - list of possible languages
 
+#### Responces
+
+```ruby
+  {
+    "code"=>200,
+    "lang"=>"en"
+  }
+```
+```ruby
+  {
+    :error=>"Bad Request"
+  } 
+```
+
 ### Translate
 
 Request for translating of the text is #translate.
@@ -61,6 +88,21 @@ Request for translating of the text is #translate.
     from - language of the text
     to - translating direction, required param
 
+#### Responces
+
+```ruby
+  {
+    "code"=>200,
+    "lang"=>"en-ru",
+    "text"=>["привет"]
+  }
+```
+```ruby
+  {
+    :error=>"Bad Request"
+  } 
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kortirso/yandex-translator-api.

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "yandex"
+require 'bundler/setup'
+require 'yandex'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "yandex"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/yandex.rb

@@ -1,5 +1,6 @@
 require_relative 'yandex/version'
 require_relative 'yandex/translator'
 
+# Top-level docs
 module Yandex
 end

data/lib/yandex/translator.rb

@@ -1,46 +1,41 @@
+require 'httparty'
 require_relative 'translator/langs'
 require_relative 'translator/detect'
 require_relative 'translator/translate'
-require 'net/http'
-require 'json'
 
 module Yandex
+    # Translator class
     class Translator
+        class YandexFailure < StandardError; end
+
+        include HTTParty
         include Yandex::Translator::Langs
         include Yandex::Translator::Detect
         include Yandex::Translator::Translate
 
-        class YandexFailure < StandardError; end
+        base_uri 'https://translate.yandex.net/api/v1.5/tr.json'
+        format :json
 
-        attr_reader :api_key, :base_uri
+        attr_reader :api_key
 
-        def initialize(api_key = '')
-            @api_key = api_key
-            @base_uri = 'https://translate.yandex.net/api/v1.5/tr.json'
+        def initialize(args = {})
+            @api_key = args[:api_key]
         end
 
-        private
-
-        def call(address, args = {})
-            response = http_request(address, args)
+        private def request(uri, args = {})
+            response = self.class.post(uri, query: args.merge(key: api_key))
             check_response(response)
             response
         end
 
-        def http_request(address, args)
-            uri = URI("#{base_uri}#{address}")
-            req = Net::HTTP::Post.new(uri)
-            req.set_form_data(args.merge(key: api_key))
-            Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
-        end
-
-        def check_response(response)
-            if response.code != '200'
-                raise YandexFailure, JSON.parse(response.body)['message']
+        private def check_response(response)
+            if response.code != 200
+                error_message = response.message.empty? ? response.code : response.message
+                raise YandexFailure, error_message
             end
         end
 
-        def check_args(args)
+        private def check_args(args)
             args.each do |arg_name, value|
                 if value.nil? || !value.is_a?(String)
                     raise YandexFailure, "Invalid argument '#{arg_name}', must be string"
@@ -48,4 +43,4 @@ module Yandex
             end
         end
     end
-end
+end

data/lib/yandex/translator/detect.rb

@@ -1,15 +1,15 @@
 module Yandex
     class Translator
+        # Detection module
         module Detect
-
+            # Detect language
             def detect(args = {})
                 check_args(text: args[:text])
-                response = call('/detect', { hint: args[:hint], text: args[:text] })
-                JSON.parse(response.body)['lang']
+                response = request('/detect', hint: args[:hint], text: args[:text])
+                response.parsed_response
             rescue YandexFailure => ex
                 return { error: ex.message }
             end
-
         end
     end
-end
+end

data/lib/yandex/translator/langs.rb

@@ -1,14 +1,14 @@
 module Yandex
     class Translator
+        # Available languages module
         module Langs
-
+            # Get list of available languages for translation
             def langs
-                response = call('/getLangs')
-                JSON.parse(response.body)['dirs']
+                response = request('/getLangs')
+                response.parsed_response
             rescue YandexFailure => ex
                 return { error: ex.message }
             end
-            
         end
     end
-end
+end

data/lib/yandex/translator/translate.rb

@@ -1,16 +1,16 @@
 module Yandex
     class Translator
+        # Translate module
         module Translate
-
+            # Translate text
             def translate(args = {})
                 check_args(text: args[:text], to: args[:to])
                 translate_direction = args[:from].nil? ? args[:to] : "#{args[:from]}-#{args[:to]}"
-                response = call('/translate', { lang: translate_direction, text: args[:text] })
-                JSON.parse(response.body)['text']
+                response = request('/translate', lang: translate_direction, text: args[:text])
+                response.parsed_response
             rescue YandexFailure => ex
                 return { error: ex.message }
             end
-            
         end
     end
-end
+end

data/lib/yandex/version.rb

@@ -1,3 +1,3 @@
 module Yandex
-  VERSION = '1.0.0'
+    VERSION = '1.1.0'.freeze
 end

data/yandex.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'yandex/version'
@@ -23,5 +24,6 @@ Gem::Specification.new do |spec|
 
     spec.add_development_dependency 'bundler', '~> 1.14'
     spec.add_development_dependency 'rake', '~> 10.0'
-    spec.add_development_dependency 'rspec', '~> 3.0'
+    spec.add_development_dependency 'rubocop', '~> 0.49.1'
+    spec.add_dependency 'httparty', '~> 0.15'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yandex-translator-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Anton Bogdanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2017-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,19 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
 description: Gem for sending words for translation to Yandex Translator API
 email:
 - kortirso@gmail.com
@@ -61,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -95,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Text translating by Yandex Translator API