aptly-api 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9efbe6f74dd549cd105d0fcb98789e58ab3e4d79
-  data.tar.gz: 8f2ec5e7dc006199444dcb714c3aea3e34a0940b
+  metadata.gz: e05f1603a52e6c576b35e475a2598c8c9b6192d0
+  data.tar.gz: 200046983723560e59038822e12f738c452b663b
 SHA512:
-  metadata.gz: 3c899648d86ab6eeddc83d38368958adf3c829a1881c148beca3bb3b40c48cec0f9232c4dc6f969fbf1dffad3215f6b15fb4c0c2bffe04918e2320f702e69b18
-  data.tar.gz: 29231774db283cfaad31859c0d6feb2355c010e1e8791ea9ec7df1d85d6b3388a2304db98b81175e054d306fecd279a9a028b355629adc8d0a0d3eca6ff445f8
+  metadata.gz: 9cb8262c9cfe2777f0588498cd7dcf43b656d10918345c3a08371c7eee7fd0213d73b7332f2846d579dce187b2cd4b3ab099e112d465a5f94d664eaa7fff7caf
+  data.tar.gz: d89fa0b8074a9c85fd76ad02586f4823f2e6f32ca38971224d595b20928ba20ee697774c6fa7f8ef71fe11882b319ad50adf5a3a3d7d3ad9c7ee0e623e3affa8

data/.rubocop.yml

@@ -1,3 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.1
 
+# We are not going to require gems just so we can indent heredocs...
+Layout/IndentHeredoc:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Change Log
 
+## Unreleased
+### Added
+- Configuration now has two new attributes timeout and write_timeout.
+  When you set a timeout manually on the Aptly configuration object it gets
+  used even if you have global timeouts set elsewhere.
+  As a side effect setting timeouts on faraday directly will not work anymore.
+  If you used to set a faraday-wide timeout we will try to use it,
+  iff longer than our default value. So, the effective default is at least
+  15 minutes but may be longer depending on the Faraday timeout.
+  This Faraday fallback is getting removed in 1.0, so you should port
+  to the new attributes instead. For future reference you should avoid
+  talking to Faraday directly.
+  - `timeout` controls the general HTTP connection timeouts. It's set to
+    1 minute by default which should be enough for most read operations.
+  - `write_timeout` controls the HTTP connection timeout of writing timeouts.
+    This applies in broad terms to all requests which we expect to require a
+    server-side lock to run and thus have high potential for timing out.
+    It defaults to 10 minutes which should allow most operations to finish.
+    The attribute will have tighter functionality if or when
+    https://github.com/smira/aptly/pull/459 gets merged and we can adopt a more
+    async API.
+- Connection.new now takes a new `config` parameter that is the Configuration
+  instance to use for the Connection. This partially deprecates the `uri`
+  parameter which you can set through the Configuration instance now.
+
+  ```
+  Aptly::Connection.new(uri: uri)
+  # can become
+  Aptly::Connection.new(Aptly::Configuration.new(uri: uri))
+  ```
+
+### Changed
+- Connection.new no longer catches arbitrary options but instead specifies
+  the accepted arguments in the method signature. It accepted two
+  well-known options before anyway, this enforces them properly on a language
+  level.
+
 ## [0.7.0]
 ### Added
 - Aptly.escape_prefix is a new helper method to turn prefixes into

data/lib/aptly/configuration.rb

@@ -1,3 +1,18 @@
+# Copyright (C) 2015-2017 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/>.
+
 require 'rubygems/deprecate'
 
 module Aptly
@@ -8,23 +23,54 @@ module Aptly
     # @!attribute uri
     #   Generally any suitable URI is allowed. This can also be a Unix domain
     #   socket which needs to be used in the notation unix:/tmp/sock.
-    #   @return [URI] the base URI for the API (http://localhost by default)
+    # @return [URI] the base URI for the API (http://localhost by default)
     attr_accessor :uri
 
+    # @!attribute timeout
+    #   The request read timeout in seconds. HTTP connections not responding in
+    #   this time limit will raise an error. Note that the server-side API is
+    #   currently synchronous so a read request may time out for no better
+    #   reason than it not getting a suitable database lock in time, so allowing
+    #   for some leeway is recommended here.
+    #   https://github.com/smira/aptly/pull/459
+    # @return [Integer] read timeout seconds
+    attr_accessor :timeout
+
+    # @!attribute write_timeout
+    #   The request write timeout in seconds. HTTP connections not responding
+    #   in this time limit will raise an error. When pushing data into Aptly
+    #   or publishing large repositories this value should be suitably high.
+    #   This timeout is used for API calls which we expect to need a write-lock
+    #   on the server. Using a value of a couple minutes is recommended if
+    #   you have concurrent write requests (multiple uploads from different
+    #   sources) or the server performance isn't always assured (slow disk,
+    #   load spikes).
+    # @return [Integer] write timeout seconds
+    attr_accessor :write_timeout
+
+    # rubocop:disable Metrics/ParameterLists So long because of deprecation.
+
     # Creates a new instance.
     # @param uri see {#uri}
+    # @param timeout see {#timeout}
+    # @param write_timeout see {#write_timeout}
     # @param host DEPRECATED use uri
     # @param port DEPRECATED use uri
     # @param path DEPRECATED use uri
     def initialize(uri: URI::HTTP.build(host: 'localhost',
                                         port: 80,
                                         path: '/'),
+                   timeout: [60, faraday_default_timeout].max,
+                   write_timeout: [10 * 60, timeout].max,
                    host: nil, port: nil, path: nil)
+      @timeout = timeout
+      @write_timeout = write_timeout
       @uri = nil
       @uri = uri unless host || port || path
       return if @uri
       @uri = fallback_uri(host, port, path)
     end
+    # rubocop:enable Metrics/ParameterLists
 
     # @!attribute host
     #   @deprecated use {#uri}
@@ -39,7 +85,7 @@ module Aptly
     #   @return [String] path to use (defaults to /)
 
     # Fake deprecated attributes and redirect them to @uri
-    [:host, :port, :path].each do |uri_attr|
+    %i[host port path].each do |uri_attr|
       define_method(uri_attr.to_s) do
         @uri.send(uri_attr)
       end
@@ -54,6 +100,10 @@ module Aptly
 
     private
 
+    def faraday_default_timeout
+      Faraday.default_connection_options[:request][:timeout] || -1
+    end
+
     def safe_port(port)
       port ? port.to_i : port
     end

data/lib/aptly/connection.rb

@@ -1,7 +1,23 @@
+# Copyright (C) 2015-2017 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/>.
+
 require 'faraday'
 require 'json'
 require 'uri'
 
+require_relative 'configuration'
 require_relative 'errors'
 
 module Aptly
@@ -10,9 +26,14 @@ module Aptly
   # automation on top of the raw HTTP actions.
   class Connection
     DEFAULT_QUERY = {}.freeze
-    GETISH_ACTIONS = %i(get delete).freeze
-    POSTISH_ACTIONS = %i(post put).freeze
+    private_constant :DEFAULT_QUERY
+    GETISH_ACTIONS = %i[get delete].freeze
+    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
 
     CODE_ERRORS = {
       400 => Errors::ClientError,
@@ -21,34 +42,44 @@ module Aptly
       409 => Errors::ConflictError,
       500 => Errors::ServerError
     }.freeze
-
-    def initialize(**kwords)
-      @query = kwords.fetch(:query, DEFAULT_QUERY)
-      @base_uri = kwords.delete(:uri) { ::Aptly.configuration.uri.clone }
-
-      raise if uri.nil?
-      @connection = Faraday.new(uri) do |c|
+    private_constant :CODE_ERRORS
+
+    # New connection.
+    # @param config [Configuration] Configuration instance to use
+    # @param query [Hash] Default HTTP query paramaters, these get the
+    #   specific query parameters merged upon.
+    # @param uri [URI] Base URI for the remote (default from
+    #   {Configuration#uri}).
+    def initialize(config: ::Aptly.configuration, query: DEFAULT_QUERY,
+                   uri: config.uri)
+      @query = query
+      @base_uri = uri
+      raise if faraday_uri.nil?
+      @config = config
+      @connection = Faraday.new(faraday_uri) do |c|
         c.request :multipart
         c.request :url_encoded
         c.adapter :excon, @adapter_options
       end
     end
 
-    def method_missing(symbol, *args, **kwords)
-      return super(symbol, *args, kwords) unless HTTP_ACTIONS.include?(symbol)
-
-      kwords[:query] = build_query(kwords)
-      kwords.delete(:query) if kwords[:query].empty?
+    HTTP_ACTIONS.each do |action|
+      # private api
+      define_method(action) do |relative_path = '', kwords = {}|
+        # NB: double splat is broken with Ruby 2.2.1's define_method, so we
+        #   cannot splat kwords in the signature.
+        kwords[:query] = build_query(kwords)
+        kwords.delete(:query) if kwords[:query].empty?
 
