artifactory 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36a57d1a8d8f2897585a0e123efbc5fd0b179577
-  data.tar.gz: 7b9b819091f946ef7be601b36a87b0dd126199da
+  metadata.gz: 25479b749ea49c38799479ba12df5373efdf77a0
+  data.tar.gz: 52732e8ba49c9b1e29ad2180aa1e4ff8175d1798
 SHA512:
-  metadata.gz: cef02ee8889eea9693ac3442f1c3922acd6d99da9aa40438e452902fe1cc62fa4d3ddea91f096b81c647ddf5c63b14ee03eb79a4485a998760bedc878b16563f
-  data.tar.gz: d227fd12f179a45d6bd934418a90c3a3f0465f3e0de6c3a0cc694d96f71a0bdf93a9f8b681ba3b2ae3c3c1e6dd81cc9e2faffea4a7460e51d51566e173fe0b67
+  metadata.gz: e111db3109a4598677fd2ba3b1cbe7d5cb26c087e43690c06ca97cc3ced0b0fc776e1736dfadf87ee5d8683ba1d6a369dbd0c416ae27055d41dfa0ca69d58c6f
+  data.tar.gz: c76f8078e1829439fb4673a284842c954d8aa859b9ac16cad3535f508f568309c196e587df1d43946bcc1725e97211c5460d0797bd27717054124687ff4449f2

data/CHANGELOG.md

@@ -3,6 +3,10 @@ Artifactory Client CHANGELOG
 This file is used to document the changes between releases of the Artifactory
 Ruby client.
 
+v2.8.0 (03-17-2017)
+-------------------
+- Include statuses in Build resource
+
 v2.7.0 (02-21-2017)
 -------------------
 - Include statuses in Build resource

data/README.md

@@ -1,6 +1,6 @@
 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]
+[![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%20CI)][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.
 
@@ -115,6 +115,8 @@ artifact #=> "#<Artifactory::Resource::Artifact md5: 'ABCD1234'>"
 # Get the properties of an artifact
 artifact.md5 #=> "ABCD1234"
 artifact.properties #=> { ... }
+# Set the properties of an artifact
+artifact.properties({prop1: 'value1', 'prop2': 'value2'}) #=> { ... }
 
 # Download the artifact to disk
 artifact.download #=> /tmp/folders-a38b0decf038201/package.deb

data/lib/artifactory/resources/artifact.rb

@@ -430,16 +430,27 @@ module Artifactory
     end
 
     #
-    # The list of properties for this object.
+    # Set properties for this object. If no properties are given it lists the properties for this object.
     #
     # @example List all properties for an artifact
-    #   artifact.properties #=> { 'artifactory.licenses'=>['Apache-2.0'] }
+    #   artifact.properties #=> { 'licenses'=>['Apache-2.0'] }
+    #
+    # @example Set new properties for an artifact
+    #   artifact.properties(maintainer: 'SuperStartup01') #=> { 'licenses'=>['Apache-2.0'], 'maintainer'=>'SuperStartup01' }
+    #
+    # @param [Hash<String, Object>] props (default: +nil+)
+    #   A hash of properties and corresponding values to set for the artifact
     #
     # @return [Hash<String, Object>]
     #   the list of properties
     #
-    def properties
-      @properties ||= client.get(File.join("/api/storage", relative_path), properties: nil)["properties"]
+    def properties(props = nil)
+      if props.nil? || props.empty?
+        get_properties
+      else
+        set_properties(props)
+        get_properties(true)
+      end
     end
 
     #
@@ -619,6 +630,45 @@ module Artifactory
 
     private
 
+    #
+    # Helper method for reading artifact properties
+    #
+    # @example List all properties for an artifact
+    #   artifact.get_properties #=> { 'artifactory.licenses'=>['Apache-2.0'] }
+    #
+    # @param [TrueClass, FalseClass] refresh_cache (default: +false+)
+    #   wether or not to use the locally cached value if it exists and is not nil
+    #
+    # @return [Hash<String, Object>]
+    #   the list of properties
+    #
+    def get_properties(refresh_cache = false)
+      if refresh_cache || @properties.nil?
+        @properties = client.get(File.join("/api/storage", relative_path), properties: nil)["properties"]
+      end
+
+      @properties
+    end
+
+    #
+    # Helper method for setting artifact properties
+    #
+    # @example Set properties for an artifact
+    #   artifact.set_properties({ prop1: 'value1', 'prop2' => 'value2' })
+    #
+    # @param [Hash<String, Object>] properties
+    #   A hash of properties and corresponding values to set for the artifact
+    #
+    # @return [Hash]
+    #   the parsed JSON response from the server
+    #
+    def set_properties(properties)
+      matrix = to_matrix_properties(properties)
+      endpoint = File.join("/api/storage", relative_path) + "?properties=#{matrix}"
+
+      client.put(endpoint, nil)
+    end
+
     #
     # Helper method for extracting the relative (repo) path, since it's not
     # returned as part of the API.

data/lib/artifactory/version.rb

@@ -15,5 +15,5 @@
 #
 
 module Artifactory
-  VERSION = "2.7.0"
+  VERSION = "2.8.0"
 end

data/spec/integration/resources/artifact_spec.rb

@@ -32,6 +32,20 @@ module Artifactory
       end
     end
 
+    describe ".properties" do
+      let(:artifact) do
+        artifact = described_class.send(:search, repos: "libs-properties-local", name: "artifact.deb").first
+      end
+
+      it "returns artifact properties when reading" do
+        expect(artifact.properties).to include({ "licenses" => [ "Apache 2" ] })
+      end
+
+      it "writes artifact properties" do
+        expect(artifact.properties({ author: "Jörg", "status" => "public" })).to eq({ "licenses" => [ "Apache 2" ], "author" => "Jörg", "status" => "public" })
+      end
+    end
+
     describe ".search" do
       it_behaves_like "an artifact search endpoint", :search, name: "artifact.deb"
     end

data/spec/support/api_server/artifact_endpoints.rb

@@ -1,6 +1,8 @@
 module Artifactory
   module APIServer::ArtifactEndpoints
     def self.registered(app)
+      artifact_properties = { "licenses" => [ "Apache 2" ] }
+
       app.get("/api/search/artifact") do
         content_type "application/vnd.org.jfrog.artifactory.search.ArtifactSearchResult+json"
         artifacts_for_conditions do
@@ -86,6 +88,22 @@ module Artifactory
         )
       end
 
+      app.get("/api/storage/libs-properties-local/org/acme/artifact.deb") do
+        content_type "application/vnd.org.jfrog.artifactory.storage.ItemProperties+json"
+        JSON.fast_generate(
+          "properties" => artifact_properties,
+          "uri" => server_url.join("/api/storage/libs-properties-local/org/acme/artifact.deb")
+        )
+      end
+
+      app.put("/api/storage/libs-properties-local/org/acme/artifact.deb") do
+        props = params["properties"].split(";").reject(&:empty?).map { |e| e.split("=") }.to_h
+        artifact_properties.merge!(props)
+
+        status 204
+        body ""
+      end
+
       app.get("/api/storage/ext-release-local/org/acme/artifact.deb") do
         content_type "application/vnd.org.jfrog.artifactory.storage.FileInfo+json"
         JSON.fast_generate(
@@ -145,6 +163,12 @@ module Artifactory
                   { "uri" => server_url.join("/api/storage/libs-release-local/org/acme/artifact.deb") },
                 ]
               )
+            elsif params["repos"] == "libs-properties-local"
+              JSON.fast_generate(
+                "results" => [
+                  { "uri" => server_url.join("/api/storage/libs-properties-local/org/acme/artifact.deb") },
+                ]
+              )
             else
               JSON.fast_generate(
                 "results" => [

data/spec/unit/resources/artifact_spec.rb

@@ -482,10 +482,15 @@ module Artifactory
       let(:response) do
         { "properties" => properties }
       end
+
       let(:client) { double(get: response) }
       let(:relative_path) { "/api/storage/some-repo/path/artifact.deb" }
       let(:artifact_uri) { File.join("http://33.33.33.11", relative_path) }
 
+      let(:property_set_path) { "#{relative_path}?properties=;author=J%C3%B6rg;status=public" }
+      let(:new_properties) { { author: "Jörg", "status" => "public" } }
+      let(:client) { double(put: nil ) }
+
       before do
         subject.client = client
         subject.uri    = artifact_uri
@@ -500,6 +505,16 @@ module Artifactory
         subject.properties
         expect(subject.instance_variable_get(:@properties)).to eq(properties)
       end
+
+      it "sets the properties on the server" do
+        expect(client).to receive(:put).with(property_set_path, nil).once
+        subject.properties(new_properties)
+      end
+
+      it "updates the chache" do
+        expect(subject).to receive(:get_properties).with(true).once
+        subject.properties(new_properties)
+      end
     end
 
     describe "#compliance" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artifactory
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-21 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler