puppet-pson 1.1.10

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: bb042b282fec5f28bd294898b6b435064301a165a9af99e71a3332d0be0e866b
4
+ data.tar.gz: 8420168506ed72a4b1ba023f87709e469fd6135b6adff3e492414b2601fd2c92
5
+ SHA512:
6
+ metadata.gz: a35a90d4a0dacefe172b18808f448090e1eeb76a38483e171b1d70469610ab38243c591a709d66a40bf2af18374a13e2398546a0d9fcb540a486a73c9be238be
7
+ data.tar.gz: e270512fedba002f929e05125f3b754c15cb43613ab8dfd73914a0cdfd66ce81508c59bc2a0451b4499f8cc030e5360ec728d642990a866c8ea3208afedf6d9c
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/CODEOWNERS ADDED
@@ -0,0 +1,2 @@
1
+ # added by slack-gitbot
2
+ * @puppetlabs/phoenix
data/Gemfile ADDED
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+
3
+ source "https://rubygems.org"
4
+
5
+ # Specify your gem's dependencies in puppet-pson.gemspec
6
+ gemspec
7
+
8
+ gem "rake", "~> 13.0"
9
+
10
+ gem "rspec", "~> 3.0"
data/LICENSE.txt ADDED
@@ -0,0 +1,201 @@
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.
data/README.md ADDED
@@ -0,0 +1,116 @@
1
+ PSON
2
+ =============
3
+
4
+ PSON is a variant of [JSON](http://json.org) that puppet uses for serializing
5
+ data to transmit across the network or store on disk. Whereas JSON requires
6
+ that the serialized form is valid unicode (usually UTF-8), PSON is 8-bit ASCII,
7
+ which allows it to represent arbitrary byte sequences in strings.
8
+
9
+ PSON was forked from upstream [pure JSON v1.1.9](https://github.com/flori/json/tree/v1.1.9/lib/json/pure) and patches
10
+ were added to [allow binary data](https://github.com/puppetlabs/puppet/commit/3c56705a95c945778674f9792a07b66b879cb48e).
11
+
12
+ Puppet uses the MIME types "pson" and "text/pson" to refer to PSON.
13
+
14
+ JSON Strings
15
+ -------------
16
+
17
+ A JSON string is encoded in Unicode. The string must start and end with " (ASCII
18
+ 0x22). Between these characters, double quote, reverse solidus (backslash) and
19
+ control characters (\u0000 - \u001F) must be escaped, all others may be escaped.
20
+
21
+ The escape process replaces each code point with "reverse solidus, followed by
22
+ the lowercase letter u, followed by four hexadecimal digits that encode the
23
+ character's code point." For example, the ASCII record separator character
24
+ (\u001F) is serialized in JSON as:
25
+
26
+ 0x5C 0x75 0x30 0x30 0x31 0x45
27
+
28
+ In addition, the double quote, reverse solidus and some printable control
29
+ characters are commonly escaped using a shorter form, using a single reverse
30
+ solidus:
31
+
32
+ | Byte | ASCII Character | Encoded Sequence | Encoded ASCII Sequence |
33
+ | ---- | --------------- | ---------------- | ---------------------- |
34
+ | 0x22 | " | 0x5C, 0x22 | \" |
35
+ | 0x5c | \ | 0x5C, 0x5C | \\ |
36
+ | 0x08 | Backspace | 0x5C, 0x62 | \b |
37
+ | 0x09 | Horizontal Tab | 0x5C, 0x74 | \t |
38
+ | 0x0A | Line Feed | 0x5C, 0x6E | \n |
39
+ | 0x0C | Form Feed | 0x5C, 0x66 | \f |
40
+ | 0x0D | Carriage Return | 0x5C, 0x72 | \r |
41
+
42
+ UTF-8/16/32 encodings define a set of rules for how code points are encoded as
43
+ bytes. However, there are some byte sequences that are not a valid encoding for
44
+ any code point. For example, in UTF-8, 0x80 is used to indicate a two byte
45
+ sequence, so the following fails:
46
+
47
+ JSON.generate("\x80")
48
+ #=> JSON::GeneratorError (source sequence is illegal/malformed utf-8)
49
+
50
+ Differences from JSON
51
+ ---------------------
52
+
53
+ PSON does *not differ* from JSON in its representation of objects, arrays,
54
+ numbers, booleans, and null values. PSON *does* serialize strings differently
55
+ from JSON.
56
+
57
+ PSON shares the same encoding process as JSON, except that a PSON string is a
58
+ sequence of 8-bit ASCII values. So the string containing 0x80 can be serialized
59
+ *unescaped* as PSON:
60
+
61
+ PSON.generate("\x80").bytes.to_a.map { |b| b.to_s(16) }
62
+ #=> ["22", "80", "22"]
63
+
64
+ One other difference is that PSON *may* produce strings with 8-bit ASCII
65
+ encoding, unlike JSON:
66
+
67
+ PSON.generate("\u20AC").encoding
68
+ #=> #<Encoding:ASCII-8BIT>
69
+ JSON.generate("\u20AC").encoding
70
+ #=> #<Encoding:UTF-8>
71
+
72
+ Finally, PSON does not roundtrip values that are not arrays or hashes in the same way as JSON:
73
+
74
+ JSON.parse(JSON.generate("\x1E"))
75
+ #=> "\u001E"
76
+ PSON.parse(PSON.generate("\x1E"))
77
+ #=> PSON::ParserError (source '"\u001e"' not in PSON!)
78
+
79
+ whereas PSON can roundtrip an array (or hash) containing that value:
80
+
81
+ PSON.parse(PSON.generate(["\x1E"]))
82
+ #=> ["\u001E"]
83
+
84
+ Decoding PSON Using JSON Parsers
85
+ --------------------------------
86
+
87
+ Many languages have JSON parsers already, which can often be used to parse PSON
88
+ data. Although JSON requires that it is encoded as unicode most parsers will
89
+ produce usable output from PSON if they are instructed to interpret the input
90
+ as Latin-1 encoding.
91
+
92
+ In all these examples there is a file available called `data.pson` that
93
+ contains the ruby structure `{ "data" => "\x07\x08\xC3\xC3" }` encoded as
94
+ PSON (the value is an invalid unicode sequence). In bytes the data is:
95
+
96
+ 0x7b 0x22 0x64 0x61 0x74 0x61 0x22 0x3a 0x22 0x5c 0x75 0x30 0x30 0x30 0x37 0x5c 0x62 0xc3 0xc3 0x22 0x7d
97
+
98
+ which represents:
99
+
100
+ { " d a t a " <sp> " \ u 0 0 0 7 \ b 0xc3 0xc3 " }
101
+
102
+ Python Example:
103
+
104
+ >>> import json
105
+ >>> json.load(open("data.pson"), "latin_1")
106
+ {u'data': u'\x07\x08\xc3\xc3'}
107
+
108
+ Clojure Example:
109
+
110
+ user> (parse-string (slurp "data.pson" :encoding "ISO-8859-1"))
111
+ {"data" "^G\bÃÃ"}
112
+
113
+ Ruby Example:
114
+
115
+ irb> JSON.parse(File.read('data.pson', encoding: "ISO-8859-1"))
116
+ => {"data"=>"\a\bÃÃ"}
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ task default: :spec