mushikago-sdk 0.4.3 → 2.0.0

data/README.md

@@ -5,7 +5,7 @@ Mushikago SDK for Ruby.
 - **Author**:          Toru Matsuoka
 - **Copyright**:       2011
 - **License**:         Apache License, Version 2.0
-- **Latest Version**:  0.4.0
+- **Latest Version**:  1.3-beta
 - **Release Date**:    January 27th 2012
 
 
@@ -153,6 +153,8 @@ $ export MUSHIKAGO_SECRET_KEY=<シークレットキー>
 変更履歴
 --------
 
+- **May.23.12**: 1.3-beta release
+  - haanmgriのベータサポート
 - **Feb.20.12**: 0.4.2 release
   - tomboのcaptureオプション「delay_time」に対応
 - **Feb.20.12**: 0.4.0 release

data/Rakefile

@@ -2,6 +2,7 @@ $:.unshift File.expand_path('../lib', __FILE__)
 require 'rubygems'
 require 'bundler'
 Bundler.setup :default, :test, :development
+require 'ci/reporter/rake/rspec'
 
 Bundler::GemHelper.install_tasks
 

data/lib/mushikago/hanamgri/client.rb

@@ -0,0 +1,264 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    # Hanamgriサービスを利用する
+    #
+    # @example
+    #   client = Mushikago::Hanamgri::Client.new(:api_key => '<api_key>', :secret_key => '<secret_key>')
+    #
+    # @example APIキーをファイルから読み込む場合
+    #   Mushikago.config.load(YAML.load(File.read('config.yml')))
+    #   client = Mushikago::Hanamgri::Client.new
+    class Client < Mushikago::Http::Client
+      # ドメインを新規作成する
+      #
+      # @example
+      #   schema = Mushikago::Hanamgri::Schema.new do
+      #     add Mushikago::Hanamgri::Field.new('name', true, :string)
+      #     add Mushikago::Hanamgri::Field.new('price', true, :number)
+      #     add {:name => 'shipping', :required => true, :type => :number, :knowledge_name => 'mushikago/ec/shipping'} # <= Hashでも追加できます
+      #   end
+      #   client.create_domain('ec', '税込', schema)
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] seeds 初期キーワード
+      # @param [String] schema スキーマ
+      # @param [Hash] options オプション
+      # @option options [String] :description ドメインの説明
+      # @option options [String] :dictionary_name 初期辞書
+      def create_domain domain_name, seeds, schema, options={}
+        request = Hanamgri::CreateDomainRequest.new(domain_name, seeds, schema, options)
+        send_request(request)
+      end
+      
+      # ドメインを削除する
+      #
+      # @example
+      #   client.delete_domain('ec')
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [Hash] options オプション
+      # @option options [String] :description ドメインの説明
+      def delete_domain domain_name, options={}
+        request = Hanamgri::DeleteDomainRequest.new(domain_name, options)
+        send_request(request)
+      end
+      
+      # 解析リクエストを送信する
+      #
+      # @example
+      #   client.request_analysis('ec', 'http://shop.example.com/')
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] url 解析対象URL
+      # @param [Hash] options オプション
+      # @option options [String] :charset 解析対象ページ文字コード
+      # @option options [String] :tag 解析結果識別用タグ
+      # @option options [String] :auto_feedback 解析のみ。もしくは解析と学習を行う
+      def request_analysis domain_name, url, options={}
+        request = Hanamgri::RequestAnalysisRequest.new(domain_name, url, options)
+        send_request(request)
+      end
+
+      # 解析結果を取得する
+      #
+      # @example
+      #    client.get_analysis('ec', 'xxxxxx-xxxxxx-xxxxxx')
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] request_id 解析リクエストID
+      # @param [Hash] options リクエストのオプション
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def get_analysis domain_name, request_id, options={}
+        request = Hanamgri::GetAnalysisRequest.new(domain_name, request_id, options)
+        send_request(request)
+      end
+
+      # ドメイン内の残タスク数を取得する
+      #
+      # @example
+      #    ret = client.get_queue_size('ec')
+      #    puts ret['queue_size']
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [Hash] options リクエストのオプション
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def get_queue_size domain_name, options={}
+        request = Hanamgri::GetQueueSizeRequest.new(domain_name, options)
+        send_request(request)
+      end
+
+      # ドメインの情報を取得する
+      #
+      # @example
+      #    client.get_information('ec')
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [Hash] options リクエストのオプション
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def get_information domain_name, options={}
+        request = Hanamgri::GetInformationRequest.new(domain_name, options)
+        send_request(request)
+      end
+
+      # ドメインの一覧を取得する
+      #
+      # @example
+      #    client.list_domains(20, 10, 'ec')
+      #
+      # @param [Hash] options リクエストのオプション
+      # @option options [Integer] : limit 最大取得件数
+      # @option options [Integer] : offset 開始位置
+      # @option options [String] : filter 検索文字（先頭一致）
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def list_domains options={}
+        request = Hanamgri::GetListDomainsRequest.new(options)
+        send_request(request)
+      end
+
+      # ドメインの情報を更新する
+      #
+      # @example
+      #    client.update_domain('ec', 'updateDescription')
+      #
+      # @param [Hash] options リクエストのオプション
+      # @option options [String] : domain_name ドメイン名
+      # @option options [String] : description ドメインの説明文
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def update_domain domain_name, description, options={}
+        request = Hanamgri::UpdateDomainRequest.new(domain_name, description, options)
+        send_request(request)
+      end
+
+      # 解析結果の一覧を取得する
+      #
+      # @example
+      #    client.list_analyses('ec', {:limit => '20', :offset => '5', :status => 'complete'})
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [Hash] options リクエストのオプション
+      # @option options [Integer] : limit 最大取得件数
+      # @option options [Integer] : offset 開始位置
+      # @option options [String] : filter 検索文字
+      # @option options [String] : status 解析の状態
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def list_analyses domain_name, options={}
+        request = Hanamgri::GetListAnalysesRequest.new(domain_name, options)
+        send_request(request)
+      end
+      
+      # 解析結果を検索する
+      #
+      # @example
+      #    client.search_schema('ec', 'name', 'something', {:limit => '20', :offset => '5'})
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] query_key 検索対象のフィールド名
+      # @param [String] query_value 検索対象のフィールド値
+      # @option options [Integer] : limit 最大取得件数
+      # @option options [Integer] : offset 開始位置
+      # @return [Mushikagp::Http::Response] リクエストの結果
+      def search_schema domain_name, query_key, query_value, options={}
+        request = Hanamgri::SearchSchemaRequest.new(domain_name, query_key, query_value, options)
+        send_request(request)
+      end
+
+      # 解析結果を検索する
+      #
+      # @example
+      #   training_data = Mushikago::Hanamgri::TrainingData.new do
+      #     put('name', 'mushikago')
+      #   end
+      #   client.train('ec', 'http://www.mushikago.org/', training_data)   # URLを指定する例
+      #   client.train('ec', '<div>hello mushikago</div>', training_data)  # HTML文字列を指定する例
+      #   client.train('ec', File.read('./mushikago.html'), training_data) # HTMLをファイルから読み込んで指定する例
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [String] url_or_html 学習対象のURLもしくはHTML文字列
+      # @param [Mushikago::Hanamgri::TrainingData] training_data 学習データ
+      # @return [Mushikagp::Http::Response] リクエストの結果
+      def train domain_name, url_or_html, training_data, options={}
+        request = Hanamgri::TrainRequest.new(domain_name, url_or_html, training_data, options)
+        send_request(request)
+      end
+
+      # 辞書を保存する
+      #
+      # @example
+      #   client.save_dictionary('ec', {:description => '辞書の説明'})
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [Hash] options オプション
+      # @option options [String] :description 辞書の説明
+      def save_dictionary domain_name, options={}
+        request = Hanamgri::SaveDictionaryRequest.new(domain_name, options)
+        send_request(request)
+      end
+
+      # 辞書の一覧を取得する
+      #
+      # @example
+      #    client.list_dictionaries(20, 10)
+      #
+      # @param [Hash] options リクエストのオプション
+      # @option options [Integer] : limit 最大取得件数
+      # @option options [Integer] : offset 開始位置
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def list_dictionaries options={}
+        request = Hanamgri::ListDictionariesRequest.new(options)
+        send_request(request)
+      end
+      
+      # 辞書の情報を削除する
+      #
+      # @example
+      #    client.delete_dictionary('ec-UUID')
+      #
+      # @param [String] dictionary_name 辞書名
+      def delete_dictionary dictionary_name, options={}
+        request = Hanamgri::DeleteDictionaryRequest.new(dictionary_name,options)
+        send_request(request)
+      end
+
+      # 学習データを保存する
+      #
+      # @example
+      #   client.save_knowledge('ec', {:description => '学習データの説明'})
+      #
+      # @param [String] domain_name ドメイン名
+      # @param [Hash] options オプション
+      # @option options [String] :description 学習データの説明
+      def save_knowledge domain_name, options={}
+        request = Hanamgri::SaveKnowledgeRequest.new(domain_name, options)
+        send_request(request)
+      end
+
+      # 学習データの一覧を取得する
+      #
+      # @example
+      #    client.list_knowledges(20, 10, 'complete')
+      #
+      # @param [Hash] options リクエストのオプション
+      # @option options [Integer] : limit 最大取得件数
+      # @option options [Integer] : offset 開始位置
+      # @option options [String] : status 学習データ保存の進捗状況
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def list_knowledges options={}
+        request = Hanamgri::ListKnowledgesRequest.new(options)
+        send_request(request)
+      end
+      
+      # 学習データの情報を削除する
+      #
+      # @example
+      #    client.delete_knowledge('ec/price-UUID')
+      #
+      # @param [String] knowledge_name 学習データ名
+      def delete_knowledge knowledge_name, options={}
+        request = Hanamgri::DeleteKnowledgeRequest.new(knowledge_name,options)
+        send_request(request)
+      end
+
+    end
+  end
+end

data/lib/mushikago/hanamgri/create_domain_request.rb

@@ -0,0 +1,25 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class CreateDomainRequest < Mushikago::Http::PutRequest
+      def path; "/1/hanamgri/domains/#{domain_name}" end
+      attr_accessor :domain_name
+      request_parameter :seeds
+      request_parameter :schema do |s| s.to_json end
+      request_parameter :dictionary_name
+      request_parameter :description
+
+      def initialize domain_name, seeds, schema, options={}
+        super(options)
+        raise unless schema.kind_of? Mushikago::Hanamgri::Schema
+        self.domain_name = domain_name
+        self.seeds = seeds
+        self.schema = schema
+        self.description = options[:description] if options.has_key?(:description)
+        self.dictionary_name = options[:dictionary_name] if options.has_key?(:dictionary_name)
+      end
+    end
+  end
+end
+
+

data/lib/mushikago/hanamgri/delete_dictionary_request.rb

@@ -0,0 +1,14 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class DeleteDictionaryRequest < Mushikago::Http::DeleteRequest
+      def path; "/1/hanamgri/dictionary" end
+      request_parameter :dictionary_name
+      
+      def initialize dictionary_name, options={}
+        super(options)
+        self.dictionary_name = dictionary_name
+      end
+    end
+  end
+end

