mime_builder 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1b242e017dbe6bc717e94d6ef217bab7a7ff6d2
-  data.tar.gz: fefd7653cf050420e71d3f1434376a8793a9759b
+  metadata.gz: 1e8c66cc9be954dfe63a9f841f57ef99dd8beb5c
+  data.tar.gz: 4507ce85c36fff99737abbc386e2b9571b5e068c
 SHA512:
-  metadata.gz: 1f7e5c60b154659606764c9fb73cf333c194e0aec35ca931a37e292a16f4188b01907ad88e7efdeb6bf1b0088600150b0bb3cf947626804f6fda31d1c2fcf2ea
-  data.tar.gz: 1e9ff54c3742e05f4be0ddfa5ee9fa2efd9b6cc64b38f19c0d81ff513a4d1b009dd6015e3f17e9860ceaaaf4322a4040e8a1739870dd33ebe986b19ab4bc0319
+  metadata.gz: 76916c33698592a13092c35ed30dd62894c61b0acb24ae3516f13beb250446b6ba0919f7dadd4ff1b71926be3fe52f5a1bc1ad46f55f6715b76ca04c06846039
+  data.tar.gz: 3cc0cff3eb0789ca6d0013fd4faab341a1b0f4008d490d408d2e98a95ca636143d214b04df16447f830aec811ff3adf1a3a7fc7764adc3afdda85b6331a0c01f

data/README.md

@@ -15,12 +15,39 @@ MIMEBuilder Ruby
 
 This library creates `mime` parts from limited information.
 
+## Installation
+
+### Via Bundler
+
+Add 'mime_builder' to Gemfile and then run `bundle`:
+
+```sh
+$ echo "gem 'mime_builder'" >> Gemfile
+$ bundle
+```
+
+### Via RubyGems
+
+```sh
+$ gem install mime_builder
+```
+
 ## Usage
 
 ### From Filepath
 
+Builds a `MIME::Application` or `MIME::Type` object depending on whether base64 encoding is selected. This reads bytes from filesystem and populates the following MIME headers:
+
+1. `Content-Disposition`
+2. `Content-Transfer-Encoding`
+3. `Content-Type`
+
+This will optionally delete the following auto-generated header:
+
+1. `Content-Id`
+
 ```ruby
-builder = MIMEBuilder::Filepath('/path/to/file')
+builder = MIMEBuilder::Filepath.new '/path/to/file'
 mime_part = builder.mime
 ```
 
@@ -40,20 +67,21 @@ builder = MIMEBuilder::Filepath(
 
 ### From String
 
+Builds a `MIME::Text` object.
+
+This will optionally delete the following auto-generated header:
+
+1. `Content-Id`
+
 ```ruby
-builder = MIMEBuilder::Filepath('Hi there!')
+builder = MIMEBuilder::Text.new 'Hi there!' 
 mime_part = builder.mime
 ```
 
 Options:
 
 ```ruby
-builder = MIMEBuilder::Filepath(
-  'Hi there!',
-  {
-    :content_id_disable => true,   # remove auto-generated Content-Id header
-  }
-)
+builder = MIMEBuilder::Text.new 'Hi there!', :content_id_disable => true
 ```
 
 ## Change Log

data/lib/mime_builder.rb

@@ -1,5 +1,5 @@
 module MIMEBuilder
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
   autoload :Filepath, 'mime_builder/file'
   autoload :Text, 'mime_builder/text'

data/lib/mime_builder/file.rb

@@ -7,7 +7,6 @@ module MIMEBuilder
     attr_accessor :mime
     attr_accessor :filepath
 
-    # {:base64_encode bool, :content_type string, :content_id_disable bool}
     def initialize(filepath, opts = {})
       if opts.key?(:base64_encode) && opts[:base64_encode]
         @base64_encode = true
@@ -46,7 +45,6 @@ module MIMEBuilder
         fail "File \"#{filepath}\" does not exist or cannot be read"
       end
 
-      #File.open(filepath, 'rb:BINARY') { |f| f.read }
       File.read(filepath)
     end
 

data/test/test_text.rb

@@ -1,11 +1,6 @@
 require './test/test_base.rb'
 
 class MIMEBuilderTextTest < Test::Unit::TestCase
-
-  def test_file_one
-    #assert_equal "bXlfYXBwX2tleTpteV9hcHBfc2VjcmV0", @rcsdk.send(:get_api_key)
-  end
-
   def test_contenttype
   	test_text = 'Hello world!'
 
@@ -16,4 +11,9 @@ class MIMEBuilderTextTest < Test::Unit::TestCase
     assert_equal test_text, filepart.mime.body.to_s
   end
 
+  def test_content_id_disable
+    filepart = MIMEBuilder::Text.new 'Hello world!', :content_id_disable => true
+
+    assert_equal nil, filepart.mime.headers.get('Content-Id')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mime_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-23 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime