open-build-service-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c5e147324f417fe00b366de7fbf147ba8226703afa23629694849d3432d1aea
-  data.tar.gz: 96295d4f01c7f1988e1c491977d96f45a749abab67cb8559238cb3ef63afae1b
+  metadata.gz: 1f1e3cde838735b8f74df547f7409ad60ded20f5cdd25f6acd8e1328abcc14ad
+  data.tar.gz: 12e82fd311a6ffb074722f12d2edc25bbda0a0a6f89c8147155ed0856bfaa6bc
 SHA512:
-  metadata.gz: ef3d73d904f39553846c60741c94aa52e3910140ba17ed352d686482e843aee016229aa20817bcb5f8155a889378e3783cd1e06787946c9d67a9e0339a288090
-  data.tar.gz: 57d6e4b7f432b578a8deb7988ddacddd3a718da08390074fa773e6264cacb071adc1163f8481236c460212116c5605fd98c2ae9b4bd813d05994b071cd2d0ae8
+  metadata.gz: 1ff27e3f77889b45615a9042a1a8e1f340fe048fc8d64bcef26e1477d1f518089fdeaeb9dc34b18e5187c8d167bdd491c3ad20ee5a6916e2616b8dc16e1708f4
+  data.tar.gz: '019080bdede8c641971efc2f56ed07b4147f0e4eb546fdc8db09eba905688131f66e40c6a89d2a577383a4d87cdf5ab762ad293c24a57e3cc8fdd27ddebd3759'

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## Version: 0.3.0 (alpha)
+
+- Added `#rebuild_failed!` method to `Package` model to rebuild only failed builds
+- Added setter methods for package title and description
+- Added `#dirty?` method to `Package` model to identify if a package needs to be saved
+- Added `#repositories` method to `Project` model to list all build repositories
+- Added `#binaries` method to `Package` model to list all built binaries
+- Added `#run_service!` method to `Package` model to trigger remote services
+- Added `#sources` method to `Package` model to retrieve sources of a package container
+
 ## Version: 0.2.0 (alpha)
 
 - Added `#public_key` method to `Project` model to retrieve a project's public key

data/lib/collections/abstract_collection.rb

@@ -3,7 +3,7 @@ module OpenBuildServiceAPI
     include Enumerable
     extend Forwardable
 
-    def_delegators :@data, :each, :count
+    def_delegators :@data, :each, :count, :empty?
 
     def inspect
       count = 1

data/lib/collections/binaries_collection.rb

@@ -0,0 +1,18 @@
+module OpenBuildServiceAPI
+  class BinariesCollection < AbstractCollection
+    attr_accessor :package
+
+    def initialize(params = {})
+      raise ArgumentError.new('The dataset needs to be provided as an Array.') if params[:data] && !params[:data].is_a?(Array)
+
+      @connection = params[:connection]
+      @package = params[:package]
+      @data = params[:data] ? params[:data] : []
+    end
+
+    def delete_all!
+      @connection.send_request(:post, "/build/#{CGI.escape(@package.project.name)}", cmd: :wipe, package: @package.name)
+      true
+    end
+  end
+end

data/lib/collections/sources_collection.rb

@@ -0,0 +1,13 @@
+module OpenBuildServiceAPI
+  class SourcesCollection < AbstractCollection
+    attr_accessor :package
+
+    def initialize(params = {})
+      raise ArgumentError.new('The dataset needs to be provided as an Array.') if params[:data] && !params[:data].is_a?(Array)
+
+      @connection = params[:connection]
+      @package = params[:package]
+      @data = params[:data] ? params[:data] : []
+    end
+  end
+end

data/lib/exception.rb

@@ -40,9 +40,11 @@ module OpenBuildServiceAPI
   class PackageDeletionPermissionError < APIError; end
   class PackageAlreadyExistsError < APIError; end
   class PackageNotFoundError < APIError; end
+  class NoSourceServiceDefinedError < APIError; end
 
   # library specific exceptions
   class GeneralError < Exception; end
   class ConnectionError < GeneralError; end
   class InvalidHTTPMethodWithBody < GeneralError; end
+  class InvalidDownloadDirectoryPath < GeneralError; end
 end

data/lib/helpers/binary_helper.rb

@@ -0,0 +1,7 @@
+module OpenBuildServiceAPI
+  module BinaryHelper
+    def self.binary_file?(file_name)
+      file_name.end_with?('.rpm') || file_name.end_with?('.deb') || file_name.end_with?('.qcow2')
+    end
+  end
+end

data/lib/models/binary.rb

@@ -0,0 +1,54 @@
+module OpenBuildServiceAPI
+  class Binary
+    attr_reader :name, :size, :created_at, :repository, :architecture, :local_file_path, :local_path
+    attr_accessor :package
+
+    def initialize(params = {})
+      raise ArgumentError.new('repository needs to be an instance of OpenBuildServiceAPI::Repository') unless params[:repository].is_a?(Repository)
+
+      @name = params[:name]
+      @size = Filesize.from(params[:size])
+      @created_at = Time.at(params[:created_at])
+      @repository = params[:repository]
+      @architecture = params[:architecture]
+      @package = params[:package]
+      @connection = params[:connection]
+    end
+
+    def to_s
+      @name
+    end
+
+    def download(destination=nil)
+      delete_local_copy!
+
+      if destination
+        raise InvalidDownloadDirectoryPath.new("Path '#{destination}' is not a directory.") unless File.directory?(destination)
+
+        destination = destination[0..-2] if destination.end_with?('/')
+        @tmp_dir = false
+      else
+        destination = Dir.mktmpdir('obs-binary-download')
+        @tmp_dir = true
+      end
+
+      @local_file_path = "#{destination}/#{@name}"
+      @local_path = destination
+
+      response = @connection.send_request(:get, "/build/#{CGI.escape(@package.project.name)}/#{CGI.escape(@repository.to_s)}/" \
+                                          "#{CGI.escape(@architecture)}/#{CGI.escape(@package.name)}/#{CGI.escape(@name)}")
+      File.write(@local_file_path, response.body)
+      @local_file_path
+    end
+
+    def delete_local_copy!
+      return false unless @local_file_path
+      return false unless File.exists?(@local_file_path)
+
+      File.delete(@local_file_path)
+      FileUtils.rm_r(@local_path) if Dir.empty?(@local_path) && @tmp_dir
+
+      true
+    end
+  end
+end

data/lib/models/package.rb

@@ -14,15 +14,43 @@ module OpenBuildServiceAPI
     end
 
     def title
+      return @title_updated if @title_updated
+
       title = meta.xpath('//package/title')
       title.empty? ? nil : title[0].text
     end
 
+    def title=(value)
+      @dirty = true
+      @title_updated = value
+    end
+
     def description
+      return @description_updated if @description_updated
+
       description = meta.xpath('//package/description')
       description.empty? ? nil : description[0].text
     end
 
+    def description=(value)
+      @dirty = true
+      @description_updated = value
+    end
+
+    def run_service!
+      begin
+        @connection.send_request(:post, "/source/#{CGI.escape(@project.name)}/#{CGI.escape(@name)}", cmd: :runservice)
+      rescue RequestError => err
+        if err.error_code == 'not_found' && err.error_summary =~ /no source service defined/
+          raise NoSourceServiceDefinedError.new("Package '#{@name}' in project '#{@project.name}' has no source service defined.")
+        end
+
+        raise
+      end
+
+      true
+    end
+
     def meta(opts = {})
       if !@cached_meta || @meta_reload
         @cached_meta = @connection.send_request(:get, "/source/#{CGI.escape(@project.name)}/#{CGI.escape(@name)}/_meta").body
@@ -36,6 +64,69 @@ module OpenBuildServiceAPI
       end
     end
 
+    def sources
+      return @cached_sources if @cached_sources && !@sources_reload
+      collection_data = []
+
+      response_xml = Nokogiri::XML(@connection.send_request(:get, "/source/#{CGI.escape(@project.name)}/#{CGI.escape(@name)}").body)
+      response_xml.xpath('//entry').each do |file|
+        collection_data << Source.new(
+          name:       file.attr('name'),
+          md5_hash:   file.attr('md5'),
+          size:       file.attr('size'),
+          updated_at: file.attr('mtime').to_i,
+          package:    self,
+          connection: @connection
+        )
+      end
+
+      @sources_reload = false
+      @cached_sources = SourcesCollection.new(data: collection_data, package: self, connection: @connection)
+    end
+
+    def binaries
+      collection_data = []
+
+      @project.repositories.each do |repository|
+        binary_data = { repository: repository, binaries: [] }
+
+        repository.architectures.each do |arch|
+          begin
+            response = @connection.send_request(:get, "/build/#{CGI.escape(@project.name)}/#{CGI.escape(repository.to_s)}/#{CGI.escape(arch)}/#{CGI.escape(@name)}")
+            response_xml = Nokogiri::XML(response.body)
+
+            response_xml.xpath('//binarylist/binary').each do |binary|
+              file_name = binary.attr('filename')
+              file_size = binary.attr('size')
+              created_at = binary.attr('mtime').to_i
+
+              if BinaryHelper.binary_file?(file_name)
+                binary_data[:binaries] << Binary.new(
+                  name:         file_name,
+                  size:         file_size,
+                  architecture: arch,
+                  created_at:   created_at,
+                  repository:   repository,
+                  package:      self,
+                  connection:   @connection
+                )
+              end
+            end
+          rescue RequestError => err
+            # in case the repository does no longer exist, we can ignore it. there are no binaries anyways
+            next if err.error_code == '404' && err.error_summary =~ /has no repository/
+
+            # raise any other error
+            raise
+          end
+        end
+
+        collection_data << binary_data unless binary_data[:binaries].empty?
+      end
+
+      BinariesCollection.new(data: collection_data, connection: @connection, package: self)
+    end
+
     def inspect
       "#<#{self.class.name}:#{"0x00%x" % (object_id << 1)} @name=\"#{@name}\", @project=\"#{@project.name}\">"
     end
@@ -45,6 +136,39 @@ module OpenBuildServiceAPI
       true
     end
 
+    def rebuild_failed!
+      @connection.send_request(:post, "/build/#{CGI.escape(@project.name)}", cmd: :rebuild, package: @name, code: :failed)
+      true
+    end
+
+    def dirty?
+      !!@dirty
+    end
+
+    def save!
+      return false unless @dirty
+
+      @meta_reload = true
+      meta_xml = meta
+
+      meta_xml.xpath('//package/title')[0].content = @title_updated if @title_updated
+      meta_xml.xpath('//package/description')[0].content = @description_updated if @description_updated
+
+      # update meta definition
+      @connection.send_request(:put, "/source/#{CGI.escape(@project.name)}/#{CGI.escape(@name)}/_meta", request_body: meta_xml.to_xml)
+
+      # reset updated values
+      @dirty = false
+
+      @title_updated = nil
+      @description_updated = nil
+
+      # updated cached meta
+      @cached_meta = meta_xml.to_xml
+
+      true
+    end
+
     def delete!(message=nil)
       begin
         @connection.send_request(:delete, "/source/#{CGI.escape(@project.name)}/#{CGI.escape(@name)}", comment: message)
@@ -59,6 +183,7 @@ module OpenBuildServiceAPI
 
     def reload!
       @meta_reload = true
+      @sources_reload = true
     end
   end
 end

data/lib/models/project.rb

@@ -25,6 +25,29 @@ module OpenBuildServiceAPI
       end
     end
 
+    def repositories
+      collection_data = []
+
+      meta.xpath('//repository').each do |repository|
+        paths = []
+        archs = []
+
+        repository.children.each do |child|
+          if child.is_a?(Nokogiri::XML::Element)
+            if child.name == 'path'
+              paths << { project: child.attr('project'), repository: child.attr('repository') }
+            elsif child.name == 'arch'
+              archs << child.text
+            end
+          end
+        end
+
+        collection_data << Repository.new(name: repository.attr('name'), paths: paths, architectures: archs, connection: @connection, project: self)
+      end
+
+      collection_data
+    end
+
     def delete!(message=nil)
       begin
         @connection.send_request(:delete, "/source/#{CGI.escape(@name)}", comment: message)

data/lib/models/repository.rb

@@ -0,0 +1,25 @@
+module OpenBuildServiceAPI
+  class Repository
+    attr_accessor :name, :project
+
+    def initialize(params = {})
+      @name = params[:name]
+      @paths = params[:paths]
+      @architectures = params[:architectures]
+      @project = params[:project]
+      @connection = params[:connection]
+    end
+
+    def to_s
+      @name
+    end
+
+    def paths
+      @paths
+    end
+
+    def architectures
+      @architectures
+    end
+  end
+end

data/lib/models/source.rb

@@ -0,0 +1,19 @@
+module OpenBuildServiceAPI
+  class Source
+    attr_reader :name, :md5_hash, :size, :updated_at
+    attr_accessor :package
+
+    def initialize(params = {})
+      @name = params[:name]
+      @md5_hash = params[:md5_hash]
+      @size = Filesize.from(params[:size])
+      @updated_at = Time.at(params[:updated_at])
+      @package = params[:package]
+      @connection = params[:connection]
+    end
+
+    def to_s
+      @name
+    end
+  end
+end

data/lib/open-build-service-api.rb

@@ -1,8 +1,11 @@
 require 'cgi'
 require 'date'
+require 'filesize'
+require 'fileutils'
 require 'forwardable'
 require 'net/http'
 require 'nokogiri'
+require 'tmpdir'
 require_relative 'version'
 require_relative 'exception'
 require_relative 'connection'
@@ -11,10 +14,18 @@ require_relative 'connection'
 require_relative 'api/about'
 require_relative 'api/projects'
 
+# Helpers
+require_relative 'helpers/binary_helper'
+
 # Collections
 require_relative 'collections/abstract_collection'
+require_relative 'collections/binaries_collection'
 require_relative 'collections/packages_collection'
+require_relative 'collections/sources_collection'
 
 # Models
+require_relative 'models/binary'
 require_relative 'models/package'
 require_relative 'models/project'
+require_relative 'models/repository'
+require_relative 'models/source'

data/lib/version.rb

@@ -1,4 +1,4 @@
 module OpenBuildServiceAPI
-  VERSION = '0.2.0'
-  RELEASE_DATE = '2019-06-24'
+  VERSION = '0.3.0'
+  RELEASE_DATE = '2019-06-25'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open-build-service-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Manuel Schnitzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-24 00:00:00.000000000 Z
+date: 2019-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: date
@@ -70,6 +70,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: filesize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -121,11 +161,17 @@ files:
 - lib/api/about.rb
 - lib/api/projects.rb
 - lib/collections/abstract_collection.rb
+- lib/collections/binaries_collection.rb
 - lib/collections/packages_collection.rb
+- lib/collections/sources_collection.rb
 - lib/connection.rb
 - lib/exception.rb
+- lib/helpers/binary_helper.rb
+- lib/models/binary.rb
 - lib/models/package.rb
 - lib/models/project.rb
+- lib/models/repository.rb
+- lib/models/source.rb
 - lib/open-build-service-api.rb
 - lib/version.rb
 homepage: https://github.com/mschnitzer/open-build-service-api