es-http-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96beb2009b1bb63cfc65f17f652c828541290e16
+  data.tar.gz: a4e96f7f8f7c264fe05728fd3c6d0b1398a6204c
+SHA512:
+  metadata.gz: 1a2901d97560b14975dae589d656bd1a2bc5660c1b0bb2b2f42047c0de0ea2fa521bfe33d383d728bf59750c05d39e3eb6de2d3c90623e15e7a359e0f12df506
+  data.tar.gz: 13acf122a54d600287869df41ca1d7789f64f0d1a28c720863a96f5e37228767e12c7299e279871241cd1d5d3bdc6d363d378d164b49480ad459d563f8d72796

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+rdoc
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Max: 99
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+Style/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines
+DisplayCopNames: true
+DisplayStyleGuide: true

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/Gemfile

@@ -0,0 +1,15 @@
+ruby '2.4.0'
+
+source 'http://rubygems.org'
+
+gem 'uuidtools'
+gem 'faraday'
+gem 'faraday_middleware'
+gem 'json'
+gem 'hashie'
+
+group :development, :test do
+  gem 'rspec'
+  gem 'guard'
+  gem 'guard-rspec', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,84 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    faraday (0.11.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.11.0.1)
+      faraday (>= 0.7.4, < 1.0)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashie (3.5.5)
+    json (2.0.3)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.11)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (12.0.0)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.8)
+      ffi (>= 0.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.4)
+    uuidtools (2.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday
+  faraday_middleware
+  guard
+  guard-rspec
+  hashie
+  json
+  rake
+  rspec
+  uuidtools
+
+RUBY VERSION
+   ruby 2.4.0p0
+
+BUNDLED WITH
+   1.13.7

data/Guardfile

@@ -0,0 +1,13 @@
+directories %w(lib spec) \
+ .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+guard :rspec, cmd: "bundle exec rspec", all_on_start: true, first_match: true do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_files)
+  watch(%r{^spec/.+\.rb$}) { rspec.spec_dir }
+  watch(%r{^lib/.+\.rb$}) { rspec.spec_dir }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kevin Rutherford
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# es-http-client
+A Ruby HTTP client for EventStore
+
+## Installation
+
+Install the gem
+
+```
+gem install es-http-client
+```
+
+Or add it to your Gemfile and run `bundle`.
+
+``` ruby
+gem 'es-http-client'
+```
+
+## Usage
+
+Open a connection to EventStore:
+```ruby
+eventstore = EsHttpClient.connect('http://localhost:2113', 'admin', 'changeit')
+```
+
+Subscribe to `$all`:
+
+``` ruby
+stream = eventstore.all_events
+stream = stream.replay_forward {|event| ... }
+stream.subscribe {|event| ... }
+```
+
+Write to a stream:
+
+```ruby
+stream = eventstore.stream(:user, user_id)
+return 404 unless stream.exists?
+stream_version = -1
+stream.replay_forward do |event|
+  if event.type == 'UserAccountClosed'
+    return [410, JSON.pretty_generate({
+      errors: 'User account already closed'
+    })]
+  end
+  stream_version = event.number
+end
+return [400, JSON.pretty_generate({
+  errors: "Stream #{stream} unexpectedly empty"
+})] if stream_version < 0
+event = EsHttpClient.create_event('UserAccountClosed', { userId:  user_id })
+stream.append(event, stream_version) ? 200 : 409
+```

data/es-http-client.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'es-http-client'
+  spec.version       = '0.1.0'
+  spec.licenses      = ['MIT']
+  spec.authors       = ['Kevin Rutherford']
+  spec.email         = ['kevin@rutherford-software.com']
+
+  spec.summary       = %q{A simple HTTP client for EventStore}
+  spec.description   = %q{A simple HTTP client for EventStore}
+  spec.homepage      = "https://github.com/kevinrutherford/es-http-client"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rspec', '3.5.0'
+
+  spec.add_dependency 'faraday', '0.11.0'
+  spec.add_dependency 'faraday_middleware', '0.11.0.1'
+  spec.add_dependency 'json', '2.0.3'
+  spec.add_dependency 'hashie', '3.5.5'
+  spec.add_dependency 'uuidtools', '2.1.5'
+end

data/lib/es_http_client.rb

@@ -0,0 +1,27 @@
+require 'uuidtools'
+require_relative './es_http_client/client'
+require_relative './es_http_client/connection'
+require_relative './es_http_client/es_http_client_error'
+
+module EsHttpClient
+
+  module ExpectedVersion
+    Any         = -2
+    NoStream    = -1
+    EmptyStream = -1
+  end
+
+  def self.connect(endpoint, username, password)
+    Client.new(Connection.new(endpoint, username, password))
+  end
+
+  def self.create_event(type, data)
+    id = UUIDTools::UUID.random_create.to_s
+    timestamp = Time.now.strftime('%FT%T.%3N%:z')
+    data = data.merge({
+      occurredAt: timestamp
+    })
+    Event.new(id, type, data, timestamp, 0)
+  end
+
+end

data/lib/es_http_client/caught_up_stream.rb

@@ -0,0 +1,32 @@
+require_relative './event'
+require_relative './page'
+
+module EsHttpClient
+
+  class CaughtUpStream
+
+    def initialize(ref, connection)
+      @ref = ref
+      @connection = connection
+    end
+
+    def subscribe(&block)
+      loop do
+        sleep 1
+        @ref = fetch(@ref, &block)
+      end
+    end
+
+    def fetch(ref, &block)
+      response = @connection.get(ref.uri, ref.etag)
+      page = Page.new(response.body)
+      next_uri = ref.uri
+      if page.has_entries?
+        page.each_event(&block)
+        next_uri = page.previous
+      end
+      return Ref.new(next_uri, response.headers['etag'])
+    end
+
+  end
+end

data/lib/es_http_client/client.rb

@@ -0,0 +1,22 @@
+require_relative './readonly_stream'
+require_relative './writeable_stream'
+
+module EsHttpClient
+
+  class Client
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def stream(type, id)
+      WriteableStream.new("#{type}-#{id}", @connection)
+    end
+
+    def all_events
+      @all ||= ReadonlyStream.new("$all", @connection)
+    end
+
+  end
+
+end

data/lib/es_http_client/connection.rb

@@ -0,0 +1,58 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'base64'
+require_relative './error_handler'
+
+module EsHttpClient
+
+  class Connection
+
+    def initialize(endpoint, username=nil, password=nil)
+      STDERR.puts "Faraday connecting to #{endpoint}"
+      @connection = Faraday.new(url: endpoint) do |faraday|
+        faraday.request :retry, max: 4, interval: 0.05, interval_randomness: 0.5, backoff_factor: 2
+        faraday.response :json, content_type: 'application/json'
+        faraday.response :mashify
+        faraday.adapter Faraday.default_adapter
+        faraday.use ErrorHandler
+      end
+      @headers = {
+        'Accept'       => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+      if username && password
+        token = Base64.encode64("#{username}:#{password}")[0..-2]
+        @headers.merge!({ 'Authorization' => "Basic #{token}" })
+      end
+    end
+
+    def get(uri, etag)
+      response = @connection.send(:get, uri) do |req|
+        req.headers = @headers
+        req.headers.merge({ 'If-None-Match' => etag, 'ES-LongPoll' => 10 }) if etag
+        req.body = {}.to_json
+        req.params['embed'] = 'body'
+      end
+      response
+    rescue EsHttpClientError => e
+      STDERR.puts "Faraday: Error response #{e}"
+      raise e
+    end
+
+    def post(uri, event, expected_version)
+      @connection.send(:post, uri) do |req|
+        req.headers = {
+          'Accept'        => 'application/json',
+          'Content-Type'  => 'application/json',
+          'ES-EventType' => event.type,
+          'ES-EventId'   => event.id,
+          'ES-ExpectedVersion' => expected_version.to_s
+        }
+        req.body = event.data.to_json
+      end
+    end
+
+  end
+
+end

data/lib/es_http_client/error_handler.rb

@@ -0,0 +1,15 @@
+require 'faraday'
+require 'faraday_middleware'
+require_relative './es_http_client_error'
+
+module EsHttpClient
+
+  class ErrorHandler < Faraday::Response::Middleware
+
+    def on_complete(env)
+      status = env[:status]
+      raise EsHttpClientError.new(status, env[:reason_phrase]) if status >= 400
+    end
+
+  end
+end

data/lib/es_http_client/es_http_client_error.rb

@@ -0,0 +1,14 @@
+module EsHttpClient
+
+  class EsHttpClientError < StandardError
+
+    attr_reader :code
+
+    def initialize(code, reason)
+      @code = code
+      super("#{code}: #{reason}")
+    end
+
+  end
+
+end

data/lib/es_http_client/event.rb

@@ -0,0 +1,24 @@
+module EsHttpClient
+
+  class Event < Struct.new(:id, :type, :data, :updated, :number, :uri, :stream_id)
+
+    def self.load_from(hash)
+      return nil unless hash['data']
+      data = JSON.parse(hash['data'], symbolize_names: true)
+      event = Event.new(hash['eventId'], hash['eventType'], data, hash['updated'], hash['eventNumber'].to_i, hash['id'], hash['streamId'])
+      event
+    end
+
+    def occurred_at
+      data[:occurredAt]
+    end
+
+    private
+
+    def initialize(id, type, data, updated=nil, number=nil, uri=nil, stream_id=nil)
+      super
+    end
+
+  end
+
+end

data/lib/es_http_client/page.rb

@@ -0,0 +1,39 @@
+module EsHttpClient
+
+  class Page
+
+    def initialize(body)
+      @body = body
+    end
+
+    def last
+      find_link('last')
+    end
+
+    def previous
+      find_link('previous')
+    end
+
+    def has_entries?
+      @body['entries'] && @body['entries'].length > 0
+    end
+
+    def each_event(&block)
+      @body['entries']
+        .reverse!
+        .map {|e| Event.load_from(e)}
+        .compact
+        .select {|e| e.type !~ /^\$/ }
+        .each {|e| yield e }
+    end
+
+    private
+
+    def find_link(rel)
+      link = @body['links'].detect { |l| l['relation'] == rel }
+      link.nil? ? nil : link['uri']
+    end
+
+  end
+
+end

data/lib/es_http_client/readonly_stream.rb

@@ -0,0 +1,22 @@
+require_relative './stream_events'
+require_relative './caught_up_stream'
+require_relative './event'
+require_relative './ref'
+
+module EsHttpClient
+
+  class ReadonlyStream
+
+    def initialize(stream_name, connection)
+      @stream_name = stream_name
+      @connection = connection
+    end
+
+    def replay_forward(&block)
+      ref = StreamEvents.new(@stream_name, @connection).each(&block)
+      CaughtUpStream.new(ref, @connection)
+    end
+
+  end
+
+end

data/lib/es_http_client/ref.rb

@@ -0,0 +1,11 @@
+module EsHttpClient
+
+  class Ref < Struct.new(:uri, :etag)
+
+    def self.head_of(stream_name)
+      Ref.new("/streams/#{stream_name}", nil)
+    end
+
+  end
+
+end

data/lib/es_http_client/stream_events.rb

@@ -0,0 +1,41 @@
+require_relative './page'
+
+module EsHttpClient
+
+  class StreamEvents
+
+    def initialize(name, connection)
+      @connection = connection
+      @latest_ref = Ref.head_of(name)
+    end
+
+    def each(&block)
+      page = read_stream_page(@latest_ref.uri)
+      last = page.last
+      page = read_stream_page(last) if last
+      loop do
+        break unless page.has_entries?
+        page.each_event(&block)
+        next_page = page.previous
+        break unless next_page
+        page = read_stream_page(next_page)
+      end
+      return @latest_ref
+    end
+
+    private
+
+    def read_stream_page(uri)
+      response = @connection.get(uri, @latest_ref.etag)
+      @latest_ref = Ref.new(uri, response.headers['etag'])
+      Page.new(response.body)
+    end
+
+    def find_link(links, rel)
+      link = links.detect { |l| l['relation'] == rel }
+      link.nil? ? nil : link['uri']
+    end
+
+  end
+
+end

data/lib/es_http_client/writeable_stream.rb

@@ -0,0 +1,41 @@
+require_relative './stream_events'
+require_relative './ref'
+
+module EsHttpClient
+
+  class WriteableStream
+
+    def initialize(name, connection)
+      @stream_name = name
+      @connection = connection
+    end
+
+    def to_s
+      @stream_name
+    end
+
+    def exists?
+      ref = Ref.head_of(@stream_name)
+      @connection.get(ref.uri, ref.etag)
+      true
+    rescue EsHttpClientError => e
+      return false if e.code == 404
+      raise e
+    end
+
+    def append(event, expected_version=ExpectedVersion::Any)
+      @connection.post(Ref.head_of(@stream_name).uri, event, expected_version)
+      true
+    rescue EsHttpClientError => e
+      STDERR.puts e.message
+      STDERR.puts e.backtrace
+      false
+    end
+
+    def replay_forward(&block)
+      StreamEvents.new(@stream_name, @connection).each(&block)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: es-http-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Rutherford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.5
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+description: A simple HTTP client for EventStore
+email:
+- kevin@rutherford-software.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- es-http-client.gemspec
+- lib/es_http_client.rb
+- lib/es_http_client/caught_up_stream.rb
+- lib/es_http_client/client.rb
+- lib/es_http_client/connection.rb
+- lib/es_http_client/error_handler.rb
+- lib/es_http_client/es_http_client_error.rb
+- lib/es_http_client/event.rb
+- lib/es_http_client/page.rb
+- lib/es_http_client/readonly_stream.rb
+- lib/es_http_client/ref.rb
+- lib/es_http_client/stream_events.rb
+- lib/es_http_client/writeable_stream.rb
+homepage: https://github.com/kevinrutherford/es-http-client
+licenses:
+- MIT
+metadata: {}
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A simple HTTP client for EventStore
+test_files: []