libastag 0.0.1

data/CHANGES

@@ -0,0 +1,7 @@
+==v0.0.1
+
+- Response module is working
+- test/doc for Response
+
+- Base of Request module is working (Query class, sending message, actions)
+- test/doc for Action and Request::Base

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007 Perrin Alexandre
+
+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,65 @@
+=libastag --- a Nabastag communication library for Ruby
+[Author]
+    Perrin Alexandre <kaworu@kaworu.ch>
+
+
+==About
+
+libastag is a full featured library for the Nabastag API (see http://api.nabaztag.com/docs/home.html).
+It provide also a minimal fake HTTP Violet Server based on WEBrick for testing purpose.
+
+Main goals are :
+- complete Rdoc documentation
+- Unit testing
+- Easy to use
+
+
+
+==About Nabastag
+
+The Nabaztag is a small electronic rabbit with lights, motorised ears, and speech.
+
+http://www.nabaztag.com
+
+
+
+==Download
+
+You can found the latest version of libastag at :
+- http://rubyforge.org/frs/?group_id=4947
+
+
+
+== Installation
+
+=Gem Instalation
+
+to install libastag's gem :
+    gem install --remote libastag
+
+
+
+==Online Documentation
+
+- libastag Documentation Homepage : http://libastag.rubyforge.org
+- libastag Project Page :  http://rubyforge.org/projects/libastag
+
+
+
+==Irb Examples
+TODO
+
+
+
+==Other Nabastag related Ruby projects
+
+- Nabaztag : http://rubyforge.org/projects/nabaztag
+
+
+
+==Copying
+
+Copyright (c) 2007 Perrin Alexandre
+
+You may use, copy and redistribute this library under the terms of the MIT licence (see MIT-LICENSE file).
+

data/Rakefile

@@ -0,0 +1,276 @@
+#
+# libastag's Rakefile
+#
+
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+
+
+
+task :default => [:stats]
+
+
+# perso infos
+MY_NAME         = "Alexandre Perrin"
+MY_EMAIL        = "makoto.kaworu@gmail.com"
+
+
+# Project infos
+PROJECT         = "libastag"
+PROJECT_SUMMARY = "A library for sending commands to Nabastag(/tag) (see http://www.nabaztag.com)"
+PROJECT_DESC    = <<-EOF
+                  libastag is a full featured library for the Nabastag API (see http://api.nabaztag.com/docs/home.html).
+                  It provide also a minimal fake Violet HTTP Server written with WEBrick for testing purpose.
+                  Main goals are :
+                  - complete Rdoc documentations
+                  - Unit testing
+                  - Easy to use
+                  EOF
+
+require File.join( File.dirname(__FILE__), 'lib', "#{PROJECT}.rb" )
+PROJECT_VERSION = eval "#{PROJECT.capitalize}::VERSION"
+
+
+# rubyforge infos
+RUBYFORGE_USER  = "kaworu"
+UNIX_NAME       = "libastag"
+
+
+# Rdoc
+RDOC_DIR        = "doc"
+RDOC_OPTIONS    = [
+                  "--title",        "#{PROJECT} API documentation",
+                  "--main",         "README",
+                  "--charset",      "utf-8",
+                  "--diagram",
+                  "--line-number",
+                  "--inline-source"
+                  ]
+
+
+# files
+LIB_FILES       = Dir["lib/**/*.rb"]
+TEST_FILES      = Dir["test/**/*.rb"]
+
+RDOC_FILES      = %w[ README MIT-LICENSE TODO CHANGES ] + LIB_FILES
+DIST_FILES      = %w[ Rakefile ] + LIB_FILES + TEST_FILES + RDOC_FILES
+
+
+
+#
+# RDoc
+#
+Rake::RDocTask.new do |rd|
+  rd.main        = RDOC_FILES.first
+  rd.rdoc_dir    = RDOC_DIR
+  rd.options     = RDOC_OPTIONS
+  rd.rdoc_files.include(*RDOC_FILES)
+end
+
+
+
+#
+# Tests
+#
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.warning = true
+end
+
+
+
+#
+# Cleaning
+#
+CLOBBER.include 'doc', 'pkg'
+CLEAN.include   'doc', 'pkg', 'test/**/*.tmp'
+
+
+
+#
+# Pkg
+#
+gem_spec = Gem::Specification.new do |s|
+  s.author       = MY_NAME
+  s.email        = MY_EMAIL
+  s.homepage     = "http://#{UNIX_NAME}.rubyforge.org"
+
+  s.name        = PROJECT
+  s.summary     = PROJECT_SUMMARY
+  s.description = PROJECT_DESC
+
+  s.has_rdoc            = true
+  s.rdoc_options        = RDOC_OPTIONS
+  s.extra_rdoc_files    = RDOC_FILES + Dir["#{RDOC_DIR}/**/*"]
+
+  s.test_files          = TEST_FILES
+  s.files               = DIST_FILES
+  s.version             = PROJECT_VERSION
+  s.rubyforge_project   = UNIX_NAME
+end
+
+Rake::GemPackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+
+
+#
+# stats
+#
+# ScriptLines class is code from Oreilly's "Ruby Cookbook" (rewritted a bit)
+#
+module Stats
+  # A ScriptLines instance analyses a Ruby script and maintains
+  # counters for the total number of lines, lines of  code, etc.
+  class ScriptLines
+
+    attr_reader :name
+    attr_accessor :bytes, :lines, :lines_of_code, :lines_of_comments
+
+    LINE_FORMAT = '%8s %8s %8s %8s    %s'
+
+
+    def ScriptLines.headline
+      LINE_FORMAT % %w[ BYTES LINES LOC COMMENT FILE ]
+    end
+
+    # The 'name' argument is usually a filename
+    def initialize(name)
+      @name = name
+      @bytes, @lines, @lines_of_code, @lines_of_comments = 0, 0, 0, 0
+    end
+
+    # Iterates over all the lines in io (io might be a file or a string), analyses them and appropriately increases
+    # the counter attributes.
+    def read(io)
+      in_multiline_comment = false
+
+      io.each do |line|
+        @lines += 1
+        @bytes += line.size
+
+        case line
+        when /^=(begin|end)/  # multi line comment
+          @lines_of_comments += 1
+          in_multiline_comment = ($1 == 'begin')
+
+        when /^\s*#/ # Comment line
+          @lines_of_comments += 1
+
+        when /^\s*$/ # empty/whitespace only line
+          # do nothin' :)
+
+        else
+          if in_multiline_comment then @lines_of_comments += 1 else @lines_of_code += 1 end
+        end
+      end
+    end
+
+    # Get a new ScriptLines instance whose counters hold the
+    # sum of self and other.
+    def +(other)
+      sum = self.dup
+      sum.bytes += other.bytes
+      sum.lines += other.lines
+      sum.lines_of_code += other.lines_of_code
+      sum.lines_of_comments += other.lines_of_comments
+      sum
+    end
+
+    # Get a formatted string containing all counter numbers and the
+    # name of this instance.
+    def to_s
+      LINE_FORMAT % [@bytes, @lines, @lines_of_code, @lines_of_comments, @name]
+    end
+  end
+
+end
+
+
+desc "display somes stats (# of lines, # lines of comment/code etc.) of this project"
+task 'stats' do
+
+  def stats_display name, files
+    include Stats
+    puts "\nStats (#{name})"
+    puts ScriptLines.headline
+    sum = ScriptLines.new("TOTAL (#{files.size} file(s))")
+
+    files.each do |f|
+      sl = ScriptLines.new f
+      sl.read File.read(f)
+      puts sl
+      sum += sl
+    end
+    puts sum
+    sum
+  end
+
+  libstats  =   stats_display 'lib files',  LIB_FILES
+  teststats =   stats_display 'test files', TEST_FILES
+
+  puts
+  puts "Ratio (test    / code) = %.2f" % (teststats.lines_of_code.to_f / libstats.lines_of_code)
+  puts "Ratio (comment / code) = %.2f" % (libstats.lines_of_comments.to_f / libstats.lines_of_code)
+end
+
+
+
+#
+# publish
+#
+desc "setup for RubyForge"
+task "rubyforge-setup" do
+  unless File.exist?( File.join(ENV['HOME'], '.rubyforge') )
+    puts <<-EOF
+    rubyforge will ask you to edit its config file now.
+    Please set the 'username' and 'password' entries to your RubyForge username/password !
+    press ENTER to continue.
+    EOF
+    STDIN.gets
+    sh "rubyforge setup", :verbose => true
+  end
+end
+
+desc "Connection to RubyForge's server"
+task "rubyforge-login" => %w[ rubyforge-setup ] do
+  sh "rubyforge login", :verbose => true
+end
+
+
+desc "Upload documentation to RubyForge"
+task "publish-doc" => %w[ rdoc ] do
+  rubyforge_path = "/var/www/gforge-projects/#{UNIX_NAME}/"
+  sh "scp -r #{RDOC_DIR}/* '#{RUBYFORGE_USER}@rubyforge.org:#{rubyforge_path}'", :verbose => true
+end
+
+desc "Upload package to RubyForge"
+task "publish-packages" => %w[ package rubyforge-login ] do
+  cd "pkg" do
+    %w[ gem tgz zip ].each do |pkgtype|
+      sh "rubyforge add_release #{UNIX_NAME} #{UNIX_NAME} #{PROJECT_VERSION} #{UNIX_NAME}-#{PROJECT_VERSION}.#{pkgtype}"
+    end
+  end
+end
+
+desc  "Run tests, generate RDoc and create packages."
+task "pre-release" => %w[ clobber clean ] do
+  puts "Preparing release of #{PROJECT} v#{PROJECT_VERSION}"
+  Rake::Task["test"].invoke
+  Rake::Task["rdoc"].invoke
+  Rake::Task["package"].invoke
+end
+
+desc "Publish a new release of #{PROJECT}"
+task "publish" => %w[ pre-release ] do
+  puts "Uploading doc..."
+  Rake::Task["publish-doc"].invoke
+  puts "Uploading packages..."
+  Rake::Task["publish-packages"].invoke
+  puts "release done !"
+end
+

data/TODO

@@ -0,0 +1,7 @@
+- Complete Request module
+- move EvenCollection out of Base
+- Complete Request module doc/test
+
+- Write doc for Helpers module
+- Write doc for VioletAPI module
+

data/doc/classes/Helpers/REXML/Attributes.html

@@ -0,0 +1,179 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Helpers::REXML::Attributes</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Helpers::REXML::Attributes</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/violet/helpers_rb.html">
+                lib/violet/helpers.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+    <div id="diagram">
+      <map id="map" name="map">
+  <area shape="rect" coords="53,85,128,133"      href="Attributes.html" alt="Attributes" />
+  <area shape="rect" coords="43,51,165,144"      href="../REXML.html" alt="REXML" />
+  <area shape="rect" coords="16,16,176,155"      href="../../Helpers.html" alt="Helpers" />
+</map>
+<img src="../../../dot/f_6.png" usemap="#map" border="0" alt="dot/f_6.png">
+    </div>
+
+    <div id="description">
+      <p>
+<a href="Attributes.html#M000002">REXML::Attributes#to_hash</a> seems to be
+broken.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000002">to_hash</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+    <div id="aliases-list">
+      <h3 class="section-bar">External Aliases</h3>
+
+      <div class="name-list">
+                        <table summary="aliases">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">to_hash</td>
+          <td>-&gt;</td>
+          <td class="context-item-value">to_hash_old</td>
+        </tr>
+                        </table>
+      </div>
+    </div>
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="#M000002" class="method-signature">
+          <span class="method-name">to_hash</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+convert attributes to an instance of Hash.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000002-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/violet/helpers.rb, line 17</span>
+17:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
+18:       <span class="ruby-identifier">h</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
+19:       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>,<span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">value</span> }
+20:       <span class="ruby-identifier">h</span>
+21:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Helpers/REXML.html

@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Helpers::REXML</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Helpers::REXML</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+    <div id="diagram">
+      <map id="map" name="map">
+  <area shape="rect" coords="53,85,128,133"      href="REXML/Attributes.html" alt="Attributes" />
+  <area shape="rect" coords="43,51,165,144"      href="REXML.html" alt="REXML" />
+  <area shape="rect" coords="16,16,176,155"      href="../Helpers.html" alt="Helpers" />
+</map>
+<img src="../../dot/f_6.png" usemap="#map" border="0" alt="dot/f_6.png">
+    </div>
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Class <a href="REXML/Attributes.html" class="link">Helpers::REXML::Attributes</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>