artifactory 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb987fd18b2034340daf17e7f5d6d06b7289966f
-  data.tar.gz: 5315895f5ab0badfee1351eecfd7d80a701d509c
+  metadata.gz: f36b33be0b821d20e678a3f104b7fd24a41ebd93
+  data.tar.gz: 144d1a14596dd383816dbb47158249a578cf31af
 SHA512:
-  metadata.gz: 56040d7854457cbd0d86712e1ad7e096e539409012ea8e904fe4eda9b8d18ee7f4ad4d31f5f45ec12636c7f8f9c734b40fcbf9e45555d50660b9689db801f993
-  data.tar.gz: 93bdb1b294a58cb73d6bfbcb118090828b25e1dd7ee0cf5e92a00850b6850f16bdf22248a900a62a6338e03b5e3425da78500b047a60157b61d1b106d4fa2402
+  metadata.gz: d85c333c34fa8fcb273ccf4a8fee6598f8e748c310c6f8de1b75c57c793994e5046ff98d37983ecd771a311d81c6c65e92df25b493a82e273a20e237cf7b1720
+  data.tar.gz: 9ea0a6be40e91885a8a1ea63b62a4fa2032c4e751f8536b325e60e7eea783464e2930fdd5821e37110de890952fc685f659ea13b800827dae4d2360ad2bc8cf0

data/CHANGELOG.md

@@ -3,6 +3,10 @@ Artifactory Client CHANGELOG
 This file is used to document the changes between releases of the Artifactory
 Ruby client.
 
+v2.3.0 (08-04-2015)
+-------------------
+- Support for Build endpoints
+
 v2.2.1 (12-16-2014)
 -------------------
 - provide data to post in `Artifact#copy_or_move`

data/README.md

@@ -1,6 +1,6 @@
 Artifactory Client
 ==================
-[![Build Status](https://secure.travis-ci.org/opscode/artifactory-client.png?branch=master)](http://travis-ci.org/opscode/artifactory-client)
+[![Build Status](https://secure.travis-ci.org/chef/artifactory-client.png?branch=master)](http://travis-ci.org/chef/artifactory-client)
 
 A Ruby client and interface to the Artifactory API. **The majority of API endpoints are only exposed for Artifactory Pro customers!** As such, many of the resources and actions exposed by this gem also require Artifactory Pro.
 
@@ -121,8 +121,36 @@ artifact.delete #=> true
 
 #### Builds
 ```ruby
-# Show all builds
-Build.all #=> [#<Build ...>]
+# Show all components
+BuildComponent.all #=> [#<BuildComponent ...>]
+
+# Show all builds for a components
+Build.all('wicket') #=> [#<Build ...>]
+
+# Find a build component by name
+component = BuildComponent.find('wicket')
+
+# Delete some builds for a component
+component.delete(build_numbers: %w( 51 52)) #=> true
+
+# Delete all builds for a component
+component.delete(delete_all: true) #=> true
+
+# Delete a component and all of its associated data (including artifacts)
+component.delete(artifacts: true, delete_all: true) #=> true
+
+# Get a list of all buld records for a component
+component.builds #=> #=> [#<Artifactory::Resource::Build ...>, ...]
+
+# Create a new build record
+build = Build.new(name: 'fricket', number: '51', properties: {...}, modules: [...])
+build.save
+
+# Find a build
+build = Build.find('wicket', '51')
+
+# Promote a build
+build.promote('libs-release-local', status: 'staged', comment: 'Tested on all target platforms.')
 ```
 
 #### Plugins

data/Rakefile

@@ -1,8 +1,12 @@
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:integration)
-RSpec::Core::RakeTask.new(:unit)
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.rspec_opts = "--tag integration"
+end
+RSpec::Core::RakeTask.new(:unit) do |t|
+  t.rspec_opts = "--tag ~integration"
+end
 
 namespace :travis do
   desc 'Run tests on Travis'

data/lib/artifactory.rb

@@ -27,6 +27,7 @@ module Artifactory
   module Collection
     autoload :Artifact, 'artifactory/collections/artifact'
     autoload :Base,     'artifactory/collections/base'
+    autoload :Build, 'artifactory/collections/build'
   end
 
   module Resource
@@ -34,6 +35,7 @@ module Artifactory
     autoload :Backup,           'artifactory/resources/backup'
     autoload :Base,             'artifactory/resources/base'
     autoload :Build,            'artifactory/resources/build'
+    autoload :BuildComponent,   'artifactory/resources/build_component'
     autoload :Group,            'artifactory/resources/group'
     autoload :Layout,           'artifactory/resources/layout'
     autoload :LDAPSetting,      'artifactory/resources/ldap_setting'

data/lib/artifactory/collections/build.rb

@@ -0,0 +1,28 @@
+#
+# Copyright 2015 Chef Software, Inc.
+#
+# 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.
+#
+
+module Artifactory
+  class Collection::Build < Collection::Base
+    #
+    # Create a new build collection.
+    #
+    # @param (see Collection::Base#initialize)
+    #
+    def initialize(parent, options = {}, &block)
+      super(Resource::Build, parent, options, &block)
+    end
+  end
+end

data/lib/artifactory/errors.rb

@@ -40,5 +40,19 @@ module Artifactory
               "running an that your authentication information is correct."
       end
     end
+
+    # A general connection error with a more informative message
+    class InvalidBuildType < ArtifactoryError
+      def initialize(given_type)
+        super <<-EOH
+'#{given_type}' is not a valid build type.
+
+Valid build types include:
+
+    #{Resource::Build::BUILD_TYPES.join("\n    ")}"
+
+EOH
+      end
+    end
   end
 end

data/lib/artifactory/resources/artifact.rb

@@ -663,18 +663,7 @@ module Artifactory
         param[:dry]             = 1 if options[:dry_run]
       end
 
-      # Okay, seriously, WTF Artifactory? Are you fucking serious? You want me
-      # to make a POST request, but you don't actually read the contents of the
-      # POST request, you read the URL-params. Sigh, whoever claimed this was a
-      # RESTful API should seriously consider a new occupation.
-      params = params.map do |k, v|
-        key   = URI.escape(k.to_s)
-        value = URI.escape(v.to_s)
-
-        "#{key}=#{value}"
-      end
-
-      endpoint = File.join('/api', action.to_s, relative_path) + '?' + params.join('&')
+      endpoint = File.join('/api', action.to_s, relative_path) + "?#{to_query_string_parameters(params)}"
 
       client.post(endpoint, {})
     end

data/lib/artifactory/resources/base.rb

@@ -297,7 +297,7 @@ module Artifactory
     def to_hash
       attributes.inject({}) do |hash, (key, value)|
         unless Resource::Base.has_attribute?(key)
-          hash[Util.camelize(key, true)] = value
+          hash[Util.camelize(key, true)] = send(key.to_sym)
         end
 
         hash
@@ -316,7 +316,7 @@ module Artifactory
     end
 
     #
-    # Create URI-escaped string from matrix properties
+    # Create CGI-escaped string from matrix properties
     #
     # @see http://bit.ly/1qeVYQl
     #
@@ -335,6 +335,26 @@ module Artifactory
       end
     end
 
+    #
+    # Create URI-escaped querystring parameters
+    #
+    # @see http://bit.ly/1qeVYQl
+    #
+    def to_query_string_parameters(hash = {})
+      properties = hash.map do |k, v|
+        key   = URI.escape(k.to_s)
+        value = URI.escape(v.to_s)
+
+        "#{key}=#{value}"
+      end
+
+      if properties.empty?
+        nil
+      else
+        properties.join('&')
+      end
+    end
+
     # @private
     def to_s
       "#<#{short_classname}>"

data/lib/artifactory/resources/build.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2014 Chef Software, Inc.
+# Copyright 2015 Chef Software, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,12 +14,20 @@
 # limitations under the License.
 #
 
+require 'time'
+
 module Artifactory
   class Resource::Build < Resource::Base
+    BUILD_SCHEMA_VERSION = '1.0.1'.freeze
+    # valid build types as dictated by the Artifactory API
+    BUILD_TYPES = %w( ANT IVY MAVEN GENERIC GRADLE )
+
     class << self
       #
       # Search for all builds in the system.
       #
+      # @param [String] name
+      #   the name of the build component
       # @param [Hash] options
       #   the list of options
       #
@@ -29,9 +37,13 @@ module Artifactory
       # @return [Array<Resource::Build>]
       #   the list of builds
       #
-      def all(options = {})
+      def all(name, options = {})
         client = extract_client!(options)
-        client.get('/api/build')
+        client.get("/api/build/#{url_safe(name)}")['buildsNumbers'].map do |build_number|
+          # Remove the leading / from the `uri` value. Converts `/484` to `484`.
+          number = build_number['uri'].slice(1..-1)
+          find(name, number, client: client)
+        end.compact.flatten
       rescue Error::HTTPError => e
         # Artifactory returns a 404 instead of an empty list when there are no
         # builds. Whoever decided that was a good idea clearly doesn't
@@ -39,6 +51,179 @@ module Artifactory
         raise unless e.code == 404
         []
       end
+
+      #
+      # Find (fetch) data for a particular build of a component
+      #
+      # @example Find data for a build of a component
+      #   Build.find('wicket', 25) #=> #<Build name: 'wicket' ...>
+      #
+      # @param [String] name
+      #   the name of the build component
+      # @param [String] number
+      #   the number of the build
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @option options [Artifactory::Client] :client
+      #   the client object to make the request with
+      #
+      # @return [Resource::Build, nil]
+      #   an instance of the build that matches the given name/number
+      #   combination, or +nil+ if one does not exist
+      #
+      def find(name, number, options = {})
+        client = extract_client!(options)
+        response = client.get("/api/build/#{url_safe(name)}/#{url_safe(number)}")
+        from_hash(response['buildInfo'], client: client)
+      rescue Error::HTTPError => e
+        raise unless e.code == 404
+        nil
+      end
+
+      #
+      # @see Artifactory::Resource::Base.from_hash
+      #
+      def from_hash(hash, options = {})
+        super.tap do |instance|
+          instance.started = Time.parse(instance.started) rescue nil
+          instance.duration_millis = instance.duration_millis.to_i
+        end
+      end
+    end
+
+    # Based on https://github.com/JFrogDev/build-info/blob/master/README.md#build-info-json-format
+    attribute :properties, {}
+    attribute :version, BUILD_SCHEMA_VERSION
+    attribute :name, ->{ raise 'Build component missing!' }
+    attribute :number, ->{ raise 'Build number missing!' }
+    attribute :type, 'GENERIC'
+    attribute :build_agent, {}
+    attribute :agent, {}
+    attribute :started, Time.now.utc.iso8601(3)
+    attribute :duration_millis
+    attribute :artifactory_principal
+    attribute :url
+    attribute :vcs_revision
+    attribute :vcs_url
+    attribute :license_control, {}
+    attribute :build_retention, {}
+    attribute :modules, []
+    attribute :governance
+
+    #
+    # Compare a build artifacts/dependencies/environment with an older
+    # build to see what has changed (new artifacts added, old dependencies
+    # deleted etc).
+    #
+    # @example List all properties for an artifact
+    #   build.diff(35) #=> { 'artifacts'=>{}, 'dependencies'=>{}, 'properties'=>{} }
+    #
+    # @param [String] previous_build_number
+    #   the number of the previous build to compare against
+    #
+    # @return [Hash<String, Hash>]
+    #   the list of properties
+    #
+    def diff(previous_build_number)
+      endpoint = api_path + '?' "diff=#{url_safe(previous_build_number)}"
+      client.get(endpoint, {})
+    end
+
+    #
+    # Move a build's artifacts to a new repository optionally moving or
+    # copying the build's dependencies to the target repository
+    # and setting properties on promoted artifacts.
+    #
+    # @example promote the build to 'omnibus-stable-local'
+    #   build.promote('omnibus-stable-local')
+    # @example promote a build attaching some new properites
+    #   build.promote('omnibus-stable-local'
+    #     properties: {
+    #       'promoted_by' => 'hipchat:schisamo@chef.io'
+    #     }
+    #   )
+    #
+    # @param [String] target_repo
+    #   repository to move or copy the build's artifacts and/or dependencies
+    # @param [Hash] options
+    #   the list of options to pass
+    #
+    # @option options [String] :status (default: 'promoted')
+    #   new build status (any string)
+    # @option options [String] :comment (default: '')
+    #   an optional comment describing the reason for promotion
+    # @option options [String] :user (default: +Artifactory.username+)
+    #   the user that invoked promotion
+    # @option options [Boolean] :dry_run (default: +false+)
+    #   pretend to do the promotion
+    # @option options [Boolean] :copy (default: +false+)
+    #   whether to copy instead of move
+    # @option options [Boolean] :dependencies (default: +false+)
+    #   whether to move/copy the build's dependencies
+    # @option options [Array] :scopes (default: [])
+    #   an array of dependency scopes to include when "dependencies" is true
+    # @option options [Hash<String, Array<String>>] :properties (default: [])
+    #   a list of properties to attach to the build's artifacts
+    # @option options [Boolean] :fail_fast (default: +true+)
+    #   fail and abort the operation upon receiving an error
+    #
+    # @return [Hash]
+    #   the parsed JSON response from the server
+    #
+    def promote(target_repo, options = {})
+      request_body = {}.tap do |body|
+        body[:status]       = options[:status] || 'promoted'
+        body[:comment]      = options[:comment] || ''
+        body[:ciUser]       = options[:user] || Artifactory.username
+        body[:dryRun]       = options[:dry_run] || false
+        body[:targetRepo]   = target_repo
+        body[:copy]         = options[:copy] || false
+        body[:artifacts]    = true # always move/copy the build's artifacts
+        body[:dependencies] = options[:dependencies] || false
+        body[:scopes]       = options[:scopes] || []
+        body[:properties]   = options[:properties] || {}
+        body[:failFast]     = options[:fail_fast] || true
+      end
+
+      endpoint = "/api/build/promote/#{url_safe(name)}/#{url_safe(number)}"
+      client.post(endpoint, JSON.fast_generate(request_body),
+        'Content-Type' => 'application/json'
+      )
+    end
+
+    #
+    # Creates data about a build.
+    #
+    # @return [Boolean]
+    #
+    def save
+      raise Error::InvalidBuildType.new(type) unless BUILD_TYPES.include?(type)
+
+      file = Tempfile.new("build.json")
+      file.write(to_json)
+      file.rewind
+
+      client.put('/api/build', file,
+        'Content-Type' => 'application/json'
+      )
+      true
+    ensure
+      if file
+        file.close
+        file.unlink
+      end
+    end
+
+    private
+
+    #
+    # The path to this build on the server.
+    #
+    # @return [String]
+    #
+    def api_path
+      "/api/build/#{url_safe(name)}/#{url_safe(number)}"
     end
   end
 end

data/lib/artifactory/resources/build_component.rb

@@ -0,0 +1,160 @@
+#
+# Copyright 2015 Chef Software, Inc.
+#
+# 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.
+#
+
+require 'time'
+
+module Artifactory
+  class Resource::BuildComponent < Resource::Base
+    class << self
+      #
+      # Search for all compoenents for which build data exists.
+      #
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @option options [Artifactory::Client] :client
+      #   the client object to make the request with
+      #
+      # @return [Array<Resource::BuildComponent>]
+      #   the list of builds
+      #
+      def all(options = {})
+        client = extract_client!(options)
+        client.get('/api/build')['builds'].map do |component|
+          from_hash(component, client: client)
+        end.compact.flatten
+      rescue Error::HTTPError => e
+        # Artifactory returns a 404 instead of an empty list when there are no
+        # builds. Whoever decided that was a good idea clearly doesn't
+        # understand the point of REST interfaces...
+        raise unless e.code == 404
+        []
+      end
+
+      #
+      # Find (fetch) data for a particular build component
+      #
+      # @example Find a particular build component
+      #   BuildComponent.find('wicket') #=> #<BuildComponent name: 'wicket' ...>
+      #
+      # @param [String] name
+      #   the name of the build component
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @option options [Artifactory::Client] :client
+      #   the client object to make the request with
+      #
+      # @return [Resource::BuildComponent, nil]
+      #   an instance of the build component that matches the given name,
+      #   or +nil+ if one does not exist
+      #
+      def find(name, options = {})
+        client = extract_client!(options)
+        all.find do |component|
+          component.name == name
+        end
+      end
+
+      #
+      # @see Artifactory::Resource::Base.from_hash
+      #
+      def from_hash(hash, options = {})
+        super.tap do |instance|
+          # Remove the leading / from the `uri` value. Converts `/foo` to `foo`.
+          instance.name = instance.uri.slice(1..-1)
+          instance.last_started = Time.parse(instance.last_started) rescue nil
+        end
+      end
+    end
+
+    attribute :uri
+    attribute :name, ->{ raise 'Name missing!' }
+    attribute :last_started
+
+    #
+    # The list of build data for this component.
+    #
+    # @example Get the list of artifacts for a repository
+    #   component = BuildComponent.new(name: 'wicket')
+    #   component.builds #=> [#<Resource::Build>, ...]
+    #
+    # @return [Collection::Build]
+    #   the list of builds
+    #
+    def builds
+      @builds ||= Collection::Build.new(self, name: name) do
+        Resource::Build.all(name)
+      end
+    end
+
+    #
+    # Remove this component's build data stored in Artifactory
+    #
+    # @option options [Array<String>] :build_numbers (default: nil)
+    #   an array of build numbers that should be deleted; if not given
+    #   all builds (for this component) are deleted
+    # @option options [Boolean] :artifacts (default: +false+)
+    #   if true the component's artifacts are also removed
+    # @option options [Boolean] :delete_all (default: +false+)
+    #   if true the entire component is removed
+    #
+    # @return [Boolean]
+    #   true if the object was deleted successfully, false otherwise
+    #
+    def delete(options = {})
+      params = {}.tap do |param|
+        param[:buildNumbers] = options[:build_numbers].join(',') if options[:build_numbers]
+        param[:artifacts]    = 1 if options[:artifacts]
+        param[:deleteAll]    = 1 if options[:delete_all]
+      end
+
+      endpoint = api_path + "?#{to_query_string_parameters(params)}"
+      client.delete(endpoint, {})
+      true
+    rescue Error::HTTPError => e
+      false
+    end
+
+    #
+    # Rename a build component.
+    #
+    # @param [String] new_name
+    #   new name for the component
+    #
+    # @return [Boolean]
+    #   true if the object was renamed successfully, false otherwise
+    #
+    def rename(new_name, options = {})
+      endpoint = "/api/build/rename/#{url_safe(name)}" + "?to=#{new_name}"
+      client.post(endpoint, {})
+      true
+    rescue Error::HTTPError => e
+      false
+    end
+
+    private
+
+    #
+    # The path to this build component on the server.
+    #
+    # @return [String]
+    #
+    def api_path
+      "/api/build/#{url_safe(name)}"
+    end
+  end
+end