better_sqs 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bc6925375407c2cbf92a02ea941fd69473be9bc
-  data.tar.gz: e1edc6bf3cd3bdb58c44587f26be969c5abe8bc2
+  metadata.gz: 9fc0e03ed8b4c5106c87e9046b2911ededc75b45
+  data.tar.gz: b38ac02b1f0aac3bc3ee50424e98b54fa7851a31
 SHA512:
-  metadata.gz: 6541159a743aebac803e31cba94bb5e9836b05f520f1012c38390456483d69d7e7f6f37cb95153da653a2998a62bf752985add2513dbcab1d319a06c5891864f
-  data.tar.gz: 4323c5e50a27a610f2151e093996ebf7757c7196ad7c82f402f3f164c98261608af243087d6ffa6f925386f32c04851640fa89edf14aa8ad5a3940eebad6a4d9
+  metadata.gz: 286e9d755d6444667bc77abcaa124b0224e45c3fab2b6fa4470576a261c3607a5ebd33f377921717471899c90d72370c5d1f84a2093cced2edee5ef2721531c0
+  data.tar.gz: dcbdcfa04471da11f5033ffc6572f32b10b0b40f861c0a2fa12b2dbfb6ce433372aee278acebbd7d38b24ab5f57f4512b8140ff540ec7c1ae696217f28ecef18

data/.rubocop_todo.yml

@@ -1,12 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-01-26 02:10:21 +0000 using RuboCop version 0.35.1.
+# on 2016-04-12 01:43:20 +0000 using RuboCop version 0.35.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 15
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'spec/support/mocks.rb'
+
+# Offense count: 57
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 173

data/README.md

@@ -21,6 +21,44 @@ puts message.message_body
 message.delete
 ```
 
+If you prefer you can interact with a Queue directly for enqueue and dequeue operations
+
+```ruby
+require "better_sqs"
+
+better = BetterSqs::Client.new
+queue = better.queue "better_sqs_dev_queue"
+queue.push "You pushed the message successfully!"
+message = queue.reserve
+
+puts message.message_body
+message.delete
+```
+
+### Inspecting a queue
+
+BetterSqs makes it easy to check on the attributes of a SQS queue.
+
+```ruby
+require "better_sqs"
+
+better = BetterSqs::Client.new
+queue = better.queue("better_sqs_dev_queue")
+queue.approximate_number_of_messages
+queue.approximate_number_of_messages_not_visible
+queue.visibility_timeout
+queue.created_timestamp
+queue.last_modified_timestamp
+queue.policy
+queue.maximum_message_size
+queue.message_retention_period
+queue.queue_arn
+queue.approximate_number_of_messages_delayed
+queue.delay_seconds
+queue.receive_message_wait_time_seconds
+queue.redrive_policy
+```
+
 ## Configuration
 
 To configure BetterSqs use the configuration block pattern

data/better_sqs.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name        = "better_sqs"
-  s.version     = "0.1.1"
+  s.version     = "0.2.0"
   s.license     = "MIT"
-  s.date        = "2016-02-24"
+  s.date        = "2016-04-12"
   s.summary     = "A more idiomatic interface to SQS."
   s.description = "A convenient API for developers to interact with SQS with a trivial amount of effort"
   s.authors     = ["Courtland Caldwell"]
@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
     "https://github.com/Referly/better_sqs"
   s.add_runtime_dependency "lincoln_logger", "~> 1.0"                   # Mattermark gem
   s.add_runtime_dependency "aws-sdk", "~> 2"                            # Apache2 https://github.com/aws/aws-sdk-ruby/blob/master/LICENSE.txt
+  s.add_runtime_dependency "activesupport"
   s.add_development_dependency "rspec", "~> 3.2"                        # MIT - @link https://github.com/rspec/rspec/blob/master/License.txt
   s.add_development_dependency "byebug", "~> 3.5"                       # BSD (content is BSD) https://github.com/deivid-rodriguez/byebug/blob/master/LICENSE
   s.add_development_dependency "simplecov", "~> 0.10"                   # MIT - @link https://github.com/colszowka/simplecov/blob/master/MIT-LICENSE

data/lib/better_sqs/client.rb

@@ -60,5 +60,13 @@ module BetterSqs
     def url_for_queue(queue_name)
       sqs.create_queue(queue_name: queue_name).queue_url
     end
+
+    # Get a BetterSqs::Queue instance
+    #
+    # @param queue_name [String, Symbol] the name of the SQS queue
+    # @return [BetterSqs::Queue] the requested Queue instance
+    def queue(queue_name)
+      Queue.new self, queue_name
+    end
   end
 end

data/lib/better_sqs/queue.rb

@@ -0,0 +1,52 @@
+require "active_support/inflector"
+module BetterSqs
+  # A Class for interacting with an SQS queue as an OOP style entity
+  class Queue
+    attr_accessor :better_client,
+                  :queue_name
+
+    def initialize(better_client, queue_name)
+      @better_client = better_client
+      @queue_name = queue_name
+    end
+
+    # Push a message onto a queue
+    #
+    # @param message_body [String] the message as it will be pushed onto the queue, no serialization occurs as
+    #  part of this method. You need to encode or serialize your object to a string before sending it to this method
+    # @return [Types::SendMessageResult] the sent message object returned from s3
+    def push(message_body)
+      better_client.push queue_name, message_body
+    end
+
+    # Reserve a message from the specified queue
+    #
+    # @return [Messages::Sqs, NilClass] the message retrieved from the queue
+    def reserve
+      better_client.reserve queue_name
+    end
+
+    QUEUE_ATTRIBUTES = [
+      :approximate_number_of_messages,
+      :approximate_number_of_messages_not_visible,
+      :visibility_timeout,
+      :created_timestamp,
+      :last_modified_timestamp,
+      :policy,
+      :maximum_message_size,
+      :message_retention_period,
+      :queue_arn,
+      :approximate_number_of_messages_delayed,
+      :delay_seconds,
+      :receive_message_wait_time_seconds,
+      :redrive_policy,
+    ]
+    QUEUE_ATTRIBUTES.each do |queue_attribute|
+      define_method queue_attribute do
+        resp = better_client.sqs.get_queue_attributes queue_url:       better_client.url_for_queue(queue_name),
+                                                      attribute_names: [queue_attribute.to_s.camelize]
+        resp.attributes[queue_attribute.to_s.camelize]
+      end
+    end
+  end
+end

data/lib/better_sqs.rb

@@ -2,6 +2,7 @@ require "lincoln_logger"
 require "better_sqs/configuration"
 require "better_sqs/client"
 require "better_sqs/message"
+require "better_sqs/queue"
 module BetterSqs
   class << self
     # Allows the user to set configuration options

data/spec/better_sqs/client_spec.rb

@@ -4,7 +4,8 @@ describe BetterSqs::Client do
   subject { described_class.new }
 
   let(:queue_name) { "anotherqueue" }
-  let(:sqs) { mock_aws_sqs_client queue_url: "sqs://foo/bar" }
+  let(:queue_url) { "sqs://foo/bar" }
+  let(:sqs) { mock_aws_sqs_client }
   let(:sqs_message) { mock_sqs_message }
 
   before do
@@ -17,7 +18,7 @@ describe BetterSqs::Client do
     it "enqueues the message into the SQS queue" do
       expect(sqs).
         to receive(:send_message).
-        with(queue_url: sqs.url_for_queue(queue_name), message_body: message_body).
+        with(queue_url: sqs.queues[queue_name].queue_url, message_body: message_body).
         and_return(double "SendMessageResult")
 
       subject.push queue_name, message_body
@@ -33,7 +34,7 @@ describe BetterSqs::Client do
     it "retrieves a message from SQS" do
       expect(sqs).
         to receive(:receive_message).
-        with(queue_url: sqs.url_for_queue(queue_name), max_number_of_messages: 1).
+        with(queue_url: sqs.queues[queue_name].queue_url, max_number_of_messages: 1).
         and_return receive_message_response
 
       subject.reserve queue_name
@@ -54,7 +55,7 @@ describe BetterSqs::Client do
                                                  sqs_message:  sqs_message
       expect(sqs).
         to receive(:delete_message).
-        with(queue_url: sqs.url_for_queue(queue_name), receipt_handle: sqs_message.receipt_handle)
+        with(queue_url: sqs.queues[queue_name].queue_url, receipt_handle: sqs_message.receipt_handle)
 
       subject.delete message_to_delete
     end
@@ -64,7 +65,7 @@ describe BetterSqs::Client do
     let(:mock_queue) {
       mq = SqsMocks::MockQueue.new
       mq.queue_name = queue_name
-      mq.queue_url = sqs.queue_url
+      mq.queue_url = queue_url
       mq
     }
     it "creates the queue" do
@@ -73,7 +74,7 @@ describe BetterSqs::Client do
     end
 
     it "is the queue_url for the queue" do
-      expect(subject.url_for_queue queue_name).to eq sqs.queue_url
+      expect(subject.url_for_queue queue_name).to eq sqs.queues.values.first.queue_url
     end
   end
 
@@ -85,7 +86,7 @@ describe BetterSqs::Client do
 
       expect(sqs).
         to receive(:change_message_visibility).
-        with(queue_url:          sqs.url_for_queue(queue_name),
+        with(queue_url:          sqs.queues[queue_name].queue_url,
              receipt_handle:     message_to_defer.receipt_handle,
              visibility_timeout: BetterSqs.configuration.sqs_message_deferral_seconds)
       subject.defer_retry message_to_defer

data/spec/better_sqs/queue_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe BetterSqs::Queue do
+  subject { described_class.new better_client, queue_name }
+
+  let(:better_client) {
+    b = BetterSqs::Client.new
+    allow(b).to receive(:sqs).and_return mock_sqs
+    b
+  }
+  let(:mock_sqs) { SqsMocks::MockClient.new }
+  # let(:queue_url) { "some arn" }
+  let(:queue_name) { "superdupertuberqueue" }
+  let(:encoded_message) { { foo: "i am a foo" }.to_json }
+
+  describe "#push" do
+    it "pushes the encoded message onto the SQS queue" do
+      subject.push encoded_message
+      expect(mock_sqs.queues[queue_name].messages).to eq [encoded_message]
+    end
+  end
+
+  describe "#reserve" do
+    context "when there are messages in the queue to be received" do
+      it "returns a message from the queue" do
+        expected_message = BetterSqs::Message.new queue_client: better_client, queue: queue_name, sqs_message: encoded_message
+
+        subject.push encoded_message
+
+        expect(subject.reserve).to eq expected_message
+      end
+    end
+    context "when there are no messages in the queue to be received" do
+      it "is nil" do
+        expect(subject.reserve).to be_nil
+      end
+    end
+  end
+
+  described_class::QUEUE_ATTRIBUTES.each do |queue_attribute|
+    describe "##{queue_attribute}" do
+      it "gets the queue attribute: '#{queue_attribute}' from SQS" do
+        expect(subject.public_send queue_attribute).to eq SqsMocks::MockClient::FAUX_ATTRIBUTES[queue_attribute.to_s.camelize]
+      end
+    end
+  end
+end

data/spec/support/mocks.rb

@@ -1,3 +1,5 @@
+require "securerandom"
+
 def mock_queue_client
   double "QueueClient"
 end
@@ -12,30 +14,98 @@ end
 
 module SqsMocks
   class MockQueue
-    attr_accessor :queue_name, :queue_url
-  end
+    attr_accessor :queue_name, :queue_url, :messages
 
-  class MockClient
-    attr_accessor :queue_name, :queue_url
+    def initialize
+      @messages = []
+    end
+  end
 
-    def initialize(queue_url)
-      @queue_url = queue_url
+  class MockQueues < Hash
+    def [](key)
+      existing_val = super
+      return existing_val if existing_val
+      self[key] = create_queue queue_name: key
     end
 
-    def create_queue(queue_name)
-      @queue_name = queue_name
+    def create_queue(queue_name: nil)
       q = MockQueue.new
       q.queue_name = queue_name
+      queue_url = SecureRandom.hex(10)
       q.queue_url = queue_url
       q
     end
+  end
+
+  class MockClient
+    FAUX_ATTRIBUTES = {
+      "ApproximateNumberOfMessages"           => 5,
+      "ApproximateNumberOfMessagesNotVisible" => 2,
+      "VisibilityTimeout"                     => 10,
+      "CreatedTimestamp"                      => 123_456,
+      "LastModifiedTimestamp"                 => 123_456,
+      "Policy"                                => :some_policy,
+      "MaximumMessageSize"                    => 256_000,
+      "MessageRetentionPeriod"                => 86_400,
+      "QueueArn"                              => "arn:aws:sqs:us-east-1:201024061765:dolla-custom_list_creation_delete_user_tag_lots",
+      "ApproximateNumberOfMessagesDelayed"    => 3,
+      "DelaySeconds"                          => 12,
+      "ReceiveMessageWaitTimeSeconds"         => 25,
+      "RedrivePolicy"                         => :redrive_policy,
+    }
+    attr_accessor :queues
+
+    def initialize
+      @queues = MockQueues.new
+    end
+
+    def create_queue(queue_name: nil)
+      queues[queue_name]
+    end
+
+    def send_message(queue_url: nil, message_body: nil)
+      queue = queue_by_url queue_url
+      queue.messages << message_body
+    end
+
+    # If we get to the point of needing to mock visiblity then this approximation will not be adequate
+    def receive_message(queue_url: nil, max_number_of_messages: nil)
+      queue = queue_by_url queue_url
+      r = MockResponse.new
+      r.messages = Array(queue.messages.shift max_number_of_messages) if queue.messages.any?
+      r
+    end
+
+    # Just a static mock of the get_queue_attributes API
+    def get_queue_attributes(queue_url: nil, attribute_names: nil)
+      r = MockResponse.new
+      if attribute_names == "All"
+        r.attributes = FAUX_ATTRIBUTES
+      else
+        attribute_names.each do |attribute_name|
+          r.attributes[attribute_name] = FAUX_ATTRIBUTES[attribute_name]
+        end
+      end
+      r
+    end
+
+    private
+
+    def queue_by_url(queue_url)
+      queues.select { |_queue_name, q| q.queue_url == queue_url }.values.first
+    end
+  end
+
+  class MockResponse
+    attr_accessor :messages, :attributes
 
-    def url_for_queue(_queue_name)
-      @queue_url
+    def initialize
+      @messages = []
+      @attributes = {}
     end
   end
 end
 
-def mock_aws_sqs_client(queue_url: nil)
-  SqsMocks::MockClient.new queue_url
+def mock_aws_sqs_client
+  SqsMocks::MockClient.new
 end

metadata

@@ -1,111 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: better_sqs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Courtland Caldwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lincoln_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.31'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.31'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
 description: A convenient API for developers to interact with SQS with a trivial amount
@@ -115,9 +129,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
+- .gitignore
+- .rubocop.yml
+- .rubocop_todo.yml
 - LICENSE
 - README.md
 - better_sqs.gemspec
@@ -126,8 +140,10 @@ files:
 - lib/better_sqs/client.rb
 - lib/better_sqs/configuration.rb
 - lib/better_sqs/message.rb
+- lib/better_sqs/queue.rb
 - spec/better_sqs/client_spec.rb
 - spec/better_sqs/message_spec.rb
+- spec/better_sqs/queue_spec.rb
 - spec/better_sqs_spec.rb
 - spec/simplecov_custom_profile.rb
 - spec/spec_helper.rb
@@ -142,23 +158,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: A more idiomatic interface to SQS.
 test_files:
 - spec/better_sqs/client_spec.rb
 - spec/better_sqs/message_spec.rb
+- spec/better_sqs/queue_spec.rb
 - spec/better_sqs_spec.rb
 - spec/simplecov_custom_profile.rb
 - spec/spec_helper.rb