fog-brightbox 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e454f9c0dfb541dfcb036712499e20160fb9743ab0da50776252bc6f53516f7
-  data.tar.gz: a69d2679435006c7c1da3997aa61b38ce5f180b0d1f20b422f7e2c370dc1b753
+  metadata.gz: 2fd48abde8380eb206f3b30abcb6000a8bec7c066d1913649efdde89719f0a79
+  data.tar.gz: b75f15aabc38798dcb1a8bcb13eb3e0b66e9ee9fe93beb91e462808d822f9fb7
 SHA512:
-  metadata.gz: 00302c2501178651b3aa88100cceec4a5acd33f6feb39ae27aa03935e8e95c5796b2f5c144bb457936d1694791afcaa3b0689cae1e16d81ca02b8c81c63383bb
-  data.tar.gz: b072d486bfd7f2a8a4b7a0cf747be18c3db59a7e8b66553ae4183500c33a4e4adb67baa405c58dd7063ba6630141879c92ba380c82da4f9233d9fdb40589b0b9
+  metadata.gz: 6ea1059b94824d5ae37fda327001f94704a544fd29bfa7825627599cef850653fdcb55c18d493352af9bb1afd6864faf89c2d824da4baccd9fcdbd0d020096e4
+  data.tar.gz: 464af05ddefa022497cce27fb7535eaac5f9db282e32037e922780f0ab05f96eb1f72ccad07f9ad5860c5a2e62228a5a05c676ee83e666507d1a62191e7f3580

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 1.8.0 / 2022-08-31
+
+Changes:
+
+* Allow custom `volume_size` in server creation where supported
+
+### 1.7.3 / 2022-08-17
+
+Bug fixes:
+
+* Fix to deduplicate forward slashes in `Storage::File#public_url` when object keys are prefixed with "/"
+
+### 1.7.2 / 2022-08-17
+
+Bug fixes:
+
+* Fix in `Storage.escape` regexp which failed to handle dashes correctly and broke generated URLs.
+
 ### 1.7.1 / 2022-08-17
 
 Bug fixes:

data/lib/fog/brightbox/models/compute/server.rb

@@ -8,6 +8,7 @@ module Fog
         include Fog::Brightbox::Compute::ResourceLocking
 
         attr_accessor :volume_id
+        attr_accessor :volume_size
 
         identity :id
         attribute :resource_type
@@ -197,7 +198,16 @@ module Fog
           options.merge!(:disk_encrypted => disk_encrypted) if disk_encrypted
 
           if volume_id
-            options.merge!(:volumes => [:volume => volume_id])
+            options.merge!(:volumes => [{ volume: volume_id }])
+          elsif volume_size
+            options.merge!(
+              volumes: [
+                {
+                  image: image_id,
+                  size: volume_size
+                }
+              ]
+            )
           else
             options.merge!(:image => image_id)
           end

data/lib/fog/brightbox/models/storage/directory.rb

@@ -32,7 +32,8 @@ module Fog
 
         def public_url
           requires :key
-          @public_url ||= [service.management_url , Fog::Brightbox::Storage.escape(key, "/")].join("/")
+          @public_url ||= ::File.join(service.management_url.to_s,
+                                      Fog::Brightbox::Storage.escape(key, "/"))
         end
 
         def save

data/lib/fog/brightbox/models/storage/files.rb

@@ -63,9 +63,9 @@ module Fog
 
         def get_url(key)
           requires :directory
-          if directory.public_url
-            "#{directory.public_url}/#{Fog::Brightbox::Storage.escape(key, "/")}"
-          end
+          return unless directory.public_url
+
+          ::File.join(directory.public_url, Fog::Brightbox::Storage.escape(key, "/"))
         end
 
         def get_http_url(key, expires, options = {})

data/lib/fog/brightbox/storage.rb

@@ -215,7 +215,8 @@ module Fog
 
       # CGI.escape, but without special treatment on spaces
       def self.escape(str, extra_exclude_chars = "")
-        str.gsub(/([^a-zA-Z0-9_.-#{extra_exclude_chars}]+)/) do
+        # Includes fix to Regexp so "-" is correctly handled by placing last
+        str.gsub(/([^a-zA-Z0-9_.#{extra_exclude_chars}-]+)/) do
           "%" + Regexp.last_match[1].unpack("H2" * Regexp.last_match[1].bytesize).join("%").upcase
         end
       end

data/lib/fog/brightbox/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Brightbox
-    VERSION = "1.7.1"
+    VERSION = "1.8.0"
   end
 end

data/spec/fog/brightbox/storage/escape_spec.rb

@@ -0,0 +1,62 @@
+require "minitest/autorun"
+require "fog/brightbox"
+
+describe Fog::Brightbox::Storage, ".escape" do
+  describe "when only excluded characters are used" do
+    it "escapes no letters" do
+      str = ("A".."Z").to_a.join
+      escaped = Fog::Brightbox::Storage.escape(str)
+      assert_equal str, escaped
+
+      str = ("a".."z").to_a.join
+      escaped = Fog::Brightbox::Storage.escape(str)
+      assert_equal str, escaped
+    end
+
+    it "escapes no numbers" do
+      str = ("0".."9").to_a.join
+      escaped = Fog::Brightbox::Storage.escape(str)
+      assert_equal str, escaped
+    end
+
+    it "does not escape dashes" do
+      str = "test-pattern123"
+      escaped = Fog::Brightbox::Storage.escape(str)
+      assert_equal str, escaped
+    end
+
+    it "does not escape dots" do
+      str = "sample.demo"
+      escaped = Fog::Brightbox::Storage.escape(str)
+      assert_equal str, escaped
+    end
+
+    it "does not escape underscores" do
+      str = "file_name"
+      escaped = Fog::Brightbox::Storage.escape(str)
+      assert_equal str, escaped
+    end
+  end
+
+  describe "when escaped characters are included" do
+    it "escapes those forward slashes" do
+      str = "test/pattern/123.txt"
+      escaped = Fog::Brightbox::Storage.escape(str)
+      assert_equal "test%2Fpattern%2F123.txt", escaped
+    end
+
+    it "escapes those backslashes" do
+      str = "test\\pattern\\123.txt"
+      escaped = Fog::Brightbox::Storage.escape(str)
+      assert_equal "test%5Cpattern%5C123.txt", escaped
+    end
+  end
+
+  describe "when additional characters are excluded" do
+    it "escapes those characters" do
+      str = "test/pattern/123.txt"
+      escaped = Fog::Brightbox::Storage.escape(str, "/")
+      assert_equal "test/pattern/123.txt", escaped
+    end
+  end
+end

data/spec/fog/brightbox/storage/files_spec.rb

@@ -0,0 +1,88 @@
+require "minitest/autorun"
+require "fog/brightbox"
+require "fog/brightbox/models/storage/directory"
+require "fog/brightbox/models/storage/files"
+
+describe Fog::Brightbox::Storage::Files do
+  describe "#get_url" do
+    before do
+      @options = {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "1234567890",
+        :brightbox_storage_management_url => "https://management.url/v1/acc-12345"
+      }
+      @service = Fog::Brightbox::Storage.new(@options)
+    end
+
+    describe "when directory can generate URL" do
+      describe "with object prefixed by forward slash" do
+        it do
+          assert_equal "https://management.url/v1/acc-12345", @service.management_url.to_s
+
+          directory = Fog::Brightbox::Storage::Directory.new(
+            service: @service,
+            key: "container-name"
+          )
+          assert_equal "https://management.url/v1/acc-12345/container-name", directory.public_url
+
+          files = Fog::Brightbox::Storage::Files.new(
+            service: @service,
+            directory: directory
+          )
+
+          expected = "https://management.url/v1/acc-12345/container-name/object"
+
+          assert_equal expected, files.get_url("/object")
+        end
+      end
+
+      describe "when object is correctly named" do
+        it do
+          assert_equal "https://management.url/v1/acc-12345", @service.management_url.to_s
+
+          directory = Fog::Brightbox::Storage::Directory.new(
+            service: @service,
+            key: "container-name"
+          )
+          assert_equal "https://management.url/v1/acc-12345/container-name", directory.public_url
+
+          files = Fog::Brightbox::Storage::Files.new(
+            service: @service,
+            directory: directory
+          )
+
+          expected = "https://management.url/v1/acc-12345/container-name/object"
+
+          assert_equal expected, files.get_url("object")
+        end
+      end
+    end
+
+    describe "when no management URL" do
+      before do
+        @options = {
+          :brightbox_client_id => "cli-12345",
+          :brightbox_secret => "1234567890"
+        }
+        @service = Fog::Brightbox::Storage.new(@options)
+      end
+
+      it do
+        assert_equal "", @service.management_url.to_s
+
+        directory = Fog::Brightbox::Storage::Directory.new(
+          service: @service,
+          key: "container-name"
+        )
+        assert_equal "/container-name", directory.public_url
+
+        files = Fog::Brightbox::Storage::Files.new(
+          service: @service,
+          directory: directory
+        )
+
+        assert_equal "/container-name/object", files.get_url("/object")
+      end
+    end
+  end
+end

data/spec/fog/brightbox/storage_spec.rb

@@ -0,0 +1,34 @@
+require "minitest/autorun"
+require "fog/brightbox"
+
+describe Fog::Brightbox::Storage do
+  describe "when passed in configuration" do
+    before do
+      @options = {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "1234567890",
+        :brightbox_storage_management_url => "https://management.url/v1/acc-12345"
+      }
+      @service = Fog::Brightbox::Storage.new(@options)
+    end
+
+    it "returns a URI matching config option" do
+      assert_kind_of URI, @service.management_url
+      assert_equal "https://management.url/v1/acc-12345", @service.management_url.to_s
+    end
+  end
+
+  describe "when unavailable" do
+    before do
+      @options = {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "1234567890"
+      }
+      @service = Fog::Brightbox::Storage.new(@options)
+    end
+
+    it "returns nil" do
+      assert_nil @service.management_url
+    end
+  end
+end

data/spec/fog/compute/brightbox/server_spec.rb

@@ -20,7 +20,7 @@ describe Fog::Brightbox::Compute::Server do
   end
 
   describe "when creating" do
-    describe "with required image_id" do
+    describe "with image_id" do
       it "sends correct JSON" do
         options = {
           image_id: "img-12345"
@@ -38,6 +38,33 @@ describe Fog::Brightbox::Compute::Server do
       end
     end
 
+    describe "with image_id and custom size" do
+      it "sends correct JSON" do
+        options = {
+          image_id: "img-12345",
+          volume_size: 25_000
+        }
+        expected_args = {
+          volumes: [
+            {
+              image: "img-12345",
+              size: 25_000
+            }
+          ]
+        }
+
+        stub_request(:post, "http://localhost/1.0/servers").
+          with(:query => hash_including(:account_id),
+               :headers => { "Authorization" => "Bearer FAKECACHEDTOKEN",
+                             "Content-Type" => "application/json" },
+                             :body => hash_including(expected_args)).
+        to_return(:status => 202, :body => %q({"id":"srv-12345"}), :headers => {})
+
+        @server = Fog::Brightbox::Compute::Server.new({ :service => service }.merge(options))
+        assert @server.save
+      end
+    end
+
     describe "with additional disk_encrypted" do
       it "sends correct JSON" do
         options = {
@@ -61,6 +88,27 @@ describe Fog::Brightbox::Compute::Server do
     end
   end
 
+  describe "with volume_id" do
+    it "sends correct JSON" do
+      options = {
+        volume_id: "vol-12345"
+      }
+      expected_args = {
+        volumes: [{ volume: "vol-12345" }]
+      }
+
+      stub_request(:post, "http://localhost/1.0/servers").
+        with(:query => hash_including(:account_id),
+             :headers => { "Authorization" => "Bearer FAKECACHEDTOKEN",
+                           "Content-Type" => "application/json" },
+                           :body => hash_including(expected_args)).
+      to_return(:status => 202, :body => %q({"id":"srv-12345"}), :headers => {})
+
+      @server = Fog::Brightbox::Compute::Server.new({ :service => service }.merge(options))
+      assert @server.save
+    end
+  end
+
   describe "when snapshotting with no options" do
     it "returns the server" do
       stub_request(:post, "http://localhost/1.0/servers/srv-12345/snapshot").

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fog-brightbox
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Paul Thornthwaite
@@ -403,6 +403,9 @@ files:
 - spec/fog/brightbox/storage/config_spec.rb
 - spec/fog/brightbox/storage/connection_errors_spec.rb
 - spec/fog/brightbox/storage/connection_spec.rb
+- spec/fog/brightbox/storage/escape_spec.rb
+- spec/fog/brightbox/storage/files_spec.rb
+- spec/fog/brightbox/storage_spec.rb
 - spec/fog/compute/brightbox/account_spec.rb
 - spec/fog/compute/brightbox/api_client_spec.rb
 - spec/fog/compute/brightbox/application_spec.rb
@@ -513,6 +516,9 @@ test_files:
 - spec/fog/brightbox/storage/config_spec.rb
 - spec/fog/brightbox/storage/connection_errors_spec.rb
 - spec/fog/brightbox/storage/connection_spec.rb
+- spec/fog/brightbox/storage/escape_spec.rb
+- spec/fog/brightbox/storage/files_spec.rb
+- spec/fog/brightbox/storage_spec.rb
 - spec/fog/compute/brightbox/account_spec.rb
 - spec/fog/compute/brightbox/api_client_spec.rb
 - spec/fog/compute/brightbox/application_spec.rb