crown 0.0.11 → 0.1.0

data/lib/crown/buzzurl.rb

@@ -3,7 +3,7 @@
 #
 #  buzzurl.rb
 #
-#  Copyright (c) 2008 - 2011, clown.
+#  Copyright (c) 2008 - 2012, clown.
 #
 #  Redistribution and use in source and binary forms, with or without
 #  modification, are permitted provided that the following conditions
@@ -32,42 +32,29 @@
 #
 # --------------------------------------------------------------------------- #
 module Crown
-    module Buzzurl
-        require 'cgi'
-        require 'net/http'
-        require 'crown/http'
-        require 'rubygems'
-        require 'json'
-        Net::HTTP.version_1_2
+    class Buzzurl
+        require 'crown/buzzurl/counter'
         
         # ------------------------------------------------------------------- #
         #
-        #  count
+        #  Buzzurl.count
         #
-        #  uri に指定したページのブックマーク数を取得する．
+        #  指定した URL のブックマーク数を取得する．
         #
         # ------------------------------------------------------------------- #
-        def count(uri, proxy_host = nil, proxy_port = nil)
-            begin
-                session = Net::HTTP.new('api.buzzurl.jp', 80, proxy_host, proxy_port)
-                path = '/api/counter/v1/json?url=' + CGI.escape(uri)
-                result = Crown::HTTP.get(session, path)
-                return 0 if (result == nil || result.code.to_i != 200)
-                
-                json = JSON.parse(result.body)
-                json.each { |elem|
-                    return elem['users'].to_i
-                }
-            rescue Exception
-                return 0
-            end
-            
-            return 0
+        def Buzzurl.count(uri, options = nil)
+            return Crown::Buzzurl::BookmarkCounter.new.count(uri, options)
         end
         
         # ------------------------------------------------------------------- #
-        #  module functions
+        #
+        #  count
+        #
+        #  指定した URL のブックマーク数を取得する．
+        #
         # ------------------------------------------------------------------- #
-        module_function :count
+        def count(uri, options = nil)
+            return Crown::Buzzurl::BookmarkCounter.new.count(uri, options)
+        end
     end # Buzzurl
 end # Crown

data/lib/crown/buzzurl/counter.rb

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+# --------------------------------------------------------------------------- #
+#
+#  buzzurl/counter.rb
+#
+#  Copyright (c) 2008 - 2012, clown.
+#
+#  Redistribution and use in source and binary forms, with or without
+#  modification, are permitted provided that the following conditions
+#  are met:
+#
+#    - Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#    - Redistributions in binary form must reproduce the above copyright
+#      notice, this list of conditions and the following disclaimer in the
+#      documentation and/or other materials provided with the distribution.
+#    - No names of its contributors may be used to endorse or promote
+#      products derived from this software without specific prior written
+#      permission.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+#  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+#  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+#  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# --------------------------------------------------------------------------- #
+module Crown
+    class Buzzurl
+        # --------------------------------------------------------------- #
+        #
+        #  BookmarkCounter
+        #
+        #  指定した URL のブックマーク数を取得するクラス．
+        #
+        # --------------------------------------------------------------- #
+        class BookmarkCounter
+            require 'cgi'
+            require 'crown/cgm/countable'
+            require 'rubygems'
+            require 'json'
+            
+            # --------------------------------------------------------------- #
+            #  Mix-in modules
+            # --------------------------------------------------------------- #
+            include Crown::CGM::Countable
+            
+        private
+            # --------------------------------------------------------------- #
+            #  address
+            # --------------------------------------------------------------- #
+            def address()
+                return 'api.buzzurl.jp'
+            end
+            
+            # --------------------------------------------------------------- #
+            #  path
+            # --------------------------------------------------------------- #
+            def path()
+                return '/api/counter/v1/json'
+            end
+            
+            # --------------------------------------------------------------- #
+            #  query
+            # --------------------------------------------------------------- #
+            def query(uri, options)
+                return '?url=' + CGI.escape(uri)
+            end
+            
+            # --------------------------------------------------------------- #
+            #  parse
+            # --------------------------------------------------------------- #
+            def parse(body)
+                json = JSON.parse(body)
+                json.each { |elem|
+                    return elem['users'].to_i
+                }
+                return error_value()
+            end
+        end # BookmarkCounter
+    end # Buzzurl
+end # Crown

data/lib/crown/cgm.rb

@@ -0,0 +1,98 @@
+# -*- coding: utf-8 -*-
+# --------------------------------------------------------------------------- #
+#
+#  cgm.rb
+#
+#  Copyright (c) 2008 - 2012, clown.
+#
+#  Redistribution and use in source and binary forms, with or without
+#  modification, are permitted provided that the following conditions
+#  are met:
+#
+#    - Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#    - Redistributions in binary form must reproduce the above copyright
+#      notice, this list of conditions and the following disclaimer in the
+#      documentation and/or other materials provided with the distribution.
+#    - No names of its contributors may be used to endorse or promote
+#      products derived from this software without specific prior written
+#      permission.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+#  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+#  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+#  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# --------------------------------------------------------------------------- #
+module Crown
+    module CGM
+        require 'crown/twitter'
+        require 'crown/topsy'
+        require 'crown/tweetmeme'
+        require 'crown/backtype'
+        require 'crown/facebook'
+        require 'crown/hatena/bookmark'
+        require 'crown/livedoor/clip'
+        require 'crown/livedoor/reader'
+        require 'crown/delicious'
+        require 'crown/buzzurl'
+        require 'crown/yahoo/bookmark'
+        
+        # ------------------------------------------------------------------- #
+        #
+        #  proxy
+        #
+        #  シンボルを利用して目的の CGM の API へアクセスするための
+        #  Abstract Factory メソッド．実装されている CGM は以下の通り:
+        #
+        #  - Twitter
+        #    http://twitter.com/
+        #  - Topsy (Twitter のりツイート数カウントサービス)
+        #    http://topsy.com/
+        #  - TweetMeme (同上)
+        #    http://tweetmeme.com/
+        #  - BackType (BackTweets, 同上，要 API key)
+        #    http://backtweets.com/
+        #  - Facebook
+        #    http://www.facebook.com/
+        #  - はてなブックマーク
+        #    http://b.hatena.ne.jp/
+        #  - Livedoor クリップ
+        #    http://clip.livedoor.com/
+        #  - Livedoor Reader
+        #    http://reader.livedoor.com/
+        #  - Delicious
+        #    http://delicious.com/
+        #  - Buzzurl
+        #    http://buzzurl.jp/
+        #  - Yahoo! ブックマーク
+        #    http://bookmarks.yahoo.co.jp/
+        #
+        # ------------------------------------------------------------------- #
+        def proxy(service)
+            case service
+            when :twitter_user    then return Crown::Twitter::User.new
+            when :twitter_uri     then return Crown::Twitter::URI.new
+            when :topsy           then return Crown::Topsy.new
+            when :tweetmeme       then return Crown::TweetMeme.new
+            when :backtype        then return Crown::BackType.new
+            when :facebook        then return Crown::Facebook.new
+            when :hatena_bookmark then return Crown::Hatena::Bookmark.new
+            when :livedoor_clip   then return Crown::Livedoor::Clip.new
+            when :livedoor_reader then return Crown::Livedoor::Reader.new
+            when :delicious       then return Crown::Delicious.new
+            when :buzzurl         then return Crown::Buzzurl.new
+            when :yahoo_bookmark  then return Crown::Yahoo::Bookmark.new
+            else return nil
+            end
+        end
+        module_function :proxy
+    end # CGM
+end # Crown

data/lib/crown/cgm/countable.rb

@@ -0,0 +1,130 @@
+# -*- coding: utf-8 -*-
+# --------------------------------------------------------------------------- #
+#
+#  cgm/countable.rb
+#
+#  Copyright (c) 2008 - 2012, clown.
+#
+#  Redistribution and use in source and binary forms, with or without
+#  modification, are permitted provided that the following conditions
+#  are met:
+#
+#    - Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#    - Redistributions in binary form must reproduce the above copyright
+#      notice, this list of conditions and the following disclaimer in the
+#      documentation and/or other materials provided with the distribution.
+#    - No names of its contributors may be used to endorse or promote
+#      products derived from this software without specific prior written
+#      permission.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+#  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+#  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+#  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# --------------------------------------------------------------------------- #
+module Crown
+    module CGM
+        # ------------------------------------------------------------------- #
+        #
+        #  Countable
+        #
+        #  はてなブックマークのブックマーク数や Twitter のツイート数の
+        #  ように，ある URL に対して何らかのカウント値を API 経由で提供
+        #  している CGM 用の Mix-in.
+        #
+        # ------------------------------------------------------------------- #
+        module Countable
+            require 'crown/http-wrapper'
+            
+            # --------------------------------------------------------------- #
+            #
+            #  address
+            #
+            #  カウント値を取得する API のドメインを返すメソッド．
+            #  インクルードしたクラスが再定義する必要がある．
+            #
+            # --------------------------------------------------------------- #
+            def address()
+                return 'example.com'
+            end
+            
+            # --------------------------------------------------------------- #
+            #
+            #  port
+            #
+            #  カウント値を取得する API のポート番号を返すメソッド．
+            #  多くの場合は標準の HTTP 通信（ポート番号 80）で通信が行われる
+            #  ので，必要な場合のみ再定義する．
+            #
+            # --------------------------------------------------------------- #
+            def port()
+                return 80
+            end
+            
+            # --------------------------------------------------------------- #
+            #  path
+            # --------------------------------------------------------------- #
+            def path()
+                return '/'
+            end
+            
+            # --------------------------------------------------------------- #
+            #  query
+            # --------------------------------------------------------------- #
+            def query(uri, options)
+                return uri
+            end
+            
+            # --------------------------------------------------------------- #
+            #  parse
+            # --------------------------------------------------------------- #
+            def parse(body)
+                return error_value()
+            end
+            
+            # --------------------------------------------------------------- #
+            #
+            #  error_value
+            #
+            #  何らかの理由で指定した CGM からカウント値が取得できなかった
+            #  場合に返す値を定義するためのメソッド．
+            #
+            # --------------------------------------------------------------- #
+            def error_value()
+                return -1
+            end
+            
+            # --------------------------------------------------------------- #
+            #  count
+            # --------------------------------------------------------------- #
+            def count(uri, options = nil)
+                begin
+                    proxy_addr = nil
+                    proxy_port = nil
+                    if (options.class == Hash)
+                        proxy_addr = options[:proxy_address] if (options.has_key?(:proxy_address))
+                        proxy_port = options[:proxy_port] if (options.has_key?(:proxy_port))
+                    end
+                    
+                    Crown::HTTPWrapper.start(address(), port(), proxy_addr, proxy_port) { |session|
+                        str = path() + query(uri, options)
+                        response = session.get(str)
+                        return error_value() if (response == nil || response.code.to_i != 200)
+                        return parse(response.body)
+                    }
+                rescue Exception => e
+                    return error_value()
+                end
+            end
+        end # Countable
+    end # CGM
+end # Crown

data/lib/crown/cgm/summarizable.rb

@@ -0,0 +1,130 @@
+# -*- coding: utf-8 -*-
+# --------------------------------------------------------------------------- #
+#
+#  cgm/summarizable.rb
+#
+#  Copyright (c) 2008 - 2012, clown.
+#
+#  Redistribution and use in source and binary forms, with or without
+#  modification, are permitted provided that the following conditions
+#  are met:
+#
+#    - Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#    - Redistributions in binary form must reproduce the above copyright
+#      notice, this list of conditions and the following disclaimer in the
+#      documentation and/or other materials provided with the distribution.
+#    - No names of its contributors may be used to endorse or promote
+#      products derived from this software without specific prior written
+#      permission.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+#  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+#  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+#  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# --------------------------------------------------------------------------- #
+module Crown
+    module CGM
+        # ------------------------------------------------------------------- #
+        #
+        #  Countable
+        #
+        #  �͂Ăȃu�b�N�}�[�N�̃u�b�N�}�[�N���� Twitter �̃c�C�[�g����
+        #  �悤�ɁC���� URL �ɑ΂��ĉ��炩�̃J�E���g�l�� API �o�R�Œ�
+        #  ������ CGM �p�� Mix-in.
+        #
+        # ------------------------------------------------------------------- #
+        module Summarizable
+            require 'crown/http-wrapper'
+            
+            # --------------------------------------------------------------- #
+            #
+            #  address
+            #
+            #  API �̃h���C����Ԃ����\�b�h�D
+            #  �C���N���[�h�����N���X���Ē�`����K�v������D
+            #
+            # --------------------------------------------------------------- #
+            def address()
+                return 'example.com'
+            end
+            
+            # --------------------------------------------------------------- #
+            #
+            #  port
+            #
+            #  API �̃|�[�g�ԍ���Ԃ����\�b�h�D
+            #  �����̏ꍇ�͕W���� HTTP �ʐM�i�|�[�g�ԍ� 80�j�ŒʐM���s����
+            #  �̂ŁC�K�v�ȏꍇ�̂ݍĒ�`����D
+            #
+            # --------------------------------------------------------------- #
+            def port()
+                return 80
+            end
+            
+            # --------------------------------------------------------------- #
+            #  path
+            # --------------------------------------------------------------- #
+            def path()
+                return '/'
+            end
+            
+            # --------------------------------------------------------------- #
+            #  query
+            # --------------------------------------------------------------- #
+            def query(uri, options)
+                return uri
+            end
+            
+            # --------------------------------------------------------------- #
+            #  parse
+            # --------------------------------------------------------------- #
+            def parse(body)
+                return error_value()
+            end
+            
+            # --------------------------------------------------------------- #
+            #
+            #  error_value
+            #
+            #  ���炩�̗��R�Ŏw�肵�� CGM ����J�E���g�l���擾�ł��Ȃ�����
+            #  �ꍇ�ɕԂ��l���`���邽�߂̃��\�b�h�D
+            #
+            # --------------------------------------------------------------- #
+            def error_value()
+                return nil
+            end
+            
+            # --------------------------------------------------------------- #
+            #  summary
+            # --------------------------------------------------------------- #
+            def summary(uri, options = nil)
+                begin
+                    proxy_addr = nil
+                    proxy_port = nil
+                    if (options.class == Hash)
+                        proxy_addr = options[:proxy_address] if (options.has_key?(:proxy_address))
+                        proxy_port = options[:proxy_port] if (options.has_key?(:proxy_port))
+                    end
+                    
+                    Crown::HTTPWrapper.start(address(), port(), proxy_addr, proxy_port) { |session|
+                        str = path() + query(uri, options)
+                        response = session.get(str)
+                        return error_value() if (response == nil || response.code.to_i != 200)
+                        return parse(response.body)
+                    }
+                rescue Exception => e
+                    return error_value()
+                end
+            end
+        end # Summarizable
+    end # CGM
+end # Crown