bundler-download 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb61a0b520412978a018678b63cc25c70eb15ac38f3846b3696df2053a6dd7c1
+  data.tar.gz: 97dd4d3d79ba2ca66cf0ba5f7336da9e64d98b496fdd11ca18f30407dd94fb49
+SHA512:
+  metadata.gz: cd213672c9915b6988aee281e19dd25c0a28bad85067d3aa84dcd4e4d2a4cdd2df8d5a67a3606db0ef090ec384f55277fd9296937fba731a562ecb1c90f7951a
+  data.tar.gz: 8492025f9a3b7c2a7779a77e09783c35eb46f05cf0f89e9dfae036574813ad6aecb0adbc369a91ee63cb59037a4a855c2b28e0eb0f0adac1838d56dcb75bdfd5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 1.0.0
+
+- Initial bundler-download with gem-after-install-all hook and `download` command for gem `Downloadfile`

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Andy Maleh
+
+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,119 @@
+# bundler-download - Bundler Plugin
+[![Gem Version](https://badge.fury.io/rb/bundler-download.svg)](http://badge.fury.io/rb/bundler-download)
+
+Bundler plugin for auto-downloading specified extra files via [`Downloadfile`](#downloadfile) after `bundle install`.
+
+## How It Works
+
+Gems declare the need for extra downloads upon install by Bundler via [`Downloadfile`](#downloadfile).
+
+Apps can simply add those gems to Bundler `Gemfile` the standard way with no change. Afterwards, when running `bundle install`, bundle-download will automatically download extra files at the end.
+
+If a Ruby Gem needs to depend on one of those gems, it can declare as a standard dependency in .gemspec
+
+## Gem Instructions
+
+Add `bundler-download` as a standard .gemspec dependency:
+
+```ruby
+s.add_dependency('bundler', [">= 2.1.4"])
+```
+
+Afterwards, ensure there is a [`Downloadfile`](#downloadfile) at the root directory of the gem that needs extra downloads, mentioning under .gemspec `files`:
+
+```ruby
+    s.files = [
+    # ...
+      "Downloadfile",
+    # ...
+    ]
+```
+
+### Downloadfile
+
+A gem `Downloadfile` contains download links for files that need to be downloaded relative to the gem directory after install.
+
+Example of `Downloadfile`:
+
+```
+download 'http://dl.maketechnology.io/chromium-cef/rls/repository/plugins/com.make.chromium.cef.gtk.linux.x86_64_0.4.0.202005172227.jar' # downloads into gem root directory
+download 'http://dl.maketechnology.io/chromium-cef/rls/repository/plugins/com.make.chromium.cef.cocoa.macosx.x86_64_0.4.0.202005172227.jar', 
+  to: 'cef' # downloads into 'cef' directory under the gem installation directory
+download 'http://dl.maketechnology.io/chromium-cef/rls/repository/plugins/com.make.chromium.cef.win32.win32.x86_64_0.4.0.202005172227.jar',
+  to: 'cef/windows' # downloads into 'cef/windows' directory under the gem installation directory
+```
+
+## App Instructions
+
+Apps can depend on a gem with `Downloadfile` by adding `bundler-download` plugin and including the gem in `Gemfile` like it normally would:
+
+```
+plugin 'bundler-download'
+gem 'some_gem_with_downloadfile'
+```
+
+Afterwards, run `bundle install` twice (the first time it installs the plugin and the second time it activates it):
+
+```
+bundle install
+bundle install
+```
+
+You should see something like this:
+
+```
+$ bundle
+Using array_include_methods 1.0.2
+Using bundler 2.1.4
+Using download 1.1.0
+Using mime-types-data 3.2020.0512
+Using mime-types 3.3.1
+Using multi_xml 0.6.0
+Using httparty 0.18.1
+Using strings-ansi 0.1.0
+Using tty-cursor 0.7.1
+Using tty-screen 0.8.1
+Using unicode-display_width 1.7.0
+Using tty-progressbar 0.17.0
+Using bundler-download 1.0.0
+Using facets 3.1.0
+Using glimmer 1.0.0
+bundle-download plugin gem-after-install-all hook:
+Processing /Users/User/.rvm/gems/ruby-2.7.1@tmp/gems/glimmer-1.0.0/Downloadfile
+Download URL: https://equo-chromium-cef.ams3.digitaloceanspaces.com/rls/repository/plugins/com.make.chromium.cef.gtk.linux.x86_64_0.4.0.202005172227.jar
+Download size: 57742279
+Download path: /Users/User/.rvm/gems/ruby-2.7.1@tmp/gems/glimmer-1.0.0/com.make.chromium.cef.gtk.linux.x86_64_0.4.0.202005172227.jar
+Downloading 100% (  0s ) [========================================================]
+Download URL: https://equo-chromium-cef.ams3.digitaloceanspaces.com/rls/repository/plugins/com.make.chromium.cef.cocoa.macosx.x86_64_0.4.0.202005172227.jar
+Download size: 54070695
+Download path: /Users/User/.rvm/gems/ruby-2.7.1@tmp/gems/glimmer-1.0.0/cef/com.make.chromium.cef.cocoa.macosx.x86_64_0.4.0.202005172227.jar
+Downloading 26% ( 59s ) [==============                                      ]
+```
+
+Subsequent runs of `bundle install` will keep existing downloads without overwriting them unless you use the [`bundle-download`](#bundler-download-command) command to manually redownload files again.
+
+### Bundler Download Command
+
+If you would like to redownload file from gem [`Downloadfile's`](#downloadfile) again, overwriting existing downloads, simply run:
+
+`bundle download`
+
+If you only want to download files if they didn't exist already, you could alternatively run:
+
+`bundle download --keep-existing`
+
+## Contributing to bundler-download
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+[MIT](LICENSE.txt)
+
+Copyright (c) 2020 Andy Maleh.

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/bundler-download

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundle-download'
+
+Bundler::Download.new.exec('download', ARGV)

data/bundler-download.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: bundler-download 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "bundler-download".freeze
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["AndyMaleh".freeze]
+  s.date = "2020-09-22"
+  s.description = "Bundler plugin for auto-downloading specified extra files after gem install".freeze
+  s.email = "andy.am@gmail.com".freeze
+  s.executables = ["bundler-download".freeze]
+  s.extra_rdoc_files = [
+    "CHANGELOG.md",
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG.md",
+    "LICENSE.txt",
+    "README.md",
+    "VERSION",
+    "bin/bundler-download",
+    "bundler-download.gemspec",
+    "lib/bundler-download.rb",
+    "lib/bundler-download/ext/download.rb",
+    "lib/bundler/download.rb",
+    "lib/bundler/downloadfile.rb",
+    "plugins.rb"
+  ]
+  s.homepage = "http://github.com/AndyObtiva/bundler-download".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.1.2".freeze
+  s.summary = "Bundler plugin for auto-downloading specified extra files after gem install".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<bundler>.freeze, [">= 2.0.0"])
+    s.add_runtime_dependency(%q<httparty>.freeze, ["~> 0.18.1"])
+    s.add_runtime_dependency(%q<download>.freeze, ["~> 1.1.0"])
+    s.add_runtime_dependency(%q<tty-progressbar>.freeze, ["~> 0.17.0"])
+    s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+    s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_development_dependency(%q<jeweler>.freeze, [">= 2.3.5"])
+    s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_development_dependency(%q<puts_debuggerer>.freeze, [">= 0"])
+    s.add_development_dependency(%q<pessimize>.freeze, [">= 0"])
+    s.add_development_dependency(%q<rake-tui>.freeze, [">= 0"])
+  else
+    s.add_dependency(%q<bundler>.freeze, [">= 2.0.0"])
+    s.add_dependency(%q<httparty>.freeze, ["~> 0.18.1"])
+    s.add_dependency(%q<download>.freeze, ["~> 1.1.0"])
+    s.add_dependency(%q<tty-progressbar>.freeze, ["~> 0.17.0"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<jeweler>.freeze, [">= 2.3.5"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<puts_debuggerer>.freeze, [">= 0"])
+    s.add_dependency(%q<pessimize>.freeze, [">= 0"])
+    s.add_dependency(%q<rake-tui>.freeze, [">= 0"])
+  end
+end
+

data/lib/bundler-download.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2020 Andy Maleh
+# 
+# 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.
+
+require 'bundler'
+require 'download'
+require 'fileutils'
+require 'httparty'
+require 'tty-progressbar'
+
+$LOAD_PATH.unshift(File.expand_path('..', __FILE__))
+
+require 'bundler-download/ext/download'
+require 'bundler/downloadfile'
+require 'bundler/download'
+
+Bundler::Plugin.add_hook(Bundler::Plugin::Events::GEM_AFTER_INSTALL_ALL) do |dependencies|
+  puts 'bundle-download plugin gem-after-install-all hook (checking gems for Downloadfile):'
+  Bundler::Download.new.exec('download', ['--keep-existing'])
+end

data/lib/bundler-download/ext/download.rb

@@ -0,0 +1,60 @@
+# Copyright (c) 2020 Andy Maleh
+# 
+# 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.
+
+require 'net/http'
+
+module Download
+  class Object
+    DOWNLOAD_CHUNK_SIZE = 1_048_576
+    
+    def start(hash={})
+      set_multi(hash)
+      return puts("Download '#{file_path}' already exists! (run `bundle download` to redownload)") if options.keys.include?('--keep_existing') && File.exist?(file_path)
+      
+      head_response = HTTParty.head(url)
+      uri = head_response.request.uri
+      content_length = head_response.headers["content-length"]
+      puts "Download URL: #{uri.to_s}"
+      puts "Download size: #{content_length}"
+      puts "Download path: #{file_path}"
+      file_size = content_length.to_f
+      progress_total = (file_size / DOWNLOAD_CHUNK_SIZE).ceil
+      bar = TTY::ProgressBar.new("Downloading :percent ( :eta ) [:bar]", total: progress_total)
+      starting_bytes = 0
+      File.open(file_path, 'wb') do |file_obj|
+        until starting_bytes >= file_size
+          Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+            ending_bytes = [starting_bytes + DOWNLOAD_CHUNK_SIZE, file_size].min
+            ending_bytes = nil if ending_bytes == file_size # this makes the request return remaining bytes only
+            request = Net::HTTP::Get.new uri, 'Range' => "bytes=#{starting_bytes}-#{ending_bytes}"
+            res = http.request request # Net::HTTPResponse object
+            file_obj << res.body
+            starting_bytes += DOWNLOAD_CHUNK_SIZE + 1
+            bar.advance(1)
+          end
+        end
+      end
+
+      return file_path
+
+    end 
+  end
+end

data/lib/bundler/download.rb

@@ -0,0 +1,20 @@
+module Bundler
+  class Download < Bundler::Plugin::API
+    command "download"
+  
+    def exec(command, args)
+      begin
+        downloadfiles = Dir.glob(File.join(Gem.dir, 'gems', '**', 'Downloadfile')).to_a
+        puts 'No gems were found with Downloadfile.' if downloadfiles.empty?
+        downloadfiles.each do |downloadfile|
+          puts "Processing #{downloadfile}"
+          Bundler::Downloadfile.new(File.read(downloadfile), gem_path: File.dirname(downloadfile), keep_existing: args.include?('--keep-existing')).call
+        end
+        true
+      rescue => e
+        puts e.full_message
+        false
+      end
+    end
+  end
+end

data/lib/bundler/downloadfile.rb

@@ -0,0 +1,22 @@
+module Bundler
+  class Downloadfile
+    
+    def initialize(file_content, gem_path:, keep_existing:)
+      @gem_path = gem_path
+      @file_content = file_content
+      @keep_existing = keep_existing
+    end
+    
+    def download(uri, to:'')
+      directory = File.join(@gem_path, to)
+      FileUtils.mkdir_p(directory)
+      options = {}
+      options['--keep_existing'] = nil if @keep_existing
+      ::Download.file(uri, directory, options)
+    end
+    
+    def call
+      instance_eval(@file_content)
+    end
+  end
+end

data/plugins.rb

@@ -0,0 +1 @@
+require 'bundler-download'

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: bundler-download
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- AndyMaleh
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: download
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: puts_debuggerer
+  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: pessimize
+  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: rake-tui
+  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: Bundler plugin for auto-downloading specified extra files after gem install
+email: andy.am@gmail.com
+executables:
+- bundler-download
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- VERSION
+- bin/bundler-download
+- bundler-download.gemspec
+- lib/bundler-download.rb
+- lib/bundler-download/ext/download.rb
+- lib/bundler/download.rb
+- lib/bundler/downloadfile.rb
+- plugins.rb
+homepage: http://github.com/AndyObtiva/bundler-download
+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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Bundler plugin for auto-downloading specified extra files after gem install
+test_files: []