aptly-api 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 380c5f11e70678a2475099bcd03210ec4181ad123d6094b7bdecc1f636e6b9af
-  data.tar.gz: 810b109dcdae36be88317a858267b3d16b5f80e1fa1b4cff82e09f412e2e1a59
+  metadata.gz: ef67a756d6233d6522678531b0b0b221303a19120b14d80c834e62ad04b061f3
+  data.tar.gz: bc8c50900970fcd89e47302d43f49e9b6b3c6fd34d008e8f34b9c473c2a71856
 SHA512:
-  metadata.gz: 2883165cc34396cbc478fd096f0d1ee4a18b26f799aab81d6fd48fb0d3be79404f00d3b349e4545028549e46ebe21f824d182965469d6307d8a2447008a6f41e
-  data.tar.gz: 036bd6f29fb8cd1eb2f6bfae2a610168d18a42bc573213bee6a073eeda71de284425d32e7cc1e1729eceefdf160f54cd3a91723f5419a9a4e433e9eeca626629
+  metadata.gz: bf61c4b10714a527b5cf699ca9f9e77dd0cee51ce8e8a23f8d6f59b70bdb136091a1c3422ac1c39093038188fc5d6ccb4ca91c84fd7f42c08be48f3aa2b6f541
+  data.tar.gz: 1baed9a8971546a8c41a8101e56ec07e66a4d8a7eb801b1fcb5ac844afdd6f9ed7f8e0ef46bde5cfd5d75598b6915909c6420cdb7ea7d32f44e47b599fc19a0c

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [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/lib/aptly.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 Harald Sitter <sitter@kde.org>
+# 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
@@ -26,18 +26,26 @@ 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})
+    #    {.escape_prefix})
     # @param source_kind [String] the source kind (local or snapshot)
     # @return [PublishedRepository] newly published repository
     def publish(sources, prefix = '', source_kind = 'local',

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,

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/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}"

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.10.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aptly-api
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Harald Sitter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler