httmultiparty_sf 0.3.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54f0193a6c526bbbb92f68ff2b0eb804596900bc
+  data.tar.gz: 20c9a2857190351daaa342375953054b2a7c76e2
+SHA512:
+  metadata.gz: 300dad012082b0d803046532af329e2bdb364beab6e36da18eb27e89ea92c0b57181ef38213a058ba85504ac708f3f1bcbe99cf9f31236046b04e4b25a0f8322
+  data.tar.gz: 9298f40555ad3cbf76f07f1ef35023efd6b2a6011dfef8f31b7ea99e2703f63ffa90ae7b2067f278bb7cd248e17e22b1e0944432e8b53f5b17f38f1182d5fd10

data/README.md

@@ -0,0 +1,58 @@
+[![Build Status](https://travis-ci.org/jwagener/httmultiparty.svg?branch=v0.3.14)](https://travis-ci.org/jwagener/httmultiparty)
+
+
+[![Gem Version](https://badge.fury.io/rb/httmultiparty.svg)](http://badge.fury.io/rb/httmultiparty)
+
+
+## Description
+
+HTTMultiParty is a thin wrapper around HTTParty to provide multipart uploads.
+
+## Requirements
+
+- httparty
+- multipart-post
+- mimemagic
+
+## Quick Start and Example
+
+To start just "include HTTMultiParty" instead of "include HTTParty" into
+your client class. When you pass a query with an instance of a File as a value for a PUT or POST request, the wrapper will use a bit of magic and multipart-post to execute a multipart upload:
+
+```ruby
+require 'httmultiparty'
+class SomeClient
+  include HTTMultiParty
+  base_uri 'http://localhost:3000'
+end
+
+response = SomeClient.post('/', :query => {
+  :foo      => 'bar',
+  :somefile => File.new('README.md')
+})
+```
+
+Aside from that it provides all the usual HTTParty gimmicks.
+
+## MIME type support
+
+If you want the library to detect the MIME types of the uploaded files, then
+you need to enable it by supplying the `:detect_mime_type` option as `true`
+for POST or PUT requests. Otherwise, they will be uploaded with the default
+MIME type of `application/octet-stream`. For example:
+
+```ruby
+require 'httmultiparty'
+class SomeClient
+  include HTTMultiParty
+  base_uri 'http://localhost:3000'
+end
+
+response = SomeClient.post('/', :query => {
+  :foo      => 'bar',
+  :somefile => File.new('README.md')
+}, :detect_mime_type => true)
+```
+## File class support
+
+You can use any class that responds to a `read` method. This method should act similar to the `IO#read` method. To set the filename your file class can optionally respond to the `original_filename` method, which should return a `String`.

data/lib/httmultiparty.rb

@@ -0,0 +1,134 @@
+gem 'httparty'
+gem 'multipart-post'
+require 'tempfile'
+require 'httparty'
+require 'net/http/post/multipart'
+require 'mimemagic'
+
+module HTTMultiParty
+  def self.included(base)
+    base.send :include, HTTParty
+    base.extend ClassMethods
+  end
+
+  def self.file_to_upload_io(file, detect_mime_type = false)
+    if file.respond_to? :original_filename
+      filename = file.original_filename
+    else
+      filename =  File.split(file.path).last
+    end
+    content_type = detect_mime_type ? MimeMagic.by_path(filename) : 'application/octet-stream'
+    UploadIO.new(file, content_type, filename)
+  end
+
+  def self.query_string_normalizer(options = {})
+    detect_mime_type = options.fetch(:detect_mime_type, false)
+    Proc.new do |params|
+      if file_present_in_params?(params)
+        HTTMultiParty.flatten_params(params).map do |(k,v)|
+          [k, v.respond_to?(:read) ? HTTMultiParty.file_to_upload_io(v, detect_mime_type) : v]
+        end
+      else
+        HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER.call(params)
+      end
+    end
+  end
+
+  def self.flatten_params(params={}, prefix='')
+    flattened = []
+    params.each do |(k,v)|
+      if params.is_a?(Array)
+        v = k
+        k = ""
+      end
+
+      flattened_key = prefix == "" ? "#{k}" : "#{prefix}[#{k}]"
+      if v.is_a?(Hash) || v.is_a?(Array)
+        flattened += flatten_params(v, flattened_key)
+      else
+        flattened << [flattened_key, v]
+      end
+    end
+    flattened
+  end
+
+  def self.get(*args)
+    Basement.get(*args)
+  end
+
+  def self.post(*args)
+    Basement.post(*args)
+  end
+
+  def self.put(*args)
+    Basement.put(*args)
+  end
+
+  def self.delete(*args)
+    Basement.delete(*args)
+  end
+
+  def self.head(*args)
+    Basement.head(*args)
+  end
+
+  def self.options(*args)
+    Basement.options(*args)
+  end
+
+  private
+
+  def self.file_present_in_params?(params)
+    params.values.any? do |v|
+      if v.is_a? Array
+        v.any? { |vv| file_present?(vv) }
+      elsif v.is_a? Hash
+        v.values.any? { |vv| file_present?(vv) }
+      else
+        file_present?(v)
+      end
+    end
+  end
+
+  def self.file_present?(value)
+    value.respond_to?(:read)
+  end
+
+   module ClassMethods
+     def post(path, options={})
+       method = Net::HTTP::Post
+       options[:body] ||= options.delete(:query)
+       if hash_contains_files?(options[:body])
+         method = MultipartPost
+         options[:query_string_normalizer] = HTTMultiParty.query_string_normalizer(options)
+       end
+       perform_request method, path, options
+     end
+
+     def put(path, options={})
+       method = Net::HTTP::Put
+       options[:body] ||= options.delete(:query)
+       if hash_contains_files?(options[:body])
+         method = MultipartPut
+         options[:query_string_normalizer] = HTTMultiParty.query_string_normalizer(options)
+       end
+       perform_request method, path, options
+     end
+
+    private
+      def hash_contains_files?(hash)
+        hash.is_a?(Hash) && HTTMultiParty.flatten_params(hash).select do |_,v|
+          HTTMultiParty.file_present?(v)
+        end.size > 0
+      end
+   end
+
+  class Basement
+    include HTTMultiParty
+  end
+end
+
+require 'httmultiparty/version'
+require 'httmultiparty/multipartable'
+require 'httmultiparty/multipart_post'
+require 'httmultiparty/multipart_put'

data/lib/httmultiparty/multipart_post.rb

@@ -0,0 +1,5 @@
+class HTTMultiParty::MultipartPost < Net::HTTP::Post
+  include HTTMultiParty::Multipartable
+end
+
+HTTParty::Request::SupportedHTTPMethods << HTTMultiParty::MultipartPost

data/lib/httmultiparty/multipart_put.rb

@@ -0,0 +1,5 @@
+class HTTMultiParty::MultipartPut < Net::HTTP::Put
+  include HTTMultiParty::Multipartable
+end
+
+HTTParty::Request::SupportedHTTPMethods << HTTMultiParty::MultipartPut

data/lib/httmultiparty/multipartable.rb

@@ -0,0 +1,28 @@
+module HTTMultiParty::Multipartable
+  DEFAULT_BOUNDARY = "-----------RubyMultipartPost"
+  # prevent reinitialization of headers
+  def initialize_http_header(initheader)
+    super
+    set_headers_for_body
+  end
+
+  def body=(value)
+    @body_parts = Array(value).map {|(k,v)| Parts::Part.new(boundary, k, v)}
+    @body_parts << Parts::EpiloguePart.new(boundary)
+    set_headers_for_body
+  end
+
+  def boundary
+    DEFAULT_BOUNDARY
+  end
+
+private
+
+  def set_headers_for_body
+    if @body_parts
+      self.set_content_type("multipart/form-data", { "boundary" => boundary })
+      self.content_length = @body_parts.inject(0) {|sum,i| sum + i.length }
+      self.body_stream = CompositeReadIO.new(*@body_parts.map { |part| part.to_io })
+    end
+  end
+end

data/lib/httmultiparty/version.rb

@@ -0,0 +1,3 @@
+module HTTMultiParty
+  VERSION = '0.3.14'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: httmultiparty_sf
+version: !ruby/object:Gem::Version
+  version: 0.3.14
+platform: ruby
+authors:
+- Johannes Wagener
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  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: mimemagic
+  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: 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: fakeweb
+  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: HTTMultiParty is a thin wrapper around HTTParty to provide multipart
+  uploads.
+email:
+- johannes@wagener.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/httmultiparty/multipart_post.rb
+- lib/httmultiparty/multipart_put.rb
+- lib/httmultiparty/multipartable.rb
+- lib/httmultiparty/version.rb
+- lib/httmultiparty.rb
+- README.md
+homepage: http://github.com/jwagener/httmultiparty
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: HTTMultiParty is a thin wrapper around HTTParty to provide multipart uploads.
+test_files: []