mail-jenc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a854118202e49e07a327bfd1e4ed4e4454d3106cb11d2bf37862511bd995f18
+  data.tar.gz: 2d0df7569232ed77e15c42e0ce0ed7ccadbbec2a1f80e3e2a8ad1365ccbd0910
+SHA512:
+  metadata.gz: 0fb0376402c784705aae16a7a7e836c6c8aa1f8555a002b924dc1154b46ca3c98287558c9a028127c7505f485e991d0786f075e8c67f6cdf05e5390968f3f472
+  data.tar.gz: 1186fe098ff229094d78b8ae72abdd5a49a837397c5bc71f7922a60ce8c6918a61a67969c9ad59a9e6800111f72f897181d224af3de7cff5427fdd57a82dd33c

data/README.md

@@ -0,0 +1,40 @@
+# Mail::Jenc
+
+A mail patch for encoding conventional mail.
+
+## Dependencies
+
+* ruby 2.3+
+* mail 2.7
+
+## Installation
+
+Add to your application's Gemfile:
+
+```ruby
+gem 'mail-jenc'
+```
+
+Then run:
+
+    $ bundle install
+
+## Usage
+
+Use mail as usual. You can enable/disable patched features as follows:
+
+```ruby
+# disable patch
+Mail::Jenc.disable
+
+# enable patch
+Mail::Jenc.enable
+```
+
+## Contributing
+
+Pull requests are welcome on GitHub at https://github.com/kanety/mail-jenc.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mail/jenc/attachments_list_patch.rb

@@ -0,0 +1,30 @@
+module Mail
+  module Jenc
+    module AttachmentsListPatch
+      def []=(name, value)
+        if Jenc.enabled?
+          if name && !name.ascii_only? && value.is_a?(Hash) && (charset = value.delete(:header_charset))
+            mime_type = set_mime_type(name)
+            transcoded = Mail::Encodings.transcode_charset(name, name.encoding, charset)
+            if Jenc.rfc2231
+              encoded = RFC2231Encoder.encode(transcoded, charset: charset)
+              value[:content_disposition] ||= %Q|#{@content_disposition_type}; #{encoded}|
+              encoded = Mail::Encodings.b_value_encode(transcoded)
+              value[:content_type] ||= %Q|#{mime_type}; name="#{encoded}"|
+            else
+              encoded = Mail::Encodings.b_value_encode(transcoded)
+              value[:content_disposition] ||= %Q|#{@content_disposition_type}; filename="#{encoded}"|
+              value[:content_type] ||= %Q|#{mime_type}; name="#{encoded}"|
+            end
+            value[:transfer_encoding] = 'binary'
+          end
+        end
+        super
+      end
+    end
+  end
+end
+
+unless Mail::AttachmentsList.included_modules.include?(Mail::Jenc::AttachmentsListPatch)
+  Mail::AttachmentsList.prepend Mail::Jenc::AttachmentsListPatch
+end

data/lib/mail/jenc/encoder.rb

@@ -0,0 +1,47 @@
+module Mail
+  module Jenc
+    module PercentEncoder
+      class << self
+        def encode(str)
+          encode_to_array(str).join
+        end
+
+        def encode_to_array(str)
+          str.unpack('H*').first.scan(/.{2}/).map { |hex| "%#{hex.upcase}" }
+        end
+      end
+    end
+
+    module RFC2231Encoder
+      class << self
+        def encode(name, options = {})
+          encode_to_hash(name, options).map { |k, v| "#{k}=#{v}" }.join(";\r\n\s")
+        end
+
+        def encode_to_hash(name, key: 'filename', charset: 'utf-8')
+          hexes = name.unpack('H*')[0].scan(/.{2}/).map { |hex| "%#{hex.upcase}" }
+
+          first_hex_num = hex_num(charset.size + key.size + 3)
+          if hexes.size <= first_hex_num
+            params = { "#{key}*" => "#{charset.downcase}''#{hexes.join}" }
+          else
+            params = { "#{key}*0*" => "#{charset.downcase}''#{hexes.shift(first_hex_num).join}" }
+            slices = hexes.each_slice(hex_num(key.size + 3))
+            slices.each_with_index do |sliced, i|
+              kc = "#{key}*#{i+1}*"
+              params[kc] = sliced.join
+            end
+          end
+
+          params
+        end
+
+        private
+
+        def hex_num(size)
+          ((80 - 4 - size).to_f / 3).to_i
+        end
+      end
+    end
+  end
+end

data/lib/mail/jenc/fields/address_field_patch.rb

