mushikago-sdk 0.2.3 → 0.3.1

data/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.7.2
+    &mdash; Documentation by YARD 0.7.4
   
 </title>
 
@@ -94,9 +94,9 @@
 </div>
     
     <div id="footer">
-  Generated on Thu Sep  8 10:07:02 2011 by 
+  Generated on Thu Jan 26 17:19:03 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.2 (ruby-1.8.7).
+  0.7.4 (ruby-1.9.2).
 </div>
 
   </body>

data/lib/mushikago-sdk.rb

@@ -1 +1,2 @@
+# -*- coding: utf-8 -*-
 require 'mushikago'

data/lib/mushikago.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # Mushikagoサービスを提供するモジュール
 module Mushikago
   # class
@@ -7,6 +8,8 @@ module Mushikago
   autoload :Http, 'mushikago/http'
   autoload :Auth, 'mushikago/auth'
   autoload :Tombo, 'mushikago/tombo'
+  autoload :Hotaru, 'mushikago/hotaru'
+  autoload :Mitsubachi, 'mushikago/mitsubachi'
 
   # @return [Mushikago::Config] config コンフィグのインスタンスへのアクセスを提供する
   def self.config

data/lib/mushikago/auth.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 module Mushikago
   # Mushikagoサービスの認証を扱うモジュール
   module Auth

data/lib/mushikago/auth/signature.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 module Mushikago
   module Auth
     # MushikagoのリクエストにMix-inして利用する

data/lib/mushikago/auth/signer.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'base64'
 require 'openssl'
 

data/lib/mushikago/configuration.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'singleton'
 module Mushikago
   # Mushikago SDK for Rubyの各設定
@@ -7,7 +8,7 @@ module Mushikago
     # @param [Hash] options optionsをロードします
     # @option options [String] :api_key(ENV['MUSHIKAGO_API_KEY']) 発行されたAPIKeyを設定する
     # @option options [String] :secret_key(ENV['MUSHIKAGO_SECRET_KEY']) 発行されたSecretKeyを設定する
-    # @option options [String] :tombo_endpoint('tombo.mushikago.org') tomboサービスのエンドポイントを設定する
+    # @option options [String] :endpoint('api.mushikago.org') 標準のエンドポイントを設定する
     # @example
     #   Mushikago.config.load(:api_key => 'ABCDEFG', :secret_key => 'HIJKLMN')
     def load options={}
@@ -38,7 +39,7 @@ module Mushikago
     
     add_option :api_key, ENV['MUSHIKAGO_API_KEY'] || ENV['MUSHIKAGO_API_KEY_ID']
     add_option :secret_key, ENV['MUSHIKAGO_SECRET_KEY'] || ENV['MUSHIKAGO_SECRET_ACCESS_KEY']
-    add_option :tombo_endpoint, 'tombo.mushikago.org'
+    add_option :endpoint, 'api.mushikago.org'
 
     # @private
     private

data/lib/mushikago/hotaru.rb

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+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'
+
+    autoload :ListDocumentRequest, 'mushikago/hotaru/list_document_request'
+    autoload :PutDocumentRequest, 'mushikago/hotaru/put_document_request'
+    autoload :DeleteDocumentRequest, 'mushikago/hotaru/delete_document_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'
+  end
+end

data/lib/mushikago/hotaru/client.rb

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+module Mushikago
+  module Hotaru
+    # Hotaruサービスを利用する
+    #
+    # @example
+    #   client = Mushikago::Hotaru::Client.new(:api_key => '<api_key>', :secret_key => '<secret_key>')
+    #
+    #   client.capture('http://www.hotaru.ne.jp/', :thumbnail => true, :tags => ['hotaru', 'webservice'])
+    #
+    #   captures = client.captures
+    #   captures['images'].each do |image|
+    #     puts image['image_url']
+    #   end
+    #
+    # @example APIキーをファイルから読み込む場合
+    #   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 [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 タグ
+      # @example
+      #   client.capture('http://www.hotaru.ne.jp/', :thumbnail => true, :tags => ['hotaru', 'webservice'])
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def capture url, options={}
+        request = CaptureRequest.new(url, options)
+        send_request(request)
+      end
+
+      # いままでキャプチャした画像の情報を取得する
+      #
+      # @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) 取得オフセット
+      # @example
+      #   client.captures(:tag => 'webservice')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def captures options={}
+        request = CapturesRequest.new(options)
+        send_request(request)
+      end
+
+      # 指定した画像を削除する
+      #
+      # @param [String] id 画像のID
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.delete('5a6cdfa3-xxx3-47d6-8xxx-5f83af6b66cc')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def delete id, options={}
+        request = DeleteRequest.new(id, options)
+        send_request(request)
+      end
+
+      # APIの使用状況を取得する
+      #
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.info
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def info options={}
+        request = InfoRequest.new(options)
+        send_request(request)
+      end
+    end
+  end
+end

data/lib/mushikago/hotaru/request.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+module Mushikago
+  module Hotaru
+    # Hotaruのリクエストを表す抽象クラス
+    class Request < Mushikago::Http::Request
+      include Mushikago::Auth::Signature
+
+      # @param [Hash] options オプション
+      # @option options [String] :endpoint('hotaru.mushikago.org') Hotaruのエンドポイント
+      def initialize options={}
+        super()
+        endpoint = options[:endpoint] || Mushikago.config.hotaru_endpoint
+        host, port = endpoint.split(':')
+        @host = host
+        @port = port if port
+        @path = "/#{api_version}/#{method_name}"
+      end
+
+      # @private
+      private
+      def api_version
+        1
+      end
+
+      # @private
+      private
+      def method_name
+        ''
+      end
+    end
+  end
+end

data/lib/mushikago/http.rb

@@ -1,8 +1,10 @@
+# -*- coding: utf-8 -*-
 module Mushikago
   # MushikagoサービスへのHTTPリクエストを扱うモジュール
   module Http
     autoload :Client, 'mushikago/http/client'
     autoload :Request, 'mushikago/http/request'
+    autoload :MultipartRequest, 'mushikago/http/multipart_request'
     autoload :Response, 'mushikago/http/response'
   end
 end

data/lib/mushikago/http/client.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'net/http'
 require 'json'
 module Mushikago
@@ -30,7 +31,7 @@ module Mushikago
         Net::HTTP.start(request.host, request.port) do |http|
           http_request = request.to_http_request
           http_response = http.request(http_request)
-          return Mushikago::Http::Response.new(JSON.parse(http_response.body)) 
+          return Mushikago::Http::Response.new(JSON.parse(http_response.body))
         end
       end
     end

data/lib/mushikago/http/multipart_request.rb

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+require 'mime/types'
+module Mushikago
+  module Http
+    class MultipartRequest < Request
+      CR = "\015"
+      LF = "\012"
+      EOL = CR+LF
+
+      def to_http_request
+        http_request = new_http_request
+        headers.each do |key, value|
+          http_request[key] = value
+        end
+        boundary = '----------------38117'
+        http_request.set_content_type "multipart/form-data; boundary=#{boundary}"
+        http_request.body = multipart_body(boundary)
+        http_request.content_length = http_request.body.size
+        return http_request
+      end
+
+      def multipart_body boundary='boundary'
+        content = ''
+
+        files, parameters = params.partition{|k, v| v.kind_of?(File)}
+        parameters.each do |k, v|
+          content << [
+            %Q|--#{boundary}|,
+            %Q|Content-Disposition: form-data; name="#{k}"|,
+            %Q||,
+            %Q|#{v}|
+          ].join(EOL)
+          content << EOL
+        end
+
+        files.each do |k, v|
+          v.rewind
+          content_type = ''
+          begin
+            content_type = MIME::Types.of(v.path).first.to_s
+          rescue NameError => e
+          ensure
+            content_type = "application/octet-stream" if content_type.to_s.empty?
+          end
+          content << [
+            %Q|--#{boundary}|,
+            %Q|Content-Disposition: form-data; name="#{k}"; filename="#{File::basename(v.path)}"|,
+            %Q|Content-Type: "#{content_type}"|,
+            %Q||,
+            %Q|#{v.read}|
+          ].join(EOL)
+          content << EOL
+        end
+        content << EOL
+        content << %Q|--#{boundary}--|
+        content << EOL
+        return content
+      end
+    end
+  end
+end
+

data/lib/mushikago/http/request.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'net/http'
 require 'cgi'
 module Mushikago
@@ -41,7 +42,7 @@ module Mushikago
 
       # @return [String] URLエンコードされ、&で接続されたパラメータの文字列
       def url_encoded_params
-        params.sort.collect{|pp| pp.map{|p| encode p}.join('=')}.join('&')
+        params.sort.select{|p| p[1].kind_of?(String)}.collect{|pp| pp.map{|p| encode p}.join('=')}.join('&')
       end
 
       # HTTPリクエストオブジェクトに変換する
@@ -93,14 +94,16 @@ module Mushikago
         # @yieldreturn [Object] 変換された値
         # @example
         #   add_param :price do |v| v.to_i end
-        def add_param name, &transform
+        def add_param name, options={}, &transform
           attr_accessor name
           define_method("#{name}=") do |value|
