open-build-service-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ae3c8988ffb5be05ac23a83b479fe10eb4b3091b4265d205a9d8479d3f5b73b
-  data.tar.gz: 48212cc3850ca449b7fcd16893d44bcefb9a0e7cdb887843d319f7d1c6c4c6a7
+  metadata.gz: 9bf527982bd90cbc256ebf065939281cf3f6448c3c77ae6de5bccf60e576a01b
+  data.tar.gz: 9de0695570ac504b8b7172cc251dcec5a1712495002c643743d286e1a35e0900
 SHA512:
-  metadata.gz: b372876289fac3af5c3a41d2b06c17b386a33866eb8e47113eb1e1cdd936008a42836e380839ddb0109d82ca2e21e757c7c71ba2b080fe339adbac9a738d8c42
-  data.tar.gz: e22e29039001a171acfda7cf87894837fa70a61b235a4986ed690a04068f688ebb7bab83a8a1069ccbe77d352817e5765371f22b5a14ed165c3751cc4a560b4d
+  metadata.gz: 23f3d09d60d92aa116caa2ad2296ed5ef9b6d525aff16e81e64a9c9905cb9f77eb1e91e359b6ac342ac7b1f45192b6abf84b4a7d0da66957f42ec5b30de46a5c
+  data.tar.gz: b9fe7c2dbec2cb50272097637f08236b505662dfc713b6158e0ddd794490716c9b40fa2cbf56bd9777bc077f6b9715c3be013b2ced4c5c9220d7032234508e18

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## Version: 0.0.2 (alpha)
+
+- Adds `Connection` module to establish a connection with a Build Service instance
+- Adds `About` module to query information about the current Build Service instance
+- Adds `Projects` module to allow searching and listing projects
+- Requires a new dependency: `date` >= 2.0.0
+
+## Version: 0.0.1 (alpha)
+
+- Dummy release to register gem name on https://rubygems.org

data/README.md

@@ -1,2 +1,29 @@
-# open-build-service-api
-The Open Build Service API wrapped into a Ruby gem.
+# Open Build Service API - Library for Ruby
+
+This library is a wrapper for the [Open Build Service API](https://github.com/openSUSE/open-build-service).
+
+## How to Install
+
+It is as simple as it can be:
+```
+gem install open-build-service-api
+```
+
+## How to Use
+
+Please use the following links for references:
+
+- [Wiki](https://github.com/mschnitzer/open-build-service-api/wiki)
+- [Examples](https://github.com/mschnitzer/open-build-service-api/tree/master/examples)
+
+## Contribution
+
+Contribution to this library is highly appreciated. You can work on [issues](https://github.com/mschnitzer/open-build-service-api/issues) at any time and open a pull request. Just clone this repository, do your changes, and open a new pull request.
+
+If you need help, please open a [new issue](https://github.com/mschnitzer/open-build-service-api/issues/new).
+
+## Reporting Bugs
+
+Please report bugs via [GitHub's issue tracker](https://github.com/mschnitzer/open-build-service-api/issues).
+
+Security relevant issues should be reported via email: mschnitzer@suse.com

data/lib/api/about.rb

@@ -0,0 +1,30 @@
+module OpenBuildServiceAPI
+  module API
+    class About
+      attr_reader :title, :description, :revision, :last_deployment, :commit
+
+      def initialize(connection)
+        @connection = connection
+        reload!
+      end
+
+      def reload!
+        response = @connection.send_request(:get, '/about')
+        data = Nokogiri::XML(response.body)
+
+        @title = data.xpath('//about/title').text
+        @description = data.xpath('//about/description').text
+        @revision = data.xpath('//about/revision').text
+        @commit = data.xpath('//about/commit').text
+
+        begin
+          @last_deployment = DateTime.parse(data.xpath('//about/last_deployment').text)
+        rescue ArgumentError
+          @last_deployment = nil
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/api/projects.rb

@@ -0,0 +1,31 @@
+module OpenBuildServiceAPI
+  module API
+    class Projects
+      def initialize(connection)
+        @connection = connection
+      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')) }
+      end
+
+      def find(name)
+        begin
+          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
+        end
+      end
+
+      def find!(name)
+        project = find(name)
+
+        raise ProjectNotFoundError.new("Project '#{name}' does not exist.") unless project
+        project
+      end
+    end
+  end
+end

data/lib/connection.rb

@@ -0,0 +1,86 @@
+module OpenBuildServiceAPI
+  class Connection
+    attr_reader :api_endpoint
+
+    def initialize(username, password, opts = {})
+      @username = username
+      @password = password
+      @api_endpoint = opts[:api_endpoint] ? opts[:api_endpoint] : 'https://api.opensuse.org'
+      @request_timeout = opts[:request_timeout] ? opts[:request_timeout].to_i : 10
+      @ca_file = opts[:ca_file]
+
+      # send a simple request to test authentication - it raises an exception if the credentials are wrong
+      send_request(:get, '/')
+    end
+
+    def send_request(method, path, params = {})
+      request_body = params[:request_body] if params[:request_body]
+      params.delete(:request_body)
+
+      path = "/#{path}" unless path.start_with?('/')
+
+      request_params = "?#{format_params(params)}" unless format_params(params).empty?
+      uri = URI("#{@api_endpoint}#{path}#{request_params}")
+
+      begin
+        request = Net::HTTP.start(uri.host, uri.port, use_ssl: (uri.scheme == 'https'), open_timeout: @request_timeout, ca_file: @ca_file)
+
+        if method.to_s.downcase == 'post'
+          request_method = Net::HTTP::Post.new(uri)
+        elsif method.to_s.downcase == 'put'
+          request_method = Net::HTTP::Put.new(uri)
+        elsif method.to_s.downcase == 'get'
+          request_method = Net::HTTP::Get.new(uri)
+        end
+
+        request_method['Accept'] = 'application/xml'
+        request_method['User-Agent'] = "open-build-service-api (Ruby Gem Version: #{OpenBuildServiceAPI::VERSION})"
+
+        request_method.basic_auth(@username, @password)
+        request_method.body = request_body if request_body
+
+        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)
+
+        return response
+      rescue Errno::ECONNREFUSED, SocketError, Net::OpenTimeout => err
+        raise ConnectionError.new(err.to_s)
+      end
+    end
+
+    def about
+      return @ref_about if @ref_about
+      @ref_about = API::About.new(self)
+    end
+
+    def projects
+      return @ref_projects if @ref_projects
+      @ref_projects = API::Projects.new(self)
+    end
+
+    private
+
+    def format_params(params)
+      values = params.values
+      formatted_params = ""
+
+      params.keys.each_with_index do |param, index|
+        formatted_params += "&" if index != 0
+
+        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)}"
+          end
+        else
+          formatted_params += "#{CGI.escape(param.to_s)}=#{CGI.escape(values[index].to_s)}"
+        end
+      end
+
+      formatted_params
+    end
+  end
+end

data/lib/exception.rb

@@ -0,0 +1,28 @@
+module OpenBuildServiceAPI
+  # remote API network errors
+  class RemoteAPIError < Exception
+    attr_accessor :response, :message
+
+    def initialize(response, message=nil)
+      @response = response
+      @message = message ? message : response.body
+    end
+
+    def to_s
+      @message
+    end
+  end
+
+  class InternalServerError < RemoteAPIError; end
+  class AuthenticationError < RemoteAPIError; end
+  class NotFoundError < RemoteAPIError; end
+
+  # remote API errors
+  class APIError < Exception; end
+  class ProjectNotFoundError < APIError; end
+
+  # library specific exceptions
+  class GeneralError < Exception; end
+  class ConnectionError < GeneralError; end
+  class InvalidHTTPMethodWithBody < GeneralError; end
+end

data/lib/models/project.rb

@@ -0,0 +1,15 @@
+module OpenBuildServiceAPI
+  class Project
+    attr_accessor :name, :projects, :packages
+
+    def initialize(params = {})
+      @name = params[:name]
+      @projects = params[:projects]
+      @packages = params[:packages]
+    end
+
+    def to_s
+      @name
+    end
+  end
+end

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

@@ -1,2 +1,14 @@
+require 'cgi'
+require 'date'
+require 'net/http'
 require 'nokogiri'
 require_relative 'version'
+require_relative 'exception'
+require_relative 'connection'
+
+# OBS API
+require_relative 'api/about'
+require_relative 'api/projects'
+
+# Models
+require_relative 'models/project'

data/lib/version.rb

@@ -1,3 +1,3 @@
 module OpenBuildServiceAPI
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: open-build-service-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Manuel Schnitzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-03 00:00:00.000000000 Z
+date: 2019-06-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: date
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -36,7 +56,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
+- lib/api/about.rb
+- lib/api/projects.rb
+- lib/connection.rb
+- lib/exception.rb
+- lib/models/project.rb
 - lib/open-build-service-api.rb
 - lib/version.rb
 homepage: https://github.com/mschnitzer/open-build-service-api