anyfetch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f6440473107e9be88c9355b4b3ba91bb518d292
+  data.tar.gz: 1140887e72f2336f59cc7b9738496bf6b642e8a5
+SHA512:
+  metadata.gz: 15e01dc7b1ac52f129a086a73618b0262245ff939b3639aed43d908064b7a155e6360da4dd8e609d94ed55aed4b3c6c2d6ff25807958d77e3e86ae253625dd12
+  data.tar.gz: 5200670c1d3b55948c4eeaf589d9efeac0c801412c8b68cbaa8be85af8e0bd92f9f4f1713a1b023eb21281f380dcd57ed9fa70dd68f3bd3a64a9dc102e88d484

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in anyfetch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michał Szajbe
+
+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,76 @@
+# Anyfetch
+
+Anyfetch provides abstraction layer around multiple protocols to allow accessing files in uniform way.
+
+Current support:
+
+* local files (via path or `file:///` protocol)
+* HTTP(s)
+* FTP
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'anyfetch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install anyfetch
+
+## Usage
+
+Simply provide file's URI. Optionally an `options` hash can be provided as second argument, it will be passed "as is" to specific handler (see below).
+
+`Anyfetch.open(uri, options)`
+
+### Local files
+
+Both path and `file://` protocol are accepted.
+
+```
+Anyfetch.open("/path/to/file")
+Anyfetch.open("file:///path/to/file")
+```
+
+### HTTP/HTTPS and FTP
+
+Internally `open-uri` (with extensions provided by `open_uri_redirections` gem) is used to fetch the file from HTTP and FTP servers. Feel free to pass any options recognized by `open-uri` or `open_uri_redirections`.
+
+```
+Anyfetch.open("http://example.org/file.html")
+Anyfetch.open("https://user:password@example.org/file.html", { 'User-Agent' => '...' })
+Anyfetch.open("ftp://user:password@example.org/file.html")
+```
+
+### Original filenames
+
+It is not always possible to know the original filename and/or content type of the accessed file upfront, e.g. when fetching files from the URLs like `http://example.org/file?id=123` or when the file is streamed from the server. Anyfetch provides `original_filename` method to the file instance to handle this. Internally it checks `content-disposition` meta information returned by the server, file's content type or simply file's basename for local files. This method can also be handy when trying to assign the file to an uploader like Paperclip or Carrierwave.
+
+```
+file = Anyfetch.open("http://example.org/file?id=123")
+file.original_filename
+# => filename.html
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+Found a bug? File an issue on Github. Got a patch? Submit a pull request.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/szajbus/anyfetch.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/anyfetch.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "anyfetch/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "anyfetch"
+  spec.version       = Anyfetch::VERSION
+  spec.authors       = ["Michał Szajbe"]
+  spec.email         = ["michal.szajbe@gmail.com"]
+
+  spec.summary       = %q{Fetch files via any protocol.}
+  spec.description   = %q{Anyfetch provides abstraction layer around multiple protocols to allow accessing files in uniform way.}
+  spec.homepage      = "https://github.com/szajbus/anyfetch"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'cocaine'
+  spec.add_dependency 'mime-types'
+  spec.add_dependency 'open_uri_redirections'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "anyfetch"
+
+# 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(__FILE__)

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/anyfetch/file.rb

@@ -0,0 +1,15 @@
+require "anyfetch/original_filename/path"
+
+module Anyfetch
+  class File
+    def initialize(uri, options = {})
+      @uri = uri
+      @options = options
+    end
+
+    def open
+      file = ::File.open(@uri.path)
+      file.extend(OriginalFilename::Path)
+    end
+  end
+end

data/lib/anyfetch/ftp.rb

@@ -0,0 +1,26 @@
+require "anyfetch/original_filename/content_type"
+
+module Anyfetch
+  class FTP
+    def initialize(uri, options = {})
+      @uri = uri
+      @options = options
+      setup_auth
+    end
+
+    def open
+      file = super(@uri)
+      file.extend(OriginalFilename::ContentType)
+      file
+    end
+
+    private
+
+    def setup_auth
+      if @uri.password
+        # Rollback URI-encoding of password by open-uri lib
+        @uri.instance_variable_set "@password", URI.decode(@uri.password)
+      end
+    end
+  end
+end

data/lib/anyfetch/http.rb

@@ -0,0 +1,32 @@
+require "anyfetch/original_filename/content_type"
+
+module Anyfetch
+  class HTTP
+    OPTIONS = {
+      "User-Agent" => "Mozilla/5.0 (X11; Linux x86_64; rv:39.0) Gecko/20100101 Firefox/39.0",
+      allow_redirections: :safe,
+    }
+
+    def initialize(uri, options)
+      @uri = uri
+      @options = OPTIONS.merge(options)
+      setup_basic_auth
+    end
+
+    def open
+      file = super(@uri, @options)
+      file.extend(OriginalFilename::ContentType)
+      file
+    end
+
+    private
+
+    def setup_basic_auth
+      if @uri.user || @uri.password
+        @options[:http_basic_authentication] = [@uri.user, @uri.password]
+        @uri.user = nil
+        @uri.password = nil
+      end
+    end
+  end
+end

data/lib/anyfetch/original_filename/content_type.rb

@@ -0,0 +1,32 @@
+require "cocaine"
+require "mime-types"
+
+module Anyfetch
+  module OriginalFilename
+    module ContentType
+      def original_filename
+        if meta.include? 'content-disposition'
+          match = meta['content-disposition'].match(/filename=(\"?)(.+)\1/)
+          return match[2] unless match.nil?
+        end
+
+        filename = ::File.basename(base_uri.path)
+        ext = ::File.extname(filename)
+
+        cmd = Cocaine::CommandLine.new('/usr/bin/file', '--mime-type -b :file')
+        begin
+          mime_type = cmd.run(file: path)
+        rescue
+          mime_type = meta['content-type']
+        end
+
+        if mime = MIME::Types[mime_type.to_s.strip].first
+          mime_ext = mime.extensions.first
+          ext != mime_ext ? [::File.basename(filename, ext), '.', mime_ext].join : filename
+        else
+          filename
+        end
+      end
+    end
+  end
+end

data/lib/anyfetch/original_filename/path.rb

@@ -0,0 +1,9 @@
+module Anyfetch
+  module OriginalFilename
+    module Path
+      def original_filename
+        ::File.basename(path)
+      end
+    end
+  end
+end

data/lib/anyfetch/version.rb

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

data/lib/anyfetch.rb

@@ -0,0 +1,37 @@
+require "open-uri"
+require "open_uri_redirections"
+
+require "anyfetch/file"
+require "anyfetch/ftp"
+require "anyfetch/http"
+require "anyfetch/version"
+
+module Anyfetch extend self
+  def open(uri, options = {})
+    uri = URI.parse(uri.to_s)
+    handler(uri, options).open
+  end
+
+  private
+
+  def to_uri(uri)
+    uri = uri.gsub('[', '%5B').gsub(']', '%5D').strip
+    uri = ::URI.parse(::URI.encode(::URI.decode(uri)))
+    URI.parse(uri)
+  end
+
+  def handler(uri, options = {})
+    scheme = uri.scheme || "file"
+
+    klass =
+      case scheme
+      when "file"    then File
+      when "ftp"     then FTP
+      when /^https?/ then HTTP
+      else
+        raise "No handler for '#{scheme}' protocol."
+      end
+
+    klass.new(uri, options)
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: anyfetch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michał Szajbe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocaine
+  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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: open_uri_redirections
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: Anyfetch provides abstraction layer around multiple protocols to allow
+  accessing files in uniform way.
+email:
+- michal.szajbe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- anyfetch.gemspec
+- bin/console
+- bin/setup
+- lib/anyfetch.rb
+- lib/anyfetch/file.rb
+- lib/anyfetch/ftp.rb
+- lib/anyfetch/http.rb
+- lib/anyfetch/original_filename/content_type.rb
+- lib/anyfetch/original_filename/path.rb
+- lib/anyfetch/version.rb
+homepage: https://github.com/szajbus/anyfetch
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Fetch files via any protocol.
+test_files: []