yandex_dictionary 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+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,45 @@
+# YandexDictionary
+
+Library for Yandex Dictionary API | Бібліотека для API Яндекс Словник
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+  gem 'yandex_dictionary'
+
+And then execute:
+
+  $ bundle
+
+Or install it yourself as:
+
+  $ gem install yandex_dictionary
+
+## Usage
+
+First, set your api key:
+
+	YandexDictionary.set_api_key('API_KEY')
+
+Set translation directions
+
+	YandexDictionary.set_lang('ru-uk')
+
+Returns a list of language supported by the server
+
+	YandexandexDictionary.getLangs
+
+Searches for words or phrases in the dictionary and returns an automatically generated dictionary entry
+
+	YandexDictionary.lookup 'list'
+
+Documentation: http://api.yandex.ru/dictionary/doc/dg/concepts/api-overview.xml
+
+## 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. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/yandex_dictionary/api.rb

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+require "httparty"
+
+module YandexDictionary
+
+  class API
+
+  	include HTTParty
+
+    base_uri 'https://dictionary.yandex.net/api/v1/dicservice.json'
+    @@lang = 'en-en'
+
+    def self.api_key= key
+      @@api_key = key
+    end
+
+    def self.lang= lang
+      @@lang = lang
+    end
+
+    # Returns a list of language supported by the server
+    def getLangs
+      result = self.class.get '/getLangs', { query:{ key:@@api_key } }
+      check_result result
+    end
+
+    # Searches for words or phrases in the dictionary and returns an automatically generated dictionary entry
+    def lookup text
+      result = self.class.get '/lookup', { query:{ key:@@api_key, lang:@@lang, text:text } }
+      check_result result  
+    end
+
+    private
+
+    def check_result result  
+      result.code == 200 ? JSON.parse( result.body ) : check_api_errors( result )
+    end
+
+    def check_api_errors responce
+      case responce.code
+        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')
+        when 413
+          ApiError.new('Exceeds the maximum size of the text')
+        when 501
+          ApiError.new('Set direction of transfer is not supported')
+        else
+          raise ApiError.new('Try again later')
+      end
+    end
+
+  end
+
+end

data/lib/yandex_dictionary/api_error.rb

@@ -0,0 +1,6 @@
+module YandexDictionary
+
+	class ApiError < StandardError
+	end
+
+end

data/lib/yandex_dictionary/version.rb

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

data/lib/yandex_dictionary.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+require "yandex_dictionary/version"
+require "yandex_dictionary/api"
+require "yandex_dictionary/api_error"
+require 'json'
+
+module YandexDictionary
+
+	def self.set_api_key key
+    API.api_key = key
+  end
+
+  def self.set_lang lang
+    API.lang = lang
+  end
+
+  def self.getLangs
+    API.new.getLangs
+  end
+
+  def self.lookup text
+    API.new.lookup text
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'yandex_dictionary'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

data/spec/yandex_dictionary_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe YandexDictionary do
+
+  before do
+    YandexDictionary.set_api_key(ENV['API_KEY'])
+  end
+
+  it "shoud return a list of language supported by the server" do
+    responce = YandexDictionary.getLangs
+    responce.include?('en-en').should == true
+  end
+
+  it "shoud return words or phrases" do
+    responce = YandexDictionary.lookup 'list'
+    responce['def'][0]['text'].should == 'list'
+  end
+
+  it "shoud set translation directions" do
+    YandexDictionary.set_lang 'en-de'
+    responce = YandexDictionary.lookup 'like'
+    responce['def'][0]['tr'][0]['text'].should == 'wie'
+  end
+
+end

data/yandex_dictionary.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yandex_dictionary/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yandex_dictionary"
+  spec.version       = YandexDictionary::VERSION
+  spec.authors       = ["Andrii Peliak"]
+  spec.email         = ["vseprav@gmaul.com"]
+  spec.description   = %q{Library for Yandex Dictionary API}
+  spec.summary       = %q{Yandex Dictionary APIy}
+  spec.homepage      = "https://github.com/vseprav/yandex_dictionary"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "httparty"
+  spec.add_development_dependency 'json'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: yandex_dictionary
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrii Peliak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Library for Yandex Dictionary API
+email:
+- vseprav@gmaul.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yandex_dictionary.rb
+- lib/yandex_dictionary/api.rb
+- lib/yandex_dictionary/api_error.rb
+- lib/yandex_dictionary/version.rb
+- spec/spec_helper.rb
+- spec/yandex_dictionary_spec.rb
+- yandex_dictionary.gemspec
+homepage: https://github.com/vseprav/yandex_dictionary
+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.25
+signing_key: 
+specification_version: 3
+summary: Yandex Dictionary APIy
+test_files:
+- spec/spec_helper.rb
+- spec/yandex_dictionary_spec.rb