idn-mihu 0.0.2

data/Rakefile

@@ -0,0 +1,126 @@
+# Rakefile for LibIDN Ruby Bindings.
+#
+# Copyright (c) 2005 Erik Abele. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# Please see the file called LICENSE for further details.
+#
+# You may also obtain a copy of the License at
+#
+# * http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# This software is OSI Certified Open Source Software.
+# OSI Certified is a certification mark of the Open Source Initiative.
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/contrib/sshpublisher'
+
+TEST_FILES = FileList[
+  'test/ts_*.rb'
+]
+
+DOC_FILES = FileList[
+  'README', 'CHANGES', 'LICENSE', 'lib/**/*.rb',
+  'ext/idna.c', 'ext/punycode.c', 'ext/stringprep.c', 'ext/idn.c'
+]
+
+INFO_NOTE = <<EOL
+  Please note that if the required libraries or header files can only be
+  found in a non-standard location an alternative search path has to be
+  specified when executing Rake:
+    rake ext IDN_DIR=/path/to/non/standard/location
+EOL
+
+task :default do
+  puts "Please see 'rake --tasks' for an overview of the available tasks."
+end
+
+desc 'Build all the extensions'
+task :ext do
+  extconf_args = ''
+
+  unless ENV['IDN_DIR'].nil?
+    extconf_args = "--with-idn-dir=#{ENV['IDN_DIR']}"
+  end
+
+  cd 'ext' do
+    unless system("ruby extconf.rb #{extconf_args}")
+      STDERR.puts "ERROR: could not configure extension!\n" +
+                  "\n#{INFO_NOTE}\n"
+      break
+    end
+
+    unless system('make')
+      STDERR.puts 'ERROR: could not build extension!'
+      break
+    end
+  end
+end
+
+desc 'Install (and build) extensions'
+task :install => [:ext] do
+  cd 'ext' do
+    unless system('make install')
+      STDERR.puts 'ERROR: could not install extension!'
+      break
+    end
+  end
+end
+
+desc 'Remove extension products'
+task :clobber_ext do
+  FileList['ext/**/*'].each do |file|
+    unless FileList['ext/**/*.{c,h,rb}'].include?(file)
+      rm_r file if File.exists?(file)
+    end
+  end
+end
+
+desc 'Force a rebuild of the extension files'
+task :reext => [:clobber_ext, :ext]
+
+desc 'Remove all files created during the build process'
+task :clobber => [:clobber_doc, :clobber_ext, :clobber_package]
+
+Rake::TestTask.new do |test|
+  test.test_files = TEST_FILES
+  test.verbose = true
+  test.warning = true
+end
+
+Rake::RDocTask.new('doc') do |rdoc|
+  rdoc.rdoc_files = DOC_FILES
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'README'
+  rdoc.title = 'LibIDN Ruby Bindings Documentation'
+  rdoc.options << '-N' << '-S' << '-w 2'
+end
+
+desc 'Publish the documentation'
+task :publish_doc => [:redoc] do
+  Rake::SshDirPublisher.new(PKG_EMAIL,
+    "/var/www/gforge-projects/idn/docs", 'doc').upload
+end
+
+begin
+  require 'rubygems'
+	require 'rake/gempackagetask'
+	spec = eval(File.read('idn.gemspec'))
+
+	Rake::GemPackageTask.new(spec) do |pkg|
+		pkg.need_zip = true
+		pkg.need_tar_gz = true
+	end
+rescue Exception
+  nil
+end
+

data/ext/extconf.rb

