yandex_dictionary_api 0.0.1

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 IronSerj
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# YandexDictionaryApi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yandex_dictionary_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yandex_dictionary_api
+
+## Exapmle
+
+    i = YandexDictionaryApi::ApiInterface.new("<your_api_key>")
+    i.get_langs
+    params = { "lang" => "en-ru", "text" => "time" }
+    i.lookup( params )
+
+## Return
+
+ApiInterface returns classes, created by JSON parser. 
+In case of the bad response from server raises ApiError with suitable message.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yandex_dictionary_api/fork )
+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. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc 'Spec all functionality of gem'
+task :spec_all do
+system("rspec spec/spec_yandex_dictionary_api.rb")
+end

data/lib/yandex_dictionary_api.rb

@@ -0,0 +1,26 @@
+require "yandex_dictionary_api/version"
+require "yandex_dictionary_api/api_client"
+require "yandex_dictionary_api/api_error"
+require "json"
+
+module YandexDictionaryApi
+
+  class ApiInterface
+
+    def initialize( api_key )
+      @client = YandexDictionaryApi::ApiClient.new( api_key )
+    end
+
+    #Executes getLangs (list of supported languages) request to YandexDictionaryApi api
+    def get_langs
+      response = @client.execute_get_langs
+      JSON.parse( response.body )
+    end
+
+    #Executes lookup (Interpretation and translate) request to yandex dictionary api 
+    def lookup( params_hash )
+      response = @client.execute_lookup( params_hash )
+      JSON.parse( response.body )
+    end
+  end
+end

data/lib/yandex_dictionary_api/api_client.rb

@@ -0,0 +1,42 @@
+gem "httpclient"
+require "httpclient"
+
+module YandexDictionaryApi
+
+  class ApiClient
+
+    GET_LANGS_HTTP_REQUEST_TMPL = "https://dictionary.yandex.net/api/v1/dicservice.json/getLangs?".freeze
+    LOOKUP_HTTP_REQUEST_TMPL = "https://dictionary.yandex.net/api/v1/dicservice.json/lookup?".freeze
+
+    def initialize( api_key )
+      @http_client = HTTPClient.new
+      @api_key = api_key
+    end
+
+    def execute_get_langs
+      str_request = self.add_parameters_to_request(GET_LANGS_HTTP_REQUEST_TMPL, Hash.new)
+      self.exec_request_http( str_request )
+    end
+
+    def execute_lookup( params_hash )
+      str_request = self.add_parameters_to_request(LOOKUP_HTTP_REQUEST_TMPL, params_hash)
+      self.exec_request_http( str_request )
+    end
+
+    protected
+
+    def add_parameters_to_request( str_request, params_hash )
+      str_res = str_request + "key=#{@api_key}"
+      params_hash.each do |(key, value)|
+        str_res += "&#{key}=#{value}"
+      end
+      str_res
+    end
+
+    def exec_request_http( str_request )
+      response = @http_client.get( str_request )
+      ApiError.check( response )
+    end
+  end
+
+end

data/lib/yandex_dictionary_api/api_error.rb

@@ -0,0 +1,25 @@
+module YandexDictionaryApi
+
+	class ApiError < StandardError
+
+		def self.check( response )
+			case response.code
+			when 200
+				response
+			when 401
+				raise ApiError.new("Invalid api key.")
+			when 402
+				raise ApiError.new("Spicified api key is blocked.")
+			when 403
+				raise ApiError.new("The daily limit on the number of requests exceeded.")
+			when 413
+				raise ApiError.new("Limit on the size of text exceeded.")
+			when 501
+				raise ApiError.new("Spicified direction of translation is not supported.")
+			else 
+				raise ApiError.new("Try again later.")
+			end
+		end
+	end
+
+end

data/lib/yandex_dictionary_api/version.rb

@@ -0,0 +1,3 @@
+module YandexDictionaryApi
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "rspec"
+require "yandex_dictionary_api"
+

data/spec/spec_yandex_dictionary_api.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe YandexDictionaryApi do 
+
+	before do
+		$interface = YandexDictionaryApi::ApiInterface.new(ENV['YANDEX_API_KEY'])
+	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 
+
+end

data/yandex_dictionary_api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yandex_dictionary_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yandex_dictionary_api"
+  spec.version       = YandexDictionaryApi::VERSION
+  spec.authors       = ["IronSerj"]
+  spec.email         = ["iron.serj@gmail.com"]
+  spec.summary       = %q{Yandex dictionary API realization}
+  spec.description   = %q{Yandex dictionary API realization}
+  spec.homepage      = "https://github.com/IronSerj/yandex_dictionary_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "httpclient"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "rspec"
+end
+

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: yandex_dictionary_api
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- IronSerj
+autorequire: 
+bindir: bin
+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'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: httpclient
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: json
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+description: Yandex dictionary API realization
+email:
+- iron.serj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yandex_dictionary_api.rb
+- lib/yandex_dictionary_api/api_client.rb
+- lib/yandex_dictionary_api/api_error.rb
+- lib/yandex_dictionary_api/version.rb
+- spec/spec_helper.rb
+- spec/spec_yandex_dictionary_api.rb
+- yandex_dictionary_api.gemspec
+homepage: https://github.com/IronSerj/yandex_dictionary_api
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: Yandex dictionary API realization
+test_files:
+- spec/spec_helper.rb
+- spec/spec_yandex_dictionary_api.rb