ronan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e912fb24f81dd1409d897a08a722c9ddeb4f815267ea96088f3cb77ff309701a
+  data.tar.gz: 3b42c314a1db12ce41d005a2e5fef829e0b6d9622a1bb8a046b427f9af6e5926
+SHA512:
+  metadata.gz: c6ac36ca67419b25187eb8c7462e99cbca0641626c7585f5f43f783810623c7ad87a2a5190014631fc9bd3f3aafacab9ce13cd01efa020887262c245ead13a4c
+  data.tar.gz: 81a684d7e6c6692cc0bb171599b6066600d4a0108eb78170237a3cc1948283640e79bafa7f1daf75b909e78ee74337eb93293bd67b46cc6ba5308326249f71fc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ronan.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    ronan (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    debase (0.2.4.1)
+      debase-ruby_core_source (>= 0.10.2)
+    debase-ruby_core_source (0.10.16)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rspec_junit_formatter (0.5.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    ruby-debug-ide (0.7.3)
+      rake (>= 0.8.1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  debase
+  rake (~> 13.0)
+  ronan!
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.5.1)
+  ruby-debug-ide
+  simplecov (~> 0.21.2)
+  simplecov-cobertura (~> 2.1.0)
+
+BUNDLED WITH
+   2.2.27

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 digitalwerk / services / gems
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Ronan
+
+ronan is a lightweight REST API client for conan servers. It is not intended to be a full replacement of conan itself. Instead this client will only implement simple queries to get information about packages stored in a conan repository (e.g. artifactory). Most common use case at our's has been to get download URLs from an artifactory instance in order to allow users not willing to use conan to download and integrate packages manually.
+
+As there is not much documentation about how conan communicatates with servers, the conan server implentation's routes have been reverse engineered from https://github.com/conan-io/conan/blob/597f14668b3e1b5f0a7a3a0e9d1b0ee1cdfe2666/conans/model/rest_routes.py, so that requests behave like conan itself.
+
+
+[[_TOC_]]
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ronan'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install ronan
+```
+
+
+## Usage
+
+```ruby
+require "ronan"
+
+Ronan.configure do |config|
+  # set remote repository (dw-developer-sdk is open to everyone)
+  config.remote = "https://artifactory.digitalwerk.net/artifactory/api/conan/dw-developer-sdk/"
+end
+
+# search for recipes and take first off the result
+recipe = Ronan::Recipe.search("ddl").first
+
+# get a list of package information for a recipe and take first one
+package = recipe.packages.first
+
+# get all downloads for the package
+downloads = package.downloads
+
+# print out a single download URL for an artifact
+puts downloads.url("conaninfo.txt")
+
+```
+
+
+## Contributing
+
+Bug reports are welcome on [Gitlab](https://gitlab.com/digitalwerk/community/gems/ronan).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "returns version information defined in ronan/version.rb"
+task :version do
+  puts Ronan::VERSION
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ronan"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ci/release.yml

@@ -0,0 +1,23 @@
+# requires environment variable GEM_HOST_API_KEY to be set. content
+# has to be a valid rubygems API key for authentication when publishing the
+# gem to rubygems.org.
+#
+# also requires GIT_REPOSITORY_AUTH in which "access_token_name:access_token"
+# for this git repository is configured.
+release:
+  stage: release
+  rules:
+    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
+      when: manual
+  variables:
+    GIT_REMOTE_URL: ${CI_SERVER_PROTOCOL}://${GIT_REPOSITORY_AUTH}@${CI_SERVER_HOST}:${CI_SERVER_PORT}/${CI_PROJECT_PATH}.git
+  script:
+    - VERSION=$(bundle exec rake version)
+    - bundle exec rake build
+    # remember who is responsible for this release
+    - git config --global user.name "${GITLAB_USER_LOGIN}"
+    - git config --global user.email "${GITLAB_USER_EMAIL}"
+    - git remote add release ${GIT_REMOTE_URL}
+    - git tag ${VERSION}
+    - git push release --tags
+    - gem push pkg/ronan-${VERSION}.gem

data/ci/test.yml

@@ -0,0 +1,15 @@
+test:
+  stage: test
+  coverage: '/\(\d+\.\d+%\)\s+covered/'
+  artifacts:
+    when: always
+    paths:
+      - ci/reports
+    reports:
+      junit: ci/reports/rspec-report.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: ci/reports/coverage/coverage.xml
+  script:
+    - bundle exec rspec
+    - bundle exec rspec --format progress --format RspecJunitFormatter --out ci/reports/rspec-report.xml

data/lib/ronan/base.rb

@@ -0,0 +1,47 @@
+require "net/http"
+
+module Ronan
+  class Base
+    attr_accessor :attributes
+
+    def self.get(path, symbolize: true, **params, &block)
+      uri = build_uri(path, params)
+      res = Net::HTTP.get_response(uri)
+      raise HttpError.new(res) unless res.is_a?(Net::HTTPSuccess)
+      deserialize(res.body, symbolize: symbolize, &block)
+    end
+
+    def initialize(**attributes)
+      self.attributes = attributes
+    end
+
+    def method_missing(method, *args)
+      method = method.to_sym unless method.is_a?(Symbol)
+      return attributes[method] || super
+    end
+
+    private
+      def self.deserialize(body, symbolize: true, &block)
+        parsed = JSON.parse(body, symbolize_names: symbolize)
+        if block.nil?
+          self.new(**parsed)
+        else
+          hash_or_array = block.call(parsed)
+          if hash_or_array.is_a?(Array)
+            hash_or_array.map do |a|
+              self.new(**a)
+            end
+          else
+            self.new(**hash_or_array)
+          end
+        end
+      end
+
+      def self.build_uri(path, params={})
+        path = "/" + path unless path.start_with?("/")
+        uri = URI(Ronan.cfg.remote + path)
+        uri.query = URI.encode_www_form(params)
+        uri
+      end
+  end
+end

data/lib/ronan/configuration.rb

@@ -0,0 +1,10 @@
+module Ronan
+  class Configuration
+    attr_reader :remote
+
+    def remote=(value)
+      value = value[0..-2] if value.end_with?("/")
+      @remote = value
+    end
+  end
+end

data/lib/ronan/downloads.rb

@@ -0,0 +1,18 @@
+module Ronan
+  class Downloads < Base
+    def self.where(package: nil)
+      name = package.recipe.name
+      version = package.recipe.version
+      user = package.recipe.user
+      channel = package.recipe.channel
+      revision = package.revision
+      get("/v1/conans/#{name}/#{version}/#{user}/#{channel}/packages/#{revision}/download_urls", symbolize: false) do |attributes|
+        {package: package, artifacts: attributes}
+      end
+    end
+
+    def url(name)
+      artifacts[name]
+    end
+  end
+end

data/lib/ronan/error.rb

@@ -0,0 +1,30 @@
+require "net/http"
+
+module Ronan
+  class ParseError < StandardError; end
+
+  class HttpError < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      super(response.message)
+      @response = response
+    end
+
+    def message
+      "#{response.message} (#{context})"
+    end
+
+    def context
+      "#{response.uri} responded with #{response.code}"
+    end
+
+    def code
+      response.code
+    end
+
+    def to_s
+      message
+    end
+  end
+end

data/lib/ronan/package.rb

@@ -0,0 +1,57 @@
+module Ronan
+  class Package < Base
+    def self.where(recipe: nil)
+      get("/v1/conans/#{recipe.name}/#{recipe.version}/#{recipe.user}/#{recipe.channel}/search") do |hash|
+        hash.map do |revision, attributes|
+          attributes[:revision] = revision.to_s
+          attributes[:recipe] = recipe
+          attributes
+        end
+      end
+    end
+
+    def downloads
+      @downloads ||= Downloads.where(package: self)
+    end
+
+    def url
+      downloads.url("conan_package.tgz")
+    end
+
+    def filename
+      # settings has keys: :os, :"compiler.libcxx", :arch, :compiler, :build_type, :"compiler.version"
+      name = "#{recipe.name}-#{settings[:os]}-#{settings[:arch]}-#{recipe.version}"
+      if !["any", "release", "relwithdebinfo"].include?(settings[:build_type].downcase)
+        (name << settings[:build_type])
+      end
+      "#{name.downcase}.tgz"
+    end
+
+    def <=>(other)
+      result = self.settings[:os] <=> other.settings[:os]
+      result = self.settings[:arch] <=> other.settings[:arch] if result == 0
+      result = self.settings[:compiler] <=> other.settings[:compiler] if result == 0
+      result = self.settings[:"compiler.version"] <=> other.settings[:"compiler.version"] if result == 0
+      result = self.settings[:"compiler.libcxx"] <=> other.settings[:"compiler.libcxx"] if result == 0
+      result = self.settings[:build_type] <=> other.settings[:build_type] if result == 0
+      result
+    end
+
+    def to_h
+      {
+        settings: settings,
+        options: options,
+        requires: requires,
+        recipe_hash: recipe_hash,
+        revision: revision,
+        recipe: recipe.to_h,
+        filename: filename,
+        url: url
+      }
+    end
+
+    def to_json
+      to_h.to_json
+    end
+  end
+end

data/lib/ronan/recipe.rb

@@ -0,0 +1,43 @@
+module Ronan
+  class Recipe  < Base
+    def self.search(pattern)
+      get("/v2/conans/search", q: pattern) do |hash|
+        hash[:results].map do |r|
+          r.match(/(\S+)\/(\S+)@(\S+)\/(\S+)/) do |m|
+            {
+              name: m[1],
+              version: SemanticVersion.new(m[2]),
+              user: m[3],
+              channel: m[4]
+            }
+          end
+        end
+      end
+    end
+
+    def packages
+      Package.where(recipe: self)
+    end
+
+    def <=>(other)
+      self.version <=> other.version
+    end
+
+    def to_s
+      "#{name}/#{version}@#{user}/#{channel}"
+    end
+
+    def to_h
+      {
+        name: name,
+        version: version.to_s,
+        user: user,
+        channel: channel
+      }
+    end
+
+    def to_json
+      to_h.to_json
+    end
+  end
+end

data/lib/ronan/semantic_version.rb

@@ -0,0 +1,28 @@
+module Ronan
+  class SemanticVersion
+    attr_accessor :major, :minor, :patch
+
+    def initialize(version_str)
+      version_str.match(/(\d+)\.(\d+)\.(\d+)/) do |m|
+        self.major = m[1].to_i
+        self.minor = m[2].to_i
+        self.patch = m[3].to_i
+      end
+    end
+
+    def <=>(other)
+      result = self.major <=> other.major
+      result = self.minor <=> other.minor if result == 0
+      result = self.patch <=> other.patch if result == 0
+      result
+    end
+
+    def ==(other)
+      (self <=> other) == 0
+    end
+
+    def to_s
+      "#{major}.#{minor}.#{patch}"
+    end
+  end
+end

data/lib/ronan/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ronan
+  VERSION = "0.0.1"
+end

data/lib/ronan.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "ronan/version"
+require_relative "ronan/configuration"
+require_relative "ronan/error"
+require_relative "ronan/base"
+require_relative "ronan/downloads"
+require_relative "ronan/package"
+require_relative "ronan/semantic_version"
+require_relative "ronan/recipe"
+
+module Ronan
+  def self.configure
+    yield cfg
+  end
+
+  def self.cfg
+    @configuration ||= Configuration.new
+  end
+end

data/ronan.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/ronan/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ronan"
+  spec.version       = Ronan::VERSION
+  spec.authors       = ["digitalwerk GmbH"]
+  spec.email         = ["contact-project+digitalwerk-community-gems-ronan-37759952-issue-@incoming.gitlab.com"]
+
+  spec.summary       = "Conan client for ruby"
+  spec.description   = "ronan is a client library for accessing conan servers, written in pure ruby. It is not intended as full replacement of conan, but provides means to query information from the server for analysis."
+  spec.homepage      = "https://gitlab.com/digitalwerk/community/gems/ronan.git"
+  spec.required_ruby_version = ">= 2.6.8"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.5.1"
+  spec.add_development_dependency "simplecov", "~> 0.21.2"
+  spec.add_development_dependency "simplecov-cobertura", "~> 2.1.0"
+  spec.add_development_dependency "ruby-debug-ide"
+  spec.add_development_dependency "debase"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: ronan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- digitalwerk GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ronan is a client library for accessing conan servers, written in pure
+  ruby. It is not intended as full replacement of conan, but provides means to query
+  information from the server for analysis.
+email:
+- contact-project+digitalwerk-community-gems-ronan-37759952-issue-@incoming.gitlab.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ci/release.yml
+- ci/test.yml
+- lib/ronan.rb
+- lib/ronan/base.rb
+- lib/ronan/configuration.rb
+- lib/ronan/downloads.rb
+- lib/ronan/error.rb
+- lib/ronan/package.rb
+- lib/ronan/recipe.rb
+- lib/ronan/semantic_version.rb
+- lib/ronan/version.rb
+- ronan.gemspec
+homepage: https://gitlab.com/digitalwerk/community/gems/ronan.git
+licenses: []
+metadata:
+  homepage_uri: https://gitlab.com/digitalwerk/community/gems/ronan.git
+  source_code_uri: https://gitlab.com/digitalwerk/community/gems/ronan.git
+  changelog_uri: https://gitlab.com/digitalwerk/community/gems/ronan.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.17
+signing_key: 
+specification_version: 4
+summary: Conan client for ruby
+test_files: []