formdata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: caccbe286e92c40d511e574f3d9b70fbe5be470e
+  data.tar.gz: 539bf1715974b63de330bdf292519c77e97e81fd
+SHA512:
+  metadata.gz: 6b7f53822152b8d5254b5d2831ec7f5347b78c1fc74acf0d8ff78acf3817981c6c301e6a4d084390208d4577477432a8e172b255ecdfe340575ba93d4ead3582
+  data.tar.gz: f3b362f3d24b0d70c0d18cbfc1ee88194ffecd96c894882c74c0d8f8407d39717f9d61873413847e1fc5759584d9c36c58c673845f0f61b051bb773f6e513a61

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/tmp/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+script: "bundle exec rake"
+before_install:
+  - uname -a
+  - gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nelson Darkwah Oppong
+
+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,70 @@
+# FormData [![Build Status](https://travis-ci.org/nelsond/formdata.svg?branch=master)](https://travis-ci.org/nelsond/formdata)
+
+Ruby gem to generate data in the same format as "multipart/form-data".
+The gem is heavily inspired by the [JavaScript FormData API](https://developer.mozilla.org/en/docs/Web/API/FormData).
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'formdata'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install formdata
+
+## Example usage
+
+```ruby
+require 'formdata'
+require 'stringio'
+require 'net/http'
+
+# create form data
+f = FormData.new
+
+# append some text values...
+f.append('name', 'Richard')
+f.append('surname', 'Feynman')
+
+# ...and some files...
+f.append('avatar-file', File.open('some/file.jpg'))
+f.append('cv-file', File.open('some/file.pdf'), {
+  :content_type => 'application/pdf',
+  :filename => 'cv.pdf'
+})
+f.append('text-file', StringIO.new('test'), {
+  :content_tyoe => 'text/plain',
+  :filename => 'text.txt'
+})
+
+# ...or multiple values from a hash
+f.append({
+    'street' => '1200 E California Blvd',
+    'city' => 'Pasadena',
+    'zip' => '91125',
+    'state' => 'CA',
+    'map-file' => File.open('some/file.pdf')
+})
+
+# create a new net/http request
+req = Net::HTTP::Post.new('/test')
+req.content_type = f.content_type
+req.content_length = f.size
+req.body_stream = f
+
+# send the request
+http = Net::HTTP.new('localhost', 80)
+http.request(req) # => ...response
+
+# or use the request constructor
+req = f.post_request('/test')
+http = Net::HTTP.new('localhost', 80)
+http.request(req) # => ...response
+```

data/Rakefile

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

data/formdata.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'formdata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'formdata'
+  spec.version       = FormData::VERSION
+  spec.authors       = ['Nelson Darkwah Oppong']
+  spec.email         = ['n@darkwahoppong.com']
+
+  spec.summary       = 'Ruby gem to generate data in the same format as "multipart/form-data".'
+  spec.homepage      = 'http://github.com/nelsond/formdata'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'webmock', '~> 1.22'
+  spec.add_development_dependency 'sinatra', '~> 1.4.6'
+end

data/lib/formdata.rb

@@ -0,0 +1,119 @@
+require 'formdata/version'
+require 'securerandom'
+require 'tempfile'
+require 'mkmf'
+require 'net/http'
+
+module FormData
+  def self.new
+    FormData.new
+  end
+
+  class FormData
+    attr_reader :boundary
+
+    def initialize
+      @id = SecureRandom.hex(10).freeze
+
+      @buffer = Tempfile.new(@id)
+      @buffer.binmode
+
+      @boundary = "----RubyFormBoundary#{@id}".freeze
+
+      @finalized = false
+    end
+
+    def append(name, value = nil, opts = {})
+      name.each { |n, v| append(n, v) } if name.is_a?(Hash)
+
+      if value.respond_to?(:read)
+        append_file(name, value, opts)
+      else
+        append_text(name, value)
+      end
+    end
+
+    def content_type
+      "multipart/form-data; boundary=#{@boundary}"
+    end
+
+    def size
+      @finalized ? @buffer.size : @buffer.size + epilogue.size
+    end
+    alias length size
+
+    def read(*args)
+      finalize! unless @finalized
+      @buffer.read(*args)
+    end
+
+    def eof?(*args)
+      return false unless @finalized
+      @buffer.eof?(*args)
+    end
+
+    def post_request(*args)
+      req = Net::HTTP::Post.new(*args)
+      req.content_type = content_type
+      req.content_length = size
+      req.body_stream = self
+
+      req
+    end
+
+    private
+
+    def append_text(name, text)
+      write_boundary
+      @buffer.write %(Content-Disposition: form-data; name="#{name}"\r\n\r\n)
+      @buffer.write text.to_s
+    end
+
+    def append_file(name, file, opts = {})
+      opts[:filename] ||= File.basename(file.path) if file.respond_to?(:path)
+
+      if file.respond_to?(:path) && File.readable?(file.path)
+        opts[:content_type] ||= guess_mime_type(file)
+      end
+
+      opts = {
+        content_type: 'application/octet-stream',
+        filename: 'unknown'
+      }.merge(opts)
+
+      write_boundary
+      @buffer.write %(Content-Disposition: form-data; name="#{name}"; filename="#{opts[:filename]}"\r\n)
+      @buffer.write %(Content-Type: #{opts[:content_type]}\r\n\r\n)
+
+      chunk_size = 1024**2
+      @buffer.write file.read(chunk_size) until file.eof?
+      file.close
+    end
+
+    def write_boundary
+      @buffer.write "\r\n" if size > 0
+      @buffer.write "--#{@boundary}\r\n"
+    end
+
+    def epilogue
+      "\r\n--#{@boundary}--\r\n"
+    end
+
+    def finalize!
+      @buffer.write epilogue
+      @buffer.rewind
+      @finalized = true
+    end
+
+    def guess_mime_type(file)
+      return unless find_executable0('file')
+
+      content_type = nil
+      IO.popen(['file', '--brief', '--mime-type', file.path]) do |m|
+        content_type = m.read.strip
+      end
+
+      $?.exitstatus == 0 ? content_type : nil
+    end
+  end
+end

data/lib/formdata/version.rb

@@ -0,0 +1,3 @@
+module FormData
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: formdata
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nelson Darkwah Oppong
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+description: 
+email:
+- n@darkwahoppong.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- formdata.gemspec
+- lib/formdata.rb
+- lib/formdata/version.rb
+homepage: http://github.com/nelsond/formdata
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby gem to generate data in the same format as "multipart/form-data".
+test_files: []