milk1000cc-web_service_simple 0.0.1

data/README.textile

@@ -0,0 +1,127 @@
+h1. WebService::Simple
+
+Simple Interface To Web Services APIs (Ruby)
+
+"Original perl version":http://search.cpan.org/~yusukebe/WebService-Simple-0.15/lib/WebService/Simple.pm was created by Yusuke Wada.
+
+h2. Usage
+
+<pre>
+require 'rubygems'
+require 'web_service_simple'
+
+# Simple use case
+technorati = WebService::Simple.new(
+  :base_url => 'http://api.technorati.com/',
+  :param    => { :key => 'your_api_key', }
+)
+
+# send GET request to
+# http://api.technorati.com/?language=ja&key=your_api_key&query=value
+technorati.get :language => 'ja', :query => 'value'
+
+# send GET request to
+# http://api.technorati.com/extra/path?language=ja&key=your_api_key&query=value
+technorati.get 'extra/path', :language => 'ja', :query => 'value'
+</pre>
+
+h2. Methods
+
+* new(arg)
+
+<pre>
+technorati = WebService::Simple.new(
+  :base_url => 'http://api.technorati.com/',
+  :param    => { :key => 'your_api_key', },
+  # :debug    => 1
+)
+</pre>
+
+Create and return a new WebService::Simple object. "new" Method requires a base_url of Web Service API. If debug is set, dump a request URL in get or post method.
+
+* get([extra_path,] arg)
+
+<pre>
+response =
+  technorati.get(:language => 'ja', :query => 'value')
+</pre>
+
+Send GET request, and you can get the WebService::Simple::Response object. If you want to add a path to base URL, use an option parameter.
+
+<pre>
+technorati = WebService::Simple.new(
+  :base_url => 'http://api.technorati.com/',
+  :param    => { :api_key => 'your_api_key', :language => 'ja' }
+)
+response = technorati.get('search', :limit => 50)
+</pre>
+
+* base_url
+
+* base_url=
+
+* basic_params
+
+* basic_params=
+
+* logger
+
+* logger=
+
+* debug
+
+* debug=
+
+* response_parser
+
+* response_parser=
+
+h2. Subclassing
+
+For better encapsulation, you can create subclass of WebService::Simple to customize the behavior
+
+<pre>
+class WebService::Simple::Technorati < WebService::Simple
+  @@config = {
+    :base_url => 'http://api.technorati.jp',
+    :response_parser => { :module => 'XML::Technorati' }
+  }
+
+  def key_info
+    get '/keyinfo'
+  end
+
+  def search(keyword)
+    get '/search', :query => keyword
+  end
+end
+</pre>
+
+h2. Parsers
+
+Web services return their results in various different formats. Or perhaps you require more sophisticated results parsing than what WebService::Simple provides.
+
+WebService::Simple by default uses WebService::Simple::Parser::XML::Nokogiri (based on Nokogiri gem), but you can easily override that by providing a parser object to the constructor:
+
+<pre>
+service = WebService::Simple.new(
+  :response_parsrer => AVeryComplexParser.new,
+  ...
+)
+response = service.get( ... )
+thing = response.parse_response
+</pre>
+
+This allows great flexibility in handling different webservices
+
+h2. Install
+
+<pre>
+sudo gem install milk1000cc-web_service_simple --source=http://gems.github.com
+</pre>
+
+h2. Author
+
+milk1000cc &lt;<a href="mailto:info@milk1000.cc">info@milk1000.cc</a>&gt;
+
+Yusuke Wada

data/init.rb

@@ -0,0 +1 @@
+require 'web_service/simple'

data/lib/web_service/simple.rb

@@ -0,0 +1,92 @@
+require 'logger'
+require 'net/http'
+require 'uri'
+
+require 'web_service/simple/response'
+require 'web_service/simple/response_code_error'
+require 'web_service/simple/parser'
+
+module WebService
+  class Simple
+    VERSION = '0.0.1'
+
+    attr_accessor :base_url
+    attr_accessor :basic_params
+    attr_accessor :response_parser
+    attr_accessor :logger
+    attr_accessor :debug
+
+    @@config = {
+      :base_url => nil,
+      :response_parser => { :module => 'XML::Nokogiri' }
+    }
+
+    def logger
+      unless @logger
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::INFO
+      end
+      @logger
+    end
+
+    def response_parser
+      unless @response_parser and @response_parser.is_a?(Parser)
+        klass = @response_parser.is_a?(Hash) ? @response_parser[:module] : @response_parser
+        klass = "Simple::Parser::#{ klass }"
+        require File.expand_path(underscore(klass), File.dirname(__FILE__))
+        @response_parser = eval(klass).new
+      end
+      @response_parser
+    end
+
+    def initialize(arg = {})
+      Net::HTTP.version_1_2
+
+      @base_url = arg[:base_url] || @@config[:base_url]
+      raise ArgumentError, 'base_url is required' unless @base_url
+
+      @logger = arg[:logger]
+      @debug = arg[:debug] || false
+      @basic_params = arg[:params] || arg[:param] || {}
+      @response_parser = arg[:response_parser] || @@config[:response_parser]
+    end
+
+    def get(*args)
+      extra_path, extra_params = nil, {}
+
+      if args.first.is_a?(Hash)
+        extra_params = args.shift
+      else
+        extra_path = args.shift
+        extra_params = args.shift if args.first.is_a?(Hash)
+      end
+
+      params = @basic_params.merge(extra_params).map { |k, v| "#{ URI.escape(k.to_s) }=#{ URI.escape(v.to_s) }" } * '&'
+      uri = URI("#{ @base_url }#{ extra_path }?#{ params }")
+
+      log "Request URL is #{ uri }"
+
+      response = nil
+      Net::HTTP.start(uri.host, uri.port) { |http|
+        req = Net::HTTP::Get.new(uri.request_uri)
+        response = http.request(req)
+      }
+      raise ResponseCodeError.new(response) unless response.code == '200'
+
+      Response.new(response.body, response_parser)
+    end
+
+    private
+    def underscore(camel_cased_word)
+      camel_cased_word.to_s.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+
+    def log(message)
+      logger.info "[simple_web_service] #{message}" if @debug
+    end
+  end
+end

data/lib/web_service/simple/parser.rb

@@ -0,0 +1,6 @@
+module WebService
+  class Simple
+    class Parser
+    end
+  end
+end

data/lib/web_service/simple/parser/json.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'json'
+
+module WebService
+  class Simple
+    class Parser
+      class JSON < Parser
+        def parse_response(response)
+          ::JSON.parse response.content
+        end
+      end
+    end
+  end
+end

data/lib/web_service/simple/parser/xml/nokogiri.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'nokogiri'
+
+module WebService
+  class Simple
+    class Parser
+      module XML
+        class Nokogiri < Parser
+          def parse_response(response)
+            ::Nokogiri::XML response.content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/web_service/simple/response.rb

@@ -0,0 +1,16 @@
+module WebService
+  class Simple
+    class Response
+      attr_reader :content
+
+      def initialize(content, parser)
+        @content = content
+        @parser = parser
+      end
+
+      def parse_response
+        @parser.parse_response self
+      end
+    end
+  end
+end

data/lib/web_service/simple/response_code_error.rb

@@ -0,0 +1,19 @@
+module WebService
+  class Simple
+    class ResponseCodeError < RuntimeError
+      attr_reader :response_code
+      attr_reader :response_body
+
+      def initialize(response)
+        @response_code = response.code
+        @response_body = response.body
+      end
+
+      def to_s
+        "#{ response_code } => #{ Net::HTTPResponse::CODE_TO_OBJ[response_code] }"
+      end
+
+      def inspect; to_s; end
+    end
+  end
+end

data/lib/web_service_simple.rb

@@ -0,0 +1 @@
+require 'web_service/simple'

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+
+require 'rubygems'
+require 'spec'
+require 'fakeweb'

data/spec/web_service/simple/parser/json_spec.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require File.expand_path('../../../spec_helper', File.dirname(__FILE__))
+require 'web_service/simple/parser'
+require 'web_service/simple/parser/json'
+
+describe WebService::Simple::Parser::JSON do
+  describe '#parse_response' do
+    it 'は、json pure で JSON 文字列をパースして、その結果を返すこと' do
+      parser = WebService::Simple::Parser::JSON.new
+      response = stub(:response, :content => '{ "hoge": 3, "fuga": ["a", "b"] }')
+      parser.parse_response(response).should == { 'hoge' => 3, 'fuga' => ['a', 'b'] }
+    end
+  end
+end

data/spec/web_service/simple/parser/xml/nokogiri_spec.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require File.expand_path('../../../../spec_helper', File.dirname(__FILE__))
+require 'web_service/simple/parser'
+require 'web_service/simple/parser/xml/nokogiri'
+
+describe WebService::Simple::Parser::XML::Nokogiri do
+  before do
+    @xml = <<-'EOF'
+      <?xml version="1.0" encoding="UTF-8"?>
+      <!-- generator="Technorati API version 1.0" -->
+      <!DOCTYPE tapi PUBLIC "-//Technorati, Inc.//DTD TAPI 0.02//EN" "http://api.technorati.com/dtd/tapi-002.xml">
+      <tapi version="1.0">
+      <document>
+        <result>
+          <query>ミッドナイトクラブ</query>
+          <total>109</total>
+          <start/>
+        </result>
+      </document>
+      </tapi>
+    EOF
+  end
+
+  describe '#parse_response' do
+    it 'は、nokogiri で xml をパースして、その結果を返すこと' do
+      parser = WebService::Simple::Parser::XML::Nokogiri.new
+      response = stub(:response, :content => @xml)
+      parser.parse_response(response).at('//tapi/document/result/query').text.should == 'ミッドナイトクラブ'
+    end
+  end
+end

data/spec/web_service/simple/response_spec.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require File.expand_path('../../spec_helper', File.dirname(__FILE__))
+require 'web_service/simple/response'
+require 'web_service/simple/parser'
+require 'web_service/simple/parser/json'
+
+describe WebService::Simple::Response do
+  before do
+    @parser = WebService::Simple::Parser::JSON.new
+    @content = '{ error: 1 }'
+    @response = WebService::Simple::Response.new(@content, @parser)
+  end
+
+  describe 'を作成するとき' do
+    it 'は、第 1 引数を @content に、第 2 引数を @parser に設定すること' do
+      @response.content.should == @content
+    end
+  end
+
+  describe '#parse_response' do
+    it 'は、パーサの parse_response メソッドを、自身を引数として呼び出すこと' do
+      @parser.should_receive(:parse_response).with(@response)
+      @response.parse_response
+    end
+  end
+end

data/spec/web_service/simple_spec.rb

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+require 'web_service/simple'
+require 'tempfile'
+
+describe WebService::Simple do
+  it { WebService::Simple::VERSION.should =~ /\A\d+\.\d+\.\d+\Z/ }
+
+  before do
+    @base_url = 'http://api.example.com'
+    @service = WebService::Simple.new(:base_url => @base_url)
+  end
+
+  describe 'を作成するとき' do
+    it 'は、:base_url の値を @base_url に設定すること' do
+      service = WebService::Simple.new(:base_url => @base_url)
+      service.base_url.should == @base_url
+    end
+
+    it 'で、:base_url の値が未指定ならば ArgumentError が発生すること' do
+      proc { WebService::Simple.new }.should raise_error(ArgumentError)
+    end
+
+    it 'は、:logger の値を @logger に設定すること' do
+      logger = Logger.new(STDOUT)
+      service = WebService::Simple.new(:base_url => @base_url, :logger => logger)
+      service.logger.should == logger
+    end
+
+    it 'は、:debug の値を @debug に設定すること' do
+      service = WebService::Simple.new(:base_url => @base_url, :debug => true)
+      service.debug.should be_true
+    end
+
+    it 'は、:params の値を @basic_params に設定すること' do
+      params = { :key => 'xxx' }
+      service = WebService::Simple.new(:base_url => @base_url, :params => params)
+      service.basic_params.should == params
+    end
+
+    it 'は、:param の値を @basic_params に設定すること' do
+      param = { :key => 'xxx' }
+      service = WebService::Simple.new(:base_url => @base_url, :param => param)
+      service.basic_params.should == param
+    end
+
+    it 'は、:response_parser の値を @response_parer に設定すること' do
+      service = WebService::Simple.new(:base_url => @base_url, :response_parser => 'XML::Nokogiri')
+      service.response_parser.should_not be_nil
+
+      service = WebService::Simple.new(:base_url => @base_url, :response_parser => { :module => 'XML::Nokogiri' })
+      service.response_parser.should_not be_nil
+
+      parser = WebService::Simple::Parser::XML::Nokogiri.new
+      service = WebService::Simple.new(:base_url => @base_url, :response_parser => parser)
+      service.response_parser.should_not be_nil
+    end
+
+    it 'で、:response_parser の値が未指定ならば @@config の値から @response_parser を設定すること' do
+      service = WebService::Simple.new(:base_url => @base_url)
+      service.response_parser.class.should == WebService::Simple::Parser::XML::Nokogiri
+    end
+  end
+
+  describe '#logger' do
+    it 'は、@logger を返すこと' do
+      logger = Logger.new(StringIO.new)
+      @service.logger = logger
+      @service.logger.should == logger
+    end
+
+    it 'は、@logger が nil ならば標準出力 INFO レベルの Logger を返すこと' do
+      logger = @service.logger
+      logger.class.should == Logger
+      logger.level.should == Logger::INFO
+    end
+  end
+
+  describe '#response_parser' do
+    it 'は、@response_parser が文字列ならば、そのレスポンスパーサを生成して返すこと' do
+      @service.response_parser = 'XML::Nokogiri'
+      @service.response_parser.class.should == WebService::Simple::Parser::XML::Nokogiri
+    end
+
+    it 'は、@response_parser がハッシュならば、そのレスポンスパーサを生成して返すこと' do
+      @service.response_parser = { :module => 'XML::Nokogiri' }
+      @service.response_parser.class.should == WebService::Simple::Parser::XML::Nokogiri
+    end
+
+    it 'は、@response_parser が Parser オブジェクトならば、それを返すこと' do
+      parser = WebService::Simple::Parser::XML::Nokogiri.new
+      @service.response_parser = parser
+      @service.response_parser.should == parser
+    end
+  end
+
+  describe '#get' do
+    before do
+      FakeWeb.clean_registry
+      FakeWeb.allow_net_connect = false
+    end
+
+    before do
+      @service = WebService::Simple.new(:base_url => 'http://api.example.com', :param => { :key => 'xxx' })
+    end
+
+    it 'は、GET リクエストを送信して、Response オブジェクトを返すこと' do
+      FakeWeb.register_uri(:get, 'http://api.example.com?key=xxx', :string => 'ok')
+
+      response = @service.get
+      response.class.should == WebService::Simple::Response
+      response.content.should == 'ok'
+    end
+
+    it 'は、リクエストの結果、レスポンスコードが 200 以外ならば、例外 ResponseCodeError が発生すること' do
+      FakeWeb.register_uri(:get, 'http://api.example.com?key=xxx', :string => 'nf', :status => ['404', 'Not Found'])
+      begin
+        @service.get
+      rescue => e
+        e.class.should == WebService::Simple::ResponseCodeError
+        e.response_code.should == '404'
+        e.response_body.should == 'nf'
+      end
+    end
+
+    it 'は、引数に応じて、よしなにリクエストすること' do
+      FakeWeb.register_uri(:get, 'http://api.example.com?key=xxx&word=yyy', :string => 'ok1')
+      FakeWeb.register_uri(:get, 'http://api.example.com/hage?key=xxx&word=yyy', :string => 'ok2')
+      FakeWeb.register_uri(:get, 'http://api.example.com/hage?key=xxx', :string => 'ok3')
+
+      @service.get(:word => 'yyy').content.should == 'ok1'
+      @service.get('/hage', :word => 'yyy').content.should == 'ok2'
+      @service.get('/hage').content.should == 'ok3'
+      @service.get('/hage').content.should == 'ok3'
+
+      service = WebService::Simple.new(:base_url => 'http://api.example.com/hage', :param => { :key => 'xxx' })
+      service.get.content.should == 'ok3'
+    end
+
+    it 'は、デバッグモードではないならば、ログを出力しないこと' do
+      io = StringIO.new
+      logger = Logger.new(io)
+      @service.logger = logger
+      @service.debug = false
+
+      io.string.should be_empty
+    end
+
+    describe 'で、デバッグモードのとき' do
+      before do
+        @io = StringIO.new
+        @logger = Logger.new(@io)
+
+        FakeWeb.register_uri(:get, @base_url, :string => 'ok')
+
+        @service = WebService::Simple.new(:base_url => @base_url, :debug => true)
+      end
+
+      it 'は、logger に対して INFO レベルのログを出力すること' do
+        @logger.level = Logger::INFO
+        @service.logger = @logger
+        @service.get
+
+        @io.string.should =~ %r!#{ Regexp.escape(@base_url) }!
+      end
+
+      it 'は、logger が INFO より上のレベルに設定されていればログを出力しないこと' do
+        @logger.level = Logger::WARN
+        @service.logger = @logger
+        @service.get
+
+        @io.string.should be_empty
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: milk1000cc-web_service_simple
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- milk1000cc
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Simple Interface To Web Services APIs (Ruby)
+email: info@milk1000.cc
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.textile
+- init.rb
+- lib/web_service/simple.rb
+- lib/web_service/simple/parser.rb
+- lib/web_service/simple/parser/json.rb
+- lib/web_service/simple/parser/xml/nokogiri.rb
+- lib/web_service/simple/response.rb
+- lib/web_service/simple/response_code_error.rb
+- lib/web_service_simple.rb
+- spec/spec_helper.rb
+- spec/web_service/simple/parser/json_spec.rb
+- spec/web_service/simple/parser/xml/nokogiri_spec.rb
+- spec/web_service/simple/response_spec.rb
+- spec/web_service/simple_spec.rb
+has_rdoc: true
+homepage: http://github.com/milk1000cc/web_service_simple/tree/master
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple Interface To Web Services APIs (Ruby)
+test_files: []
+