aptly-api 0.8.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c729ac7d333aee96cfebe50fab52e466ab5a0f40415731fb8b5aa13ce25ca07
-  data.tar.gz: 40ec80ef71efcf5b210f19db3bfafe00b3aa5d6cb41db4756b4dfb41a6af1baf
+  metadata.gz: 1620dd9faac56d2cdc59e3c4fa5071269dfa3fb500ca6837d0c5c2095dfbc793
+  data.tar.gz: 9010ab42e434fa472f990a4d8d69a519bbf7989597a9e6c826aae988997d533c
 SHA512:
-  metadata.gz: 67731160d86722a903a54a8492ac98d7e98e6ad06d3740a175c54cb0798dbdd749bb14138afdb81f6c325970e9ac14a6daf27a4a9acaa164a56c29d6a757fc0e
-  data.tar.gz: e70a5147ec2eba41c2d8b99e10f47caaca3c784da1cde20fa95da157374b5fb233f9d1699d40d2697ecc58fbb309bf6ef8a3a1d32eedab42634f865ed92da567
+  metadata.gz: 120c7e010476239efb0f3148aaa7871875ec959372d5de59bf29693c2440856f62b5170c6aa9f3d910ae61648a5afc10d8ea88b1283204220e2abd97419d17a5
+  data.tar.gz: 719edccb1abff82d097c269631f15b3d56b1cdb809d121bda40c08b6dbe8032a461aa90010241ec7c7e2c0e385a65dbb9668eb226d5fe1120883a88ec6ae43eb

data/.travis.yml

@@ -1,9 +1,5 @@
 language: ruby
 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,50 @@
 # Change Log
 
+## [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
+  behavior is to remove added files) in the `Files.tmp_upload` documentation.
+- `Connection` properly passes query parameters for post-ish requests now.
+- `Repository.add_file` no longer mangles it's query parameters as they are
+  inconsistently cased on the API level.
+
+## [0.9.0]
+### Added
+- `Files.tmp_upload` is a new convenience wrapper around `#upload` and
+  `#delete`. It picks a temporary directory name and uploads the list of files
+  to that directory, it then yields the directory name so you can use it as file
+  identifier for the files. When the method returns it automatically cleans the
+  remote up via `#delete`.
+
+### Changed
+- `Repository.upload` is now based on `Files.tmp_upload`. Functionally
+  all remains the same; the temporary directory name on the remote changes.
+- Temporary directory names now include a thread id to reduce the risk of
+  conflicts across different threads.
+
+## [0.8.2]
+### Fixed
+- Temporary files no longer contain characters that trip up the daemon.
+
 ## [0.8.1]
 ### Changed
 - Ruby 2.5.0 compatible. Temporary name construction of uploaded files now

data/README.md

@@ -3,7 +3,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,7 +19,7 @@ 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 'bundler', '~> 2.0'
   spec.add_development_dependency 'coveralls', '~> 0.8'
   spec.add_development_dependency 'minitest', '~> 5.8'
   spec.add_development_dependency 'rake', '~> 12.0'
@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.8'
 
   spec.add_dependency 'faraday', '~> 0.9'
-  spec.add_dependency 'excon', '~> 0.54'
+  spec.add_dependency 'excon', '~> 0.71'
 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

data/lib/aptly/connection.rb

@@ -31,9 +31,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,
@@ -126,12 +127,14 @@ module Aptly
 
     def run_postish(action, path, kwords)
       body = kwords.delete(:body)
+      params = kwords.delete(:query)
       headers = kwords.delete(:headers)
 
       body, headers = mangle_post(body, headers, kwords)
 
       @connection.send(action, path, body, headers) do |request|
         setup_request(action, request)
+        request.params.update(params) if params
       end
     end
 

data/lib/aptly/files.rb

@@ -1,3 +1,18 @@
+# Copyright (C) 2015-2018 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
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
 module Aptly
   # Aptly files management.
   # @see http://www.aptly.info/doc/api/files/
@@ -14,6 +29,38 @@ module Aptly
         JSON.parse(response.body)
       end
 
+      # Upload files into a temporary directory on remote.
+      # This method expects a block which will be yielded to with the directory
+      # name on the remote. The directory will be deleted when this method
+      # returns.
+      # You'll generally want to use this instead of #upload so you don't have
+      # to worry about name collission and clean up.
+      #
+      # @param files [Array<String>] paths to files to upload
+      # @param connection [Connection] connection to use
+      # @yield [String] the remote directory name the files were uploaded to
+      # @return return value of block
+      #
+      # @example Can be used to push into multiple repositories with one upload
+      #   Files.tmp_upload(files) do |d|
+      #     repos.each { |r| r.add_files(d, noRemove: 1) }
+      #   end
+      #
+      # @since 0.9.0
+      def tmp_upload(files, connection = Connection.new, **kwords)
+        # TODO: 1.0 find out if #upload even has a use case and maybe replace it
+        dir = tmp_dir_name
+        upload(files, dir, connection, **kwords)
+        uploaded = true
+        yield dir
+      ensure
+        # We have an uploaded var here as exceptions raised by upload would
+        # still run this, but they may not have the remote file, so our
+        # delete request would again cause an error making it harder to spot
+        # the orignal problem.
+        delete(dir) if uploaded
+      end
+
       # Delete files from remote's upload directory.
       # @param path [String] path to delete (this may be a directory or a file)
       # @return [nil]
@@ -21,6 +68,13 @@ module Aptly
         connection.send(:delete, "/files/#{path}", kwords)
         nil
       end
+
+      private
+
+      def tmp_dir_name
+        prefix = "#{to_s.tr(':', '_')}-#{Socket.gethostname}"
+        TmpName.dir(prefix)
+      end
     end
   end
 end

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

@@ -41,8 +41,11 @@ module Aptly
     # @return [Hash] report data as specified in the API.
     # FIXME: this should be called file
     def add_file(path, **kwords)
+      # Don't mangle query, the file API is inconsistently using camelCase
+      # rather than CamelCase.
       response = connection.send(:post, "/repos/#{self.Name}/file/#{path}",
-                                 query: kwords)
+                                 query: kwords,
+                                 query_mangle: false)
       hash = JSON.parse(response.body)
       error = Errors::RepositoryFileError.from_hash(hash)
       raise error if error
@@ -52,12 +55,9 @@ module Aptly
     # FIXME: needs to support single files
     # Convenience wrapper around {Files.upload}, {#add_file} and {Files.delete}
     def upload(files)
-      prefix = "#{self.class.to_s.tr(':', '_')}-#{Socket.gethostname}-"
-      directory = TmpName.make(prefix)
-      Files.upload(files, directory, connection)
-      add_file(directory)
-    ensure
-      Files.delete(directory, connection)
+      Files.tmp_upload(files, connection) do |dir|
+        add_file(dir)
+      end
     end
 
     # List all packages in the repository
@@ -95,7 +95,9 @@ 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)

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,7 +47,9 @@ 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)

data/lib/aptly/tmpname.rb

@@ -13,16 +13,22 @@
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
+require 'English'
+
 module Aptly
   # Helper to generate temporary names
   module TmpName
-    def self.make(prefix)
-      format('%<prefix>s-%<time>s-%<prog>s-%<rand>s',
+    # 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',
              prefix: prefix,
              # rubocop:disable Style/FormatStringToken
              time: Time.now.strftime('%Y%m%d'),
              # rubocop:enable Style/FormatStringToken
-             prog: $PROGRAM_NAME,
+             pid: $PROCESS_ID,
+             tid: Thread.current.object_id,
              rand: rand(0x100000000).to_s(36))
     end
   end

data/lib/aptly/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aptly-api
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Harald Sitter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-15 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,14 +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'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -143,14 +143,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.54'
+        version: '0.71'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.54'
+        version: '0.71'
 description: REST client for the Aptly API
 email:
 - sitter@kde.org
@@ -201,8 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: REST client for the Aptly API