fog-brightbox 1.7.0 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 930c37c33d46857b7fa6f4e9880bd11068f9b4cc3a90aad25d1db39904ae6601
-  data.tar.gz: e9bfaa815ea41d8a0fc5afc094b4e7626d8dfa3fb7b35ddb58f9fa0c60aaf945
+  metadata.gz: 92ebad94e1526398b760b8a104898cdb2600d3a624e6f77af9b9a2bf24011279
+  data.tar.gz: 913cf9025ebd5dda7b47b4c2511da1b3f03eea54de7db58a30b1ca15423d592e
 SHA512:
-  metadata.gz: e7d00dbc24b5d7b9c2e292bf7caa4797d93ed6d94d28622ea5beb9f29af6c29d6098d17ab495d3707f9e7a847694f9a331e5de5268000bddb1e4f884d80566c6
-  data.tar.gz: 4164e7796800011e460411dccc08efb780362b61afd2790b5af8e724151c86e50e315fba45f785ad8cf5fb44f9016e1aac36d7093436f07670332afff66c1aec
+  metadata.gz: 7d7d77edd59fb85d9d5ae125896a6d9f2f572ea7161a1da1eb4f183567f6fbf9682d18b55e648560cfa1ea179006aaa764b15a0fe11502d727038f2d97571cf2
+  data.tar.gz: 24359f5541ce79e0f658bdd86c039e1b90358e5b1a3defa2b52bc7fd391fbf87f783cdd33f96d4caaffccaa48fefb2b5438f90ff979462cd1b1a8f3c0536150b

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 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:
+
+* Implement `Storage::Directory#public_url` to allow generation of `File` public URLs correctly.
+
 ### 1.7.0 / 2022-07-28
 
 Changes:

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

@@ -31,8 +31,9 @@ module Fog
         attr_writer :public
 
         def public_url
-          # raise NotImplementedError
-          ""
+          requires :key
+          @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.0"
+    VERSION = "1.7.3"
   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fog-brightbox
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.7.3
 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