opener-callback-handler 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fd7f9d735aab8917d4f5c64090f6ffebc3a0d3d
-  data.tar.gz: b0acc4cf19f01a23a6339d6675d11a6a5152a62c
+  metadata.gz: 728ac45c10bdd72761739eacf9ef463d7718f319
+  data.tar.gz: b7ff5d6086fcc50e3db3084b04f103569899dfc0
 SHA512:
-  metadata.gz: f174cba7d89489209640c9ce91ae2b87cc3ecb1a0334260bea051097a9b246d10286d45cf52ad863ab2ecf33ee72c3084d2445aadbc18ef7abc7fb50d5ffe9a5
-  data.tar.gz: 249579cd869a8024229fa5721c3fc48dd77da8462f459707b8652b08c7347cfe09ced297b3d87b1c80e79d9afd884e3664d56c10ee78edc406936d87ca21cedd
+  metadata.gz: 1c9168c9e7807562a72217cb29c654593d53717f550071bf410ae3aa7e7f90a31e5c29e26160c1b81a22795f9e2ed69a2a736f8fe20fb50d7a15caa681569586
+  data.tar.gz: 00285dfb7176cb3f009bd0b538fec3fc7f7750ac3962f162e3d2b14fea59583aa759235476f81b1e951f57c41613ad84d6f3c8b29b49427a41e7269625b66d25

data/README.md

@@ -2,7 +2,8 @@
 
 Gem that handles the different callback URLs based on the protocol of each URL.
 
-(HTTP, HTTPS, SQS, S3, FTP etc..) For now HTTP/HTTPS and Amazon SQS are supported.
+(HTTP, HTTPS, SQS, S3, FTP etc..) For now HTTP/HTTPS and Amazon SQS are
+supported.
 
 ## Installation
 
@@ -20,7 +21,8 @@ Or install it yourself as:
 
 ## Usage
 
-For SQS, `AWS_REGION` `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables should be set on startup of the webservice or daemon.
+For SQS, `AWS_REGION` `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+environment variables should be set on startup of the webservice or daemon.
 
 ## Contributing
 

data/lib/opener/callback_handler.rb

@@ -1,35 +1,48 @@
-require 'active_support/inflector'
-require "opener/callback_handler/version"
-require 'aws-sdk-core'
+require 'json'
+require 'aws-sdk'
 require 'httpclient'
 
-##
-# First strategy that passes the validation is served. So make sure that
-# if there are overlapping strategies, to put the one that needs to
-# be handled, first. For example amazon_sqs URLs are also http URLs, but need
-# to be handled by the amazon_sqs strategy. so http should go after the
-# amazon_sqs strategy.
-STRATEGIES = ["amazon_sqs", "http"]
-STRATEGIES.each do |strategy|
-  require_relative "callback_handler/strategies/#{strategy}"
-end
+require_relative 'callback_handler/version'
+require_relative 'callback_handler/strategies/amazon_sqs'
+require_relative 'callback_handler/strategies/http'
 
 module Opener
   class CallbackHandler
-    attr_accessor :url
-    
+    ##
+    # The available strategies. These are processed in order to make sure the
+    # order is correct (e.g. AmazonSqs should take precedence over Http).
+    #
+    # @return [Array]
+    #
+    STRATEGIES = [
+      Opener::CallbackHandler::Strategies::AmazonSqs,
+      Opener::CallbackHandler::Strategies::Http,
+    ]
+
+    ##
+    # @param [String] url
+    # @param [Hash] params
+    #
     def post(url, params = {})
       strategy = select_strategy(url)
-      strategy.process(url, params)
+
+      unless strategy
+        raise ArgumentError, "No strategy for URL #{url.inspect}"
+      end
+
+      strategy.new.process(url, params)
     end
-    
-    
+
+    ##
+    # Returns the strategy class to use based on the input URL.
+    #
+    # @param [String] url
+    # @return [Class]
+    #
     def select_strategy(url)
-      STRATEGIES.map do |strategy|
-        "Opener::CallbackHandler::Strategies::#{strategy.camelize}".constantize.new
-      end.select do |strategy_class|
-        strategy_class.pass_validation?(url)        
-      end.compact.first
+      return STRATEGIES.find do |const|
+        const.pass_validation?(url)
+      end
     end
-  end
-end
+  end # CallbackHandler
+end # Opener

data/lib/opener/callback_handler/strategies/amazon_sqs.rb

@@ -1,25 +1,60 @@
-require 'json'
-
 module Opener
   class CallbackHandler
     module Strategies
-      class AmazonSqs        
-        def pass_validation?(url)
-          !!Regexp.new("^https:\/\/sqs.(.*)amazonaws.com\/.*").match(url)
+      ##
+      # Strategy for submitting data to an Amazon SQS queue. This strategy
+      # expects URIs in the following format:
+      #
+      #     sqs://<name>
+      #
+      # Here `<name>` is the name of the queue to use.
+      #
+      # @!attribute [r] sqs
+      #  @return [AWS::SQS]
+      #
+      class AmazonSqs
+        attr_reader :sqs
+
+        ##
+        # @param [String] url
+        # @return [TrueClass|FalseClass]
+        #
+        def self.pass_validation?(url)
+          return !!(url =~ /^sqs:\/\/.+/)
         end
-        
-        def process(url, params = {})
-          send_message(url, params)
+
+        def initialize
+          @sqs = AWS::SQS.new
+        end
+
+        ##
+        # @param [String] uri The queue URI
+        # @param [Hash] params The message to submit.
+        #
+        def process(uri, params = {})
+          queue = queue_for_uri(uri)
+
+          queue.send_message(JSON.dump(params))
+        end
+
+        ##
+        # @param [String] uri
+        # @return [AWS::SQS::Queue]
+        #
+        def queue_for_uri(uri)
+          parsed = URI.parse(uri)
+
+          return queue_for_name(parsed.host)
         end
 
-        def send_message(url, params)
-          sqs = ::Aws::SQS::Client.new
-          params_json = params.is_a?(String) ? params : params.to_json
-          message_body = params.keys.include?(:message_body) ? params : {:message_body => params_json}
-          
-          sqs.send_message(message_body.merge(:queue_url=>url))
+        ##
+        # @param [String] name
+        # @return [AWS::SQS::Queue]
+        #
+        def queue_for_name(name)
+          return sqs.queues.named(name)
         end
-      end
-    end
-  end
-end
+      end # AmazonSqs
+    end # Strategies
+  end # CallbackHandler
+end # Opener

data/lib/opener/callback_handler/strategies/http.rb

@@ -1,24 +1,48 @@
 module Opener
   class CallbackHandler
     module Strategies
+      ##
+      # Strategy for submitting data to a regular HTTP URL. This strategy
+      # submits data as JSON while making sure the correct Content-Type header
+      # is set.
+      #
+      # @!attribute [r] http
+      #  @return [HTTPClient]
+      #
       class Http
-        
-        def pass_validation?(url)
-          !!Regexp.new("^https?:\/\/.*").match(url)
+        attr_reader :http
+
+        ##
+        # The headers to use when submitting data.
+        #
+        # @return [Hash]
+        #
+        HEADERS = {
+          'Content-Type' => 'application/json'
+        }
+
+        ##
+        # @param [String] url
+        # @return [TrueClass|FalseClass]
+        #
+        def self.pass_validation?(url)
+          return !!Regexp.new("^https?:\/\/.+").match(url)
         end
-        
-        def process(url, params = {})
-          body_params = params.keys.include?(:body) ? params : {:body => params}
-          http_client.post_async(url, body_params)
+
+        def initialize
+          @http = HTTPClient.new
         end
-        
-        def http_client
-          client = ::HTTPClient.new
-          client.connect_timeout = 120
 
-          return client
+        ##
+        # @param [String] url
+        # @param [Hash] params
+        #
+        def process(url, params = {})
+          body = JSON.dump(params)
+
+          http.post(url, :body => body, :header => HEADERS)
         end
-      end
-    end
-  end
-end
+      end # Http
+    end # Strategies
+  end # CallbackHandler
+end # Opener

data/lib/opener/callback_handler/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class CallbackHandler
-    VERSION = "0.0.2"
+    VERSION = '1.0.0'
   end
 end

data/opener-callback-handler.gemspec

@@ -1,10 +1,10 @@
 require File.expand_path('../lib/opener/callback_handler/version', __FILE__)
 
 Gem::Specification.new do |spec|
-  spec.name          = "opener-callback-handler"
+  spec.name          = 'opener-callback-handler'
   spec.version       = Opener::CallbackHandler::VERSION
-  spec.authors       = ["development@olery.com"]
-  spec.summary       = %q{Tool for handling different callback URLs based on their protocol.}
+  spec.authors       = ['development@olery.com']
+  spec.summary       = 'Tool for handling different callback URLs based on their protocol.'
   spec.description   = spec.summary
 
   spec.license = 'Apache 2.0'
@@ -16,12 +16,10 @@ Gem::Specification.new do |spec|
     'LICENSE.txt'
   ]).select { |file| File.file?(file) }
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
+  spec.add_dependency 'aws-sdk', '~> 1.0'
+  spec.add_dependency 'httpclient'
 
-  spec.add_dependency "json"
-  spec.add_dependency "activesupport"
-  spec.add_dependency "aws-sdk-core"
-  spec.add_dependency "httpclient"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

metadata

@@ -1,148 +1,121 @@
 --- !ruby/object:Gem::Specification
 name: opener-callback-handler
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - development@olery.com
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
+  name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  prerelease: false
-  type: :development
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: pry
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
   prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency
-  name: json
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: activesupport
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: aws-sdk-core
   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: '0'
+  type: :development
   prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: httpclient
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  prerelease: false
-  type: :runtime
 description: Tool for handling different callback URLs based on their protocol.
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - lib/opener/callback_handler.rb
-- lib/opener/callback_handler/version.rb
 - lib/opener/callback_handler/strategies/amazon_sqs.rb
 - lib/opener/callback_handler/strategies/http.rb
+- lib/opener/callback_handler/version.rb
 - opener-callback-handler.gemspec
-- README.md
-- LICENSE.txt
-homepage:
+homepage: 
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 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.1.9
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
 specification_version: 4
 summary: Tool for handling different callback URLs based on their protocol.
 test_files: []
+has_rdoc: