mushikago-sdk 0.1.4 → 0.1.5

data/lib/mushikago/configuration.rb

@@ -1,5 +1,6 @@
 require 'singleton'
 module Mushikago
+  # Mushikago SDK for Rubyの各設定
   class Config
     include Singleton
 
@@ -39,6 +40,7 @@ module Mushikago
     add_option :secret_key, ENV['MUSHIKAGO_SECRET_KEY'] || ENV['MUSHIKAGO_SECRET_ACCESS_KEY']
     add_option :tombo_endpoint, 'tombo.mushikago.org'
 
+    # @private
     private
     def supplied
       @supplied ||= {}

data/lib/mushikago/http/client.rb

@@ -2,6 +2,7 @@ require 'net/http'
 require 'json'
 module Mushikago
   module Http
+    # Mushikagoサービスに接続するクライアント
     class Client
       # @return [String] api_key
       attr_reader :api_key

data/lib/mushikago/http/request.rb

@@ -2,6 +2,7 @@ require 'net/http'
 require 'cgi'
 module Mushikago
   module Http
+    # MushikagoサービスのHTTPリクエストを表すクラス
     class Request
       # @return [Hash] headers
       attr_reader :headers
@@ -25,19 +26,26 @@ module Mushikago
         @http_method = new_http_request.method
       end
 
+      # @param [String] key パラメータのキー
+      # @param [String] value パラメータの値
       def set_param key, value
         params[key] = value
       end
 
+      # @param [String] key パラメータのキー
+      # @return [String] パラメータの値
       def get_param key
         param = params.detect{|p| p[0] == key}
         param ? param[1] : nil
       end
 
+      # @return [String] URLエンコードされ、&で接続されたパラメータの文字列
       def url_encoded_params
         params.sort.collect{|pp| pp.map{|p| encode p}.join('=')}.join('&')
       end
 
+      # HTTPリクエストオブジェクトに変換する
+      # @return [Net::HTTPRequest] HTTPリクエスト
       def to_http_request
         http_request = new_http_request
         headers.each do |key, value|
@@ -47,17 +55,29 @@ module Mushikago
         return http_request
       end
 
+      # @private
+      # @return [Net::HTTPRequest] HTTPリクエスト
       protected
       def new_http_request
         Net::HTTP::Get.new("#{path}?#{url_encoded_params}")
       end
 
+      # URLエンコードされた文字列を取得する
+      # @private
+      # @param [String] s URLエンコード対象の文字列
+      # @return [String] URLエンコードされた文字列
       private
       def encode s
         CGI.escape(s).gsub('+', '%20')
       end
 
       class << self
+        # リクエストパラメータへのアクセサを定義する
+        # @param [String] name パラメータ名
+        # @yield [value] アクセサを通して渡された値を変換するブロック
+        # @yieldreturn [Object] 変換された値
+        # @example
+        #   add_param :price do |v| v.to_i end
         def add_param name, &transform
           attr_accessor name
           define_method("#{name}=") do |value|

data/lib/mushikago/tombo/capture_request.rb

@@ -1,6 +1,9 @@
 module Mushikago
   module Tombo
+    # キャプチャリクエスト
     class CaptureRequest < Request
+      def method_name; 'capture.json' end
+
       add_param :url
       add_param :image_format
       add_param :image_quality do |v| v.to_i.to_s end
@@ -20,10 +23,10 @@ module Mushikago
         self.image_quality = options[:image_quality] if options.has_key?(:image_quality)
         self.thumbnail = options[:thumbnail] if options.has_key?(:thumbnail)
         self.tags = options[:tags] if options.has_key?(:tags)
-        @path = "/#{api_version}/capture.json"
         @headers['Content-type'] = 'application/x-www-form-urlencoded; charset=utf-8'
       end
 
+      # @private
       def new_http_request
         Net::HTTP::Post.new(path)
       end

data/lib/mushikago/tombo/captures_request.rb

@@ -1,6 +1,9 @@
 module Mushikago
   module Tombo
+    # キャプチャ一覧取得リクエスト
     class CapturesRequest < Request
+      def method_name; 'captures.json' end
+
       add_param :id
       add_param :limit
       add_param :offset
@@ -20,7 +23,6 @@ module Mushikago
         self.offset = options[:offset] if options.has_key?(:offset)
         self.domain = options[:domain] if options.has_key?(:domain)
         self.tag = options[:tag] if options.has_key?(:tag)
-        @path = "/#{api_version}/captures.json"
       end
     end
   end

data/lib/mushikago/tombo/delete_request.rb

@@ -1,6 +1,9 @@
 module Mushikago
   module Tombo
+    # Deleteリクエスト
     class DeleteRequest < Request
+      def method_name; 'delete.json' end
+
       add_param :id
 
       # @param [String] id 画像のID
@@ -8,9 +11,9 @@ module Mushikago
       def initialize id, options={}
         super(options)
         self.id = id
-        @path = "/#{api_version}/delete.json"
       end
 
+      # @private
       def new_http_request
         Net::HTTP::Delete.new("#{path}?#{url_encoded_params}")
       end

data/lib/mushikago/tombo/info_request.rb

@@ -1,10 +1,12 @@
 module Mushikago
   module Tombo
+    # API使用状況取得リクエスト
     class InfoRequest < Request
+      def method_name; 'info.json' end
+
       # @param [Hash] options リクエストのオプション 
       def initialize options={}
         super(options)
-        @path = "/#{api_version}/info.json"
       end
     end
   end

data/lib/mushikago/tombo/request.rb

@@ -1,19 +1,31 @@
 module Mushikago
   module Tombo
+    # Tomboのリクエストを表す抽象クラス
     class Request < Mushikago::Http::Request
       include Mushikago::Auth::Signature
 
+      # @param [Hash] options オプション
+      # @option options [String] :endpoint('tombo.mushikago.org') Tomboのエンドポイント
       def initialize options={}
         super()
         endpoint = options[:endpoint] || Mushikago.config.tombo_endpoint
         host, port = endpoint.split(':')
-        self.host = host
-        self.port = port if port
+        @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/version.rb

@@ -1,3 +1,4 @@
 module Mushikago
-  VERSION = '0.1.4'
+  # Mushikago SDK for Ruby のバージョン
+  VERSION = '0.1.5'
 end

data/spec/mushikago/http/request_spec.rb

@@ -1,5 +1,11 @@
 require 'spec_helper'
 
+class SampleRequest < Mushikago::Http::Request
+  add_param :sample1
+  add_param :sample2 do |v| v.to_i end
+  add_param :sample3 do |v| 'sample3' end
+end
+
 describe Mushikago::Http::Request do
   before :all do
     @request = Mushikago::Http::Request.new
@@ -38,5 +44,23 @@ describe Mushikago::Http::Request do
     subject{ @request.to_http_request }
     it{ should be_a_kind_of(Net::HTTPRequest) }
   end
+
+  context 'extend with add_param' do
+    before :all do
+      @request = SampleRequest.new
+      @request.sample1 = 'hoge'
+      @request.sample2 = '20'
+      @request.sample3 = 'fuga'
+    end
+
+    subject{ @request }
+
+    it{ should respond_to(:sample1, :sample1=) }
+    it{ should respond_to(:sample2, :sample2=) }
+
+    it{ subject.sample1.should == 'hoge' }
+    it{ subject.sample2.should == 20 }
+    it{ subject.sample3.should == 'sample3' }
+  end
 end
 

data/spec/mushikago/tombo/request_spec.rb

@@ -7,8 +7,6 @@ describe Mushikago::Tombo::Request do
 
   subject{ @request }
 
-  it{ should respond_to(:api_version) }
-  it{ subject.api_version.should == 1 }
   it{ subject.host.should == Mushikago.config.tombo_endpoint }
 
   context 'construct with options' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mushikago-sdk
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Toru Matsuoka