evt-event_store-http-connect 0.0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97a7bd0fee4ca0e32f4c360b0a6133c080be1933
+  data.tar.gz: 8252510cab8534e3cb9194f2f7421c0dfb1fab82
+SHA512:
+  metadata.gz: fb4b8d2b156765f99275efd0f32cf3fb15e451f86f0cf1ce20b37b1a3c97300fb0589b6f38453aa2d7706bed95e256fd25a50ca49d29a9d1c4ea71cf472cdebb
+  data.tar.gz: 512436e0c43e5d6bbf3b7010309d49236d2f05068921633b47ffdc484757b8c96cb04a688694b802b1be24c05398b005a1eb8f41d35b431ae55bb03f267f70ea

data/lib/event_store/http/connect.rb

@@ -0,0 +1,16 @@
+require 'net/http'
+
+require 'dns/resolve_host'
+
+require 'event_store/http/connect/log'
+
+require 'event_store/http/connect/defaults'
+require 'event_store/http/connect/net_http'
+require 'event_store/http/connect/settings'
+
+require 'event_store/http/connect/assertions'
+require 'event_store/http/connect/log_attributes'
+
+require 'event_store/http/connect/telemetry'
+
+require 'event_store/http/connect/connect'

data/lib/event_store/http/connect/assertions.rb

@@ -0,0 +1,23 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Assertions
+        def settings?(settings, namespace: nil)
+          namespace = Array(namespace)
+
+          Settings.names.all? do |name|
+            settings_value = settings.get name, *namespace
+
+            if settings_value.nil?
+              true
+            else
+              instance_value = __send__ name
+
+              instance_value == settings_value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/connect.rb

@@ -0,0 +1,174 @@
+module EventStore
+  module HTTP
+    class Connect
+      include Log::Dependency
+
+      dependency :resolve_host, DNS::ResolveHost
+      dependency :telemetry, ::Telemetry
+
+      setting :host
+      setting :port
+
+      setting :continue_timeout
+      setting :keep_alive_timeout
+      setting :open_timeout
+      setting :read_timeout
+
+      def self.build(settings=nil, namespace: nil)
+        settings ||= Settings.build
+        namespace = Array(namespace)
+
+        instance = new
+        DNS::ResolveHost.configure instance
+        ::Telemetry.configure instance
+        settings.set instance, *namespace
+        instance
+      end
+
+      def self.call(settings=nil, namespace: nil, host: nil, &block)
+        instance = build settings, namespace: namespace
+        instance.(host, &block)
+      end
+
+      def self.configure(receiver, settings=nil, namespace: nil, connect: nil, attr_name: nil)
+        attr_name ||= :connect
+
+        if connect.nil?
+          instance = build settings, namespace: namespace
+        else
+          instance = connect
+        end
+
+        receiver.public_send "#{attr_name}=", instance
+
+        instance
+      end
+
+      def self.register_telemetry_sink(instance)
+        sink = Telemetry::Sink.new
+        instance.telemetry.register sink
+        sink
+      end
+
+      def call(host=nil, &block)
+        log_attributes = LogAttributes.get self, host: host
+
+        host ||= self.host
+
+        logger.trace { "Establishing HTTP connection to EventStore (#{log_attributes})" }
+
+        begin
+          ip_addresses = resolve_ip_address host
+        rescue DNS::ResolveHost::ResolutionError => error
+          error_message = "Could not connect to EventStore (#{log_attributes}, Error: #{error.class})"
+          logger.error error_message
+
+          record_host_resolution_failed host, error
+
+          raise ConnectionError, error
+        end
+
+        record_host_resolved host, ip_addresses
+
+        net_http = nil
+
+        ip_addresses.each_with_index do |ip_address, index|
+          net_http = new_connection ip_address
+
+          begin
+            net_http.start
+
+            record_connection_established host, ip_address, net_http
+
+            break
+          rescue Errno::EADDRNOTAVAIL, Errno::ECONNREFUSED, SocketError => error
+            record_connection_attempt_failed host, ip_address, error
+
+            error_message = "Could not connect to EventStore (#{log_attributes}, IPAddress: #{ip_address} (#{index.next} of #{ip_addresses.count}), Error: #{error.class})"
+
+            if index + 1 == ip_addresses.count
+              logger.error error_message
+              raise ConnectionError, error_message
+            else
+              logger.warn error_message
+              net_http = nil
+            end
+          end
+        end
+
+        unless block.nil?
+          begin
+            block.(net_http)
+          ensure
+            net_http.finish
+          end
+        end
+
+        logger.info { "HTTP connection to EventStore established (#{log_attributes}, IPAddress: #{net_http.address})" }
+
+        net_http
+      end
+
+      def resolve_ip_address(host)
+        logger.trace { "Resolving IP address from host (Host: #{host})" }
+
+        ip_addresses = resolve_host.(host) do |dns_resolver|
+          dns_resolver.timeouts = open_timeout
+        end
+
+        logger.debug { "Resolved IP address from host (Host: #{host}, IPAddresses: #{ip_addresses.inspect})" }
+
+        ip_addresses
+      end
+
+      def record_connection_established(host, ip_address, connection)
+        record = Telemetry::ConnectionEstablished.new host, ip_address, port, connection
+
+        telemetry.record :connection_established, record
+
+        record
+      end
+
+      def record_connection_attempt_failed(host, ip_address, error)
+        record = Telemetry::ConnectionAttemptFailed.new host, ip_address, port, error
+
+        telemetry.record :connection_attempt_failed, record
+
+        record
+      end
+
+      def record_host_resolved(host, ip_addresses)
+        record = Telemetry::HostResolved.new host, ip_addresses
+
+        telemetry.record :host_resolved, record
+
+        record
+      end
+
+      def record_host_resolution_failed(host, error)
+        record = Telemetry::HostResolutionFailed.new host, error
+
+        telemetry.record :host_resolution_failed, record
+
+        record
+      end
+
+      def new_connection(ip_address)
+        net_http = Net::HTTP.new ip_address, port
+
+        net_http.continue_timeout = continue_timeout unless continue_timeout.nil?
+        net_http.keep_alive_timeout = keep_alive_timeout unless keep_alive_timeout.nil?
+        net_http.open_timeout = open_timeout unless open_timeout.nil?
+        net_http.read_timeout = read_timeout unless read_timeout.nil?
+
+        net_http
+      end
+
+      def port
+        @port ||= Defaults.port
+      end
+
+      ConnectionError = Class.new StandardError
+    end
+  end
+end

data/lib/event_store/http/connect/controls.rb

@@ -0,0 +1,20 @@
+require 'securerandom'
+
+require 'event_store/http/connect/controls/ip_address'
+require 'event_store/http/connect/controls/ip_address/loopback'
+require 'event_store/http/connect/controls/ip_address/loopback/alias'
+require 'event_store/http/connect/controls/ip_address/non_routable'
+require 'event_store/http/connect/controls/ip_address/unavailable'
+
+require 'event_store/http/connect/controls/cluster/hostname'
+require 'event_store/http/connect/controls/cluster/ip_address'
+require 'event_store/http/connect/controls/cluster/resolve_host'
+require 'event_store/http/connect/controls/cluster/size'
+
+require 'event_store/http/connect/controls/host'
+require 'event_store/http/connect/controls/hostname'
+require 'event_store/http/connect/controls/net_http'
+require 'event_store/http/connect/controls/port'
+require 'event_store/http/connect/controls/resolve_host'
+require 'event_store/http/connect/controls/settings'
+require 'event_store/http/connect/controls/timeouts'

data/lib/event_store/http/connect/controls/cluster.rb

@@ -0,0 +1,21 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module Cluster
+          module Hostname
+            def self.example
+              Hostname.example 'cluster'
+            end
+          end
+
+          module Size
+            def self.example
+              3
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/cluster/hostname.rb

@@ -0,0 +1,15 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module Cluster
+          module Hostname
+            def self.example
+              Controls::Hostname.example 'cluster'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/cluster/ip_address.rb

@@ -0,0 +1,52 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module Cluster
+          module IPAddress
+            def self.example(member_index=nil, third_octet: nil)
+              member_index ||= 1
+              third_octet ||= 111
+
+              Controls::IPAddress::Loopback::Alias.example(
+                member_index,
+                third_octet: third_octet
+              )
+            end
+
+            module List
+              def list
+                (1..Size.example).map do |member_index|
+                  example member_index
+                end
+              end
+            end
+            extend List
+
+            module Unavailable
+              extend List
+
+              def self.example(member_index=nil)
+                IPAddress.example member_index, third_octet: 222
+              end
+            end
+
+            module PartiallyAvailable
+              extend List
+
+              def self.example(member_index=nil)
+                member_index ||= nil
+
+                if member_index == 1
+                  Unavailable.example member_index
+                else
+                  IPAddress.example member_index
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/cluster/resolve_host.rb

