yahoo-japanese-analysis 0.1.1

data/.gitignore

@@ -0,0 +1 @@
+credential.yaml

data/README.md

@@ -0,0 +1,32 @@
+#Yahoo Japanese Analysis Library
+
+This is Yahoo! Japan Text Analysis Wrapper for Ruby.
+See below to get more info.
+    http://developer.yahoo.co.jp/webapi/jlp/
+
+#Installation
+
+##Yahoo! Japan Developers' Network Registration
+
+You must register at http://developer.yahoo.co.jp/ .
+And you can get appid to access APIs
+
+##Installtion gem
+
+#Example
+
+see https://gist.github.com/2605666
+
+#LICENSE
+
+## The MIT License
+
+    Copyright (c) 2012 rhysd
+
+    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/lib/yahoo-japanese-analysis.rb

@@ -0,0 +1,33 @@
+require 'yahoo-japanese-analysis/client'
+require 'yahoo-japanese-analysis/version'
+
+
+#
+# YahooJA module. You can use YahooJA class methods to use
+# YahooJA::Client instance methods without instance.
+# If you want to use multi-account states, you should use
+# YahooJA::Client instance to use multi accounts.
+#
+module YahooJA
+    class << self
+
+        # override to delegate
+        def method_missing name,*args,&block
+            @client ||= YahooJA::Client.new
+            return super unless @client.respond_to? name
+            @client.send name,*args,&block
+        end
+
+        # override to delegate
+        def respond_to? name,include_private=false
+            @client ||= YahooJA::Client.new
+            @client.respond_to?(name,include_private) || super(name,include_private)
+        end
+
+        # reset client state
+        def reset
+            @client = nil
+        end
+
+    end
+end

data/lib/yahoo-japanese-analysis/client.rb

@@ -0,0 +1,32 @@
+require 'yahoo-japanese-analysis/config'
+
+module YahooJA
+
+    #
+    # Client to use Yahoo! Japan Text Analysis API.
+    #
+    class Client
+
+        include YahooJA::Config
+        attr_accessor *Config::CONFIG_KEYS
+
+        require 'yahoo-japanese-analysis/client/keyphrase'
+        include YahooJA::Client::Keyphrase
+
+        require 'yahoo-japanese-analysis/client/morpheme_analysis'
+        include YahooJA::Client::MorphemeAnalysis
+
+        require 'yahoo-japanese-analysis/client/kanji_conv'
+        include YahooJA::Client::KanjiConv
+
+        require 'yahoo-japanese-analysis/client/furigana'
+        include YahooJA::Client::Furigana
+
+        require 'yahoo-japanese-analysis/client/kousei_support'
+        include YahooJA::Client::KouseiSupport
+
+        require 'yahoo-japanese-analysis/client/kakari_uke'
+        include YahooJA::Client::KakariUke
+
+    end
+end

data/lib/yahoo-japanese-analysis/client/furigana.rb

@@ -0,0 +1,22 @@
+module YahooJA
+    class Client
+        module Furigana
+
+            require 'yahoo-japanese-analysis/service_base'
+            include YahooJA::ServiceBase
+
+            #
+            # "ルビ振り" API
+            #
+            # @args
+            #   @text text to analyze
+            #   @opts other options.
+            # @return Hash converted from XML format. more info is below.
+            # @see http://developer.yahoo.co.jp/webapi/jlp/furigana/v1/furigana.html
+            #
+            def furigana text,opts={}
+                use_service 'http://jlp.yahooapis.jp/FuriganaService/V1/furigana',self.app_key,text,opts
+            end
+        end
+    end
+end

data/lib/yahoo-japanese-analysis/client/kakari_uke.rb

@@ -0,0 +1,23 @@
+module YahooJA
+    class Client
+        module KakariUke
+
+            require 'yahoo-japanese-analysis/service_base'
+            include YahooJA::ServiceBase
+
+            #
+            # "日本語係り受け解析" API
+            #
+            # @args
+            #   @text text to analyze
+            # @return Hash converted from XML format. more info is below.
+            # @see http://developer.yahoo.co.jp/webapi/jlp/da/v1/parse.html
+            # @supplementation kakari-uke service doesn't have any option
+            #
+            def kakari_uke text
+                use_service 'http://jlp.yahooapis.jp/DAService/V1/parse',self.app_key,text
+            end
+
+        end
+    end
+end

data/lib/yahoo-japanese-analysis/client/kanji_conv.rb

@@ -0,0 +1,23 @@
+module YahooJA
+    class Client
+        module KanjiConv
+
+            require 'yahoo-japanese-analysis/service_base'
+            include YahooJA::ServiceBase
+
+            #
+            # "かな漢字変換" API
+            #
+            # @args
+            #   @text text to analyze
+            #   @opts other options.
+            # @return Hash converted from XML format. more info is below.
+            # @see http://developer.yahoo.co.jp/webapi/jlp/jim/v1/conversion.html
+            #
+            def kanji_conv text,opts={}
+                use_service 'http://jlp.yahooapis.jp/JIMService/V1/conversion',self.app_key,text,opts
+            end
+
+        end
+    end
+end

data/lib/yahoo-japanese-analysis/client/keyphrase.rb

@@ -0,0 +1,37 @@
+require 'yahoo-japanese-analysis/request'
+require 'rexml/document'
+
+module YahooJA
+    class Client
+        module Keyphrase
+            include YahooJA::Request
+
+            #
+            # "特徴語抽出" API
+            #
+            # @args
+            #   @text text to analyze
+            #   @opts other options.
+            # @return Hash( key: word, value: score )
+            # @see http://developer.yahoo.co.jp/webapi/jlp/keyphrase/v1/extract.html
+            #
+            def keyphrase text,opts={}
+                raise "appid is needed" unless self.app_key
+                params = {:sentence => text}.merge(opts) do |k,v1,v2|
+                    raise "you shouldn't set #{k} as opts. it is already set."
+                end
+                res = request 'http://jlp.yahooapis.jp/KeyphraseService/V1/extract',self.app_key,params
+                keyphrases = {}
+                doc = REXML::Document.new(res).elements['ResultSet']
+                doc.elements.each('Result') do |result|
+                    phrase = result.elements['Keyphrase'].get_text.to_s
+                    score = result.elements['Score'].get_text.to_s.to_i
+                    keyphrases[phrase] = score
+                end
+                keyphrases
+            end
+
+        end
+    end
+end
+

data/lib/yahoo-japanese-analysis/client/kousei_support.rb

@@ -0,0 +1,23 @@
+module YahooJA
+    class Client
+        module KouseiSupport
+
+            require 'yahoo-japanese-analysis/service_base'
+            include YahooJA::ServiceBase
+
+            #
+            # "校正支援" API
+            #
+            # @args
+            #   @text text to analyze
+            #   @opts other options.
+            # @return Hash converted from XML format. more info is below.
+            # @see http://developer.yahoo.co.jp/webapi/jlp/kousei/v1/kousei.html
+            #
+            def kousei_support text,opts={}
+                use_service 'http://jlp.yahooapis.jp/KouseiService/V1/kousei',self.app_key,text,opts
+            end
+
+        end
+    end
+end

data/lib/yahoo-japanese-analysis/client/morpheme_analysis.rb

@@ -0,0 +1,23 @@
+module YahooJA
+    class Client
+        module MorphemeAnalysis
+
+            require 'yahoo-japanese-analysis/service_base'
+            include YahooJA::ServiceBase
+
+            #
+            # "日本語形態素解析" API (Japanese Morpheme Analysis)
+            #
+            # @args
+            #   @text text to analyze
+            #   @opts other options.
+            # @return Hash converted from XML format. more info is below.
+            # @see http://developer.yahoo.co.jp/webapi/jlp/ma/v1/parse.html
+            #
+            def morpheme_analysis text,opts={}
+                use_service 'http://jlp.yahooapis.jp/MAService/V1/parse',self.app_key,text,opts
+            end
+
+        end
+    end
+end

data/lib/yahoo-japanese-analysis/config.rb

@@ -0,0 +1,49 @@
+module YahooJA
+
+    #
+    # Config module.
+    # You should set appid before using APIs.
+    #
+    module Config
+        DEFAULT_APP_KEY = nil
+
+        CONFIG_KEYS = [ :app_key ]
+
+        attr_accessor *CONFIG_KEYS
+
+        #
+        # set appid
+        #
+        #   YahooJA.configure do |config|
+        #       config.app_key = 'hogehoge'
+        #   end
+        #
+        #   c = YahooJA::Client.new
+        #   c.configure do |config|
+        #       config.app_key = 'hogehoge'
+        #   end
+        #
+        def configure
+            yield self
+            self
+        end
+
+        def options
+            opts = {}
+            CONFIG_KEYS.each do |k|
+                opts[k] = send k
+            end
+            opts
+        end
+
+        def self.extended base
+            base.reset
+        end
+
+        # reset config setting
+        def reset
+            self.app_key = DEFAULT_APP_KEY
+        end
+    end
+
+end

data/lib/yahoo-japanese-analysis/request.rb

@@ -0,0 +1,18 @@
+module YahooJA
+    module Request
+
+        require 'uri'
+        require 'net/http'
+
+        def request path,app_id,params={}
+            uri = URI.parse path
+            queries = 'appid='+app_id+'&'+params.map{|k,v| k.to_s+'='+v.to_s}.join('&')
+            req = Net::HTTP::Post.new uri.path
+            res = Net::HTTP.start(uri.host,uri.port) do |http|
+                http.request req, queries
+            end
+            res.body
+        end
+
+    end
+end

data/lib/yahoo-japanese-analysis/service_base.rb

@@ -0,0 +1,47 @@
+module YahooJA
+    module ServiceBase
+
+        require 'rexml/document'
+
+        require 'yahoo-japanese-analysis/request'
+        include YahooJA::Request
+
+        def use_service url,appid,text,opts={}
+            raise "appid is needed" unless appid
+            params = {:sentence => text}.merge(opts) do |k,v1,v2|
+                raise "you shouldn't set #{k} as opts. it is already set."
+            end
+            res = request url, appid, params
+
+            doc = REXML::Document.new(res)
+            xml_to_hash(REXML::Document.new(res))[:ResultSet]
+        end
+
+        private
+
+        def xml_to_hash rexml
+            xml_elem_to_hash rexml.root
+        end
+
+        def xml_elem_to_hash elem
+            value = if elem.has_elements?
+                children = {}
+                elem.each_element do |e|
+                    # children << xml_elem_to_hash(e)
+                    children.merge!(xml_elem_to_hash(e)) do |k,v1,v2|
+                        if v1.class == Array
+                            v1 << v2
+                        else
+                            [v1,v2]
+                        end
+                    end
+                end
+                children
+            else
+                elem.text
+            end
+            { elem.name.to_sym => value }
+        end
+
+    end
+end

data/lib/yahoo-japanese-analysis/version.rb

@@ -0,0 +1,27 @@
+module YahooJA
+    class Version
+        class << self
+
+            def major
+                0
+            end
+
+            def minor
+                1
+            end
+
+            def patch
+                1
+            end
+
+            def pre
+                nil
+            end
+
+            def to_s
+                [major, minor, patch, pre].compact!.join '.'
+            end
+
+        end
+    end
+end

data/test/pre_test.rb

@@ -0,0 +1,2 @@
+path = Dir.pwd+'/../lib'
+$LOAD_PATH.push path unless $LOAD_PATH.include? path

