api-clients 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27349b1c4e24b1f6365753c40b8c6d4eb45808bd77e56af4e2a4452f170a6463
+  data.tar.gz: f3c817aa66b949ffd78d98650eb2f85d59522e0080c6888a70dbf7a036f4727c
+SHA512:
+  metadata.gz: 642b69d625d514bc5d61f7ba4537c76798b508911ecf3adab5cab54486b4ef71d6fbcdf481873d2bddcbe170e8e1a355fdd183ffb0475077dcdeeec11d159ab2
+  data.tar.gz: 71a573c26f8c602e190174f85b8c6d27c92ace795d0b076b61d178a9cade88dd00c993999ad3596281538a44aae0295832fb15217c42ac985e0be8f288c3b03f

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-31
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in api-clients.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "httparty", "~> 0.21.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Joaquin
+
+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,35 @@
+# Api::Clients
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/api/clients`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api-clients.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/api-clients.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/api/clients/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "api-clients"
+  spec.version = Api::Clients::VERSION
+  spec.authors = ["Joaquin Rivera Padron"]
+  spec.email = ["joahking@gmail.com"]
+
+  spec.summary = "API clients for tools like Cortex, Mend, Sonarqube"
+  spec.description = "API clients for tools like Cortex, Mend, Sonarqube to decorate projects with repository data"
+  spec.metadata["homepage_uri"] = "https://rubygems.org/gems/api-clients"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = "https://rubygems.org/gems/api-clients"
+  spec.metadata["source_code_uri"] = "https://github.com/joahking/api-tools"
+  spec.metadata["changelog_uri"] = "https://github.com/joahking/api-tools/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "0.21.0"
+end

data/lib/api/clients/cortex.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+
+# Public: Add gitlab path as info.x-cortex-tag to Cortex service
+
+require 'httparty'
+require 'json'
+require 'yaml'
+
+module Api
+  module Clients
+    class Cortex
+      attr_accessor :gitlab_url
+
+      CORTEX_API = "https://api.cortex.sportradar.ag/api/v1"
+      GITLAB_URL = "https://gitlab.sportradar.ag/"
+
+      API_KEY = ENV["CORTEX_API_KEY"]
+
+      # Public:
+      # - gitlab_url: gitlab project url
+      def initialize(gitlab_url:)
+        @gitlab_url = gitlab_url
+      end
+
+      # Public: service tag in cortex.yaml
+      def service
+        @service ||= config["info"]["x-cortex-tag"]
+      end
+
+      # Public: read the service info on cortex
+      def service_info
+        @service_info ||= get_call(get_service_url)
+      end
+
+      # Public: add gitlab info to cortex service
+      def update_service!
+        return if service_has_gitlab_info?
+        post_call post_service_url, post_body
+      end
+
+      private
+
+      def service_has_gitlab_info?
+        return true if service_gitlab_info == gitlab_path
+        false
+      end
+
+      # Private: gitlab info in cortex service
+      def service_gitlab_info
+        @service_gitlab_info ||= service_info["info"]["x-cortex-git"]["gitlab"]["repository"]
+      end
+
+      def gitlab_path
+        @gitlab_path ||= gitlab_url.gsub(GITLAB_URL, '')
+      end
+
+      def config
+        @config ||= YAML.load_file('cortex.yaml')
+      end
+
+      def get_service_url
+        "#{CORTEX_API}/catalog/#{service}/openapi"
+      end
+
+      def get_call(url)
+        res = HTTParty.get(url,
+                           headers: { 'Authorization' => "Bearer #{API_KEY}" })
+
+        JSON.parse res.body
+      end
+
+      def post_service_url
+        "#{CORTEX_API}/open-api"
+      end
+
+      def post_body
+        @post_body ||= begin
+                         body = config
+                         body["info"] ||= {}
+                         body["info"].merge! gitlab_info
+                         body
+                       end
+      end
+
+      # Private:
+      # - gitlab_path is accepted via API and cortex.yaml, shows ok on UI
+      # - gitlab_url is accepted via API and cortex.yaml, BUT does not show on UI
+      # - gitlab_id is accepted via cortex.yaml BUT not via API, shows ok on UI
+      def gitlab_info
+        {
+          "x-cortex-git" => {
+            "gitlab" => {
+              "repository" => gitlab_path
+            }
+          }
+        }
+      end
+
+      def post_call(url, body)
+        res = HTTParty.post(url,
+                            body: body.to_yaml,
+                            headers: {
+                              'Authorization' => "Bearer #{API_KEY}",
+                              'Content-Type' => 'application/openapi;charset=UTF-8'
+                            })
+
+        JSON.parse res.body
+      end
+    end
+  end
+end

data/lib/api/clients/mend.rb

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+
+# Public: Add gitlab url as tags to Mend project
+
+require 'httparty'
+require 'json'
+
+module Api
+  module Clients
+    class Mend
+      attr_accessor :gitlab_url, :product, :project
+
+      MEND_API = "https://saas.whitesourcesoftware.com/api/v1.4"
+
+      ORG_TOKEN = ENV["MEND_ORG_TOKEN"]
+      USER_KEY = ENV["MEND_USER_KEY"]
+
+      # Public:
+      # - product: product name
+      # - project: project name
+      # - gitlab_url: gitlab project url
+      def initialize(product:, project:, gitlab_url:)
+        @gitlab_url = gitlab_url
+        @product = product
+        @project = project
+      end
+
+      # Public: tag the project with gitlab url
+      def tag_project!
+        save_project_tag tag: "gitlab-url", value: gitlab_url
+      end
+
+      # Public: get project tags
+      def project_tags
+        post_call(get_tags_body)["projectTags"].first["tags"]
+      end
+
+      private
+
+      # Private: return the product token
+      def product_token
+        @product_token ||= fetch_products["products"]
+          .select { |pr| pr["productName"] == @product }
+          .first["productToken"]
+      end
+
+      # Private: return the project token
+      def project_token
+        @project_token ||= fetch_projects["projects"]
+          .select { |pr| pr["projectName"] == @project }
+          .first["projectToken"]
+      end
+
+      def fetch_projects
+        post_call get_projects_body
+      end
+
+      def get_projects_body
+        @get_projects_body ||= {
+          "requestType" => "getAllProjects",
+        }.merge(product_auth)
+      end
+
+      def fetch_products
+        post_call get_products_body
+      end
+
+      def get_products_body
+        @get_products_body ||= {
+          "requestType" => "getAllProducts"
+        }.merge(org_auth)
+      end
+
+      def save_project_tag(tag:, value:)
+        post_call save_tag_body(tag: tag, value: value)
+      end
+
+      def save_tag_body(tag:, value:)
+        {
+          "requestType" => "saveProjectTag",
+          "tagKey" => tag,
+          "tagValue" => value,
+        }.merge(project_auth)
+      end
+
+      def get_tags_body
+        @get_tags_body ||= {
+          "requestType" => "getProjectTags"
+        }.merge(project_auth)
+      end
+
+      # Private: make a post request with body, returns parsed response
+      def post_call(body)
+        res = HTTParty.post(MEND_API,
+                            body: body.to_json,
+                            headers: { 'Content-Type' => 'application/json' })
+
+        JSON.parse res.body
+      end
+
+      def org_auth
+        @org_auth ||= {
+          "userKey" => USER_KEY,
+          "orgToken" => ORG_TOKEN
+        }
+      end
+
+      def product_auth
+        @product_auth ||= {
+          "userKey" => USER_KEY,
+          "productToken" => product_token
+        }
+      end
+
+      def project_auth
+        @project_auth ||= {
+          "userKey" => USER_KEY,
+          "projectToken" => project_token
+        }
+      end
+    end
+  end
+end

data/lib/api/clients/sonarqube.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+# Public: Add gitlab url as link to Sonarqube project
+
+require 'httparty'
+require 'json'
+
+module Api
+  module Clients
+    class Sonarqube
+      attr_accessor :gitlab_url, :project
+
+      SQ_API = "https://sonarqube.sportradar.ag/api"
+      TOKEN = ENV["SQ_TOKEN"]
+      USER = ENV["SQ_USER"]
+
+      # Public:
+      # - project: project key
+      # - gitlab_url: gitlab project url
+      def initialize(project:, gitlab_url:)
+        @gitlab_url = gitlab_url
+        @project = project
+      end
+
+      # Public: create link of project with gitlab's url
+      def link_project!
+        return if project_has_link?
+        post_call save_link_url
+      end
+
+      # Public: get project links
+      def project_links
+        get_call(get_links_url)["links"]
+      end
+
+      private
+
+      def link_name
+        @link_name ||= "gitlab-url"
+      end
+
+      # Private: does project has already link gitlab-url?
+      def project_has_link?
+        project_links.any? { |link| link["name"] == link_name }
+      rescue
+        false
+      end
+
+      def get_links_url
+        @get_links_url ||= "project_links/search?projectKey=#{project}"
+      end
+
+      def save_link_url
+        @save_link_url ||= "project_links/create?projectKey=#{project}&name=#{link_name}&url=#{gitlab_url}"
+      end
+
+      def get_call(url)
+        res = HTTParty.get "#{SQ_API}/#{url}", basic_auth: auth
+        JSON.parse res.body
+      end
+
+      def post_call(url)
+        res = HTTParty.post "#{SQ_API}/#{url}", basic_auth: auth
+        JSON.parse res.body
+      end
+
+      def auth
+        @auth ||= { username: USER, password: TOKEN }
+      end
+
+    end
+  end
+end

data/lib/api/clients/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Api
+  module Clients
+    VERSION = "0.0.1"
+  end
+end

data/lib/api/clients.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "clients/version"
+require_relative "clients/cortex"
+require_relative "clients/mend"
+require_relative "clients/sonarqube"
+
+module Api
+  module Clients
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/sig/api/clients.rbs

@@ -0,0 +1,6 @@
+module Api
+  module Clients
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: api-clients
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joaquin Rivera Padron
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+description: API clients for tools like Cortex, Mend, Sonarqube to decorate projects
+  with repository data
+email:
+- joahking@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api-clients.gemspec
+- lib/api/clients.rb
+- lib/api/clients/cortex.rb
+- lib/api/clients/mend.rb
+- lib/api/clients/sonarqube.rb
+- lib/api/clients/version.rb
+- sig/api/clients.rbs
+homepage: 
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/api-clients
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/joahking/api-tools
+  changelog_uri: https://github.com/joahking/api-tools/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: API clients for tools like Cortex, Mend, Sonarqube
+test_files: []