aptly-api 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a820f41426fba78e2df8de2eb2473853b9cf3d05
-  data.tar.gz: ae8062079c4393b311719405afc85b8753591579
+SHA256:
+  metadata.gz: 2f05bd8ea6f8823c9ecbdd75ece3fd75fea137e1c7feaf3ee9be7bacbc746fa6
+  data.tar.gz: 80e7d9229aa43d4d39a2d563a3570623a9beae956fc9add43ea53cb6dd985a02
 SHA512:
-  metadata.gz: 785d302d050691514f11fa1bc5c73e23f6f105aef27af492557ee2e888ea98f9469f91be159f64b91ac8b10dde5be97e33101b8e9dc77f1480e775930a29a7a8
-  data.tar.gz: 67229cb608abbf58f090024cec0bd16a654fcc90a63800b57a2267b07d3325cfb763e72870f1f74bec317b198aafbf645eedc70bc6dd63f59ac5829ea9ee78db
+  metadata.gz: ea9a99200d5c2a5c76c60013b2a90c695674bc31c9d63ea1cb5fd13912edcf5aa0696b79a9fe84289b93ddb46a170859108ba5e8b8c7fc1190ef99bb612b1126
+  data.tar.gz: 5f9731ea0d96ea4dbd0723598500f9e6ce6707ef30fd675e3cc1aad65542d7e8747fdb9b0b78361c35a636b52ecc4079351857595177f80c19911f1a68a4f32f

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## [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.

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,36 @@ 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) { |d| repos.each { |r| r.add_files(d) } }
+      #
+      # @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 +66,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/repository.rb

@@ -52,12 +52,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.dir(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

data/lib/aptly/tmpname.rb

@@ -20,12 +20,13 @@ module Aptly
   module TmpName
     # @return [String] temporary directory name (only safe characters)
     def self.dir(prefix)
-      format('%<prefix>s-%<time>s-%<pid>s-%<rand>s',
+      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
              pid: $PROCESS_ID,
+             tid: Thread.current.object_id,
              rand: rand(0x100000000).to_s(36))
     end
   end

data/lib/aptly/version.rb

@@ -1,4 +1,4 @@
 # Aptly API
 module Aptly
-  VERSION = '0.8.2'.freeze
+  VERSION = '0.9.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aptly-api
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Harald Sitter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-16 00:00:00.000000000 Z
+date: 2018-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -202,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: REST client for the Aptly API