open-build-service-api 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bf527982bd90cbc256ebf065939281cf3f6448c3c77ae6de5bccf60e576a01b
-  data.tar.gz: 9de0695570ac504b8b7172cc251dcec5a1712495002c643743d286e1a35e0900
+  metadata.gz: 02f4ce3a2f1f328cead66065db1d5b5ff6b12c54a964d29134905bdabbcc5223
+  data.tar.gz: 857c13405e1b116ac1607a2bf3ce3316db46d47d83fc7910b0f6402a85958409
 SHA512:
-  metadata.gz: 23f3d09d60d92aa116caa2ad2296ed5ef9b6d525aff16e81e64a9c9905cb9f77eb1e91e359b6ac342ac7b1f45192b6abf84b4a7d0da66957f42ec5b30de46a5c
-  data.tar.gz: b9fe7c2dbec2cb50272097637f08236b505662dfc713b6158e0ddd794490716c9b40fa2cbf56bd9777bc077f6b9715c3be013b2ced4c5c9220d7032234508e18
+  metadata.gz: 9013c7b9d55d8bf2ddf3752570d6bc0c2a944728f9a675ac062bfd79ad6cb9142e3dd3d88b74c50592c0c06e306757b120a60889ac7b83794e61c279b2f27d57
+  data.tar.gz: 24f6529b60d5a2bffefd2f705384d4c685d07b5a8b75cde9f0ea83832856e431f84b1cec4960b2083e44c14303d0febbc21170f8f65e65e155e53c9b160109d7

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Version: 0.1.0 (alpha)
+
+- Exception `RemoteAPIError` does now store the `error_code` and `error_summary` if it is available
+- Added a method to allow creation of Open Build Service projects
+- Added `exists?` method to `Projects module in order to check whether a project exists or not
+- Added a `branch_package` method to Project model to allow branching of source packages
+- Added a `delete!` method to Project model to allow deletion of source projects
+
 ## Version: 0.0.2 (alpha)
 
 - Adds `Connection` module to establish a connection with a Build Service instance

data/lib/api/projects.rb

@@ -5,9 +5,29 @@ module OpenBuildServiceAPI
         @connection = connection
       end
 
+      def create(name, meta = nil)
+        raise ProjectAlreadyExistsError.new("Project name '#{name}' has already been taken.") if exists?(name)
+
+        meta = meta ? meta : meta_for_new_project(name)
+
+        begin
+          response = @connection.send_request(:put, "/source/#{CGI.escape(name)}/_meta", request_body: meta)
+        rescue RequestError => err
+          raise ProjectCreationPermissionError.new(err.error_summary) if err.error_code == 'create_project_no_permission'
+          raise
+        end
+
+        return Project.new(projects: self, connection: @connection, name: name) if response.is_a?(Net::HTTPOK)
+        raise ProjectCreationFailedError.new("could not create project. API responded with '#{response.code}': #{response.body}")
+      end
+
       def list
         projects = Nokogiri::XML(@connection.send_request(:get, '/source').body)
-        projects.xpath('//entry').map {|project| Project.new(projects: self, name: project.attr('name')) }
+        projects.xpath('//entry').map {|project| Project.new(projects: self, connection: @connection, name: project.attr('name')) }
+      end
+
+      def exists?(name)
+        !!find(name)
       end
 
       def find(name)
@@ -15,8 +35,10 @@ module OpenBuildServiceAPI
           project_data = Nokogiri::XML(@connection.send_request(:get, "/source/#{CGI.escape(name)}").body)
           packages = project_data.xpath('//entry').map { |package| package.attr('name') }
 
-          Project.new(projects: self, name: name, packages: packages)
-        rescue NotFoundError
+          Project.new(projects: self, name: name, packages: packages, connection: @connection)
+        rescue RequestError => err
+          return if err.error_code == 'unknown_project'
+          raise
         end
       end
 
@@ -26,6 +48,19 @@ module OpenBuildServiceAPI
         raise ProjectNotFoundError.new("Project '#{name}' does not exist.") unless project
         project
       end
+
+      private
+
+      def meta_for_new_project(name)
+        project_meta = Nokogiri::XML::Builder.new do |xml|
+          xml.project('name': name) do
+            xml.title name
+            xml.description
+          end
+        end
+
+        project_meta.to_xml
+      end
     end
   end
 end

data/lib/connection.rb

@@ -13,6 +13,12 @@ module OpenBuildServiceAPI
       send_request(:get, '/')
     end
 
+    def inspect
+      inspected_object = super
+      inspected_object.gsub!(/\@username="([^\"]+)"/, '@username="..."')
+      inspected_object.gsub(/\@password="([^\"]+)"/, '@password="..."')
+    end
+
     def send_request(method, path, params = {})
       request_body = params[:request_body] if params[:request_body]
       params.delete(:request_body)
@@ -31,6 +37,8 @@ module OpenBuildServiceAPI
           request_method = Net::HTTP::Put.new(uri)
         elsif method.to_s.downcase == 'get'
           request_method = Net::HTTP::Get.new(uri)
+        elsif method.to_s.downcase == 'delete'
+          request_method = Net::HTTP::Delete.new(uri)
         end
 
         request_method['Accept'] = 'application/xml'
@@ -42,9 +50,11 @@ module OpenBuildServiceAPI
         response = request.request(request_method)
 
         raise InternalServerError.new(response) if response.is_a?(Net::HTTPInternalServerError)
-        raise NotFoundError.new(response) if response.is_a?(Net::HTTPNotFound)
         raise AuthenticationError.new(response, "Authentication failed. Please check your credentials.") if response.is_a?(Net::HTTPUnauthorized)
 
+        code = response.code.to_i
+        raise RequestError.new(response) if code >= 400
+
         return response
       rescue Errno::ECONNREFUSED, SocketError, Net::OpenTimeout => err
         raise ConnectionError.new(err.to_s)

data/lib/exception.rb

@@ -1,11 +1,23 @@
 module OpenBuildServiceAPI
   # remote API network errors
   class RemoteAPIError < Exception
-    attr_accessor :response, :message
+    attr_accessor :response, :message, :error_code, :error_summary
 
     def initialize(response, message=nil)
+      response_body = response.body
+
       @response = response
-      @message = message ? message : response.body
+      @message = message ? message : response_body
+
+      response_xml = Nokogiri::XML(response_body)
+      status = response_xml.xpath('./status')[0]
+
+      if status
+        @error_code = status.attr('code')
+
+        summary = status.xpath('./summary')
+        @error_summary = summary.text if summary[0]
+      end
     end
 
     def to_s
@@ -15,11 +27,17 @@ module OpenBuildServiceAPI
 
   class InternalServerError < RemoteAPIError; end
   class AuthenticationError < RemoteAPIError; end
-  class NotFoundError < RemoteAPIError; end
+  class RequestError < RemoteAPIError; end
 
   # remote API errors
   class APIError < Exception; end
   class ProjectNotFoundError < APIError; end
+  class ProjectCreationPermissionError < APIError; end
+  class ProjectCreationFailedError < APIError; end
+  class ProjectDeletionPermissionError < APIError; end
+  class ProjectAlreadyExistsError < APIError; end
+  class PackageAlreadyExistsError < APIError; end
+  class TargetProjectPermissionError < APIError; end
 
   # library specific exceptions
   class GeneralError < Exception; end

data/lib/models/package.rb

@@ -0,0 +1,16 @@
+module OpenBuildServiceAPI
+  class Package
+    attr_reader :name
+    attr_accessor :project
+
+    def initialize(params = {})
+      @name = params[:name]
+      @project = params[:project]
+      @connection = params[:connection]
+    end
+
+    def to_s
+      @name
+    end
+  end
+end

data/lib/models/project.rb

@@ -1,15 +1,62 @@
 module OpenBuildServiceAPI
   class Project
-    attr_accessor :name, :projects, :packages
+    attr_accessor :name, :projects
 
     def initialize(params = {})
       @name = params[:name]
       @projects = params[:projects]
-      @packages = params[:packages]
+      @connection = params[:connection]
     end
 
     def to_s
       @name
     end
+
+    def delete!(message=nil)
+      begin
+        @connection.send_request(:delete, "/source/#{CGI.escape(@name)}", comment: message)
+      rescue RequestError => err
+        raise ProjectDeletionPermissionError.new("No permission to delete project '#{@name}'.") if err.error_code == 'delete_project_no_permission'
+        raise
+      end
+
+      true
+    end
+
+    def packages
+      return @cached_packages if @cached_packages && !@package_reload
+      @package_reload = false
+      @cached_packages = []
+
+      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)
+      end
+
+      @cached_packages
+    end
+
+    def branch_package(source_project, source_package, package_name_after_branch=nil)
+      params = { cmd: 'branch', target_project: name }
+      params[:target_package] = package_name_after_branch ? package_name_after_branch : source_package
+
+      begin
+        response = @connection.send_request(:post, "/source/#{CGI.escape(source_project.to_s)}/#{CGI.escape(source_package.to_s)}", params)
+        response_xml = Nokogiri::XML(response.body)
+
+        @package_reload = true
+        Package.new(name: response_xml.xpath('//data[@name="targetpackage"]')[0].text, connection: @connection, project: self)
+      rescue RequestError => err
+        raise PackageAlreadyExistsError.new("Package '#{params[:target_package]}' does already exist " \
+                                            "in project '#{@name}'.") if err.error_code == 'double_branch_package'
+        raise TargetProjectPermissionError.new("Branching to project '#{@name}' is not possible: No " \
+                                               "access in target project.") if err.error_code == 'cmd_execution_no_permission'
+        raise
+      end
+    end
+
+    def reload!
+      @package_reload = true
+    end
   end
 end

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

@@ -11,4 +11,5 @@ require_relative 'api/about'
 require_relative 'api/projects'
 
 # Models
+require_relative 'models/package'
 require_relative 'models/project'

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open-build-service-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Manuel Schnitzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2019-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: date
@@ -50,6 +50,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.0.1
 description: The Open Build Service API wrapped into a Ruby gem.
 email: webmaster@mschnitzer.de
 executables: []
@@ -62,6 +82,7 @@ files:
 - lib/api/projects.rb
 - lib/connection.rb
 - lib/exception.rb
+- lib/models/package.rb
 - lib/models/project.rb
 - lib/open-build-service-api.rb
 - lib/version.rb