magic_pipe 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a16af40ae46abcba5bafeca16db82382e91bd4ee
-  data.tar.gz: 31eb6c6e23ce061727e467879869a749adf7af08
+  metadata.gz: 18fc9852ccb722d15f8d65698d45fb83123aebe7
+  data.tar.gz: 7762b69a3dedfa880e5111cee8f91cd9a031c5e3
 SHA512:
-  metadata.gz: 4cfebdd5448a995c0a93b0f10b1ac5f950e9ed9c2d94c1eeed99020da205d1943d520d2c24fa91279e48eb779f27cf5f2de7fb5ad469277fb2f083675abc66c2
-  data.tar.gz: 82cfe543de0788e2e3cf758450396de4707fa7255b0bc90564465203b3d6f439e23120cc85a38c20ac1c72ca23edee4fa3d738399c3f314f778a71dd406ecff1
+  metadata.gz: 100dd028a5f518b410990725bbbc2d85d4e015d74f5aed6dea0e59417335e23a84d579fdb6cdae21f89c9c0f13b097c7a344bcf87c6165f770e0f4dd51c6c2e7
+  data.tar.gz: f2d5f95580ab2cc93ab3614bf16721c3c36c6c1dc43a7fdbdbee2370bc43c8efe889ff67b515d777953b1032159dc47674587cdb44b4fbd6fe1c2779765140cd

data/.travis.yml

@@ -6,3 +6,7 @@ rvm:
   - 2.2.9
 script:
   - bundle exec rspec
+notifications:
+  email:
+    on_success: never
+    on_failure: never

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # MagicPipe Changelog
 
+## v0.2.0
+
+Enhancing the HTTPS transport:
+
+* Allow to configure both user and password for HTTP Basic Auth.
+* Allow to configure a callable to use dynamic URL paths.
+
 ## v0.1.0
 
 Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    magic_pipe (0.1.0)
+    magic_pipe (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -127,6 +127,9 @@ require "magic_pipe/transports/https"
 require "magic_pipe/transports/sqs"
 
 $magic_pipe = MagicPipe.build do |mp|
+  mp.client_name = :my_magic_pipe
+  mp.producer_name = "My Awesome Service (Production)"
+
   mp.sender = :async
   mp.loader = :simple_active_record
 
@@ -138,7 +141,7 @@ $magic_pipe = MagicPipe.build do |mp|
   }
   mp.https_transport_options = {
     url: "https://my.receiver.service/foo",
-    auth_token: "bar",
+    basic_auth_user: "bar",
   }
   mp.sqs_transport_options = {
     queue: "my_data_stream"
@@ -202,6 +205,42 @@ export AWS_SECRET_ACCESS_KEY='bar'
 export AWS_REGION='us-east-1'
 ```
 
+#### Transport: HTTPS
+
+This transport builds a [Faraday](https://github.com/lostisland/faraday) connection. A number of options can be configured:
+
+```ruby
+$magic_pipe = MagicPipe.build do |mp|
+  mp.transport = :https
+
+  mp.https_transport_options = {
+    url: "https://my.receiver.service/messages",
+    dynamic_path_builder: -> (topic) { topic }
+
+    basic_auth_user: "foo",
+    basic_auth_password: "bar",
+
+    timeout: 2,
+    open_timeout: 3,
+  }
+end
+```
+
+The `dynamic_path_builder` setting should be a callable that will receive the topic name. It defaults to `nil`, in which case the base URL will be used as is. If present, its return value will be used in Faraday as:
+
+```ruby
+faraday_connection.post do |r|
+  r.url dynamic_path_builder.call(metadata[:topic])
+end
+```
+
+Which will result in requests as:
+
+```
+HTTP POST https://my.receiver.service/messages/a-topic-name
+```
+
+
 ## Dependencies
 
 Becasuse of MagicPipe's modular design, and in order to keep a small installation footprint, all of its dependencies are optional. Users of the library need to manually install the required dependencies in their projects.

data/lib/magic_pipe/codecs/base.rb

@@ -7,17 +7,22 @@ module MagicPipe
       # to an ActiveModel::Serializer or
       # ActiveRecord object.
       #
-      def initialize(object)
-        @object = object
+      def initialize(envelope)
+        @envelope = envelope
       end
 
-      attr_reader :object
-      alias_method :o, :object
+      attr_reader :envelope
+      alias_method :object, :envelope
+      alias_method :o, :envelope
 
       def encode
         raise NotImplementedError
       end
 
+      def inner_object
+        @envelope.body
+      end
+
       def type
         self.class.const_get(:TYPE)
       end

data/lib/magic_pipe/config.rb

@@ -54,8 +54,28 @@ module MagicPipe
       return unless @https_transport_options
 
       defaults = {
+        # The base URL. It can contain a path
+        #
         url: "https://localhost:8080/foo",
-        auth_token: "missing",
+        #
+        # A callable that receives the topic name.
+        # For example if you want to use the topic
+        # as sub path, provide an identity proc:
+        #
+        #  -> (t) { t }
+        #
+        # The callable should return an absolute "/my/path"
+        # value to replace the entire path of the configured
+        # URL. It should return a relative "my/path" value
+        # to simply append the dynamic path to the base URL.
+        #
+        # When this parameter is nil, the configured URL
+        # will be used as is.
+        #
+        dynamic_path_builder: nil,
+
+        basic_auth_user: "missing",
+        basic_auth_password: "x",
         timeout: 2,
         open_timeout: 3,
       }

data/lib/magic_pipe/transports/https.rb

@@ -11,6 +11,7 @@ module MagicPipe
         super(config, metrics)
         @options = @config.https_transport_options
         @conn = build_connection
+        @path_builder = @options[:dynamic_path_builder]
       end
 
       attr_reader :conn
@@ -21,6 +22,9 @@ module MagicPipe
       #
       def submit(payload, metadata)
         @conn.post do |r|
+          path = dynamic_path(metadata[:topic])
+          r.url(path) if path
+
           r.body = payload
           r.headers["X-MagicPipe-Sent-At"] = metadata[:time]
           r.headers["X-MagicPipe-Topic"] = metadata[:topic]
@@ -31,12 +35,22 @@ module MagicPipe
 
       private
 
+
+      def dynamic_path(topic)
+        return nil unless !!@path_builder
+        @path_builder.call(topic)
+      end
+
       def url
         @options.fetch(:url)
       end
 
-      def auth_token
-        @options.fetch(:auth_token)
+      def basic_auth_user
+        @options.fetch(:basic_auth_user)
+      end
+
+      def basic_auth_password
+        @options.fetch(:basic_auth_password)
       end
 
       def timeout
@@ -64,7 +78,7 @@ module MagicPipe
       def build_connection
         Faraday.new(url) do |f|
           f.request :retry, max: 2, interval: 0.1, backoff_factor: 2
-          f.request :basic_auth, auth_token, 'x'
+          f.request :basic_auth, basic_auth_user, basic_auth_password
 
           f.headers['Content-Type'] = content_type
           f.headers['User-Agent'] = user_agent

data/lib/magic_pipe/version.rb

@@ -1,3 +1,3 @@
 module MagicPipe
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magic_pipe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tommaso Pavese
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-04 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler