artifactory 1.2.0 → 2.0.0

data/lib/artifactory/resources/ldap_setting.rb

@@ -0,0 +1,105 @@
+require 'rexml/document'
+
+module Artifactory
+  class Resource::LDAPSetting < Resource::Base
+    class << self
+      #
+      # Get a list of all ldap settings 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::LDAPSetting>]
+      #   the list of layouts
+      #
+      def all(options = {})
+        config = Resource::System.configuration(options)
+        list_from_config('config/security/ldapSettings/ldapSetting', config, options)
+      end
+
+      #
+      # Find (fetch) an ldap setting by its name.
+      #
+      # @example Find an LDAPSetting by its name.
+      #   ldap_config.find('ldap.example.com') #=> #<MailServer host: 'ldap.example.com' ...>
+      #
+      # @param [String] name
+      #   the name of the ldap config setting to find
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @option options [Artifactory::Client] :client
+      #   the client object to make the request with
+      #
+      # @return [Resource::LDAPSetting, nil]
+      #   an instance of the ldap setting 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/security/ldapSettings/ldapSetting/key[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 = Util.xml_to_hash(r, 'search')
+          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, 'search')
+        from_hash(properties, options)
+      end
+    end
+
+    # Ordered to match the artifactory xsd to make consuming the attributes
+    # hash when writing artifactory xml more convenient.
+    # http://bit.ly/UHMrHc
+    attribute :key, ->{ raise 'name missing!' }
+    attribute :enabled, true
+    attribute :ldap_url
+    attribute :search_filter
+    attribute :search_base
+    attribute :search_sub_tree
+    attribute :manager_dn
+    attribute :manager_password
+    attribute :auto_create_user
+    attribute :email_attribute, 'mail'
+  end
+end

data/lib/artifactory/resources/mail_server.rb

@@ -0,0 +1,61 @@
+require 'rexml/document'
+
+module Artifactory
+  class Resource::MailServer < Resource::Base
+    class << self
+      #
+      # Get a list of all mail servers 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::MailServer>]
+      #   the list of layouts
+      #
+      def all(options = {})
+        config = Resource::System.configuration(options)
+        list_from_config('config/mailServer', config, options)
+      end
+
+      #
+      # Find (fetch) a mail server by its host.
+      #
+      # @example Find a MailServer by its host.
+      #   mail_server.find('smtp.gmail.com') #=> #<MailServer host: 'smtp.gmail.com' ...>
+      #
+      # @param [String] host
+      #   the host of the mail server to find
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @option options [Artifactory::Client] :client
+      #   the client object to make the request with
+      #
+      # @return [Resource::MailServer, nil]
+      #   an instance of the mail server that matches the given host, or +nil+
+      #   if one does not exist
+      #
+      def find(host, options = {})
+        config = Resource::System.configuration(options)
+        find_from_config("config/mailServer/host[text()='#{host}']", config, options)
+      rescue Error::HTTPError => e
+        raise unless e.code == 404
+        nil
+      end
+    end
+
+    attribute :enabled
+    attribute :host, ->{ raise 'host missing!' }
+    attribute :port
+    attribute :username
+    attribute :password
+    attribute :from
+    attribute :subject_prefix
+    attribute :tls
+    attribute :ssl
+    attribute :artifactory_url
+  end
+end

data/lib/artifactory/resources/repository.rb

@@ -77,9 +77,9 @@ module Artifactory
     #
     # @return [Resource::Artifact]
     #
-    def upload(path_or_io, path, properties = {}, headers = {})
-      artifact = Resource::Artifact.new
-      artifact.upload(key, path_or_io, path, properties, headers)
+    def upload(local_path, remote_path, properties = {}, headers = {})
+      artifact = Resource::Artifact.new(local_path: local_path)
+      artifact.upload(key, remote_path, properties, headers)
     end
 
     #
@@ -87,25 +87,22 @@ module Artifactory
     # documentation for the possible responses when the checksums fail to
     # match.
     #
-    # @see Artifact#upload More syntax examples
+    # @see Artifact#upload_with_checksum More syntax examples
     #
-    def upload_with_checksum(path_or_io, path, checksum, properties = {})
-      upload(path_or_io, path, properties,
-        'X-Checksum-Deploy' => true,
-        'X-Checksum-Sha1'   => checksum,
-      )
+    def upload_with_checksum(local_path, remote_path, checksum, properties = {})
+      artifact = Resource::Artifact.new(local_path: local_path)
+      artifact.upload_with_checksum(key, remote_path, checksum, properties)
     end
 
     #
     # Upload an artifact with the given archive. Consult the artifactory
     # documentation for the format of the archive to upload.
     #
-    # @see Artifact#upload More syntax examples
+    # @see Artifact#upload_from_archive More syntax examples
     #
-    def upload_from_archive(path_or_io, path, properties = {})
-      upload(path_or_io, path, properties,
-        'X-Explode-Archive' => true,
-      )
+    def upload_from_archive(local_path, remote_path, properties = {})
+      artifact = Resource::Artifact.new(local_path: local_path)
+      artifact.upload_from_archive(key, remote_path, properties)
     end
 
     #

data/lib/artifactory/resources/url_base.rb

