aptly-api 0.9.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 380c5f11e70678a2475099bcd03210ec4181ad123d6094b7bdecc1f636e6b9af
-  data.tar.gz: 810b109dcdae36be88317a858267b3d16b5f80e1fa1b4cff82e09f412e2e1a59
+  metadata.gz: 269fe5487b43c1f890f887f41d64112ed87fe5847b6de5f463be83ff46b3be8b
+  data.tar.gz: 1d15d78cdd86cb01865df47e3fec4f2de85a518e3773ac25d7794673bbb3afce
 SHA512:
-  metadata.gz: 2883165cc34396cbc478fd096f0d1ee4a18b26f799aab81d6fd48fb0d3be79404f00d3b349e4545028549e46ebe21f824d182965469d6307d8a2447008a6f41e
-  data.tar.gz: 036bd6f29fb8cd1eb2f6bfae2a610168d18a42bc573213bee6a073eeda71de284425d32e7cc1e1729eceefdf160f54cd3a91723f5419a9a4e433e9eeca626629
+  metadata.gz: ae1dc863c00addaacbb19586563ab84c60c33254a4b5c7eb0919c51977171812c5f1fc7d785dbb8a96d8877c3cf79e32a262d42b9b6a252a12ff7c10385843b4
+  data.tar.gz: acfb847b12356161c604e18a6bc69c38a34b408e6341eb4f334641474342803bbca8719e7e5fa3f18ff1cfebd73ef507ba68b493f6344a1d31d3cd867c51202d

data/.travis.yml

@@ -1,9 +1,6 @@
 language: ruby
+before_install: gem update bundler
 rvm:
-  - 2.2.1
-  - 2.3.0
-  - 2.4.0
   - 2.5.0
-before_install:
-  - gem update --system
-  - gem install bundler -v 1.10.6
+  - 2.6.0
+  - 2.7.0

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Change Log
 
+## [0.11]
+
+### Added
+
+- Faraday 2 support
+- Ruby 3 support
+
+## [0.10.1]
+### Fixed
+- Publishing endpoint escaping no longer creates invalid URIs when the Prefix
+  already contains underscores. Prefix=foo_bar is now correctly escaped to
+  foo__bar.
+- excon 0.71 is now required as earlier versions had open security issues.
+
+## [0.10.0]
+### Added
+- `PublishedRepository#from_repositories` publishes repository sources
+   into the same prefix.
+- `Aptly.repo` is a new shorthand for `Aptly::Repository.get` to get
+   a repository by name when writing code interactively in IRB, or to
+   write slightly less verbose code.
+
+### Fixed
+- Documentation fixes.
+- `Connection.HTTP_ACTIONS` is now properly marked private.
+
 ## [0.9.1]
 ### Fixed
 - Hint at needing `noRemove: 1` as param when loop adding files (default

data/README.md

@@ -2,8 +2,6 @@
 
 [![Inline docs](http://inch-ci.org/github/KDEJewellers/aptly-api.svg?branch=master)](http://inch-ci.org/github/KDEJewellers/aptly-api)
 [![Build Status](https://travis-ci.org/KDEJewellers/aptly-api.svg?branch=master)](https://travis-ci.org/KDEJewellers/aptly-api)
-[![Coverage Status](https://coveralls.io/repos/KDEJewellers/aptly-api/badge.svg?branch=master&service=github)](https://coveralls.io/github/KDEJewellers/aptly-api?branch=master)
-[![Dependency Status](https://gemnasium.com/KDEJewellers/aptly-api.svg)](https://gemnasium.com/KDEJewellers/aptly-api)
 [![Code Climate](https://codeclimate.com/github/KDEJewellers/aptly-api/badges/gpa.svg)](https://codeclimate.com/github/KDEJewellers/aptly-api)
 
 ## Installation

data/aptly-api.gemspec

@@ -19,15 +19,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.8'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rake-notes', '~> 0.2'
   spec.add_development_dependency 'simplecov', '~> 0.11'
   spec.add_development_dependency 'webmock', '~> 3.1'
   spec.add_development_dependency 'yard', '~> 0.8'
 
-  spec.add_dependency 'faraday', '~> 0.9'
-  spec.add_dependency 'excon', '~> 0.54'
+  spec.add_dependency 'faraday', '~> 2.0'
+  spec.add_dependency 'faraday-multipart', '~> 1.0'
+  spec.add_dependency 'faraday-excon', '~> 2.0'
+  spec.add_dependency 'excon'
 end

data/lib/aptly/connection.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 Harald Sitter <sitter@kde.org>
+# Copyright (C) 2015-2022 Harald Sitter <sitter@kde.org>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -14,6 +14,8 @@
 # License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'faraday'
+require 'faraday/excon'
+require 'faraday/multipart'
 require 'json'
 require 'uri'
 
@@ -31,9 +33,10 @@ module Aptly
     private_constant :GETISH_ACTIONS
     POSTISH_ACTIONS = %i[post put].freeze
     private_constant :POSTISH_ACTIONS
-    HTTP_ACTIONS = GETISH_ACTIONS + POSTISH_ACTIONS
     WRITE_ACTIONS = (POSTISH_ACTIONS + %i[delete]).freeze
     private_constant :WRITE_ACTIONS
+    HTTP_ACTIONS = GETISH_ACTIONS + POSTISH_ACTIONS
+    private_constant :HTTP_ACTIONS
 
     CODE_ERRORS = {
       400 => Errors::ClientError,

data/lib/aptly/publish.rb

@@ -42,6 +42,17 @@ module Aptly
                                    query: kwords)
         JSON.parse(response.body).collect { |h| new(connection, h) }
       end
+
+      # Publish an array of {Repository} to a prefix.
+      # @param repos [Array<Repository>] array of repositories to source
+      # @param prefix [String] the prefix to publish under (must be escaped see
+      #    {.escape_prefix})
+      # @return [PublishedRepository] newly published repository
+      # @since 0.10.0
+      def from_repositories(repos, prefix, **kwords)
+        sources = repos.collect { |x| { Name: x.Name } }
+        Aptly.publish(sources, prefix, **kwords)
+      end
     end
 
     private

data/lib/aptly/publishable.rb

@@ -1,11 +1,13 @@
 module Aptly
+  # Abstract "type" of all publishable entities. Publishable entities
+  # are everything that can act as Source for a PublishedRepository.
   module Publishable
     # Lists all PublishedRepositories self is published in. Namely self must
     # be a source of the published repository in order for it to appear here.
     # This method always returns an array of affected published repositories.
     # If you use this method with a block it will additionally yield each
     # published repository that would appear in the array, making it a shorthand
-    # for {Array#each}.
+    # for Array#each.
     # @yieldparam pub [PublishedRepository]
     # @return [Array<PublishedRepository>]
     def published_in

data/lib/aptly/repository.rb

@@ -95,10 +95,12 @@ module Aptly
 
     # Convenience wrapper around {Aptly.publish}, publishing this repository
     # locally and as only source of prefix.
-    # @param prefix [String] prefix to publish under (i.e. published repo name)
+    # @param prefix [String] prefix to publish under (i.e. published repo name).
+    #   This must be escaped (see {Aptly.escape_prefix})
+    # @see Aptly.escape_prefix
     # @return [PublishedRepository] newly published repository
     def publish(prefix, **kwords)
-      Aptly.publish([{ Name: self.Name }], prefix, 'local', kwords)
+      Aptly.publish([{ Name: self.Name }], prefix, 'local', **kwords)
     end
 
     # Edit this repository's attributes as per the parameters.

data/lib/aptly/snapshot.rb

@@ -28,7 +28,7 @@ module Aptly
     end
 
     # Find differences between this and another snapshot
-    # @param [Snapshot] to diff against
+    # @param other_snapshot [Snapshot] to diff against
     # @return [Array<Hash>] diff between the two snashots
     def diff(other_snapshot)
       endpoint = "/snapshots/#{self.Name}/diff/#{other_snapshot.Name}"
@@ -47,10 +47,12 @@ module Aptly
 
     # Convenience wrapper around {Aptly.publish}, publishing this snapshot
     # locally and as only source of prefix.
-    # @param prefix [String] prefix to publish under (i.e. published snapshot name)
+    # @param prefix [String] prefix to publish under (i.e. published repo name).
+    #   This must be escaped (see {Aptly.escape_prefix})
+    # @see Aptly.escape_prefix
     # @return [PublishedRepository] newly published repository
     def publish(prefix, **kwords)
-      Aptly.publish([{ Name: self.Name }], prefix, 'snapshot', kwords)
+      Aptly.publish([{ Name: self.Name }], prefix, 'snapshot', **kwords)
     end
 
     class << self

data/lib/aptly/tmpname.rb

@@ -18,6 +18,8 @@ require 'English'
 module Aptly
   # Helper to generate temporary names
   module TmpName
+    # Generate a random temporary directory name.
+    # @param prefix [String] arbitrary prefix string to start the name with
     # @return [String] temporary directory name (only safe characters)
     def self.dir(prefix)
       format('%<prefix>s-%<time>s-%<pid>s-%<tid>s-%<rand>s',

data/lib/aptly/version.rb

@@ -1,4 +1,5 @@
 # Aptly API
 module Aptly
-  VERSION = '0.9.1'.freeze
+  # The loaded version of the gem.
+  VERSION = '0.11.0'.freeze
 end

data/lib/aptly.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 Harald Sitter <sitter@kde.org>
+# Copyright (C) 2015-2020 Harald Sitter <sitter@kde.org>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -26,18 +26,27 @@ require 'aptly/tmpname'
 # Aptly API
 module Aptly
   class << self
+    # Configures aptly in a block.
     def configure
       yield configuration
     end
 
+    # The global configuration instance.
     def configuration
       @configuration ||= Configuration.new
     end
 
+    # Convenience shorthand for {Repository#get}.
+    # @since 0.10.0
+    def repo(name, connection = Connection.new, **kwords)
+      Repository.get(name, connection, **kwords)
+    end
+
     # Publish 1 or more sources into a public repository prefix.
     # @param sources [Array<Repository>] array of repositories to source
-    # @param prefix [String] the prefix to publish under (must be escaped see
-    #    {#escape_prefix})
+    # @param prefix [String] prefix to publish under (i.e. published repo name).
+    #   This must be escaped (see {Aptly.escape_prefix})
+    # @see Aptly.escape_prefix
     # @param source_kind [String] the source kind (local or snapshot)
     # @return [PublishedRepository] newly published repository
     def publish(sources, prefix = '', source_kind = 'local',
@@ -60,7 +69,7 @@ module Aptly
     # @return [String] API-safe prefix notation
     # @since 0.7.0
     def escape_prefix(prefix_path)
-      prefix_path.tr('_', '__').tr('/', '_')
+      prefix_path.gsub('_', '__').tr('/', '_')
     end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: aptly-api
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Harald Sitter
 - Rohan Garg
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,28 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -59,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rake-notes
   requirement: !ruby/object:Gem::Requirement
@@ -129,28 +115,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: excon
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.54'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.54'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: REST client for the Aptly API
 email:
 - sitter@kde.org
@@ -186,7 +200,7 @@ homepage: https://github.com/KDEJewellers/aptly-api/
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -201,9 +215,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.3.13
+signing_key:
 specification_version: 4
 summary: REST client for the Aptly API
 test_files: []