artifactory 2.5.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 807a2f1639d5c32dff15a9cc23d7d129396d9847
-  data.tar.gz: 063be4bd80cb37f69f04492bf9cdcda5c92fb565
+  metadata.gz: b78870ce533114a24a58309118aa1371b8148e84
+  data.tar.gz: 70072323490ca5caa97a9f26c5ada37076df82a1
 SHA512:
-  metadata.gz: 20e6cdf9a45f0da723ff60dc4bcab19c5cf06dd1be1ce54fab35cad878b167474740cb807fbe1aa2818edcd26993342bcce7d2cbee1283c82e77f36601f99161
-  data.tar.gz: 4646fa8579e83c41a2733c35c336257aab79fb869d3f4ea8f8122a03ef8e6d85a21dd093dcbe148d1fbc48992fec903d1b4616c721fba463dae18fb263a39bad
+  metadata.gz: acb5a08f27fe3551f4b4bb97ce45720194295a71e9ed6123cb03d47784e38fae528a1b1de37a96efb6468dff407082e147a0e7f5b2eda6091ce57cad6312fe17
+  data.tar.gz: eda4087d4293e24272959d44d58b1673546c1b096fb7349384b3407cd3d60cb6154f6dc62b8e61ebb9144dccbd54b66fc4f6dbba1ad9df5e81c26e9089ec211b

data/.travis.yml

@@ -1,7 +1,8 @@
 rvm:
-  - 1.9.3
-  - 2.0.0
   - 2.1
+  - 2.2
+  - 2.3
+  - 2.4.0
 
 bundler_args: --jobs 7
 

data/CHANGELOG.md

@@ -3,6 +3,12 @@ Artifactory Client CHANGELOG
 This file is used to document the changes between releases of the Artifactory
 Ruby client.
 
+v2.6.0 (02-02-2017)
+-------------------
+- Add API Key authentication
+- Add new Ruby versions to test matrix
+- Add ChefStyle for linting
+
 v2.5.2 (01-27-2017)
 -------------------
 - Update tests to run properly on Windows

data/Gemfile

@@ -1,18 +1,14 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem 'sinatra', '~> 1.4'
-  gem 'rspec',   '~> 3.0'
-  gem 'webmock', '~> 1.17'
-  if RUBY_VERSION =~ /^1\.9\.3.*/
-    # gaurd that webmock only brings in addressable with 1.9.3 support.
-    gem 'addressable', '<= 2.4.0'
-    # guard simplecov import of json gem
-    gem 'json', '<= 1.8.3'
-  end
+  gem "chefstyle"
+  gem "sinatra", "~> 1.4"
+  gem "rspec",   "~> 3.0"
+  gem "webmock", "~> 2.3"
+  gem "rainbow", "< 2.2.1"
   # rspec-mocks 3.4.1 breaks tests with 'System level too deep' errors.
-  gem 'rspec-mocks', '3.4.0'
-  gem 'simplecov'
-  gem 'simplecov-console'
+  gem "rspec-mocks", "3.4.0"
+  gem "simplecov"
+  gem "simplecov-console"
 end

data/README.md

@@ -1,6 +1,6 @@
 Artifactory Client
 ==================
-[![Build Status](https://secure.travis-ci.org/chef/artifactory-client.png?branch=master)](http://travis-ci.org/chef/artifactory-client)
+[![Gem Version](http://img.shields.io/gem/v/artifactory.svg)][gem] [![Travis Build Status](http://img.shields.io/travis/chef/artifactory-client.svg?label=Travis CI)][travis] [![AppVeyor Build Status](http://img.shields.io/appveyor/ci/chef/artifactory-client.svg?label=AppVeyor)][appveyor]
 
 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.
 
@@ -56,6 +56,10 @@ Artifactory.configure do |config|
   config.username = 'admin'
   config.password = 'password'
 
+  # You can also use an API key for authentication, username and password
+  # take precedence so leave them off if you are using an API key.
+  config.api_key = 'XXXXXXXXXXXXXXXXXX'
+
   # 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).
@@ -86,6 +90,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_API_KEY=XXXXXXXXXXXXXXXXXX
 export ARTIFACTORY_SSL_PEM_FILE=/path/to/my.pem
 ```
 
@@ -275,3 +280,7 @@ 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.
 ```
+
+[appveyor]: https://ci.appveyor.com/project/chef/artifactory-client
+[gem]: https://rubygems.org/gems/artifactory
+[travis]: https://travis-ci.org/chef/artifactory-client

data/Rakefile

@@ -1,6 +1,6 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:integration) do |t|
   t.rspec_opts = "--tag integration"
 end
@@ -8,12 +8,21 @@ RSpec::Core::RakeTask.new(:unit) do |t|
   t.rspec_opts = "--tag ~integration"
 end
 
-namespace :travis do
-  desc 'Run tests on Travis'
-  task :ci => [:unit,:integration]
+require "chefstyle"
+require "rubocop/rake_task"
+desc "Run ChefStyle"
+RuboCop::RakeTask.new(:chefstyle) do |task|
+  task.options << "--display-cop-names"
 end
 
-desc 'Generate coverage report'
+desc "Generate coverage report"
 RSpec::Core::RakeTask.new(:coverage) do |t|
-  ENV['COVERAGE'] = 'true'
+  ENV["COVERAGE"] = "true"
 end
+
+namespace :travis do
+  desc "Run tests on Travis"
+  task ci: %w{chefstyle unit integration}
+end
+
+task default: %w{travis:ci}

data/appveyor.yml

@@ -6,8 +6,10 @@ environment:
   matrix:
     - RUBY_VERSION: 21
     - RUBY_VERSION: 21-x64
-    - RUBY_VERSION: 200
-    - RUBY_VERSION: 193
+    - RUBY_VERSION: 22
+    - RUBY_VERSION: 22-x64
+    - RUBY_VERSION: 23
+    - RUBY_VERSION: 23-x64
 
 install:
   - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%

data/artifactory.gemspec

@@ -1,25 +1,25 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'artifactory/version'
+require "artifactory/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'artifactory'
+  spec.name          = "artifactory"
   spec.version       = Artifactory::VERSION
-  spec.author        = 'Seth Vargo'
-  spec.email         = 'sethvargo@gmail.com'
-  spec.description   = 'A Ruby client for Artifactory'
-  spec.summary       = 'Artifactory is a simple, lightweight Ruby client for ' \
-                       'interacting with the Artifactory and Artifactory Pro ' \
-                       'APIs.'
-  spec.homepage      = 'https://github.com/opscode/artifactory-client'
-  spec.license       = 'Apache 2.0'
+  spec.author        = "Seth Vargo"
+  spec.email         = "sethvargo@gmail.com"
+  spec.description   = "A Ruby client for Artifactory"
+  spec.summary       = "Artifactory is a simple, lightweight Ruby client for " \
+                       "interacting with the Artifactory and Artifactory Pro " \
+                       "APIs."
+  spec.homepage      = "https://github.com/opscode/artifactory-client"
+  spec.license       = "Apache 2.0"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end

data/lib/artifactory.rb

@@ -14,38 +14,38 @@
 # limitations under the License.
 #
 
-require 'pathname'
-require 'artifactory/version'
+require "pathname"
+require "artifactory/version"
 
 module Artifactory
-  autoload :Client,       'artifactory/client'
-  autoload :Configurable, 'artifactory/configurable'
-  autoload :Defaults,     'artifactory/defaults'
-  autoload :Error,        'artifactory/errors'
-  autoload :Util,         'artifactory/util'
+  autoload :Client,       "artifactory/client"
+  autoload :Configurable, "artifactory/configurable"
+  autoload :Defaults,     "artifactory/defaults"
+  autoload :Error,        "artifactory/errors"
+  autoload :Util,         "artifactory/util"
 
   module Collection
-    autoload :Artifact, 'artifactory/collections/artifact'
-    autoload :Base,     'artifactory/collections/base'
-    autoload :Build, 'artifactory/collections/build'
+    autoload :Artifact, "artifactory/collections/artifact"
+    autoload :Base,     "artifactory/collections/base"
+    autoload :Build, "artifactory/collections/build"
   end
 
   module Resource
-    autoload :Artifact,         'artifactory/resources/artifact'
-    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'
-    autoload :MailServer,       'artifactory/resources/mail_server'
-    autoload :PermissionTarget, 'artifactory/resources/permission_target'
-    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'
+    autoload :Artifact,         "artifactory/resources/artifact"
+    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"
+    autoload :MailServer,       "artifactory/resources/mail_server"
+    autoload :PermissionTarget, "artifactory/resources/permission_target"
+    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
@@ -58,7 +58,7 @@ module Artifactory
     # @return [Pathname]
     #
     def root
-      @root ||= Pathname.new(File.expand_path('../../', __FILE__))
+      @root ||= Pathname.new(File.expand_path("../../", __FILE__))
     end
 
     #

data/lib/artifactory/client.rb

@@ -14,10 +14,10 @@
 # limitations under the License.
 #
 
-require 'cgi'
-require 'json'
-require 'net/http'
-require 'uri'
+require "cgi"
+require "json"
+require "net/http"
+require "uri"
 
 module Artifactory
   #
@@ -31,7 +31,7 @@ module Artifactory
       # @private
       #
       def proxy(klass)
-        namespace = klass.name.split('::').last.downcase
+        namespace = klass.name.split("::").last.downcase
         klass.singleton_methods(false).each do |name|
           define_method("#{namespace}_#{name}") do |*args|
             if args.last.is_a?(Hash)
@@ -69,10 +69,10 @@ module Artifactory
       # Use any options given, but fall back to the defaults set on the module
       Artifactory::Configurable.keys.each do |key|
         value = if options[key].nil?
-          Artifactory.instance_variable_get(:"@#{key}")
-        else
-          options[key]
-        end
+                  Artifactory.instance_variable_get(:"@#{key}")
+                else
+                  options[key]
+                end
 
         instance_variable_set(:"@#{key}", value)
       end
@@ -193,6 +193,8 @@ module Artifactory
       # Add basic authentication
       if username && password
         request.basic_auth(username, password)
+      elsif api_key
+        request.add_field("X-JFrog-Art-Api", api_key)
       end
 
       # Setup PATCH/POST/PUT
@@ -219,8 +221,8 @@ module Artifactory
       connection.read_timeout = read_timeout
 
       # Apply SSL, if applicable
-      if uri.scheme == 'https'
-        require 'net/https' unless defined?(Net::HTTPS)
+      if uri.scheme == "https"
+        require "net/https" unless defined?(Net::HTTPS)
 
         # Turn on SSL
         connection.use_ssl = true
@@ -247,7 +249,7 @@ module Artifactory
 
         case response
         when Net::HTTPRedirection
-          redirect = URI.parse(response['location'])
+          redirect = URI.parse(response["location"])
           request(verb, redirect, data, headers)
         when Net::HTTPSuccess
           success(response)
@@ -267,9 +269,9 @@ module Artifactory
     #
     def default_headers
       {
-        'Connection' => 'keep-alive',
-        'Keep-Alive' => '30',
-        'User-Agent' => user_agent,
+        "Connection" => "keep-alive",
+        "Keep-Alive" => "30",
+        "User-Agent" => user_agent,
       }
     end
 
@@ -294,7 +296,7 @@ module Artifactory
     def build_uri(verb, path, params = {})
       # Add any query string parameters
       if [:delete, :get].include?(verb)
-        path = [path, to_query_string(params)].compact.join('?')
+        path = [path, to_query_string(params)].compact.join("?")
       end
 
       # Parse the URI
@@ -333,7 +335,7 @@ module Artifactory
     def to_query_string(hash)
       hash.map do |key, value|
         "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
-      end.join('&')[/.+/]
+      end.join("&")[/.+/]
     end
 
     #
@@ -348,7 +350,7 @@ module Artifactory
     #   the parsed response, as an object
     #
     def success(response)
-      if (response.content_type || '').include?('json')
+      if (response.content_type || "").include?("json")
         JSON.parse(response.body)
       else
         response.body
@@ -365,20 +367,20 @@ module Artifactory
     #   the response object from the request
     #
     def error(response)
-      if (response.content_type || '').include?('json')
+      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)
+          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,
+        "status"  => response.code,
+        "message" => response.body
       )
     end
   end

data/lib/artifactory/configurable.rb

@@ -31,6 +31,7 @@ module Artifactory
           :endpoint,
           :username,
           :password,
+          :api_key,
           :proxy_address,
           :proxy_password,
           :proxy_port,

data/lib/artifactory/defaults.rb

@@ -14,12 +14,12 @@
 # limitations under the License.
 #
 
-require 'artifactory/version'
+require "artifactory/version"
 
 module Artifactory
   module Defaults
     # Default API endpoint
-    ENDPOINT = 'http://localhost:8080/artifactory'.freeze
+    ENDPOINT = "http://localhost:8080/artifactory".freeze
 
     # Default User Agent header string
     USER_AGENT = "Artifactory Ruby Gem #{Artifactory::VERSION}".freeze
@@ -40,7 +40,7 @@ module Artifactory
       # @return [String]
       #
       def endpoint
-        ENV['ARTIFACTORY_ENDPOINT'] || ENDPOINT
+        ENV["ARTIFACTORY_ENDPOINT"] || ENDPOINT
       end
 
       #
@@ -49,7 +49,7 @@ module Artifactory
       # @return [String]
       #
       def user_agent
-        ENV['ARTIFACTORY_USER_AGENT'] || USER_AGENT
+        ENV["ARTIFACTORY_USER_AGENT"] || USER_AGENT
       end
 
       #
@@ -58,7 +58,7 @@ module Artifactory
       # @return [String, nil]
       #
       def username
-        ENV['ARTIFACTORY_USERNAME']
+        ENV["ARTIFACTORY_USERNAME"]
       end
 
       #
@@ -67,7 +67,16 @@ module Artifactory
       # @return [String, nil]
       #
       def password
-        ENV['ARTIFACTORY_PASSWORD']
+        ENV["ARTIFACTORY_PASSWORD"]
+      end
+
+      #
+      # The API Key for authentication
+      #
+      # @return [String, nil]
+      #
+      def api_key
+        ENV["ARTIFACTORY_API_KEY"]
       end
 
       #
@@ -76,7 +85,7 @@ module Artifactory
       # @return [String, nil]
       #
       def proxy_address
-        ENV['ARTIFACTORY_PROXY_ADDRESS']
+        ENV["ARTIFACTORY_PROXY_ADDRESS"]
       end
 
       #
@@ -85,7 +94,7 @@ module Artifactory
       # @return [String, nil]
       #
       def proxy_password
-        ENV['ARTIFACTORY_PROXY_PASSWORD']
+        ENV["ARTIFACTORY_PROXY_PASSWORD"]
       end
 
       #
@@ -94,7 +103,7 @@ module Artifactory
       # @return [String, nil]
       #
       def proxy_port
-        ENV['ARTIFACTORY_PROXY_PORT']
+        ENV["ARTIFACTORY_PROXY_PORT"]
       end
 
       #
@@ -103,7 +112,7 @@ module Artifactory
       # @return [String, nil]
       #
       def proxy_username
-        ENV['ARTIFACTORY_PROXY_USERNAME']
+        ENV["ARTIFACTORY_PROXY_USERNAME"]
       end
 
       #
@@ -112,7 +121,7 @@ module Artifactory
       # @return [String, nil]
       #
       def ssl_pem_file
-        ENV['ARTIFACTORY_SSL_PEM_FILE']
+        ENV["ARTIFACTORY_SSL_PEM_FILE"]
       end
 
       #
@@ -121,10 +130,10 @@ module Artifactory
       # @return [true, false]
       #
       def ssl_verify
-        if ENV['ARTIFACTORY_SSL_VERIFY'].nil?
+        if ENV["ARTIFACTORY_SSL_VERIFY"].nil?
           true
         else
-          %w[t y].include?(ENV['ARTIFACTORY_SSL_VERIFY'].downcase[0])
+          %w{t y}.include?(ENV["ARTIFACTORY_SSL_VERIFY"].downcase[0])
         end
       end
 
@@ -134,8 +143,8 @@ module Artifactory
       # @return [Integer]
       #
       def read_timeout
-        if ENV['ARTIFACTORY_READ_TIMEOUT']
-          ENV['ARTIFACTORY_READ_TIMEOUT'].to_i
+        if ENV["ARTIFACTORY_READ_TIMEOUT"]
+          ENV["ARTIFACTORY_READ_TIMEOUT"].to_i
         else
           120
         end