@@ -0,0 +1,74 @@
+require 'rexml/document'
+
+module Artifactory
+  class Resource::URLBase < Resource::Base
+    class << self
+      #
+      # List UrlBase in the system configuration.
+      #
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @option options [Artifactory::Client] :client
+      #   the client object to make the request with
+      #
+      # @return [Array<Resource::URLBase>]
+      #   the list of UrlBases
+      #
+      def all(options = {})
+        config = Resource::System.configuration(options)
+        simple_text_from_config('config/urlBase', config, options)
+      end
+
+      #
+      # Find (fetch) the url base.
+      #
+      # @example Find a URLBase by its url_base.
+      #   url_base.find('http://33.33.33.20/artifactory') #=> #<URLBase url_base: 'http://33.33.33.20/artifactory' ...>
+      #
+      # @param [String] url
+      #   the base url to find
+      # @param [Hash] options
+      #   the list of options
+      #
+      # @option options [Artifactory::Client] :client
+      #   the client object to make the request with
+      #
+      # @return [Resource::MailServer, nil]
+      #   an instance of the mail server that matches the given host, or +nil+
+      #   if one does not exist
+      #
+      def find(url, options = {})
+        config = Resource::System.configuration(options)
+        find_from_config("config/urlBase[text()='#{url}']", config, options)
+      rescue Error::HTTPError => e
+        raise unless e.code == 404
+        nil
+      end
+
+      private
+      #
+      # List all the text elements in the Artifactory configuration file
+      # matching the given xpath.  Ignore any children of elements that match the xpath.
+      #
+      # @param [String] xpath
+      #   xpath expression for which matches are to be listed
+      #
+      # @param [REXML] config
+      #   Artifactory config as an REXML file
+      #
+      # @param [Hash] options
+      #   the list of options
+      #
+      def simple_text_from_config(xpath, config, options = {})
+        REXML::XPath.match(config, xpath).map do |r|
+          hash = {}
+          hash[r.name] = r.text
+          from_hash(hash, options)
+        end
+      end
+    end
+
+    attribute :url_base, ->{ raise 'URL base missing!' }
+  end
+end

data/lib/artifactory/util.rb

@@ -95,5 +95,46 @@ module Artifactory
         hash
       end
     end
+
+    #
+    # Flatten an xml element with at most one child node with children
+    # into a hash.
+    #
+    # @param [REXML] element
+    #   xml element
+    #
+    def xml_to_hash(element, child_with_children = '', unique_children = true)
+      properties = {}
+      element.each_element_with_text do |e|
+        if e.name.eql?(child_with_children)
+          if unique_children
+            e.each_element_with_text do |t|
+              properties[t.name] = to_type(t.text)
+            end
+          else
+            children = []
+            e.each_element_with_text do |t|
+              properties[t.name] = children.push(to_type(t.text))
+            end
+          end
+        else
+          properties[e.name] = to_type(e.text)
+        end
+      end
+      properties
+    end
+
+    def to_type(string)
+      return true if string.eql?('true')
+      return false if string.eql?('false')
+      return string.to_i if numeric?(string)
+      return string
+    end
+
+    private
+
+    def numeric?(string)
+      string.to_i.to_s == string || string.to_f.to_s == string
+    end
   end
 end

data/lib/artifactory/version.rb

@@ -1,3 +1,3 @@
 module Artifactory
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

data/spec/integration/resources/backup.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Artifactory
+  describe Resource::Backup, :integration do
+    describe '.all' do
+      it 'returns an array of Backups' do
+        results = described_class.all
+        expect(results).to be_a(Array)
+        expect(results.first).to be_a(described_class)
+      end
+    end
+
+    describe '.find' do
+      it 'finds a Backup by key' do
+        backup = described_class.find('backup-daily')
+
+        expect(backup).to be_a(described_class)
+        expect(backup.key).to eq('backup-daily')
+      end
+    end
+  end
+end

data/spec/integration/resources/build_spec.rb

@@ -3,9 +3,7 @@ require 'spec_helper'
 module Artifactory
   describe Resource::Build, :integration do
     describe '.all' do
-      it 'returns an array of build objects' do
-        pending 'Need more information about what the Build API returns'
-      end
+      it 'returns an array of build objects'
     end
   end
 end

data/spec/integration/resources/group_spec.rb

@@ -31,14 +31,14 @@ module Artifactory
     describe '#delete' do
       it 'deletes the group from the server' do
         readers = described_class.find('readers')
-        expect(readers.delete).to be_true
+        expect(readers.delete).to be_truthy
       end
     end
 
     describe '#save' do
       it 'saves the group to the server' do
         group = described_class.new(name: 'testing')
-        expect(group.save).to be_true
+        expect(group.save).to be_truthy
       end
     end
   end

data/spec/integration/resources/ldap_setting_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Artifactory
+  describe Resource::LDAPSetting, :integration do
+    describe '.all' do
+      it 'returns an array of LdapSetting' do
+        results = described_class.all
+        expect(results).to be_a(Array)
+        expect(results.first).to be_a(described_class)
+      end
+    end
+
+    describe '.find' do
+      it 'finds an LdapSetting by key' do
+        ldap = described_class.find('example-ldap')
+
+        expect(ldap).to be_a(described_class)
+        expect(ldap.key).to eq('example-ldap')
+      end
+    end
+  end
+end

data/spec/integration/resources/mail_server_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Artifactory
+  describe Resource::MailServer, :integration do
+    describe '.all' do
+      it 'returns an array of MailServer' do
+        results = described_class.all
+        expect(results).to be_a(Array)
+        expect(results.first).to be_a(described_class)
+      end
+    end
+
+    describe '.find' do
+      it 'finds a MailServer by host' do
+        smtp = described_class.find('smtp.gmail.com')
+
+        expect(smtp).to be_a(described_class)
+        expect(smtp.host).to eq('smtp.gmail.com')
+      end
+    end
+  end
+end

data/spec/integration/resources/repository_spec.rb

@@ -13,7 +13,7 @@ module Artifactory
     describe '#save' do
       it 'saves the repository to the server' do
         repository = described_class.new(key: 'libs-testing-local')
-        expect(repository.save).to be_true
+        expect(repository.save).to be_truthy
       end
     end
   end