fog-rackspace 0.1.0

data/lib/fog/rackspace/requests/queues/create_message.rb

@@ -0,0 +1,56 @@
+module Fog
+  module Rackspace
+    class Queues
+      class Real
+        # This operation posts the specified message or messages.
+        # @note You can submit up to 10 messages in a single request.
+        #
+        # @param [String] client_id UUID for the client instance.
+        # @param [String] queue_name Specifies the name of the queue.
+        # @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).
+        # @return [Excon::Response] response
+        # @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 create_message(client_id, queue_name, body, ttl)
+          data = [{
+            :ttl => ttl,
+            :body => body
+          }]
+          request(
+            :body => Fog::JSON.encode(data),
+            :expects => 201,
+            :method => 'POST',
+            :path => "queues/#{queue_name}/messages",
+            :headers => { 'Client-ID' => client_id }
+          )
+        end
+      end
+
+      class Mock
+        def create_message(client_id, queue_name, body, ttl)
+          queue = mock_queue!(queue_name)
+
+          raise BadRequest.new if body.nil? || body.empty?
+
+          # Ensure that any Symbol keys within +body+ are converted to Strings, just as being
+          # round-tripped through the API will.
+          converted = MockData.stringify(body)
+          message = queue.add_message(client_id, converted, ttl)
+
+          response = Excon::Response.new
+          response.status = 201
+          response.body = {
+            "partial" => false,
+            "resources" => ["#{PATH_BASE}/#{queue_name}/messages/#{message.id}"]
+          }
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/queues/create_queue.rb

@@ -0,0 +1,39 @@
+module Fog
+  module Rackspace
+    class Queues
+      class Real
+        # This operation creates a new queue.
+        # The body of the request is empty.
+        #
+        # @param [String] queue_name Specifies the name of the queue.
+        # @return [Excon::Response] response
+        # @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/PUT_createQueue__version__queues__queue_name__queue-operations-dle001.html
+        def create_queue(queue_name)
+          request(
+            :body => Fog::JSON.encode({}),
+            :expects => 201,
+            :method => 'PUT',
+            :path => "queues/#{queue_name}"
+          )
+        end
+      end
+
+      class Mock
+        def create_queue(queue_name)
+          raise MethodNotAllowed.new if queue_name.nil? || queue_name.empty?
+
+          existed = ! mock_queue(queue_name).nil?
+          add_queue(queue_name) unless existed
+
+          response = Excon::Response.new
+          response.status = existed ? 201 : 204
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/queues/delete_claim.rb

@@ -0,0 +1,42 @@
+module Fog
+  module Rackspace
+    class Queues
+      class Real
+        # This operation immediately releases a claim, making any remaining, undeleted) messages that are associated with the claim available to other workers.
+        # Claims with malformed IDs or claims that are not found by ID are ignored.
+        #
+        # @param [String] queue_name Specifies the name of the queue.
+        # @param [String] claim_id Specifies the claim ID.
+        # @return [Excon::Response] response
+        # @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_deleteClaim__version__queues__queue_name__claims__claimId__claims-operations-dle001.html
+        def delete_claim(queue_name, claim_id)
+          request(
+            :expects => 204,
+            :method => 'DELETE',
+            :path => "queues/#{queue_name}/claims/#{claim_id}"
+          )
+        end
+      end
+
+      class Mock
+        def delete_claim(queue_name, claim_id)
+          queue = mock_queue!(queue_name)
+          claim = queue.claim!(claim_id)
+
+          claim.messages.each do |message|
+            message.claim = nil
+          end
+          queue.claims.delete(claim_id)
+
+          response = Excon::Response.new
+          response.status = 204
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/queues/delete_message.rb

@@ -0,0 +1,62 @@
+module Fog
+  module Rackspace
+    class Queues
+      class Real
+        # This operation immediately deletes the specified message.
+        # @note If you do not specify claim_id, but the message is claimed, the operation fails. You can only delete claimed messages by providing an appropriate claim_id.
+        #
+        # @param [String] queue_name Specifies the name of the queue.
+        # @param [String] message_id Specifies the message ID.
+        # @param [Hash] options
+        # @option options [Integer] :claim_id - Identifies the claim.
+        # @return [Excon::Response] response
+        # @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 delete_message(queue_name, message_id, options = {})
+          query = {}
+          query[:claim_id] = options[:claim_id] if options.key? :claim_id
+          request(
+            :expects => 204,
+            :method => 'DELETE',
+            :path => "queues/#{queue_name}/messages/#{message_id}",
+            :query => query
+          )
+        end
+      end
+
+      class Mock
+        def delete_message(queue_name, message_id, options = {})
+          queue = mock_queue!(queue_name)
+
+          claim_id = options[:claim_id]
+
+          message = queue.messages.find { |m| m.id == message_id }
+
+          perform_delete = true
+          if message && message.claimed?
+            unless message.claim.id == claim_id
+              # Currently returns a 204 without deleting!
+              perform_delete = false
+            end
+          else
+            if claim_id
+              # Currently returns a 204 without deleting!
+              perform_delete = false
+            end
+          end
+
+          if perform_delete
+            queue.messages.reject! { |m| m.id == message_id }
+          end
+
+          response = Excon::Response.new
+          response.status = 204
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/queues/delete_queue.rb

@@ -0,0 +1,33 @@
+module Fog
+  module Rackspace
+    class Queues
+      class Real
+        # This operation immediately deletes a queue and all of its existing messages.
+        #
+        # @param [String] queue_name Specifies the name of the queue.
+        # @return [Excon::Response] response
+        # @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 delete_queue(queue_name)
+          request(
+            :expects => 204,
+            :method => 'DELETE',
+            :path => "queues/#{queue_name}"
+          )
+        end
+      end
+
+      class Mock
+        def delete_queue(queue_name)
+          data.delete(queue_name)
+          response = Excon::Response.new
+          response.status = 204
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/queues/get_claim.rb

@@ -0,0 +1,37 @@
+module Fog
+  module Rackspace
+    class Queues
+      class Real
+        # This operation queries the specified claim for the specified queue. Claims with malformed IDs or claims that are not found by ID are ignored.
+        #
+        # @param [String] queue_name Specifies the name of the queue.
+        # @param [Integer] claim_id Specifies the claim ID.
+        # @return [Excon::Response] response
+        # @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/GET_queryClaim__version__queues__queue_name__claims__claimId__claims-operations-dle001.html
+        def get_claim(queue_name, claim_id)
+          request(
+            :expects => 200,
+            :method => 'GET',
+            :path => "queues/#{queue_name}/claims/#{claim_id}"
+          )
+        end
+      end
+
+      class Mock
+        def get_claim(queue_name, claim_id)
+          queue = mock_queue!(queue_name)
+          claim = queue.claim!(claim_id)
+
+          response = Excon::Response.new
+          response.status = 200
+          response.body = claim.to_h
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/queues/get_message.rb

@@ -0,0 +1,41 @@
+module Fog
+  module Rackspace
+    class Queues
+      class Real
+        # This operation gets the specified message from the specified queue.
+        #
+        # @param [String] client_id UUID for the client instance.
+        # @param [String] queue_name Specifies the name of the queue.
+        # @param [Integer] message_id Specifies the message ID.
+        # @return [Excon::Response] response
+        # @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/GET_getSpecificMessage__version__queues__queue_name__messages__messageId__message-operations-dle001.html
+        def get_message(client_id, queue_name, message_id)
+          request(
+            :expects => 200,
+            :method => 'GET',
+            :path => "queues/#{queue_name}/messages/#{message_id}",
+            :headers => { 'Client-ID' => client_id }
+          )
+        end
+      end
+
+      class Mock
+        def get_message(client_id, queue_name, message_id)
+          queue = mock_queue!(queue_name)
+
+          message = queue.messages.find { |msg| msg.id == message_id }
+          raise NotFound.new unless message
+
+          response = Excon::Response.new
+          response.status = 200
+          response.body = message.to_h
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/queues/get_queue.rb

@@ -0,0 +1,36 @@
+module Fog
+  module Rackspace
+    class Queues
+      class Real
+        # This operation verifies whether the specified queue exists.
+        #
+        # @param [String] queue_name Specifies the name of the queue.
+        # @return [Excon::Response] response
+        # @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/GET_checkQueueExists__version__queues__queue_name__queue-operations-dle001.html
+        def get_queue(queue_name)
+          request(
+            :expects => [200, 204],
+            :method => 'GET',
+            :path => "queues/#{queue_name}"
+          )
+        end
+      end
+
+      class Mock
+        def get_queue(queue_name)
+          if mock_queue(queue_name).nil?
+            raise NotFound.new
+          else
+            response = Excon::Response.new
+            response.status = 204
+            response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/queues/get_queue_stats.rb

@@ -0,0 +1,57 @@
+module Fog
+  module Rackspace
+    class Queues
+      class Real
+        # This operation returns queue statistics, including how many messages are in the queue, categorized by status.
+        #
+        # @param [String] queue_name Specifies the name of the queue.
+        # @return [Excon::Response] response
+        # @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/GET_getQueueStats__version__queues__queue_name__stats_queue-operations-dle001.html
+        def get_queue_stats(queue_name)
+          request(
+            :expects => 200,
+            :method => 'GET',
+            :path => "queues/#{queue_name}/stats"
+          )
+        end
+      end
+
+      class Mock
+        def get_queue_stats(queue_name)
+          queue = mock_queue!(queue_name)
+
+          payload = {
+            "claimed" => queue.claimed,
+            "total" => queue.total,
+            "free" => queue.free
+          }
+
+          report_message(payload, "oldest", queue.oldest)
+          report_message(payload, "newest", queue.newest)
+
+          response = Excon::Response.new
+          response.status = 200
+          response.body = { "messages" => payload }
+          response
+        end
+
+        private
+
+        def report_message(payload, description, element)
+          return unless element
+
+          ctime = Time.at(element.created).utc
+          payload[description] = {
+            "age" => element.age,
+            "href" => element.href,
+            "created" => ctime.strftime("%Y-%m-%dT%I:%M:%SZ")
+          }
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/queues/list_messages.rb

@@ -0,0 +1,73 @@
+module Fog
+  module Rackspace
+    class Queues
+      class Real
+        # This operation gets the message or messages in the specified queue.
+        #
+        # A request to list messages when the queue is not found or when messages are not found returns 204, instead of 200, because there was no information to send back.
+        # Messages with malformed IDs or messages that are not found by ID are ignored.
+        #
+        # @param [String] client_id UUID for the client instance.
+        # @param [String] queue_name Specifies the name of the queue.
+        # @param [Hash] options
+        # @option options [String] :marker - 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).
+        # @option options [Integer] :limit - 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.
+        # @option options [String] :echo - 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.
+        # @option options [String] :include_claimed - 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).
+        # @return [Excon::Response] response
+        # @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/GET_getMessages__version__queues__queue_name__messages_message-operations-dle001.html
+        def list_messages(client_id, queue_name, options = {})
+          request(
+            :expects => [200, 204],
+            :method => 'GET',
+            :path => "queues/#{queue_name}/messages",
+            :headers => { 'Client-ID' => client_id },
+            :query => options
+          )
+        end
+      end
+
+      class Mock
+        def list_messages(client_id, queue_name, options = {})
+          queue = mock_queue!(queue_name)
+
+          marker = (options[:marker] || "0").to_i
+          limit = options[:limit] || 10
+          echo = options[:echo] || false
+          include_claimed = options[:include_claimed] || false
+
+          next_marker = marker + limit + 1
+          messages = queue.messages[marker...next_marker]
+          messages.reject! { |m| m.producer_id == client_id } unless echo
+          messages.reject! { |m| m.claimed? } unless include_claimed
+
+          response = Excon::Response.new
+          if queue.messages.empty?
+            response.status = 204
+          else
+            response.status = 200
+            response.body = {
+              "messages" => messages.map { |m| m.to_h },
+              "links" => [{
+                "href" => "#{PATH_BASE}/#{queue_name}/messages?marker=#{next_marker}",
+                "rel" => "next"
+              }]
+            }
+          end
+          response
+        end
+      end
+    end
+  end
+end