propono 0.0.1 → 0.1.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.swp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - rake test
+addons:
+    code_climate:
+        repo_token: 88dd239bc2e0010742a42a4e0234b4decd19b46d0e9d3408d8b1fe0f96dd8fc1

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in propono.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -3,8 +3,6 @@
 [![Build Status](https://travis-ci.org/meducation/propono.png)](https://travis-ci.org/meducation/propono)
 [![Dependencies](https://gemnasium.com/meducation/propono.png?travis)](https://gemnasium.com/meducation/propono)
 [![Code Climate](https://codeclimate.com/github/meducation/propono.png)](https://codeclimate.com/github/meducation/propono)
-[![Coverage Status](https://coveralls.io/repos/meducation/propono/badge.png)](https://coveralls.io/r/meducation/propono)
-
 
 ## Installation
 
@@ -20,6 +18,34 @@ And then execute:
 
     $ bundle
 
+This script demonstrates usage:
+
+```ruby
+require 'propono'
+
+class Toy
+  def play
+    configure
+    make_fun_stuff_happen
+  end
+
+  private
+  def make_fun_stuff_happen
+    Propono.publish("jez-test-topic", "A test message")
+    Propono.subscribe_by_queue("jez-test-topic")
+    Propono.subscribe_by_post("jez-test-topic", 'http://example.com/endpoint')
+  end
+
+  def configure
+    Propono.config.access_key = '...'
+    Propono.config.secret_key = '...'
+    Propono.config.queue_region = 'eu-west-1'
+  end
+end
+
+Toy.new.play
+```
+
 ## Contributing
 
 Firstly, thank you!! :heart::sparkling_heart::heart:

data/lib/propono.rb

@@ -1,11 +1,30 @@
 require "propono/version"
 require 'propono/configuration'
 require 'propono/sns'
+require 'propono/sqs'
+require "propono/post_subscriber"
 require "propono/publisher"
+require "propono/queue"
+require "propono/queue_creator"
+require "propono/queue_subscriber"
+require "propono/subscriber"
 require "propono/topic_creator"
 
 module Propono
-  def config
+  def self.config
     Configuration.instance
   end
+
+  def self.publish(*args)
+    Publisher.publish(*args)
+  end
+
+  def self.subscribe_by_queue(*args)
+    Subscriber.subscribe_by_queue(*args)
+  end
+
+  def self.subscribe_by_post(*args)
+    Subscriber.subscribe_by_post(*args)
+  end
+
 end

data/lib/propono/post_subscriber.rb

@@ -0,0 +1,19 @@
+module Propono
+  class PostSubscriber
+    include Sns
+
+    def self.subscribe(topic, endpoint)
+      new(topic, endpoint).subscribe
+    end
+
+    def initialize(topic_id, endpoint)
+      @topic_id = topic_id
+      @endpoint = endpoint
+    end
+
+    def subscribe
+      topic_arn = TopicCreator.find_or_create(@topic_id)
+      sns.subscribe(topic_arn, @endpoint, 'http')
+    end
+  end
+end

data/lib/propono/publisher.rb

@@ -9,14 +9,12 @@ module Propono
       new.publish(topic, message)
     end
 
-    def initialize
-    end
-
     def publish(topic_id, message)
       raise PublisherError.new("Topic is nil") if topic_id.nil?
       raise PublisherError.new("Message is nil") if message.nil?
 
       topic_arn = TopicCreator.find_or_create(topic_id)
+      sns.publish(topic_arn, message)
     end
   end
 end

data/lib/propono/queue.rb

@@ -0,0 +1,16 @@
+module Propono
+  class Queue
+
+    include Sqs
+
+    attr_reader :url
+    def initialize(url)
+      @url = url
+    end
+
+    def arn
+      attributes = sqs.get_queue_attributes(@url, 'QueueArn').body["Attributes"]
+      attributes["QueueArn"]
+    end
+  end
+end

data/lib/propono/queue_creator.rb

@@ -0,0 +1,23 @@
+module Propono
+  class QueueCreatorError < Exception
+  end
+
+  class QueueCreator
+    include Sqs
+
+    def self.find_or_create(name)
+      new(name).find_or_create
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    def find_or_create
+      result = sqs.create_queue(@name)
+      body = result.body
+      url = body.fetch('QueueUrl') { raise QueueCreatorError.new("No QueueUrl returned from SQS") }
+      Queue.new(url)
+    end
+  end
+end

data/lib/propono/queue_subscriber.rb

@@ -0,0 +1,29 @@
+module Propono
+  class QueueSubscriber
+
+    include Sns
+    include Sqs
+
+    attr_reader :topic_arn, :queue
+
+    def self.subscribe(topic_id)
+      new(topic_id).subscribe
+    end
+
+    def initialize(topic_id)
+      @topic_id = topic_id
+    end
+
+    def subscribe
+      @topic_arn = TopicCreator.find_or_create(@topic_id)
+      @queue = QueueCreator.find_or_create(queue_name)
+      sns.subscribe(@topic_arn, @queue.arn, 'sqs')
+    end
+
+    private
+
+    def queue_name
+      @topic_id
+    end
+  end
+end

data/lib/propono/sqs.rb

@@ -0,0 +1,20 @@
+require 'fog'
+
+module Propono
+  module Sqs
+    private
+
+    def sqs
+      @sqs ||= Fog::AWS::SQS.new(
+        :aws_access_key_id => config.access_key,
+        :aws_secret_access_key => config.secret_key,
+        :region => config.queue_region
+      )
+    end
+
+    def config
+      Configuration.instance
+    end
+  end
+end
+

data/lib/propono/subscriber.rb

@@ -0,0 +1,12 @@
+module Propono
+
+  module Subscriber
+    def self.subscribe_by_queue(topic)
+      QueueSubscriber.subscribe(topic)
+    end
+
+    def self.subscribe_by_post(topic, endpoint)
+      PostSubscriber.subscribe(topic, endpoint)
+    end
+  end
+end

data/lib/propono/topic_creator.rb

@@ -14,8 +14,8 @@ module Propono
     end
 
     def find_or_create
-      create_topic_result = sns.create_topic(@topic_id)
-      body = create_topic_result.body
+      result = sns.create_topic(@topic_id)
+      body = result.body
       body.fetch('TopicArn') { raise TopicCreatorError.new("No TopicArn returned from SNS") }
     end
   end

data/lib/propono/version.rb

@@ -1,3 +1,3 @@
 module Propono
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/post_subscriber_test.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Propono
+  class PostSubscriberTest < Minitest::Test
+    def test_create_topic
+      topic = 'foobar'
+      TopicCreator.expects(:find_or_create).with(topic)
+      PostSubscriber.subscribe(topic, "foobar")
+    end
+
+    def test_subscribe_calls_subscribe
+      arn = "arn123"
+      endpoint = "http://meducation.net/some_queue_name"
+
+      TopicCreator.stubs(find_or_create: arn)
+
+      sns = mock()
+      sns.expects(:subscribe).with(arn, endpoint, 'http')
+      subscriber = PostSubscriber.new("Some topic", endpoint)
+      subscriber.stubs(sns: sns)
+      subscriber.subscribe
+    end
+
+    def test_it_correctly_uses_http_and_https
+      skip
+    end
+  end
+end
+

data/test/publisher_test.rb

@@ -15,16 +15,40 @@ module Propono
       Publisher.new.publish(topic, message)
     end
 
-    def test_publish_should_call_sns_on_correct_topic
+    def test_publish_should_call_sns_on_correct_topic_and_message
+      topic = "topic123"
+      message = "message123"
+      topic_arn = "arn123"
+
+      TopicCreator.stubs(find_or_create: topic_arn)
+
+      sns = mock()
+      sns.expects(:publish).with(topic_arn, message)
+      publisher = Publisher.new
+      publisher.stubs(sns: sns)
+
+      publisher.publish(topic, message)
     end
 
-    def test_publish_should_call_sns_with_message
+    def test_publish_should_propogate_exception_on_topic_creation_error
+      TopicCreator.stubs(:find_or_create).raises(TopicCreatorError)
+
+      assert_raises(TopicCreatorError) do
+        Publisher.publish("topic", "message")
+      end
     end
 
     def test_publish_creates_a_topic
       topic = "Malcs_topic"
+
       TopicCreator.expects(:find_or_create).with(topic)
-      Publisher.new.publish(topic, "Foobar")
+
+      sns = mock()
+      sns.stubs(:publish)
+      publisher = Publisher.new
+      publisher.stubs(sns: sns)
+
+      publisher.publish(topic, "Foobar")
     end
 
     def test_publish_should_raise_exception_if_topic_is_nil

data/test/queue_creator_test.rb

@@ -0,0 +1,41 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Propono
+  class QueueCreatorTest < Minitest::Test
+
+    def test_create_topic_called_on_sqs
+      sqs = mock()
+      sqs.expects(:create_queue).with("foobar").returns(mock(body: { "QueueUrl" => "Foobar"}))
+
+      creator = QueueCreator.new("foobar")
+      creator.stubs(sqs: sqs)
+
+      creator.find_or_create
+    end
+
+    def test_returns_url
+      url = "malcs_happy_queue"
+      result = mock(body: { "QueueUrl" => url})
+      sqs = mock(create_queue: result)
+
+      creator = QueueCreator.new("foobar")
+      creator.stubs(sqs: sqs)
+
+      queue = creator.find_or_create
+      assert_equal url, queue.url
+    end
+
+    def test_should_raise_exception_if_no_queue_returned
+      result = mock(body: {})
+      sqs = mock(create_queue: result)
+
+      creator = QueueCreator.new("foobar")
+      creator.stubs(sqs: sqs)
+
+      assert_raises QueueCreatorError do
+        creator.find_or_create
+      end
+    end
+  end
+end
+

data/test/queue_subscriber_test.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Propono
+  class QueueSubscriberTest < Minitest::Test
+    def test_create_topic
+      topic = 'foobar'
+      TopicCreator.expects(:find_or_create).with(topic)
+      QueueSubscriber.subscribe(topic)
+    end
+
+    def test_sqs_create_is_called
+      topic = "Foobar"
+      subscriber = QueueSubscriber.new(topic)
+
+      TopicCreator.stubs(find_or_create: "1123")
+
+      sqs = mock()
+      sqs.expects(:create_queue).with(subscriber.send(:queue_name)).returns(mock(body: {'QueueUrl' => Fog::AWS::SQS::Mock::QueueUrl}))
+      QueueCreator.any_instance.stubs(sqs: sqs)
+
+      subscriber.subscribe
+    end
+
+    def test_subscriber_queue_name
+      skip
+    end
+
+    def test_subscribe_calls_subscribe
+      arn = "arn123"
+      queue_url = 
+
+      TopicCreator.stubs(find_or_create: arn)
+      QueueCreator.stubs(find_or_create: Queue.new(Fog::AWS::SQS::Mock::QueueUrl))
+
+      sns = mock()
+      sns.expects(:subscribe).with(arn, Fog::AWS::SQS::Mock::QueueArn, 'sqs')
+      subscriber = QueueSubscriber.new("Some topic")
+      subscriber.stubs(sns: sns)
+      subscriber.subscribe
+    end
+
+    def test_subscribe_saves_queue
+      queue = Queue.new(Fog::AWS::SQS::Mock::QueueUrl)
+
+      QueueCreator.expects(:find_or_create).returns(queue)
+      subscriber = QueueSubscriber.new("Some Topic")
+      subscriber.subscribe
+      assert_equal queue, subscriber.queue
+    end
+  end
+end

data/test/queue_test.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Propono
+  class QueueTest < Minitest::Test
+    def test_intialization_sets_url
+      url = 'foobar'
+      queue = Queue.new(url)
+      assert url, queue.url
+    end
+
+    def test_arn
+      skip
+    end
+  end
+end
+

data/test/sqs_test.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Propono
+  class SqsTest < Minitest::Test
+    class SqsTestClass
+      include Sqs
+    end
+
+    def setup
+      config.access_key = "test-access-key"
+      config.secret_key = "test-secret-key"
+      config.queue_region = "us-east-1"
+    end
+
+    def test_sqs
+      Fog::AWS::SQS.expects(:new)
+        .with(:aws_access_key_id     => 'test-access-key',
+              :aws_secret_access_key => 'test-secret-key',
+              :region                => 'us-east-1')
+
+      SqsTestClass.new.send :sqs
+    end
+
+    private
+
+    def config
+      Configuration.instance
+    end
+  end
+end
+

data/test/subscriber_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Propono
+  class SubscriberTest < Minitest::Test
+
+    def test_subscribe_by_queue_calls_queue_subscriber
+      subscriber = QueueSubscriber.new("topic")
+      QueueSubscriber.expects(:new).with("topic").returns(subscriber)
+      QueueSubscriber.any_instance.expects(:subscribe)
+      Subscriber.subscribe_by_queue("topic")
+    end
+
+    def test_subscribe_by_post_calls_post_subscribe
+      subscriber = PostSubscriber.new("topic", 'endpoint')
+      PostSubscriber.expects(:new).with("topic", 'endpoint').returns(subscriber)
+      PostSubscriber.any_instance.expects(:subscribe)
+      Subscriber.subscribe_by_post("topic", "endpoint")
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 gem "minitest"
 require "minitest/autorun"
 require "minitest/pride"
@@ -8,3 +11,40 @@ lib = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "propono"
+
+Fog.mock!
+
+class Minitest::Test
+  def setup
+    Propono::Configuration.instance.access_key = "test-access-key"
+    Propono::Configuration.instance.secret_key = "test-secret-key"
+    Propono::Configuration.instance.queue_region = "us-east-1"
+  end
+end
+
+class Fog::AWS::SNS::Mock
+  def create_topic(*args)
+    foo = Object.new
+    class << foo
+      def body
+        {"TopicArn" => "FoobarFromTheMock"}
+      end
+    end
+    foo
+  end
+
+  def subscribe(topic_arn, arn_or_url, type)
+  end
+end
+
+require 'fog'
+class Fog::AWS::SQS::Mock
+  def create_queue(*args)
+  end
+end
+
+Fog::AWS::SQS::Mock::QueueUrl = 'https://meducation.net/foobar'
+Fog::AWS::SQS::Mock::QueueArn = 'FoobarArn'
+data = {'Attributes' => {"QueueArn" => Fog::AWS::SQS::Mock::QueueArn}}
+queues = Fog::AWS::SQS::Mock.data["us-east-1"]["test-access-key"][:queues]
+queues[Fog::AWS::SQS::Mock::QueueUrl] = data

data/test/topic_creator_test.rb

@@ -15,8 +15,8 @@ module Propono
 
     def test_returns_arn
       arn = "malcs_happy_arn"
-      create_topic_result = mock(body: { "TopicArn" => arn})
-      sns = mock(create_topic: create_topic_result)
+      result = mock(body: { "TopicArn" => arn})
+      sns = mock(create_topic: result)
 
       creator = TopicCreator.new("foobar")
       creator.stubs(sns: sns)
@@ -25,8 +25,8 @@ module Propono
     end
 
     def test_should_raise_exception_if_no_arn_returned
-      create_topic_result = mock(body: {})
-      sns = mock(create_topic: create_topic_result)
+      result = mock(body: {})
+      sns = mock(create_topic: result)
 
       creator = TopicCreator.new("foobar")
       creator.stubs(sns: sns)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: propono
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -101,6 +101,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CONTRIBUTING.md
 - Gemfile
 - LICENCE.md
@@ -108,14 +109,26 @@ files:
 - Rakefile
 - lib/propono.rb
 - lib/propono/configuration.rb
+- lib/propono/post_subscriber.rb
 - lib/propono/publisher.rb
+- lib/propono/queue.rb
+- lib/propono/queue_creator.rb
+- lib/propono/queue_subscriber.rb
 - lib/propono/sns.rb
+- lib/propono/sqs.rb
+- lib/propono/subscriber.rb
 - lib/propono/topic_creator.rb
 - lib/propono/version.rb
 - propono.gemspec
 - test/configuration_test.rb
+- test/post_subscriber_test.rb
 - test/publisher_test.rb
+- test/queue_creator_test.rb
+- test/queue_subscriber_test.rb
+- test/queue_test.rb
 - test/sns_test.rb
+- test/sqs_test.rb
+- test/subscriber_test.rb
 - test/test_helper.rb
 - test/topic_creator_test.rb
 homepage: ''
@@ -133,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1315307569303523686
+      hash: 1295735887844079183
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -142,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1315307569303523686
+      hash: 1295735887844079183
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -151,7 +164,13 @@ specification_version: 3
 summary: General purpose pub/sub library built on top of AWS SNS and SQS
 test_files:
 - test/configuration_test.rb
+- test/post_subscriber_test.rb
 - test/publisher_test.rb
+- test/queue_creator_test.rb
+- test/queue_subscriber_test.rb
+- test/queue_test.rb
 - test/sns_test.rb
+- test/sqs_test.rb
+- test/subscriber_test.rb
 - test/test_helper.rb
 - test/topic_creator_test.rb