fog-rackspace 0.1.0

data/lib/fog/rackspace/models/queues/message.rb

@@ -0,0 +1,88 @@
+require 'fog/core/model'
+
+module Fog
+  module Rackspace
+    class Queues
+      class Message < Fog::Model
+        # @!attribute [r] age
+        # @return [Integer] The number of seconds relative to the server's clock.
+        attribute :age
+
+        # @!attribute [rw] ttl
+        # @return [Integer] specifies how long the server waits before marking the message as expired and removing it from the queue.
+        # @note The value of ttl must be between 60 and 1209600 seconds (14 days). Note that the server might not actually delete the message until its
+        # age has reached up to (ttl + 60) seconds, to allow for flexibility in storage implementations.
+        attribute :ttl
+
+        # @!attribute [rw] body
+        # @return [String, Hash, Array] specifies an arbitrary document that constitutes the body of the message being sent. The size of this body is limited to 256 KB, excluding whitespace. The document must be valid JSON.
+        attribute :body
+
+        # @!attribute [r] href
+        # @return [String] location of the message
+        attribute :href
+
+        # @!attribute [r] claim_id
+        # @return [String] the id of the claim
+        attribute :claim_id
+
+        # @!attribute [r] identity
+        # @return [String] The messages identity
+        def identity
+          return nil unless href
+
+          match = href.match(/\A.*\/queues\/[a-zA-Z0-9_-]{0,64}\/messages\/(.+?)(?:\?|\z)/i)
+          match ? match[1] : nil
+        end
+        alias_method :id, :identity
+
+        # Creates messages
+        # Requires queue, client_id, body, and ttl attributes to be populated
+        # @note messages cannot be updated
+        #
+        # @return [Boolean] returns true if message has been succesfully saved
+        #
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Queues::ServiceError]
+        # @see http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/POST_postMessage__version__queues__queue_name__messages_message-operations-dle001.html
+        def save
+          requires :queue, :client_id, :body, :ttl
+          raise "Message has already been created and may not be updated." unless identity.nil?
+          data = service.create_message(client_id, queue.name, body, ttl).body
+          self.href = data['resources'][0]
+          true
+        end
+
+        # Destroys Message
+        #
+        # @return [Boolean] returns true if message is deleted
+        #
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Queues::ServiceError]
+        # @see http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/DELETE_deleteMessage__version__queues__queue_name__messages__messageId__message-operations-dle001.html
+        def destroy
+          requires :identity, :queue
+          options = {}
+          options[:claim_id] = claim_id unless claim_id.nil?
+
+          service.delete_message(queue.name, identity, options)
+          true
+        end
+
+        private
+
+        def queue
+          collection.queue
+        end
+
+        def client_id
+          collection.client_id
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/models/queues/messages.rb

@@ -0,0 +1,90 @@
+require 'fog/core/collection'
+require 'fog/rackspace/models/queues/message'
+
+module Fog
+  module Rackspace
+    class Queues
+      class Messages < Fog::Collection
+        model Fog::Rackspace::Queues::Message
+
+        # @!attribute [r] client_id
+        # @return [String] UUID for the client instance.
+        attr_accessor :client_id
+
+        # @!attribute [r] queue
+        # @return [String] The name of the queue associated with the message.
+        attr_accessor :queue
+
+        # @!attribute [rw] echo
+        # @return [Boolean] Determines whether the API returns a client's own messages. The echo parameter is a Boolean value (true or false) that determines whether the API
+        #   returns a client's own messages, as determined by the uuid portion of the User-Agent header. If you do not specify a value, echo uses the default value of false.
+        #   If you are experimenting with the API, you might want to set echo=true in order to see the messages that you posted.
+        attr_accessor :echo
+
+        # @!attribute [rw] limit
+        # @return [String]  When more messages are available than can be returned in a single request, the client can pick up the next batch of messages by simply using the URI
+        #   template parameters returned from the previous call in the "next" field. Specifies up to 10 messages (the default value) to return. If you do not specify a value
+        #   for the limit parameter, the default value of 10 is used.
+        attr_accessor :limit
+
+        # @!attribute [rw] marker
+        # @return [String] Specifies an opaque string that the client can use to request the next batch of messages. The marker parameter communicates to the server which
+        #   messages the client has already received. If you do not specify a value, the API returns all messages at the head of the queue (up to the limit).
+        attr_accessor :marker
+
+        # @!attribute [rw] include_claimed
+        # @return [String]  Determines whether the API returns claimed messages and unclaimed messages. The include_claimed parameter is a Boolean value (true or false)
+        #   that determines whether the API returns claimed messages and unclaimed messages. If you do not specify a value, include_claimed uses the default value of false
+        #   (only unclaimed messages are returned).
+        attr_accessor :include_claimed
+
+        # Returns list of messages
+        #
+        # @return [Fog::Rackspace::Queues::Messages] Retrieves a collection of messages.
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        def all
+          requires :client_id, :queue
+          response = service.list_messages(client_id, queue.name, options)
+          if response.status == 204
+            data = []
+          else
+            data = response.body['messages']
+          end
+          load(data)
+        end
+
+        # Returns the specified message from the queue.
+        #
+        # @param [Integer] message_id id of the message to be retrieved
+        # @return [Fog::Rackspace::Queues::Claim] Returns a claim
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Queues::ServiceError]
+        def get(message_id)
+          requires :client_id, :queue
+          data = service.get_message(client_id, queue.name, message_id).body
+          new(data)
+        rescue Fog::Rackspace::Queues::NotFound
+          nil
+        # HACK - This has been escalated to the Rackspace Queues team, as this
+        # behavior is not normal HTTP behavior.
+        rescue Fog::Rackspace::Queues::ServiceError
+          nil
+        end
+
+        private
+
+        def options
+          data = {}
+          data[:echo] = echo.to_s unless echo.nil?
+          data[:limit] = limit.to_s unless limit.nil?
+          data[:marker] = marker.to_s unless marker.nil?
+          data[:include_claimed] = include_claimed.to_s unless include_claimed.nil?
+          data
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/models/queues/queue.rb

@@ -0,0 +1,135 @@
+require 'fog/core/model'
+
+module Fog
+  module Rackspace
+    class Queues
+      class Queue < Fog::Model
+        # @!attribute [rw] name
+        # @return [String] name of queue
+        identity :name
+
+        # Returns list of messages in the queue
+        #
+        # @return [Fog::Rackspace::Queues::Messages] Retrieves a collection of messages.
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @see http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/GET_getMessages__version__queues__queue_name__messages_message-operations-dle001.html
+        def messages
+          @messages ||= begin
+            Fog::Rackspace::Queues::Messages.new({
+              :service => service,
+              :queue => self,
+              :client_id => service.client_id,
+              :echo => true
+            })
+          end
+        end
+
+        # Returns queue statistics, including how many messages are in the queue, categorized by status.
+        #
+        # @return [Hash] Retrieves a collection of messages.
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @see http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/GET_getQueueStats__version__queues__queue_name__stats_queue-operations-dle001.html
+        def stats
+          service.get_queue_stats(name).body['messages']
+        end
+
+        # Returns list of claims
+        # @note The Rackspace Cloud does not currently provide a way to retrieve claims as such this list is maintained by fog. Claims are added to the claim collection
+        # as they are created.
+        # @return [Fog::Rackspace::Queues::Claims] Retrieves a collection of claims.
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Queues::ServiceError]
+        def claims
+          @claims ||= begin
+            Fog::Rackspace::Queues::Claims.new({
+              :service => service,
+              :queue => self
+            })
+          end
+        end
+
+        # Helper method to enqueue a single message
+        #
+        # @param [String, Hash, Array] body The body attribute specifies an arbitrary document that constitutes the body of the message being sent. The size of this body is limited to 256 KB, excluding whitespace. The document must be valid JSON.
+        # @param [Integer] ttl The ttl attribute specifies how long the server waits before releasing the claim. The ttl value must be between 60 and 43200 seconds (12 hours).
+        # @param [Hash] options
+        # @return [Boolean] returns true if message has been succesfully enqueued
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Queues::ServiceError]
+        # @see http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/POST_postMessage__version__queues__queue_name__messages_message-operations-dle001.html
+        def enqueue(body, ttl, options = {})
+          messages.create(options.merge({:body => body, :ttl => ttl}))
+        end
+
+        # Helper method to claim (dequeue) a single message, yield the message, and then destroy it
+        #
+        # @param [Integer] ttl The ttl attribute specifies how long the server waits before releasing the claim. The ttl value must be between 60 and 43200 seconds (12 hours).
+        # @param [Integer] grace The grace attribute specifies the message grace period in seconds. The value of grace value must be between 60 and 43200 seconds (12 hours).
+        # @param [Hash] options
+        # @yieldparam message claimed [Fog::Rackspace::Queues::Message]
+        # @return [Boolean] Returns true if claim was successfully made
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Queues::ServiceError]
+        def dequeue(ttl, grace, options = {}, &block)
+          claim = claims.create(
+            options.merge(
+            {
+              :limit => 1,
+              :ttl => ttl,
+              :grace => grace
+            }))
+
+          if claim
+            message = claim.messages.first
+            yield message if block_given?
+            message.destroy
+            true
+          else
+            false
+          end
+        end
+
+        # Creates queue
+        # Requires name attribute to be populated
+        #
+        # @return [Boolean] returns true if queue has been succesfully saved
+        #
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Queues::ServiceError]
+        # @see http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/POST_postMessage__version__queues__queue_name__messages_message-operations-dle001.html
+        def save
+          requires :name
+          data = service.create_queue(name)
+          true
+        end
+
+        # Destroys queue
+        #
+        # @return [Boolean] returns true if queue is deleted
+        #
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Queues::ServiceError]
+        # @see http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/DELETE_deleteQueue__version__queues__queue_name__queue-operations-dle001.html
+        def destroy
+          requires :name
+          service.delete_queue(name)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/models/queues/queues.rb

@@ -0,0 +1,46 @@
+require 'fog/core/collection'
+require 'fog/rackspace/models/queues/queue'
+
+module Fog
+  module Rackspace
+    class Queues
+      class Queues < Fog::Collection
+        model Fog::Rackspace::Queues::Queue
+
+        # Returns list of queues
+        #
+        # @return [Fog::Rackspace::Queues::Queues] Retrieves a collection of queues.
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @see http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/GET_listQueues__version__queues_.html
+        def all
+          response = service.list_queues
+          if service.list_queues.status == 204
+            data = []
+          else
+            data = service.list_queues.body['queues']
+          end
+          load(data)
+        end
+
+        # This operation queries the specified queue.
+        #
+        # @param [String] queue_name Specifies the queue name
+        # @return [Fog::Rackspace::Queues::Queue] Returns a queue
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Queues::ServiceError]
+        # @see http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/GET_checkQueueExists__version__queues__queue_name__queue-operations-dle001.html
+        def get(queue_name)
+          #204 no content is returned on success.  That's why no data is passed
+          # from the GET to the constructor.
+          service.get_queue(queue_name)
+          new({:name => queue_name})
+        rescue Fog::Rackspace::Queues::NotFound
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/models/storage/account.rb

@@ -0,0 +1,50 @@
+require 'fog/core/model'
+
+module Fog
+  module Storage
+    class Rackspace
+      class Account < Fog::Model
+        # @see http://docs.rackspace.com/files/api/v1/cf-devguide/content/View_Account_Info-d1e11995.html
+
+        # @!attribute [rw] meta_temp_url_key
+        # @return [String] The temporary URL key used to generate temporary access to files
+        # @see http://docs.rackspace.com/files/api/v1/cf-devguide/content/Create_TempURL-d1a444.html
+        attribute :meta_temp_url_key, :aliases => 'X-Account-Meta-Temp-Url-Key'
+
+        # @!attribute [r] container_count
+        # @return [Integer] The number of containers in account
+        attribute :container_count, :aliases => 'X-Account-Container-Count', :type => :integer
+
+        # @!attribute [r] bytes_used
+        # @return [Integer] The total number of bytes used by the account
+        attribute :bytes_used, :aliases => 'X-Account-Bytes-Used', :type => :integer
+
+        # @!attribute [r] object_count
+        # @return [Integer] The total number of objects in the account
+        attribute :object_count, :aliases => 'X-Account-Object-Count', :type => :integer
+
+        # Saves account settings (meta_temp_url_key)
+        # @return [Boolean] returns true if successfully updated
+        # @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404
+        # @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400
+        # @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500
+        # @raise [Fog::Storage::Rackspace::ServiceError]
+        def save
+          service.post_set_meta_temp_url_key meta_temp_url_key
+          true
+        end
+
+        # Reload account with latest data from Cloud Files
+        # @return [Fog::Storage::Rackspace::Account] returns itself
+        # @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404
+        # @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400
+        # @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500
+        # @raise [Fog::Storage::Rackspace::ServiceError]
+        def reload
+          response = service.head_containers
+          merge_attributes response.headers
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require 'fog/core/collection'
+require 'fog/rackspace/models/storage/directory'
+
+module Fog
+  module Storage
+    class Rackspace
+      class Directories < Fog::Collection
+        model Fog::Storage::Rackspace::Directory
+
+        # Returns list of directories
+        # @return [Fog::Storage::Rackspace::Directories] Retrieves a list directories.
+        # @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404
+        # @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400
+        # @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500
+        # @raise [Fog::Storage::Rackspace::ServiceError]
+        # @note Fog's current implementation only returns 10,000 directories
+        # @see http://docs.rackspace.com/files/api/v1/cf-devguide/content/View_List_of_Containers-d1e1100.html
+        def all
+          data = service.get_containers.body
+          load(data)
+        end
+
+        # Retrieves directory
+        # @param [String] key  of directory
+        # @param options [Hash]:
+        # @option options [String] cdn_cname CDN CNAME used when calling Directory#public_url
+        # @return [Fog::Storage::Rackspace::Directory]
+        # @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404
+        # @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400
+        # @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500
+        # @raise [Fog::Storage::Rackspace::ServiceError]
+        # @example
+        #   directory = fog.directories.get('video', :cdn_cname => 'http://cdn.lunenburg.org')
+        #   files = directory.files
+        #   files.first.public_url
+        #
+        # @see Directory#public_url
+        # @see http://docs.rackspace.com/files/api/v1/cf-devguide/content/View-Container_Info-d1e1285.html
+        def get(key, options = {})
+          data = service.get_container(key, options)
+          directory = new(:key => key, :cdn_cname => options[:cdn_cname])
+          for key, value in data.headers
+            if ['X-Container-Bytes-Used', 'X-Container-Object-Count'].include?(key)
+              directory.merge_attributes(key => value)
+            end
+          end
+
+          directory.metadata = Metadata.from_headers(directory, data.headers)
+          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::Rackspace::NotFound
+          nil
+        end
+      end
+    end
+  end
+end