cartage-s3 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16aa1d98e9a68dba8de3548a4618047e0774861a
+  data.tar.gz: 779253a86e9be288e0ed0ae36bfb438bc74f75f6
+SHA512:
+  metadata.gz: a88299b376895aeff8d1521f48e71eb551f86dfbb0d35bd9954babe25bda0e1433839a6db4bce0995ac653b4618c937ba662b2cbddeb20bcc021bbe3dd60915c
+  data.tar.gz: c5a70b38350fd3db62027d9e11d81793c0485eb76f59a5d156987fbd7d1647315c59ea0dfc57b4fc86997daf9f113f5816bff6c889746cac89e6fec0230eb1e7

data/.autotest

@@ -0,0 +1,27 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+Autotest.add_hook :initialize do |at|
+  # .minitest.rb ensures that the gem version of minitest is used.
+  at.testlib = ".minitest.rb"
+  # at.testlib = "minitest/unit"
+  #
+  # at.extra_files << "../some/external/dependency.rb"
+  #
+  # at.libs << ":../some/external"
+  #
+  # at.add_exception "vendor"
+  #
+  # at.add_mapping(/dependency.rb/) do |f, _|
+  #   at.files_matching(/test_.*rb$/)
+  # end
+  #
+  # %w(TestA TestB).each do |klass|
+  #   at.extra_class_map[klass] = "test/test_misc.rb"
+  # end
+end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/.gemtest

@@ -0,0 +1 @@
+

data/.minitest.rb

@@ -0,0 +1,2 @@
+gem "minitest"
+require "minitest/autorun"

data/Contributing.rdoc

