s3repo 0.3.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fde82742c63e068eb1d6b32e8c04c86093ff3d0
-  data.tar.gz: 632901109c6ab3c99b26e9cc471570c494108660
+  metadata.gz: 037f096771d38b162f01efabbd4f21a3d38d2e54
+  data.tar.gz: 2639022f0ac61664ed66c9bdd49b28e8b3dc4d13
 SHA512:
-  metadata.gz: 20908e3c9ad2f565e2bb742a5a92770c88eb6523f58ca454bfeadee206a1859554acb46f2fcabb55793ace1a929503bbca90f26d749cf655a233920ec9fc8e30
-  data.tar.gz: d21812cac7e684eab6f9e4dff2a221267f5391353be85491c265f7cebd8048694e33daea75b590e8fc5ef20dfa496e3e559518b12b33fb089a1dc4a3ed36e882
+  metadata.gz: 40e4eba132b5c8374a4c5da86dc5043aca1700daf69c616ee91f018bd214e010cf64bda56b0c1187388252ffc21d95e328be2b68daf1f10d0fdf0d940c2f6978
+  data.tar.gz: d09e26179074b0c678e798bc814b1a2e4277bea5738d914c7af0c64c306896f4da46423dc03ec2b8af3f0917d432f707f8e8d38614598d50c7fe2dddc6cd7067

data/.prospectus

@@ -0,0 +1,11 @@
+item do
+  expected do
+    static
+    set 'green'
+  end
+
+  actual do
+    gemnasium
+    slug 'amylum/server'
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 1.0.0 / 2016-01-23
+
+* [ENHANCEMENT] Stabilized API
+

data/README.md

