idnx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 931f92a4d37e74baad51a046058aa31aa0054563936e40e451f77eecd8eaf1b1
+  data.tar.gz: bed5e05b59d801504c2110d851723e09b302dc4a48169334ddebb4a493ed07d1
+SHA512:
+  metadata.gz: 905cf486978554c95bb7c7b912338439cb4acd431bb50d11cbe6afaee8047a9b53e28f522b4986873817ca8c76523eab7a5b784109f877001846228e7212ebfa
+  data.tar.gz: c94fd02aaf52386076a9a022f922d1962c1ce813b82a403f35f0d50fd4c68bb719a7def9a401a34a1aca62f8ac8443695e9dbadba5ed7bf8316459ea0b001a16

data/LICENSE.txt

@@ -0,0 +1,239 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2013-2017 Docker, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://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.
+
+
+* lib/httpx/domain_name.rb
+
+This file is derived from the implementation of punycode available at
+here:
+
+https://www.verisign.com/en_US/channel-resources/domain-registry-products/idn-sdks/index.xhtml
+
+Copyright (C) 2000-2002 Verisign Inc., All rights reserved.
+
+Redistribution and use in source and binary forms, with or
+without modification, are permitted provided that the following
+conditions are met:
+
+ 1) Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+ 2) Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+ 3) Neither the name of the VeriSign Inc. nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+This software is licensed under the BSD open source license. For more
+information visit www.opensource.org.
+
+Authors:
+ John Colosi (VeriSign)
+ Srikanth Veeramachaneni (VeriSign)
+ Nagesh Chigurupati (Verisign)
+ Praveen Srinivasan(Verisign)

data/README.md

