mushikago-sdk 0.3.7 → 0.4.0

data/doc/top-level-namespace.html

@@ -94,7 +94,7 @@
 </div>
     
     <div id="footer">
-  Generated on Wed Feb  1 14:15:31 2012 by 
+  Generated on Mon Feb 20 09:55:35 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.4 (ruby-1.9.2).
 </div>

data/lib/mushikago/hotaru.rb

@@ -3,20 +3,43 @@ module Mushikago
   # Hotaruへのアクセスを行うモジュール
   module Hotaru
     autoload :Client, 'mushikago/hotaru/client'
-    autoload :Request, 'mushikago/hotaru/request'
 
-    autoload :ListDomainRequest, 'mushikago/hotaru/list_domain_request'
-    autoload :CreateDomainRequest, 'mushikago/hotaru/create_domain_request'
-    autoload :DeleteDomainRequest, 'mushikago/hotaru/delete_domain_request'
+    # domain
+    autoload :DomainCreateRequest, 'mushikago/hotaru/domain_create_request'
+    autoload :DomainInfoRequest, 'mushikago/hotaru/domain_info_request'
+    autoload :DomainListRequest, 'mushikago/hotaru/domain_list_request'
+    autoload :DomainDeleteRequest, 'mushikago/hotaru/domain_delete_request'
 
-    autoload :ListDocumentRequest, 'mushikago/hotaru/list_document_request'
-    autoload :PutDocumentRequest, 'mushikago/hotaru/put_document_request'
-    autoload :DeleteDocumentRequest, 'mushikago/hotaru/delete_document_request'
+    # text
+    autoload :TextListRequest, 'mushikago/hotaru/text_list_request'
+    autoload :TextPutRequest, 'mushikago/hotaru/text_put_request'
+    autoload :TextDeleteRequest, 'mushikago/hotaru/text_delete_request'
+    autoload :TextTagsetRequest, 'mushikago/hotaru/text_tagset_request'
+    autoload :TextGetRequest, 'mushikago/hotaru/text_get_request'
 
-    autoload :ListCollocationRequest, 'mushikago/hotaru/list_collocation_request'
-    autoload :BuildCollocationRequest, 'mushikago/hotaru/build_collocation_request'
-    autoload :SearchCollocationRequest, 'mushikago/hotaru/search_collocation_request'
-    autoload :DeleteCollocationRequest, 'mushikago/hotaru/delete_collocation_request'
-    autoload :GetCollocationGraphRequest, 'mushikago/hotaru/get_collocation_graph_request'
+    # classifier
+    autoload :ClassifierJudgeRequest, 'mushikago/hotaru/classifier_judge_request'
+
+    # collocation
+    autoload :CollocationListRequest, 'mushikago/hotaru/collocation_list_request'
+    autoload :CollocationDeleteRequest, 'mushikago/hotaru/collocation_delete_request'
+    autoload :CollocationGetRequest, 'mushikago/hotaru/collocation_get_request'
+    autoload :CollocationCreateRequest, 'mushikago/hotaru/collocation_create_request'
+    autoload :CollocationDownloadRequest, 'mushikago/hotaru/collocation_download_request'
+    autoload :CollocationWordlistRequest, 'mushikago/hotaru/collocation_wordlist_request'
+
+    # tag
+    autoload :TagPutRequest, 'mushikago/hotaru/tag_put_request'
+    autoload :TagDeleteRequest, 'mushikago/hotaru/tag_delete_request'
+    autoload :TagListRequest, 'mushikago/hotaru/tag_list_request'
+
+    # word
+    autoload :WordListRequest, 'mushikago/hotaru/word_list_request'
+    autoload :WordGetRequest, 'mushikago/hotaru/word_get_request'
+
+    # dictionary
+    autoload :DictionaryPutRequest, 'mushikago/hotaru/dictionary_put_request'
+    autoload :DictionaryListRequest, 'mushikago/hotaru/dictionary_list_request'
+    autoload :DictionaryDeleteRequest, 'mushikago/hotaru/dictionary_delete_request'
   end
 end

data/lib/mushikago/hotaru/classifier_judge_request.rb

@@ -0,0 +1,16 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hotaru
+    class ClassifierJudgeRequest < Mushikago::Http::PostRequest
+      def path; '/1/hotaru/classifier/judge' end
+      request_parameter :domain_name
+      request_parameter :text
+
+      def initialize domain_name, text, options={}
+        super(options)
+        self.domain_name = domain_name
+        self.text = text
+      end
+    end
+  end
+end

data/lib/mushikago/hotaru/client.rb

@@ -17,58 +17,356 @@ module Mushikago
     #   Mushikago.config.load(YAML.load(File.read('config.yml')))
     #   client = Mushikago::Hotaru::Client.new
     class Client < Mushikago::Http::Client
-      # 指定したURLのキャプチャを取得する
+      # ドメインを作成する
       #
-      # @param [String] url キャプチャ対象のURL
+      # @param [String] domain_name ドメイン名
+      # @param [String] splitter スプリッター
       # @param [Hash] options リクエストのオプション
-      # @option options [String] :image_format('jpg') 画像のフォーマット(jpg,png)
-      # @option options [Integer] :image_quality(80) 画像の品質(0-100)
-      # @option options [Boolean] :thumbnail(0) サムネイル取得フラグ(false:取得しない,true:取得する)
-      # @option options [String,Array] :tags タグ
+      # @option options [String] :description ドメインの説明
+      # @option options [String,Array] :dictionary_ids ユーザ辞書のID
+      # @option options [String,Array] :tags ドメイン内で使用するタグ
       # @example
-      #   client.capture('http://www.hotaru.ne.jp/', :thumbnail => true, :tags => ['hotaru', 'webservice'])
+      #   client.domain_create('sample_domain', '2gram')
       # @return [Mushikago::Http::Response] リクエストの結果
-      def capture url, options={}
-        request = CaptureRequest.new(url, options)
+      def domain_create domain_name, splitter, options={}
+        request = Hotaru::DomainCreateRequest.new(domain_name, splitter, options)
         send_request(request)
       end
 
-      # いままでキャプチャした画像の情報を取得する
+      # ドメインの情報を参照する
       #
+      # @param [String] domain_name ドメイン名
       # @param [Hash] options リクエストのオプション
-      # @option options [String] :id 画像のID
-      # @option options [String] :domain 指定したドメインの画像一覧を取得する
-      # @option options [String] :tag 指定したタグの画像一覧を取得する
-      # @option options [Integer] :limit(10) 最大取得件数(1-100)
-      # @option options [Integer] :offset(0) 取得オフセット
+      # @option options [Integer] :time
       # @example
-      #   client.captures(:tag => 'webservice')
+      #   client.domain_info('sample_domain')
       # @return [Mushikago::Http::Response] リクエストの結果
-      def captures options={}
-        request = CapturesRequest.new(options)
+      def domain_info domain_name, options={}
+        request = Hotaru::DomainInfoRequest.new(domain_name, options)
         send_request(request)
       end
 
-      # 指定した画像を削除する
+      # ドメインの一覧を取得する
       #
-      # @param [String] id 画像のID
       # @param [Hash] options リクエストのオプション
+      # @option options [Integer] :limit
+      # @option options [Integer] :offset
+      # @option options [String] :filter
       # @example
-      #   client.delete('5a6cdfa3-xxx3-47d6-8xxx-5f83af6b66cc')
+      #   client.domain_list
       # @return [Mushikago::Http::Response] リクエストの結果
-      def delete id, options={}
-        request = DeleteRequest.new(id, options)
+      def domain_list options={}
+        request = Hotaru::DomainListRequest.new(options)
         send_request(request)
       end
 
-      # APIの使用状況を取得する
+      # ドメインを削除する
       #
+      # @param [String] domain_name ドメイン名
       # @param [Hash] options リクエストのオプション
       # @example
-      #   client.info
+      #   client.domain_delete 'sample_domain'
       # @return [Mushikago::Http::Response] リクエストの結果
-      def info options={}
-        request = InfoRequest.new(options)
+      def domain_delete domain_name, options={}
+        request = Hotaru::DomainDeleteRequest.new(domain_name, options)
+        send_request(request)
+      end
+
+      # テキストを登録する 
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] text テキスト
+      # @param [String] tags タグ
+      # @param [Hash] options リクエストのオプション
+      # @option options [String] :text_name テキストにつける名前
+      # @example
+      #   client.text_put 'sample_domain', '吾輩は猫である。名前はまだない。....', ['夏目漱石'], :text_name => '吾輩は猫である'
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def text_put domain_name, text, tags, options={}
+        request = Hotaru::TextPutRequest.new(domain_name, text, tags, options)
+        send_request(request)
+      end
+
+      # テキストを削除する 
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] text_id テキストID
+      # @param [Hash] options リクエストのオプション
+      # @option options [String] :forcedelete textを強制的に削除する場合true
+      # @example
+      #   client.text_delete 'sample_domain', 'text_id'
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def text_delete domain_name, text_id, options={}
+        request = Hotaru::TextDeleteRequest.new(domain_name, text_id, options)
+        send_request(request)
+      end
+
+      # テキストにヒモ付たタグの追加更新
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] text_id テキストID
+      # @param [String,Array] tags タグ
+      # @param [Hash] options リクエストのオプション
+      # @option options [String] :replace tagを追加する場合false, 入れ替える場合true
+      # @example
+      #   client.text_tagset 'sample_domain', 'text_id', ['hoge']
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def text_tagset domain_name, text_id, tags, options={}
+        request = Hotaru::TextTagsetRequest.new(domain_name, text_id, tags, options)
+        send_request(request)
+      end
+
+      # テキストを取得する 
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] text_id テキストID
+      # @param [Hash] options リクエストのオプション
+      # @option options [Boolean] :with_body trueを指定すると、response['body']でファイルの内容にアクセスすることができるようになります。
+      # @example
+      #   client.text_get 'sample_domain', 'text_id'
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def text_get domain_name, text_id, options={}
+        request = Hotaru::TextGetRequest.new(domain_name, text_id, options)
+        result = send_request(request)
+        if options[:with_body]
+          begin
+            uri = URI.parse(result['url'])
+            result['body'] = Net::HTTP.get(uri.host, uri.request_uri)
+          rescue
+          end
+        end
+        return result
+      end
+
+      # テキスト一覧を取得する
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [Hash] options リクエストのオプション
+      # @option options [Integer] :limit
+      # @option options [Integer] :offset
+      # @option options [String] :filter
+      # @option options [String,Array] :tags
+      # @option options [String] :status
+      # @example
+      #   client.text_list('sample_domain')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def text_list domain_name, options={}
+        request = Hotaru::TextListRequest.new(domain_name, options)
+        send_request(request)
+      end
+
+      # 指定されたtextにふさわしいtagを返す
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] text text
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.classifier_judge
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def classifier_judge domain_name, text, options={}
+        request = Hotaru::ClassifierJudgeRequest.new(domain_name, text, options)
+        send_request(request)
+      end
+
+      # 共起グラフを作成する
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String,Array] tags タグ
+      # @param [Hash] options リクエストのオプション
+      # @option options [String,Array] :parts_of_speech 共起を取る単語の品詞
+      # @option options [String] :collocation_name 共起グラフにつける名前
+      # @option options [String] :lower_threshold 単語の出現数下限
+      # @option options [String] :upper_threshold 単語の出現数上限
+      # @option options [String] :description 共起グラフの説明
+      # @example
+      #   client.collocation_create('sample_domain', ['tag1', 'tag2'])
+      #   client.collocation_create('sample_domain', 'tag1', :parts_of_speech => Mushikago::Hotaru::CollocationCreateRequest::POS_LARGE)
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def collocation_create domain_name, tags, options={}
+        request = Hotaru::CollocationCreateRequest.new(domain_name, tags, options)
+        send_request(request)
+      end
+
+      # 共起グラフ一覧を取得する
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [Hash] options リクエストのオプション
+      # @option options [Integer] :limit
+      # @option options [Integer] :offset
+      # @option options [String] :filter
+      # @option options [String] :status
+      # @example
+      #   client.collocation_list('sample_domain')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def collocation_list domain_name, options={}
+        request = Hotaru::CollocationListRequest.new(domain_name, options)
+        send_request(request)
+      end
+
+      # 共起グラフを削除する
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] collocation_id 共起ID
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.collocation_delete('sample_domain', 'c12345')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def collocation_delete domain_name, collocation_id, options={}
+        request = Hotaru::CollocationDeleteRequest.new(domain_name, collocation_id, options)
+        send_request(request)
+      end
+
+      # 共起語を取得する
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] collocation_id 共起ID
+      # @param [String] word 共起語を取得したい単語
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.collocation_get('sample_domain', 'c12345', '我輩')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def collocation_get domain_name, collocation_id, word, options={}
+        request = Hotaru::CollocationGetRequest.new(domain_name, collocation_id, word, options)
+        send_request(request)
+      end
+
+      # 共起グラフ内の単語一覧を取得する
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] collocation_id 共起ID
+      # @param [Hash] options リクエストのオプション
+      # @option options [Integer] :limit
+      # @option options [Integer] :offset
+      # @option options [String] :filter
+      # @example
+      #   client.collocation_wordlist('sample_domain', 'c12345')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def collocation_wordlist domain_name, collocation_id, options={}
+        request = Hotaru::CollocationWordlistRequest.new(domain_name, collocation_id, options)
+        send_request(request)
+      end
+
+      # 共起グラフをダウンロードする
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] collocation_id 共起ID
+      # @param [Hash] options リクエストのオプション
+      # @option options [Boolean] :with_body trueを指定すると、response['body']でファイルの内容にアクセスすることができるようになります。
+      # @example
+      #   client.collocation_download('sample_domain', 'c12345')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def collocation_download domain_name, collocation_id, options={}
+        request = Hotaru::CollocationDownloadRequest.new(domain_name, collocation_id, options)
+        result = send_request(request)
+        if options[:with_body]
+          begin
+            uri = URI.parse(result['url'])
+            result['body'] = Net::HTTP.get(uri.host, uri.request_uri)
+          rescue
+          end
+        end
+        return result
+      end
+
+      # ドメインにタグを登録する
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] tag タグ
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.tag_put('sample_domain', 'tag1')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def tag_put domain_name, tag, options={}
+        request = Hotaru::TagPutRequest.new(domain_name, tag, options)
+        send_request(request)
+      end
+
+      # ドメインに登録されているタグを削除する
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] tag タグ
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.tag_delete('sample_domain', 'tag1')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def tag_delete domain_name, tag, options={}
+        request = Hotaru::TagDeleteRequest.new(domain_name, tag, options)
+        send_request(request)
+      end
+
+      # ドメイン内のタグ一覧を取得する
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [Hash] options リクエストのオプション
+      # @option options [String] :filter
+      # @example
+      #   client.tag_list('sample_domain')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def tag_list domain_name, options={}
+        request = Hotaru::TagListRequest.new(domain_name, options)
+        send_request(request)
+      end
+
+      # 単語の一覧を取得する
+      #
+      # @param [Hash] options リクエストのオプション
+      # @param [String] domain_name ドメイン名
+      # @option options [Integer] :limit
+      # @option options [Integer] :offset
+      # @option options [String] :filter
+      # @example
+      #   client.word_list 'sample_domain'
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def word_list domain_name, options={}
+        request = Hotaru::WordListRequest.new(domain_name, options)
+        send_request(request)
+      end
+
+      # 指定した単語の詳細な情報を返す
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] word
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.word_get('sample_domain', '我輩')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def word_get domain_name, word, options={}
+        request = Hotaru::WordGetRequest.new(domain_name, word, options)
+        send_request(request)
+      end
+
+      # 辞書を登録する 
+      #
+      # @param [String,File] dictionary_file 辞書ファイル
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.dictionary_put 'custom.csv', :dictionary_name => 'mushikago用語'
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def dictionary_put dictionary_file, options={}
+        request = Hotaru::DictionaryPutRequest.new(dictionary_file, options)
+        send_request(request)
+      end
+
+      # 辞書の一覧を取得する 
+      #
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.dictionary_list
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def dictionary_list options={}
+        request = Hotaru::DictionaryListRequest.new(options)
+        send_request(request)
+      end
+
+      # 辞書を削除する 
+      #
+      # @param [String] dictionary_id 辞書ID
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.dictionary_delete('dicid')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def dictionary_delete dictionary_id, options={}
+        request = Hotaru::DictionaryDeleteRequest.new(dictionary_id, options)
         send_request(request)
       end
     end