wbxml 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-05-21
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Clifford Heath
+
+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/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+config/hoe.rb
+config/requirements.rb
+ext/wbxml/extconf.rb
+ext/wbxml/wbxml.c
+lib/wbxml/version.rb
+setup.rb

data/README.txt

@@ -0,0 +1,54 @@
+= wbxml
+
+* http://wbxml.rubyforge.org/
+
+== DESCRIPTION:
+
+Convert XML to WBXML for WAP mobile phone services
+wbxml is a simple Ruby wrapper for the wbxml2 library.
+
+== FEATURES/PROBLEMS:
+
+* WBXML.xml_to_wbxml - converts XML to WBXML
+* WBXML.wbxml_to_xml - converts WBXML to XML
+
+== SYNOPSIS:
+
+  xml = File.open("message.xml"){|f| f.read}
+  wbxml = WBXML.xml_to_wbxml xml
+  $output.print wbxml
+
+== REQUIREMENTS:
+
+* a working wbxml2
+** OSX: port install wbxml2
+** Debian: apt-get install libwbxml2
+
+== INSTALL:
+
+* sudo gem install
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/config/hoe.rb

@@ -0,0 +1,75 @@
+require 'wbxml/version'
+
+AUTHOR = 'Clifford Heath'  # can also be an array of Authors
+EMAIL = "cjheath@rubyforge.org"
+DESCRIPTION = "Wrapper for wbxml2, a WAP<->XML converter"
+GEM_NAME = 'wbxml' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'wbxml' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Wbxml::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'wbxml documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  # p.test_globs = ["spec/**/spec_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store', 'ext/wbxml/*.o*' ]  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+# Arrange to build the extension on install:
+$hoe.spec.extensions = ['ext/wbxml/extconf.rb']
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/ext/wbxml/extconf.rb

@@ -0,0 +1,7 @@
+require 'mkmf'
+
+dir_config("wbxml")
+
+$libs = append_library($libs, "wbxml2")
+
+create_makefile("wbxml")

data/ext/wbxml/wbxml.c

@@ -0,0 +1,81 @@
+/*
+ * Ruby extension to expose the conversion methods of WBXML,
+ * the WAP XML to XML (and back) converter.
+ *
+ * Copyright 2008 Clifford Heath. SOME RIGHTS RESERVED, READ THE COPYRIGHT.
+ * This work was paid for by Gekocard Pty Ltd for http://mobiblast.com
+ */
+#include <ruby.h>
+#include <wbxml.h> /* libwbxml2 */
+
+VALUE mWBXML;		/* The WBXML module object */
+
+VALUE
+xml_to_wbxml(VALUE self, VALUE xml_source)
+{
+	WBXMLError	ret = WBXML_OK;
+	WBXMLConvXML2WBXMLParams params;
+	WB_UTINY*	xml = NULL;		/* Must be null terminated */
+	WB_UTINY*	wbxml = NULL;
+	WB_ULONG	wbxml_len = 0;
+	VALUE		value;
+
+	Check_SafeStr(xml_source);
+	if (TYPE(xml_source) != T_STRING)
+		rb_raise(rb_eTypeError, "parameter to xml_to_wbxml must be a string");
+	xml = (WB_UTINY*)STR2CSTR(xml_source);
+
+	params.wbxml_version = WBXML_VERSION_13;
+	params.use_strtbl = TRUE;
+	params.keep_ignorable_ws = FALSE;
+
+	ret = wbxml_conv_xml2wbxml(xml, &wbxml, &wbxml_len, &params);
+	if (ret != WBXML_OK)
+		rb_raise(rb_eRuntimeError, (const char*)wbxml_errors_string(ret));
+
+	value = rb_str_new((const char*)wbxml, wbxml_len);
+
+	if (wbxml != NULL)
+		wbxml_free(wbxml);
+	return value;
+}
+
+VALUE
+wbxml_to_xml(VALUE self, VALUE wbxml_source)
+{
+	WBXMLError	ret = WBXML_OK;
+	WBXMLConvWBXML2XMLParams	params;
+	WB_UTINY*	wbxml = NULL;
+	WB_ULONG	wbxml_len = 0;
+	WB_UTINY*	xml = NULL;		/* Must be null terminated */
+	VALUE		value;
+
+	Check_SafeStr(wbxml_source);
+	if (TYPE(wbxml_source) != T_STRING)
+		rb_raise(rb_eTypeError, "parameter to wbxml_to_xml must be a string");
+	wbxml = (WB_UTINY*)STR2CSTR(wbxml_source);
+	wbxml_len = RSTRING_LEN(wbxml_source);
+
+	params.gen_type = WBXML_ENCODER_XML_GEN_INDENT;
+	params.lang = WBXML_LANG_UNKNOWN;	/* Don't force the language */
+	params.indent = 2;
+	params.keep_ignorable_ws = FALSE;
+
+	ret = wbxml_conv_wbxml2xml(wbxml, wbxml_len, &xml, &params);
+	if (ret != WBXML_OK)
+		rb_raise(rb_eRuntimeError, (const char*)wbxml_errors_string(ret));
+
+	value = rb_str_new((const char*)xml, strlen(xml));
+
+	if (xml != NULL)
+		wbxml_free(xml);
+	return value;
+}
+
+void
+Init_wbxml()
+{
+	mWBXML = rb_define_module("WBXML");
+	rb_define_singleton_method(mWBXML, "xml_to_wbxml", xml_to_wbxml, 1);
+	rb_define_singleton_method(mWBXML, "wbxml_to_xml", wbxml_to_xml, 1);
+}

data/lib/wbxml/version.rb

@@ -0,0 +1,9 @@
+module Wbxml #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end