s3repo 2.0.3 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 609adf699a1840ed8e7b5b948ef5ccbc4a5cfbb3
-  data.tar.gz: c245a2f3e192a948a20c7075d8b0cd82c867a548
+SHA256:
+  metadata.gz: 920f623d4624b83bed321ed8a464533e2affe89515df068212dea3038df405a8
+  data.tar.gz: c4563a4c983fdbb3816691f4f8fe9ce841ec1783c047a6338c4be29d9f85c8b3
 SHA512:
-  metadata.gz: 2f7c49211cc10b4b5f42d112e6669014493bcc2714f23948a515821169aa4b638681ff75d9b5ab407b9fe1baf1ca11569c6b27236175012d148b1ee9683b1a3a
-  data.tar.gz: adb460ccb03c7c30aededd9e9b2f84dbd53c9f9c62b24b66f29078bb351d8d2bb9ee92774fc130e600516b765818fb491854da9998ad1d6b3ab717a4a0d28324
+  metadata.gz: 1e4ddea1d15f24c0e24400eba0ee6776baf130f5286fdfca5419f8d7e370602dd13463ada5b1e72996c4322f61661edf8680ec713d6f3abab403a98581b49b0e
+  data.tar.gz: d3bf80e3684abb39c635a7a1850c2bfcd1f6c9b3f4eddb24aa76f413b891f3e5d1791a2561af5f46e45cb57c6b1ba71c3f652b427b2fcb1f734cf8f1a6b31a8d

data/.github/exporter.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+URL="https://exporter.akerl.app/metric"
+AUTH="Authorization: Bearer $EXPORTER_TOKEN"
+if [[ "$JOB_STATUS" == "success" ]] ; then
+    VALUE=1
+else
+    VALUE=0
+fi
+BODY="{\"name\":\"gh/${GITHUB_REPOSITORY}\",\"metrics\":[{\"name\":\"ghactions\",\"type\":\"gauge\",\"tags\":{\"repo\":\"${GITHUB_REPOSITORY}\"},\"value\":\"${VALUE}\"}]}"
+
+echo "$BODY"
+
+curl -i -XPOST -d "$BODY" -H"$AUTH" "$URL"

data/.github/workflows/build.yml

@@ -0,0 +1,37 @@
+---
+name: Build
+'on':
+  push:
+    branches:
+    - main
+    tags:
+    - "**"
+  pull_request_target:
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+      with:
+        submodules: recursive
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+        bundler-cache: true
+    - name: Build
+      run: bundle exec rake
+    - name: Release
+      if: github.ref_type == 'tag'
+      run: bundle exec rake release
+      env:
+        GEM_HOST_API_KEY: "${{ secrets.GEM_HOST_API_KEY }}"
+    - name: Post to hook-exporter
+      run: "./.github/exporter.sh"
+      env:
+        EXPORTER_TOKEN: "${{ secrets.EXPORTER_TOKEN }}"
+        JOB_STATUS: "${{ job.status }}"
+      if: always() && github.ref == 'refs/heads/main'

data/.rubocop.yml

@@ -1,5 +1,2 @@
 inherit_gem:
   goodcop: .rubocop.yml
-AllCops:
-  Include:
-  - 'bin/*'

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 3.0.1 / 2023-08-24
+
+* [BUGFIX] Fix linter errors
+
+# 3.0.0 / 2023-08-24
+
+* [FEATURE] Support multiple build targets
+
+# 2.0.3 / 2017-10-08
+
+* [DEPRECATION] The features for directly serving files have been removed
+* [FEATURE] Added templating support for managing ancillary files like index.html
+* [FEATURE] Use YAML config file instead of env variables for configuration
+* [ENHANCEMENT] Handle signing directly rather than counting on makepkg
+
 # 1.0.0 / 2016-01-23
 
 * [ENHANCEMENT] Stabilized API

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Les Aker
+Copyright (c) 2023 Les Aker
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,28 +2,33 @@ 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)
-[![Build Status](https://img.shields.io/circleci/project/amylum/s3repo/master.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)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/amylum/s3repo/build.yml?branch=main)](https://github.com/amylum/s3repo/actions)
 [![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
+The canonical usage of this tool is by [my personal repo](https://github.com/amylum/repo/blob/master/Makefile), which uses s3repo.
 
-This tool provides an `s3repo` script that can be used to manage an S3 bucket with packages. It is configured via environment variable:
+### Config file
 
-* 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
+The config file is used to provide information about the repo:
+
+```
+repo_name: # this is used to name the metadata DB file for the repo
+bucket: # where to upload the files
+region: # what AWS region the bucket is in
+makepkg_flags: # any flags to pass to makepkg
+key: # GPG key ID to use for signing, assuming that signing is enabled
+sign_db: # true/false to control signing
+sign_packages: # true/false to control signing
+template_dir: # where to find repo templates
+template_params: # a key-value store of details to use in the templates
+  example_key: example_value
+```
+
+### Managing the repo
 
 #### Build a package
 
@@ -57,20 +62,6 @@ 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

@@ -76,3 +76,4 @@ Mercenary.program(:s3repo) do |p|
     exit 1
   end
 end
+# rubocop:enable Metrics/BlockLength

data/lib/s3repo/base.rb

@@ -16,6 +16,10 @@ module S3Repo
       raise "Failed running #{cmd}:\n#{results}"
     end
 
+    def targets
+      @targets ||= @options[:targets] || ['x86_64']
+    end
+
     def bucket
       @options[:bucket] || raise('No bucket given')
     end

data/lib/s3repo/cache.rb

@@ -7,7 +7,7 @@ module S3Repo
   # Cache object, stores S3 objects on disk
   class Cache < Base
     TMPDIRS = [
-      ENV['TMPDIR'],
+      ENV.fetch('TMPDIR', nil),
       Dir.tmpdir,
       '/tmp/s3repo'
     ].freeze
@@ -41,8 +41,7 @@ module S3Repo
       FileUtils.mkdir_p File.dirname(path)
       object = atomic_get_object(key, path)
       etags[key] = object.etag
-    rescue Aws::S3::Errors::NotModified
-      return
+    rescue Aws::S3::Errors::NotModified # rubocop:disable Lint/SuppressedException
     end
 
     def atomic_get_object(key, path)

data/lib/s3repo/client.rb

@@ -19,7 +19,7 @@ module S3Repo
     end
 
     def upload_file(key, path)
-      upload(key, File.open(path).read)
+      upload(key, File.read(path))
     end
 
     private

data/lib/s3repo/metadata.rb

@@ -42,12 +42,12 @@ module S3Repo
 
     def db_names
       @db_names ||= ['repo', repo_name].flat_map do |x|
-        [x + '.db.tar.xz', x + '.db']
+        ["#{x}.db.tar.xz", "#{x}.db"]
       end
     end
 
     def sig_names
-      @sig_names ||= db_names.map { |x| x + '.sig' }
+      @sig_names ||= db_names.map { |x| "#{x}.sig" }
     end
 
     def signer

data/lib/s3repo/repo.rb

@@ -9,7 +9,11 @@ module S3Repo
       paths.each do |path|
         dir = File.dirname(path)
         puts "Building #{File.basename(dir)}"
-        Dir.chdir(dir) { run "makepkg #{@options[:makepkg_flags]}" }
+        Dir.chdir(dir) do
+          targets.each do |x|
+            run "CARCH='#{x}' makepkg #{@options[:makepkg_flags]}"
+          end
+        end
       end
     end
 
@@ -51,7 +55,7 @@ module S3Repo
       key = File.basename(path)
       return false if include? key
       sig_path = signer.sign(path)
-      sig_key = key + '.sig'
+      sig_key = "#{key}.sig"
       client.upload_file(sig_key, sig_path) if @options[:sign_packages]
       client.upload_file(key, path)
       true

data/lib/s3repo/signer.rb

@@ -3,7 +3,7 @@ module S3Repo
   # Signer object, signs files w/ GPG
   class Signer < Base
     def sign(path)
-      sig_path = path + '.sig'
+      sig_path = "#{path}.sig"
       run "gpg --detach-sign --local-user '#{key}' #{path}"
       sig_path
     end

data/lib/s3repo/templates.rb

@@ -25,12 +25,12 @@ module S3Repo
 
     def templates
       @templates ||= template_files.map do |x|
-        [File.basename(x), ERB.new(File.read(x), nil, '-')]
+        [File.basename(x), ERB.new(File.read(x), trim_mode: '-')]
       end
     end
 
     def template_files
-      @template_files ||= Dir.glob(template_path + '/*')
+      @template_files ||= Dir.glob("#{template_path}/*")
     end
 
     def template_path

data/lib/s3repo/version.rb

@@ -3,5 +3,5 @@
 ##
 # Define version
 module S3Repo
-  VERSION = '2.0.3'.freeze
+  VERSION = '3.0.1'
 end

data/s3repo.gemspec

@@ -1,11 +1,12 @@
 require 'English'
-$LOAD_PATH.unshift File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 's3repo/version'
 
 Gem::Specification.new do |s|
   s.name        = 's3repo'
   s.version     = S3Repo::VERSION
-  s.date        = Time.now.strftime('%Y-%m-%d')
+
+  s.required_ruby_version = '>= 3.0'
 
   s.summary     = 'S3 Archlinux repo library'
   s.description = 'Simple library for interacting with Archlinux repos in S3'
@@ -15,21 +16,13 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
 
   s.files       = `git ls-files`.split
-  s.test_files  = `git ls-files spec/*`.split
   s.executables = ['s3repo']
 
-  s.add_dependency 'mercenary', '~> 0.3.4'
-  s.add_dependency 'aws-sdk', '~> 3.0.0'
+  s.add_dependency 'aws-sdk', '~> 3.1.0'
   s.add_dependency 'basiccache', '~> 1.0.0'
-  s.add_dependency 'cymbal', '~> 1.0.0'
+  s.add_dependency 'cymbal', '~> 2.0.0'
+  s.add_dependency 'mercenary', '~> 0.4.0'
 
-  s.add_development_dependency 'rubocop', '~> 0.50.0'
-  s.add_development_dependency 'goodcop', '~> 0.1.0'
-  s.add_development_dependency 'rake', '~> 12.1.0'
-  s.add_development_dependency 'codecov', '~> 0.1.1'
-  s.add_development_dependency 'rspec', '~> 3.6.0'
-  s.add_development_dependency 'fuubar', '~> 2.2.0'
-  s.add_development_dependency 'webmock', '~> 3.1.0'
-  s.add_development_dependency 'vcr', '~> 3.0.0'
-  s.add_development_dependency 'climate_control', '~> 0.2.0'
+  s.add_development_dependency 'goodcop', '~> 0.9.7'
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/spec/spec_helper.rb

@@ -1,36 +1,2 @@
-if ENV['CI'] == 'true'
-  require 'simplecov'
-  require 'codecov'
-  SimpleCov.formatter = SimpleCov::Formatter::Codecov
-  SimpleCov.start do
-    add_filter '/spec/'
-  end
-end
-
 require 'rspec'
 require 's3repo'
-
-require 'webmock'
-WebMock.enable!
-
-require 'vcr'
-VCR.configure do |c|
-  c.cassette_library_dir = 'spec/fixtures/cassettes'
-  c.hook_into :webmock
-  c.configure_rspec_metadata!
-  c.before_record do |i|
-    i.request.headers.delete 'Authorization'
-  end
-end
-
-require 'climate_control'
-AUTH_OPTS = {
-  S3_BUCKET: 'amylum',
-  AWS_REGION: 'us-east-1',
-  AWS_SECRET_ACCESS_KEY: 'accesskey',
-  AWS_ACCESS_KEY_ID: 'sekritkey'
-}.freeze
-def with_auth(&block)
-  opts = AUTH_OPTS.dup.map { |k, v| [k, ENV.fetch("REAL_#{k}", v)] }
-  ClimateControl.modify(Hash[opts], &block)
-end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: s3repo
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.0.1
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-08 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: mercenary
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: basiccache
   requirement: !ruby/object:Gem::Requirement
@@ -58,140 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: mercenary
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
-  type: :development
+        version: 0.4.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: goodcop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.9.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 12.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 12.1.0
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.6.0
-- !ruby/object:Gem::Dependency
-  name: fuubar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: climate_control
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.9.7
 description: Simple library for interacting with Archlinux repos in S3
 email: me@lesaker.org
 executables:
@@ -199,9 +87,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circle-ruby"
+- ".github/exporter.sh"
+- ".github/workflows/build.yml"
 - ".gitignore"
-- ".prospectus"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -210,7 +98,6 @@ files:
 - README.md
 - Rakefile
 - bin/s3repo
-- circle.yml
 - lib/s3repo.rb
 - lib/s3repo/base.rb
 - lib/s3repo/cache.rb
@@ -226,7 +113,8 @@ files:
 homepage: https://github.com/amylum/s3repo
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -235,18 +123,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: S3 Archlinux repo library
-test_files:
-- spec/s3repo_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.circle-ruby

@@ -1,3 +0,0 @@
-2.4.2
-2.3.5
-2.2.8

data/.prospectus

@@ -1,25 +0,0 @@
-Prospectus.extra_dep('file', 'prospectus_circleci')
-
-my_slug = 'amylum/s3repo'
-
-item do
-  noop
-
-  deps do
-    item do
-      name 'gems'
-
-      expected do
-        static
-        set 'green'
-      end
-
-      actual do
-        gemnasium
-        slug my_slug
-      end
-    end
-  end
-
-  extend ProspectusCircleci::Build.new(my_slug)
-end

data/circle.yml

@@ -1,11 +0,0 @@
-machine:
-  environment:
-    AWS_ACCESS_KEY_ID: '1'
-    AWS_SECRET_ACCESS_KEY: '1'
-dependencies:
-  override:
-  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i gem update --system --no-doc || exit 1 ; done'
-  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle install || exit 1 ; done'
-test:
-  override:
-  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle exec rake || exit 1 ; done'