data/lib/mushikago/hanamgri/delete_domain_request.rb

@@ -0,0 +1,16 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class DeleteDomainRequest < Mushikago::Http::DeleteRequest
+      def path; "/1/hanamgri/domains/#{domain_name}" end
+      attr_accessor :domain_name
+
+      def initialize domain_name, options={}
+        super(options)
+        self.domain_name = domain_name
+      end
+    end
+  end
+end
+
+

data/lib/mushikago/hanamgri/delete_knowledge_request.rb

@@ -0,0 +1,15 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class DeleteKnowledgeRequest < Mushikago::Http::DeleteRequest
+      def path; "/1/hanamgri/knowledge" end
+      request_parameter :knowledge_name
+      
+      def initialize knowledge_name, options={}
+        super(options)
+        raise 'Unsupported Operation.'
+        self.knowledge_name = knowledge_name
+      end
+    end
+  end
+end

data/lib/mushikago/hanamgri/field.rb

@@ -0,0 +1,20 @@
+# -*- coding : utf-8 -*-
+require 'json'
+module Mushikago
+  module Hanamgri
+    class Field < Struct.new(:name, :required, :type, :knowledge_name)
+      def validate!
+        raise "Invalid Type Value [#{type}]" unless [:string, :number].include?(type)
+      end
+
+      def required?
+        !!required
+      end
+
+      def to_json *args
+        {:name => name.to_s, :required => required?, :type => type}.to_json(args)
+      end
+    end
+  end
+end
+

data/lib/mushikago/hanamgri/get_analysis_request.rb

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class GetAnalysisRequest < Mushikago::Http::GetRequest
+      def path; "/1/hanamgri/domains/#{domain_name}/analyses/#{request_id}" end
+      attr_accessor :domain_name
+      attr_accessor :request_id
+      
+      def initialize domain_name, request_id, options={}
+        super(options)
+        self.domain_name = domain_name
+        self.request_id = request_id
+      end
+    end
+  end
+end

data/lib/mushikago/hanamgri/get_information_request.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class GetInformationRequest < Mushikago::Http::GetRequest
+      def path; "/1/hanamgri/domains/#{domain_name}" end
+      attr_accessor :domain_name
+      
+      def initialize domain_name, options={}
+        super(options)
+        self.domain_name = domain_name
+      end
+    end
+  end
+end

data/lib/mushikago/hanamgri/get_queue_size_request.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class GetQueueSizeRequest < Mushikago::Http::GetRequest
+      def path; "/1/hanamgri/domains/#{domain_name}/queues" end
+      attr_accessor :domain_name
+      
+      def initialize domain_name, options={}
+        super(options)
+        self.domain_name = domain_name
+      end
+    end
+  end
+end

data/lib/mushikago/hanamgri/list_analyses_request.rb

@@ -0,0 +1,24 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class GetListAnalysesRequest < Mushikago::Http::GetRequest
+      def path; "/1/hanamgri/domains/#{domain_name}/analyses" end
+      attr_accessor :domain_name
+      request_parameter :limit
+      request_parameter :offset
+      request_parameter :filter
+      request_parameter :status
+
+      def initialize domain_name, options={}
+        super(options)
+        self.domain_name = domain_name
+        self.limit = options[:limit] if options.has_key?(:limit)
+        self.offset = options[:offset] if options.has_key?(:offset)
+        self.filter = options[:filter] if options.has_key?(:filter)
+        self.status = options[:status] if options.has_key?(:status)
+      end
+    end
+  end
+end
+
+

data/lib/mushikago/hanamgri/list_dictionaries_request.rb

@@ -0,0 +1,17 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class ListDictionariesRequest < Mushikago::Http::GetRequest
+      def path; "/1/hanamgri/dictionaries" end
+      request_parameter :limit
+      request_parameter :offset
+
+      def initialize options={}
+        super(options)
+        self.limit = options[:limit] if options.has_key?(:limit)
+        self.offset = options[:offset] if options.has_key?(:offset)
+      end
+    end
+  end
+end
+

data/lib/mushikago/hanamgri/list_domains_request.rb

@@ -0,0 +1,20 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class GetListDomainsRequest < Mushikago::Http::GetRequest
+      def path; "/1/hanamgri/domains" end
+      request_parameter :limit
+      request_parameter :offset
+      request_parameter :filter
+
+      def initialize options={}
+        super(options)
+        self.limit = options[:limit] if options.has_key?(:limit)
+        self.offset = options[:offset] if options.has_key?(:offset)
+        self.filter = options[:filter] if options.has_key?(:filter)
+      end
+    end
+  end
+end
+
+

data/lib/mushikago/hanamgri/list_knowledges_request.rb

@@ -0,0 +1,20 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class ListKnowledgesRequest < Mushikago::Http::GetRequest
+      def path; "/1/hanamgri/knowledges" end
+      request_parameter :limit
+      request_parameter :offset
+      request_parameter :status
+
+      def initialize options={}
+        super(options)
+        raise 'Unsupported Operation.'
+        self.limit = options[:limit] if options.has_key?(:limit)
+        self.offset = options[:offset] if options.has_key?(:offset)
+        self.status = options[:status] if options.has_key?(:status)
+      end
+    end
+  end
+end
+

data/lib/mushikago/hanamgri/request_analysis_request.rb

@@ -0,0 +1,21 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class RequestAnalysisRequest < Mushikago::Http::PutRequest
+      def path; "/1/hanamgri/domains/#{domain_name}/analysis" end
+      attr_accessor :domain_name
+      request_parameter :url
+      request_parameter :charset
+      request_parameter :tag
+      request_parameter :auto_feedback
+      def initialize domain_name, url, options={}
+        super(options)
+        self.domain_name = domain_name
+        self.url = url
+        self.charset = options[:charset] if options.has_key?(:charset)
+        self.tag = options[:tag] if options.has_key?(:tag)
+        self.tag = options[:auto_feedback] if options.has_key?(:auto_feedback)
+      end
+    end
+  end
+end

data/lib/mushikago/hanamgri/save_dictionary_request.rb

@@ -0,0 +1,18 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class SaveDictionaryRequest < Mushikago::Http::PutRequest
+      def path; "/1/hanamgri/dictionary" end
+      request_parameter :domain_name
+      request_parameter :description
+
+      def initialize domain_name, options={}
+        super(options)
+        self.domain_name = domain_name
+        self.description = options[:description] if options.has_key?(:description)
+      end
+    end
+  end
+end
+
+

data/lib/mushikago/hanamgri/save_knowledge_request.rb

@@ -0,0 +1,19 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class SaveKnowledgeRequest < Mushikago::Http::PutRequest
+      def path; "/1/hanamgri/knowledge" end
+      request_parameter :domain_name
+      request_parameter :description
+
+      def initialize domain_name, options={}
+        super(options)
+        raise 'Unsupported Operation.'
+        self.domain_name = domain_name
+        self.description = options[:description] if options.has_key?(:description)
+      end
+    end
+  end
+end
+
+

data/lib/mushikago/hanamgri/schema.rb

@@ -0,0 +1,28 @@
+# -*- coding : utf-8 -*-
+require 'json'
+module Mushikago
+  module Hanamgri
+    class Schema
+      attr_reader :fields
+      
+      def initialize(&block)
+        @fields = []
+        instance_eval(&block) if block_given?
+      end
+      
+      def add field_or_hash
+        field = field_or_hash
+        if field.kind_of?(Hash)
+          field = Mushikago::Hanamgri::Field.new(field[:name], field[:required], field[:type], field[:knowledge_name])
+        end
+        field.validate!
+        @fields << field
+      end
+
+      def to_json *args
+        {:fields => @fields}.to_json(args)
+      end
+    end
+  end
+end
+

data/lib/mushikago/hanamgri/search_schema_request.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class SearchSchemaRequest < Mushikago::Http::GetRequest
+      def path; "/1/hanamgri/domains/#{domain_name}/schema/search" end
+      attr_accessor :domain_name
+      attr_accessor :query_key
+      attr_accessor :query_value
+      
+      def initialize domain_name, query_key, query_value, options={}
+        super(options)
+        raise 'Unsupported Operation.'
+        self.domain_name = domain_name
+        self.query_key = query_key
+        self.query_value = query_value
+      end
+    end
+  end
+end

data/lib/mushikago/hanamgri/train_request.rb

@@ -0,0 +1,21 @@
+# -*- coding : utf-8 -*-
+module Mushikago
+  module Hanamgri
+    class TrainRequest < Mushikago::Http::PostRequest
+      def path; "/1/hanamgri/domains/#{domain_name}/train" end
+      attr_accessor :domain_name
+      request_parameter :url_or_html
+      request_parameter :training_data do |s| s.to_json end
+
+      def initialize domain_name, url_or_html, training_data, options={}
+        super(options)
+        raise unless training_data.kind_of? Mushikago::Hanamgri::TrainingData
+        self.domain_name = domain_name
+        self.url_or_html = url_or_html
+        self.training_data = training_data
+      end
+    end
+  end
+end
+
+