@@ -0,0 +1,56 @@
+# Makefile configuration for LibIDN Ruby Bindings.
+#
+# Copyright (c) 2005 Erik Abele. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# Please see the file called LICENSE for further details.
+#
+# You may also obtain a copy of the License at
+#
+# * http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# This software is OSI Certified Open Source Software.
+# OSI Certified is a certification mark of the Open Source Initiative.
+
+require 'mkmf'
+
+@libs = ['idn']
+@headers = ['idna.h', 'punycode.h', 'stringprep.h']
+
+INFO_NOTE = <<EOL
+  Please install the GNU IDN library or alternatively specify at least one
+  of the following options if the library can only be found in a non-standard
+  location:
+    --with-idn-dir=/path/to/non/standard/location
+        or
+    --with-idn-lib=/path/to/non/standard/location/lib
+    --with-idn-include=/path/to/non/standard/location/include
+EOL
+
+dir_config('idn')
+
+@libs.each do |lib|
+  unless have_library(lib)
+    STDERR.puts "ERROR: could not find #{lib} library!\n" +
+                "\n#{INFO_NOTE}\n"
+    exit 1
+  end
+end
+
+@headers.each do |header|
+  unless have_header(header)
+    STDERR.puts "ERROR: could not find #{header} header file!\n" +
+                "\n#{INFO_NOTE}\n"
+    exit 1
+  end
+end
+
+$CFLAGS += ' -Wall' unless $CFLAGS.split.include? '-Wall'
+create_makefile('idn')

data/ext/idn.c

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2005 Erik Abele. All rights reserved.
+ * Portions Copyright (c) 2005 Yuki Mitsui. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * Please see the file called LICENSE for further details.
+ *
+ * You may also obtain a copy of the License at
+ *
+ * * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * This software is OSI Certified Open Source Software.
+ * OSI Certified is a certification mark of the Open Source Initiative.
+ */
+
+#include <ruby.h>
+#include "idn.h"
+
+/*
+ * Document-class: IDN
+ * The main module of LibIDN Ruby Bindings.
+ *
+ * === Example usage
+ *
+ *   require 'idn'
+ *   include IDN
+ *
+ *   ...
+ */
+
+VALUE mIDN;
+
+/*
+ * Document-class: IDN::IDNError
+ * The superclass for all exceptions raised by the IDN extension.
+ */
+
+VALUE eIDNError;
+
+/*
+ * Module Initialization.
+ */
+
+void Init_idn(void)
+{
+  mIDN = rb_define_module("IDN");
+  eIDNError = rb_define_class_under(mIDN, "IDNError", rb_eStandardError);
+
+  init_idna();
+  init_punycode();
+  init_stringprep();
+}

data/ext/idn.h

@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2005 Erik Abele. All rights reserved.
+ * Portions Copyright (c) 2005 Yuki Mitsui. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * Please see the file called LICENSE for further details.
+ *
+ * You may also obtain a copy of the License at
+ *
+ * * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * This software is OSI Certified Open Source Software.
+ * OSI Certified is a certification mark of the Open Source Initiative.
+ */
+
+#ifndef ___IDN_IDN_H_
+#define ___IDN_IDN_H_
+
+#include <ruby.h>
+
+/*
+ * idn.c
+ */
+extern VALUE mIDN;
+extern VALUE eIDNError;
+
+/*
+ * idna.c
+ */
+extern VALUE mIdna;
+extern VALUE eIdnaError;
+
+void init_idna(void);
+
+/*
+ * punycode.c
+ */
+extern VALUE mPunycode;
+extern VALUE ePunycodeError;
+
+void init_punycode(void);
+
+/*
+ * stringprep.c
+ */
+extern VALUE mStringprep;
+extern VALUE eStringprepError;
+
+void init_stringprep(void);
+
+#endif /* ___IDN_IDN_H_ */

data/ext/idna.c

@@ -0,0 +1,164 @@
+/*
+ * Copyright (c) 2005 Erik Abele. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * Please see the file called LICENSE for further details.
+ *
+ * You may also obtain a copy of the License at
+ *
+ * * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * This software is OSI Certified Open Source Software.
+ * OSI Certified is a certification mark of the Open Source Initiative.
+ */
+
+#include <stdlib.h>
+#include <ruby.h>
+#include <idna.h>
+#include "idn.h"
+
+/*
+ * Document-class: IDN::Idna
+ * The Idna module of LibIDN Ruby Bindings.
+ *
+ * === Example usage
+ *
+ *   require 'idn'
+ *   include IDN
+ *
+ *   puts 'ACE-Prefix: ' + Idna::ACE_PREFIX
+ *
+ *   domain = Idna.toUnicode('xn--rksmrgs-5wao1o.josefsson.org',
+ *     Idna::USE_STD3_ASCII_RULES | Idna::ALLOW_UNASSIGNED)
+ *
+ * === Constants
+ *
+ * <b>ACE_PREFIX</b>
+ * - The ACE prefix: 'xn--'.
+ *
+ * <b>ALLOW_UNASSIGNED</b>
+ * - Used as flag for toASCII/toUnicode.
+ *
+ * <b>USE_STD3_ASCII_RULES</b>
+ * - Used as flag for toASCII/toUnicode.
+ */
+
+VALUE mIdna;
+
+/*
+ * Document-class: IDN::Idna::IdnaError
+ * The base class for all exceptions raised by the IDN::Idna module.
+ */
+
+VALUE eIdnaError;
+
+/*
+ * call-seq:
+ *   IDN::Idna.toASCII(string, flags=nil) => string
+ *
+ * Converts a domain name in UTF-8 format into an ASCII string. The domain
+ * name may contain several labels, separated by dots.
+ *
+ * Raises IDN::Idna::IdnaError on failure.
+ */
+
+static VALUE toASCII(int argc, VALUE argv[], VALUE self)
+{
+  int rc;
+  char *buf;
+  VALUE str, flags, retv;
+
+  rb_scan_args(argc, argv, "11", &str, &flags);
+  str = rb_check_convert_type(str, T_STRING, "String", "to_s");
+
+  if (flags != Qnil) {
+    Check_Type(flags, T_FIXNUM);
+    flags = FIX2INT(flags);
+  } else {
+    flags = 0x0000;
+  }
+
+  rc = idna_to_ascii_8z(RSTRING_PTR(str), &buf, flags);
+
+  if (rc != IDNA_SUCCESS) {
+    xfree(buf);
+    rb_raise(eIdnaError, "%s (%d)", idna_strerror(rc), rc);
+    return Qnil;
+  }
+
+  retv = rb_str_new2(buf);
+  xfree(buf);
+  return retv;
+}
+
+/*
+ * call-seq:
+ *   IDN::Idna.toUnicode(string, flags=nil) => string
+ *
+ * Converts a possibly ACE encoded domain name in UTF-8 format into an
+ * UTF-8 string. The domain name may contain several labels, separated
+ * by dots.
+ *
+ * Raises IDN::Idna::IdnaError on failure.
+ */
+
+static VALUE toUnicode(int argc, VALUE argv[], VALUE self)
+{
+  int rc;
+  char *buf;
+  VALUE str, flags, retv;
+
+  rb_scan_args(argc, argv, "11", &str, &flags);
+  str = rb_check_convert_type(str, T_STRING, "String", "to_s");
+
+  if (flags != Qnil) {
+    Check_Type(flags, T_FIXNUM);
+    flags = FIX2INT(flags);
+  } else {
+    flags = 0x0000;
+  }
+
+  rc = idna_to_unicode_8z8z(RSTRING_PTR(str), &buf, flags);
+
+  if (rc != IDNA_SUCCESS) {
+    xfree(buf);
+    rb_raise(eIdnaError, "%s (%d)", idna_strerror(rc), rc);
+    return Qnil;
+  }
+
+  retv = rb_str_new2(buf);
+  xfree(buf);
+  return retv;
+}
+
+/*
+ * Module Initialization.
+ */
+
+void init_idna(void)
+{
+#ifdef mIDN_RDOC_HACK
+  mIDN = rb_define_module("IDN");
+  eIDNError = rb_define_class_under(mIDN, "IDNError", rb_eStandardError);
+#endif
+
+  mIdna = rb_define_module_under(mIDN, "Idna");
+  eIdnaError = rb_define_class_under(mIdna, "IdnaError", eIDNError);
+
+  rb_define_const(mIdna, "ACE_PREFIX",
+                  rb_str_new2(IDNA_ACE_PREFIX));
+  rb_define_const(mIdna, "ALLOW_UNASSIGNED",
+                  INT2FIX(IDNA_ALLOW_UNASSIGNED));
+  rb_define_const(mIdna, "USE_STD3_ASCII_RULES",
+                  INT2FIX(IDNA_USE_STD3_ASCII_RULES));
+
+  rb_define_singleton_method(mIdna, "toASCII", toASCII, -1);
+  rb_define_singleton_method(mIdna, "toUnicode", toUnicode, -1);
+}