mime_builder 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4433b3e98a0fa4631cc3a6b2193a2c5e26687a20
-  data.tar.gz: 79d171be6bbf4bf3c4350230a2360d5692fb5371
+  metadata.gz: d8de3fc319dce616c0b945f1aa9f986618c6f363
+  data.tar.gz: 1c1f37d3d4190ef49f741b8a6b9fa4348dcfa3d1
 SHA512:
-  metadata.gz: f4e135cd2153477e464ee05b307c7b728938b3a6cff006904d5d77437d5ba2d385ca682a6245268cff521beeef244c3b0593fd83204dbd9b167a93d8e2cea069
-  data.tar.gz: 7bee0cfe96986ef80484be8bbb552c537ead6aedeb6018b12bd96bad6ce1d773d15493675154a794acafaa688ba74f3c491fa3016858b798bdf0a05a203c57a2
+  metadata.gz: 885b5fb3c26a687f828b3257885c18c22225331df3c251c30274172dfe7a4c5adfa3e7e5df43bdaacc642c42d18207e928fa5b53a1b015332577527fd4d1054d
+  data.tar.gz: 9ca88ad183f4fad5e3cee88567fe4d6d78f6b67ece89326780c54d43df54c1c5ece04a4093f86236e0b9115af6638749c6b75f07dbf684474d9b0e36c994addd

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 CHANGELOG
 ---------
+- **2015-12-14**: 0.0.4
+  - Add JSON support
 - **2015-05-30**: 0.0.3
   - Add Text support for arbitrary content types
   - Add Text support for content disposition

data/README.md

@@ -13,7 +13,7 @@ MIMEBuilder Ruby
 
 ## Overview
 
-This library creates `mime` parts from limited information.
+This library creates MIME parts from limited information. The MIME parts are based on the Ruby `mime` library and are all sub-classes of `MIME::Media`.
 
 ## Installation
 
@@ -54,7 +54,7 @@ mime_part = builder.mime
 Options:
 
 ```ruby
-builder = MIMEBuilder::Filepath(
+builder = MIMEBuilder::Filepath.new(
   '/path/to/file',
   base64_encode: true,        # base64 encode part
   content_id_disable: true,   # remove auto-generated Content-Id header
@@ -65,7 +65,10 @@ builder = MIMEBuilder::Filepath(
 
 ### From String
 
-Builds a `MIME::Text` object.
+Builds a `MIME::Text` object. This accepts a string and can optionally populate the following headers:
+
+1. `Content-Disposition`
+2. `Content-Type`
 
 This will optionally delete the following auto-generated header:
 
@@ -79,13 +82,37 @@ mime_part = builder.mime
 Options:
 
 ```ruby
-builder = MIMEBuilder::Text(
+builder = MIMEBuilder::Text.new(
   'Hi there!',
   content_id_disable: true, # remove auto-generated Content-Id header
   content_type: 'text/html' # override auto-generated Content-Type
 )
 ```
 
+### From JSON
+
+Builds a `MIME::Text` object. This accepts a string, hash, or array.
+
+This will optionally:
+
+1. delete the following auto-generated `Content-Id`
+1. base64 encode the content
+
+```ruby
+builder = MIMEBuilder::JSON.new { foo: 'bar' }
+mime_part = builder.mime
+```
+
+Options:
+
+```ruby
+builder = MIMEBuilder::JSON.new(
+  'Hi there!',
+  content_id_disable: true, # remove auto-generated Content-Id header
+  base64_encode: false      # disable default base64 encoding
+)
+```
+
 ## Change Log
 
 See [CHANGELOG.md](CHANGELOG.md)
@@ -96,6 +123,11 @@ Project Repo
 
 * https://github.com/grokify/mime-builder-ruby
 
+MIME Library
+
+* https://rubygems.org/gems/mime
+* https://bitbucket.org/pachl/mime/src
+
 ## Contributions
 
 Any reports of problems, comments or suggestions are most welcome.

data/lib/mime_builder.rb

@@ -1,6 +1,7 @@
 module MIMEBuilder
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 
   autoload :Filepath, 'mime_builder/file'
+  autoload :JSON, 'mime_builder/json'
   autoload :Text, 'mime_builder/text'
 end

data/lib/mime_builder/file.rb

@@ -65,10 +65,9 @@ module MIMEBuilder
 
     def get_attachment_content_disposition(filepath = nil)
       filename = File.basename(filepath.to_s)
-      if filename.is_a?(String) && filename.length > 0
-        return "attachment; filename=\"#{filename}\""
-      end
-      'attachment'
+      return filename.to_s.length > 0              \
+        ? "attachment; filename=\"#{filename}\"" \
+        : 'attachment'
     end
   end
 end

data/lib/mime_builder/json.rb

@@ -0,0 +1,50 @@
+require 'base64'
+require 'mime'
+require 'multi_json'
+
+module MIMEBuilder
+  class JSON
+    BASE64_DEFAULT = true
+    CONTENTID_DEFAULT = false
+
+    attr_accessor :mime
+    attr_accessor :json
+
+    def initialize(content, opts = {})
+      @opts = opts
+
+      @json = content_to_json content
+
+      @json = Base64.encode64(@json) if encode_base64?
+      @mime = build_json_part @json
+    end
+
+    def content_to_json(content)
+      content = MultiJson.encode(content) if content.is_a?(Array) || content.is_a?(Hash)
+      content = content.to_s unless content.is_a? String
+      content
+    end
+
+    def build_json_part(json)
+      json_part = MIME::Text.new(json)
+      json_part.headers.delete('Content-Id') if disable_content_id?
+      json_part.headers.set('Content-Type', 'application/json')
+      json_part.headers.set('Content-Transfer-Encoding', 'base64') if encode_base64?
+      return json_part
+    end
+
+    def encode_base64?
+      if @opts.key? :encode_base64
+        return @opts[:encode_base64] ? true : false
+      end
+      return BASE64_DEFAULT
+    end
+
+    def disable_content_id?
+      if @opts.key? :content_id_disable
+        return @opts[:content_id_disable] ? true : false
+      end
+      return !CONTENTID_DEFAULT
+    end
+  end
+end

data/lib/mime_builder/text.rb

@@ -33,7 +33,7 @@ module MIMEBuilder
     end
 
     def get_attachment_content_disposition(filename = nil)
-      cd = filename.to_s.length > 0              \
+      return filename.to_s.length > 0              \
         ? "attachment; filename=\"#{filename}\"" \
         : 'attachment'
     end

data/test/test_file.rb

@@ -21,8 +21,8 @@ class MIMEBuilderFileTest < Test::Unit::TestCase
   end
 
   def test_base64
-    filepath = './test/test_file.pdf'
     filename = 'test_file.pdf'
+    filepath = File.join './test', filename
 
     filepart = MIMEBuilder::Filepath.new(filepath, {:base64_encode => true})
 
@@ -47,8 +47,8 @@ class MIMEBuilderFileTest < Test::Unit::TestCase
   end
 
   def test_attachment
-    filepath = './test/test_file.pdf'
     filename = 'test_file.pdf'
+    filepath = File.join './test', filename
 
     filepart = MIMEBuilder::Filepath.new(filepath, {:is_attachment => true})
 
@@ -59,7 +59,7 @@ class MIMEBuilderFileTest < Test::Unit::TestCase
     filepath = './test/test_file_nonexistent.pdf'
 
     assert_raise do
-      filepart = MIMEBuilder::Filepath.new(filepath)
+      MIMEBuilder::Filepath.new(filepath)
     end
   end
 end

data/test/test_json.rb

@@ -0,0 +1,24 @@
+require './test/test_base.rb'
+
+require 'base64'
+
+class MIMEBuilderJsonTest < Test::Unit::TestCase
+  def test_base
+    test_json = { hello: 'world' }
+
+    json_part = MIMEBuilder::JSON.new(test_json)
+
+    assert_equal 'application/json', json_part.mime.headers.get('Content-Type')
+    assert_equal Base64.encode64(MultiJson.encode(test_json)), json_part.mime.body.to_s
+    assert_equal nil, json_part.mime.headers.get('Content-Id')
+  end
+
+  def test_no_base64
+    test_json = { hello: 'world' }
+    test_json = MultiJson.encode(test_json)
+
+    json_part = MIMEBuilder::JSON.new test_json, encode_base64: false
+
+    assert_equal test_json, json_part.mime.body.to_s
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mime_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - John Wang
@@ -14,30 +14,56 @@ dependencies:
   name: mime
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.3
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: 1.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: 1.12.1
 description: Helper library to build MIME parts
 email: johncwang@gmail.com
 executables: []
@@ -46,16 +72,17 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/mime_builder.rb
 - lib/mime_builder/file.rb
+- lib/mime_builder/json.rb
 - lib/mime_builder/text.rb
 - test/test_base.rb
 - test/test_file.pdf
 - test/test_file.rb
+- test/test_json.rb
 - test/test_text.rb
 homepage: https://github.com/grokify/
 licenses:
@@ -77,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: MIME Builder is a helper to build MIME parts

data/Gemfile.lock

@@ -1,53 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coveralls (0.8.1)
-      json (~> 1.8)
-      rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.10.0)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
-    docile (1.1.5)
-    domain_name (0.5.24)
-      unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.2)
-      domain_name (~> 0.5)
-    json (1.8.3)
-    metaclass (0.0.4)
-    mime (0.4.2)
-    mime-types (2.6.2)
-    mocha (1.1.0)
-      metaclass (~> 0.0.1)
-    netrc (0.10.3)
-    power_assert (0.2.4)
-    rake (10.4.2)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    simplecov (0.10.0)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    term-ansicolor (1.3.0)
-      tins (~> 1.0)
-    test-unit (3.1.4)
-      power_assert
-    thor (0.19.1)
-    tins (1.5.2)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  coveralls
-  mime
-  mime-types
-  mocha
-  rake
-  simplecov
-  test-unit