fog-brightbox 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c828f450aae49fe5ef940159c7cdaee50804594
-  data.tar.gz: 6ab4e5663ebb90199b0e01b8d38cf117479c4d27
+  metadata.gz: 885f9a5d7a53d8239ab311b2a6fb621b147bfd82
+  data.tar.gz: 9bd4bb8e36fc2ee1ff504dec8f795ccf0f0aa6d8
 SHA512:
-  metadata.gz: d7ba85e84d50f9689c9262836196c02629e470613d26cbd403c0319f16cc513bc09d06ca8d7f0e4762cbe2dec4f0dc4212058bb9289e35702c3d27a20e480381
-  data.tar.gz: 19d9f5dfac3c1825c9bc21749a1baf5ff68c4f0b87a3a210c519dd90837c2e0fcf19a008a6c037ed4ebf106cbbf4d9543873d798abf2a3b29f124a17b1849e9b
+  metadata.gz: 0a87b352d2167daedb10f233d6f941c0923b4b0d10d371f5387d283ffd18e4ee7987e3fcfd27350f375331879ee883a4911b85e9f6a32c0b9180567f4e66e614
+  data.tar.gz: 8e3758fa7350541363f744096379c0c065ead22f479c911a945ae56d27ed81c0b3676ac3cd3ee8f0d39b27b7c3eceb054ac6103b1feaadf5a1b5b82213547867

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.4.0 / 2014-08-28
+
+Enhancements:
+
+* Add Add support for Brightbox Orbit cloud storage service. This adds a
+  `storage` service to the Brightbox provider using the standard `fog`
+  interfaces.
+
 ### 0.3.0 / 2014-08-12
 
 Enhancements:

data/lib/fog/brightbox.rb

@@ -1 +1,2 @@
 require 'fog/brightbox/compute'
+require 'fog/brightbox/storage'

data/lib/fog/brightbox/config.rb

@@ -1,3 +1,5 @@
+require "fog/brightbox/oauth2"
+
 module Fog
   module Brightbox
     # The {Fog::Brightbox::Config} class is designed to encapsulate a group of settings for reuse
@@ -49,6 +51,21 @@ module Fog
         @options = options
       end
 
+      # @return [OAuth2::CredentialSet]
+      def credentials
+        @credentials ||= OAuth2::CredentialSet.new(client_id, client_secret, {
+          :username => username,
+          :password => password,
+          :access_token => cached_access_token,
+          :refresh_token => cached_refresh_token
+        })
+      end
+
+      # @return [Boolean]
+      def user_credentials?
+        credentials.user_details?
+      end
+
       # Can this be used to configure services? Yes, yes it can.
       #
       # @return [true]
@@ -71,7 +88,24 @@ module Fog
       end
       alias_method :api_url, :compute_url
 
-      # @return [String] The configured  identifier of the API client or user application.
+      def storage_url
+        URI.parse(@options[:brightbox_storage_url] || "https://files.gb1.brightbox.com")
+      end
+
+      def storage_management_url
+        @storage_management_url ||= if @options.key?(:brightbox_storage_management_url)
+          URI.parse(@options[:brightbox_storage_management_url])
+        else
+          nil
+        end
+      end
+
+      # @param [URI] management_url The URI to use for management requests.
+      def storage_management_url=(management_url)
+        @storage_management_url = management_url
+      end
+
+      # @return [String] The configured identifier of the API client or user application.
       def client_id
         @options[:brightbox_client_id]
       end
@@ -93,7 +127,21 @@ module Fog
 
       # @return [String] The configured account identifier to scope API requests by.
       def account
-        @options[:brightbox_account]
+        @current_account ||= @options[:brightbox_account]
+      end
+
+      # This changes the scoped account from the originally configured one to another.
+      #
+      # @return [String] The new account identifier used to scope API requests by.
+      def change_account(new_account)
+        @current_account = new_account
+      end
+
+      # Sets the scoped account back to originally configured one.
+      #
+      # @return [String] The configured account identifier to scope API requests by.
+      def reset_account
+        @current_account = @options[:brightbox_account]
       end
 
       def connection_options
@@ -109,10 +157,34 @@ module Fog
         @options[:brightbox_access_token]
       end
 
+      def latest_access_token
+        credentials.access_token
+      end
+
       def cached_refresh_token
         @options[:brightbox_refresh_token]
       end
 
+      # This is the current, most up to date refresh token.
+      def latest_refresh_token
+        credentials.refresh_token
+      end
+
+      def must_authenticate?
+        !credentials.access_token?
+      end
+
+      # Allows classes sharing to mark the tokens as invalid in response to API status codes.
+      def expire_tokens!
+        update_tokens(nil)
+      end
+
+      # @param [String] access_token The new access token to use
+      # @param [String] refresh_token The new refresh token to use
+      def update_tokens(access_token, refresh_token = nil, expires_in = nil)
+        credentials.update_tokens(access_token, refresh_token, expires_in)
+      end
+
       def managed_tokens?
         @options.fetch(:brightbox_token_management, true)
       end
@@ -120,6 +192,34 @@ module Fog
       def default_image_id
         @options.fetch(:brightbox_default_image, nil)
       end
+
+      def latest_token
+        @options[:brightbox_access_token]
+      end
+
+      def service_type
+        @options[:brightbox_service_type] || "object-store"
+      end
+
+      def service_name
+        @options[:brightbox_service_name]
+      end
+
+      def region
+        @options[:brightbox_region]
+      end
+
+      def tenant
+        @options[:brightbox_tenant]
+      end
+
+      def storage_connection_options
+        @options[:connection_options] || {}
+      end
+
+      def storage_temp_key
+        @options[:brightbox_temp_url_key]
+      end
     end
   end
 end

data/lib/fog/brightbox/core.rb

@@ -7,5 +7,6 @@ module Fog
     extend Fog::Provider
 
     service(:compute, 'Compute')
+    service(:storage, 'Storage')
   end
 end

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

@@ -9,13 +9,15 @@ module Fog
         attribute :description
         attribute :secret
         attribute :revoked_at, :type => :time
+        attribute :permissions_group
         attribute :account_id
 
         def save
           raise Fog::Errors::Error.new('Resaving an existing object may create a duplicate') if persisted?
           options = {
             :name => name,
-            :description => description
+            :description => description,
+            :permissions_group => permissions_group
           }.delete_if { |k, v| v.nil? || v == "" }
           data = service.create_api_client(options)
           merge_attributes(data)

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

@@ -0,0 +1,45 @@
+require 'fog/core/collection'
+require 'fog/brightbox/models/storage/directory'
+
+module Fog
+  module Storage
+    class Brightbox
+
+      class Directories < Fog::Collection
+
+        model Fog::Storage::Brightbox::Directory
+
+        HEADER_ATTRIBUTES = [
+          'X-Container-Bytes-Used', 'X-Container-Object-Count', 'X-Container-Read',
+          'X-Container-Write'
+        ]
+
+        def all
+          data = service.get_containers.body
+          load(data)
+        end
+
+        def get(key, options = {})
+          data = service.get_container(key, options)
+          directory = new(:key => key)
+          for key, value in data.headers
+            if HEADER_ATTRIBUTES.include?(key)
+              directory.merge_attributes(key => value)
+            end
+          end
+          directory.files.merge_attributes(options)
+          directory.files.instance_variable_set(:@loaded, true)
+
+          data.body.each do |file|
+            directory.files << directory.files.new(file)
+          end
+          directory
+        rescue Fog::Storage::Brightbox::NotFound
+          nil
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+require "fog/core/model"
+require "fog/brightbox/models/storage/files"
+
+module Fog
+  module Storage
+    class Brightbox
+      class Directory < Fog::Model
+        identity  :key, :aliases => "name"
+
+        attribute :bytes, :aliases => "X-Container-Bytes-Used"
+        attribute :count, :aliases => "X-Container-Object-Count"
+        attribute :read_permissions, :aliases => "X-Container-Read"
+        attribute :write_permissions, :aliases => "X-Container-Write"
+
+        def destroy
+          requires :key
+          service.delete_container(key)
+          true
+        rescue Excon::Errors::NotFound
+          false
+        end
+
+        def files
+          @files ||= begin
+            Fog::Storage::Brightbox::Files.new(
+              :directory    => self,
+              :service   => service
+            )
+          end
+        end
+
+        def public=(new_public)
+          @public = new_public
+        end
+
+        def public_url
+          #raise NotImplementedError
+          ""
+        end
+
+        def save
+          requires :key
+          options = {
+            'read_permissions' => read_permissions,
+            'write_permissions' => write_permissions
+          }
+          service.put_container(key, options)
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,166 @@
+require 'fog/core/model'
+
+module Fog
+  module Storage
+    class Brightbox
+
+      class File < Fog::Model
+
+        identity  :key,             :aliases => 'name'
+
+        attribute :content_length,  :aliases => ['bytes', 'Content-Length'], :type => :integer
+        attribute :content_type,    :aliases => ['content_type', 'Content-Type']
+        attribute :content_disposition, :aliases => ['content_disposition', 'Content-Disposition']
+        attribute :etag,            :aliases => ['hash', 'Etag']
+        attribute :last_modified,   :aliases => ['last_modified', 'Last-Modified'], :type => :time
+        attribute :access_control_allow_origin, :aliases => ['Access-Control-Allow-Origin']
+        attribute :origin,          :aliases => ['Origin']
+
+        def body
+          attributes[:body] ||= if last_modified
+            collection.get(identity).body
+          else
+            ''
+          end
+        end
+
+        def body=(new_body)
+          attributes[:body] = new_body
+        end
+
+        def directory
+          @directory
+        end
+
+        def copy(target_directory_key, target_file_key, options={})
+          requires :directory, :key
+          options['Content-Type'] ||= content_type if content_type
+          options['Access-Control-Allow-Origin'] ||= access_control_allow_origin if access_control_allow_origin
+          options['Origin'] ||= origin if origin
+          service.copy_object(directory.key, key, target_directory_key, target_file_key, options)
+          target_directory = service.directories.new(:key => target_directory_key)
+          target_directory.files.get(target_file_key)
+        end
+
+        def destroy
+          requires :directory, :key
+          service.delete_object(directory.key, key)
+          true
+        end
+
+        def metadata
+          @metadata ||= headers_to_metadata
+        end
+
+        def owner=(new_owner)
+          if new_owner
+            attributes[:owner] = {
+              :display_name => new_owner['DisplayName'],
+              :id           => new_owner['ID']
+            }
+          end
+        end
+
+        def public=(new_public)
+          new_public
+        end
+
+        # Get a url for file.
+        #
+        #     required attributes: key
+        #
+        # @param expires [String] number of seconds (since 1970-01-01 00:00) before url expires
+        # @param options [Hash]
+        # @return [String] url
+        #
+        def url(expires, options = {})
+          requires :directory, :key
+          self.service.create_temp_url(directory.key, key, expires, "GET", options)
+        end
+
+        def public_url
+          requires :key
+          self.collection.get_url(self.key)
+        end
+
+
+        def save(options = {})
+          requires :body, :directory, :key
+          options['Content-Type'] = content_type if content_type
+          options['Content-Disposition'] = content_disposition if content_disposition
+          options['Access-Control-Allow-Origin'] = access_control_allow_origin if access_control_allow_origin
+          options['Origin'] = origin if origin
+          options.merge!(metadata_to_headers)
+
+          data = service.put_object(directory.key, key, body, options)
+          update_attributes_from(data)
+          refresh_metadata
+
+          self.content_length = Fog::Storage.get_body_size(body)
+          self.content_type ||= Fog::Storage.get_content_type(body)
+          true
+        end
+
+        private
+
+        def directory=(new_directory)
+          @directory = new_directory
+        end
+
+        def refresh_metadata
+          metadata.reject! {|k, v| v.nil? }
+        end
+
+        def headers_to_metadata
+          key_map = key_mapping
+          Hash[metadata_attributes.map {|k, v| [key_map[k], v] }]
+        end
+
+        def key_mapping
+          key_map = metadata_attributes
+          key_map.each_pair {|k, v| key_map[k] = header_to_key(k)}
+        end
+
+        def header_to_key(opt)
+          opt.gsub(metadata_prefix, '').split('-').map {|k| k[0, 1].downcase + k[1..-1]}.join('_').to_sym
+        end
+
+        def metadata_to_headers
+          header_map = header_mapping
+          Hash[metadata.map {|k, v| [header_map[k], v] }]
+        end
+
+        def header_mapping
+          header_map = metadata.dup
+          header_map.each_pair {|k, v| header_map[k] = key_to_header(k)}
+        end
+
+        def key_to_header(key)
+          metadata_prefix + key.to_s.split(/[-_]/).map(&:capitalize).join('-')
+        end
+
+        def metadata_attributes
+          if last_modified
+            headers = service.head_object(directory.key, self.key).headers
+            headers.reject! {|k, v| !metadata_attribute?(k)}
+          else
+            {}
+          end
+        end
+
+        def metadata_attribute?(key)
+          key.to_s =~ /^#{metadata_prefix}/
+        end
+
+        def metadata_prefix
+          "X-Object-Meta-"
+        end
+
+        def update_attributes_from(data)
+          merge_attributes(data.headers.reject {|key, value| ['Content-Length', 'Content-Type'].include?(key)})
+        end
+      end
+
+    end
+  end
+end