etwin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91479b28b00a4f5f8225a418c5f1f742fdd71554d00afbb5c4c5fe69858152fa
+  data.tar.gz: ed39199b30be361b3568339b75d288f0706531aac94598fb0b63f74d25448b36
+SHA512:
+  metadata.gz: 2a5758dfe8e51877b210a3ee1e98f183d020c122582f107a68c031acc85564054b351bc94c4d26d7faa358497bfa6682c4b27a1e12e2c5bbab85922fce5ca6c9
+  data.tar.gz: ef84e9e060c0b7a7002b3d02a878f15d440f81543e2e9879f94a88c59ca15ff2f97e3d5ae0d286466f127b456fdf9a20a01cc156fdd29ba9ddf523c29b0dc4d4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+require:
+  - rubocop-sorbet
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  NewCops: "enable"
+  TargetRubyVersion: 2.7
+
+Style/AccessorGrouping:
+  EnforcedStyle: "separated"

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hello_rb.gemspec
+gemspec
+
+gem 'irb', '~> 1.2.7', group: :development
+gem 'ruby-debug-ide', '~> 2.3.1', group: :development

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    etwin (0.0.1)
+      faraday (~> 1.1.0)
+      sorbet-runtime (~> 0.5.6076)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    debase (2.3.2)
+      debase-ruby_core_source (~> 0.10.11)
+    debase-ruby_core_source (0.10.11)
+    diff-lcs (1.4.4)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    io-console (0.5.6)
+    irb (1.2.7)
+      reline (>= 0.1.5)
+    multipart-post (2.1.1)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    reline (0.1.9)
+      io-console (~> 0.5)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.3.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-sorbet (0.5.1)
+      rubocop
+    ruby-debug-ide (2.3.1)
+      debase (~> 2.3.2)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    sorbet (0.5.6084)
+      sorbet-static (= 0.5.6084)
+    sorbet-runtime (0.5.6111)
+    sorbet-static (0.5.6084-x86_64-linux)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  etwin!
+  irb (~> 1.2.7)
+  rake (~> 13.0.1)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.3.1)
+  rubocop-sorbet (~> 0.5.1)
+  ruby-debug-ide (~> 2.3.1)
+  sorbet (~> 0.5.6076)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,30 @@
+# Etwin client for ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'etwin'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+## Usage
+
+TODO
+
+## Development
+
+```
+bundle install
+bundle exec rubocop
+bundle exec rspec
+bundle exec rake release
+bundle exec rake install
+bundle exec srb tc
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'etwin'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/etwin.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/etwin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'etwin'
+  spec.version       = Etwin::VERSION
+  spec.authors       = ['Charles Samborski']
+  spec.email         = ['demurgos@demurgos.net']
+  spec.licenses      = ['AGPL-3.0-or-later']
+
+  spec.summary       = 'Ruby client for the Eternal-Twin API.'
+  spec.description   = 'Ruby client for the Eternal-Twin API. Defines Etwin domain types and HTTP client.'
+  spec.homepage      = 'https://gitlab.com/eternal-twin/etwin'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://gitlab.com/eternal-twin/etwin'
+  spec.metadata['changelog_uri'] = 'https://gitlab.com/eternal-twin/etwin'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency('rake', '~> 13.0.1')
+  spec.add_development_dependency('rspec', '~> 3.10.0')
+  spec.add_development_dependency('rubocop', '~> 1.3.1')
+  spec.add_development_dependency('rubocop-sorbet', '~> 0.5.1')
+  spec.add_development_dependency('sorbet', '~> 0.5.6076')
+  spec.add_runtime_dependency('faraday', '~> 1.1.0')
+  spec.add_runtime_dependency('sorbet-runtime', '~> 0.5.6076')
+end

data/lib/etwin.rb

@@ -0,0 +1,27 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+require 'pp'
+require 'time'
+require 'sorbet-runtime'
+
+# Eternal-Twin types and client
+module Etwin
+  # class << self
+  #   def get_user(name)
+  #     "Hello, #{name}"
+  #   end
+  # end
+end
+
+require_relative './etwin/auth'
+require_relative './etwin/core'
+require_relative './etwin/hammerfest'
+require_relative './etwin/link'
+require_relative './etwin/twinoid'
+require_relative './etwin/user'
+require_relative './etwin/version'
+
+require_relative './etwin/_auth'

data/lib/etwin/_auth.rb

@@ -0,0 +1,4 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative './auth/_auth_context'

data/lib/etwin/auth.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  # Authentication and Authorization typess
+  module Auth
+  end
+end
+
+require_relative './auth/auth_context'
+require_relative './auth/auth_scope'
+require_relative './auth/auth_type'
+require_relative './auth/guest_auth_context'
+require_relative './auth/user_auth_context'

data/lib/etwin/auth/_auth_context.rb

@@ -0,0 +1,30 @@
+# typed: false
+# frozen_string_literal: true
+
+module Etwin
+  module Auth # rubocop:disable Style/Documentation
+    class << AuthContext
+      extend T::Sig
+
+      sig(:final) { returns(String) }
+      def AuthContext.name
+        'Etwin::Auth::AuthContext'
+      end
+
+      sig(:final) { params(json_str: String).returns(T.self_type) }
+      def AuthContext.from_json(json_str)
+        deserialize JSON.parse(json_str)
+      end
+
+      sig(:final) { params(raw: T.untyped).returns(T.self_type) }
+      def AuthContext.deserialize(raw)
+        type = AuthType.deserialize(raw['type'])
+        case type
+        when AuthType::Guest then GuestAuthContext.deserialize(raw)
+        when AuthType::User then UserAuthContext.deserialize(raw)
+        else T.absurd(type)
+        end
+      end
+    end
+  end
+end

data/lib/etwin/auth/auth_context.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Auth # rubocop:disable Style/Documentation
+    extend T::Sig
+    AuthContext = T.type_alias { T.any(GuestAuthContext, UserAuthContext) }
+  end
+end

data/lib/etwin/auth/auth_scope.rb

@@ -0,0 +1,25 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Auth
+    # Authentication scope enum
+    class AuthScope < T::Enum
+      extend T::Sig
+
+      enums do
+        Default = new('Default')
+      end
+
+      sig { returns(String) }
+      def to_s
+        T.cast(serialize, String)
+      end
+
+      sig { returns(String) }
+      def inspect
+        "AuthScope(#{self})"
+      end
+    end
+  end
+end

data/lib/etwin/auth/auth_type.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Auth
+    # Authentication type enum
+    class AuthType < T::Enum
+      extend T::Sig
+
+      enums do
+        Guest = new('Guest')
+        User = new('User')
+      end
+
+      sig { returns(String) }
+      def to_s
+        T.cast(serialize, String)
+      end
+
+      sig { returns(String) }
+      def inspect
+        "AuthType(#{self})"
+      end
+    end
+  end
+end

data/lib/etwin/auth/guest_auth_context.rb

@@ -0,0 +1,71 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Auth
+    # Guest authentication context
+    class GuestAuthContext
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      sig(:final) { returns(AuthScope) }
+      attr_reader :scope
+
+      sig(:final) { params(scope: AuthScope).void }
+      def initialize(scope)
+        @scope = T.let(scope, AuthScope)
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when GuestAuthContext
+          @scope == other.scope
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        [@scope].hash
+      end
+
+      # https://github.com/sorbet/sorbet/blob/master/rbi/stdlib/json.rbi#L194
+      sig(:final) { params(opts: T.untyped).returns(String) }
+      def to_json(opts = nil)
+        JSON.generate(as_json, opts)
+      end
+
+      sig(:final) { returns(T::Hash[String, T.untyped]) }
+      def as_json
+        {
+          'scope' => @scope.serialize
+        }
+      end
+
+      sig(:final) { returns(String) }
+      def inspect
+        "GuestAuthContext(scope=#{@scope.inspect})"
+      end
+
+      class << self
+        extend T::Sig
+
+        sig(:final) { params(json_str: String).returns(T.attached_class) }
+        def from_json(json_str)
+          deserialize JSON.parse(json_str)
+        end
+
+        sig(:final) { params(raw: T.untyped).returns(T.attached_class) }
+        def deserialize(raw)
+          scope = AuthScope.deserialize(raw['scope'])
+          new(scope)
+        end
+      end
+    end
+  end
+end