data/test/test_all.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require './pre_test.rb'
+require 'yahoo-japanese-analysis'
+require 'test/unit'
+require 'yaml'
+
+class TestBase < Test::Unit::TestCase
+
+    def setup
+        @appid = YAML.load(File.open('credential.yaml').read)['my_appid']
+        @client = YahooJA::Client.new
+    end
+
+    def test_base_client
+        assert_not_nil @client
+        assert_instance_of YahooJA::Client, @client
+        assert_respond_to @client,:configure
+        assert_respond_to @client,:options
+        assert_respond_to @client,:reset
+    end
+
+    def test_configure
+        @client.configure{|config| config.app_key = @appid}
+        assert_equal @client.app_key,@appid
+    end
+
+    def test_version
+        assert_equal YahooJA::Version.major.class,Fixnum
+        assert_equal YahooJA::Version.minor.class,Fixnum
+        assert_equal YahooJA::Version.patch.class,Fixnum
+        assert( !YahooJA::Version.pre || (YahooJA::Version.pre.class == String) )
+        assert YahooJA::Version.to_s =~ /^\d+?\.\d+?\.\d+?.*?$/
+    end
+
+    # test YahooJA class methods for lightweight-use
+    def test_gateway
+        [ :configure, :options, :reset,
+          :keyphrase, :morpheme_analysis, :furigana,
+          :kanji_conv, :kousei_support, :kakari_uke
+        ].each do |m|
+            assert YahooJA.respond_to?(m),"#{m} is missing."
+        end
+    end
+
+    require 'yahoo-japanese-analysis/service_base'
+    include YahooJA::ServiceBase
+
+    # test xml_to_hash
+    def test_service_base
+
+        xml_pairs = {}
+        xml_pairs['<result><info><title>Title1</title><data>1234</data></info><info><title>Title2</title><data>5678</data></info></result>'] = {:result=>{:info=>[{:title=>"Title1", :data=>"1234"}, {:title=>"Title2", :data=>"5678"}]}}
+        xml_pairs['<hoge></hoge>'] = {:hoge=>nil}
+        xml_pairs['<hoge><foo><bar>piyo</bar></foo></hoge>'] = {:hoge=>{:foo=>{:bar=>"piyo"}}}
+
+        # work around to test private method in block.
+        xml_to_hash_method = method(:xml_to_hash).to_proc
+        xml_pairs.each do |xml,expected|
+            rexml = REXML::Document.new xml
+            result = xml_to_hash_method.call rexml
+            assert_equal result,expected
+        end
+    end
+
+end
+
+class TestFeatures < Test::Unit::TestCase
+
+    def setup
+        @appid = YAML.load(File.open('credential.yaml').read)['my_appid']
+        @client = YahooJA::Client.new
+    end
+
+    def test_keyphrase
+        @client.configure{|config| config.app_key = @appid}
+        assert_respond_to @client,:keyphrase
+        text = "RubyやC++も良いけれど，そろそろHaskellを習得したいなぁ．"
+        result = nil
+        assert_nothing_raised{ result = @client.keyphrase text }
+        assert_not_nil result
+        assert_not_nil result['Ruby']
+        assert_not_nil result['Haskell']
+        assert_not_nil result['C']
+    end
+
+    def test_morpheme_analysis
+        @client.configure{|config| config.app_key = @appid}
+        assert_respond_to @client, :morpheme_analysis
+        text = "庭には二羽ニワトリがいる。"
+        result = nil
+        assert_nothing_raised{ result = @client.morpheme_analysis text,{:results => "ma,uniq"} }
+        assert_not_nil result
+        assert_not_nil result[:ma_result][:total_count]
+        assert_not_nil result[:ma_result][:word_list][:word].first[:surface]
+        assert_not_nil result[:uniq_result][:total_count]
+        assert_not_nil result[:uniq_result][:word_list][:word].first[:surface]
+    end
+
+    def test_furigana
+        @client.configure{|config| config.app_key = @appid}
+        assert_respond_to @client, :morpheme_analysis
+        text = "漢字かな交じり文にふりがなを振ること。"
+        result = nil
+        assert_nothing_raised{ result = @client.furigana text }
+        assert_not_nil result
+        assert_not_nil result[:Result][:WordList][:Word].first[:Surface]
+    end
+
+    def test_kanji_conv
+        @client.configure{|config| config.app_key = @appid}
+        assert_respond_to @client, :kanji_conv
+        text = "きょうはよいてんきです。"
+        result = nil
+        assert_nothing_raised{ result = @client.kanji_conv text }
+        assert_not_nil result
+        assert_not_nil result[:Result][:SegmentList][:Segment].first[:CandidateList]
+    end
+
+    def test_kousei_support
+        @client.configure{|config| config.app_key = @appid}
+        assert_respond_to @client, :kousei_support
+        text = "遙か彼方に小形飛行機が見える。"
+        result = nil
+        assert_nothing_raised{ result = @client.kousei_support text }
+        assert_not_nil result
+        assert_not_nil result[:Result].first[:ShitekiInfo]
+    end
+
+    def test_kakari_uke
+        @client.configure{|config| config.app_key = @appid}
+        assert_respond_to @client, :kakari_uke
+        text = "うちの庭には二羽鶏がいます。"
+        result = nil
+        assert_nothing_raised{ result = @client.kakari_uke text }
+        assert_not_nil result
+        assert_not_nil result[:Result][:ChunkList][:Chunk].first[:MorphemList][:Morphem].first[:Feature]
+    end
+end

