fog-brightbox 0.3.0 → 0.4.0

data/lib/fog/brightbox/storage/errors.rb

@@ -0,0 +1,11 @@
+module Fog
+  module Brightbox
+    module Storage
+      class ManagementUrlUnknown < Fog::Errors::Error
+      end
+
+      class AuthenticationRequired < Fog::Errors::Error
+      end
+    end
+  end
+end

data/lib/fog/brightbox/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Brightbox
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/fog/brightbox/config_spec.rb

@@ -97,6 +97,25 @@ describe Fog::Brightbox::Config do
     end
   end
 
+  describe "when account was passed but changed" do
+    it "returns the new account" do
+      @options = { :brightbox_account => "acc-12345" }
+      @config = Fog::Brightbox::Config.new(@options)
+      @config.change_account("acc-abcde")
+      assert_equal "acc-abcde", @config.account
+    end
+  end
+
+  describe "when account was passed, changed and reset" do
+    it "returns the original account" do
+      @options = { :brightbox_account => "acc-12345" }
+      @config = Fog::Brightbox::Config.new(@options)
+      @config.change_account("acc-abcde")
+      @config.reset_account
+      assert_equal "acc-12345", @config.account
+    end
+  end
+
   describe "when connection options are passed" do
     it "returns the settings" do
       @connection_settings = {
@@ -135,7 +154,7 @@ describe Fog::Brightbox::Config do
   end
 
   describe "when cached OAuth tokens were passed" do
-    it "returns the settings" do
+    before do
       @access_token = "1234567890abcdefghijklmnopqrstuvwxyz"
       @refresh_token = "1234567890abcdefghijklmnopqrstuvwxyz"
       @options = {
@@ -143,8 +162,26 @@ describe Fog::Brightbox::Config do
         :brightbox_refresh_token => @refresh_token
       }
       @config = Fog::Brightbox::Config.new(@options)
+    end
+
+    it "returns the access token" do
       assert_equal @access_token, @config.cached_access_token
+      assert_equal @access_token, @config.latest_access_token
+    end
+
+    it "returns the refresh token" do
       assert_equal @refresh_token, @config.cached_refresh_token
+      assert_equal @refresh_token, @config.latest_refresh_token
+    end
+
+    it "does not need to authenticate" do
+      refute @config.must_authenticate?
+    end
+
+    it "can expire the tokens" do
+      @config.expire_tokens!
+      assert_nil @config.latest_access_token
+      assert_nil @config.latest_refresh_token
     end
   end
 
@@ -177,4 +214,28 @@ describe Fog::Brightbox::Config do
       assert_nil @config.default_image_id
     end
   end
+
+  describe "when username and password are given" do
+    it "user_credentials? returns true" do
+      @options = {
+        :brightbox_client_id => "app-12345",
+        :brightbox_secret => "12345",
+        :brightbox_username => "user@example.com",
+        :brightbox_password => "12345"
+      }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert @config.user_credentials?
+    end
+  end
+
+  describe "when no username is given" do
+    it "user_credentials? returns false" do
+      @options = {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "12345"
+      }
+      @config = Fog::Brightbox::Config.new(@options)
+      refute @config.user_credentials?
+    end
+  end
 end

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

@@ -0,0 +1,77 @@
+require "minitest/autorun"
+require "webmock/minitest"
+require "fog/brightbox"
+
+describe Fog::Brightbox::Storage::AuthenticationRequest do
+  describe "when initialised with blank config" do
+    before do
+      stub_request(:get, "https://files.gb1.brightbox.com/v1").
+        with(:headers => {
+        "Host" => "files.gb1.brightbox.com:443",
+        "X-Auth-User" => "",
+        "X-Auth-Key" => ""
+      }).to_return(:status => 412, :body => "Bad URL", :headers => {})
+    end
+
+    it "fails" do
+      settings = {}
+      @config = Fog::Brightbox::Config.new(settings)
+      @request = Fog::Brightbox::Storage::AuthenticationRequest.new(@config)
+      refute @request.authenticate
+    end
+  end
+
+  describe "when initialised with API client details" do
+    before do
+      stub_request(:get, "https://files.gb1.brightbox.com/v1").
+        with(:headers => {
+          "Host" => "files.gb1.brightbox.com:443",
+          "X-Auth-User" => "cli-12345",
+          "X-Auth-Key" => "12345"
+      }).to_return(:status => 200, :body => "Authenticated", :headers => {
+        "X-Storage-Url" => "https://files.gb1.brightbox.com/v1/acc-12345",
+        "X-Storage-Token" => "abcdefghijklmnopqrstuvwxyz1234567890",
+        "X-Auth-Token" => "abcdefghijklmnopqrstuvwxyz1234567890",
+        "Content-Type" => "text/plain"
+      })
+    end
+
+    it "authenticates correctly" do
+      settings = {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "12345"
+      }
+      @config = Fog::Brightbox::Config.new(settings)
+      @request = Fog::Brightbox::Storage::AuthenticationRequest.new(@config)
+      assert @request.authenticate
+    end
+  end
+
+  describe "when initialised with user details" do
+    before do
+      stub_request(:get, "https://files.gb1.brightbox.com/v1").
+        with(:headers => {
+          "Host" => "files.gb1.brightbox.com:443",
+          "X-Auth-User" => "user@example.com",
+          "X-Auth-Key" => "abcde"
+      }).to_return(:status => 200, :body => "Authenticated", :headers => {
+        "X-Storage-Url" => "https://files.gb1.brightbox.com/v1/acc-12345",
+        "X-Storage-Token" => "abcdefghijklmnopqrstuvwxyz1234567890",
+        "X-Auth-Token" => "abcdefghijklmnopqrstuvwxyz1234567890",
+        "Content-Type" => "text/plain"
+      })
+    end
+
+    it "authenticates correctly" do
+      settings = {
+        :brightbox_client_id => "app-12345",
+        :brightbox_secret => "12345",
+        :brightbox_username => "user@example.com",
+        :brightbox_password => "abcde"
+      }
+      @config = Fog::Brightbox::Config.new(settings)
+      @request = Fog::Brightbox::Storage::AuthenticationRequest.new(@config)
+      assert @request.authenticate
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require "minitest/autorun"
+require "fog/brightbox"
+
+describe Fog::Brightbox::Storage::Config do
+  describe "when required arguments are included" do
+    it "nothing is raised" do
+      settings = {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "1234567890"
+      }
+      config = Fog::Brightbox::Config.new(settings)
+      Fog::Brightbox::Storage::Config.new(config)
+      pass
+    end
+  end
+
+  describe "when client_id is not in configuration" do
+    it "raises ArgumentError" do
+      settings = {
+        :brightbox_secret => "1234567890"
+      }
+      config = Fog::Brightbox::Config.new(settings)
+      assert_raises ArgumentError do
+        Fog::Brightbox::Storage::Config.new(config)
+      end
+    end
+  end
+
+  describe "when client_secret is not in configuration" do
+    it "raises ArgumentError" do
+      settings = {
+        :brightbox_client_id => "cli-12345"
+      }
+      config = Fog::Brightbox::Config.new(settings)
+      assert_raises ArgumentError do
+        Fog::Brightbox::Storage::Config.new(config)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+require "minitest/autorun"
+require "webmock/minitest"
+require "fog/brightbox"
+
+describe Fog::Brightbox::Storage::Connection do
+  let(:config) { Fog::Brightbox::Config.new(settings) }
+  let(:connection) { Fog::Brightbox::Storage::Connection.new(config) }
+  let(:params) do
+    { :path => "fnord", :expects => [200] }
+  end
+  let(:settings) do
+    {
+      :brightbox_client_id => "app-12345",
+      :brightbox_secret => "1234567890",
+      :brightbox_storage_management_url => "https://files.gb2.brightbox.com/v1/acc-12345"
+    }
+  end
+  let(:valid_auth_token) { "01234567890abcdefghijklmnopqrstuvwxyz" }
+
+  {
+    400 => Excon::Errors::BadRequest,
+    401 => Fog::Brightbox::Storage::AuthenticationRequired,
+    402 => Excon::Errors::PaymentRequired,
+    403 => Excon::Errors::Forbidden,
+    404 => Fog::Storage::Brightbox::NotFound,
+    405 => Excon::Errors::MethodNotAllowed,
+    406 => Excon::Errors::NotAcceptable,
+    407 => Excon::Errors::ProxyAuthenticationRequired,
+    408 => Excon::Errors::RequestTimeout,
+    409 => Excon::Errors::Conflict,
+    410 => Excon::Errors::Gone,
+    411 => Excon::Errors::LengthRequired,
+    412 => Excon::Errors::PreconditionFailed,
+    413 => Excon::Errors::RequestEntityTooLarge,
+    414 => Excon::Errors::RequestURITooLong,
+    415 => Excon::Errors::UnsupportedMediaType,
+    416 => Excon::Errors::RequestedRangeNotSatisfiable,
+    417 => Excon::Errors::ExpectationFailed,
+    422 => Excon::Errors::UnprocessableEntity,
+    500 => Excon::Errors::InternalServerError,
+    501 => Excon::Errors::NotImplemented,
+    502 => Excon::Errors::BadGateway,
+    503 => Excon::Errors::ServiceUnavailable,
+    504 => Excon::Errors::GatewayTimeout
+  }.each do |status, error|
+    describe "when request responds with #{status}" do
+      it "raises #{error}" do
+        stub_request(:get, "https://files.gb2.brightbox.com/v1/acc-12345/fnord").
+          to_return(:status => status)
+        assert_raises(error) { connection.request(params) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+require "minitest/autorun"
+require "webmock/minitest"
+require "fog/brightbox"
+
+describe Fog::Brightbox::Storage::Connection do
+  let(:config) { Fog::Brightbox::Config.new(settings) }
+  let(:connection) { Fog::Brightbox::Storage::Connection.new(config) }
+  let(:params) do
+    { :path => "fnord", :expects => [200] }
+  end
+  let(:settings) do
+    {
+      :brightbox_client_id => "app-12345",
+      :brightbox_secret => "1234567890",
+      :brightbox_storage_management_url => "https://files.gb2.brightbox.com/v1/acc-12345"
+    }
+  end
+  let(:valid_auth_token) { "01234567890abcdefghijklmnopqrstuvwxyz" }
+
+  describe "when management URL is not available" do
+    let(:settings) do
+      {
+        :brightbox_client_id => "app-12345",
+        :brightbox_secret => "1234567890"
+      }
+    end
+
+    it "raises Fog::Brightbox::Storage::ManagementUrlUnknown" do
+      assert_raises(Fog::Brightbox::Storage::ManagementUrlUnknown) { connection.request(params) }
+    end
+  end
+
+  describe "when parameters are nil" do
+    let(:params) {}
+
+    it "raises ArgumentError" do
+      assert_raises(ArgumentError) { connection.request(params) }
+    end
+  end
+
+  describe "when parameters are empty" do
+    let(:params) { {} }
+
+    before do
+      stub_request(:get, "https://files.gb2.brightbox.com/v1/acc-12345").
+        with(:headers => {
+        "Accept" => "application/json",
+        "Content-Type" => "application/json",
+        "X-Auth-Token" => valid_auth_token
+      }).to_return(:status => 200, :body => "{}", :headers => {
+        "Content-Type" => "application/json"
+      })
+    end
+
+    it "completes successfully" do
+      config.stub :latest_access_token, valid_auth_token do
+        connection.request(params)
+        pass
+      end
+    end
+  end
+
+  describe "when request should succeed" do
+    before do
+      stub_request(:get, "https://files.gb2.brightbox.com/v1/acc-12345/fnord").
+        with(:headers => {
+        "Accept" => "application/json",
+        "Content-Type" => "application/json",
+        "X-Auth-Token" => valid_auth_token
+      }).to_return(:status => 200, :body => "{}", :headers => {
+        "Content-Type" => "application/json"
+      })
+    end
+
+    it "completes successfully" do
+      config.stub :latest_access_token, valid_auth_token do
+        connection.request(params)
+        pass
+      end
+    end
+  end
+
+  describe "when custom headers are passed" do
+    let(:params) do
+      { :headers => { "X-Test" => "present" }, :path => "fnord" }
+    end
+
+    it "completes successfully" do
+      stub_request(:get, "https://files.gb2.brightbox.com/v1/acc-12345/fnord").
+        with(:headers => { "X-Test" => "present" }).to_return(:status => 200)
+
+      connection.request(params)
+      pass
+    end
+  end
+
+  describe "when container is not found" do
+    it "raises Fog::Storage::Brightbox::NotFound" do
+      stub_request(:get, "https://files.gb2.brightbox.com/v1/acc-12345/fnord").
+        to_return(:status => 404,
+                  :body => "<html><h1>Not Found</h1><p>The resource could not be found.</p></html>",
+                  :headers => {
+                    "Content-Type" => "text/html"
+                  })
+      assert_raises(Fog::Storage::Brightbox::NotFound) { connection.request(params) }
+    end
+  end
+
+  describe "when request is not authenticated" do
+    it "raises Fog::Brightbox::Storage::AuthenticationRequired" do
+      stub_request(:get, "https://files.gb2.brightbox.com/v1/acc-12345/fnord").
+        to_return(:status => 401,
+                  :body => "Authentication required",
+                  :headers => {
+                    "Content-Type" => "text/plain"
+                  })
+      assert_raises(Fog::Brightbox::Storage::AuthenticationRequired) { connection.request(params) }
+    end
+  end
+end

data/spec/fog/storage/brightbox_spec.rb

@@ -0,0 +1,290 @@
+require "minitest/autorun"
+require "webmock/minitest"
+require "fog/brightbox"
+
+describe Fog::Storage::Brightbox do
+  let(:valid_auth_response) do
+    {
+      :status => 200,
+      :body => "Authenticated",
+      :headers => {
+        "X-Storage-Url"=>"https://files.gb1.brightbox.com:443/v1/acc-12345",
+        "Content-Length"=>"13",
+        "X-Storage-Token"=>"c1236c8c34d668df497c06075d8a76a79c6fdd0d",
+        "Content-Type"=>"text/plain",
+        "X-Auth-Token"=>"c1236c8c34d668df497c06075d8a76a79c6fdd0d",
+        "X-Trans-Id"=>"txcb228b8b9bfe4d5184828-0053568313",
+        "Date"=>"Tue, 22 Apr 2014 14:56:20 GMT"
+      }
+    }
+  end
+  let(:config) { Fog::Brightbox::Config.new(settings) }
+  let(:service) { Fog::Storage::Brightbox.new(config) }
+
+  describe "when created without required arguments" do
+    it "raises an error" do
+      Fog.stub :credentials, {} do
+        assert_raises ArgumentError do
+          Fog::Storage::Brightbox.new({})
+        end
+      end
+    end
+  end
+
+  describe "when created with a Config object" do
+    let(:settings) do
+      {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "1234567890"
+      }
+    end
+
+    it "does not error" do
+      service
+      pass
+    end
+  end
+
+  describe "when created with Config missing required settings" do
+    let(:settings) { {} }
+
+    it "raises ArgumentError" do
+      assert_raises ArgumentError do
+        Fog::Storage::Brightbox.new(config)
+      end
+    end
+  end
+
+  describe "when created with a viable config" do
+    let(:settings) do
+      {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "fdkls"
+      }
+    end
+
+    before do
+      stub_request(:get, "https://files.gb1.brightbox.com/v1").to_return(valid_auth_response)
+    end
+
+    it "requires a call to authenticate" do
+      assert service.needs_to_authenticate?
+    end
+
+    it "requires a call to discover management_url" do
+      assert_nil service.management_url
+    end
+
+    it "can authenticate" do
+      service.authenticate
+      assert_equal "https://files.gb1.brightbox.com/v1/acc-12345", service.management_url.to_s
+    end
+  end
+
+  describe "when created with bad credentials" do
+    let(:settings) do
+      {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "wrong"
+      }
+    end
+
+    it "fails to authenticate" do
+      response =  {
+        :body=>"Bad URL",
+        :headers=>
+        {"Content-Length"=>"7",
+         "Content-Type"=>"text/html; charset=UTF-8",
+         "X-Trans-Id"=>"txab03ff4864ff42989f4a1-0053568282",
+         "Date"=>"Tue, 22 Apr 2014 14:53:54 GMT"},
+         :status=>412
+      }
+      stub_request(:get, "https://files.gb1.brightbox.com/v1").to_return(response)
+
+      service.authenticate
+      assert_nil service.management_url
+    end
+  end
+
+  describe "when configured scoped to a specific account" do
+    let(:settings) do
+      {
+        :brightbox_client_id => "app-12345",
+        :brightbox_secret => "12345",
+        :brightbox_username => "user@example.com",
+        :brightbox_password => "abcde",
+        :brightbox_account => "acc-abcde"
+      }
+    end
+
+    before do
+      stub_request(:get, "https://files.gb1.brightbox.com/v1").to_return(valid_auth_response)
+    end
+
+    it "uses the configured account" do
+      assert service.authenticate
+      assert_equal "acc-abcde", service.account
+    end
+  end
+
+  describe "when account is not configured" do
+    let(:settings) do
+      {
+        :brightbox_client_id => "app-12345",
+        :brightbox_secret => "12345",
+        :brightbox_username => "user@example.com",
+        :brightbox_password => "abcde"
+      }
+    end
+
+    before do
+      stub_request(:get, "https://files.gb1.brightbox.com/v1").to_return(valid_auth_response)
+    end
+
+    it "extracts the account from the management URL" do
+      assert service.authenticate
+      assert_equal "acc-12345", service.account
+    end
+  end
+
+  describe "when configured with existing token" do
+    let(:settings) do
+      {
+        :brightbox_client_id => "app-12345",
+        :brightbox_secret => "12345",
+        :brightbox_access_token => "1234567890abcdefghijklmnopqrstuvwxyz",
+        :brightbox_refresh_token => "1234567890abcdefghijklmnopqrstuvwxyz"
+      }
+    end
+
+    it "does not need to authenticate" do
+      refute service.needs_to_authenticate?
+    end
+
+    it "requires a call to discover management_url" do
+      assert_nil service.management_url
+    end
+  end
+
+  describe "when configured with tokens and management_url" do
+    let(:settings) do
+       {
+        :brightbox_client_id => "app-12345",
+        :brightbox_secret => "12345",
+        :brightbox_access_token => "1234567890abcdefghijklmnopqrstuvwxyz",
+        :brightbox_refresh_token => "1234567890abcdefghijklmnopqrstuvwxyz",
+        :brightbox_storage_management_url => "https://files.gb2.brightbox.com/v1/acc-12345"
+      }
+    end
+
+    it "does not need to authenticate" do
+      refute service.needs_to_authenticate?
+    end
+
+    it "uses configured management_url" do
+      assert_equal "https://files.gb2.brightbox.com/v1/acc-12345", service.management_url.to_s
+    end
+
+    it "keeps setting after authentication" do
+      stub_request(:get, "https://files.gb1.brightbox.com/v1").to_return(valid_auth_response)
+      config.expire_tokens!
+      service.authenticate
+      assert_equal "https://files.gb2.brightbox.com/v1/acc-12345", service.management_url.to_s
+    end
+  end
+
+  describe "when configured with expired tokens" do
+    let(:settings) do
+       {
+        :brightbox_client_id => "app-12345",
+        :brightbox_secret => "12345",
+        :brightbox_access_token => "1234567890abcdefghijklmnopqrstuvwxyz",
+        :brightbox_refresh_token => "1234567890abcdefghijklmnopqrstuvwxyz",
+        :brightbox_storage_management_url => "https://files.gb2.brightbox.com/v1/acc-12345",
+        :brightbox_token_management => false
+      }
+    end
+
+    before do
+      # Ongoing request but tokens are expired
+      stub_request(:get, "https://files.gb2.brightbox.com/v1/acc-12345/fnord").
+        to_return(:status => 401,
+                  :body => "Authentication required",
+                  :headers => { "Content-Type" => "text/plain" })
+    end
+
+    let(:params) { { :expects => [200], :path => "fnord" } }
+
+    it "raises Fog::Brightbox::Storage::AuthenticationRequired" do
+      assert_raises(Fog::Brightbox::Storage::AuthenticationRequired) { service.request(params) }
+    end
+  end
+
+  describe "when configured with user details and expired tokens" do
+    let(:settings) do
+       {
+        :brightbox_client_id => "app-12345",
+        :brightbox_secret => "12345",
+        :brightbox_username => "user@example.com",
+        :brightbox_password => "12345",
+        :brightbox_access_token => "1234567890abcdefghijklmnopqrstuvwxyz",
+        :brightbox_refresh_token => "1234567890abcdefghijklmnopqrstuvwxyz",
+        :brightbox_storage_url => "https://files.gb2.brightbox.com",
+        :brightbox_storage_management_url => "https://files.gb2.brightbox.com/v1/acc-12345"
+      }
+    end
+
+    before do
+      # Ongoing request but tokens are expired
+      stub_request(:get, "https://files.gb2.brightbox.com/v1/acc-12345/fnord").
+        with(:headers => { "X-Auth-Token" => "1234567890abcdefghijklmnopqrstuvwxyz" }).
+        to_return(:status => 401,
+                  :body => "Authentication required",
+                  :headers => { "Content-Type" => "text/plain" })
+
+      # The reauthentication
+      stub_request(:get, "https://files.gb2.brightbox.com/v1").
+        with(:headers => { "X-Auth-User" => "user@example.com", "X-Auth-Key" => "12345" }).
+        to_return(valid_auth_response)
+
+      # Repeated request
+      stub_request(:get, "https://files.gb2.brightbox.com/v1/acc-12345/fnord").
+        with(:headers => { "X-Auth-Token" => "c1236c8c34d668df497c06075d8a76a79c6fdd0d" }).
+        to_return(:status => 200)
+    end
+
+    let(:params) { { :expects => [200], :path => "fnord" } }
+
+    it "authenticates again and retries" do
+      service.request(params)
+      pass
+    end
+  end
+
+  describe "when configured with client credentials" do
+    let(:settings) do
+      {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "12345"
+      }
+    end
+
+    before do
+      # Initial authentication
+      stub_request(:get, "https://files.gb1.brightbox.com/v1").
+        with(:headers => {"X-Auth-Key" => "12345", "X-Auth-User" => "cli-12345"}).
+        to_return(valid_auth_response)
+
+      stub_request(:get, "https://files.gb1.brightbox.com/v1/acc-12345/fnord").
+        with(:headers => { "X-Auth-Token" => "c1236c8c34d668df497c06075d8a76a79c6fdd0d" }).
+        to_return(:status => 200)
+    end
+
+    let(:params) { { :expects => [200], :path => "fnord" } }
+
+    it "authenticates again and retries" do
+      service.request(params)
+      pass
+    end
+  end
+end