youdao-fanyi 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gem 'crack'

data/README.md

@@ -0,0 +1,94 @@
+# Youdao Fanyi #
+This is a [Youdao Fanyi][YoudaoFanyi] API wrapper written in Ruby.
+
+[Youdao Fanyi][YoudaoFanyi] is a translation service provided by Youdao.
+
+## Pre Job ##
+Before coding, you should go to [Youdao Fanyi API][YoudaoFanyiAPI] for an API key.
+
+**Caution**: Each key can only request less than 1000 times per hour.
+
+## Example ##
+
+    # coding: UTF-8
+    # example.rb
+    require 'youdao-fanyi'
+    # Configure the key first
+    YoudaoFanyi::Config.key_from = "youdao-fanyi"
+    YoudaoFanyi::Config.key = 1629987369
+    # Then use the 4 methods provided.
+    to_be_translated = "要翻译的词句"
+    YoudaoFanyi.search_json(to_be_translated)       # returns a JSON string
+    YoudaoFanyi.search_xml(to_be_translated)        # returns an XML string
+    YoudaoFanyi.search_jsonp(to_be_translated)      # returns a JSONP string
+    YoudaoFanyi.search_result_obj(to_be_translated) # returns a YoudaoFanyi::Result object
+
+## About the API ##
+[Youdao Fanyi API][YoudaoFanyiAPI] provides 3 types of data: *xml*, *json* and *jsonp*.
+
+Here is an ***xml*** sample:
+
+http://fanyi.youdao.com/fanyiapi.do?keyfrom=<keyfrom>&key=<key>&type=data&doctype=xml&version=1.1&q=这里是有道翻译API 
+
+	<?xml version="1.0" encoding="UTF-8"?>
+	<youdao-fanyi>
+    	<errorCode>0</errorCode>
+    	<!-- 有道翻译 -->
+    	<query><![CDATA[这里是有道翻译API]]></query>
+    	<translation>
+        	<paragraph><![CDATA[Here is the youdao translation API]]></paragraph>
+    	</translation>
+	</youdao-fanyi>
+
+Here is a ***json*** sample:
+
+http://fanyi.youdao.com/fanyiapi.do?keyfrom=<keyfrom>&key=<key>&type=data&doctype=json&version=1.1&q=翻译 
+
+	{
+    	"errorCode":0
+	    "query":"翻译",
+    	"translation":["translation"], // 有道翻译
+    	"basic":{ // 有道词典-基本词典
+    	    "phonetic":"fān yì",
+    	    "explains":[
+    	        "translate",
+    	        "interpret"
+    	    ]
+    	},
+    	"web":[ // 有道词典-网络释义
+    	    {
+    	        "key":"翻译",
+    	        "value":["translator","translation","translate","Interpreter"]
+    	    },
+    	    {...}
+    	]
+	}
+
+Here is a ***jsonp*** sample:
+
+http://fanyi.youdao.com/fanyiapi.do?keyfrom=<keyfrom>&key=<key>&type=data&doctype=jsonp&callback=show&version=1.1&q=API 
+
+	show({
+    	"errorCode":0
+    	"query":"API",
+    	"translation":["API"], // 有道翻译
+    	"basic":{ // 有道词典-基本词典
+    	    "explains":[
+    	        "abbr. 应用程序界面（Application Program Interface）；..."
+    	    ]
+    	},
+    	"web":[ // 有道词典-网络释义
+    	    {
+    	        "key":"API",
+    	        "value":["应用程序接口(Application Programming Interface)","应用编程接口","应用程序编程接口","美国石油协会"]
+    	    },
+    	    {...}
+    	]
+	});
+
+## Contributors ##
+*	ZHANG Hailong (https://github.com/zhhailon)
+
+
+[YoudaoFanyi]: http://fanyi.youdao.com "Youdao Fanyi"
+[YoudaoFanyiAPI]: http://fanyi.youdao.com/fanyiapi?path=data-mode "Youdao Fanyi API"

data/lib/youdao-fanyi.rb

@@ -0,0 +1,61 @@
+# Made for Youdao Fanyi (https://github.com/zhhailon/youdao-fanyi).
+# Author: ZHANG Hailong <zhhailon@gmail.com>
+# Date:   Dev 1, 2011
+
+require 'youdao-fanyi/config'
+require 'youdao-fanyi/request'
+require 'youdao-fanyi/result'
+
+module YoudaoFanyi
+
+  # Query a word or sentence.
+  # Param:  q The query word or sentence.
+  # Return: A String of doctype JSON.
+  def self.search_json(q)
+    if q.is_a?(String) && q.length > 0 && q.length <= 200
+      Request.get(q, :json)
+    else
+      puts "The query must be a String and its length should "+
+           "be between 1 to 200."
+    end
+  end
+
+  # Query a word or sentence.
+  # Param:  q The query word or sentence.
+  # Return: A String of doctype XML.
+  def self.search_xml(q)
+    if q.is_a?(String) && q.length > 0 && q.length <= 200
+      Request.get(q, :xml)
+    else
+      puts "The query must be a String and its length should "+
+           "be between 1 to 200."
+    end
+  end
+
+  # Query a word or sentence.
+  # Param:  q The query word or sentence.
+  # Return: A String of doctype JSONP.
+  def self.search_jsonp(q)
+    if q.is_a?(String) && q.length > 0 && q.length <= 200
+      Request.get(q, :jsonp)
+    else
+      puts "The query must be a String and its length should "+
+           "be between 1 to 200."
+    end
+  end
+
+  # Query a word or sentence.
+  # Param:  q The query word or sentence.
+  # Return: A YoudaoFanyi::Result object.
+  def self.search_result_obj(q)
+    if q.is_a?(String) && q.length > 0 && q.length <= 200
+      Result.new(search_xml(q))
+    else
+      puts "The query must be a String and its length should "+
+           "be between 1 to 200."
+    end
+  end
+
+  class YoudaoFanyiError < StandardError; end
+
+end

data/lib/youdao-fanyi/config.rb

@@ -0,0 +1,25 @@
+# Config the authorization.
+# Go to http://fanyi.youdao.com/fanyiapi?path=data-mode for an API key.
+
+module YoudaoFanyi
+
+  module Config
+
+    def self.key_from=(val)
+      @@key_from = val
+    end
+
+    def self.key_from
+      @@key_from
+    end
+
+    def self.key=(val)
+      @@key = val
+    end
+
+    def self.key
+      @@key
+    end
+
+  end
+end

data/lib/youdao-fanyi/request.rb

@@ -0,0 +1,49 @@
+require 'uri'
+require 'net/http'
+#require 'open-uri'
+
+module YoudaoFanyi
+	class Request
+
+		def self.get(q, doctype)
+			new(q, doctype).request
+		end
+
+		def initialize(q, doctype)
+			@query = q
+			@doctype = doctype
+		end
+
+		def request
+			#open(url) do |f|
+			#	f.read
+			#end
+			uri = URI.parse(url)
+			http = Net::HTTP.new(uri.host, uri.port)
+			request = Net::HTTP::Get.new(uri.request_uri)
+			response = http.request(request)
+			raise_errors(response)
+			response.body
+		end
+
+		private
+			# Return the URL
+			def url
+				url = "http://fanyi.youdao.com/fanyiapi.do?keyfrom=" +
+					YoudaoFanyi::Config.key_from + "&key=" +
+					YoudaoFanyi::Config.key.to_s + "&type=data&doctype=" +
+					@doctype.to_s
+				if @doctype == :jsonp
+					url = url + "&callback=show"
+				end
+				url = url + "&version=1.1&q=" + @query
+				URI.encode(url)
+			end
+
+			def raise_errors(response)
+				unless response.code.to_i == 200
+					raise YoudaoFanyiError.new, "(#{response.code}): #{response.message}"
+				end
+			end
+	end
+end

data/lib/youdao-fanyi/result.rb

@@ -0,0 +1,22 @@
+require 'crack'
+
+module YoudaoFanyi
+	class Result
+		attr_reader :error_code, :query, :translation, :explains,
+								:web_explains
+
+		def initialize(xml_data)
+			data = parse(xml_data)["youdao_fanyi"]
+			@error_code = data["errorCode"]
+			@query = data["query"]
+			@translation = data["translation"]["paragraph"]
+			@explains = data["basic"]["explains"]["ex"]
+			@web_explains = data["web"]["explain"]
+		end
+
+		private
+			def parse(xml)
+				Crack::XML.parse(xml)
+			end
+	end
+end

data/youdao-fanyi.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+	s.name = 'youdao-fanyi'
+	s.version = "0.0.1"
+	s.authors = ["ZHANG Hailong"]
+	s.date = '2011-12-01'
+	s.summary = 'Youdao Fanyi (Translation) API Wrapper'
+	s.description = 'A gem to wrap the Youdao Fanyi (fanyi.youdao.com) API. "fanyi" is "translation" in Chinese.'
+	s.email = 'zhhailon@gmail.com'
+	s.homepage = 'https://github.com/zhhailon/youdao-fanyi'
+	s.files = [
+    "Gemfile",
+    "youdao-fanyi.gemspec",
+    "README.md",
+    "lib/youdao-fanyi.rb",
+    "lib/youdao-fanyi/config.rb",
+    "lib/youdao-fanyi/request.rb",
+    "lib/youdao-fanyi/result.rb"
+  ]
+	s.add_dependency('crack', [">= 0"])
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: youdao-fanyi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ZHANG Hailong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: &74031110 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74031110
+description: A gem to wrap the Youdao Fanyi (fanyi.youdao.com) API. "fanyi" is "translation"
+  in Chinese.
+email: zhhailon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- youdao-fanyi.gemspec
+- README.md
+- lib/youdao-fanyi.rb
+- lib/youdao-fanyi/config.rb
+- lib/youdao-fanyi/request.rb
+- lib/youdao-fanyi/result.rb
+homepage: https://github.com/zhhailon/youdao-fanyi
+licenses: []
+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.11
+signing_key: 
+specification_version: 3
+summary: Youdao Fanyi (Translation) API Wrapper
+test_files: []