aptly-api 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79ced71b1cd9922919fe97c154e793f0f9bc21db
-  data.tar.gz: 1d2e0d76380078c95a75c35691d3d337f0ad8e22
+  metadata.gz: 9efbe6f74dd549cd105d0fcb98789e58ab3e4d79
+  data.tar.gz: 8f2ec5e7dc006199444dcb714c3aea3e34a0940b
 SHA512:
-  metadata.gz: 34774e02ed4bfeb26c39d6e16923012e768ac997539c945f11f65c72ef0bd1f48c2ba563852e8cb7415c62d21c8a3f150cb8aefcf40b3b6266c6b9edb14c4b41
-  data.tar.gz: fde5d5743c21e7dbacf7edd0ad6a1d71aa5a8a2c151667c79e437e0495b28f2c22d3ce0dced080da752a9e7614d7b33160fe530694db1f76c7e471679e812477
+  metadata.gz: 3c899648d86ab6eeddc83d38368958adf3c829a1881c148beca3bb3b40c48cec0f9232c4dc6f969fbf1dffad3215f6b15fb4c0c2bffe04918e2320f702e69b18
+  data.tar.gz: 29231774db283cfaad31859c0d6feb2355c010e1e8791ea9ec7df1d85d6b3388a2304db98b81175e054d306fecd279a9a028b355629adc8d0a0d3eca6ff445f8

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+## [0.7.0]
+### Added
+- Aptly.escape_prefix is a new helper method to turn prefixes into
+  REST API format.
+
+### Changed
+- Aptly.publish and all publishing methods built on top of it now raise an
+  InvalidPrefixError when they encounter a forward-slash in the publishing
+  prefix. Aptly's REST API enforces prefixes to be encoded with _ as __ and
+  / as _ unfortuantely as this is ambiguous we cannot automatically determine
+  if a prefix is encoded or unencoded. To retain backwards compatibility the
+  assumption is that is is encoded and if it clearly is not an error is raised.
+  For 1.0 this expectation is changing to assume the prefix is unencoded and
+  will be forcefully encoded!

data/lib/aptly.rb

@@ -35,11 +35,14 @@ module Aptly
 
     # 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
+    # @param prefix [String] the prefix to publish under (must be escaped see
+    #    {#escape_prefix})
     # @param source_kind [String] the source kind (local or snapshot)
     # @return [PublishedRepository] newly published repository
     def publish(sources, prefix = '', source_kind = 'local',
                 connection = Connection.new, **kwords)
+      # TODO: 1.0 break compat and invert the assertion to want unescaped
+      raise Errors::InvalidPrefixError if prefix.include?('/')
       kwords = kwords.map { |k, v| [k.to_s.capitalize, v] }.to_h
       options = kwords.merge(
         SourceKind: source_kind,
@@ -49,5 +52,14 @@ module Aptly
                                  body: JSON.generate(options))
       PublishedRepository.new(connection, JSON.parse(response.body))
     end
+
+    # Translates a pathish prefix (e.g. 'dev/unstable_x') to an API-safe prefix
+    # (e.g. 'dev_unstable__x')
+    # See prefix format description on https://www.aptly.info/doc/api/publish/
+    # @return [String] API-safe prefix notation
+    # @since 0.7.0
+    def escape_prefix(prefix_path)
+      prefix_path.tr('_', '__').tr('/', '_')
+    end
   end
 end

data/lib/aptly/errors.rb

@@ -67,5 +67,13 @@ module Aptly
         end
       end
     end
+
+    # Raised when a publishing prefix contains a slash when it was expected to
+    # be in API-safe format.
+    # Unfortunately we cannot automatically coerce as the safe format has
+    # character overlap with an unsafe format (_ means something in both), so
+    # we'll expect the API consumer to only hand us suitable prefixes.
+    # https://www.aptly.info/doc/api/publish/
+    class InvalidPrefixError < StandardError; end
   end
 end

data/lib/aptly/publish.rb

@@ -50,7 +50,7 @@ module Aptly
     #   _ => __
     #   / => _
     def api_prefix
-      self.Prefix.tr('_', '__').tr('/', '_')
+      ::Aptly.escape_prefix(self.Prefix)
     end
 
     def parse_sources

data/lib/aptly/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aptly-api
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Harald Sitter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -161,6 +161,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - COPYING.lib
 - Gemfile
@@ -201,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: REST client for the Aptly API