yandex_dictionary_api 0.1.1 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34e76bdb7d5419b0e4c976f955e77d104c8eab85
+  data.tar.gz: 7a3360ce89a10f218b78de0c9e64c1631419977d
+SHA512:
+  metadata.gz: edae715beae7c2594c3d9e2ea3c805c0cf02f2649425de32cfd21aec498ded1b8342acc4594c046d6a61a931aec39e8620b10ba4161aa8d929e6c7133b7cddae
+  data.tar.gz: e9670c646adfee781b57c28416f8c4e5df303b72289d75a6099d8aefd8bcc08226964cd80d385a0c041a2f7ed5ce0acab9005dba184ef00a7e6f3adc338be614

data/README.md

@@ -22,6 +22,14 @@ Or install it yourself as:
     i.get_langs
     params = { "lang" => "en-ru", "text" => "time" }
     i.lookup( params )
+    articles = i.lookup_arr( params )
+    articles.each do |article|
+    	article.text
+	    article.translations
+	    article.synonyms
+	    article.means
+	    article.examples
+    end
 
 ## Return
 

data/lib/yandex_dictionary_api.rb

@@ -1,6 +1,7 @@
 require "yandex_dictionary_api/version"
 require "yandex_dictionary_api/api_client"
 require "yandex_dictionary_api/api_error"
+require "yandex_dictionary_api/article"
 require "json"
 
 module YandexDictionaryApi
@@ -18,15 +19,27 @@ module YandexDictionaryApi
       JSON.parse(response.body)
     end
 
-    #Executes lookup (Interpretation and translate) request to yandex dictionary api 
+    # Executes lookup (Interpretation and translate) request to yandex dictionary api 
+    # Returns Json object (see Readme example).
     def lookup(params_hash)
-      response = @client.execute("lookup", params_hash)
-      self.check_response(response)
+      response = exec_lookup(params_hash)
       JSON.parse(response.body)
     end
 
+    # Executes lookup (Interpretation and translate) request to yandex dictionary api 
+    # Returns Array of Articles (see Readme example).
+    def lookup_arr(params_hash)
+      response = exec_lookup(params_hash)
+      read_lookup_response(JSON.parse(response.body))
+    end
+
     protected
 
+    def exec_lookup(params_hash)
+      response = @client.execute("lookup", params_hash)
+      self.check_response(response)
+    end
+
     def check_response(response)
       case response.code
       when 200
@@ -45,5 +58,29 @@ module YandexDictionaryApi
         raise ApiError.new(response.code, "Try again later.")
       end
     end
+
+    def read_lookup_response(hash)
+      res = Array.new
+      hash["def"].each do |hash|
+        res << read_response_hash(hash)
+      end
+      res
+    end
+
+    def read_response_hash(hash)
+      res = Article.new
+      hash.each_pair do |key, value|
+        unless value.is_a? Array
+          res.text = res.text << value << " "
+        else
+          if key == "tr"
+            res.recognize_translation(value)
+          else
+            raise StandardError.new("Unknown format of response message. Please, contact the developer.")
+          end
+        end
+      end
+      res
+    end
   end
 end

data/lib/yandex_dictionary_api/api_error.rb

@@ -1,13 +1,13 @@
 module YandexDictionaryApi
 
-	class ApiError < StandardError
+  class ApiError < StandardError
 
-		attr_reader :code
+    attr_reader :code
 
-		def initialize(int_code, str_message)
-			@code = int_code
-			msg = "Response code: #{int_code}. " + str_message
-			super(msg)
-		end
-	end
+    def initialize(int_code, str_message)
+      @code = int_code
+      msg = "Response code: #{int_code}. " + str_message
+      super(msg)
+    end
+  end
 end

data/lib/yandex_dictionary_api/article.rb

@@ -0,0 +1,63 @@
+module YandexDictionaryApi
+  
+  # Includes containing of interpretation article, that returns lookup request
+  class Article
+    attr_accessor :text
+    attr_accessor :translations
+    attr_accessor :synonyms
+    attr_accessor :means
+    attr_accessor :examples
+
+    def initialize()
+      @text = ""
+      @translations = ""
+      @synonyms = ""
+      @means = ""
+      @examples = ""
+    end
+
+    def recognize_translation(array)
+      array.each do |hash|
+        read_hash(hash)
+      end
+    end
+
+    protected
+
+    def read_hash(hash)
+      hash.each_pair do |key, value|
+        unless value.is_a? Array
+          @translations << value << " "
+        else
+          case key
+          when "syn"
+            @synonyms << read_attr_string(value)
+          when "mean"
+            @means << read_attr_string(value)
+          when "ex"
+            @examples << read_attr_string(value)
+          end
+        end
+      end
+    end
+
+    def read_attr_string(list)
+      str_res = ""
+      if list.is_a? Array
+        list.each do |hash|
+          str_res << read_attr_string(hash)
+        end
+        return str_res
+      end
+      list.each_pair do |key, value|
+        if value.is_a? Array
+          str_res << read_attr_string(value)
+        else
+          str_res << "#{value}" << " "
+        end
+      end
+      str_res
+    end
+
+  end
+end

data/lib/yandex_dictionary_api/version.rb

@@ -1,3 +1,3 @@
 module YandexDictionaryApi
-	VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/spec/spec_yandex_dictionary_api.rb

@@ -2,19 +2,32 @@ require "spec_helper"
 
 describe YandexDictionaryApi do 
 
-	before do
-		$interface = YandexDictionaryApi::ApiInterface.new(ENV["KEY"])
-	end
+  before do
+    $interface = YandexDictionaryApi::ApiInterface.new(ENV["KEY"])
+  end
 
-	it "should return a list of supported languages" do
-		res = $interface.get_langs
-		res.include?("en-en")
-	end
+  it "should return a list of supported languages" do
+    res = $interface.get_langs
+    res.include?("en-en")
+  end
 
-	it "should return a class contains translation and interpretation of the text" do
-		params = { "lang" => "en-ru", "text" => "time" }
-		res = $interface.lookup( params )
-		res["def"][0]["text"] == "time"
-	end 
+  it "should return a class contains translation and interpretation of the text" do
+    params = { "lang" => "en-ru", "text" => "time" }
+    res = $interface.lookup(params)
+    res["def"][0]["text"] == "time"
+  end
+
+  it "should return an array of instances Article class" do
+    params = { "lang" => "en-ru", "text" => "time" }
+    articles = $interface.lookup_arr( params )
+    articles.each do |article|
+      puts article.text
+      puts article.translations
+      puts article.synonyms
+      puts article.means
+      puts article.examples
+    end
+    true
+  end
 
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yandex_dictionary_api
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - IronSerj
@@ -12,85 +11,75 @@ cert_chain: []
 date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
   name: bundler
-  type: :development
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+  type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.7'
+- !ruby/object:Gem::Dependency
   name: rake
-  type: :development
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+  type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
+- !ruby/object:Gem::Dependency
   name: httpclient
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   name: json
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
-  type: :development
   requirement: !ruby/object:Gem::Requirement
-    none: false
     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: Yandex dictionary API realization
 email:
 - iron.serj@gmail.com
@@ -98,7 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -106,6 +95,7 @@ files:
 - lib/yandex_dictionary_api.rb
 - lib/yandex_dictionary_api/api_client.rb
 - lib/yandex_dictionary_api/api_error.rb
+- lib/yandex_dictionary_api/article.rb
 - lib/yandex_dictionary_api/version.rb
 - spec/spec_helper.rb
 - spec/spec_yandex_dictionary_api.rb
@@ -113,27 +103,26 @@ files:
 homepage: https://github.com/IronSerj/yandex_dictionary_api
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Yandex dictionary API realization
 test_files:
 - spec/spec_helper.rb