pull_tempfile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: caf9eb1fd40ac992ddd93ac1e53514c560d2c4c1
+  data.tar.gz: 6a288c61ead7821e62d2cf4b89aa57d0039e9e7c
+SHA512:
+  metadata.gz: 8618caa4f7c3cc2689d5ab7d36e0649ff2913e2a79089ec8edc42f86fca8bded6e6fa8935703bd0e87d7f2604525495de1c55a3ab558bf0c52b2af858d4eb51d
+  data.tar.gz: c26e94ac0e8df02659ddb1ed61c872e2422e3f416b7f7c9a5ecd104939e5aa3a31fc46c00e744f0da870db79034b0db3a43217e56beb62001a5c5cb5f0ee9232

data/.gitignore

@@ -0,0 +1,11 @@
+/.ruby-version
+/.ruby-gemset
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.3
+  - 2.3.0
+before_install: gem install bundler -v 1.10.6
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at equivalent@eq8.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pull_tempfile.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tomas Valent
+
+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,165 @@
+# PullTempfile
+
+[![Build Status](https://travis-ci.org/equivalent/pull_tempfile.svg?branch=master)](https://travis-ci.org/equivalent/pull_tempfile)
+[![Code Climate](https://codeclimate.com/github/equivalent/pull_tempfile/badges/gpa.svg)](https://codeclimate.com/github/equivalent/pull_tempfile)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pull_tempfile'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pull_tempfile
+
+## Usage
+
+```
+class Medium < ActiveRecord::Base
+  has_attached_file :file
+
+  # ...
+end
+
+require 'pull_tempfile'
+
+# when used as "AWS S3 browser upload" you can fetch original filename as "${filename}" metadata
+# or use some different way to determine the file name.
+original_filename = 'my face.jpg'
+
+medium = Media.new
+
+PullTempfile.transaction(url: url, original_filename: original_filename) do |tmp_file|
+  medium.file = tmp_file
+  medium.save!
+end
+
+```
+
+Transaction will automatically delete (`unlink`) the temporary file after block
+finish. If you want to keep the tmp file for longer you can use:
+
+```
+file = PullTempfile.pull_tempfile(url: url, original_filename: original_filename)
+# ...
+file.unlink # delete file
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+## Reason why this Gem exist:
+
+When you using gem like [paperclip](https://github.com/thoughtbot/paperclip) `> 3.1.4` you can do something like this to pull file from url:
+
+```ruby
+class User < ActiveRecord::Base
+  attr_reader :avatar_remote_url
+  has_attached_file :avatar
+
+  def avatar_remote_url=(url_value)
+    self.avatar = URI.parse(url_value)
+    # Assuming url_value is http://example.com/photos/face.png
+    # avatar_file_name == "face.png"
+    # avatar_content_type == "image/png"
+    @avatar_remote_url = url_value
+  end
+end
+
+user = User.new
+user.avatar_remote_url = 'http://example.com/photos/face.png'
+user.save!
+```
+
+And this is how you upload file from url.
+
+> source
+> https://github.com/thoughtbot/paperclip/wiki/Attachment-downloaded-from-a-URL
+
+The problem is that if you do this on AWS S3 signd url is sending binary mime type
+`binary/octet-stream` and therefore
+if you are implementing validations on your uploads:
+
+```
+class User < ActiveRecord::Base
+  # ...
+  validates_attachment_content_type :avatar, :content_type => ["image/jpg", "image/jpeg", "image/png", "image/gif"]
+  # ...
+end
+```
+
+...you'll get error:
+
+```
+Validation failed: File has contents that are not what they are
+reported to be, File is invalid, File content type is invalid
+```
+
+One solution is to skip validations in this context:
+
+```ruby
+#...
+medium.save!(validate: false)  # will skip validations
+```
+
+...but that's not secure.
+
+> Yes you can use context validations, or implement validations differently
+> http://www.eq8.eu/blogs/22-different-ways-how-to-do-rails-validations
+> but that's not the point,
+
+So way how to get around this is to  download the file to your `/tmp/` folder as a temp
+file, and upload it via Paperclip
+
+Install gem `httparty`
+
+```
+# Gemfile
+# ...
+gem 'httparty'
+# ...
+```
+
+Run `bundle install`
+
+
+Next create new file `./lib/s3_helper.rb`
+
+```
+require 'httparty'      # gem
+module S3Helper
+  def pull_asset(url:, destination:)
+    File.open(destination, "wb") do |f|
+      f.binmode
+      f.write HTTParty.get(url).parsed_response
+      f.close
+    end
+  end
+end
+```
+
+And now you can do something like:
+
+```ruby
+user = User.new
+require Rails.root.join('lib', 's3_helper')
+
+S3Helper.pull_asset(url: "http://s3....../bbuesubeueueue", destination: "/tmp/my-file.jpg")
+
+user.avatar = File.open("/tmp/my-file.jpg")
+user.save!
+```
+
+But the problem is that you need to delete this file manually. So why
+not to take advantage of Ruby `Tempfile`. This is exactly what this gem
+is doing. Have a look on the Source code  https://github.com/equivalent/pull_tempfile/blob/master/lib/pull_tempfile.rb

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pull_tempfile"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pull_tempfile/version.rb

@@ -0,0 +1,3 @@
+module PullTempfile
+  VERSION = "0.1.0"
+end

data/lib/pull_tempfile.rb

@@ -0,0 +1,39 @@
+require 'httparty'     # gem
+require 'pathname'     # standard Ruby lib
+require 'tempfile'     # standard Ruby lib
+
+require "pull_tempfile/version"
+
+module PullTempfile
+  # Creates Temporary file
+  #
+  #     file = PullTempfile.pull_tempfile(original_filename: "image asset.jpg", url: 'http://..../uaoeuoeueoauoueao' )
+  #     # ...do stuff
+  #     file.unlink
+  #
+  # Temporary files have suffix so your file "image asset.jpg"
+  # will be saved as "/tmp/image asset20160317-18066-gw1q0.jpg". This is because
+  # Tempfile lib is ensuring you won't override files
+  #
+  # Remmember to `file.unlink` or PullTempfile.transaction that does that automatically
+  #
+  def self.pull_tempfile(original_filename:, url:)
+    _generated_name = Pathname.new(original_filename)
+    extension     = _generated_name.extname.to_s
+    tmp_file_name = _generated_name.basename(extension).to_s
+
+    file = Tempfile.new([tmp_file_name, extension])
+    file.binmode
+    file.write(HTTParty.get(url).parsed_response)
+    file.close
+    file
+  end
+
+  def self.transaction(original_filename:, url:)
+    file = pull_tempfile(original_filename: original_filename, url: url)
+
+    yield file.open
+  ensure
+    file && file.unlink #delete temp file
+  end
+end

data/pull_tempfile.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pull_tempfile/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pull_tempfile"
+  spec.version       = PullTempfile::VERSION
+  spec.authors       = ["Tomas Valent"]
+  spec.email         = ["equivalent@eq8.eu"]
+
+  spec.summary       = %q{Pull URL to temporary file}
+  spec.description   = %q{Lightway way to pull file from URL to tmp folder as a standard Ruby Tempfile}
+  spec.homepage      = "https://github.com/equivalent/pull_tempfile"
+  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_dependency "httparty", "~> 0.13"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.24"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: pull_tempfile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Valent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+description: Lightway way to pull file from URL to tmp folder as a standard Ruby Tempfile
+email:
+- equivalent@eq8.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pull_tempfile.rb
+- lib/pull_tempfile/version.rb
+- pull_tempfile.gemspec
+homepage: https://github.com/equivalent/pull_tempfile
+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.8
+signing_key: 
+specification_version: 4
+summary: Pull URL to temporary file
+test_files: []