@@ -0,0 +1,63 @@
+== Contributing
+
+We value any contribution to cartage-s3 you can provide: a bug report, a
+feature request, or code contributions.
+
+cartage-s3 has a few contribution guidelines:
+
+* Changes *will* *not* be accepted without tests. The test suite is written
+  with {Minitest}[https://github.com/seattlerb/minitest].
+* Match our coding style.
+* Use a thoughtfully-named topic branch that contains your change. Rebase your
+  commits into logical chunks as necessary.
+* Use {quality commit messages}[http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html].
+* Do not change the version number; when your patch is accepted and a release
+  is made, the version will be updated at that point.
+* Submit a GitHub pull request with your changes.
+
+=== Test Dependencies
+
+cartage-s3 uses Ryan Davis’s {Hoe}[https://github.com/seattlerb/hoe] to manage
+the release process, and it adds a number of rake tasks. You will mostly be
+interested in:
+
+    $ rake
+
+which runs the tests the same way that:
+
+    $ rake test
+    $ rake travis
+
+will do.
+
+To assist with the installation of the development dependencies for cartage-s3,
+I have provided the simplest possible Gemfile pointing to the (generated)
++cartage-s3.gemspec+ file. This will permit you to do:
+
+    $ bundle install
+
+to get the development dependencies. If you aleady have +hoe+ installed, you
+can accomplish the same thing with:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs, and
+generate the RDoc.
+
+=== Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+* Fork the project.
+* Clone down your fork (<tt>git clone git://github.com/KineticCafe/cartage-s3.git</tt>).
+* Create a topic branch to contain your change (<tt>git checkout -b my\_awesome\_feature</tt>).
+* Hack away, add tests. Not necessarily in that order.
+* Make sure everything still passes by running +rake+.
+* If necessary, rebase your commits into logical chunks, without errors.
+* Push the branch up (<tt>git push origin my\_awesome\_feature</tt>).
+* Create a pull request against KineticCafe/cartage-s3 and describe
+  what your change does and the why you think it should be merged.
+
+=== Contributors
+
+* Austin Ziegler created cartage-s3.

data/Gemfile

@@ -0,0 +1,9 @@
+# -*- ruby -*-
+
+# NOTE: This file is not the canonical source of dependencies. Edit the
+# Rakefile, instead.
+
+source "https://rubygems.org/"
+gemspec
+
+# vim: syntax=ruby

data/History.rdoc

@@ -0,0 +1,5 @@
+=== 1.0 / 2015-03-20
+
+*   1 major enhancement
+
+    *   Birthday!

data/Licence.rdoc

@@ -0,0 +1,27 @@
+== Licence
+
+This software is available under an MIT-style licence.
+
+* Copyright 2015 Kinetic Cafe
+
+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 names of its contributors may not be used to endorse or promote
+  products derived from this software without specific prior written
+  permission.
+
+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/Manifest.txt

@@ -0,0 +1,12 @@
+.autotest
+.gemtest
+.minitest.rb
+Contributing.rdoc
+Gemfile
+History.rdoc
+Licence.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/cartage/s3.rb
+lib/cartage/s3/command.rb

data/README.rdoc

@@ -0,0 +1,45 @@
+= cartage-s3 by Kinetic Cafe
+
+code :: https://github.com/KineticCafe/cartage-s3/
+issues :: https://github.com/KineticCafe/cartage-s3/issues
+continuous integration :: {<img src="https://travis-ci.org/KineticCafe/cartage-s3.png" />}[https://travis-ci.org/KineticCafe/cartage-s3]
+
+== Description
+
+cartage-s3 is a plug-in for {cartage}[https://github.com/KineticCafe/cartage]
+to upload the built package to Amazon's S3 or a service with a similar
+interface. Cartage provides a repeatable means to create a package for a Rails
+application that can be used in deployment with a configuration tool like
+Ansible, Chef, Puppet, or Salt. The package is created with its dependencies
+bundled in `vendor/bundle`, so it can be deployed in environments with strict
+access control rules and without requiring development tool access.
+
+== Synopsis
+
+    # Build a package from the current machine, using the Manifest.txt, and
+    # uploads it to AWS S3.
+    cartage s3
+
+== Install
+
+Add cartage-s3 to your Gemfile:
+
+    gem 'cartage-s3', '~> 1.0'
+
+Or manually install:
+
+  % gem install cartage-s3
+
+== cartage-s3 Semantic Versioning
+
+cartage-s3 uses a {Semantic Versioning}[http://semver.org/] scheme with one
+change:
+
+* When PATCH is zero (+0+), it will be omitted from version references.
+
+cartage-s3 will generally track cartage for major versions to ensure plugin API
+compatibility.
+
+:include: Contributing.rdoc
+
+:include: Licence.rdoc

data/Rakefile

@@ -0,0 +1,56 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'pathname'
+
+Hoe.plugin :doofus
+Hoe.plugin :email unless ENV['CI'] or ENV['TRAVIS']
+Hoe.plugin :gemspec2
+Hoe.plugin :git
+Hoe.plugin :minitest
+Hoe.plugin :rubygems
+
+spec = Hoe.spec 'cartage-s3' do
+  developer('Austin Ziegler', 'aziegler@kineticcafe.com')
+
+  self.history_file = 'History.rdoc'
+  self.readme_file = 'README.rdoc'
+  self.extra_rdoc_files = FileList['*.rdoc'].to_a
+
+  license 'MIT'
+
+  self.extra_deps << ['cartage', '~> 1.0']
+  self.extra_deps << ['fog', '~> 1.27']
+
+  self.extra_dev_deps << ['rake', '~> 10.0']
+  self.extra_dev_deps << ['hoe-doofus', '~> 1.0']
+  self.extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
+  self.extra_dev_deps << ['hoe-git', '~> 1.5']
+  self.extra_dev_deps << ['hoe-geminabox', '~> 0.3']
+=begin
+  self.extra_dev_deps << ['minitest', '~> 5.4']
+  self.extra_dev_deps << ['minitest-autotest', '~> 1.0']
+  self.extra_dev_deps << ['minitest-bisect', '~> 1.2']
+  self.extra_dev_deps << ['minitest-focus', '~> 1.1']
+  self.extra_dev_deps << ['minitest-moar', '~> 0.0']
+  self.extra_dev_deps << ['minitest-pretty_diff', '~> 0.1']
+  self.extra_dev_deps << ['simplecov', '~> 0.7']
+=end
+end
+
+=begin
+namespace :test do
+  task :coverage do
+    prelude = <<-EOS
+require 'simplecov'
+SimpleCov.start('test_frameworks') { command_name 'Minitest' }
+gem 'minitest'
+    EOS
+    spec.test_prelude = prelude.split($/).join('; ')
+    Rake::Task['test'].execute
+  end
+end
+=end
+
+# vim: syntax=ruby

data/lib/cartage/s3.rb

@@ -0,0 +1,151 @@
+begin
+  require 'psych'
+rescue LoadError
+end
+require 'yaml'
+require 'erb'
+require 'cartage/plugin'
+
+class Cartage
+  # Upload the target package to S3.
+  #
+  # == Configuration
+  # Cartage::S3 is configured in the +plugins.s3+ section of the Cartage
+  # configuration file, and supports the following keys:
+  #
+  # +path+:: The path name or bucket name where the targets will be uploaded.
+  #          The <tt>--path</tt> option will override a config-provided path
+  #          setting.
+  # +credentials+:: A dictionary which, if present, will be used to initialize
+  #                 a Fog::Storage object. If +credentials+ is set in a
+  #                 configuration file, the command-line parameters
+  #                 <tt>--key-id</tt>, <tt>--secret-key</tt>, and
+  #                 <tt>--region</tt> will be ignored.
+  #
+  # For AWS in us-west-2, this configuration would look like this:
+  #
+  #   ---
+  #   plugins:
+  #     s3:
+  #       path: PATHNAME
+  #       credentials:
+  #         provider: AWS
+  #         aws_access_key_id: YOUR_AWS_ACCESS_KEY_ID
+  #         aws_secret_access_key: YOUR_AWS_SECRET_ACCESS_KEY
+  #         region: us-west-2
+  #
+  # For Rackspace CloudFiles London, it would be:
+  #
+  #   ---
+  #   plugins:
+  #     s3:
+  #       path: PATHNAME
+  #       credentials:
+  #         provider: Rackspace
+  #         rackspace_username: RACKSPACE_USERNAME
+  #         rackspace_api_key: RACKSPACE_API_KEY
+  #         rackspace_auth_url: lon.auth.api.rackspacecloud.com
+  #
+  # For Google Cloud Storage, it would be:
+  #
+  #   ---
+  #   plugins:
+  #     s3:
+  #       path: PATHNAME
+  #       credentials:
+  #         provider: Google
+  #         google_storage_access_key_id: YOUR_SECRET_ACCESS_KEY_ID
+  #         google_storage_secret_access_key: YOUR_SECRET_ACCESS_KEY
+  #
+  # If Cartage#environment has been set, that value will be used to select
+  # partitioned configuration values.
+  #
+  #   ---
+  #   development:
+  #     plugins:
+  #       s3:
+  #         path: PATHNAME
+  #         credentials:
+  #           provider: AWS
+  #           aws_access_key_id: YOUR_AWS_ACCESS_KEY_ID
+  #           aws_secret_access_key: YOUR_AWS_SECRET_ACCESS_KEY
+  #           region: us-west-2
+  #
+  # === Cloud Storage Security Considerations
+  #
+  # cartage-s3 does not create the target path and expects to place both
+  # files in the same directory. The only thing that is required from the
+  # access user is that it may put a file directly into the bucket/path. The
+  # files in question are timestamped UTC, so there is little chance for
+  # collision.
+  class S3 < Cartage::Plugin
+    VERSION = '1.0' #:nodoc:
+
+    # The AWS S3 path (bucket) to use for uploading the cartage package.
+    attr_accessor :path
+    # The AWS S3 Access Key ID. If a +credentials+ section is not present in
+    # the configuration file and this is not provided, this will be pulled from
+    # <tt>$AWS_ACCESS_KEY_ID</tt>.
+    attr_accessor :aws_access_key_id
+    # The AWS S3 Secret Access Key. If a +credentials+ section is not present
+    # in the configuration file and this is not provided, this will be pulled
+    # from <tt>$AWS_SECRET_ACCESS_KEY</tt>.
+    attr_accessor :aws_secret_access_key
+    # The AWS S3 Region name.
+    attr_accessor :region
+
+    # Perform the upload.
+    def upload
+      require 'fog'
+
+      connection = Fog::Storage.new(@access)
+
+      @cartage.display "Uploading #{@cartage.final_release_hashref.basename}..."
+      connection.put_object(@target, @cartage.final_release_hashref.basename.to_s,
+                            @cartage.final_release_hashref.read)
+      @cartage.display "Uploading #{@cartage.final_tarball.basename}..."
+      connection.put_object(@target, @cartage.final_tarball.basename.to_s,
+                            @cartage.final_tarball.read)
+    end
+
+    private
+
+    def resolve_config!(s3_config)
+      @target = s3_config && s3_config.path
+
+      @access = if s3_config && s3_config.credentials
+                  s3_config.credentials.to_h
+                else
+                  {
+                    provider:              'AWS',
+                    aws_access_key_id:     value_for!(:aws_access_key_id),
+                    aws_secret_access_key: value_for!(:aws_secret_access_key),
+                    region:                region
+                  }
+                end
+
+      provider = @access[:provider]
+      raise ArgumentError, <<-exception if provider.nil? or provider.empty?
+Cannot upload: no provider set.
+      exception
+
+      @target = path || @target
+      raise ArgumentError, <<-exception if @target.nil? or @target.empty?
+Cannot upload to #{provider}: path is not set.
+      exception
+    end
+
+    def value_for!(name)
+      (send(name) || ENV[name.to_s.upcase]).tap do |value|
+        raise ArgumentError, <<-exception if value.nil? or value.empty?
+Cannot upload: AWS S3 requires #{name.to_s.upcase} be provided.
+        exception
+      end
+    end
+
+    def self.commands
+      require_relative 's3/command'
+      [ Cartage::S3::Command ]
+    end
+  end
+end

data/lib/cartage/s3/command.rb

@@ -0,0 +1,43 @@
+require 'cartage/command'
+
+class Cartage::S3::Command < Cartage::Command #:nodoc:
+  def initialize(cartage)
+    super(cartage, 's3')
+    takes_commands(false)
+    short_desc('Build a release package and upload to cloud storage.')
+
+    @cartage = cartage
+    @s3 = cartage.s3
+
+    Cartage.common_build_options(options, cartage)
+
+    options do |opts|
+      opts.separator "Cartage S3 Options"
+      opts.on(
+        '-P', '--path PATH',
+        'The bucket or path where the release package will be uploaded to.'
+      ) { |b| @s3.path = b }
+      opts.on(
+        '-K', '--key-id AWS_ACCESS_KEY_ID',
+        'The AWS S3 access key ID.'
+      ) { |k| @s3.aws_access_key_id = k }
+      opts.on(
+        '-S', '--secret-key AWS_SECRET_ACCESS_KEY',
+        'The AWS S3 secret access key.'
+      ) { |s| @s3.aws_secret_access_key = s }
+      opts.on(
+        '-R', '--region REGION',
+        'The AWS S3 region for uploading.'
+      ) { |r| @s3.region = r }
+    end
+  end
+
+  def perform(*)
+    @cartage.pack
+    @s3.upload
+  end
+
+  def with_plugins
+    %w(s3)
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: cartage-s3
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Austin Ziegler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cartage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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: hoe-doofus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: hoe-git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: hoe-geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: |-
+  cartage-s3 is a plug-in for {cartage}[https://github.com/KineticCafe/cartage]
+  to upload the built package to Amazon's S3 or a service with a similar
+  interface. Cartage provides a repeatable means to create a package for a Rails
+  application that can be used in deployment with a configuration tool like
+  Ansible, Chef, Puppet, or Salt. The package is created with its dependencies
+  bundled in `vendor/bundle`, so it can be deployed in environments with strict
+  access control rules and without requiring development tool access.
+email:
+- aziegler@kineticcafe.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- Contributing.rdoc
+- History.rdoc
+- Licence.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- ".autotest"
+- ".gemtest"
+- ".minitest.rb"
+- Contributing.rdoc
+- Gemfile
+- History.rdoc
+- Licence.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/cartage/s3.rb
+- lib/cartage/s3/command.rb
+homepage: https://github.com/KineticCafe/cartage-s3/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.rdoc
+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.2.2
+signing_key: 
+specification_version: 4
+summary: cartage-s3 is a plug-in for {cartage}[https://github.com/KineticCafe/cartage]
+  to upload the built package to Amazon's S3 or a service with a similar interface
+test_files: []