aptly-api 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d24ca1fd0b5824c5257eee32bbd16043670ae6e3
-  data.tar.gz: 5516f23a22c14e12b9b31fbaa5cf4d55921adc13
+  metadata.gz: 626177bba4926b1d4edfe1229e5e334238cf61b4
+  data.tar.gz: 077010652f6d2059f85e647f89913ddbfcd23daa
 SHA512:
-  metadata.gz: e4c9606a314e35351298ea345126fffaba1e701b7d211103cf4824983042010d07c25e94250e3973ba21eb8fe159e10e50599181ed22ec6ff1559e361b958f60
-  data.tar.gz: dcf37ff7ff3fe160130565b0fae6df7988fc4038f85ffe3a6c41eca6c6e205cf4cd47d7cfaa4b7e6996efc47a87fa06d47b57a28fed4c7f68d8850e955979c99
+  metadata.gz: c9d07b75e5ba858305bf41f4e274db6c22a5a00f7f404dfd32b746cd5e91ae3abe41f20199a37481f3540f68091f9a10c65360dd16734a793495ff6e5d0d4b28
+  data.tar.gz: 9feb9b78522009ffbc8d980835d6a2b8165157cbf9e3c697ea5f6ec732a97e0d7e22c52918b052fa1b36b90084e8fa4eb33d564be80118243f206dc8fe7d9347

data/aptly-api.gemspec

@@ -14,9 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/KDEJewellers/aptly-api/'
   spec.license       = 'LGPL-3.0'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/}) || f == 'lib/aptly/snapshot.rb'
-  end
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']

data/lib/aptly.rb

@@ -20,6 +20,7 @@ require 'aptly/files'
 require 'aptly/publish'
 require 'aptly/repository'
 require 'aptly/version'
+require 'aptly/snapshot'
 
 # Aptly API
 module Aptly

data/lib/aptly/configuration.rb

@@ -9,12 +9,28 @@ module Aptly
     #   @return [Integer] port to talk to host to on
     attr_accessor :port
 
+    # @!attribute path
+    #   @return [String] path to use (defaults to /)
+    attr_accessor :path
+
     # Creates a new instance.
     # @param host see {#host}
     # @param port see {#port}
-    def initialize(host: 'localhost', port: 80)
+    def initialize(host: 'localhost', port: 80, path: '/')
       @host = host
       @port = port
+      @path = path
+    end
+
+    def uri
+      # FIXME: maybe we should simply configure a URI instead of configuring
+      #   each part?
+      uri = URI.parse('')
+      uri.scheme = 'http'
+      uri.host = host
+      uri.port = port
+      uri.path = path
+      uri
     end
   end
 end

data/lib/aptly/connection.rb

@@ -9,9 +9,9 @@ module Aptly
   # This class wraps HTTP interactions for our purposes and adds general purpose
   # automation on top of the raw HTTP actions.
   class Connection
-    DEFAULT_QUERY = {}
-    GETISH_ACTIONS = %i(get delete)
-    POSTISH_ACTIONS = %i(post put)
+    DEFAULT_QUERY = {}.freeze
+    GETISH_ACTIONS = %i(get delete).freeze
+    POSTISH_ACTIONS = %i(post put).freeze
     HTTP_ACTIONS = GETISH_ACTIONS + POSTISH_ACTIONS
 
     CODE_ERRORS = {
@@ -20,16 +20,12 @@ module Aptly
       404 => Errors::NotFoundError,
       409 => Errors::ConflictError,
       500 => Errors::ServerError
-    }
+    }.freeze
 
     def initialize(**kwords)
       @query = kwords.fetch(:query, DEFAULT_QUERY)
 
-      uri = URI.parse('')
-      uri.scheme = 'http'
-      uri.host = ::Aptly.configuration.host
-      uri.port = ::Aptly.configuration.port
-
+      uri = ::Aptly.configuration.uri
       @connection = Faraday.new(url: uri.to_s) do |c|
         c.request :multipart
         c.request :url_encoded
@@ -64,7 +60,7 @@ module Aptly
     def mangle_post(body, headers, kwords)
       if body
         headers ||= {}
-        headers.merge!('Content-Type' => 'application/json')
+        headers['Content-Type'] = 'application/json'
       else
         kwords.each do |k, v|
           if k.to_s.start_with?('file_')
@@ -104,10 +100,10 @@ module Aptly
       elsif GETISH_ACTIONS.include?(action)
         response = run_getish(action, path, kwords)
       else
-        fail "Unknown http action: #{action}"
+        raise "Unknown http action: #{action}"
       end
       error = CODE_ERRORS.fetch(response.status, nil)
-      fail error, response.body if error
+      raise error, response.body if error
       response
     end
   end

data/lib/aptly/files.rb

@@ -17,6 +17,14 @@ module Aptly
                                    kwords)
         JSON.parse(response.body)
       end
+
+      # Delete files from remote's upload directory.
+      # @param path [String] path to delete (this may be a directory or a file)
+      # @return [nil]
+      def delete(path, connection = Connection.new, **kwords)
+        connection.send(:delete, "/files/#{path}", kwords)
+        nil
+      end
     end
   end
 end

data/lib/aptly/publish.rb

@@ -26,7 +26,7 @@ module Aptly
       response = connection.send(:put,
                                  "/publish/#{api_prefix}/#{self.Distribution}",
                                  body: JSON.generate(kwords))
-      hash = JSON.parse(response.body)
+      hash = JSON.parse(response.body, symbolize_names: true)
       return nil if hash == marshal_dump
       marshal_load(hash)
       self

data/lib/aptly/repository.rb

@@ -3,6 +3,7 @@ require 'tmpdir'
 
 require_relative 'errors'
 require_relative 'representation'
+require_relative 'snapshot'
 
 module Aptly
   # Aptly repository representation.
@@ -21,19 +22,19 @@ module Aptly
                                  query: kwords)
       hash = JSON.parse(response.body)
       error = Errors::RepositoryFileError.from_hash(hash)
-      fail error if error
+      raise error if error
       hash['Report']['Added']
     end
 
     # FIXME: needs to support single files
-    # Convenience wrapper around {Files.upload} and {#add_file}
+    # Convenience wrapper around {Files.upload}, {#add_file} and {Files.delete}
     def upload(files)
       prefix = "#{self.class.to_s.tr(':', '_')}-#{Socket.gethostname}-"
       directory = Dir::Tmpname.make_tmpname(prefix, nil)
       Files.upload(files, directory, connection)
       add_file(directory)
     ensure
-      # FIXME: delete dir?
+      Files.delete(directory, connection)
     end
 
     # List all packages in the repository
@@ -55,7 +56,7 @@ module Aptly
                       body: JSON.generate(PackageRefs: [*packages]))
       self
     end
-    alias_method :add_packages, :add_package
+    alias add_packages add_package
 
     # Deletes a package (by key) from the repository.
     # @param packages [Array<String>, String] a list of package keys or
@@ -67,7 +68,7 @@ module Aptly
                       body: JSON.generate(PackageRefs: [*packages]))
       self
     end
-    alias_method :delete_packages, :delete_package
+    alias delete_packages delete_package
 
     # Convenience wrapper around {Aptly.publish}, publishing this repository
     # locally and as only source of prefix.
@@ -100,6 +101,29 @@ module Aptly
       end
     end
 
