idn-ruby 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/CHANGES ADDED
@@ -0,0 +1,17 @@
1
+ Changes with IDN 0.1.0 (2011-03-31)
2
+
3
+ * Fix compilation errors in ruby 1.9.2p0 (2010-08-18 revision 29036).
4
+
5
+ Changes with IDN 0.0.2 (2006-02-11)
6
+
7
+ * Remove excessive xfree() if a call to stringprep_profile() returns an
8
+ error. Fixes crash reported in PR #3088.
9
+
10
+ * Add tests for invalid Stringprep strings and adjust names of already
11
+ existing test methods.
12
+
13
+ * Improve existing tests for IDN::Idna.
14
+
15
+ Changes with IDN 0.0.1 (2005-09-26)
16
+
17
+ * First release.
data/LICENSE ADDED
@@ -0,0 +1,247 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
202
+
203
+ -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + --
204
+
205
+ SUBCOMPONENT LICENSES
206
+
207
+ This software includes a number of subcomponents with separate copyright
208
+ notices and additional license terms. Your use of the source code for
209
+ these components is subject to the terms and conditions of the following
210
+ licenses:
211
+
212
+ -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + --
213
+
214
+ = ext/idn.c
215
+ = ext/idn.h
216
+ = ext/punycode.c
217
+ = ext/stringprep.c
218
+
219
+ Portions Copyright (c) 2005 Yuki Mitsui. All rights reserved.
220
+
221
+ Redistribution and use in source and binary forms, with or without
222
+ modification, are permitted provided that the following conditions
223
+ are met:
224
+
225
+ * Redistributions of source code must retain the above copyright
226
+ notice, this list of conditions and the following disclaimer.
227
+
228
+ * Redistributions in binary form must reproduce the above copyright
229
+ notice, this list of conditions and the following disclaimer in
230
+ the documentation and/or other materials provided with the
231
+ distribution.
232
+
233
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
234
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
235
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
236
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
237
+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
238
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
239
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
240
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
241
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
242
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
243
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
244
+
245
+ -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + -- + --
246
+
247
+ + END OF ALL TERMS AND CONDITIONS +
data/NOTICE ADDED
@@ -0,0 +1,5 @@
1
+ This product includes software developed by Erik Abele
2
+ (http://www.codefaktor.de/).
3
+
4
+ This software contains code derived from the Net::XMPP for Ruby
5
+ project by Yuki Mitsui (http://netxmpp-ruby.jabberstudio.org/).
data/README ADDED
@@ -0,0 +1,193 @@
1
+ == LibIDN Ruby Bindings
2
+
3
+ Version 0.1.0
4
+
5
+ Ruby Bindings for the GNU LibIDN library, an implementation of the
6
+ Stringprep, Punycode and IDNA specifications defined by the IETF
7
+ Internationalized Domain Names (IDN) working group.
8
+
9
+ Included are the most important parts of the Stringprep, Punycode
10
+ and IDNA APIs like performing Stringprep processings, encoding to
11
+ and decoding from Punycode strings and converting entire domain names
12
+ to and from the ACE encoded form.
13
+
14
+ The latest version of the LibIDN Ruby Bindings project and its
15
+ documentation can always be found at
16
+
17
+ * http://rubyforge.org/projects/idn
18
+
19
+ See the CHANGES file for detailed information on the changes of every
20
+ released version.
21
+
22
+
23
+ === Requirements
24
+
25
+ * GNU LibIDN[http://www.gnu.org/software/libidn/] Library
26
+
27
+ * Rake[http://rubyforge.org/projects/rake] to run the tests and generate
28
+ the documentation
29
+
30
+ * RubyGems[http://docs.rubygems.org/] to produce a Gem package
31
+
32
+ * Ruby 1.9.1 or above. Patches welcome to make this work in 1.8.7
33
+
34
+
35
+ === Installation
36
+
37
+ You can easily install the LibIDN Ruby Bindings by following one of the
38
+ ways outlined below:
39
+
40
+ ==== Automatic installation and management with RubyGems
41
+
42
+ Simply invoke the standard RubyGems commands (install, update, ...),
43
+ for example:
44
+
45
+ % gem install --remote --test idn
46
+
47
+ or if the GNU LibIDN library can only be found in a non-standard location
48
+
49
+ % gem install --remote --test idn -- \
50
+ --with-idn-dir=/path/to/non/standard/location
51
+
52
+ or in an even more complex setup
53
+
54
+ % gem install --remote --test idn -- \
55
+ --with-idn-lib=/path/to/non/standard/location/lib \
56
+ --with-idn-include=/path/to/non/standard/location/include
57
+
58
+ ==== Semi-automatic installation with Rake
59
+
60
+ If you are not able to or don't want to use RubyGems you can simply
61
+ download the latest release and install it with the help of Rake:
62
+
63
+ % tar -xvzf idn-x.x.x.tar.gz
64
+ % cd idn-x.x.x
65
+
66
+ % rake install
67
+
68
+ or if the GNU LibIDN library can only be found in a non-standard location
69
+
70
+ % rake install IDN_DIR=/path/to/non/standard/location
71
+
72
+ You can also run the tests or generate the documentation; just call Rake
73
+ with the '--tasks' parameter to get an overview of the available tasks:
74
+
75
+ % rake --tasks
76
+
77
+ ==== Manual installation with extconf.rb
78
+
79
+ If you are not able to or don't want to use even Rake then you will have to
80
+ do a little bit more work by yourself:
81
+
82
+ % tar -xvzf idn-x.x.x.tar.gz
83
+ % cd idn-x.x.x/ext
84
+
85
+ % ruby extconf.rb
86
+
87
+ or if the GNU LibIDN library can only be found in a non-standard location
88
+
89
+ % ruby extconf.rb \
90
+ --with-idn-dir=/path/to/non/standard/location
91
+
92
+ or in an even more complex setup
93
+
94
+ % ruby extconf.rb \
95
+ --with-idn-lib=/path/to/non/standard/location/lib \
96
+ --with-idn-include=/path/to/non/standard/location/include
97
+
98
+ and finally
99
+
100
+ % make
101
+ % sudo make install
102
+
103
+
104
+ === Documentation
105
+
106
+ The complete documentation is available online at
107
+
108
+ * http://idn.rubyforge.org/docs
109
+
110
+ See also the section on 'Semi-automatic installation with Rake' above for
111
+ some details on how to generate the documentation by yourself.
112
+
113
+ ==== Example usage
114
+
115
+ require 'idn'
116
+ include IDN
117
+
118
+ puts 'Idna.toUnicode: ' + Idna.toUnicode('xn--rksmrgs-5wao1o.josefsson.org')
119
+ puts 'Punycode.decode: ' + Punycode.decode('egbpdaj6bu4bxfgehfvwxn')
120
+ puts 'Stringprep.with_profile: ' + Stringprep.with_profile('FOO', 'Nameprep')
121
+
122
+
123
+ === References
124
+
125
+ [GNU LibIDN]
126
+ An implementation of the Stringprep, Punycode and IDNA specifications
127
+ defined by the IETF Internationalized Domain Names (IDN) working group,
128
+ used for internationalized domain names. The package is available under
129
+ the GNU Lesser General Public License.
130
+
131
+ * http://www.gnu.org/software/libidn
132
+
133
+ [RFC3454]
134
+ P. Hoffman, M. Blanchet, "Preparation of Internationalized Strings
135
+ ('stringprep')", IETF RFC3454, December 2002.
136
+
137
+ * http://www.ietf.org/rfc/rfc3454.txt
138
+
139
+ [RFC3490]
140
+ P. Faltstrom, P. Hoffman, A. Costello, "Internationalizing Domain
141
+ Names in Applications (IDNA)", IETF RFC3490, March 2003.
142
+
143
+ * http://www.ietf.org/rfc/rfc3490.txt
144
+
145
+ [RFC3491]
146
+ P. Hoffman, M. Blanchet, "Nameprep: A Stringprep Profile for
147
+ Internationalized Domain Names (IDN)", IETF RFC3491, March 2003.
148
+
149
+ * http://www.ietf.org/rfc/rfc3491.txt
150
+
151
+ [RFC3492]
152
+ A. Costello, "Punycode: A Bootstring encoding of Unicode for
153
+ Internationalized Domain Names in Applications (IDNA)", IETF
154
+ RFC3492, March 2003.
155
+
156
+ * http://www.ietf.org/rfc/rfc3492.txt
157
+
158
+
159
+ === Questions, comments, patches?
160
+
161
+ If you have any questions, comments or feature requests or if you want
162
+ to submit a bug report or provide a patch, then have a look at the project
163
+ website at
164
+
165
+ * http://rubyforge.org/projects/idn
166
+
167
+ For other information, feel free to ask on the idn-discuss at rubyforge.org
168
+ mailing list.
169
+
170
+
171
+ === Copyright & License
172
+
173
+ Copyright (c) 2005-2006 Erik Abele. 2011 Bharanee Rathna. All rights reserved.
174
+
175
+ This documentation and the software itself are licensed under the Apache
176
+ License, Version 2.0 (the "License").
177
+
178
+ Some portions of the software come with separate copyright notices and are
179
+ subject to additional license terms. Please see the file called LICENSE for
180
+ further details on these subcomponents of the software.
181
+
182
+ You may also obtain a copy of the License at
183
+
184
+ * http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
191
+
192
+ This software is OSI Certified Open Source Software.
193
+ OSI Certified is a certification mark of the Open Source Initiative.