boxrubylib 0.0.1

data/lib/boxrubylib/restclientlib.rb

@@ -0,0 +1,284 @@
+#= restclientlib.rb
+#Author:: Takehiko Watanabe
+#CopyRights:: Canon Software Inc.
+#Created date:: 2009/06/10
+#Version:: 1.0.0
+#
+#This file contains RestClientLib module.
+
+require "net/http"
+require "net/https"
+require "openssl"
+require "rexml/document"
+require "digest/md5"
+require "cgi"
+Net::HTTP.version_1_2
+#
+#= module of Rest Client Library
+#
+module RestClientLib
+
+  #Http client class.
+  #
+  #attributes:
+  # proxyUrl - Proxy server URL, if you don't want to use Proxy set nil.
+  # proxyPort - Proxy server port.
+  class HttpClient
+    attr_accessor :proxyUrl, :proxyPort, :useSSL
+
+    # Constructor.
+    #
+    def initialize
+      @proxyUrl = nil
+      @proxyPort = nil
+      @useSSL = false;
+    end
+
+    # Throw http get request method to the server.
+    #
+    #  [server]
+    #   Server address.
+    #  [port]
+    #   Server port. If you want to use default port 80, you pass the parameter - nil.
+    #  [uri]
+    #   URI(include parameter and value).
+    #  [header]
+    #   HTTP header. If you don't need to describe, you pass the parameter - nil.
+    #
+    #  [Return value]
+    #   Http response body.
+    def httpGetRequest(server, port, uri, header)
+      port = 80 if (port == nil)
+      h = Net::HTTP::Proxy(@proxyUrl,@proxyPort).new(server, port)
+      if (@useSSL == true)
+        h.use_ssl = true
+        h.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      return h.start() { |http|
+        response = http.get(uri, header)
+        response.body
+      }
+    end
+
+    # Throw http post request method to the server.
+    #
+    #  [server]
+    #   Server address.
+    #  [port]
+    #   Server port. If you want to use default port 80, you pass the parameter - nil.
+    #  [uri]
+    #   URI.
+    #  [header]
+    #   HTTP header. If you don't need to describe, you pass the parameter - nil.
+    #  [data]
+    #   HTTP query data.
+    #
+    #  [Return value]
+    #   Http response body.
+    def httpPostRequest(server, port, uri, header, data)
+      port = 80 if (port == nil)
+      h = Net::HTTP::Proxy(@proxyUrl,@proxyPort).new(server, port)
+      if (@useSSL == true)
+        h.use_ssl = true
+        h.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      return h.start() { |http|
+        response = http.post(uri, data, header)
+        response.body
+      }
+
+    end
+
+    # Generate query string.
+    #
+    #  [params]
+    #   Query parameter. You need to pass this parameter to hash type.
+    #
+    #  [Return value]
+    #   Http response body.
+    def genQueryString(params)
+      ret = Array.new
+      params.each do |k,l|
+        if l.kind_of?(Array)
+          l.each do |m|
+            ret.push(CGI::escape(k.to_s) + "=" + CGI::escape(m.to_s))
+          end
+        else
+          ret.push(CGI::escape(k.to_s) + "=" + CGI::escape(l.to_s))
+        end
+      end
+      ret.join("&")
+    end
+
+    # Determine MIME type from file name.
+    #
+    #  [filename]
+    #   File name.
+    #
+    #  [Return value]
+    #   MIME type.
+    def resolveMime(filename)
+      if filename =~ /\.(\w+)$/
+        extn = $1
+        case extn
+          when "form"   then return "multipart/form-data"
+          when "txt"    then return "text/plain"
+          when "html"   then return "text/html"
+          when "htm"    then return "text/html"
+          when "jpg"    then return "image/jpeg"
+          when "png"    then return "image/png"
+          when "gif"    then return "image/gif"
+        else         return "application/octet-stream"
+        end
+      else
+        return "application/octet-stream"
+      end
+    end
+
+    # Assemble to multipart query.
+    #
+    #  [name]
+    #   Parameter name.
+    #  [value]
+    #   Parameter value.
+    #
+    #  [Return value]
+    #   Multipart query.
+    def toMultiPart(name, value)
+      return "Content-Disposition: form-data; name=\"#{CGI::escape(name)}\"\n\n#{value.to_s}\n"
+    end
+
+    # File to multipart query.
+    #
+    #  [filename]
+    #   File name.
+    #  [content]
+    #   File contents.
+    #
+    #  [Return value]
+    #   File query.
+    def fileToMultiPart(filename, content)
+      mimetype = resolveMime(filename)
+      ret = "Content-Disposition: form-data; name=\"fileField\"; filename=\"#{filename}\"\n"
+      if (mimetype != nil)
+        ret += "Content-Type: #{mimetype}\n\n" + content + "\n"
+      end
+      return ret
+    end
+
+    # Generate query for post method.
+    #
+    #  [filename]
+    #   File name.
+    #  [params]
+    #   Parameters.
+    #  [data]
+    #   File data.
+    #  [boundary]
+    #   Query boundary.
+    #
+    #  [Return value]
+    #   Query string.
+    def prepareQuery(filename, params, data, boundary)
+      query = ""
+      if (params != nil)
+        params.each do |key, value|
+          if (defined?(value)&&(value.instance_of?(Array)))
+            value.each do |item|
+              query += "--" + boundary +"\n" + toMultiPart(key, item)
+            end
+          else
+            query += "--" + boundary + "\n" + toMultiPart(key, value)
+          end
+        end
+      end
+      if ((filename != nil)&&(data != nil))
+        query += "--" + boundary + "\n";
+        query += fileToMultiPart(filename, data);
+      end
+      query += "--" + boundary + "--\n" if (query != nil)
+
+      return query
+    end
+  end
+
+  #Rest client class.
+  #
+  class RestClient < HttpClient
+    # Constructor.
+    #
+    def initialize
+      super
+    end
+
+    # Throw rest get request method to the server.
+    #
+    #  [server]
+    #   Server address.
+    #  [port]
+    #   Server port. If you want to use default port 80, you pass the parameter - nil.
+    #  [apipath]
+    #   Api path to rest request.
+    #  [params]
+    #    Parameters to get. You need to pass this parameter to hash type.
+    #  [header]
+    #   HTTP header.  If you don't need to describe, you pass the parameter - nil.
+    #
+    #  [Return value]
+    #   Xml document.
+    def getRequest(server, port, apipath, params, header)
+      if (params != nil)
+        uri = apipath + "?" + genQueryString(params)
+      else
+        uri = apipath
+      end
+      body = self.httpGetRequest(server, port, uri, header)
+      begin
+        return REXML::Document.new(body) if body
+        return nil
+      rescue
+        body
+      end
+    end
+
+    # Throw rest post request method to the server.
+    # Notice - This method makes content-type header field automatically,
+    #          so you don't set content-type to "header" parameter.
+    #
+    #  [server]
+    #   Server address.
+    #  [port]
+    #   Server port. If you want to use default port 80, you pass the parameter - nil.
+    #  [apipath]
+    #   Api path to rest request.
+    #  [fileName]
+    #   File name, if you want to post file.
+    #  [data]
+    #   File data, if you want to post file.
+    #  [params]
+    #    Parameters to post. You need to pass this parameter to hash type.
+    #  [header]
+    #   HTTP header.  If you don't need to describe, you pass the parameter - nil.
+    #
+    #  [Return value]
+    #   Xml document.
+    def postRequest(server, port, apipath, fileName, data, params, header)
+      boundary = Digest::MD5.hexdigest(fileName != nil ? fileName : Time.now.to_s).to_s
+      query = self.prepareQuery(fileName, params, data, boundary)
+      if (header != nil)
+        localheader = Hash[header]
+      else
+        localheader = Hash.new
+      end
+      localheader['Content-Type'] = "multipart/form-data, boundary=" + boundary + "\r\n"
+      localheader['Content-Length'] = query.length.to_s
+      body = self.httpPostRequest(server, port, apipath, localheader, query)
+      begin
+        return REXML::Document.new(body) if body
+        return nil
+      rescue
+        return body
+      end
+    end
+  end
+end

data/lib/boxrubylib.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'boxrubylib/boxclientlib'
+
+module Boxrubylib
+  VERSION = '0.0.1'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/boxrubylib.rb'}"
+puts "Loading boxrubylib gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_boxrubylib.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestBoxrubylib < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/boxrubylib'

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: boxrubylib
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tomohiko Ariki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-21 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: Ruby library of OpenBox API.
+email: 
+- tomohiko.ariki@nifty.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/boxrubylib.rb
+- lib/boxrubylib/boxclientlib.rb
+- lib/boxrubylib/restclientlib.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_boxrubylib.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://boxrubylib.rubyforge.org
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: boxrubylib
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby library of OpenBox API.
+test_files: 
+- test/test_boxrubylib.rb
+- test/test_helper.rb