artifactory 1.1.0 → 1.2.0

data/lib/artifactory/resources/build.rb

@@ -16,10 +16,11 @@ module Artifactory
       def all(options = {})
         client = extract_client!(options)
         client.get('/api/build')
-      rescue Error::NotFound
+      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
     end

data/lib/artifactory/resources/group.rb

@@ -43,54 +43,10 @@ module Artifactory
 
         response = client.get("/api/security/groups/#{url_safe(name)}")
         from_hash(response, client: client)
-      rescue Error::NotFound
+      rescue Error::HTTPError => e
+        raise unless e.code == 404
         nil
       end
-
-      #
-      # Construct a group from the given URL.
-      #
-      # @example Create an group object from the given URL
-      #   Group.from_url('/security/groups/readers') #=> #<Resource::Group>
-      #
-      # @param [Artifactory::Client] client
-      #   the client object to make the request with
-      # @param [String] url
-      #   the URL to find the group from
-      #
-      # @return [Resource::Group]
-      #
-      def from_url(url, options = {})
-        client = extract_client!(options)
-        from_hash(client.get(url), client: client)
-      end
-
-      #
-      # Create a instance from the given Hash. This method extracts the "safe"
-      # information from the hash and adds them to the instance.
-      #
-      # @example Create a new group from a hash
-      #   Group.from_hash('realmAttributes' => '...', 'name' => '...')
-      #
-      # @param [Artifactory::Client] client
-      #   the client object to make the request with
-      # @param [Hash] hash
-      #   the hash to create the instance from
-      #
-      # @return [Resource::Group]
-      #
-      def from_hash(hash, options = {})
-        client = extract_client!(options)
-
-        new.tap do |instance|
-          instance.auto_join        = hash['autoJoin']
-          instance.client           = client
-          instance.description      = hash['description']
-          instance.name             = hash['name']
-          instance.realm            = hash['realm']
-          instance.realm_attributes = hash['realmAttributes']
-        end
-      end
     end
 
     attribute :auto_join
@@ -107,8 +63,9 @@ module Artifactory
     #   true if the object was deleted successfully, false otherwise
     #
     def delete
-      !!client.delete(api_path)
-    rescue Error::NotFound
+      client.delete(api_path)
+      true
+    rescue Error::HTTPError
       false
     end
 
@@ -122,30 +79,6 @@ module Artifactory
       true
     end
 
-    #
-    # The hash format for this group.
-    #
-    # @return [Hash]
-    #
-    def to_hash
-      {
-        'autoJoin'        => auto_join,
-        'description'     => description,
-        'name'            => name,
-        'realm'           => realm,
-        'realmAttributes' => realm_attributes,
-      }
-    end
-
-    #
-    # The JSON representation of this resource.
-    #
-    # @return [String]
-    #
-    def to_json
-      JSON.fast_generate(to_hash)
-    end
-
     private
 
     #

data/lib/artifactory/resources/layout.rb

@@ -0,0 +1,106 @@
+require 'rexml/document'
+
+module Artifactory
+  class Resource::Layout < Resource::Base
+    class << self
+      #
+      # Get a list of all repository layouts 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::Layout>]
+      #   the list of layouts
+      #
+      def all(options = {})
+        config = Resource::System.configuration(options)
+        list_from_config('config/repoLayouts/repoLayout', config, options)
+      end
+
+      #
+      # Find (fetch) a layout by its name.
+      #
+      # @example Find a layout by its name
+      #   Layout.find('maven-2-default') #=> #<Layout name: 'maven-2-default' ...>
+      #
+      # @param [String] name
+      #   the name of the layout to find
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @option options [Artifactory::Client] :client
+      #   the client object to make the request with
+      #
+      # @return [Resource::Layout, nil]
+      #   an instance of the layout that matches the given name, or +nil+
+      #   if one does not exist
+      #
+      def find(name, options = {})
+        config = Resource::System.configuration(options)
+        find_from_config("config/repoLayouts/repoLayout/name[text()='#{name}']", 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
+      #
+      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 :descriptor_path_pattern
+    attribute :folder_integration_revision_reg_exp
+    attribute :file_integration_revision_reg_exp
+  end
+end

data/lib/artifactory/resources/repository.rb

@@ -16,7 +16,7 @@ module Artifactory
       def all(options = {})
         client = extract_client!(options)
         client.get('/api/repositories').map do |hash|
-          find(name: hash['key'], client: client)
+          find(hash['key'], client: client)
         end.compact
       end
 
@@ -38,50 +38,15 @@ module Artifactory
       #   an instance of the repository that matches the given name, or +nil+
       #   if one does not exist
       #
-      def find(options = {})
+      def find(name, options = {})
         client = extract_client!(options)
-        name   = options[:name]
 
-        result = client.get("/api/repositories/#{url_safe(name)}")
-        from_hash(result, client: client)
-      rescue Error::NotFound
+        response = client.get("/api/repositories/#{url_safe(name)}")
+        from_hash(response, client: client)
+      rescue Error::HTTPError => e
+        raise unless e.code == 400
         nil
       end
-
-      #
-      # Create a instance from the given Hash. This method extracts the "safe"
-      # information from the hash and adds them to the instance.
-      #
-      # @example Create a new resource from a hash
-      #   Repository.from_hash('downloadUri' => '...', 'size' => '...')
-      #
-      # @param [Artifactory::Client] client
-      #   the client object to make the request with
-      # @param [Hash] hash
-      #   the hash to create the instance from
-      #
-      # @return [Resource::Repository]
-      #
-      def from_hash(hash, options = {})
-        client = extract_client!(options)
-
-        new.tap do |instance|
-          instance.blacked_out               = hash['blackedOut']
-          instance.description               = hash['description']
-          instance.checksum_policy           = hash['checksumPolicyType']
-          instance.excludes_pattern          = hash['excludesPattern']
-          instance.handle_releases           = hash['handleReleases']
-          instance.handle_snapshots          = hash['handleSnapshots']
-          instance.includes_pattern          = hash['includesPattern']
-          instance.key                       = hash['key']
-          instance.maximum_unique_snapshots  = hash['maxUniqueSnapshots']
-          instance.notes                     = hash['notes']
-          instance.property_sets             = hash['propertySets']
-          instance.snapshot_version_behavior = hash['snapshotVersionBehavior']
-          instance.suppress_pom_checks       = hash['suppressPomConsistencyChecks']
-          instance.type                      = hash['rclass']
-        end
-      end
     end
 
     attribute :blacked_out, false
@@ -95,57 +60,26 @@ module Artifactory
     attribute :maximum_unique_snapshots, 0
     attribute :notes
     attribute :property_sets, []
+    attribute :repo_layout_ref, 'maven-2-default'
+    attribute :rclass, 'local'
     attribute :snapshot_version_behavior, 'non-unique'
     attribute :suppress_pom_checks, false
-    attribute :type
+
+    def save
+      client.put(api_path, to_json, headers)
+      true
+    end
 
     #
-    # Upload an artifact into the repository. If the first parameter is a File
-    # object, that file descriptor is passed to the uploader. If the first
-    # parameter is a string, it is assumed to be the path to a local file on
-    # disk. This method will automatically construct the File object from the
-    # given path.
+    # Upload to a given repository
     #
-    # @see bit.ly/1dhJRMO Artifactory Matrix Properties
+    # @see Artifact#upload Upload syntax examples
     #
-    # @example Upload an artifact from a File instance
-    #   file = File.new('/local/path/to/file.deb')
-    #   repo = Repository.new('libs-release-local')
-    #   repo.upload(file, 'file.deb')
-    #
-    # @example Upload an artifact from a path
-    #   repo = Repository.new('libs-release-local')
-    #   repo.upload('/local/path/to/file.deb', 'file.deb')
-    #
-    # @example Upload an artifact with matrix properties
-    #   repo = Repository.new('libs-release-local')
-    #   repo.upload('/local/path/to/file.deb', 'file.deb', {
-    #     status: 'DEV',
-    #     rating: 5,
-    #     branch: 'master'
-    #   })
-    #
-    # @param [String, File] path_or_io
-    #   the file or path to the file to upload
-    # @param [String] path
-    #   the path where this resource will live in the remote artifactory
-    #   repository, relative to the current repo
-    # @param [Hash] headers
-    #   the list of headers to send with the request
-    # @param [Hash] properties
-    #   a list of matrix properties
+    # @return [Resource::Artifact]
     #
     def upload(path_or_io, path, properties = {}, headers = {})
-      file = if path_or_io.is_a?(File)
-               path_or_io
-             else
-               File.new(File.expand_path(path_or_io))
-             end
-
-      matrix   = to_matrix_properties(properties)
-      endpoint = File.join("#{url_safe_key}#{matrix}", path)
-
-      client.put(endpoint, { file: file }, headers)
+      artifact = Resource::Artifact.new
+      artifact.upload(key, path_or_io, path, properties, headers)
     end
 
     #
@@ -153,15 +87,7 @@ module Artifactory
     # documentation for the possible responses when the checksums fail to
     # match.
     #
-    # @see Repository#upload More syntax examples
-    #
-    # @example Upload an artifact with a checksum
-    #   repo = Repository.new('libs-release-local')
-    #   repo.upload_with_checksum('/local/file', '/remote/path', 'ABCD1234')
-    #
-    # @param (see Repository#upload)
-    # @param [String] checksum
-    #   the SHA1 checksum of the artifact to upload
+    # @see Artifact#upload More syntax examples
     #
     def upload_with_checksum(path_or_io, path, checksum, properties = {})
       upload(path_or_io, path, properties,
@@ -174,13 +100,7 @@ module Artifactory
     # Upload an artifact with the given archive. Consult the artifactory
     # documentation for the format of the archive to upload.
     #
-    # @see Repository#upload More syntax examples
-    #
-    # @example Upload an artifact with a checksum
-    #   repo = Repositor.new('libs-release-local')
-    #   repo.upload_from_archive('/local/archive', '/remote/path')#
-    #
-    # @param (see Repository#upload)
+    # @see Artifact#upload More syntax examples
     #
     def upload_from_archive(path_or_io, path, properties = {})
       upload(path_or_io, path, properties,
@@ -211,7 +131,7 @@ module Artifactory
     #
     #
     def files
-      response = get("/api/storage/#{url_safe_key}", {
+      response = client.get("/api/storage/#{url_safe(key)}", {
         deep:            0,
         listFolders:     0,
         mdTimestamps:    0,
@@ -221,30 +141,58 @@ module Artifactory
       response['children']
     end
 
+    #
+    # Delete this repository from artifactory, suppressing any +ResourceNotFound+
+    # exceptions might occur.
+    #
+    # @return [Boolean]
+    #   true if the object was deleted successfully, false otherwise
+    #
+    def delete
+      client.delete(api_path)
+      true
+    rescue Error::HTTPError => e
+      false
+    end
+
     private
 
     #
+    # The path to this repository on the server.
     #
+    # @return [String]
     #
-    def url_safe_key
-      @url_safe_key ||= URI.escape(key.to_s)
+    def api_path
+      "/api/repositories/#{url_safe(key)}"
     end
 
     #
-    # @todo Make this a mixin or reusable?
+    # The default headers for this object. This includes the +Content-Type+.
     #
-    def to_matrix_properties(hash = {})
-      properties = hash.map do |k, v|
-        key   = URI.escape(k.to_s)
-        value = URI.escape(v.to_s)
-
-        "#{key}=#{value}"
-      end
+    # @return [Hash]
+    #
+    def headers
+      @headers ||= {
+        'Content-Type' => content_type
+      }
+    end
 
-      if properties.empty?
-        nil
+    #
+    # The default Content-Type for this repository. It varies based on the
+    # repository type.
+    #
+    # @return [String]
+    #
+    def content_type
+      case rclass.to_s.downcase
+      when 'local'
+        'application/vnd.org.jfrog.artifactory.repositories.LocalRepositoryConfiguration+json'
+      when 'remote'
+        'application/vnd.org.jfrog.artifactory.repositories.RemoteRepositoryConfiguration+json'
+      when 'virtual'
+        'application/vnd.org.jfrog.artifactory.repositories.VirtualRepositoryConfiguration+json'
       else
-        ";#{properties.join(';')}"
+        raise "Unknown Repository type `#{rclass}'!"
       end
     end
   end