open-build-service-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02f4ce3a2f1f328cead66065db1d5b5ff6b12c54a964d29134905bdabbcc5223
-  data.tar.gz: 857c13405e1b116ac1607a2bf3ce3316db46d47d83fc7910b0f6402a85958409
+  metadata.gz: 3c5e147324f417fe00b366de7fbf147ba8226703afa23629694849d3432d1aea
+  data.tar.gz: 96295d4f01c7f1988e1c491977d96f45a749abab67cb8559238cb3ef63afae1b
 SHA512:
-  metadata.gz: 9013c7b9d55d8bf2ddf3752570d6bc0c2a944728f9a675ac062bfd79ad6cb9142e3dd3d88b74c50592c0c06e306757b120a60889ac7b83794e61c279b2f27d57
-  data.tar.gz: 24f6529b60d5a2bffefd2f705384d4c685d07b5a8b75cde9f0ea83832856e431f84b1cec4960b2083e44c14303d0febbc21170f8f65e65e155e53c9b160109d7
+  metadata.gz: ef3d73d904f39553846c60741c94aa52e3910140ba17ed352d686482e843aee016229aa20817bcb5f8155a889378e3783cd1e06787946c9d67a9e0339a288090
+  data.tar.gz: 57d6e4b7f432b578a8deb7988ddacddd3a718da08390074fa773e6264cacb071adc1163f8481236c460212116c5605fd98c2ae9b4bd813d05994b071cd2d0ae8

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## Version: 0.2.0 (alpha)
+
+- Added `#public_key` method to `Project` model to retrieve a project's public key
+- Added `#delete!` method to `Package` model to allow deletion of packages
+- Added 'Collections' system to act on a dataset like an Array and use API methods as well
+- Added `#rebuild!` method to `Package` model to allow rebuilding of packages
+- Added `#meta` method to `Project` model to obtain a project's meta config file
+- Added `#meta` method to `Package` model to obtain the meta definition of a package
+- Added `#reload!` method to `Package` model to reload the cached data of a package
+- Added `#title` method to `Package` model to obtain the title of a package
+- Added `#description` method to `Package` model to obtain the description of a package
+- Improve output of `#inspect` for `Package` model instances
+
 ## Version: 0.1.0 (alpha)
 
 - Exception `RemoteAPIError` does now store the `error_code` and `error_summary` if it is available

data/lib/collections/abstract_collection.rb

@@ -0,0 +1,27 @@
+module OpenBuildServiceAPI
+  class AbstractCollection
+    include Enumerable
+    extend Forwardable
+
+    def_delegators :@data, :each, :count
+
+    def inspect
+      count = 1
+      output = '['
+
+      @data.each do |item|
+        if count == 30
+          output += item.to_s
+          output += ", ..." if @data.count > 30
+
+          break
+        else
+          output += "#{item}, "
+          count += 1
+        end
+      end
+
+      output += ']'
+    end
+  end
+end

data/lib/collections/packages_collection.rb

@@ -0,0 +1,32 @@
+module OpenBuildServiceAPI
+  class PackagesCollection < AbstractCollection
+    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]
+      @project = params[:project]
+      @data = params[:data] ? params[:data] : []
+    end
+
+    def exists?(name)
+      !!find(name)
+    end
+
+    def find(name)
+      begin
+        package_data = Nokogiri::XML(@connection.send_request(:get, "/source/#{CGI.escape(@project.name)}/#{name}").body)
+        Package.new(name: package_data.root.attr('name'), connection: @connection, project: @project)
+      rescue RequestError => err
+        return if err.error_code == 'unknown_package'
+        raise
+      end
+    end
+
+    def find!(name)
+      package = find(name)
+
+      raise PackageNotFoundError.new("Package '#{name}' does not exist in project '#{@project.name}'.") unless package
+      package
+    end
+  end
+end

data/lib/connection.rb

@@ -47,6 +47,7 @@ module OpenBuildServiceAPI
         request_method.basic_auth(@username, @password)
         request_method.body = request_body if request_body
 
+        puts "[DEBUG] #{uri.to_s}" if ENV['OBS_API_LIBRARY_DEBUG']
         response = request.request(request_method)
 
         raise InternalServerError.new(response) if response.is_a?(Net::HTTPInternalServerError)
@@ -82,11 +83,13 @@ module OpenBuildServiceAPI
 
         if values[index].is_a?(Array)
           values[index].each do |array_value|
-            formatted_params += '&' if formatted_params[-1] != '&' && formatted_params.length > 0
-            formatted_params += "#{CGI.escape(param.to_s)}[]=#{CGI.escape(array_value.to_s)}"
+            if array_value
+              formatted_params += '&' if formatted_params[-1] != '&' && formatted_params.length > 0
+              formatted_params += "#{CGI.escape(param.to_s)}[]=#{CGI.escape(array_value.to_s)}"
+            end
           end
         else
-          formatted_params += "#{CGI.escape(param.to_s)}=#{CGI.escape(values[index].to_s)}"
+          formatted_params += "#{CGI.escape(param.to_s)}=#{CGI.escape(values[index].to_s)}" if values[index]
         end
       end
 

data/lib/exception.rb

@@ -36,8 +36,10 @@ module OpenBuildServiceAPI
   class ProjectCreationFailedError < APIError; end
   class ProjectDeletionPermissionError < APIError; end
   class ProjectAlreadyExistsError < APIError; end
-  class PackageAlreadyExistsError < APIError; end
   class TargetProjectPermissionError < APIError; end
+  class PackageDeletionPermissionError < APIError; end
+  class PackageAlreadyExistsError < APIError; end
+  class PackageNotFoundError < APIError; end
 
   # library specific exceptions
   class GeneralError < Exception; end

data/lib/models/package.rb

@@ -12,5 +12,53 @@ module OpenBuildServiceAPI
     def to_s
       @name
     end
+
+    def title
+      title = meta.xpath('//package/title')
+      title.empty? ? nil : title[0].text
+    end
+
+    def description
+      description = meta.xpath('//package/description')
+      description.empty? ? nil : description[0].text
+    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
+        @meta_reload = false
+      end
+
+      if opts[:no_parse]
+        @cached_meta
+      else
+        Nokogiri::XML(@cached_meta)
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name}:#{"0x00%x" % (object_id << 1)} @name=\"#{@name}\", @project=\"#{@project.name}\">"
+    end
+
+    def rebuild!(repository=nil, arch=nil)
+      @connection.send_request(:post, "/build/#{CGI.escape(@project.name)}", cmd: :rebuild, package: @name, repository: repository, arch: arch)
+      true
+    end
+
+    def delete!(message=nil)
+      begin
+        @connection.send_request(:delete, "/source/#{CGI.escape(@project.name)}/#{CGI.escape(@name)}", comment: message)
+      rescue RequestError => err
+        raise PackageDeletionPermissionError.new("No permission to delete package '#{@name}' in project " \
+                                                 "'#{@project.name}'.") if err.error_code == 'delete_package_no_permission'
+        raise
+      end
+
+      true
+    end
+
+    def reload!
+      @meta_reload = true
+    end
   end
 end

data/lib/models/project.rb

@@ -12,6 +12,19 @@ module OpenBuildServiceAPI
       @name
     end
 
+    def meta(opts = {})
+      if !@cached_meta || @meta_reload
+        @cached_meta = @connection.send_request(:get, "/source/#{CGI.escape(@name)}/_meta").body
+        @meta_reload = false
+      end
+
+      if opts[:no_parse]
+        @cached_meta
+      else
+        Nokogiri::XML(@cached_meta)
+      end
+    end
+
     def delete!(message=nil)
       begin
         @connection.send_request(:delete, "/source/#{CGI.escape(@name)}", comment: message)
@@ -26,14 +39,15 @@ module OpenBuildServiceAPI
     def packages
       return @cached_packages if @cached_packages && !@package_reload
       @package_reload = false
-      @cached_packages = []
+
+      collection_data = []
 
       packages = Nokogiri::XML(@connection.send_request(:get, "/source/#{CGI.escape(@name)}").body)
       packages.xpath('//entry').each do |package|
-        @cached_packages << Package.new(name: package.attr('name'), connection: @connection, project: self)
+        collection_data << Package.new(name: package.attr('name'), connection: @connection, project: self)
       end
 
-      @cached_packages
+      @cached_packages = PackagesCollection.new(connection: @connection, project: self, data: collection_data)
     end
 
     def branch_package(source_project, source_package, package_name_after_branch=nil)
@@ -55,8 +69,18 @@ module OpenBuildServiceAPI
       end
     end
 
+    def public_key
+      @cached_public_key if @cached_public_key && !@public_key_reload
+      @public_key_reload = false
+
+      response = @connection.send_request(:get, "/source/#{CGI.escape(@name)}/_pubkey")
+      response.body
+    end
+
     def reload!
       @package_reload = true
+      @public_key_reload = true
+      @meta_reload = true
     end
   end
 end

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

@@ -1,5 +1,6 @@
 require 'cgi'
 require 'date'
+require 'forwardable'
 require 'net/http'
 require 'nokogiri'
 require_relative 'version'
@@ -10,6 +11,10 @@ require_relative 'connection'
 require_relative 'api/about'
 require_relative 'api/projects'
 
+# Collections
+require_relative 'collections/abstract_collection'
+require_relative 'collections/packages_collection'
+
 # Models
 require_relative 'models/package'
 require_relative 'models/project'

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open-build-service-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Manuel Schnitzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-15 00:00:00.000000000 Z
+date: 2019-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: date
@@ -30,6 +30,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: forwardable
+  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: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +90,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 description: The Open Build Service API wrapped into a Ruby gem.
 email: webmaster@mschnitzer.de
 executables: []
@@ -80,6 +120,8 @@ files:
 - README.md
 - lib/api/about.rb
 - lib/api/projects.rb
+- lib/collections/abstract_collection.rb
+- lib/collections/packages_collection.rb
 - lib/connection.rb
 - lib/exception.rb
 - lib/models/package.rb