bundler-download 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c510e683dd2ec94c94ac33ae12c2e5776ac48cb2bba048eaa996a26910e35c94
-  data.tar.gz: 22c912fc084b77506db7170abdbc6292742f294b7ade309ce4c17a770b0fcff2
+  metadata.gz: f64d8149b156977c05751eaecef7826a3ee378ebdb5d529f0875597b11d4a5d9
+  data.tar.gz: 41bb7ad2e11cd1bcd47f0557c0d512ae5312a6193f2a518cfb7de7e1c0f7639d
 SHA512:
-  metadata.gz: f9b624db4e06692595b0a9b5e430d0e7ceb299ad7de6a27d18b6611c28484bcae7bad9e1771c4beffd45e1a586f667920e46ba9d2a3fe86e2bfe1fc8bc8cc229
-  data.tar.gz: c0503acbebf26d166709d97051cfea861f9256799fadd08d5226d5ad84be1ef47617bcd65990d1b57b74ae55a2913e9b179ffdf85ff6263cb01e516f52b5dcb5
+  metadata.gz: 1c8ff5f7452e4c1e4e0a2a118ce0e899f0334a0695a0ffa31c9f6458d12e7ca46c119af843dade3c27812f65cec7c1fa3b4ef31ae4dcfbb3553acec471329c22
+  data.tar.gz: a8f98b7bd09a75514558b09a22f5a9026c72214d7eefcb408c8e267feca121a828fa2651ef82c67cba4e9f203cc0bedfd8334f8222c0f1ec296bdee2cc6389c2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 1.2.0
+
+- Get rid of httparty
+- Only download files for Gemfile gems
+
 ## 1.1.0
 
 - Add a post install message

data/README.md

@@ -3,6 +3,14 @@
 
 Bundler plugin for auto-downloading extra gem files (e.g. large file downloads) specified in [`Downloadfile`](#downloadfile) after `bundle install`.
 
+## Background
+
+The RubyGem ecosystem, famous for gems like Rails for web development, Devise for authentication, and Pundit for authorization, enables productivity via code reuse. As such, it is great for quickly adding libraries to your project to automate part of the work or reuse other people's solutions to solved problems.
+
+That said, you would not want to package extremely large files, like the OpenAI GPT-3 175 billion parameter models, in a RubyGem.
+
+Enter [bundler-download](https://rubygems.org/gems/bundler-download), a Bundler Plugin that enables downloading extra gem files after installing with with `bundle install` by declaring gem downloads in a [Downloadfile](#downloadfile)
+
 ## How It Works
 
 Gems can add a [`Downloadfile`](#downloadfile) at the root to declare the need for extra downloads upon install by Bundler.
@@ -13,7 +21,7 @@ If a Ruby Gem needs to depend on one of those gems, it can declare as a standard
 
 ## Gem Instructions
 
-Add [bundler-download](https://rubygems.org/gems/bundler-download) as a standard .gemspec dependency (and mention in its [instructions](#app-instructions) that apps must add `plugin bundler-download` in "Gemfile" to get the extra downloads):
+Add [bundler-download](https://rubygems.org/gems/bundler-download) as a standard .gemspec dependency:
 
 ```ruby
 s.add_dependency('bundler-download', [">= 1.1.0"])
@@ -29,10 +37,20 @@ Afterwards, ensure there is a [`Downloadfile`](#downloadfile) at the root direct
     ]
 ```
 
+Finally, follow one of two options for having applications obtain downloads:
+1. Advertise that apps must install `bundler-download` as a Bundler plugin as per the [App Bundler Plugin Instructions](#app-bundler-plugin-instructions) below.
+2. Use the [API](#api) to automatically trigger downloads on first use of your gem features.
+
 ### Downloadfile
 
 A gem `Downloadfile` contains `download` links for files that need to be downloaded relative to the gem directory after `bundle install`.
 
+Downloadfile entries follow this format (keyword args are optional):
+
+```
+download url, to: gem_subdirectory, os: os
+```
+
 Example `Downloadfile`:
 
 ```
@@ -48,12 +66,13 @@ The keyword `download` declares a file to download and takes the following argum
 2. `to:` keyword arg: mentions a local download path relative to the gem installation directory (e.g. 'vendor' or 'lib/ai/data'). It automatically creates the path with all its subdirectories if it does not already exist. If left empty, then the file is downloaded to the gem directory root path.
 3. `os:` keyword arg (value: `mac` / `windows` / `linux`): limits the operating system under which the download is made. It is `nil` by default, allowing the download to occur in all operating systems.
 
-## App Instructions
+## App Bundler Plugin Instructions
 
 An app can depend on a gem that has a `Downloadfile` by adding the `bundler-download` plugin first (or manually installing via `bundle plugin install bundler-download`) and then including the gem in `Gemfile` like it normally would:
 
 ```
 plugin 'bundler-download'
+
 gem 'some_gem_with_downloadfile'
 ```
 
@@ -205,6 +224,18 @@ Showing downloaded files for /Users/User/.rvm/gems/ruby-2.7.1@bundler-download/g
 54070695 /Users/User/.rvm/gems/ruby-2.7.1@bundler-download/gems/glimmer-cw-browser-chromium-1.0.0/vendor/jars/mac/com.make.chromium.cef.cocoa.macosx.x86_64_0.4.0.202005172227.jar
 ```
 
+### API
+
+Apps may choose to integrate with the [bundler-download](https://rubygems.org/gems/bundler-download) gem directly to trigger downloads instead of relying on the plugin.
+This can be useful when wanting to trigger downloads only on first use while staying transparent should the gem features not be used.
+
+To do so, simply include this Ruby code to trigger downloads:
+
+```ruby
+require 'bundler-download'
+Bundler::Download.new.exec('download', [])
+```
+
 ## 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.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/bundler-download.gemspec

@@ -1,17 +1,17 @@
-# Generated by jeweler
+# Generated by juwelier
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: bundler-download 1.1.0 ruby lib
+# stub: bundler-download 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "bundler-download".freeze
-  s.version = "1.1.0"
+  s.version = "1.2.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-23"
+  s.date = "2020-09-25"
   s.description = "bundler-download is a Bundler plugin for auto-downloading gem-specified extra files (e.g. large file downloads) on `bundle install` from a `Downloadfile`".freeze
   s.email = "andy.am@gmail.com".freeze
   s.executables = ["bundler-download".freeze]
@@ -46,11 +46,10 @@ Gem::Specification.new do |s|
   if s.respond_to? :add_runtime_dependency then
     s.add_runtime_dependency(%q<bundler>.freeze, [">= 2.0.0", "< 3.0.0"])
     s.add_runtime_dependency(%q<download>.freeze, [">= 1.1.0", "< 2.0.0"])
-    s.add_runtime_dependency(%q<httparty>.freeze, [">= 0.18.1", "< 2.0.0"])
     s.add_runtime_dependency(%q<os>.freeze, [">= 1.1.1", "< 2.0.0"])
     s.add_runtime_dependency(%q<tty-progressbar>.freeze, [">= 0.17.0", "< 2.0.0"])
     s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
-    s.add_development_dependency(%q<jeweler>.freeze, [">= 2.3.5"])
+    s.add_development_dependency(%q<juwelier>.freeze, [">= 2.4.9"])
     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"])
@@ -58,11 +57,10 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<bundler>.freeze, [">= 2.0.0", "< 3.0.0"])
     s.add_dependency(%q<download>.freeze, [">= 1.1.0", "< 2.0.0"])
-    s.add_dependency(%q<httparty>.freeze, [">= 0.18.1", "< 2.0.0"])
     s.add_dependency(%q<os>.freeze, [">= 1.1.1", "< 2.0.0"])
     s.add_dependency(%q<tty-progressbar>.freeze, [">= 0.17.0", "< 2.0.0"])
     s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
-    s.add_dependency(%q<jeweler>.freeze, [">= 2.3.5"])
+    s.add_dependency(%q<juwelier>.freeze, [">= 2.4.9"])
     s.add_dependency(%q<simplecov>.freeze, [">= 0"])
     s.add_dependency(%q<puts_debuggerer>.freeze, [">= 0"])
     s.add_dependency(%q<pessimize>.freeze, [">= 0"])

data/lib/bundler-download.rb

@@ -20,9 +20,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'bundler'
+require 'bundler/setup'
 require 'download'
 require 'fileutils'
-require 'httparty'
 require 'os'
 require 'tty-progressbar'
 

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

@@ -35,13 +35,27 @@ module Download
       File.delete(file_path) if File.exist?(file_path)      
     end
     
+    def final_uri_and_head_response
+      location = url
+      head_response = nil
+      begin
+        uri = URI(location)
+        options = {}
+        options.merge!(use_ssl: true) if location.start_with?('https:')
+        head_response = Net::HTTP.start(uri.hostname, uri.port, options) do |http|
+          http.head(uri)
+        end
+        location = head_response['location'] if head_response['location']
+      end while head_response.is_a?(Net::HTTPRedirection)      
+      [uri, head_response]
+    end
+    
     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"]
+      uri, head_response = final_uri_and_head_response
+      content_length = head_response["content-length"]
       puts "Download URL: #{uri.to_s}"
       puts "Download size: #{content_length}"
       puts "Download path: #{file_path}"

data/lib/bundler/download.rb

@@ -27,7 +27,9 @@ module Bundler
       begin
         subcommand = extract_subcommand(args) || 'start'
         return puts("Invalid subcommand: #{subcommand} \nValid `bundle download` subcommands are: #{Bundler::Downloadfile::SUBCOMMANDS.join(' / ')}") unless Bundler::Downloadfile::SUBCOMMANDS.include?(subcommand)
-        downloadfiles = Dir.glob(File.join(Gem.dir, 'gems', '**', 'Downloadfile')).to_a
+        downloadfiles = Dir.glob(File.join(Gem.dir, 'gems', '**', 'Downloadfile')).to_a        
+        loaded_gems = Gem.loaded_specs.keys
+        downloadfiles = downloadfiles.select {|df| loaded_gems.detect {|gem| File.basename(File.dirname(df)).include?(gem)} }
         puts 'No gems were found with Downloadfile.' if downloadfiles.empty?
         downloadfiles.each do |downloadfile|
           bundler_downloadfile = Bundler::Downloadfile.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundler-download
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-23 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,26 +50,6 @@ dependencies:
     - - "<"
       - !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
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.18.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
@@ -125,19 +105,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: juwelier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.5
+        version: 2.4.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.5
+        version: 2.4.9
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement