ws-aboutme 0.5.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Aboutme webservice API client Development Team
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,30 @@
+= WebService::Aboutme - Aboutme web service API client
+
+== SYNOPSIS
+
+  require 'rubygems'
+  require 'webservice/aboutme'
+
+  client = WebService::Aboutme::API.new
+
+  # look up users with nickname 'aboutme'
+  response = client.search_user(:nickname => 'aboutme')
+  response.users.each do |user|
+    # display information of this user or something...
+  end
+
+== NOTES
+
+See http://webservice.nifty.com/aboutme/ for WebAPI documentation.
+
+== Installation
+
+  sudo gem install ws-aboutme
+
+== License
+
+WebService::Aboutme is released under the MIT license.
+
+== Authors
+
+SAWADA Tadashi <moc.liamg.cesare+ws-aboutme@gmail.com>

data/Rakefile

@@ -0,0 +1,62 @@
+# -*- mode: ruby; coding: utf-8 -*-
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(File.join(dir, "lib"))
+
+require 'webservice/aboutme/version'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'ws-aboutme'
+  s.version          = WebService::Aboutme::Version.to_version
+  s.author           = 'SAWADA Tadashi'
+  s.email            = 'moc.liamg.cesare+ws-aboutme@gmail.com'
+  s.platform         = Gem::Platform::RUBY
+  s.summary          = 'API client Library for @nifty Aboutme web service'
+
+  files = FileList["{test,lib,examples,doc}/**/*"].exclude("doc/rdoc").to_a
+  files |= ['Rakefile', 'MIT-LICENSE']
+  s.files            = files
+
+  s.require_path     = 'lib'
+  s.has_rdoc         = true
+  s.rdoc_options     = ['--charset', 'UTF-8', '--main', 'README']
+  s.extra_rdoc_files = ['README']
+
+  s.required_ruby_version = ">= 1.8.2"
+end
+
+if $0 == __FILE__
+  Gem::manage_gems
+  Gem::Builder.new(spec).build
+end
+
+task :default => ['clean', 'clobber', 'test', 'rdoc', 'package']
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar_gz  = true
+  pkg.need_tar_bz2 = true
+  pkg.need_zip     = true
+end
+
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/tc_*.rb']
+  t.verbose = true
+end
+
+
+Rake::RDocTask.new('rdoc') do |t|
+  t.rdoc_dir = 'doc/rdoc'
+  t.rdoc_files.include('README', 'lib/**/*.rb')
+  t.main = 'README'
+  t.title = 'WebService::Aboutme Documentation'
+end

data/lib/webservice/aboutme.rb

@@ -0,0 +1,32 @@
+#--
+# Copyright (c) 2007 Aboutme webservice API client Development Team
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+module WebService # :nodoc:
+  module Aboutme  # :nodoc:
+  end
+end
+
+$KCODE = 'u'
+require 'jcode'
+
+require 'webservice/aboutme/api'

data/lib/webservice/aboutme/api.rb

@@ -0,0 +1,505 @@
+require 'date'
+require 'net/http'
+require 'uri'
+require 'rexml/document'
+
+require 'webservice/aboutme/xmlobjectmapping'
+require 'webservice/aboutme/version'
+
+module WebService #:nodoc:
+  module Aboutme #:nodoc:
+
+    REQUEST_URI_BASE = URI.parse('http://api.aboutme.jp/api/v1/')
+
+    DEFAULT_OPEN_TIMEOUT = 10
+    DEFAULT_READ_TIMEOUT = 20
+
+    class API
+
+      attr_accessor :config
+
+      # Takes initialization parameters or a block to override default setttings.
+      # You can pass parameters like this,
+      #   client = WebService::Aboutme::API.new(
+      #              :open_timeout => 5,
+      #              :read_timeout => 7,
+      #            )
+      # or, override default parameters with a block,
+      #   client = WebService::Aboutme::API.new do |c|
+      #      c.open_timeout = 5
+      #      c.read_timeout = 7
+      #   end
+      #
+      # Or, just call new with no argument to create default instance.
+      #   client = WebService::Aboutme::API.new
+      #
+      # See Config class for further information.
+      #
+      def initialize(args = {}, &block)
+        uri = REQUEST_URI_BASE
+        @config = Config.new do |c|
+          c.request_path_base = uri.path
+          c.request_domain = args[:request_domain] || REQUEST_URI_BASE.host
+          c.request_port   = args[:request_port]   || REQUEST_URI_BASE.port
+          c.open_timeout = args[:open_timeout] || DEFAULT_OPEN_TIMEOUT
+          c.read_timeout = args[:read_timeout] || DEFAULT_READ_TIMEOUT
+          c.user_agent = "Aboutme API client for Ruby ver-#{Version.to_version}"
+        end
+
+        if block_given?
+          block.call @config
+        end
+      end
+
+      def request(request_class, response_class, params = {})
+        req = request_class.new(@config)
+        response = req.request(params)
+        xml = REXML::Document.new(response.body)
+        response_class.unmarshal(xml.root)
+      end
+      private :request
+
+      # Takes numeric id and returns information of the user.
+      #
+      #   response = client.show_user(1)          # => #<ShowUserResponse>
+      #   user = response.user
+      #
+      def show_user(id)
+        request(ShowUserRequest, ShowUserResponse, :id => id)
+      end
+
+      # Looks up and returns a list of users.
+      # Lookup key should be one of :nickname, :interest, :followers, or :contacts.
+      #
+      #   response = client.search_user(:nickname => 'aboutme-user',
+      #                                 :order => 'now_to_old,
+      #                                 :hits => 20,
+      #                                 :page => 1)
+      #   response.users.each {|user| do_something }
+      #
+      def search_user(params = {})
+        request(SearchUserRequest, SearchUserResponse, params)
+      end
+
+      # Takes numeric id and returns information of the question.
+      #
+      #   response = client.show_question(123)      # => #<ShowQuestionResponse>
+      #   question = response.question
+      #
+      def show_question(id)
+        request(ShowQuestionRequest, ShowQuestionResponse, :id => id)
+      end
+
+      # Looks up and returns a list of questions.
+      # Lookup key should be one of :owenr, :answerer, or :text.
+      #
+      #   response = client.search_question(:owner => 'aboutme-user',
+      #                                     :order => 'hot',
+      #                                     :hits => 20,
+      #                                     :page => 1)
+      #   response.questions.each {|q| do_something }
+      #
+      def search_question(params)
+        request(SearchQuestionRequest, SearchQuestionResponse, params)
+      end
+
+      # Takes numeric id and returns information of the answer.
+      #
+      #   response = client.show_question(987)      # => #<ShowAnswerResponse>
+      #   answer = response.answer
+      #
+      def show_answer(id)
+        request(ShowAnswerRequest, ShowAnswerResponse, :id => id)
+      end
+
+      # Looks up and returns a list of answers.
+      # Lookup key should be one of :user, :text, :gender, or :age,
+      # and :question is required.
+      #
+      #   response = client.search_answer(:question => 987,
+      #                                   :age => '30s',
+      #                                   :order => 'new_to_old',
+      #                                   :hits => 20,
+      #                                   :page => 1)
+      #   response.answers.each {|ans| do_something }
+      #
+      def search_answer(params)
+        request(SearchAnswerRequest, SearchAnswerResponse, params)
+      end
+
+      # Takes numeric question id and returns summary of answers for the question.
+      #
+      #   response = client.show_answer_digest(987)    # => #<ShowAnswerDigestResponse>
+      #   response.digest.each {|d| do_something }
+      #
+      def show_answer_digest(id)
+        request(ShowAnswerDigestRequest, ShowAnswerDigestResponse, :id => id)
+      end
+    end
+
+    # The Config class contains information of the client configuration.
+    class Config
+      # base path of the request URI. You should not change this value.
+      attr_accessor :request_path_base
+
+      # domain name of the request URI.
+      attr_accessor :request_domain
+
+      # port number of the request URI.
+      attr_accessor :request_port
+
+      # connection timeout (in seconds).
+      attr_accessor :open_timeout
+
+      # IO read timeout (in seconds).
+      attr_accessor :read_timeout
+
+      # name of user-agent for the client.
+      attr_accessor :user_agent
+
+      def initialize(&block)
+        block.call(self)
+      end
+    end
+
+    class ValidationError < ArgumentError
+    end
+
+    class Request #:nodoc:
+
+      class << self
+        def validators(*methods)
+          self.class_eval do
+            unless defined? @param_validators
+              @param_validators = []
+            end
+            @param_validators += methods
+          end
+        end
+
+        def known_params(*keys)
+          self.class_eval do
+            unless defined? @known_parameters
+              @known_parameters = []
+            end
+            @known_parameters += keys
+          end
+        end
+      end
+
+
+      def initialize(config)
+        @config = config
+      end
+
+      def request(params = {})
+        validate(params)
+        path = create_request_path(params)
+        queries = collect_queries(params)
+        method = get_method
+        _request(path, method, queries)
+      end
+
+
+      private
+
+      def get_method
+        :get
+      end
+
+      def validate(params)
+        validators = self.class.class_eval { @param_validators }
+        return true if validators.nil?
+
+        errors = []
+        validators.each do |validator|
+          message = __send__ validator, params
+          errors << message if message
+        end
+
+        unless errors.empty?
+          raise ValidationError, errors.join("\n")
+        end
+        true
+      end
+
+      def collect_queries(params)
+        keys = self.class.class_eval { @known_parameters } || []
+
+        queries = {}
+        keys.each do |key|
+          if params.key? key
+            queries[key] = params[key]
+          end
+        end
+        queries
+      end
+
+      def _request(path, method = :get, params = {})
+        uri = create_request_uri(@config.request_path_base + path, params)
+        req = create_http_request(method, uri, params)
+        response = Net::HTTP.start(uri.host, uri.port) do |http|
+          http.open_timeout = @config.open_timeout
+          http.read_timeout = @config.read_timeout
+          http.request(req)
+        end
+
+        response
+      end
+
+      def create_http_request(method, uri, params)
+        initheader = {
+          'User-Agent' => @config.user_agent
+        }
+
+        case method
+        when :get
+          Net::HTTP::Get.new(uri.request_uri)
+        when :post
+          req = Net::HTTP::Post.new(uri.path)
+          req.set_form_data(params)
+          req
+        end
+      end
+
+      def create_query_string(params = {})
+        queries = []
+        params.each_pair do |key, val|
+          queries << key.to_s + '=' + URI.encode(val.to_s)
+        end
+        queries.join('&')
+      end
+
+      def create_request_uri(request_path, params)
+        query = create_query_string(params)
+        URI::HTTP.build({ :host => @config.request_domain,
+                          :port => @config.request_port,
+                          :path => request_path,
+                          :query => query,
+                        })
+      end
+
+
+      def validate_id(params)
+        id = params[:id]
+        unless id
+          return "id missing."
+        end
+      end
+    end
+
+    class ShowUserRequest < Request  #:nodoc:
+      validators :validate_id
+
+      def create_request_path(params)
+        id = params[:id]
+        "users/show/#{id}"
+      end
+    end
+
+    class SearchUserRequest < Request  #:nodoc:
+      known_params :nickname, :interest, :followers, :contacts, :order, :hits, :page
+      def create_request_path(params)
+        "users/search"
+      end
+    end
+
+    class ShowQuestionRequest < Request  #:nodoc:
+      validators :validate_id
+
+      def create_request_path(params)
+        id = params[:id]
+        "questions/show/#{id}"
+      end
+    end
+
+    class SearchQuestionRequest < Request  #:nodoc:
+      known_params :owner, :answerer, :text, :order, :hits, :page
+
+      def create_request_path(params)
+        "questions/search"
+      end
+    end
+
+    class ShowAnswerRequest < Request  #:nodoc:
+      validators :validate_id
+
+      def create_request_path(params)
+        id = params[:id]
+        "answers/show/#{id}"
+      end
+    end
+
+    class SearchAnswerRequest < Request  #:nodoc:
+      known_params :question, :user, :text, :gender, :age, :order, :hits, :page
+
+      def create_request_path(params)
+        "answers/search"
+      end
+    end
+
+    class ShowAnswerDigestRequest < Request  #:nodoc:
+      validators :validate_id
+
+      def create_request_path(params)
+        id = params[:id]
+        "answers/digest/#{id}"
+      end
+    end
+
+
+    class ResponseStatus < XmlObjectMapping::Base
+      attr_mapping :code, :type => :integer
+      attr_mapping :message
+      attr_mapping :language
+    end
+
+    class IconImages < XmlObjectMapping::Base
+      attr_mapping :icon
+      attr_mapping :small
+      attr_mapping :medium
+      attr_mapping :large
+    end
+
+    class Birthday < XmlObjectMapping::Base
+      attr_mapping :year, :type => :integer
+      attr_mapping :month, :type => :integer
+      attr_mapping :day, :type => :integer
+    end
+
+    class User < XmlObjectMapping::Base
+      attr_mapping :id, :type => :integer
+      attr_mapping :nickname
+      attr_mapping :url
+      attr_mapping :images, :type => IconImages
+      attr_mapping :gender
+      attr_mapping :birthday, :type => Birthday
+      attr_mapping :age, :type => :integer
+      attr_mapping :horoscope
+      attr_mapping :blood_type
+      attr_mapping :prefecture
+      attr_mapping :area
+      attr_mapping :introduction
+      attr_array   :interests, :subnode => 'interest'
+    end
+
+    class Choice < XmlObjectMapping::Base
+      attr_mapping :priority, :type => :integer
+      attr_mapping :title
+      attr_mapping :answer_count, :type => :integer, :path => 'answers_count'
+    end
+
+    class Question < XmlObjectMapping::Base
+      attr_mapping :id, :type => :integer
+      attr_mapping :title
+      attr_mapping :url
+      attr_mapping :image
+      attr_mapping :creator, :type => User
+      attr_mapping :created_at, :type => :datetime
+      attr_array   :choices, :type => Choice, :path => 'options', :subnode => 'option'
+    end
+
+    class Answer < XmlObjectMapping::Base
+      attr_mapping :id, :type => :integer
+      attr_mapping :title
+      attr_mapping :question_id, :type => :integer
+      attr_mapping :updated_at, :type => :datetime
+      attr_mapping :priority, :type => :integer
+      attr_mapping :answerer, :type => User
+    end
+
+    class AnswerDigest < XmlObjectMapping::Base
+      attr_mapping :id, :type => :integer
+      attr_mapping :count, :type => :integer, :path => 'answers_count'
+      attr_array   :choices, :type => Choice, :path => 'options', :subnode => 'option'
+    end
+
+    class Summary < XmlObjectMapping::Base
+      attr_mapping :total, :type => :integer
+      attr_mapping :page, :type => :integer
+      attr_mapping :page_count, :type => :integer
+    end
+
+
+    class ResultBase < XmlObjectMapping::Base
+      attr_mapping :summary, :type => Summary
+    end
+
+    class SearchUserResult < ResultBase
+      attr_array :users, :type => User, :subnode => 'user'
+    end
+
+    class SearchQuestionResult < ResultBase
+      attr_array :questions, :type => Question, :subnode => 'question'
+    end
+
+    class SearchAnswerResult < ResultBase
+      attr_array :answers, :type => Answer, :subnode => 'answer'
+    end
+
+
+
+    class ResponseBase < XmlObjectMapping::Base
+      attr_mapping :status, :type => ResponseStatus
+    end
+
+    class ShowUserResponse < ResponseBase
+      attr_mapping :user, :type => User, :path => 'result', :subnode => 'user'
+    end
+
+    class SearchUserResponse < ResponseBase
+      attr_mapping :result, :type => SearchUserResult, :private => true
+      attr_accessor :summary
+      attr_accessor :users
+
+      private
+      def post_population
+        if @result
+          @summary = @result.summary
+          @users = @result.users
+        end
+      end
+    end
+
+    class ShowQuestionResponse < ResponseBase
+      attr_mapping :question, :type => Question, :path => 'result', :subnode => 'question'
+    end
+
+    class SearchQuestionResponse < ResponseBase
+      attr_mapping :result, :type => SearchQuestionResult, :private => true
+      attr_accessor :summary
+      attr_accessor :questions
+
+      private
+      def post_population
+        if @result
+          @summary = @result.summary
+          @questions = @result.questions
+        end
+      end
+    end
+
+    class ShowAnswerResponse < ResponseBase
+      attr_mapping :answer, :type => Answer, :path => 'result', :subnode => 'answer'
+    end
+
+    class SearchAnswerResponse < ResponseBase
+      attr_mapping :result, :type => SearchAnswerResult, :private => true
+      attr_accessor :summary
+      attr_accessor :answers
+
+      private
+      def post_population
+        if @result
+          @summary = @result.summary
+          @answers = @result.answers
+        end
+      end
+    end
+
+    class ShowAnswerDigestResponse < ResponseBase
+      attr_mapping :digest, :type => AnswerDigest, :path => 'result', :subnode => 'answers_digest'
+    end
+
+  end
+end