+    # Edit this repository's attributes as per the parameters.
+    # @note this possibly mutates the attributes depending on the HTTP response
+    # @return [self] if the instance data was mutated
+    # @return [nil] if the instance data was not mutated
+    def edit!(**kwords)
+      response = connection.send(:put,
+                                 "/repos/#{self.Name}",
+                                 body: JSON.generate(kwords))
+      hash = JSON.parse(response.body, symbolize_names: true)
+      return nil if hash == marshal_dump
+      marshal_load(hash)
+      self
+    end
+
+    # Creates a new {Snapshot}
+    # @return {Snapshot} newly created instance
+    def snapshot(**kwords)
+      kwords = kwords.map { |k, v| [k.to_s.capitalize, v] }.to_h
+      response = connection.send(:post, "/repos/#{self.Name}/snapshots",
+                                 body: JSON.generate(kwords))
+      Aptly::Snapshot.new(::Aptly::Connection.new, JSON.parse(response.body))
+    end
+
     class << self
       # Get a {Repository} instance if the repository already exists.
       # @param name [String] name of the repository

data/lib/aptly/snapshot.rb

@@ -0,0 +1,82 @@
+require_relative 'representation'
+
+module Aptly
+  # Aptly snapshots representation.
+  # @see http://www.aptly.info/doc/api/snapshots/
+  class Snapshot < Representation
+    # Updates this snapshot
+    # @return [self] if the instance data was mutated
+    # @return [nil] if the instance data was not mutated
+    def update!(**kwords)
+      kwords = kwords.map { |k, v| [k.to_s.capitalize, v] }.to_h
+      response = @connection.send(:put,
+                                  "/snapshots/#{self.Name}",
+                                  body: JSON.generate(kwords))
+      hash = JSON.parse(response.body, symbolize_names: true)
+      return nil if hash == marshal_dump
+      marshal_load(hash)
+      self
+    end
+
+    # Delete's this snapshot
+    def delete(**kwords)
+      connection.send(:delete, "/snapshots/#{self.Name}",
+                      query: kwords)
+    end
+
+    # Find differences between this and another snapshot
+    # @param [Snapshot] to diff against
+    # @return [Array<Hash>] diff between the two snashots
+    def diff(other_snapshot)
+      endpoint = "/snapshots/#{self.Name}/diff/#{other_snapshot.Name}"
+      response = @connection.send(:get, endpoint)
+      JSON.parse(response.body)
+    end
+
+    # Search for a package in this snapshot
+    # @return [Array<String>] list of packages found
+    def packages(**kwords)
+      response = connection.send(:get, "/snapshots/#{self.Name}/packages",
+                                 query: kwords,
+                                 query_mangle: false)
+      JSON.parse(response.body)
+    end
+
+    # 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)
+    # @return [PublishedRepository] newly published repository
+    def publish(prefix, **kwords)
+      Aptly.publish([{ Name: self.Name }], prefix, 'snapshot', kwords)
+    end
+
+
+    class << self
+      # List all known snapshots.
+      # @param connection [Connection] connection to use for the instance
+      # @return [Array<Snapshot>] all known snapshots
+      def list(connection = Connection.new, **kwords)
+        response = connection.send(:get, '/snapshots', query: kwords)
+        JSON.parse(response.body).collect { |r| new(connection, r) }
+      end
+
+      # Create a snapshot from package refs
+      # @param name [String] name of new snapshot
+      # @return [Snapshot] representation of new snapshot
+      def create(name, connection = Connection.new, **kwords)
+        kwords = kwords.merge(Name: name)
+        response = connection.send(:post, '/snapshots',
+                                   body: JSON.generate(kwords))
+        new(connection, JSON.parse(response.body))
+      end
+
+      # Get a snapshot by name
+      # @param [String] name of snapshot to get
+      # @return [Snapshot] representation of snapshot if snapshot was found
+      def get(name, connection = Connection.new)
+        response = connection.send(:get, "/snapshots/#{name}")
+        new(connection, JSON.parse(response.body))
+      end
+    end
+  end
+end

data/lib/aptly/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptly-api
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Harald Sitter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,7 @@ files:
 - lib/aptly/publish.rb
 - lib/aptly/repository.rb
 - lib/aptly/representation.rb
+- lib/aptly/snapshot.rb
 - lib/aptly/version.rb
 homepage: https://github.com/KDEJewellers/aptly-api/
 licenses: