Native API String Encoding

Code

<span class="hljs-comment">// Requirements: com.google.Gson</span>
<span class="hljs-comment">// <span class="hljs-doctag">NOTE:</span> Remember to run the java with assertions on "-ea"</span>

<span class="hljs-keyword">import</span> com.google.gson.Gson;
<span class="hljs-keyword">import</span> com.google.gson.reflect.TypeToken;

<span class="hljs-keyword">import</span> java.io.FileNotFoundException;
<span class="hljs-keyword">import</span> java.io.FileReader;
<span class="hljs-keyword">import</span> java.io.IOException;
<span class="hljs-keyword">import</span> java.io.UnsupportedEncodingException;
<span class="hljs-keyword">import</span> java.lang.reflect.Type;
<span class="hljs-keyword">import</span> java.util.ArrayList;
<span class="hljs-keyword">import</span> java.util.List;

<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">B2</span> </span>{
    <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> String <span class="hljs-title">b2UrlEncode</span><span class="hljs-params">(String s)</span> <span class="hljs-keyword">throws</span> UnsupportedEncodingException </span>{
        <span class="hljs-keyword">return</span> java.net.URLEncoder.encode(s, <span class="hljs-string">"UTF-8"</span>).replace(<span class="hljs-string">"%2F"</span>, <span class="hljs-string">"/"</span>);
    }

    <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> String <span class="hljs-title">b2UrlDecode</span><span class="hljs-params">(String s)</span> <span class="hljs-keyword">throws</span> UnsupportedEncodingException </span>{
        <span class="hljs-keyword">return</span> java.net.URLDecoder.decode(s, <span class="hljs-string">"UTF-8"</span>);
    }

    <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">runTestCases</span><span class="hljs-params">()</span> </span>{
        Gson gson = <span class="hljs-keyword">new</span> Gson();
        FileReader stringEncodingTestCases = <span class="hljs-keyword">null</span>;
        <span class="hljs-keyword">try</span> {
            stringEncodingTestCases = <span class="hljs-keyword">new</span> FileReader(<span class="hljs-string">"/tmp/cases.json"</span>);
            Type listType = <span class="hljs-keyword">new</span> TypeToken<ArrayList<TestCase>>() {}.getType();
            List<TestCase> testCases = gson.fromJson(stringEncodingTestCases, listType);
            <span class="hljs-keyword">for</span> (TestCase aTestCase : testCases) {
                <span class="hljs-keyword">assert</span> aTestCase.string.equals(b2UrlDecode(aTestCase.fullyEncoded));
                <span class="hljs-keyword">assert</span> aTestCase.string.equals(b2UrlDecode(aTestCase.minimallyEncoded));
                String encoded = b2UrlEncode(aTestCase.string);
                <span class="hljs-keyword">assert</span> encoded.equals(aTestCase.fullyEncoded) || encoded.equals(aTestCase.minimallyEncoded);
            }
        } <span class="hljs-keyword">catch</span> (FileNotFoundException fnfx) {
            fnfx.printStackTrace();
        } <span class="hljs-keyword">catch</span> (UnsupportedEncodingException uex) {
            uex.printStackTrace();
        } <span class="hljs-keyword">finally</span> {
            <span class="hljs-keyword">try</span> {
                stringEncodingTestCases.close();
            } <span class="hljs-keyword">catch</span> (IOException iox) {
                iox.printStackTrace();
            }
        }
    }

    <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">main</span><span class="hljs-params">(String[] args)</span> </span>{
        runTestCases();
    }

    <span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">TestCase</span> </span>{
        <span class="hljs-keyword">public</span> String fullyEncoded;
        <span class="hljs-keyword">public</span> String minimallyEncoded;
        <span class="hljs-keyword">public</span> String string;
    }
}

Code

<span class="hljs-keyword">import</span> urllib
<span class="hljs-keyword">import</span> unittest
<span class="hljs-keyword">import</span> json

<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">b2_url_encode</span><span class="hljs-params">(s)</span>:</span>
    <span class="hljs-string">"""URL-encodes a unicode string to be sent to B2 in an HTTP header.
    """</span>
    <span class="hljs-keyword">return</span> urllib.quote(s.encode(<span class="hljs-string">'utf-8'</span>))

<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">b2_url_decode</span><span class="hljs-params">(s)</span>:</span>
    <span class="hljs-string">"""Decodes a Unicode string returned from B2 in an HTTP header.

    Returns a Python unicode string.
    """</span>
    <span class="hljs-comment"># Use str() to make sure that the input to unquote is a str, not</span>
    <span class="hljs-comment"># unicode, which ensures that the result is a str, which allows</span>
    <span class="hljs-comment"># the decoding to work properly.</span>
    <span class="hljs-keyword">return</span> urllib.unquote_plus(str(s)).decode(<span class="hljs-string">'utf-8'</span>)

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">TestEncodeDecode</span><span class="hljs-params">(unittest.TestCase)</span>:</span>
    <span class="hljs-comment"># This assumes that the test cases are in a file called "cases.json".</span>
    <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">test_encode_decode</span><span class="hljs-params">(self)</span>:</span>
        <span class="hljs-keyword">for</span> item <span class="hljs-keyword">in</span> json.load(open(<span class="hljs-string">'cases.json'</span>)):
            self.assertEquals(item[<span class="hljs-string">'string'</span>], b2_url_decode(item[<span class="hljs-string">'fullyEncoded'</span>]))
            self.assertEquals(item[<span class="hljs-string">'string'</span>], b2_url_decode(item[<span class="hljs-string">'minimallyEncoded'</span>]))
            self.assertIn(b2_url_encode(item[<span class="hljs-string">'string'</span>]), [item[<span class="hljs-string">'fullyEncoded'</span>], item[<span class="hljs-string">'minimallyEncoded'</span>]])

<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
    unittest.main()

Code

<span class="hljs-keyword">import</span> <span class="hljs-type">Foundation</span>

<span class="hljs-class"><span class="hljs-keyword">extension</span> <span class="hljs-title">String</span> </span>{
    <span class="hljs-func"><span class="hljs-keyword">func</span> <span class="hljs-title">b2UrlEncode</span><span class="hljs-params">()</span></span> -> <span class="hljs-type">String</span>? {
        <span class="hljs-keyword">let</span> b2CharacterSet = <span class="hljs-type">NSMutableCharacterSet</span>()
        b2CharacterSet.formUnionWithCharacterSet(<span class="hljs-type">NSCharacterSet</span>.<span class="hljs-type">URLPathAllowedCharacterSet</span>())
        b2CharacterSet.removeCharactersInString(<span class="hljs-string">"&+,"</span>)
        <span class="hljs-keyword">return</span> stringByAddingPercentEncodingWithAllowedCharacters(b2CharacterSet)
    }
    <span class="hljs-func"><span class="hljs-keyword">func</span> <span class="hljs-title">b2UrlDecode</span><span class="hljs-params">()</span></span> -> <span class="hljs-type">String</span>? {
        <span class="hljs-keyword">if</span> (<span class="hljs-keyword">self</span> == <span class="hljs-string">"+"</span>) {
            <span class="hljs-keyword">return</span> <span class="hljs-string">" "</span>
        }
        <span class="hljs-keyword">return</span> stringByRemovingPercentEncoding
    }
}

<span class="hljs-comment">// Run a test</span>
<span class="hljs-keyword">let</span> pathToEncodeJson = <span class="hljs-string">"<PATH TO TEST CASES>"</span>
<span class="hljs-keyword">let</span> jsonTestCaseData = <span class="hljs-type">NSData</span>(contentsOfFile: pathToEncodeJson!)
<span class="hljs-keyword">do</span> {
    <span class="hljs-keyword">var</span> encodingTestCases = try <span class="hljs-type">NSJSONSerialization</span>.<span class="hljs-type">JSONObjectWithData</span>(jsonTestCaseData!, options: .<span class="hljs-type">MutableContainers</span>)
    <span class="hljs-keyword">if</span> <span class="hljs-keyword">let</span> encodingTestCases = encodingTestCases <span class="hljs-keyword">as</span>? <span class="hljs-type">Array</span><<span class="hljs-type">Dictionary</span><<span class="hljs-type">String</span>,<span class="hljs-type">String</span>>> {
        <span class="hljs-keyword">for</span> anEncodingTestCase <span class="hljs-keyword">in</span> encodingTestCases {
            <span class="hljs-built_in">assert</span>(anEncodingTestCase[<span class="hljs-string">"string"</span>]! == anEncodingTestCase[<span class="hljs-string">"minimallyEncoded"</span>]!.b2UrlDecode()!)
            <span class="hljs-built_in">assert</span>(anEncodingTestCase[<span class="hljs-string">"string"</span>]! == anEncodingTestCase[<span class="hljs-string">"fullyEncoded"</span>]!.b2UrlDecode()!)
            <span class="hljs-built_in">assert</span>(anEncodingTestCase[<span class="hljs-string">"string"</span>]!.b2UrlEncode()! == (anEncodingTestCase[<span class="hljs-string">"fullyEncoded"</span>]!)
                || anEncodingTestCase[<span class="hljs-string">"string"</span>]!.b2UrlEncode()! == (anEncodingTestCase[<span class="hljs-string">"minimallyEncoded"</span>]!), <span class="hljs-string">"Failed decoding test."</span>)
        }
    }
} catch <span class="hljs-keyword">let</span> error <span class="hljs-keyword">as</span> <span class="hljs-type">NSError</span> {
    <span class="hljs-built_in">print</span>(<span class="hljs-string">"<span class="hljs-subst">\(error.domain)</span>"</span>)
}

Code

<span class="hljs-keyword">require</span> <span class="hljs-string">'uri'</span>
<span class="hljs-keyword">require</span> <span class="hljs-string">'test/unit'</span>
<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span>

<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">URI</span></span>
    <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">B2</span></span>
        <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">self</span>.<span class="hljs-title">b2_url_encode</span><span class="hljs-params">(str)</span></span>
            <span class="hljs-constant">URI</span>.encode_www_form_component(str.force_encoding(<span class="hljs-constant">Encoding::UTF_8</span>)).gsub(<span class="hljs-string">"%2F"</span>, <span class="hljs-string">"/"</span>)
        <span class="hljs-keyword">end</span>
        <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">self</span>.<span class="hljs-title">b2_url_decode</span><span class="hljs-params">(str)</span></span>
            <span class="hljs-constant">URI</span>.decode_www_form_component(str, <span class="hljs-constant">Encoding::UTF_8</span>)
        <span class="hljs-keyword">end</span>
    <span class="hljs-keyword">end</span>
<span class="hljs-keyword">end</span>

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">B2StringEncodingTest</span> <span class="hljs-inheritance">< <span class="hljs-parent">Test::Unit</span></span>::<span class="hljs-title">TestCase</span></span>
    <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">test_string_encoding</span><span class="hljs-params">()</span></span>
        encodingTestCases = <span class="hljs-constant">JSON</span>.parse(<span class="hljs-constant">File</span>.read(<span class="hljs-string">"cases.json"</span>))
        encodingTestCases.each <span class="hljs-keyword">do</span> |oneTestCase|
            assert(oneTestCase[<span class="hljs-string">"string"</span>] == <span class="hljs-constant">URI::B2</span>.b2_url_decode(oneTestCase[<span class="hljs-string">"fullyEncoded"</span>]), <span class="hljs-string">"Failed decoding fully-encoded test."</span>)
            assert(oneTestCase[<span class="hljs-string">"string"</span>] == <span class="hljs-constant">URI::B2</span>.b2_url_decode(oneTestCase[<span class="hljs-string">"minimallyEncoded"</span>]), <span class="hljs-string">"Failed decoding minimally-encoded test."</span>)
            encoded = <span class="hljs-constant">URI::B2</span>.b2_url_encode(oneTestCase[<span class="hljs-string">"string"</span>])
            assert(oneTestCase[<span class="hljs-string">"fullyEncoded"</span>] == encoded || oneTestCase[<span class="hljs-string">"minimallyEncoded"</span>] == encoded, <span class="hljs-string">"Failed encoding test."</span>)
        <span class="hljs-keyword">end</span>
    <span class="hljs-keyword">end</span>
<span class="hljs-keyword">end</span>

Code

<span class="hljs-keyword">using</span> System;
<span class="hljs-keyword">using</span> System.Web.Script.Serialization;
<span class="hljs-keyword">using</span> System.Collections.Generic;
<span class="hljs-keyword">using</span> System.Diagnostics;

<span class="hljs-keyword">namespace</span> <span class="hljs-title">B2CustomExtension</span>
{
    <span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">class</span> <span class="hljs-title">B2StringExtension</span>
    {
        <span class="hljs-function"><span class="hljs-keyword">static</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">string</span> <span class="hljs-title">b2UrlEncode</span>(<span class="hljs-params"><span class="hljs-keyword">this</span> <span class="hljs-keyword">string</span> str</span>)
        </span>{
            <span class="hljs-keyword">if</span> (str == <span class="hljs-string">"/"</span>)
            {
                <span class="hljs-keyword">return</span> str;
            }
            <span class="hljs-keyword">return</span> Uri.EscapeDataString(str);
        }

        <span class="hljs-function"><span class="hljs-keyword">static</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">string</span> <span class="hljs-title">b2UrlDecode</span>(<span class="hljs-params"><span class="hljs-keyword">this</span> <span class="hljs-keyword">string</span> str</span>)
        </span>{
            <span class="hljs-keyword">if</span> (str == <span class="hljs-string">"+"</span>)
            {
                <span class="hljs-keyword">return</span> <span class="hljs-string">" "</span>;
            }
            <span class="hljs-keyword">return</span> Uri.UnescapeDataString(str);
        }
    }
}

<span class="hljs-keyword">namespace</span> <span class="hljs-title">B2</span>
{
    <span class="hljs-keyword">using</span> B2CustomExtension;
    <span class="hljs-keyword">using</span> System.IO;

    <span class="hljs-keyword">class</span> <span class="hljs-title">TestCase</span>
    {
        <span class="hljs-keyword">public</span> <span class="hljs-keyword">string</span> String { <span class="hljs-keyword">get</span>; <span class="hljs-keyword">set</span>; }
        <span class="hljs-keyword">public</span> <span class="hljs-keyword">string</span> FullyEncoded { <span class="hljs-keyword">get</span>; <span class="hljs-keyword">set</span>; }
        <span class="hljs-keyword">public</span> <span class="hljs-keyword">string</span> MinimallyEncoded { <span class="hljs-keyword">get</span>; <span class="hljs-keyword">set</span>; }
    }

    <span class="hljs-keyword">class</span> <span class="hljs-title">TestStringEncoding</span>
    {
        <span class="hljs-function"><span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">Main</span>(<span class="hljs-params"><span class="hljs-keyword">string</span>[] args</span>)
        </span>{
            <span class="hljs-keyword">string</span> testCaseData = System.IO.File.ReadAllText(<span class="hljs-string">"C:\\cases.json"</span>, System.Text.Encoding.UTF8);
            JavaScriptSerializer ser = <span class="hljs-keyword">new</span> JavaScriptSerializer();
            <span class="hljs-keyword">var</span> testCases = ser.Deserialize<List<TestCase>>(testCaseData);
            <span class="hljs-keyword">foreach</span> (TestCase aTestCase <span class="hljs-keyword">in</span> testCases)
            {
                Debug.Assert(aTestCase.FullyEncoded.b2UrlDecode() == aTestCase.String);
                Debug.Assert(aTestCase.MinimallyEncoded.b2UrlDecode() == aTestCase.String);
                Debug.Assert(aTestCase.String.b2UrlEncode() == aTestCase.FullyEncoded || aTestCase.String.b2UrlEncode() == aTestCase.MinimallyEncoded);
            }
        }
    }
}