bundler-source-aws-s3 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4d5919d913b511b4bd0cc2bbc5cb08bed308eb5ccc10d8790d094c107eb88e1
+  data.tar.gz: 120ca809b0c776de957420b09c6ce851d3cd1b02f67ab0fd66c0ca8f122c9c81
+SHA512:
+  metadata.gz: 458a8571991308cc317c652a6aabeebf37eaaa58572ee2e6829135dd369ca653419fb6138574258cdf9da47f272996750c714d8301915a68c625ef421a044b5a
+  data.tar.gz: ff95b41d255ce9e9a8e691c0778f15e2b32c5bda6daa6829ab5bdaf47f1159e4753cd8f2956233ab329d687ad0ab6f5cc2dbc297bc1ca96248a89a72bdf1de9a

data/README.md

@@ -0,0 +1,87 @@
+# Bundler-Source-Aws-S3
+
+This is a bundler plugin which adds support for s3 as a source for gems.
+
+## Installation
+
+### Setup the aws cli
+
+There are multiple ways to [install the aws
+cli](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)
+(including [homebrew](https://formulae.brew.sh/formula/awscli)). This plugin
+will use the aws cli to pull gems from your s3 source. There is an expectation
+that if you want to use s3 as a gem source, you'll probably already have this
+installed.
+
+### Setup s3 as a gem source
+
+First, you should already have gems in s3 and you should be able to install
+them with Rubygems. Follow the [guide for using s3 as a gem
+source](https://guides.rubygems.org/using-s3-source/).
+
+For this plugin to work the aws cli should be able to fetch your gems. The
+plugin will run a command like `aws s3 sync s3://your-source <local path>` and
+you may want to verify that you have aws cli setup correctly (permissions,
+etc) to be able to run that command.
+
+### Add aws-s3 source to your Gemfile
+
+In your Gemfile, add a source like this:
+
+```ruby
+source('s3://my-bucket/gems', type: 'aws-s3') do
+  gem 'my-cool-gem'
+end
+```
+
+When Bundler sees the `type: 'aws-s3'` it will automatically install and use
+this plugin to install gems from your s3 source.
+
+## Development
+
+We don't have a very good development story (there are no tests, yay!). You'll
+want to fork this repository and use your own fork by adding this to a
+`Gemfile` that you plan to use to test your fork:
+
+```ruby
+plugin 'bundler-source-aws-s3', git: 'https://github.com/<you>/bundler-source-aws-s3.git'
+```
+
+You may also want to wipe a few directories out as you test:
+
+```
+rm -rf ./.bundle/plugin
+rm -rf ~/.bundle/bundler-source-aws-s3
+```
+
+You may also want to wipe out the `install_path` for the s3 uri you're testing
+against. You can find that in irb by instantiating your plugin like:
+
+```ruby
+>> BundlerSourceAwsS3::S3Source.new(uri: 's3://vying-gems').send(:install_path)
+```
+
+Although this will only work if you're running irb in a directory with a
+Gemfile and a `.bundle/` directory. These can be empty as of this writing.
+
+It can also help to poke at the plugin in irb:
+
+```
+irb -I . -r bundler -r plugins.rb
+```
+
+## Other s3 source plugins
+
+As of this writing there is another gem called
+[bundler-source-s3](https://rubygems.org/gems/bundler-source-s3) that doesn't
+work and you probably don't want to confuse with this gem. If you use type 's3'
+(instead of 'aws-s3') in your Gemfile you'll get that plugin, not this one.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/eki/bundler-source-aws-s3.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/plugins.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'open3'
+require 'rubygems/package'
+
+class BundlerSourceAwsS3 < Bundler::Plugin::API
+  class S3Source < Bundler::Source
+    # Bundler plugin api, we need to install the gem for the given spec and
+    # then call post_install.
+    def install(spec, opts)
+      print_using_message "Using #{spec.name} #{spec.version} from #{self}"
+
+      validate!(spec)
+
+      package = package_for(spec)
+      destination = install_path.join(spec.full_name)
+
+      Bundler.mkdir_p(destination)
+      package.extract_files(destination)
+      File.open(spec.loaded_from, 'wb') { |f| f.write spec.to_ruby }
+
+      post_install(spec)
+    end
+
+    # Bundler plugin api, we need to return a Bundler::Index
+    def specs
+      # Only pull gems if bundler tells us to check remote
+      pull if remote?
+
+      # We haven't pulled any s3 gems if the directory doesn't exist, so we'll
+      # give bundler an empty index.
+      return Bundler::Index.new unless File.directory?(s3_gems_path)
+
+      Bundler::Index.build do |index|
+        packages.map(&:spec).each do |spec|
+          spec.source = self
+          spec.loaded_from = loaded_from_for(spec)
+
+          Bundler.rubygems.validate(spec)
+          index << spec
+        end
+      end
+    end
+
+    # Bundler calls this to tell us fetching remote gems is okay.
+    def remote!
+      @remote = true
+    end
+
+    def remote?
+      @remote
+    end
+
+    # TODO What is bundler telling us if unlock! is called?
+    def unlock!
+      puts "[aws-s3] DEBUG: unlock! called"
+    end
+
+    # TODO What is bundler telling us if cached! is called?
+    def cached!
+      puts "[aws-s3] DEBUG: cached! called"
+    end
+
+    def to_s
+      "aws-s3 plugin with uri #{uri}"
+    end
+
+    private
+
+    # This is a guard against attempting to install a spec that doesn't match
+    # our requirements / expectations.
+    #
+    # If we want to be more trusting, we could probably safely remove this
+    # method.
+    def validate!(spec)
+      unless spec.source == self && spec.loaded_from == loaded_from_for(spec)
+        raise "[aws-s3] Error #{spec.full_name} spec is not valid"
+      end
+    end
+
+    # We will use this value as the given spec's loaded_from. It should be the
+    # path fo the installed gem's gemspec.
+    def loaded_from_for(spec)
+      destination = install_path.join(spec.full_name)
+      destination.join("#{spec.full_name}.gemspec").to_s
+    end
+
+    # This path is going to be under bundler's gem_install_dir and we'll then
+    # mirror the bucket/path directory structure from the source. This is where
+    # we want to place our gems. This directory can hold multiple installed
+    # gems.
+    def install_path
+      @install_path ||= gem_install_dir.join(bucket).join(path)
+    end
+
+    # This is the path to the s3 gems for our source uri. We will pull the s3
+    # gems into this directory.
+    def s3_gems_path
+      Bundler.user_bundle_path.
+        join('bundler-source-aws-s3').join(bucket).join(path)
+    end
+
+    # Pull s3 gems from the source and store them in
+    # .bundle/bundler-source-aws-s3/<bucket>/<path>. We will install, etc, from
+    # this directory.
+    def pull
+      # We only want to pull once in a single bundler run.
+      return @pull if defined?(@pull)
+
+      Bundler.mkdir_p(s3_gems_path)
+
+      output, status = Open3.capture2e(sync_cmd)
+
+      @pull = status.success?
+    end
+
+    # Produces a list of Gem::Package for the s3 gems.
+    def packages
+      @packages ||= Dir.entries(s3_gems_path.join('gems')).
+        map { |entry| s3_gems_path.join('gems').join(entry) }.
+        select { |gem_path| File.file?(gem_path) }.
+        map { |gem_path| Gem::Package.new(gem_path.to_s) }
+    end
+
+    # Find the Gem::Package for a given spec.
+    def package_for(spec)
+      packages.find { |package| package.spec.full_name == spec.full_name }
+    end
+
+    def sync_cmd
+      "aws s3 sync --delete #{uri} #{s3_gems_path}"
+    end
+
+    def bucket
+      URI.parse(uri).normalize.host
+    end
+
+    def path
+      # Remove the leading slash from the path.
+      URI.parse(uri).normalize.path[1..-1]
+    end
+  end
+
+  source 'aws-s3', S3Source
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: bundler-source-aws-s3
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Eric K Idema
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-29 00:00:00.000000000 Z
+dependencies: []
+description: Add aws-s3 source to bundler via plugin.
+email:
+- eki@vying.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- plugins.rb
+homepage: https://github.com/eki/bundler-source-aws-s3
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Add aws-s3 source to bundler via plugin.
+test_files: []