@@ -0,0 +1,29 @@
+module Mail
+  module Jenc
+    module AddressFieldPatch
+      def initialize(value, charset = nil)
+        if Jenc.enabled?
+          if value.is_a?(String) && !value.ascii_only? && charset && charset != 'utf-8'
+            list = Mail::AddressList.new(value)
+            list.addresses.each do |addr|
+              if addr.display_name && !addr.display_name.ascii_only?
+                addr.display_name = Mail::Encodings.b_value_encode(
+                  Mail::Encodings.transcode_charset(addr.display_name, addr.display_name.encoding, charset)
+                )
+              end
+            end
+            value = list.addresses.map(&:encoded).join(', ')
+          end
+        end
+        super
+      end
+    end
+  end
+end
+
+klasses = ObjectSpace.each_object(Class).select { |klass| klass < Mail::CommonAddress }
+klasses.each do |klass|
+  unless klass.included_modules.include?(Mail::Jenc::AddressFieldPatch)
+    klass.prepend Mail::Jenc::AddressFieldPatch
+  end
+end

data/lib/mail/jenc/fields/unstructured_field_patch.rb

@@ -0,0 +1,25 @@
+module Mail
+  module Jenc
+    module UnstructuredFieldPatch
+      def initialize(name, value, charset = nil)
+        if Jenc.enabled?
+          if value.is_a?(String)
+            if value.ascii_only?
+              charset = 'us-ascii'
+              value.force_encoding('us-ascii')
+            elsif charset && charset != 'utf-8'
+              value = Mail::Encodings.b_value_encode(
+                Mail::Encodings.transcode_charset(value, value.encoding, charset)
+              )
+            end
+          end
+        end
+        super
+      end
+    end
+  end
+end
+
+unless Mail::UnstructuredField.included_modules.include?(Mail::Jenc::UnstructuredFieldPatch)
+  Mail::UnstructuredField.prepend Mail::Jenc::UnstructuredFieldPatch
+end

data/lib/mail/jenc/message_patch.rb

@@ -0,0 +1,29 @@
+module Mail
+  module Jenc
+    module MessagePatch
+      def body=(value)
+        if Jenc.enabled?
+          if value.is_a?(String) && !value.ascii_only? && charset && charset != 'utf-8' && @transport_encoding.to_s != '8bit'
+            value = Mail::Encodings.transcode_charset(value, value.encoding, charset)
+            value.force_encoding('us-ascii') if @transport_encoding.to_s == '7bit'
+            value = @transport_encoding.encode(value)
+          end
+        end
+        super
+      end
+
+      def add_file(values)
+        if Jenc.enabled?
+          if values.is_a?(Hash) && charset
+            values[:header_charset] = charset
+          end
+        end
+        super
+      end
+    end
+  end
+end
+
+unless Mail::Message.included_modules.include?(Mail::Jenc::MessagePatch)
+  Mail::Message.prepend Mail::Jenc::MessagePatch
+end

data/lib/mail/jenc/ruby_1_9_patch.rb

@@ -0,0 +1,24 @@
+module Mail
+  module Jenc
+    module Ruby19Patch
+      def transcode_charset(str, from_encoding, to_encoding = Encoding::UTF_8)
+        if Jenc.enabled?
+          coded = super(str, from_encoding, Ruby19Patch.preferred_charset(to_encoding))
+          coded.force_encoding(to_encoding)
+        else
+          super
+        end
+      end
+
+      class << self
+        def preferred_charset(charset)
+          Jenc.preferred_charsets[charset.to_s.downcase] || charset
+        end
+      end
+    end
+  end
+end
+
+unless Mail::Ruby19.singleton_class.included_modules.include?(Mail::Jenc::Ruby19Patch)
+  Mail::Ruby19.singleton_class.prepend Mail::Jenc::Ruby19Patch
+end

data/lib/mail/jenc/version.rb

@@ -0,0 +1,5 @@
+module Mail
+  module Jenc
+    VERSION = '1.0.0'
+  end
+end

data/lib/mail/jenc.rb

@@ -0,0 +1,34 @@
+require 'mail'
+
+Dir["#{__dir__}/jenc/**/*.rb"].each do |file|
+  require file
+end
+
+module Mail
+  module Jenc
+    class << self
+      attr_reader :enabled
+      attr_accessor :rfc2231
+      attr_accessor :preferred_charsets
+
+      def enabled?
+        @@enabled
+      end
+
+      def enable
+        @@enabled = true
+      end
+
+      def disable
+        @@enabled = false
+      end
+    end
+
+    self.enable
+    self.rfc2231 = true
+    self.preferred_charsets = {
+      'iso-2022-jp' => 'cp50221',
+      'shift_jis' => 'cp932'
+    }
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: mail-jenc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A mail patch for encoding conventional mail
+email:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/mail/jenc.rb
+- lib/mail/jenc/attachments_list_patch.rb
+- lib/mail/jenc/encoder.rb
+- lib/mail/jenc/fields/address_field_patch.rb
+- lib/mail/jenc/fields/unstructured_field_patch.rb
+- lib/mail/jenc/message_patch.rb
+- lib/mail/jenc/ruby_1_9_patch.rb
+- lib/mail/jenc/version.rb
+homepage: https://github.com/kanety/mail-jenc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A mail patch for encoding conventional mail
+test_files: []