ultra7 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7121700c94f787f5218730614a249883d66d098c
-  data.tar.gz: db87d3c8bfdc8db93474369d6606b78b5a84be3c
+  metadata.gz: 555011104f1136cd2db5802f51321b784a79bf3d
+  data.tar.gz: 49de6c0f2744b7b1fdb6f2053c775a0b689ac699
 SHA512:
-  metadata.gz: 96fa90813ce6cc1d349963d988ac06b6c3575bdff0c9d3a74b20c17e8f504bc8c867dccc915ac949d4a05acaef4440bd9186dec4d2c424f24183b6dbfb487f4c
-  data.tar.gz: ad4ebc79b09bf2f2f094551e5bdc9e989862ca7687399ecb89e90791a637eca8c17509b81654401ebe35129a169f7965ac52d8f9fbc9e5f072845cc2ccebd111
+  metadata.gz: 5a6bf087db91087c18ea8b469208d7eb314f526456b73dc62d5ee02e5c924c3698a190c9ab284a188be73ac39d1827b562a7825348c126a01f99ee5eae52ebd9
+  data.tar.gz: 40e87e21c246626f03b33c7b86b6fb815e03a4a51f9051fe51fecdd35beb492b707bd092fc1c996dc7b184358b9c2065f48376c20209d5949643145a51e8ee7b

data/CHANGELOG

@@ -1,4 +1,10 @@
 ## CHANGELOG
 
-- __2014/12/12__: 0.1.0 release.
+
+- __2014/12/14__: 0.2.0 release.
+    - Enhancements to deal with encoding marker.
+	- Raise ArgumentError when non-UTF-7 encoding marker text is passed in.
+	- Added more tests.
+
+- __2014/12/13__: 0.1.0 release.
     - Initial release 

data/README.md

@@ -1,47 +1,58 @@
 # Ultra7
-A UTF-7 MIME decoder, plain and simple.
+A UTF-7 MIME header 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/).
+* 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`.
+* Read the [API documentation](http://www.rubydoc.info/gems/ultra7).
+* 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
+* Ultra7 does not really require anything, except a Ruby of _1.9 or greater_.
 
 
-## Usage
-    require 'ultra7'
+## Installation
 
-    # just call decode_utf7
-    puts Ultra7::MIME.decode_utf7('1 +- 1 = 2')
-    => 1 + 1 = 2
+* Install Ultra7 with the following gem command:
 
-    # Decodes UTF-7, returning string with default encoding
-    puts Ultra7::MIME.decode_utf7('Hello, +ZeVnLIqe-')
-    => Hello, 日本語 
+        gem install ultra7
 
-    # 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
+## Usage
 
-    puts Foo.decode_utf7('1 +- 1 = 2')
-    => 1 + 1 = 2
+* Using Ultra7 is pretty straight-forward, really. It _only_ decode UTF-7.
+
+        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 an actual Subject MIME header in UTF-7,
+        # returning string with explicit UTF-8 encoding
+        subject = '=?unicode-1-1-utf-7?Q?+vDCy7A-  +wMHQ3A-  +xUy5vA-(+wuTTKA-)?='
+        Ultra7::MIME.decode_utf7(subject, encoding: 'UTF-8')
+        => "배달  상태  알림(실패)"
+
+* And you can use `Ultra7::MIME` as a mixin.
+    
+        # As a mixin to another class
+        require 'ultra7/mime'
+        class Foo
+          include Ultra7::MIME
+        end
+    
+        puts Foo.decode_utf7('Hi Mom -+Jjo--!')
+        => "Hi Mom -☺-!" 
 
 
 ## Learn more 

data/lib/ultra7/mime.rb

@@ -10,15 +10,27 @@ module Ultra7
 
     # 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` value is not specified, in the `options`
+    # hash, 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={})
+    # @return [String] UTF-7 decoded value
+    # @raise [ArgumentError] if text other than UTF-7 are passed in, or the given `encoding` cannot be found
+    # convert UTF-7
+    def self.decode_utf7(text, options={encoding: nil})
+      # only deal with UTF-7 encoding
+      text.scan(/=\?(.*)\?[qb]\?/i).each {
+        e = $1
+        if e and !(e=~/utf\-7/i)
+          raise ArgumentError.new("Cannot decode #{e} as UTF-7!")
+        end
+      }
+
+      # remove any encoding start/end markers
+      text = text.gsub(/\?=/, '').gsub(/=\?[^?]*utf\-7\?[qb]\?/i, '')
+
       enc = options[:encoding].nil? \
         ? Encoding.default_external \
         : Encoding.find(options[:encoding])

data/lib/ultra7/version.rb

@@ -7,7 +7,7 @@
 # It may be used as a mixin.
 module Ultra7
   # Version string for this Rubygem.
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end
 
 # Copyright (c) 2014-2015, Brooke M. Fujita.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultra7
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brooke M. Fujita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2014-12-13 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).
@@ -47,5 +47,5 @@ rubyforge_project:
 rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: A UTF-7 MIME decoder, plain and simple.
+summary: A UTF-7 MIME header decoder, plain and simple.
 test_files: []