@@ -3,15 +3,74 @@ s3repo
 
 [![Gem Version](https://img.shields.io/gem/v/s3repo.svg)](https://rubygems.org/gems/s3repo)
 [![Dependency Status](https://img.shields.io/gemnasium/amylum/s3repo.svg)](https://gemnasium.com/amylum/s3repo)
-[![Code Climate](https://img.shields.io/codeclimate/github/amylum/s3repo.svg)](https://codeclimate.com/github/amylum/s3repo)
-[![Coverage Status](https://img.shields.io/coveralls/amylum/s3repo.svg)](https://coveralls.io/r/amylum/s3repo)
-[![Build Status](https://img.shields.io/travis/amylum/s3repo.svg)](https://travis-ci.org/amylum/s3repo)
+[![Build Status](https://img.shields.io/circleci/project/amylum/s3repo.svg)](https://circleci.com/gh/amylum/s3repo)
+[![Coverage Status](https://img.shields.io/codecov/c/github/amylum/s3repo.svg)](https://codecov.io/github/amylum/s3repo)
+[![Code Quality](https://img.shields.io/codacy/eef971ff937642219c1d4094001c33e7.svg)](https://www.codacy.com/app/akerl/s3repo)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
 
 Simple library for interacting with an Archlinux repo stored in S3
 
 ## Usage
 
+### From the command line
+
+This tool provides an `s3repo` script that can be used to manage an S3 bucket with packages. It is configured via environment variable:
+
+* AWS_ACCESS_KEY_ID -- Used by the AWS API library to authenticate for the S3 bucket
+* AWS_SECRET_ACCESS_KEY -- Used by the AWS API library to authenticate for the S3 bucket
+* AWS_REGION -- Used by the AWS API library to know which region to use for the bucket
+* S3_BUCKET -- Controls which S3 bucket is used for packages
+* MAKEPKG_FLAGS -- Flags used for makepkg calls when building packages
+* S3REPO_TMPDIR -- Sets the temp path for local cache of metadata files. Optional, otherwise looks up a path from the system
+* S3REPO_SIGN_DB -- Set to sign the DB metadata
+* S3REPO_SIGN_PACKAGES -- Set to sign the packages
+
+#### Build a package
+
+This assumes you're in the parent directory of your package's directory, which should contain its PKGBUILD and any other files it needs. It's essentially a wrapper around makepkg.
+
+```
+s3repo build bash
+```
+
+#### Upload a package
+
+This takes an already built package and uploads its .pkg.tar.xz (and optionally .pkg.tar.xz.sig) to S3.
+
+```
+s3repo upload bash
+```
+
+#### Remove a package
+
+This removes a named package from the repo metdata (it doesn't remove the actual package files, which you can do after this using prune).
+
+```
+s3repo remove bash-amylum-4.3p42_2-1-x86_64
+```
+
+#### Prune packages
+
+This removes any files from S3 that aren't referenced in the metadata DB.
+
+```
+s3repo prune
+```
+
+### From Ruby code
+
+I use this primarily for serving the packages using [amylum/server](https://github.com/amylum/server). Like the command line tool, it expects AWS API credentials via environment variables, but you can pass in the bucket using either environmnt or a parameter when creating your S3Repo object:
+
+```
+repo = S3Repo.new(bucket: 'my_bucket')
+```
+
+You can call build_packages, add_packages, remove_packages, and prune_files on this, which work almost exactly as their command line counterparts above.
+
+The library also offers `.packages` and `.signatures`, which return arrays of packages and signatures in the bucket. You can use `.include? 'package_name'` to check for a package.
+
+To get the contents of a file, call `.serve 'package_name'`.
+
 ## Installation
 
     gem install s3repo

data/bin/s3repo

@@ -41,10 +41,10 @@ Mercenary.program(:s3repo) do |p|
 
   p.command(:prune) do |c|
     c.syntax 'prune'
-    c.description 'Prune package tarballa from the repo'
+    c.description 'Prune orphaned files from the repo'
 
     c.action do
-      S3Repo.new.prune_packages
+      S3Repo.new.prune_files
     end
   end
 

data/circle.yml

@@ -0,0 +1,8 @@
+dependencies:
+  override:
+    - 'rvm-exec 2.1.6 bundle install'
+    - 'rvm-exec 2.2.2 bundle install'
+test:
+  override:
+    - 'rvm-exec 2.1.6 bundle exec rake'
+    - 'rvm-exec 2.2.2 bundle exec rake'

data/lib/s3repo/cache.rb

@@ -6,7 +6,12 @@ module S3Repo
   ##
   # Cache object, stores S3 objects on disk
   class Cache < Base
-    TMPDIRS = [ENV['S3REPO_TMPDIR'], ENV['TMPDIR'], Dir.tmpdir, '/tmp/s3repo']
+    TMPDIRS = [
+      ENV['S3REPO_TMPDIR'],
+      ENV['TMPDIR'],
+      Dir.tmpdir,
+      '/tmp/s3repo'
+    ].freeze
 
     def initialize(params = {})
       super
@@ -14,7 +19,7 @@ module S3Repo
     end
 
     def serve(key, refresh = true)
-      File.open(download(key, refresh)) { |fh| fh.read }
+      File.open(download(key, refresh), &:read)
     rescue Aws::S3::Errors::NoSuchKey
       nil
     end

data/lib/s3repo/client.rb

@@ -15,7 +15,7 @@ module S3Repo
 
     def upload!(key, path)
       puts "Uploading #{key}"
-      put_object key: key, body: File.open(path) { |fh| fh.read }
+      put_object key: key, body: File.open(path), &:read
     end
 
     private

data/lib/s3repo/repo.rb

@@ -26,17 +26,21 @@ module S3Repo
       metadata.remove_packages(packages)
     end
 
-    def prune_packages
+    def prune_files
       if orphans.empty?
-        puts 'No orphaned packages'
+        puts 'No orphaned files'
         return
       end
-      puts "Pruning packages: #{orphans.join(', ')}"
+      puts "Pruning files: #{orphans.join(', ')}"
       client.delete_objects(delete: { objects: orphans.map { |x| { key: x } } })
     end
 
     def packages
-      package_cache.cache { parse_packages }
+      package_cache.cache { parse_objects(/.*\.pkg\.tar\.xz$/) }
+    end
+
+    def signatures
+      parse_objects(/.*\.pkg\.tar\.xz\.sig$/)
     end
 
     def include?(key)
@@ -60,7 +64,7 @@ module S3Repo
     end
 
     def orphans
-      packages.map(&:key).reject do |x|
+      (packages + signatures).map(&:key).reject do |x|
         metadata.packages.include? x.reverse.split('-', 2).last.reverse
       end
     end
@@ -73,10 +77,8 @@ module S3Repo
       @package_cache ||= BasicCache::TimeCache.new lifetime: 60
     end
 
-    def parse_packages
-      client.list_objects(bucket: bucket).contents.select do |x|
-        x.key.match(/.*\.pkg\.tar\.xz$/)
-      end
+    def parse_objects(regex)
+      client.list_objects(bucket: bucket).contents.select { |x| x.key =~ regex }
     end
   end
 end

data/lib/s3repo/version.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 ##
 # Define version
 module S3Repo
-  VERSION = '0.3.4'
+  VERSION = '1.0.0'.freeze
 end

data/s3repo.gemspec

@@ -18,12 +18,15 @@ Gem::Specification.new do |s|
   s.executables = ['s3repo']
 
   s.add_dependency 'mercenary', '~> 0.3.4'
-  s.add_dependency 'aws-sdk', '~> 2.0.0'
+  s.add_dependency 'aws-sdk', '~> 2.2.0'
   s.add_dependency 'basiccache', '~> 1.0.0'
 
-  s.add_development_dependency 'rubocop', '~> 0.30.0'
-  s.add_development_dependency 'rake', '~> 10.4.0'
-  s.add_development_dependency 'coveralls', '~> 0.8.0'
-  s.add_development_dependency 'rspec', '~> 3.2.0'
+  s.add_development_dependency 'rubocop', '~> 0.36.0'
+  s.add_development_dependency 'rake', '~> 10.5.0'
+  s.add_development_dependency 'codecov', '~> 0.1.1'
+  s.add_development_dependency 'rspec', '~> 3.4.0'
   s.add_development_dependency 'fuubar', '~> 2.0.0'
+  s.add_development_dependency 'webmock', '~> 1.22.0'
+  s.add_development_dependency 'vcr', '~> 3.0.0'
+  s.add_development_dependency 'climate_control', '~> 0.0.3'
 end