-      relative_path = args.shift
-      http_call(symbol, add_api(relative_path), kwords)
+        http_call(action, add_api(relative_path), kwords)
+      end
     end
 
     private
 
-    def uri
+    def faraday_uri
       @adapter_options ||= {}
-      @uri ||= begin
+      @faraday_uri ||= begin
         uri = @base_uri.clone
         return uri unless uri.scheme == 'unix'
         # For Unix domain sockets we need to divide the bits apart as Excon
@@ -87,13 +118,21 @@ module Aptly
       [body, headers]
     end
 
+    def setup_request(action, request)
+      standard_timeout = @config.timeout
+      standard_timeout = @config.write_timeout if WRITE_ACTIONS.include?(action)
+      request.options.timeout = standard_timeout
+    end
+
     def run_postish(action, path, kwords)
       body = kwords.delete(:body)
       headers = kwords.delete(:headers)
 
       body, headers = mangle_post(body, headers, kwords)
 
-      @connection.send(action, path, body, headers)
+      @connection.send(action, path, body, headers) do |request|
+        setup_request(action, request)
+      end
     end
 
     def run_getish(action, path, kwords)
@@ -102,6 +141,7 @@ module Aptly
       headers = kwords.delete(:headers)
 
       @connection.send(action, path, params, headers) do |request|
+        setup_request(action, request)
         if body
           request.headers[:content_type] = 'application/json'
           request.body = body
@@ -109,6 +149,12 @@ module Aptly
       end
     end
 
+    def handle_error(response)
+      error = CODE_ERRORS.fetch(response.status, nil)
+      raise error, response.body if error
+      response
+    end
+
     def http_call(action, path, kwords)
       if POSTISH_ACTIONS.include?(action)
         response = run_postish(action, path, kwords)
@@ -117,9 +163,9 @@ module Aptly
       else
         raise "Unknown http action: #{action}"
       end
-      error = CODE_ERRORS.fetch(response.status, nil)
-      raise error, response.body if error
-      response
+      handle_error(response)
+    rescue Faraday::TimeoutError => e
+      raise Errors::TimeoutError, e.message
     end
   end
 end

data/lib/aptly/errors.rb

@@ -1,4 +1,8 @@
 module Aptly
+  # TODO: 1.0 flatten this out. Either the classes should not have a suffix
+  #   or they should not be in an errors module. They were originally put in
+  #   here so its easy to view all errors in api documentation.
+
   # All aptly errors.
   module Errors
     # Generic HTTP error base.
@@ -22,6 +26,10 @@ module Aptly
     # Raised when a Snapshot consists of a unknown source type
     class UnknownSourceTypeError < StandardError; end
 
+    # Raised when a request times out waiting for the server to reply
+    # (this is the opposite of HTTP 408 where a server times out waiting for us)
+    class TimeoutError < StandardError; end
+
     # Raised when a file operation had an error.
     class RepositoryFileError < StandardError
       # @!attribute [r] failures
@@ -44,7 +52,7 @@ module Aptly
 
       # @return [String] (formatted) string representation
       def to_s
-        <<-EOF
+        <<-DESCRIPTION
 
 ~~~
   Failed to process:
@@ -52,7 +60,7 @@ module Aptly
   Warnings:
     #{warnings.join("\n    ")}
 ~~~
-        EOF
+        DESCRIPTION
       end
 
       class << self

data/lib/aptly/files.rb

@@ -9,12 +9,8 @@ module Aptly
       # @param connection [Connection] connection to use
       # @return [Array<String>] list of files now on the remote
       def upload(files, directory, connection = Connection.new, **kwords)
-        i = 0
-        files.each do |f|
-          kwords["file_#{i += 1}".to_sym] = f
-        end
-        response = connection.send(:post, "/files/#{directory}",
-                                   kwords)
+        files.each_with_index { |f, i| kwords["file_#{i}".to_sym] = f }
+        response = connection.send(:post, "/files/#{directory}", kwords)
         JSON.parse(response.body)
       end
 

data/lib/aptly/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aptly-api
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Harald Sitter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,7 +167,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- TODO
 - aptly-api.gemspec
 - bin/console
 - bin/setup

data/TODO

@@ -1,6 +0,0 @@
-- cookbook needs to install and run gpg to init keyring?
-- need signing support and testing
-  - signing happens at publishing stage
-
-low prio:
-- package listing api to port install_check.rb to