ultra7 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7121700c94f787f5218730614a249883d66d098c
+  data.tar.gz: db87d3c8bfdc8db93474369d6606b78b5a84be3c
+SHA512:
+  metadata.gz: 96fa90813ce6cc1d349963d988ac06b6c3575bdff0c9d3a74b20c17e8f504bc8c867dccc915ac949d4a05acaef4440bd9186dec4d2c424f24183b6dbfb487f4c
+  data.tar.gz: ad4ebc79b09bf2f2f094551e5bdc9e989862ca7687399ecb89e90791a637eca8c17509b81654401ebe35129a169f7965ac52d8f9fbc9e5f072845cc2ccebd111

data/.yardopts

@@ -0,0 +1,7 @@
+--no-private
+--readme README.md
+--markup markdown
+--markup-provider rdiscount
+-
+LICENSE
+CHANGELOG

data/CHANGELOG

@@ -0,0 +1,4 @@
+## CHANGELOG
+
+- __2014/12/12__: 0.1.0 release.
+    - Initial release 

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014-2015, Brooke M. Fujita.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above
+   copyright notice, this list of conditions and the
+   following disclaimer.
+
+ * 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.
+
+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.

data/README.md

@@ -0,0 +1,65 @@
+# Ultra7
+A UTF-7 MIME decoder, plain and simple.
+
+## What is Ultra7?
+Ultra7 is a UTF-7 decoder for MIME headers, unlike `Net::IMAP.decode_utf7`
+which is meant for decoding mailbox names. `Ultra7::MIME` is also a
+a mixin, so you can conveniently combine it in another class by using
+`include`.
+
+You can learn more about [Ultra7 at bitbucket](https://bitbucket.org/buruzaemon/ultra7/).
+
+
+## Requirements
+Ultra7 does not really require anything, except a Ruby of _1.9 or greater_.
+
+
+## Installation
+Install Ultra7 with the following gem command:
+
+    gem install ultra7
+
+
+## Usage
+    require 'ultra7'
+
+    # just call decode_utf7
+    puts Ultra7::MIME.decode_utf7('1 +- 1 = 2')
+    => 1 + 1 = 2
+
+    # Decodes UTF-7, returning string with default encoding
+    puts Ultra7::MIME.decode_utf7('Hello, +ZeVnLIqe-')
+    => Hello, 日本語 
+
+    # Decodes UTF-7, returning string with explicit UTF-8 encoding
+    Ultra7::MIME.decode_utf7('Hello, +ZeVnLIqe-', encoding: 'utf-8')
+
+    # As a mixin to another class
+    require 'ultra7/mime'
+    class Foo
+      include Ultra7::MIME
+    end
+
+    puts Foo.decode_utf7('1 +- 1 = 2')
+    => 1 + 1 = 2
+
+
+## Learn more 
+- You can read more about UTF-7, A Mail-Safe Transformation Format of Unicode [RFC2152](https://tools.ietf.org/html/rfc2152).
+- Contrast with
+  [`Net::IMAP.decode_utf7`](http://ruby-doc.org/stdlib-1.9.3/libdoc/net/imap/rdoc/Net/IMAP.html#method-c-decode_utf7).
+
+## Contributing to natto
+-  Use [mercurial](http://mercurial.selenic.com/) and [check out the latest code at bitbucket](https://bitbucket.org/buruzaemon/ultra7/src/) to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+-  [Browse the issue tracker](https://bitbucket.org/buruzaemon/ultra7/issues/) to make sure someone already hasn't requested it and/or contributed it.
+-  Fork the project.
+-  Start a feature/bugfix branch.
+-  Commit and push until you are happy with your contribution.
+-  Make sure to add tests for it. This is important so I don't break it in a future version unintentionally. I use [MiniTest::Unit](http://rubydoc.info/gems/minitest/MiniTest/Unit) as it is very natural and easy-to-use.
+-  Please try not to mess with the Rakefile, CHANGELOG, or version. If you must have your own version, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Changelog
+Please see the {file:CHANGELOG} for this gem's release history.
+
+## Copyright
+Copyright © 2014-2015, Brooke M. Fujita. All rights reserved. Please see the {file:LICENSE} file for further details.

data/lib/ultra7/mime.rb

@@ -0,0 +1,74 @@
+# coding: utf-8
+module Ultra7
+
+  module MIME
+
+    # @private
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Returns the decoded value for the given
+    # UTF-7 encoded `text`. If the optional
+    # `encoding` value is not specified, then
+    # the resulting string will use the default
+    # `Encoding.default_external` encoding.
+    #
+    # @param [String] UTF-7 encoded text
+    # @param [Hash] options
+    # @return UTF-7 decoded value
+    # @raise [ArgumentError] if the given `encoding` cannot be found
+    def self.decode_utf7(text, options={})
+      enc = options[:encoding].nil? \
+        ? Encoding.default_external \
+        : Encoding.find(options[:encoding])
+      
+      return text.gsub(/\+(.*?)-/n) {
+        if $1.empty?
+          "+"
+        else
+          base64 = $1
+          pad = base64.length % 4
+          if pad > 0
+            base64 << ("=" * (4-pad))
+          end
+          base64.unpack("m").first.unpack("n*").pack("U*")
+        end
+      }.encode(enc)
+    end
+
+    # @private
+    module ClassMethods
+      def decode_utf7(text, options={})
+        Ultra7::MIME.decode_utf7(text, options)
+      end
+    end
+  end
+end
+
+# Copyright (c) 2014-2015, Brooke M. Fujita.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#  * Redistributions of source code must retain the above
+#    copyright notice, this list of conditions and the
+#    following disclaimer.
+# 
+#  * 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.
+# 
+# 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.

data/lib/ultra7/version.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+# `Ultra7` is the namespace for objects that provide
+# a UTF-7 MIME header decoding.
+#
+# Module `Ultra7::MIME` provides the UTF-7 decoder function.
+# It may be used as a mixin.
+module Ultra7
+  # Version string for this Rubygem.
+  VERSION = "0.1.0"
+end
+
+# Copyright (c) 2014-2015, Brooke M. Fujita.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#  * Redistributions of source code must retain the above
+#    copyright notice, this list of conditions and the
+#    following disclaimer.
+# 
+#  * 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.
+# 
+# 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.

data/lib/ultra7.rb

@@ -0,0 +1,27 @@
+require 'ultra7/mime'
+
+# Copyright (c) 2014-2015, Brooke M. Fujita.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#  * Redistributions of source code must retain the above
+#    copyright notice, this list of conditions and the
+#    following disclaimer.
+# 
+#  * 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.
+# 
+# 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.

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: ultra7
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brooke M. Fujita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies: []
+description: |
+  ultra7 decodes UTF-7 in the context of MIME headers (c.f. https://tools.ietf.org/html/rfc2152).
+email: buruzaemon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .yardopts
+- CHANGELOG
+- LICENSE
+- README.md
+- lib/ultra7.rb
+- lib/ultra7/mime.rb
+- lib/ultra7/version.rb
+homepage: https://bitbucket.org/buruzaemon/ultra7
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: A UTF-7 MIME decoder, plain and simple.
+test_files: []