mime_builder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1b242e017dbe6bc717e94d6ef217bab7a7ff6d2
+  data.tar.gz: fefd7653cf050420e71d3f1434376a8793a9759b
+SHA512:
+  metadata.gz: 1f7e5c60b154659606764c9fb73cf333c194e0aec35ca931a37e292a16f4188b01907ad88e7efdeb6bf1b0088600150b0bb3cf947626804f6fda31d1c2fcf2ea
+  data.tar.gz: 1e9ff54c3742e05f4be0ddfa5ee9fa2efd9b6cc64b38f19c0d81ff513a4d1b009dd6015e3f17e9860ceaaaf4322a4040e8a1739870dd33ebe986b19ab4bc0319

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+CHANGELOG
+---------
+- **2016-01-23**: 0.0.1
+  - Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+gem 'coveralls'
+gem 'mime'
+gem 'mime-types'
+gem 'mocha'
+gem 'rake'
+gem 'simplecov'
+gem 'test-unit'

data/Gemfile.lock

@@ -0,0 +1,53 @@
+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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John Wang
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+MIMEBuilder Ruby
+================
+
+[![Gem Version][gem-version-svg]][gem-version-link]
+[![Build Status][build-status-svg]][build-status-link]
+[![Coverage Status][coverage-status-svg]][coverage-status-link]
+[![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
+[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
+[![Downloads][downloads-svg]][downloads-link]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-link]
+
+## Overview
+
+This library creates `mime` parts from limited information.
+
+## Usage
+
+### From Filepath
+
+```ruby
+builder = MIMEBuilder::Filepath('/path/to/file')
+mime_part = builder.mime
+```
+
+Options:
+
+```ruby
+builder = MIMEBuilder::Filepath(
+  '/path/to/file',
+  {
+    :base64_encode => true,        # base64 encode part
+    :content_id_disable => true,   # remove auto-generated Content-Id header
+    :content_type => 'text/plain', # override auto-generated Content-Type
+    :is_attachment => true         # add 'attachment' disposition
+  }
+)
+```
+
+### From String
+
+```ruby
+builder = MIMEBuilder::Filepath('Hi there!')
+mime_part = builder.mime
+```
+
+Options:
+
+```ruby
+builder = MIMEBuilder::Filepath(
+  'Hi there!',
+  {
+    :content_id_disable => true,   # remove auto-generated Content-Id header
+  }
+)
+```
+
+## Change Log
+
+See [CHANGELOG.md](CHANGELOG.md)
+
+## Contributions
+
+Any reports of problems, comments or suggestions are most welcome.
+
+Please report these on [Github](https://github.com/grokify/mime-builder-ruby)
+
+## License
+
+MIMEBuilder is available under an MIT-style license. See [LICENSE.txt](LICENSE.txt) for details.
+
+MIMEBuilder © 2016 by John Wang
+
+ [gem-version-svg]: https://badge.fury.io/rb/mime_builder.svg
+ [gem-version-link]: http://badge.fury.io/rb/mime_builder
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/mime_builder
+ [downloads-link]: https://rubygems.org/gems/mime_builder
+ [build-status-svg]: https://api.travis-ci.org/grokify/mime-builder-ruby.svg?branch=master
+ [build-status-link]: https://travis-ci.org/grokify/mime-builder-ruby
+ [coverage-status-svg]: https://coveralls.io/repos/grokify/mime-builder-ruby/badge.svg?branch=master
+ [coverage-status-link]: https://coveralls.io/r/grokify/mime-builder-ruby?branch=master
+ [dependency-status-svg]: https://gemnasium.com/grokify/mime-builder-ruby.svg
+ [dependency-status-link]: https://gemnasium.com/grokify/mime-builder-ruby
+ [codeclimate-status-svg]: https://codeclimate.com/github/grokify/mime-builder-ruby/badges/gpa.svg
+ [codeclimate-status-link]: https://codeclimate.com/github/grokify/mime-builder-ruby
+ [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/mime-builder-ruby/badges/quality-score.png?b=master
+ [scrutinizer-status-link]: https://scrutinizer-ci.com/g/grokify/mime-builder-ruby/?branch=master
+ [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
+ [docs-rubydoc-link]: http://www.rubydoc.info/gems/mime_builder/
+ [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
+ [license-link]: https://github.com/grokify/mime-builder-ruby/blob/master/LICENSE.txt

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the library.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+desc 'Generate YARD documentation.'
+task :gendoc do
+  # puts 'yard doc generation disabled until JRuby build native
+  # extensions for redcarpet or yard removes the dependency.'
+  system 'yardoc'
+  system 'yard stats --list-undoc'
+end

data/lib/mime_builder.rb

@@ -0,0 +1,6 @@
+module MIMEBuilder
+  VERSION = '0.0.1'
+
+  autoload :Filepath, 'mime_builder/file'
+  autoload :Text, 'mime_builder/text'
+end

data/lib/mime_builder/file.rb

@@ -0,0 +1,76 @@
+require 'base64'
+require 'mime'
+require 'mime/types'
+
+module MIMEBuilder
+  class Filepath
+    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
+      else
+        @base64_encode = false
+      end
+
+      @mime = create_mime(filepath, opts[:content_id_disable])
+
+      @mime.headers.set(
+        'Content-Type',
+        get_file_content_type(filepath, opts[:content_type]))
+
+      set_attachment_content_disposition(filepath, opts[:is_attachment])
+    end
+
+    def create_mime(filepath, content_id_disable)
+      bytes = read_file_bytes(filepath)
+
+      mime = nil
+
+      if @base64_encode
+        mime = MIME::Text.new(Base64.encode64(bytes))
+        mime.headers.set('Content-Transfer-Encoding', 'base64')
+      else
+        mime = MIME::Application.new(bytes)
+      end
+
+      mime.headers.delete('Content-Id') if content_id_disable
+
+      mime
+    end
+
+    def read_file_bytes(filepath = nil)
+      unless File.file?(filepath)
+        fail "File \"#{filepath}\" does not exist or cannot be read"
+      end
+
+      #File.open(filepath, 'rb:BINARY') { |f| f.read }
+      File.read(filepath)
+    end
+
+    def get_file_content_type(filepath = nil, content_type = nil)
+      if content_type.is_a?(String) && content_type =~ %r{^[^/\s]+/[^/\s]+}
+        return content_type
+      end
+      MIME::Types.type_for(filepath).first.content_type \
+        || 'application/octet-stream'
+    end
+
+    def set_attachment_content_disposition(filepath, is_attachment)
+      @mime.headers.set(
+        'Content-Disposition',
+        get_attachment_content_disposition(filepath)
+      ) if is_attachment
+    end
+
+    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'
+    end
+  end
+end

data/lib/mime_builder/text.rb

@@ -0,0 +1,15 @@
+require 'mime'
+
+module MIMEBuilder
+  class Text
+    attr_accessor :mime
+    attr_accessor :text
+
+    def initialize(text, opts = {})
+      @text = text
+      @mime = MIME::Text.new(text, 'plain')
+      @mime.headers.delete('Content-Id') \
+        if opts.key?(:content_id_disable) && opts[:content_id_disable]
+    end
+  end
+end

data/test/test_base.rb

@@ -0,0 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'test/unit'
+require 'mocha/test_unit'
+require 'mime_builder'

data/test/test_file.rb

@@ -0,0 +1,65 @@
+require './test/test_base.rb'
+
+class MIMEBuilderFileTest < Test::Unit::TestCase
+
+  def test_file_one
+    #assert_equal "bXlfYXBwX2tleTpteV9hcHBfc2VjcmV0", @rcsdk.send(:get_api_key)
+  end
+
+  def test_basic
+    filepath = './test/test_file.pdf'
+    filename = 'test_file.pdf'
+
+    filepart = MIMEBuilder::Filepath.new(filepath)
+
+    assert_equal 'application/pdf', filepart.get_file_content_type(filepath)
+    assert_equal 'application/pdf', filepart.mime.headers.get('Content-Type')
+
+    assert_equal 'attachment', filepart.get_attachment_content_disposition()
+    assert_equal 'attachment; filename="test_file.pdf"', filepart.get_attachment_content_disposition(filename)
+    assert_equal 'attachment; filename="test_file.pdf"', filepart.get_attachment_content_disposition(filepath)
+  end
+
+  def test_base64
+    filepath = './test/test_file.pdf'
+    filename = 'test_file.pdf'
+
+    filepart = MIMEBuilder::Filepath.new(filepath, {:base64_encode => true})
+
+    assert_equal 'application/pdf', filepart.get_file_content_type(filepath)
+    assert_equal 'application/pdf', filepart.mime.headers.get('Content-Type')
+  
+    assert_equal 'base64', filepart.mime.headers.get('Content-Transfer-Encoding')
+  end
+
+  def test_content_type
+    filepath = './test/test_file.pdf'
+    filename = 'test_file.pdf'
+
+    filepart = MIMEBuilder::Filepath.new(filepath, {:content_type => 'application/pdf'})
+
+    assert_equal 'application/pdf', filepart.get_file_content_type(filepath)
+    assert_equal 'application/pdf', filepart.mime.headers.get('Content-Type')
+
+    assert_equal 'attachment', filepart.get_attachment_content_disposition()
+    assert_equal 'attachment; filename="test_file.pdf"', filepart.get_attachment_content_disposition(filename)
+    assert_equal 'attachment; filename="test_file.pdf"', filepart.get_attachment_content_disposition(filepath)
+  end
+
+  def test_attachment
+    filepath = './test/test_file.pdf'
+    filename = 'test_file.pdf'
+
+    filepart = MIMEBuilder::Filepath.new(filepath, {:is_attachment => true})
+
+    assert_equal 'attachment; filename="test_file.pdf"', filepart.mime.headers.get('Content-Disposition')
+  end
+
+  def test_nonexistent_file
+    filepath = './test/test_file_nonexistent.pdf'
+
+    assert_raise do
+      filepart = MIMEBuilder::Filepath.new(filepath)
+    end
+  end
+end

data/test/test_text.rb

@@ -0,0 +1,19 @@
+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!'
+
+    filepart = MIMEBuilder::Text.new(test_text)
+
+    assert_equal 'text/plain', filepart.mime.headers.get('Content-Type')
+
+    assert_equal test_text, filepart.mime.body.to_s
+  end
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: mime_builder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.25'
+description: Helper library to build MIME parts
+email: johncwang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mime_builder/file.rb
+- lib/mime_builder/text.rb
+- lib/mime_builder.rb
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Rakefile
+- README.md
+- test/test_base.rb
+- test/test_file.pdf
+- test/test_file.rb
+- test/test_text.rb
+homepage: https://github.com/grokify/
+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: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: MIME Builder is a helper to build MIME parts
+test_files: []