karper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13cf13577600ed624dee10e2ab9704512b09fa2844bce053e168e4d4c45ebd71
+  data.tar.gz: dca0a60d7746cda3a680c7d303bf02d0ea3c7e05b46819823388f05626c8a5f2
+SHA512:
+  metadata.gz: 8e53572489481446c12507bc7c2c1a345329b7bd8ae36ea5ee9cc5162cefb62ff004e5e236159709393409536f87e3fcf6de1b53c276baaafc1dc6985fe44839
+  data.tar.gz: 3f1b257a533333a8fe5297aaa49db5829db6e01dfdb8a0e46b17bad35ea79b93fd2b442e29808f1915f490aa07268a34027c9bb8bab310bdd6627d08f99091e5

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) Fingertips
+
+MIT License
+
+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,15 @@
+# Karper Server
+
+A single channel chat server.
+
+## Start
+
+```sh
+gem install karper
+karper server
+```
+
+## Technical design in a nutshell
+
+* Communication over TCP
+* Encoded using MessagePack

data/lib/karper/code.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Karper
+  module Code
+    ERRORS = {
+      'create_invitation' => {
+        '7a2f22' => 'Duplicate nick; someone else is using that nick, please choose another one.'
+      }
+    }.freeze
+    NOTES = {
+      '1fac60' => 'Server will pause for backup, please wait 10 seconds before attempting to send new messages.'
+    }.freeze
+  end
+end

data/lib/karper/faker.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Karper
+  module Faker
+    FIRST = %w[mar lig erg tus fre urm ioa poh gaf def self.kel mee fad].freeze
+    LAST = %w[urg dee uts pee oop sed sad ddo ver cef laa lah gah].freeze
+    CONNECTORS = %w[- _ x].freeze
+
+    def self.generate_newt
+      Karper::Newt.generate
+    end
+
+    class << self
+      alias generate_user_id generate_newt
+      alias generate_invitation_token generate_newt
+    end
+
+    def self.generate_timestamp
+      # We only support up to 3 decimal places on milliseconds, so we roundtrip it through out own packing methods.
+      Karper::Unpacker.unpack_time(Karper::Packer.pack_time(Time.now.utc + rand(100) - 50))
+    end
+
+    def self.generate_word
+      (FIRST + LAST).sample
+    end
+
+    def self.generate_words
+      (0..rand(20)).map { generate_word }.join(' ')
+    end
+
+    def self.generate_contents
+      "#{generate_word.capitalize} #{generate_words}."
+    end
+
+    def self.generate_nick
+      connector = rand(4) == 1 ? ' ' : CONNECTORS.sample
+      nick = [FIRST.sample, connector, LAST.sample].compact.join
+      case rand(3)
+      when 0
+        nick.upcase
+      when 1
+        nick.downcase
+      else
+        nick.split.map { |part| "#{part[0].upcase}#{part[1..]}" }.join
+      end
+    end
+
+    def self.generate_password
+      "#{%w[zeewolf flipper winter].sample}#{rand(100).to_s[0, 2]}"
+    end
+
+    def self.generate_url
+      'http://example.com'
+    end
+
+    def self.generate_document_attributes
+      {}
+    end
+
+    def self.generate_attributes(members)
+      members.map do |name|
+        send("generate_#{name}")
+      end
+    end
+
+    Karper::Message.constants.each do |constant|
+      next if %i[Error Note].include?(constant)
+
+      class_name = Karper::Message.const_get(constant)
+      method_name = constant.to_s.gsub(/[A-Z]/) { |a, b| "_#{a.downcase}#{b}" }[1..]
+      class_eval <<~METHOD, __FILE__, __LINE__ + 1
+        def self.#{method_name}
+          #{class_name}.new(*generate_attributes(#{class_name.members.inspect}))
+        end
+      METHOD
+    end
+
+    def self.error
+      command = Karper::Code::ERRORS.keys.sample
+      code = Karper::Code::ERRORS[command].keys.sample
+      Karper::Message::Error.new(
+        generate_newt,
+        command,
+        code,
+        Karper::Code::ERRORS[command][code],
+        {}
+      )
+    end
+
+    def self.note
+      code = Karper::Code::NOTES.keys.sample
+      Karper::Message::Note.new(
+        generate_newt,
+        code,
+        Karper::Code::NOTES[code],
+        {}
+      )
+    end
+  end
+end

data/lib/karper/message.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Karper
+  module Message
+    CreateInvitation = Struct.new(:newt, :nick)
+    Invitation = Struct.new(:newt, :timestamp, :nick, :invitation_token)
+
+    CreateRegistration = Struct.new(:newt, :invitation_token, :password)
+    Registration = Struct.new(:newt, :timestamp, :user_id, :invitation_token, :nick)
+
+    CreateAuthentication = Struct.new(:newt, :user_id, :password)
+    Authentication = Struct.new(:newt, :timestamp, :user_id, :nick)
+
+    CreateMessage = Struct.new(:newt, :contents)
+    Message = Struct.new(:newt, :timestamp, :user_id, :contents)
+
+    UpdateNick = Struct.new(:newt, :user_id, :nick)
+    Nick = Struct.new(:newt, :timestamp, :user_id, :nick)
+
+    CreateMedia = Struct.new(:newt, :url, :document_attributes)
+    Media = Struct.new(:newt, :timestamp, :user_id, :url, :document_attributes)
+
+    UpdateTopic = Struct.new(:newt, :contents)
+    Topic = Struct.new(:newt, :timestamp, :user_id, :contents)
+
+    Error = Struct.new(:newt, :command, :error_code, :error_message, :attributes)
+    Note = Struct.new(:newt, :error_code, :error_message, :attributes)
+  end
+end

data/lib/karper/newt.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Karper
+  module Newt
+    def self.generate
+      SecureRandom.bytes(12)
+    end
+  end
+end

data/lib/karper/packer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Karper
+  module Packer
+    RLF = /\r\n/
+
+    def self.pack_time(value)
+      value.strftime('%Y-%m-%dT%H:%M:%S.%3NZ')
+    end
+
+    def self.map(values)
+      values.map do |value|
+        case value
+        when String
+          value.gsub(RLF, "\n")
+        when Time
+          pack_time(value)
+        else
+          value
+        end
+      end
+    end
+
+    def self.pack(object)
+      MessagePack.pack(map(object.to_a))
+    end
+  end
+end

data/lib/karper/state.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Karper
+  class State
+    def initialize
+      @messages = []
+    end
+  end
+end

data/lib/karper/unpacker.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Karper
+  module Unpacker
+    def self.unpack_time(value)
+      Time.parse(value)
+    end
+
+    def self.unpack(message_class, input)
+      values = MessagePack.load(input)
+      message_class.members.each.with_index do |name, index|
+        next unless name == :timestamp
+
+        values[index] = unpack_time(values[index])
+      end
+      message_class.new(*values)
+    end
+  end
+end

data/lib/karper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Karper
+  VERSION = '0.1.0'
+end

data/lib/karper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'msgpack'
+
+require 'karper/message'
+
+module Karper
+  autoload :Code, 'karper/code'
+  autoload :Faker, 'karper/faker'
+  autoload :Formatter, 'karper/parser'
+  autoload :Newt, 'karper/newt'
+  autoload :Packer, 'karper/packer'
+  autoload :State, 'karper/state'
+  autoload :Unpacker, 'karper/unpacker'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: karper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manfred Stienstra
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: ''
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/karper.rb
+- lib/karper/code.rb
+- lib/karper/faker.rb
+- lib/karper/message.rb
+- lib/karper/newt.rb
+- lib/karper/packer.rb
+- lib/karper/state.rb
+- lib/karper/unpacker.rb
+- lib/karper/version.rb
+homepage:
+licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Karper is a simple single channel chat server.
+test_files: []