@@ -0,0 +1,22 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module Cluster
+          module ResolveHost
+            def self.configure(receiver, host: nil, ip_addresses: nil)
+              host ||= Hostname.example
+              ip_addresses ||= IPAddress.list
+
+              Controls::ResolveHost.configure(
+                receiver,
+                host: host,
+                ip_addresses: ip_addresses
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/cluster/size.rb

@@ -0,0 +1,15 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module Cluster
+          module Size
+            def self.example
+              3
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/host.rb

@@ -0,0 +1,19 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module Host
+          def self.example
+            Hostname.example
+          end
+
+          module Other
+            def self.example
+              IPAddress.example
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/hostname.rb

@@ -0,0 +1,35 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module Hostname
+          def self.example(suffix=nil)
+            if suffix.nil?
+              'eventstore.local'
+            else
+              "eventstore-#{suffix}.local"
+            end
+          end
+
+          module Localhost
+            def self.example
+              'localhost'
+            end
+          end
+
+          module Other
+            def self.example(randomize: nil)
+              if randomize
+                random = SecureRandom.hex 7
+
+                "some-hostname-#{random}"
+              else
+                'some-hostname'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/ip_address.rb

@@ -0,0 +1,13 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module IPAddress
+          def self.example
+            Loopback.example
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/ip_address/loopback.rb

@@ -0,0 +1,15 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module IPAddress
+          module Loopback
+            def self.example
+              '127.0.0.1'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/ip_address/loopback/alias.rb

@@ -0,0 +1,66 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module IPAddress
+          module Loopback
+            module Alias
+              def self.example(fourth_octet=nil, third_octet: nil)
+                third_octet ||= 0
+
+                if third_octet == 0
+                  fourth_octet ||= 2
+                else
+                  fourth_octet ||= 1
+                end
+
+                "127.0.#{third_octet}.#{fourth_octet}"
+              end
+
+              module VerifyAll
+                def self.call
+                  port = Port::Unused.get
+
+                  unaliased_ip_addresses = list.select do |ip_address|
+                    begin
+                      server = TCPServer.new ip_address, port
+                      server.close
+                      false
+                    rescue Errno::EADDRNOTAVAIL
+                      true
+                    end
+                  end
+
+                  return true if unaliased_ip_addresses.none?
+
+                  warn <<~MESSAGE
+                  The following loopback aliases are not configured:
+
+                      #{unaliased_ip_addresses * "\n    "}
+
+                  To setup a loopback alias, run the following command:
+
+                      sudo ifconfig lo0 alias 127.0.111.1
+
+                  Note that the above command was tested on OS X and may vary
+                  on Linux systems.
+                  MESSAGE
+
+                  false
+                end
+
+                def self.list
+                  [
+                    Alias.example,
+                    *Cluster::IPAddress.list,
+                    *Cluster::IPAddress::Unavailable.list
+                  ]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/ip_address/non_routable.rb

@@ -0,0 +1,15 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module IPAddress
+          module NonRoutable
+            def self.example
+              '127.0.0.0'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/ip_address/unavailable.rb

@@ -0,0 +1,25 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module IPAddress
+          module Unavailable
+            def self.example
+              external
+            end
+
+            def self.external
+              local_ip_address_list = Socket.ip_address_list
+
+              local_ip_address_list.map! &:ip_address
+
+              local_ip_address_list.find do |ip_address|
+                ip_address != IPAddress::Loopback.example
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/net_http.rb

@@ -0,0 +1,37 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module NetHTTP
+          def self.example
+            net_http = Net::HTTP.new host, port
+            net_http.start
+            net_http
+          end
+
+          def self.host
+            IPAddress.example
+          end
+
+          def self.port
+            Port.example
+          end
+
+          module Defaults
+            def self.keep_alive_timeout
+              2
+            end
+
+            def self.open_timeout
+              60
+            end
+
+            def self.read_timeout
+              60
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/port.rb

@@ -0,0 +1,32 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module Port
+          def self.example
+            Connect::Defaults.port
+          end
+
+          module Unused
+            def self.get
+              localhost = IPAddress::Loopback.example
+
+              (10000..19999).each do |port|
+                begin
+                  socket = TCPSocket.new localhost, port
+                  socket.close
+                  next
+
+                rescue Errno::ECONNREFUSED
+                  return port
+                end
+              end
+
+              fail
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/resolve_host.rb

@@ -0,0 +1,18 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module ResolveHost
+          def self.configure(receiver, host: nil, ip_addresses: nil)
+            host ||= Hostname.example
+            ip_addresses ||= [IPAddress.example]
+
+            resolve_host = SubstAttr::Substitute.(:resolve_host, receiver)
+            resolve_host.set host, ip_addresses
+            resolve_host
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/settings.rb

@@ -0,0 +1,22 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module Settings
+          def self.example(host: nil, namespace: nil, **attributes)
+            host ||= IPAddress.example
+            namespace = Array(namespace)
+
+            attributes[:host] = host
+
+            data_source = namespace.reduce attributes do |hash, namespace|
+              { namespace => hash }
+            end
+
+            EventStore::HTTP::Connect::Settings.build data_source
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/controls/timeouts.rb

@@ -0,0 +1,25 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Controls
+        module Timeouts
+          def self.continue
+            1
+          end
+
+          def self.keep_alive
+            2
+          end
+
+          def self.open
+            3
+          end
+
+          def self.read
+            4
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/defaults.rb

@@ -0,0 +1,11 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Defaults
+        def self.port
+          2113
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/log.rb

@@ -0,0 +1,13 @@
+module EventStore
+  module HTTP
+    class Connect
+      class Log < ::Log
+        def tag!(tags)
+          tags << :event_store_http_connect
+          tags << :event_store
+          tags << :verbose
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/log_attributes.rb

@@ -0,0 +1,19 @@
+module EventStore
+  module HTTP
+    class Connect
+      module LogAttributes
+        def self.get(connect, host: nil)
+          if host.nil?
+            host_text = connect.host
+          else
+            host_text = "#{host} [Overriding setting: #{connect.host}]"
+          end
+
+          connect.instance_exec do
+            "Host: #{host_text}, Port: #{port}, KeepAliveTimeout: #{keep_alive_timeout || '(default)'}, ReadTimeout: #{read_timeout || '(default)'}, OpenTimeout: #{open_timeout || '(default)'}, ContinueTimeout: #{continue_timeout || '(none)'}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/net_http.rb

@@ -0,0 +1,25 @@
+module EventStore
+  module HTTP
+    class Connect
+      module NetHTTP
+        module Assertions
+          def connected?(ip_address: nil, port: nil)
+            unless ip_address.nil? || ip_address == self.address
+              return false
+            end
+
+            unless port.nil? || port == self.port
+              return false
+            end
+
+            active?
+          end
+
+          def closed?
+            not active?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/settings.rb

@@ -0,0 +1,21 @@
+module EventStore
+  module HTTP
+    class Connect
+      class Settings < ::Settings
+        def self.data_source
+          'settings/event_store_http.json'
+        end
+
+        def self.names
+          %i(
+            host
+            port
+            continue_timeout
+            read_timeout
+            open_timeout
+          )
+        end
+      end
+    end
+  end
+end

data/lib/event_store/http/connect/telemetry.rb

@@ -0,0 +1,24 @@
+module EventStore
+  module HTTP
+    class Connect
+      module Telemetry
+        class Sink
+          include ::Telemetry::Sink
+
+          record :host_resolved
+          record :host_resolution_failed
+          record :connection_attempt_failed
+          record :connection_established
+        end
+
+        HostResolved = Struct.new :host, :ip_addresses
+
+        HostResolutionFailed = Struct.new :host, :error
+
+        ConnectionAttemptFailed = Struct.new :host, :ip_address, :port, :error
+
+        ConnectionEstablished = Struct.new :host, :ip_address, :port, :connection
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: evt-event_store-http-connect
+version: !ruby/object:Gem::Version
+  version: 0.0.0.0
+platform: ruby
+authors:
+- The Eventide Project
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evt-dns-resolve_host
+  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: test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " "
+email: opensource@eventide-project.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/event_store/http/connect.rb
+- lib/event_store/http/connect/assertions.rb
+- lib/event_store/http/connect/connect.rb
+- lib/event_store/http/connect/controls.rb
+- lib/event_store/http/connect/controls/cluster.rb
+- lib/event_store/http/connect/controls/cluster/hostname.rb
+- lib/event_store/http/connect/controls/cluster/ip_address.rb
+- lib/event_store/http/connect/controls/cluster/resolve_host.rb
+- lib/event_store/http/connect/controls/cluster/size.rb
+- lib/event_store/http/connect/controls/host.rb
+- lib/event_store/http/connect/controls/hostname.rb
+- lib/event_store/http/connect/controls/ip_address.rb
+- lib/event_store/http/connect/controls/ip_address/loopback.rb
+- lib/event_store/http/connect/controls/ip_address/loopback/alias.rb
+- lib/event_store/http/connect/controls/ip_address/non_routable.rb
+- lib/event_store/http/connect/controls/ip_address/unavailable.rb
+- lib/event_store/http/connect/controls/net_http.rb
+- lib/event_store/http/connect/controls/port.rb
+- lib/event_store/http/connect/controls/resolve_host.rb
+- lib/event_store/http/connect/controls/settings.rb
+- lib/event_store/http/connect/controls/timeouts.rb
+- lib/event_store/http/connect/defaults.rb
+- lib/event_store/http/connect/log.rb
+- lib/event_store/http/connect/log_attributes.rb
+- lib/event_store/http/connect/net_http.rb
+- lib/event_store/http/connect/settings.rb
+- lib/event_store/http/connect/telemetry.rb
+homepage: https://github.com/eventide-project/event-store-http-connect
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Connection library to EventStore's HTTP interface
+test_files: []