artifactory 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b8e07b7674ce29c0b313ce8d5be4a551fd007ac
-  data.tar.gz: 37eec0ba96fdb294d4e285977cc0b8d8aec7579a
+  metadata.gz: f140751bb7b38da3e211b0c3fbd7332bb60754f3
+  data.tar.gz: cf32023c6d7ade23e0237828d4a2f25f6c4ed8aa
 SHA512:
-  metadata.gz: e2b460025528de4d36e1addf26d2b32656c05bc68656143c06524afe0ac6bcde325ed85c3f1c63035cf76294d99fe41fe2e474e6a1460984e6885a099ee0218e
-  data.tar.gz: 6e00717ca7b4a2e90185adc6677eb10fa762c912f9406e5003a15c02be13b44146b901399d8fce08f8ec43a268cc8761fe53abe4bec6ca6f872957794adac792
+  metadata.gz: bbc1d3688eee73f034dd8f39c62ad086555aea4345636f2654f428b5d1f89e4b92ee02fbc554187cb42057eaa6d02eb694a82f60afac33cd00987fc033406363
+  data.tar.gz: 139a0c2ac153c5440dae9d6893b081ad7730139f621ce36c393af81cb89d0a116bd6ff85d9395dd2a43017baa0bf2fbc03c811bc01edf41894298ceab4203d4d

data/.travis.yml

@@ -1,20 +1,24 @@
-# Test on modern rubies
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
 
-# Setup parallel downloaders
 bundler_args: --jobs 7
 
-# Only test master (PRs are still tested)
 branches:
   only:
     - master
 
-# Notifications
+script: bundle exec rake travis:ci
+
 notifications:
   hipchat:
+    on_change: true
+    on_failure: true
+    on_success: false
+    on_pull_requests: false
     rooms:
-      - secure: eUtMt0CeB2bbIcTeQA3rUJsTtBkq/Ng5AnM59NOCzutcPTnNDeM4kNQEfgJ5QEZZkx08IXyiPJ14gEQUaV0bF0s0FLyzFxjlX9p2jem99FmEA404KJ7axoUiGGxgATbq9V7tUOrp1zG+a8xVQTahZASKadPlC9TSRgKqjUL+Dvg= # Release Engineering
-      - secure: fQEeBZSIV9mKpM5XeKxmvcgUb19skv3+qW6TiyvuPReB4B/mc5vf3AABWhbdnnHzjsKnq2iQtcppXVG0eJwuRM5D1werMO91zwSRNBU/ClOLHaYBp5l4tVkuHzAd3eo/Z67vxE0BAV9lGWeWv7r3y/BLgJ265nQMyfgZSyz1i44= # Build Statuses
+      # Build Statuses
+      - secure: fQEeBZSIV9mKpM5XeKxmvcgUb19skv3+qW6TiyvuPReB4B/mc5vf3AABWhbdnnHzjsKnq2iQtcppXVG0eJwuRM5D1werMO91zwSRNBU/ClOLHaYBp5l4tVkuHzAd3eo/Z67vxE0BAV9lGWeWv7r3y/BLgJ265nQMyfgZSyz1i44=
+      # Release Engineering
+      - secure: eUtMt0CeB2bbIcTeQA3rUJsTtBkq/Ng5AnM59NOCzutcPTnNDeM4kNQEfgJ5QEZZkx08IXyiPJ14gEQUaV0bF0s0FLyzFxjlX9p2jem99FmEA404KJ7axoUiGGxgATbq9V7tUOrp1zG+a8xVQTahZASKadPlC9TSRgKqjUL+Dvg=

data/CHANGELOG.md

@@ -3,6 +3,24 @@ Artifactory Client CHANGELOG
 This file is used to document the changes between releases of the Artifactory
 Ruby client.
 
+v1.2.0 (2014-06-02)
+-------------------
+- Change the airty of Repository#find to align with other resources
+- Add the ability to save/create repositories
+- Remove i18n
+- Make proxy configuration more verbose
+- Remove HTTPClient in favor of raw Net::HTTP
+- Add custom SSL configuration options
+- Make Configurable#proxy_port a string because #ocd
+- Allow file uploads
+- Return an Artifact object after uploading
+- Allow repositories to be deleted
+- Add required attribute for repository layout
+- Move upload method from Repository to Artifact
+- Implement Repository.upload via Artifact.upload
+- Move to_matrix_properties method to base class
+- Add the ability to list/find repository layouts from xml configuration
+- Specify content-type for updating config
 
 v1.1.0 (2014-02-11)
 -------------------

data/README.md

@@ -6,6 +6,8 @@ A Ruby client and interface to the Artifactory API. **The majority of API endpoi
 
 The Artifactory gem offers a convienent interface for managing various parts of the Artifactory API. It is not a complete API implementation, and should still be considered a work in progress.
 
+This project is managed by the CHEF Release Engineering team. For more information on the Release Engineering team's contribution, triage, and release process, please consult the [CHEF Release Engineering OSS Management Guide](https://docs.google.com/a/opscode.com/document/d/1oJB0vZb_3bl7_ZU2YMDBkMFdL-EWplW1BJv_FXTUOzg/edit).
+
 
 Quick start
 -----------
@@ -54,9 +56,20 @@ Artifactory.configure do |config|
   config.username = 'admin'
   config.password = 'password'
 
+  # Speaking of SSL, you can specify the path to a pem file with your custom
+  # certificates and the gem will wire it all up for you (NOTE: it must be a
+  # valid PEM file).
+  config.ssl_pem_file = '/path/to/my.pem'
+
+  # Or if you are feelying frisky, you can always disable SSL verification
+  config.ssl_verify = false
+
   # You can specify any proxy information, including any authentication
   # information in the URL.
-  config.proxy = 'https://user:password@my.proxy.server'
+  config.proxy_username = 'user'
+  config.proxy_password = 'password'
+  config.proxy_address  = 'my.proxy.server'
+  config.proxy_port     = '8080'
 end
 ```
 
@@ -73,6 +86,7 @@ Or, if you want to be really Unixy, these parameters are all configurable via en
 export ARTIFACTORY_ENDPOINT=http://my.storage.server/artifactory
 export ARTIFACTORY_USERNAME=admin
 export ARTIFACTORY_PASSWORD=password
+export ARTIFACTORY_SSL_PEM_FILE=/path/to/my.pem
 ```
 
 You can also create a full `Client` object with hash parameters:
@@ -82,10 +96,13 @@ client = Artifactory::Client.new(endpoint: '...', username: '...')
 ```
 
 ### Making requests
-The Artifactory gem attempts to make the Artifactory API as object-oriented and Ruby-like as possible. All of the methods and API calls are heavily documented with examples inline using YARD. In order to keep the examples versioned with the code, the README only lists a few examples for using the Artifactory gem. Please see the inline documentation for the full API documentation.
+The Artifactory gem attempts to make the Artifactory API as object-oriented and Ruby-like as possible. All of the methods and API calls are heavily documented with examples inline using YARD. In order to keep the examples versioned with the code, the README only lists a few examples for using the Artifactory gem. Please see the inline documentation for the full API documentation. The tests in the 'spec' directory are an additional source of examples.
 
 #### Artifacts
 ```ruby
+# Upload an artifact to a repository whose key is 'repo_key'
+artifact.upload('/local/path/to/file', 'repo_key', param_1: 'foo')
+
 # Search for an artifact by name
 artifact = Artifact.search(name: 'package.deb').first
 artifact #=> "#<Artifactory::Resource::Artifact md5: 'ABCD1234'>"
@@ -123,6 +140,10 @@ repo #=> #<Artifactory::Resource::Repository ...>
 # Get information about the repository
 repo.description => "The default storage mechanism for..."
 
+# Change the repository
+repo.description = "This is a new description"
+repo.save
+
 # Upload an artifact to the repo
 repo.upload('/local/path/to/file', param_1: 'foo', param_2: 'bar')
 
@@ -155,8 +176,8 @@ client.get('/some/special/path', param_1: 'foo', param_2: 'bar')
 
 For more information on the methods available, please see the [`Artifactory::Client` class](https://github.com/opscode/artifactory-client/blob/master/lib/artifactory/client.rb).
 
-### Theadsafey
-If you plan to use the Artifactory gem in a library, you should be aware that _certain_ pathways for accessing resources is **not** threadsafe. In order to deliver a "Rails-like" experience, accessing a resource without a client object uses a global shared state. Other threads may modify this state, and therefore we do **not** recommend using the Rails-like approach if you are concerned about threadsafety. The following code snippet may better explain the differences:
+### Threadsafety
+If you plan to use the Artifactory gem in a library, you should be aware that _certain_ pathways for accessing resources are **not** threadsafe. In order to deliver a "Rails-like" experience, accessing a resource without a client object uses a global shared state. Other threads may modify this state, and therefore we do **not** recommend using the Rails-like approach if you are concerned about threadsafety. The following code snippet may better explain the differences:
 
 ```ruby
 # In our current thread...

data/Rakefile

@@ -1,6 +1,9 @@
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:unit)
 
-task default: :spec
+namespace :travis do
+  desc 'Run tests on Travis'
+  task :ci => [:unit]
+end

data/artifactory.gemspec

@@ -20,9 +20,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'httpclient', '~> 2.3'
-  spec.add_dependency 'i18n',       '~> 0.5'
-
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
 end

data/lib/artifactory.rb

@@ -1,3 +1,4 @@
+require 'pathname'
 require 'artifactory/version'
 
 module Artifactory
@@ -17,6 +18,7 @@ module Artifactory
     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'
@@ -70,9 +72,5 @@ module Artifactory
   end
 end
 
-require 'i18n'
-I18n.enforce_available_locales = false
-I18n.load_path << Dir[Artifactory.root.join('locales', '*.yml').to_s]
-
 # Load the initial default values
 Artifactory.setup

data/lib/artifactory/client.rb

@@ -1,6 +1,5 @@
-require 'httpclient'
 require 'json'
-require 'rexml/document'
+require 'net/http'
 require 'uri'
 
 module Artifactory
@@ -33,6 +32,7 @@ module Artifactory
     include Artifactory::Configurable
 
     proxy Resource::Artifact
+    proxy Resource::Layout
     proxy Resource::Repository
     proxy Resource::User
     proxy Resource::System
@@ -68,137 +68,245 @@ module Artifactory
     #
     # Make a HTTP GET request
     #
-    # @param [String] path
-    #   the path to get, relative to {Defaults.endpoint}
+    # @param path (see Client#request)
+    # @param [Hash] params
+    #   the list of query params
+    # @param headers (see Client#request)
+    #
+    # @raise (see Client#request)
+    # @return (see Client#request)
     #
-    def get(path, *args, &block)
-      request(:get, path, *args, &block)
+    def get(path, params = {}, headers = {})
+      request(:get, path, params, headers)
     end
 
     #
     # Make a HTTP POST request
     #
-    # @param [String] path
-    #   the path to post, relative to {Defaults.endpoint}
+    # @param path (see Client#request)
+    # @param [String, #read] data
+    #   the body to use for the request
+    # @param headers (see Client#request)
+    #
+    # @raise (see Client#request)
+    # @return (see Client#request)
     #
-    def post(path, *args, &block)
-      request(:post, path, *args, &block)
+    def post(path, data, headers = {})
+      request(:post, path, data, headers)
     end
 
     #
     # Make a HTTP PUT request
     #
-    # @param [String] path
-    #   the path to put, relative to {Defaults.endpoint}
+    # @param path (see Client#request)
+    # @param data (see Client#post)
+    # @param headers (see Client#request)
+    #
+    # @raise (see Client#request)
+    # @return (see Client#request)
     #
-    def put(path, *args, &block)
-      request(:put, path, *args, &block)
+    def put(path, data, headers = {})
+      request(:put, path, data, headers)
     end
 
     #
     # Make a HTTP PATCH request
     #
-    # @param [String] path
-    #   the path to patch, relative to {Defaults.endpoint}
+    # @param path (see Client#request)
+    # @param data (see Client#post)
+    # @param headers (see Client#request)
+    #
+    # @raise (see Client#request)
+    # @return (see Client#request)
     #
-    def patch(path, *args, &block)
-      request(:patch, path, *args, &block)
+    def patch(path, data, headers = {})
+      request(:patch, path, data, headers)
     end
 
     #
     # Make a HTTP DELETE request
     #
-    # @param [String] path
-    #   the path to delete, relative to {Defaults.endpoint}
+    # @param path (see Client#request)
+    # @param params (see Client#get)
+    # @param headers (see Client#request)
+    #
+    # @raise (see Client#request)
+    # @return (see Client#request)
     #
-    def delete(path, *args, &block)
-      request(:delete, path, *args, &block)
+    def delete(path, params = {}, headers = {})
+      request(:delete, path, params, headers)
     end
 
     #
-    # Make a HTTP HEAD request
-    #
-    # @param [String] path
-    #   the path to head, relative to {Defaults.endpoint}
+    # Make an HTTP request with the given verb, data, params, and headers. If
+    # the response has a return type of JSON, the JSON is automatically parsed
+    # and returned as a hash; otherwise it is returned as a string.
     #
-    def head(path, *args, &block)
-      request(:head, path, *args, &block)
-    end
-
+    # @raise [Error::HTTPError]
+    #   if the request is not an HTTP 200 OK
     #
-    # The actually HTTPClient agent.
+    # @param [Symbol] verb
+    #   the lowercase symbol of the HTTP verb (e.g. :get, :delete)
+    # @param [String] path
+    #   the absolute or relative path from {Defaults.endpoint} to make the
+    #   request against
+    # @param [#read, Hash, nil] data
+    #   the data to use (varies based on the +verb+)
+    # @param [Hash] headers
+    #   the list of headers to use
     #
-    # @return [HTTPClient]
+    # @return [String, Hash]
+    #   the response body
     #
-    def agent
-      @agent ||= begin
-        agent = HTTPClient.new(endpoint)
+    def request(verb, path, data = {}, headers = {})
+      # Build the URI and request object from the given information
+      uri = build_uri(verb, path, data)
+      request = class_for_request(verb).new(uri.request_uri)
 
-        agent.agent_name = user_agent
+      # Add headers
+      default_headers.merge(headers).each do |key, value|
+        request.add_field(key, value)
+      end
 
-        # Check if authentication was given
-        if username && password
-          agent.set_auth(endpoint, username, password)
+      # Add basic authentication
+      if username && password
+        request.basic_auth(username, password)
+      end
 
-          # https://github.com/nahi/httpclient/issues/63#issuecomment-2377919
-          agent.www_auth.basic_auth.challenge(endpoint)
+      # Setup PATCH/POST/PUT
+      if [:patch, :post, :put].include?(verb)
+        if data.respond_to?(:read)
+          request.body_stream = data
+        elsif data.is_a?(Hash)
+          request.form_data = data
+        else
+          request.body = data
         end
+      end
 
-        # Check if proxy settings were given
-        if proxy
-          agent.proxy = proxy
+      # Create the HTTP connection object - since the proxy information defaults
+      # to +nil+, we can just pass it to the initializer method instead of doing
+      # crazy strange conditionals.
+      connection = Net::HTTP.new(uri.host, uri.port,
+        proxy_address, proxy_port, proxy_username, proxy_password)
+
+      # Apply SSL, if applicable
+      if uri.scheme == 'https'
+        require 'net/https' unless defined?(Net::HTTPS)
+
+        # Turn on SSL
+        connection.use_ssl = true
+
+        # Custom pem files, no problem!
+        if ssl_pem_file
+          pem = File.read(ssl_pem_file)
+          connection.cert = OpenSSL::X509::Certificate.new(pem)
+          connection.key = OpenSSL::PKey::RSA.new(pem)
+          connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
         end
 
-        agent
+        # Naughty, naughty, naughty! Don't blame when when someone hops in
+        # and executes a MITM attack!
+        unless ssl_verify
+          connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
       end
+
+      # Create a connection using the block form, which will ensure the socket
+      # is properly closed in the event of an error.
+      connection.start do |http|
+        response = http.request(request)
+
+        case response
+        when Net::HTTPRedirection
+          redirect = URI.parse(response['location'])
+          request(verb, redirect, params, headers)
+        when Net::HTTPSuccess
+          success(response)
+        else
+          error(response)
+        end
+      end
+    rescue SocketError, Errno::ECONNREFUSED, EOFError
+      raise Error::ConnectionError.new(endpoint)
+    end
+
+    #
+    # The list of default headers (such as Keep-Alive and User-Agent) for the
+    # client object.
+    #
+    # @return [Hash]
+    #
+    def default_headers
+      {
+        'Connection' => 'keep-alive',
+        'Keep-Alive' => '30',
+        'User-Agent' => user_agent,
+      }
     end
 
     #
-    # Make an HTTP reequest with the given verb and path.
+    # Construct a URL from the given verb and path. If the request is a GET or
+    # DELETE request, the params are assumed to be query params are are
+    # converted as such using {Client#to_query_string}.
     #
-    # @param [String, Symbol] verb
-    #   the HTTP verb to use
+    # If the path is relative, it is merged with the {Defaults.endpoint}
+    # attribute. If the path is absolute, it is converted to a URI object and
+    # returned.
+    #
+    # @param [Symbol] verb
+    #   the lowercase HTTP verb (e.g. :+get+)
     # @param [String] path
-    #   the absolute or relative URL to use, expanded relative to {Defaults.endpoint}
+    #   the absolute or relative HTTP path (url) to get
+    # @param [Hash] params
+    #   the list of params to build the URI with (for GET and DELETE requests)
     #
-    # @return [Object]
+    # @return [URI]
     #
-    def request(verb, path, *args, &block)
-      url = URI.parse(path)
+    def build_uri(verb, path, params = {})
+      # Add any query string parameters
+      if [:delete, :get].include?(verb)
+        path = [path, to_query_string(params)].compact.join('?')
+      end
+
+      # Parse the URI
+      uri = URI.parse(path)
 
       # Don't merge absolute URLs
-      unless url.absolute?
-        url = URI.parse(File.join(endpoint, path)).to_s
-      end
+      uri = URI.parse(File.join(endpoint, path)) unless uri.absolute?
 
-      # Covert the URL back into a string
-      url = url.to_s
-
-      # Make the actual request
-      response = agent.send(verb, url, *args, &block)
-
-      case response.status.to_i
-      when 200..399
-        parse_response(response)
-      when 400
-        raise Error::BadRequest.new(url: url, body: response.body)
-      when 401
-        raise Error::Unauthorized.new(url: url)
-      when 403
-        raise Error::Forbidden.new(url: url)
-      when 404
-        raise Error::NotFound.new(url: url)
-      when 405
-        raise Error::MethodNotAllowed.new(url: url)
-      else
-        raise Error::ConnectionError.new(url: url, body: response.body)
-      end
-    rescue SocketError, Errno::ECONNREFUSED, EOFError
-      raise Error::ConnectionError.new(url: url, body: <<-EOH.gsub(/^ {8}/, ''))
-        The server is not currently accepting connections.
-      EOH
+      # Return the URI object
+      uri
     end
 
+    #
+    # Helper method to get the corresponding {Net::HTTP} class from the given
+    # HTTP verb.
+    #
+    # @param [#to_s] verb
+    #   the HTTP verb to create a class from
+    #
+    # @return [Class]
+    #
+    def class_for_request(verb)
+      Net::HTTP.const_get(verb.to_s.capitalize)
+    end
+
+    #
+    # Convert the given hash to a list of query string parameters. Each key and
+    # value in the hash is URI-escaped for safety.
+    #
+    # @param [Hash] hash
+    #   the hash to create the query string from
+    #
+    # @return [String, nil]
+    #   the query string as a string, or +nil+ if there are no params
+    #
+    def to_query_string(hash)
+      hash.map do |key, value|
+        "#{URI.escape(key.to_s)}=#{URI.escape(value.to_s)}"
+      end.join('&')[/.+/]
+    end
 
     #
     # Parse the response object and manipulate the result based on the given
@@ -211,14 +319,31 @@ module Artifactory
     # @return [String, Hash]
     #   the parsed response, as an object
     #
-    def parse_response(response)
-      content_type = response.headers['Content-Type']
-
-      if content_type && content_type.include?('json')
+    def success(response)
+      if (response.content_type || '').include?('json')
         JSON.parse(response.body)
       else
         response.body
       end
     end
+
+    #
+    # Raise a response error, extracting as much information from the server's
+    # response as possible.
+    #
+    # @raise [Error::HTTPError]
+    #
+    # @param [HTTP::Message] response
+    #   the response object from the request
+    #
+    def error(response)
+      error = JSON.parse(response.body)['errors'].first
+      raise Error::HTTPError.new(error)
+    rescue JSON::ParserError
+      raise Error::HTTPError.new(
+        'status'  => response.code,
+        'message' => response.body,
+      )
+    end
   end
 end