+            value = value || options[:default]
             value = transform ? transform.call(value) : value
             self[name.to_s] = value
             instance_variable_set("@#{name}".to_sym, value)
           end
         end
+        alias request_parameter add_param
       end
     end
   end

data/lib/mushikago/http/response.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 module Mushikago
   module Http
     # Mushikagoサービスのレスポンスを扱うクラス

data/lib/mushikago/mitsubachi.rb

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+module Mushikago
+  module Mitsubachi
+    autoload :Client, 'mushikago/mitsubachi/client'
+    autoload :Request, 'mushikago/mitsubachi/request'
+    autoload :MultipartRequest, 'mushikago/mitsubachi/multipart_request'
+
+    # project
+    autoload :ProjectCreateRequest, 'mushikago/mitsubachi/project_create_request'
+    autoload :ProjectListRequest, 'mushikago/mitsubachi/project_list_request'
+    autoload :ProjectInfoRequest, 'mushikago/mitsubachi/project_info_request'
+    autoload :ProjectQueuesRequest, 'mushikago/mitsubachi/project_queues_request'
+    autoload :ProjectDeleteRequest, 'mushikago/mitsubachi/project_delete_request'
+    autoload :ProjectUpdateRequest, 'mushikago/mitsubachi/project_update_request'
+    autoload :ProjectDiscontinueRequest, 'mushikago/mitsubachi/project_discontinue_request'
+    # http
+    autoload :HttpFetchRequest, 'mushikago/mitsubachi/http_fetch_request'
+    autoload :HttpPushRequest, 'mushikago/mitsubachi/http_push_request'
+
+    # script
+    autoload :ScriptDeployRequest, 'mushikago/mitsubachi/script_deploy_request'
+    autoload :ScriptGetRequest, 'mushikago/mitsubachi/script_get_request'
+    autoload :ScriptListRequest, 'mushikago/mitsubachi/script_list_request'
+    autoload :ScriptDeleteRequest, 'mushikago/mitsubachi/script_delete_request'
+
+    # resource
+    autoload :ResourceStoreRequest, 'mushikago/mitsubachi/resource_store_request'
+    autoload :ResourceGetRequest, 'mushikago/mitsubachi/resource_get_request'
+    autoload :ResourceListRequest, 'mushikago/mitsubachi/resource_list_request'
+    autoload :ResourceDeleteRequest, 'mushikago/mitsubachi/resource_delete_request'
+  end
+end
+

data/lib/mushikago/mitsubachi/client.rb

@@ -0,0 +1,256 @@
+# -*- coding: utf-8 -*-
+module Mushikago
+  module Mitsubachi
+    # Mitsubachiサービスを利用する
+    #
+    # @example
+    #   client = Mushikago::Mitsubachi::Client.new(:api_key => '<api_key>', :secret_key => '<secret_key>')
+    #
+    #   client.project_create('project01')
+    #   client.script_deploy('project01', 'sample.rb', 'sample.rb')
+    #   client.http_fetch('project01', 'http://www.mushikago.org/', 'sample.rb')
+    #
+    # @example APIキーをファイルから読み込む場合
+    #   Mushikago.config.load(YAML.load(File.read('config.yml')))
+    #   client = Mushikago::Mitsubachi::Client.new
+    class Client < Mushikago::Http::Client
+      # TODO project/createの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.project_create('project01', :stdout => true)
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def project_create project_name, options={}
+        request = ProjectCreateRequest.new(project_name, options)
+        send_request(request)
+      end
+
+      # TODO project/listの説明
+      #
+      # @param [Hash] options リクエストのオプション
+      # @option options [Integer] :limit
+      # @option options [Integer] :offset
+      # @option options [String] :filter
+      # @example
+      #   client.project_list
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def project_list options={}
+        request = ProjectListRequest.new(options)
+        send_request(request)
+      end
+
+      # TODO project/infoの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.project_info('project01')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def project_info project_name, options={}
+        request = ProjectInfoRequest.new(project_name, options)
+        send_request(request)
+      end
+
+      # TODO project/queuesの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.project_queues('project01')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def project_queues project_name, options={}
+        request = ProjectQueuesRequest.new(project_name, options)
+        send_request(request)
+      end
+
+      # TODO project/deleteの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.project_delete('project01')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def project_delete project_name, options={}
+        request = ProjectDeleteRequest.new(project_name, options)
+        send_request(request)
+      end
+
+      # TODO project/updateの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.project_update('project01', :stdout => false)
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def project_update project_name, options={}
+        request = ProjectUpdateRequest.new(project_name, options)
+        send_request(request)
+      end
+
+      # TODO project/discontinueの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.project_discontinue('project01')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def project_discontinue project_name, options={}
+        request = ProjectDiscontinueRequest.new(project_name, options)
+        send_request(request)
+      end
+
+      # TODO http/fetchの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [String] url クロール対象のURL
+      # @param [String] script_name スクレイピングスクリプトのパス
+      # @param [Hash] options リクエストのオプション
+      # @option options [String] :method('GET') HTTPリクエストメソッド
+      # @option options [String] :entity_parameter
+      # @option options [Boolean] :follow_redirect
+      # @option options [String] :parameters
+      # @option options [String] :header_overwrite
+      # @example
+      #   client.http_fetch('project01', 'http://www.tombo.ne.jp/', 'sample.rb', :follow_redirect => true)
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def http_fetch project_name, url, script_name, options={}
+        request = HttpFetchRequest.new(project_name, url, script_name, options)
+        send_request(request)
+      end
+
+      # TODO http/pushの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [String] url クロール対象のURL
+      # @param [String] script_name スクレイピングスクリプトのパス
+      # @param [String] file_name
+      # @param [String] file_input_key
+      # @param [Hash] options リクエストのオプション
+      # @option options [String] :entity_parameter
+      # @option options [String] :parameters
+      # @option options [String] :header_overwrite
+      # @option options [String] :mime_type
+      # @example
+      #   client.http_push('project01', 'http://www.tombo.ne.jp/', 'sample.rb')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def http_push project_name, url, script_name, file_name, file_input_key, options={}
+        request = HttpPushRequest.new(project_name, url, script_name, file_name, file_input_key, options)
+        send_request(request)
+      end
+
+      # TODO script/deployの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [String of File] file_or_file_name デプロイするファイルオブジェクトもしくはファイルパス
+      # @param [Hash] options リクエストのオプション
+      # @option options [String] script_name デプロイ先のファイル名
+      # @example
+      #   client.script_deploy('project01', 'sample.rb', :script_name => 'hoge.rb')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def script_deploy project_name, file_or_file_name, options={}
+        request = ScriptDeployRequest.new(project_name, file_or_file_name, options)
+        send_request(request)
+      end
+
+      # TODO script/listの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [Hash] options リクエストのオプション
+      # @option options [Integer] :limit
+      # @option options [Integer] :offset
+      # @option options [String] :filter
+      # @example
+      #   client.script_list('project01')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def script_list project_name, options={}
+        request = ScriptListRequest.new(project_name, options)
+        send_request(request)
+      end
+
+      # TODO script/getの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [String] script_name デプロイ先のファイル名
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.script_get('project01', 'sample.rb')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def script_get project_name, script_name, options={}
+        request = ScriptGetRequest.new(project_name, script_name, options)
+        send_request(request)
+      end
+
+      # TODO script/deleteの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [String] script_name デプロイ先のファイル名
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.script_delete('project01', 'sample.rb')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def script_delete project_name, script_name, options={}
+        request = ScriptDeleteRequest.new(project_name, script_name, options)
+        send_request(request)
+      end
+
+      # TODO resource/storeの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [String of File] file_or_file_name デプロイするファイルオブジェクトもしくはファイルパス
+      # @param [Hash] options リクエストのオプション
+      # @option options [String] :file_name デプロイ先のファイル名
+      # @option options [String] :content_type
+      # @option options [public] :public
+      # @example
+      #   client.resource_store('project01', 'sample.csv',)
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def resource_store project_name, file_or_file_name, options={}
+        request = ResourceStoreRequest.new(project_name, file_or_file_name, options)
+        send_request(request)
+      end
+
+      # TODO resource/listの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [Hash] options リクエストのオプション
+      # @option options [Integer] :limit
+      # @option options [Integer] :offset
+      # @option options [String] :filter
+      # @example
+      #   client.resource_list('project01')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def resource_list project_name, options={}
+        request = ResourceListRequest.new(project_name, options)
+        send_request(request)
+      end
+
+      # TODO resource/getの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [String] file_name 保存先のファイル名
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.resource_get('project01', 'sample.rb')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def resource_get project_name, file_name, options={}
+        request = ResourceGetRequest.new(project_name, file_name, options)
+        send_request(request)
+      end
+
+      # TODO resource/deleteの説明
+      #
+      # @param [String] project_name プロジェクト名
+      # @param [String] file_name 保存先のファイル名
+      # @param [Hash] options リクエストのオプション
+      # @example
+      #   client.resource_delete('project01', 'sample.rb')
+      # @return [Mushikago::Http::Response] リクエストの結果
+      def resource_delete project_name, file_name, options={}
+        request = ResourceDeleteRequest.new(project_name, file_name, options)
+        send_request(request)
+      end
+    end
+  end
+end
+