data/yahoo-japanese-analysis.gemspec

@@ -0,0 +1,17 @@
+require File.expand_path '../lib/yahoo-japanese-analysis/version',__FILE__
+
+Gem::Specification.new do |s|
+    s.name                  =  'yahoo-japanese-analysis'
+    s.version               =  YahooJA::Version.to_s
+    s.date                  =  '2012-05-06'
+    s.summary               =  "Japanese Analysis API Wrapper."
+    s.description           =  "Yahoo! Japan Text Analysis API Wrapper."
+    s.authors               =  ["rhysd"]
+    s.email                 =  'lin90162@yahoo.co.jp'
+    s.require_paths         =  ['lib']
+    s.files                 =  `git ls-files`.split("\n")
+    s.test_files            =  ['test/test_all.rb']
+    s.homepage              =  'https://github.com/rhysd/yahoo-japanese-analysis'
+    s.license               =  'MIT'
+    s.required_ruby_version = '>= 1.9.2'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: yahoo-japanese-analysis
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- rhysd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-06 00:00:00.000000000 Z
+dependencies: []
+description: Yahoo! Japan Text Analysis API Wrapper.
+email: lin90162@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- lib/yahoo-japanese-analysis.rb
+- lib/yahoo-japanese-analysis/client.rb
+- lib/yahoo-japanese-analysis/client/furigana.rb
+- lib/yahoo-japanese-analysis/client/kakari_uke.rb
+- lib/yahoo-japanese-analysis/client/kanji_conv.rb
+- lib/yahoo-japanese-analysis/client/keyphrase.rb
+- lib/yahoo-japanese-analysis/client/kousei_support.rb
+- lib/yahoo-japanese-analysis/client/morpheme_analysis.rb
+- lib/yahoo-japanese-analysis/config.rb
+- lib/yahoo-japanese-analysis/request.rb
+- lib/yahoo-japanese-analysis/service_base.rb
+- lib/yahoo-japanese-analysis/version.rb
+- test/pre_test.rb
+- test/test_all.rb
+- yahoo-japanese-analysis.gemspec
+homepage: https://github.com/rhysd/yahoo-japanese-analysis
+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: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Japanese Analysis API Wrapper.
+test_files:
+- test/test_all.rb