@@ -0,0 +1,52 @@
+# Idnx
+
+
+`idnx` provides a Ruby API for decoding Internationalized domain names into Punycode.
+
+It provides multi-platform support by using the most approriate strategy based on the target environment:
+
+* It uses (and requires the installation of) [libidn2](https://github.com/libidn/libidn2) in Linux / MacOS;
+* It uses [the appropriate winnls APIs](https://docs.microsoft.com/en-us/windows/win32/api/winnls/nf-winnls-idntoascii) in Windows;
+
+## Installation
+
+If you're on Linux or Mac OS, you'll have to install `libidn2` first:
+
+```
+# Mac OS
+> brew install libidn2
+# Ubuntu, as an example
+> apt-get install idn2
+```
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'idnx'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install idnx
+
+## Usage
+
+```ruby
+require "idnx"
+
+Idnx.to_punycode("bücher.de") #=> "xn--bcher-kva.de"
+```
+
+## Development
+
+If you want to contribute, fork this project, and submit changes via a PR on github.
+
+For running tests, you can run `rake test`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/HoneyryderChuck/idnx.

data/lib/idnx.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "idnx/version"
+require "ffi"
+
+module Idnx
+  Error = Class.new(StandardError)
+
+  module_function
+
+  def to_punycode(hostname)
+    Lib.lookup(hostname)
+  end
+end
+
+if FFI::Platform.windows?
+  require "idnx/windows"
+else
+  require "idnx/idn2"
+end

data/lib/idnx/idn2.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Idnx
+  module Lib
+    extend FFI::Library
+
+    if FFI::Platform.mac?
+      ffi_lib ["libidn2", "libidn2.0"]
+    else
+      ffi_lib ["libidn2.so", "libidn2.so.0"]
+    end
+
+    attach_function :idn2_check_version, [:string], :string
+
+    VERSION = idn2_check_version(nil)
+
+    IDN2_OK = 0
+
+    IDN2_NFC_INPUT = 1
+    IDN2_TRANSITIONAL = 4
+    IDN2_NONTRANSITIONAL = 8
+
+    FLAGS = if Gem::Version.new(VERSION) >= Gem::Version.new("0.14.0")
+      IDN2_NFC_INPUT | IDN2_NONTRANSITIONAL
+    else
+      IDN2_NFC_INPUT
+    end
+
+    attach_function :idn2_lookup_ul, [:string, :pointer, :int], :int
+    attach_function :idn2_strerror, [:int], :string
+    attach_function :idn2_free, [:pointer], :void
+
+    module_function
+
+    def lookup(hostname)
+      string_ptr = FFI::MemoryPointer.new(:pointer)
+      result = idn2_lookup_ul(hostname, string_ptr, FLAGS)
+
+      if result != IDN2_OK
+        result = idn2_lookup_ul(hostname, string_ptr, IDN2_TRANSITIONAL)
+      end
+
+      if result != IDN2_OK
+        string_ptr.free
+        raise Error, "Failed to convert \"#{hostname}\" to ascii; (error: #{idn2_strerror(result)})"
+      end
+
+      ptr = string_ptr.read_pointer
+
+      raise Error, "Failed to read \"#{hostname}\" to ascii" if ptr.null?
+
+      ascii = ptr.read_string
+
+      idn2_free(ptr)
+      string_ptr.free
+
+      ascii
+    end
+  end
+end

data/lib/idnx/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Idnx
+  VERSION = "0.0.1"
+end

data/lib/idnx/windows.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "win32ole"
+
+module Idnx
+  module Lib
+    extend FFI::Library
+
+    ffi_lib "Normaliz.dll"
+    ffi_lib "kernel32.dll"
+
+    IDN_MAX_LENGTH = 255
+    MB_ERR_INVALID_CHARS = 0x00000008
+
+    ERROR_INSUFFICIENT_BUFFER = 0x7A
+    ERROR_INVALID_FLAGS = 0x3EC
+    ERROR_INVALID_NAME = 0x7B
+    ERROR_INVALID_PARAMETER = 0x57
+    ERROR_NO_UNICODE_TRANSLATION = 0x459
+
+    # int IdnToAscii(
+    #   DWORD   dwFlags,
+    #   LPCWSTR lpUnicodeCharStr,
+    #   int     cchUnicodeChar,
+    #   LPWSTR  lpASCIICharStr,
+    #   int     cchASCIIChar
+    # );
+    #
+    # int MultiByteToWideChar(
+    #   UINT                              CodePage,
+    #   DWORD                             dwFlags,
+    #   _In_NLS_string_(cbMultiByte)LPCCH lpMultiByteStr,
+    #   int                               cbMultiByte,
+    #   LPWSTR                            lpWideCharStr,
+    #   int                               cchWideChar
+    # );
+    #
+    # int WideCharToMultiByte(
+    #   UINT                               CodePage,
+    #   DWORD                              dwFlags,
+    #   _In_NLS_string_(cchWideChar)LPCWCH lpWideCharStr,
+    #   int                                cchWideChar,
+    #   LPSTR                              lpMultiByteStr,
+    #   int                                cbMultiByte,
+    #   LPCCH                              lpDefaultChar,
+    #   LPBOOL                             lpUsedDefaultChar
+    # );
+    attach_function :IdnToAscii, [:uint, :pointer, :int, :pointer, :int], :int
+    attach_function :MultiByteToWideChar, [:uint, :uint, :string, :int, :pointer, :int], :int
+    attach_function :WideCharToMultiByte, [:uint, :uint, :pointer, :int, :pointer, :int, :pointer, :pointer], :int
+
+    module_function
+
+    def lookup(hostname)
+      # turn to wchar
+      wchar_len = MultiByteToWideChar(WIN32OLE::CP_UTF8, MB_ERR_INVALID_CHARS, hostname, -1, nil, 0)
+      raise Error, "Failed to convert \"#{hostname}\" to wchar" if wchar_len.zero?
+      wchar_ptr = FFI::MemoryPointer.new(:wchar_t, wchar_len)
+      wchar_len = MultiByteToWideChar(WIN32OLE::CP_UTF8, 0, hostname, -1, wchar_ptr, wchar_len)
+      raise Error, "Failed to convert \"#{hostname}\" to wchar" if wchar_len.zero?
+
+      # translate to punycode
+      punycode = FFI::MemoryPointer.new(:wchar_t, IDN_MAX_LENGTH)
+      punycode_len = IdnToAscii(0, wchar_ptr, -1, punycode, IDN_MAX_LENGTH)
+      wchar_ptr.free
+
+      if punycode_len == 0
+        last_error = FFI::LastError.error
+
+        # operation completed successfully, hostname is not an IDN
+        # return hostname if last_error == 0
+
+        message = case last_error
+        when ERROR_INSUFFICIENT_BUFFER
+          "The supplied buffer size was not large enough, or it was incorrectly set to NULL"
+        when ERROR_INVALID_FLAGS
+          "The values supplied for flags were not valid"
+        when ERROR_INVALID_NAME
+          "An invalid name was supplied to the function"
+        when ERROR_INVALID_PARAMETER
+          "Any of the parameter values was invalid"
+        when ERROR_NO_UNICODE_TRANSLATION
+          "An invalid Unicode was found in a string"
+        else
+          "Failed to convert \"#{hostname}\"; (error: #{last_error})" \
+            "\n\nhttps://docs.microsoft.com/en-us/windows/win32/debug/system-error-codes#system-error-codes-1"
+        end
+        punycode.free
+        raise Error, message
+      end
+
+      # turn to unicode
+      unicode_len = WideCharToMultiByte(WIN32OLE::CP_UTF8, 0, punycode, -1, nil, 0, nil, nil)
+      raise Error, "Failed to convert \"#{hostname}\" to utf8" if unicode_len.zero?
+      utf8_ptr = FFI::MemoryPointer.new(:char, unicode_len)
+      unicode_len = WideCharToMultiByte(WIN32OLE::CP_UTF8, 0, punycode, -1, utf8_ptr, unicode_len, nil, nil)
+      raise Error, "Failed to convert \"#{hostname}\" to utf8" if unicode_len.zero?
+      unicode = utf8_ptr.read_string(utf8_ptr.size)
+      unicode.strip! # remove null-byte
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: idnx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- HoneyryderChuck
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: |2
+      Converts International Domain Names into Punycode.
+      It uses (via FFI) 'libidn2' for Mac and Linux; for Windows, it uses native APIs.
+email:
+- cardoso_tiago@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- lib/idnx.rb
+- lib/idnx/idn2.rb
+- lib/idnx/version.rb
+- lib/idnx/windows.rb
+homepage: https://github.com/honeyryderchuck/idnx
+licenses: []
+metadata:
+  homepage_uri: https://github.com/honeyryderchuck/idnx
+  source_code_uri: https://github.com/honeyryderchuck/idnx
+  changelog_uri: https://github.com/honeyryderchuck/idnx/-/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Converts International Domain Names into Punycode. It uses (via FFI) 'libidn2'
+  for Mac and Linux; for Windows, it uses native APIs.
+test_files: []