idn-ruby 0.1.0

data/ext/stringprep.c

@@ -0,0 +1,183 @@
+/*
+ * Copyright (c) 2005-2006 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 <stdlib.h>
+#include <ruby.h>
+#include <stringprep.h>
+#include "idn.h"
+
+/*
+ * Document-class: IDN::Stringprep
+ * The Stringprep module of LibIDN Ruby Bindings.
+ *
+ * === Example usage
+ *
+ *   require 'idn'
+ *   include IDN
+ *
+ *   str = Stringprep.with_profile('FOO', 'Nameprep')
+ */
+
+VALUE mStringprep;
+
+/*
+ * Document-class: IDN::Stringprep::StringprepError
+ * The base class for all exceptions raised by the IDN::Stringprep module.
+ */
+
+VALUE eStringprepError;
+
+/*
+ * Internal helper function:
+ *   stringprep_internal
+ *
+ * Prepares the given string in UTF-8 format according to the given
+ * stringprep profile name. See the various public wrapper functions
+ * below for details.
+ *
+ * Raises IDN::Stringprep::StringprepError on failure.
+ */
+
+static VALUE stringprep_internal(VALUE str, const char *profile)
+{
+  int rc;
+  char *buf;
+  VALUE retv;
+
+  str = rb_check_convert_type(str, T_STRING, "String", "to_s");
+  rc = stringprep_profile(RSTRING_PTR(str), &buf, profile, 0);
+
+  if (rc != STRINGPREP_OK) {
+    rb_raise(eStringprepError, "%s (%d)", stringprep_strerror(rc), rc);
+    return Qnil;
+  }
+
+  retv = rb_str_new2(buf);
+  xfree(buf);
+  return retv;
+}
+
+/*
+ * call-seq:
+ *   IDN::Stringprep.nameprep(string) => string
+ *
+ * Prepares a string in UTF-8 format according to the 'Nameprep'
+ * profile.
+ *
+ * Raises IDN::Stringprep::StringprepError on failure.
+ */
+
+static VALUE nameprep(VALUE self, VALUE str)
+{
+  return stringprep_internal(str, "Nameprep");
+}
+
+/*
+ * call-seq:
+ *   IDN::Stringprep.nodeprep(string) => string
+ *
+ * Prepares a string in UTF-8 format according to the 'Nodeprep'
+ * profile.
+ *
+ * Raises IDN::Stringprep::StringprepError on failure.
+ */
+
+static VALUE nodeprep(VALUE self, VALUE str)
+{
+  return stringprep_internal(str, "Nodeprep");
+}
+
+/*
+ * call-seq:
+ *   IDN::Stringprep.resourceprep(string) => string
+ *
+ * Prepares a string in UTF-8 format according to the 'Resourceprep'
+ * profile.
+ *
+ * Raises IDN::Stringprep::StringprepError on failure.
+ */
+
+static VALUE resourceprep(VALUE self, VALUE str)
+{
+  return stringprep_internal(str, "Resourceprep");
+}
+
+/*
+ * call-seq:
+ *   IDN::Stringprep.with_profile(string, profile) => string
+ *
+ * Prepares a string in UTF-8 format according to the given stringprep
+ * profile name which must be one of the internally supported stringprep
+ * profiles (for details see IANA's Profile Names in RFC3454).
+ *
+ * Raises IDN::Stringprep::StringprepError on failure.
+ */
+
+static VALUE with_profile(VALUE self, VALUE str, VALUE profile)
+{
+  profile = rb_check_convert_type(profile, T_STRING, "String", "to_s");
+  return stringprep_internal(str, RSTRING_PTR(profile));
+}
+
+/*
+ * call-seq:
+ *   IDN::Stringprep.nfkc_normalize(string) => string
+ *
+ * Converts a string in UTF-8 format into canonical form, standardizing
+ * such issues as whether a character with an accent is represented as a
+ * base character and combining accent or as a single precomposed character.
+ */
+
+static VALUE nfkc_normalize(VALUE self, VALUE str)
+{
+  char *buf;
+  VALUE retv;
+
+  str = rb_check_convert_type(str, T_STRING, "String", "to_s");
+  buf = stringprep_utf8_nfkc_normalize(RSTRING_PTR(str), RSTRING_LEN(str));
+
+  retv = rb_str_new2(buf);
+  xfree(buf);
+  return retv;
+}
+
+/*
+ * Module Initialization.
+ */
+
+void init_stringprep(void)
+{
+#ifdef mIDN_RDOC_HACK
+  mIDN = rb_define_module("IDN");
+  eIDNError = rb_define_class_under(mIDN, "IDNError", rb_eStandardError);
+#endif
+
+  mStringprep = rb_define_module_under(mIDN, "Stringprep");
+  eStringprepError = rb_define_class_under(mStringprep, "StringprepError",
+                                           eIDNError);
+
+  rb_define_singleton_method(mStringprep, "nameprep", nameprep, 1);
+  rb_define_singleton_method(mStringprep, "nodeprep", nodeprep, 1);
+  rb_define_singleton_method(mStringprep, "resourceprep", resourceprep, 1);
+  rb_define_singleton_method(mStringprep, "with_profile", with_profile, 2);
+  rb_define_singleton_method(mStringprep, "nfkc_normalize", nfkc_normalize, 1);
+}

data/test/tc_Idna.rb

@@ -0,0 +1,273 @@
+# Unit tests for IDN::Idna.
+#
+# Copyright (c) 2005-2006 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 'test/unit'
+require 'idn'
+
+class Test_Idna < Test::Unit::TestCase
+  include IDN
+
+  # JOSEFSSON test vectors, taken from DRAFT-JOSEFSSON-IDN-TEST-VECTORS-00:
+  # http://www.gnu.org/software/libidn/draft-josefsson-idn-test-vectors.html
+  #
+  # Modifications:
+  #   - omission of 5.20 since it is identical with 5.8 (case H below)
+
+  TESTCASES_JOSEFSSON = {
+    'A' => [
+      [ 0x0644, 0x064A, 0x0647, 0x0645, 0x0627, 0x0628, 0x062A, 0x0643,
+        0x0644, 0x0645, 0x0648, 0x0634, 0x0639, 0x0631, 0x0628, 0x064A,
+        0x061F ].pack('U*'),
+      Idna::ACE_PREFIX + 'egbpdaj6bu4bxfgehfvwxn'
+    ],
+
+    'B' => [
+      [ 0x4ED6, 0x4EEC, 0x4E3A, 0x4EC0, 0x4E48, 0x4E0D, 0x8BF4, 0x4E2D,
+        0x6587 ].pack('U*'),
+      Idna::ACE_PREFIX + 'ihqwcrb4cv8a8dqg056pqjye'
+    ],
+
+    'C' => [
+      [ 0x4ED6, 0x5011, 0x7232, 0x4EC0, 0x9EBD, 0x4E0D, 0x8AAA, 0x4E2D,
+        0x6587 ].pack('U*'),
+      Idna::ACE_PREFIX + 'ihqwctvzc91f659drss3x8bo0yb'
+    ],
+
+    'D' => [
+      [ 0x0050, 0x0072, 0x006F, 0x010D, 0x0070, 0x0072, 0x006F, 0x0073,
+        0x0074, 0x011B, 0x006E, 0x0065, 0x006D, 0x006C, 0x0075, 0x0076,
+        0x00ED, 0x010D, 0x0065, 0x0073, 0x006B, 0x0079 ].pack('U*'),
+      Idna::ACE_PREFIX + 'Proprostnemluvesky-uyb24dma41a'
+    ],
+
+    'E' => [
+      [ 0x05DC, 0x05DE, 0x05D4, 0x05D4, 0x05DD, 0x05E4, 0x05E9, 0x05D5,
+        0x05D8, 0x05DC, 0x05D0, 0x05DE, 0x05D3, 0x05D1, 0x05E8, 0x05D9,
+        0x05DD, 0x05E2, 0x05D1, 0x05E8, 0x05D9, 0x05EA ].pack('U*'),
+      Idna::ACE_PREFIX + '4dbcagdahymbxekheh6e0a7fei0b'
+    ],
+
+    'F' => [
+      [ 0x092F, 0x0939, 0x0932, 0x094B, 0x0917, 0x0939, 0x093F, 0x0928,
+        0x094D, 0x0926, 0x0940, 0x0915, 0x094D, 0x092F, 0x094B, 0x0902,
+        0x0928, 0x0939, 0x0940, 0x0902, 0x092C, 0x094B, 0x0932, 0x0938,
+        0x0915, 0x0924, 0x0947, 0x0939, 0x0948, 0x0902 ].pack('U*'),
+      Idna::ACE_PREFIX + 'i1baa7eci9glrd9b2ae1bj0hfcgg6iyaf8o0a1dig0cd'
+    ],
+
+    'G' => [
+      [ 0x306A, 0x305C, 0x307F, 0x3093, 0x306A, 0x65E5, 0x672C, 0x8A9E,
+        0x3092, 0x8A71, 0x3057, 0x3066, 0x304F, 0x308C, 0x306A, 0x3044,
+        0x306E, 0x304B ].pack('U*'),
+      Idna::ACE_PREFIX + 'n8jok5ay5dzabd5bym9f0cm5685rrjetr6pdxa'
+    ],
+
+    'H' => [
+      [ 0x043F, 0x043E, 0x0447, 0x0435, 0x043C, 0x0443, 0x0436, 0x0435,
+        0x043E, 0x043D, 0x0438, 0x043D, 0x0435, 0x0433, 0x043E, 0x0432,
+        0x043E, 0x0440, 0x044F, 0x0442, 0x043F, 0x043E, 0x0440, 0x0443,
+        0x0441, 0x0441, 0x043A, 0x0438 ].pack('U*'),
+      Idna::ACE_PREFIX + 'b1abfaaepdrnnbgefbadotcwatmq2g4l'
+    ],
+
+    'I' => [
+      [ 0x0050, 0x006F, 0x0072, 0x0071, 0x0075, 0x00E9, 0x006E, 0x006F,
+        0x0070, 0x0075, 0x0065, 0x0064, 0x0065, 0x006E, 0x0073, 0x0069,
+        0x006D, 0x0070, 0x006C, 0x0065, 0x006D, 0x0065, 0x006E, 0x0074,
+        0x0065, 0x0068, 0x0061, 0x0062, 0x006C, 0x0061, 0x0072, 0x0065,
+        0x006E, 0x0045, 0x0073, 0x0070, 0x0061, 0x00F1, 0x006F,
+        0x006C ].pack('U*'),
+      Idna::ACE_PREFIX + 'PorqunopuedensimplementehablarenEspaol-fmd56a'
+    ],
+
+    'J' => [
+      [ 0x0054, 0x1EA1, 0x0069, 0x0073, 0x0061, 0x006F, 0x0068, 0x1ECD,
+        0x006B, 0x0068, 0x00F4, 0x006E, 0x0067, 0x0074, 0x0068, 0x1EC3,
+        0x0063, 0x0068, 0x1EC9, 0x006E, 0x00F3, 0x0069, 0x0074, 0x0069,
+        0x1EBF, 0x006E, 0x0067, 0x0056, 0x0069, 0x1EC7, 0x0074 ].pack('U*'),
+      Idna::ACE_PREFIX + 'TisaohkhngthchnitingVit-kjcr8268qyxafd2f1b9g'
+    ],
+
+    'K' => [
+      [ 0x0033, 0x5E74, 0x0042, 0x7D44, 0x91D1, 0x516B, 0x5148,
+        0x751F ].pack('U*'),
+      Idna::ACE_PREFIX + '3B-ww4c5e180e575a65lsy2b'
+    ],
+
+    'L' => [
+      [ 0x5B89, 0x5BA4, 0x5948, 0x7F8E, 0x6075, 0x002D, 0x0077, 0x0069,
+        0x0074, 0x0068, 0x002D, 0x0053, 0x0055, 0x0050, 0x0045, 0x0052,
+        0x002D, 0x004D, 0x004F, 0x004E, 0x004B, 0x0045, 0x0059,
+        0x0053 ].pack('U*'),
+      Idna::ACE_PREFIX + '-with-SUPER-MONKEYS-pc58ag80a8qai00g7n9n'
+    ],
+
+    'M' => [
+      [ 0x0048, 0x0065, 0x006C, 0x006C, 0x006F, 0x002D, 0x0041, 0x006E,
+        0x006F, 0x0074, 0x0068, 0x0065, 0x0072, 0x002D, 0x0057, 0x0061,
+        0x0079, 0x002D, 0x305D, 0x308C, 0x305E, 0x308C, 0x306E, 0x5834,
+        0x6240 ].pack('U*'),
+      Idna::ACE_PREFIX + 'Hello-Another-Way--fc4qua05auwb3674vfr0b'
+    ],
+
+    'N' => [
+      [ 0x3072, 0x3068, 0x3064, 0x5C4B, 0x6839, 0x306E, 0x4E0B,
+        0x0032 ].pack('U*'),
+      Idna::ACE_PREFIX + '2-u9tlzr9756bt3uc0v'
+    ],
+
+    'O' => [
+      [ 0x004D, 0x0061, 0x006A, 0x0069, 0x3067, 0x004B, 0x006F, 0x0069,
+        0x3059, 0x308B, 0x0035, 0x79D2, 0x524D ].pack('U*'),
+      Idna::ACE_PREFIX + 'MajiKoi5-783gue6qz075azm5e'
+    ],
+
+    'P' => [
+      [ 0x30D1, 0x30D5, 0x30A3, 0x30FC, 0x0064, 0x0065, 0x30EB, 0x30F3,
+        0x30D0 ].pack('U*'),
+      Idna::ACE_PREFIX + 'de-jg4avhby1noc0d'
+    ],
+
+    'Q' => [
+      [ 0x305D, 0x306E, 0x30B9, 0x30D4, 0x30FC, 0x30C9, 0x3067 ].pack('U*'),
+      Idna::ACE_PREFIX + 'd9juau41awczczp'
+    ],
+
+    'R' => [
+      [ 0x03B5, 0x03BB, 0x03BB, 0x03B7, 0x03BD, 0x03B9, 0x03BA,
+        0x03AC ].pack('U*'),
+      Idna::ACE_PREFIX + 'hxargifdar'
+    ],
+
+    'S' => [
+      [ 0x0062, 0x006F, 0x006E, 0x0121, 0x0075, 0x0073, 0x0061, 0x0127,
+        0x0127, 0x0061 ].pack('U*'),
+      Idna::ACE_PREFIX + 'bonusaa-5bb1da'
+    ]
+  }
+
+  # UNASSIGNED test vectors: unassigned code points U+0221 and U+0236.
+
+  TESTCASES_UNASSIGNED = {
+    'A' => [
+      [ 0x0221 ].pack('U*'),
+      Idna::ACE_PREFIX + '6la'
+    ],
+
+    'B' => [
+      [ 0x0236 ].pack('U*'),
+      Idna::ACE_PREFIX + 'sma'
+    ]
+  }
+
+  # STD3 test vectors: labels not conforming to the STD3 ASCII rules (see
+  # RFC1122 and RFC1123 for details).
+
+  TESTCASES_STD3 = {
+    'A' => [
+      [ 0x0115, 0x0073, 0x0074, 0x0065, 0x002D ].pack('U*'),
+      Idna::ACE_PREFIX + 'ste--kva'
+    ],
+
+    'B' => [
+      [ 0x006F, 0x003A, 0x006C, 0x006B, 0x01EB, 0x0065 ].pack('U*'),
+      Idna::ACE_PREFIX + 'o:lke-m1b'
+    ]
+  }
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_toASCII_JOSEFSSON
+    TESTCASES_JOSEFSSON.each do |key, val|
+      rc = Idna.toASCII(val[0])
+      assert_equal(val[1].downcase, rc, "TestCase #{key} failed")
+    end
+  end
+
+  def test_toASCII_UNASSIGNED_ALLOWED
+    TESTCASES_UNASSIGNED.each do |key, val|
+      rc = Idna.toASCII(val[0], IDN::Idna::ALLOW_UNASSIGNED)
+      assert_equal(val[1], rc, "TestCase #{key} failed")
+    end
+  end
+
+  def test_toASCII_UNASSIGNED_NOT_ALLOWED
+    TESTCASES_UNASSIGNED.each do |key, val|
+      assert_raise(Idna::IdnaError, "TestCase #{key} failed") do
+        Idna.toASCII(val[0])
+      end
+    end
+  end
+
+  def test_toASCII_STD3_USED
+    TESTCASES_STD3.each do |key, val|
+      assert_raise(Idna::IdnaError, "TestCase #{key} failed") do
+        Idna.toASCII(val[0], IDN::Idna::USE_STD3_ASCII_RULES)
+      end
+    end
+  end
+
+  def test_toASCII_STD3_NOT_USED
+    TESTCASES_STD3.each do |key, val|
+      rc = Idna.toASCII(val[0])
+      assert_equal(val[1], rc, "TestCase #{key} failed")
+    end
+  end
+
+  def test_toUnicode_JOSEFSSON
+    TESTCASES_JOSEFSSON.each do |key, val|
+      rc = Idna.toUnicode(val[1])
+      assert_equal(val[0], rc, "TestCase #{key} failed")
+    end
+  end
+
+  def test_toUnicode_UNASSIGNED_ALLOWED
+    TESTCASES_UNASSIGNED.each do |key, val|
+      rc = Idna.toUnicode(val[1], IDN::Idna::ALLOW_UNASSIGNED)
+      assert_equal(val[0], rc, "TestCase #{key} failed")
+    end
+  end
+
+  def test_toUnicode_UNASSIGNED_NOT_ALLOWED
+    TESTCASES_UNASSIGNED.each do |key, val|
+      rc = Idna.toUnicode(val[1])
+      assert_equal(val[1], rc, "TestCase #{key} failed")
+    end
+  end
+
+  def test_toUnicode_STD3_USED
+    TESTCASES_STD3.each do |key, val|
+      rc = Idna.toUnicode(val[1], IDN::Idna::USE_STD3_ASCII_RULES)
+      assert_equal(val[1], rc, "TestCase #{key} failed")
+    end
+  end
+
+  def test_toUnicode_STD3_NOT_USED
+    TESTCASES_STD3.each do |key, val|
+      rc = Idna.toUnicode(val[1])
+      assert_equal(val[0], rc, "TestCase #{key} failed")
+    end
+  end
+end