artifactory-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60b1ba3ee0e3e8e73c67bf3183837ba477edc2c0
+  data.tar.gz: 8eb5c22de96241ddd66fdafaf58bdcabd97c8da8
+SHA512:
+  metadata.gz: f61eef69170467bd2a829de851d9371da8a76f1b30d76b1a8a261f63f03b7290bec8ed1bfcdb4602caedcf8fa61a5fe2afc701b69afa389a82483a06d7300b3f
+  data.tar.gz: c60c0ba0e330be0105acac73f26a0440bfc5c322ee5313eb9d103ce3faf94e61e4c915c7f4932cef9df08d988dfabd2e9b543e8e791a838662fbe8fa0e24dcc2

data/LICENSE

@@ -0,0 +1,12 @@
+ Copyright 2017 Matteo Cerutti
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.

data/README.md

@@ -0,0 +1,14 @@
+# Ruby client library for JFrog Artifactory REST API
+This is a simple Ruby client library that allows to interact with the JFrog Artifactory REST API.
+
+Pull requests to add additional API features are very welcome. I only implemented what I needed.
+
+## Install
+To install it simply issue the following command:
+
+```
+gem install artifactory-ruby
+```
+
+## Contact
+Matteo Cerutti - matteo.cerutti@hotmail.co.uk

data/lib/artifactory/client.rb

@@ -0,0 +1,226 @@
+#
+# client.rb
+#
+
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'json'
+require 'time'
+
+module Artifactory
+  class Client
+    attr_reader :uri, :http, :basic_auth, :headers
+
+    # Initialize an Artifactory client instance
+    #
+    # @param endpoint [String] Artifactory REST API endpoint
+    # @param username [String] Username for HTTP basic authentication
+    # @param password [String] Password for HTTP basic authentication
+    # @param api_key [String] API key
+    # @param ssl_verify [Boolean] Enable/Disable SSL verification
+    #
+    def initialize(endpoint:, username: nil, password: nil, api_key: nil, ssl_verify: true)
+      basic_auth = {}
+      uri = URI.parse(endpoint)
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if (username and api_key) or (username.nil? and api_key.nil?)
+        raise RuntimeError, "Either HTTP basic or API key are allowed as authentication methods"
+      end
+
+      headers = {
+        'Content-type' => 'application/json',
+        'Accept' => 'application/json',
+      }
+
+      if username
+        basic_auth = {'username' => username, 'password' => password}
+      else
+        headers['X-JFrog-Art-Api'] = api_key
+      end
+
+      if uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless ssl_verify
+      end
+
+      @uri = uri
+      @http = http
+      @basic_auth = basic_auth
+      @headers = headers
+    end
+
+    # Retrieves the current configuration of a repository. Supported by local, remote and virtual repositories.
+    #
+    # @param key [String] Repository key
+    # @return [Hash] Repository information
+    #
+    def get_repo(key:)
+      api_get("/repositories/#{key}").tap { |h| h.delete('key') }
+    end
+
+    # Returns a list of minimal repository details (unless recurse is enabled) for all repositories of the specified type.
+    #
+    # @param type [nil, local, remote, virtual] Optionally filter by repository type
+    # @param recurse [Boolean] Recursively retrieve repos configuration
+    # @return [Hash] List of repositories
+    #
+    def repos(type: nil, recurse: false)
+      ret = {}
+      params = []
+      params << "type=#{type}" if type
+
+      api_get(["/repositories", params.join('&')].join('?')).each do |repo|
+        ret[repo['key']] = recurse ? self.get_repo(key: repo['key']) : repo.tap { |h| h.delete('key') }
+      end
+
+      ret
+    end
+
+    # Lists all Docker repositories hosted in under an Artifactory Docker repository
+    #
+    # @param repo_key [String] Repository key
+    # @param recurse [Boolean] Recursively retrieve image tags
+    # @return [Hash, Array<String>] List of docker images
+    #
+    def docker_images(repo_key:, recurse: false)
+      ret = {}
+      repolist = api_get("/docker/#{repo_key}/v2/_catalog")['repositories']
+
+      if recurse
+        api_get("/docker/#{repo_key}/v2/_catalog")['repositories'].each do |name|
+          ret[name] = self.docker_tags(repo_key: repo_key, image_name: name)
+        end
+      else
+        ret = repolist
+      end
+
+      images
+    end
+
+    # Retrieve all tags for a docker image
+    #
+    # @param repo_key [String] Repository key
+    # @param image_name [String] Docker image name
+    # @return [Array<String>] List of tags
+    #
+    def docker_tags(repo_key:, image_name:)
+      api_get("/docker/#{repo_key}/v2/#{image_name}/tags/list")['tags']
+    end
+
+    # Retrieve a docker image tag manifest
+    #
+    # @param repo_key [String] Repository key
+    # @param image_name [String] Docker image name
+    # @param image_tag [String] Docker image tag
+    # @return [Hash] Docker manifest describing the tag
+    #
+    def docker_manifest(repo_key:, image_name:, image_tag:)
+      api_get("/docker/#{repo_key}/v2/#{image_name}/manifests/#{image_tag}")
+    end
+
+    # Get a flat (the default) or deep listing of the files and folders (not included by default) within a folder
+    #
+    # @param repo_key [String] Repository key
+    # @param image_name [String] Docker image name
+    # @param image_tag [String] Docker image tag
+    # @return [Hash] Docker manifest describing the tag
+    #
+    def file_list(repo_key:, folder_path: '/', deep: false, depth: 0, list_folders: false, md_timestamps: false, include_root_path: false)
+      path = ["/storage", repo_key, folder_path].join('/').chomp('/')
+      params = ['list']
+      params << "deep=#{deep ? 1 : 0}"
+      params << "depth=#{depth}" if depth > 0
+      params << "listFolders=#{list_folders ? 1 : 0}"
+      params << "mdTimestamps=#{md_timestamps ? 1 : 0}"
+      params << "includeRootPath=#{include_root_path ? 1 : 0}"
+
+      files = {}
+      api_get([path, params.join('&')].join('?'))['files'].each do |file|
+        name = file['uri']
+        files[name] = file.tap { |h| h.delete('uri') }
+        files[name]['lastModified'] = Time.parse(files[name]['lastModified'])
+      end
+
+      files
+    end
+
+    # Get file statistics like the number of times an item was downloaded, last download date and last downloader.
+    #
+    # @param repo_key [String] Repository key
+    # @param path [String] Path of the file to look up
+    # @return [Hash] File statistics
+    #
+    def file_stat(repo_key:, path:)
+      p = File.join("/storage", repo_key, path).chomp('/')
+      params = ['stats']
+
+      ret = {}
+      api_get([p, params.join('&')].join('?')).tap { |h| h.delete('uri') }.each do |k, v|
+        case k
+          when "lastDownloaded", "remoteLastDownloaded"
+            ret[k] = Time.at(v/1000) if v > 0
+
+          else
+            ret[k] = v
+        end
+      end
+
+      ret
+    end
+
+    # Deletes a file or a folder from the specified destination
+    #
+    # @param repo_key [String] Repository key
+    # @param path [String] Path of the file to delete
+    #
+    def file_delete(repo_key:, path:)
+      api_delete(File.join(repo_key, path))
+    end
+
+private
+    # Dispatch a GET request to the Artifactory API interface
+    #
+    # @param query [String] HTTP request query
+    # @return Response from the server
+    #
+    def api_get(query)
+      begin
+        req = Net::HTTP::Get.new(File.join(self.uri.path, 'api', query), self.headers)
+        req.basic_auth(self.basic_auth['username'], self.basic_auth['password']) if self.basic_auth
+        resp = self.http.request(req)
+
+        if resp.is_a?(Net::HTTPOK)
+          begin
+            data = JSON.parse(resp.body)
+          rescue JSON::ParserError
+            raise Exception, "Failed to decode response message"
+          end
+        else
+          raise Exception, "Query returned a non successful HTTP code (Code: #{resp.code}, Error: #{resp.message})"
+        end
+      rescue
+        raise Exception, "Failed to execute GET request to Artifactory REST API (#{$!})"
+      end
+
+      data
+    end
+
+    # Dispatch a DELETE request to the Artifactory API interface
+    #
+    # @param query [String] HTTP request query
+    #
+    def api_delete(query)
+      begin
+        req = Net::HTTP::Delete.new(File.join(self.uri.path, 'api', query), self.headers)
+        req.basic_auth(self.basic_auth['username'], self.basic_auth['password']) if self.basic_auth
+        resp = self.http.request(req)
+
+        raise Exception, "Query returned a non successful HTTP code (Code: #{resp.code}, Error: #{resp.message})" unless resp.is_a?(Net::HTTPNoContent)
+      rescue
+        raise Exception, "Failed to execute DELETE request to Artifactory REST API (#{$!})"
+      end
+    end
+  end
+end

data/lib/artifactory/version.rb

@@ -0,0 +1,11 @@
+#
+# version.rb
+#
+
+module Artifactory
+  VERSION = "0.0.1"
+
+  def self.version
+    VERSION
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: artifactory-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.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: 1.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Ruby client library for Kapacitor JSON REST API
+email: matteo.cerutti@hotmail.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/artifactory/client.rb
+- lib/artifactory/version.rb
+homepage: https://github.com/m4ce/artifactory-ruby
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby client library that allows to interact with JFrog Artifactory REST API
+test_files: []