artifactory 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f140751bb7b38da3e211b0c3fbd7332bb60754f3
-  data.tar.gz: cf32023c6d7ade23e0237828d4a2f25f6c4ed8aa
+  metadata.gz: 096468dc3e965e5a8eccdbc3c0e70e56db2f3e13
+  data.tar.gz: a301449af639917f992d38e3ced4d7215d32612d
 SHA512:
-  metadata.gz: bbc1d3688eee73f034dd8f39c62ad086555aea4345636f2654f428b5d1f89e4b92ee02fbc554187cb42057eaa6d02eb694a82f60afac33cd00987fc033406363
-  data.tar.gz: 139a0c2ac153c5440dae9d6893b081ad7730139f621ce36c393af81cb89d0a116bd6ff85d9395dd2a43017baa0bf2fbc03c811bc01edf41894298ceab4203d4d
+  metadata.gz: f91a4477e6b82e3f2728de0ad4872269e77696e6dbc9195ec4900c27173021a0805ced4da035d8edda721e82ab81f09156616b15208d8d0df860b6fc80aee583
+  data.tar.gz: 4a3eaac28598ff0aee2936795f231b7e2549921131967f4448037ac36021ef595a98aba69ea4c2356b0027cdb9c1811dea7fa865815b77d81a7f671b9a7aa106

data/CHANGELOG.md

@@ -3,6 +3,21 @@ Artifactory Client CHANGELOG
 This file is used to document the changes between releases of the Artifactory
 Ruby client.
 
+v2.0.0 (07-15-2014)
+-------------------
+**Breaking Changes**
+- Change the airity of uploading an Artifact
+- Automatically upload checksum files during Artifact upload
+
+**Other Changes**
+- Bump to RSpec 3
+- Add support for configuring the Backup resource
+- Add support for configuring the LDAPSetting resource
+- Add support for configuring the MailServer resource
+- Add support for configuring the URLBase resource
+- Set `Transfer-Encoding` to "chunked"
+- Do not swallow returned errors from the server
+
 v1.2.0 (2014-06-02)
 -------------------
 - Change the airty of Repository#find to align with other resources

data/Gemfile

@@ -3,6 +3,6 @@ gemspec
 
 group :test do
   gem 'sinatra', '~> 1.4'
-  gem 'rspec',   '~> 2.14'
+  gem 'rspec',   '~> 3.0'
   gem 'webmock', '~> 1.17'
 end

data/lib/artifactory.rb

@@ -14,15 +14,19 @@ module Artifactory
   end
 
   module Resource
-    autoload :Artifact,   'artifactory/resources/artifact'
-    autoload :Base,       'artifactory/resources/base'
-    autoload :Build,      'artifactory/resources/build'
-    autoload :Group,      'artifactory/resources/group'
-    autoload :Layout,     'artifactory/resources/layout'
-    autoload :Plugin,     'artifactory/resources/plugin'
-    autoload :Repository, 'artifactory/resources/repository'
-    autoload :System,     'artifactory/resources/system'
-    autoload :User,       'artifactory/resources/user'
+    autoload :Artifact,     'artifactory/resources/artifact'
+    autoload :Backup,       'artifactory/resources/backup'
+    autoload :Base,         'artifactory/resources/base'
+    autoload :Build,        'artifactory/resources/build'
+    autoload :Group,        'artifactory/resources/group'
+    autoload :Layout,       'artifactory/resources/layout'
+    autoload :LDAPSetting,  'artifactory/resources/ldap_setting'
+    autoload :MailServer,   'artifactory/resources/mail_server'
+    autoload :Plugin,       'artifactory/resources/plugin'
+    autoload :Repository,   'artifactory/resources/repository'
+    autoload :System,       'artifactory/resources/system'
+    autoload :URLBase,      'artifactory/resources/url_base'
+    autoload :User,         'artifactory/resources/user'
   end
 
   class << self

data/lib/artifactory/client.rb

@@ -32,8 +32,12 @@ module Artifactory
     include Artifactory::Configurable
 
     proxy Resource::Artifact
+    proxy Resource::Backup
     proxy Resource::Layout
+    proxy Resource::LDAPSetting
+    proxy Resource::MailServer
     proxy Resource::Repository
+    proxy Resource::URLBase
     proxy Resource::User
     proxy Resource::System
 
@@ -176,6 +180,7 @@ module Artifactory
       # Setup PATCH/POST/PUT
       if [:patch, :post, :put].include?(verb)
         if data.respond_to?(:read)
+          request.add_field('Transfer-Encoding', 'chunked')
           request.body_stream = data
         elsif data.is_a?(Hash)
           request.form_data = data
@@ -337,9 +342,17 @@ module Artifactory
     #   the response object from the request
     #
     def error(response)
-      error = JSON.parse(response.body)['errors'].first
-      raise Error::HTTPError.new(error)
-    rescue JSON::ParserError
+      if (response.content_type || '').include?('json')
+        # Attempt to parse the error as JSON
+        begin
+          json = JSON.parse(response.body)
+
+          if json['errors'] && json['errors'].first
+            raise Error::HTTPError.new(json['errors'].first)
+          end
+        rescue JSON::ParserError; end
+      end
+
       raise Error::HTTPError.new(
         'status'  => response.code,
         'message' => response.body,

data/lib/artifactory/errors.rb

@@ -6,13 +6,12 @@ module Artifactory
     # Class for all HTTP errors
     class HTTPError < ArtifactoryError
       attr_reader :code
-      attr_reader :message
 
       def initialize(hash = {})
         @code = hash['status'].to_i
         @http = hash['message'].to_s
 
-        super "The Artifactory server responded with an HTTP Error "\
+        super "The Artifactory server responded with an HTTP Error " \
               "#{@code}: `#{@http}'"
       end
     end

data/lib/artifactory/resources/artifact.rb

@@ -406,25 +406,20 @@ module Artifactory
     # @see bit.ly/1dhJRMO Artifactory Matrix Properties
     #
     # @example Upload an artifact from a File instance
-    #   file = File.new('/local/path/to/file.deb')
-    #   artifact = Artifact.new
-    #   artifact.upload(file, 'libs-release-local', file.deb')
-    #
-    # @example Upload an artifact from a path
-    #   artifact.upload('/local/path/to/file.deb', 'libs-release-local', 'file.deb')
+    #   artifact = Artifact.new(local_path: '/local/path/to/file.deb')
+    #   artifact.upload('libs-release-local', '/remote/path')
     #
     # @example Upload an artifact with matrix properties
-    #   artifact.upload('/local/path/to/file.deb', 'libs-release-local', file.deb', {
+    #   artifact = Artifact.new(local_path: '/local/path/to/file.deb')
+    #   artifact.upload('libs-release-local', '/remote/path', {
     #     status: 'DEV',
     #     rating: 5,
     #     branch: 'master'
     #   })
     #
-    # @param [String] key
+    # @param [String] repo
     #   the key of the repository to which to upload the file
-    # @param [String, File] path_or_io
-    #   the file or path to the file to upload
-    # @param [String] path
+    # @param [String] remote_path
     #   the path where this resource will live in the remote artifactory
     #   repository, relative to the repository key
     # @param [Hash] headers
@@ -434,20 +429,54 @@ module Artifactory
     #
     # @return [Resource::Artifact]
     #
-    def upload(key, path_or_io, path, properties = {}, headers = {})
-      file = if respond_to?(:read)
-               path_or_io
-             else
-               File.new(File.expand_path(path_or_io))
-             end
-
+    def upload(repo, remote_path, properties = {}, headers = {})
+      file     = File.new(File.expand_path(local_path))
       matrix   = to_matrix_properties(properties)
-      endpoint = File.join("#{url_safe(key)}#{matrix}", path)
+      endpoint = File.join("#{url_safe(repo)}#{matrix}", remote_path)
 
       response = client.put(endpoint, file, headers)
+
+      # Upload checksums if they were given
+      upload_checksum(repo, remote_path, :md5,  md5)  if md5
+      upload_checksum(repo, remote_path, :sha1, sha1) if sha1
+
       self.class.from_hash(response)
     end
 
+    #
+    # Upload the checksum for this artifact. **The artifact must already be
+    # uploaded or Artifactory will throw an exception!**. This is both a public
+    # and private API. It is automatically called in {upload} if the SHA
+    # values are set. You may also call it manually.
+    #
+    # @example Set an artifact's md5
+    #   artifact = Artifact.new(local_path: '/local/path/to/file.deb')
+    #   artifact.upload_checksum('libs-release-local', '/remote/path', :md5, 'ABCD1234')
+    #
+    # @param (see Artifact#upload)
+    # @param [Symbol] type
+    #   the type of checksum to write (+md5+ or +sha1+)
+    # @param [String] value
+    #   the actual checksum
+    #
+    # @return [true]
+    #
+    def upload_checksum(repo, remote_path, type, value)
+      file = Tempfile.new("checksum.#{type}")
+      file.write(value)
+      file.rewind
+
+      endpoint = File.join(url_safe(repo), "#{remote_path}.#{type}")
+
+      client.put(endpoint, file)
+      true
+    ensure
+      if file
+        file.close
+        file.unlink
+      end
+    end
+
     #
     # Upload an artifact with the given SHA checksum. Consult the artifactory
     # documentation for the possible responses when the checksums fail to
@@ -456,15 +485,15 @@ module Artifactory
     # @see Artifact#upload More syntax examples
     #
     # @example Upload an artifact with a checksum
-    #   artifact = Artifact.new
-    #   artifact.upload_with_checksum('/local/file', 'libs-release-local', /remote/path', 'ABCD1234')
+    #   artifact = Artifact.new(local_path: '/local/path/to/file.deb')
+    #   artifact.upload_with_checksum('libs-release-local', /remote/path', 'ABCD1234')
     #
     # @param (see Artifact#upload)
     # @param [String] checksum
     #   the SHA1 checksum of the artifact to upload
     #
-    def upload_with_checksum(key, path_or_io, path, checksum, properties = {})
-      upload(key, path_or_io, path, properties,
+    def upload_with_checksum(repo, remote_path, checksum, properties = {})
+      upload(repo, remote_path, properties,
         'X-Checksum-Deploy' => true,
         'X-Checksum-Sha1'   => checksum,
       )
@@ -477,13 +506,13 @@ module Artifactory
     # @see Artifact#upload More syntax examples
     #
     # @example Upload an artifact with a checksum
-    #   artifact = Artifact.new('libs-release-local')
-    #   artifact.upload_from_archive('/local/archive', '/remote/path')#
+    #   artifact = Artifact.new(local_path: '/local/path/to/file.deb')
+    #   artifact.upload_from_archive('/remote/path')
     #
     # @param (see Repository#upload)
     #
-    def upload_from_archive(key, path_or_io, path, properties = {})
-      upload(key, path_or_io, path, properties,
+    def upload_from_archive(repo, remote_path, properties = {})
+      upload(repo, remote_path, properties,
         'X-Explode-Archive' => true,
       )
     end

data/lib/artifactory/resources/backup.rb

@@ -0,0 +1,104 @@
+require 'rexml/document'
+
+module Artifactory
+  class Resource::Backup < Resource::Base
+    class << self
+      #
+      # Get a list of all backup jobs in the system.
+      #
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @option options [Artifactory::Client] :client
+      #   the client object to make the request with
+      #
+      # @return [Array<Resource::Backup>]
+      #   the list of backup jobs
+      #
+      def all(options = {})
+        config = Resource::System.configuration(options)
+        list_from_config('config/backups/backup', config, options)
+      end
+
+      #
+      # Find (fetch) a backup job by its key.
+      #
+      # @example Find a Backup by its key.
+      #   backup.find('backup-daily') #=> #<Backup key: 'backup-daily' ...>
+      #
+      # @param [String] key
+      #   the name of the backup job to find
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @option options [Artifactory::Client] :client
+      #   the client object to make the request with
+      #
+      # @return [Resource::Backup, nil]
+      #   an instance of the backup job that matches the given key, or +nil+
+      #   if one does not exist
+      #
+      def find(key, options = {})
+        config = Resource::System.configuration(options)
+        find_from_config("config/backups/backup/key[text()='#{key}']", config, options)
+      rescue Error::HTTPError => e
+        raise unless e.code == 404
+        nil
+      end
+
+      private
+
+      #
+      # List all the child text elements in the Artifactory configuration file
+      # of a node matching the specified xpath
+      #
+      # @param [String] xpath
+      #   xpath expression for the parent element whose children are to be listed
+      #
+      # @param [REXML] config
+      #   Artifactory config as an REXML file
+      #
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @return [~Resource::Base]
+      #
+      def list_from_config(xpath, config, options = {})
+        REXML::XPath.match(config, xpath).map do |r|
+          hash = Util.xml_to_hash(r, 'excludedRepositories', false)
+          from_hash(hash, options)
+        end
+      end
+
+      #
+      # Find all the sibling text elements in the Artifactory configuration file
+      # of a node matching the specified xpath
+      #
+      # @param [String] xpath
+      #   xpath expression for the element whose siblings are to be found
+      #
+      # @param [REXML] config
+      #   Artifactory configuration file as an REXML doc
+      #
+      # @param [Hash] options
+      #   the list of options
+      #
+      def find_from_config(xpath, config, options = {})
+        name_node = REXML::XPath.match(config, xpath)
+        return nil if name_node.empty?
+        properties = Util.xml_to_hash(name_node[0].parent, 'excludedRepositories', false)
+        from_hash(properties, options)
+      end
+    end
+
+    attribute :key, ->{ raise 'name missing!' }
+    attribute :enabled, true
+    attribute :dir
+    attribute :cron_exp
+    attribute :retention_period_hours
+    attribute :create_archive
+    attribute :excluded_repositories
+    attribute :send_mail_on_error
+    attribute :exclude_builds
+  end
+end

data/lib/artifactory/resources/base.rb

@@ -91,6 +91,53 @@ module Artifactory
         from_hash(client.get(url), client: client)
       end
 
+      #
+      # List all the child text elements in the Artifactory configuration file
+      # of a node matching the specified xpath
+      #
+      # @param [String] xpath
+      #   xpath expression for the parent element whose children are to be listed
+      #
+      # @param [REXML] config
+      #   Artifactory config as an REXML file
+      #
+      # @param [Hash] options
+      #   the list of options
+      #
+      def list_from_config(xpath, config, options = {})
+        REXML::XPath.match(config, xpath).map do |r|
+          hash = {}
+
+          r.each_element_with_text do |l|
+            hash[l.name] = l.get_text
+          end
+          from_hash(hash, options)
+        end
+      end
+
+      #
+      # Find the text elements matching a giving xpath
+      #
+      # @param [String] xpath
+      #   xpath expression
+      #
+      # @param [REXML] config
+      #   Artifactory configuration file as an REXML doc
+      #
+      # @param [Hash] options
+      #   the list of options
+      #
+      def find_from_config(xpath, config, options = {})
+        name_node = REXML::XPath.match(config, xpath)
+        return nil if name_node.empty?
+        properties = {}
+        name_node[0].parent.each_element_with_text do |e|
+          properties[e.name] = Util.to_type(e.text)
+        end
+
+        from_hash(properties, options)
+      end
+
       #
       # Construct a new object from the hash.
       #

data/lib/artifactory/resources/layout.rb

@@ -45,60 +45,11 @@ module Artifactory
         raise unless e.code == 404
         nil
       end
-
-      private
-      #
-      # List all the child text elements in the Artifactory configuration file
-      # of a node matching the specified xpath
-      #
-      # @param [String] xpath
-      #   xpath expression for the parent element whose children are to be listed
-      #
-      # @param [REXML] config
-      #   Artifactory config as an REXML file
-      #
-      # @param [Hash] options
-      #   the list of options
-      #
-      def list_from_config(xpath, config, options = {})
-        REXML::XPath.match(config, xpath).map do |r|
-          hash = {}
-
-          r.each_element_with_text do |l|
-            hash[l.name] = l.get_text
-          end
-          from_hash(hash, options)
-        end
-      end
-
-      #
-      # Find all the sibling text elements in the Artifactory configuration file
-      # of a node matching the specified xpath
-      #
-      # @param [String] xpath
-      #   xpath expression for the element whose siblings are to be found
-      #
-      # @param [REXML] config
-      #   Artifactory configuration file as an REXML doc
-      #
-      # @param [Hash] options
-      #   the list of options
-      #
-      def find_from_config(xpath, config, options = {})
-        name_node = REXML::XPath.match(config, xpath)
-        return nil if name_node.empty?
-        properties = {}
-        name_node[0].parent.each_element_with_text do |e|
-          properties[e.name] = e.text
-        end
-
-        from_hash(properties, options)
-      end
     end
 
     attribute :name, ->{ raise 'Name missing!' }
     attribute :artifact_path_pattern
-    attribute :distinctive_descriptor_path_pattern, 'true'
+    attribute :distinctive_descriptor_path_pattern, true
     attribute :descriptor_path_pattern
     attribute :folder_integration_revision_reg_exp
     attribute :file_integration_revision_reg_exp