corona_presence_tracing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cb47ee319c9c21062ccdbd4796a75e6f26721e6ea06e8cc277bad4e9152e5c8
+  data.tar.gz: aa87a83fb4e8a29e4818b80f4d05b6c23c7831503a9a17fba4c3535b2a725d79
+SHA512:
+  metadata.gz: 593d7bcf06d9f02926d9d47f30844248ba540c8d53d9a2a1c5b90107ea9bbc252ba4c3c9c75e545f7e76645c3613295c9028b10ec9218017c1c682692d2f4d85
+  data.tar.gz: b64bdb30114568675a126f80fcef0f79e44d5707c80cd17d74a22455d7c36e80e27a0055737b6b11e0812c31f6f1abf9350916423f1fe614dbf910fb5be42449

data/lib/corona_presence_tracing.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'corona_presence_tracing/cwa_check_in'
+require_relative 'corona_presence_tracing/version'

data/lib/corona_presence_tracing/base.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative 'validator'
+require_relative 'proto/presence_tracing_pb'
+
+require 'base64'
+require 'securerandom'
+
+module CoronaPresenceTracing
+  module Base
+    attr_reader :description, :address, :start_time, :end_time
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def decode(encoded_payload)
+        base64_segment = encoded_payload.split('#').last
+        qr_payload = QRCodePayload.decode(Base64.urlsafe_decode64(base64_segment))
+        location = qr_payload.locationData
+
+        new(
+          description: location.description,
+          address: location.address,
+          start_time: Time.at(location.startTimestamp),
+          end_time: Time.at(location.endTimestamp),
+          **vendor_info(qr_payload.countryData)
+        )
+      end
+
+      private
+
+      def vendor_info(_country_data)
+        {}
+      end
+    end
+
+    def initialize(options = {})
+      @description = options[:description]
+      @address = options[:address]
+      @start_time = options[:start_time]
+      @end_time = options[:end_time]
+
+      validate
+      build_payload
+    end
+
+    def encoded_payload
+      @encoded_payload ||= Base64.urlsafe_encode64(QRCodePayload.encode(@qr_payload))
+    end
+
+    def url
+      [self.class::BASE_URL, encoded_payload].join('#')
+    end
+
+    private
+
+    def validate
+      CoronaPresenceTracing.const_get("#{self.class.name}Validator").new(self).validate
+    end
+
+    def build_payload
+      @qr_payload = QRCodePayload.new(
+        version: 1,
+        locationData: location_data,
+        crowdNotifierData: crowd_notifier_data,
+        countryData: encoded_vendor_data
+      )
+    end
+
+    def location_data
+      TraceLocation.new(
+        version: 1,
+        description: description,
+        address: address,
+        startTimestamp: start_time.to_i,
+        endTimestamp: end_time.to_i
+      )
+    end
+
+    def crowd_notifier_data
+      CrowdNotifierData.new(
+        version: 1,
+        publicKey: Base64.decode64(self.class::PUBLIC_KEY),
+        cryptographicSeed: SecureRandom.random_bytes(16)
+      )
+    end
+
+    def vendor_data
+      nil
+    end
+
+    def encoded_vendor_data
+      return unless vendor_data
+
+      vendor_data.class.encode(vendor_data)
+    end
+  end
+end

data/lib/corona_presence_tracing/cwa_check_in.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'proto/presence_tracing_pb'
+
+module CoronaPresenceTracing
+  class CWACheckIn
+    include Base
+
+    BASE_URL = 'https://e.coronawarn.app?v=1'
+    PUBLIC_KEY = 'gwLMzE153tQwAOf2MZoUXXfzWTdlSpfS99iZffmcmxOG9njSK4RTimFOFwDh6t0T' \
+                 'yw8XR01ugDYjtuKwjjuK49Oh83FWct6XpefPi9Skjxvvz53i9gaMmUEc96pbtoaA'
+
+    attr_reader :location_type, :default_check_in_length
+
+    class << self
+      private
+
+      def vendor_info(country_data)
+        location_data = CWALocationData.decode(country_data)
+        {
+          location_type: location_type_from_payload(location_data),
+          default_check_in_length: location_data.defaultCheckInLengthInMinutes
+        }
+      end
+
+      def location_type_from_payload(location_data)
+        location_data.type.to_s.delete_prefix('LOCATION_TYPE_').downcase.to_sym
+      end
+    end
+
+    def initialize(options = {})
+      @location_type = options[:location_type]
+      @default_check_in_length = options[:default_check_in_length]
+      super
+    end
+
+    private
+
+    def vendor_data
+      CWALocationData.new(
+        version: 1,
+        type: mapped_location_type,
+        defaultCheckInLengthInMinutes: default_check_in_length
+      )
+    end
+
+    def mapped_location_type
+      CoronaPresenceTracing::TraceLocationType.const_get("LOCATION_TYPE_#{location_type.to_s.upcase}")
+    end
+  end
+end

data/lib/corona_presence_tracing/proto/presence_tracing_pb.rb

@@ -0,0 +1,56 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: proto/presence_tracing.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("proto/presence_tracing.proto", :syntax => :proto3) do
+    add_message "corona_presence_tracing.QRCodePayload" do
+      optional :version, :uint32, 1
+      optional :locationData, :message, 2, "corona_presence_tracing.TraceLocation"
+      optional :crowdNotifierData, :message, 3, "corona_presence_tracing.CrowdNotifierData"
+      optional :countryData, :bytes, 4
+    end
+    add_message "corona_presence_tracing.TraceLocation" do
+      optional :version, :uint32, 1
+      optional :description, :string, 2
+      optional :address, :string, 3
+      optional :startTimestamp, :uint64, 5
+      optional :endTimestamp, :uint64, 6
+    end
+    add_message "corona_presence_tracing.CrowdNotifierData" do
+      optional :version, :uint32, 1
+      optional :publicKey, :bytes, 2
+      optional :cryptographicSeed, :bytes, 3
+      optional :type, :uint32, 4
+    end
+    add_message "corona_presence_tracing.CWALocationData" do
+      optional :version, :uint32, 1
+      optional :type, :enum, 2, "corona_presence_tracing.TraceLocationType"
+      optional :defaultCheckInLengthInMinutes, :uint32, 3
+    end
+    add_enum "corona_presence_tracing.TraceLocationType" do
+      value :LOCATION_TYPE_UNSPECIFIED, 0
+      value :LOCATION_TYPE_PERMANENT_OTHER, 1
+      value :LOCATION_TYPE_TEMPORARY_OTHER, 2
+      value :LOCATION_TYPE_PERMANENT_RETAIL, 3
+      value :LOCATION_TYPE_PERMANENT_FOOD_SERVICE, 4
+      value :LOCATION_TYPE_PERMANENT_CRAFT, 5
+      value :LOCATION_TYPE_PERMANENT_WORKPLACE, 6
+      value :LOCATION_TYPE_PERMANENT_EDUCATIONAL_INSTITUTION, 7
+      value :LOCATION_TYPE_PERMANENT_PUBLIC_BUILDING, 8
+      value :LOCATION_TYPE_TEMPORARY_CULTURAL_EVENT, 9
+      value :LOCATION_TYPE_TEMPORARY_CLUB_ACTIVITY, 10
+      value :LOCATION_TYPE_TEMPORARY_PRIVATE_EVENT, 11
+      value :LOCATION_TYPE_TEMPORARY_WORSHIP_SERVICE, 12
+    end
+  end
+end
+
+module CoronaPresenceTracing
+  QRCodePayload = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("corona_presence_tracing.QRCodePayload").msgclass
+  TraceLocation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("corona_presence_tracing.TraceLocation").msgclass
+  CrowdNotifierData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("corona_presence_tracing.CrowdNotifierData").msgclass
+  CWALocationData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("corona_presence_tracing.CWALocationData").msgclass
+  TraceLocationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("corona_presence_tracing.TraceLocationType").enummodule
+end

data/lib/corona_presence_tracing/validator.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module CoronaPresenceTracing
+  class ValidationError < StandardError
+    attr_reader :check_in, :attr, :error
+
+    def initialize(check_in, attr, error, message)
+      @check_in = check_in
+      @attr = attr
+      @error = error
+      super(message)
+    end
+  end
+
+  class CheckInValidator
+    def initialize(check_in)
+      @check_in = check_in
+    end
+
+    def validate
+      validate_presence_of :description, :address
+      validate_type_of :description, :address, %w[String]
+      validate_length_of :description, :address, max: 100
+      validate_type_of :start_time, :end_time, %w[DateTime Time Date]
+      validate_dates
+    end
+
+    private
+
+    def validate_presence_of(*attrs)
+      validate_attrs(attrs) do |attr, value|
+        raise_error(attr, :blank, "can't be blank") if value.nil? || value.is_a?(String) && value.empty?
+      end
+    end
+
+    def validate_length_of(*attrs, options)
+      max = options[:max]
+      validate_attrs(attrs) do |attr, value|
+        raise_error(attr, :length, "is too long (max #{max} characters)") if value.size > max
+      end
+    end
+
+    def validate_type_of(*attrs, types)
+      validate_attrs(attrs) do |attr, value|
+        unless value.nil? || types.include?(value.class.to_s)
+          raise_error(attr, :type, "must be a #{types.join(' or ')}")
+        end
+      end
+    end
+
+    def validate_inclusion_of(*attrs, values)
+      validate_attrs(attrs) do |attr, value|
+        unless value.nil? || values.include?(value)
+          raise_error(attr, :invalid, "must be one of the following values: #{values}")
+        end
+      end
+    end
+
+    def validate_dates
+      min = Time.at(0)
+      validate_attrs(%i[start_time end_time]) do |attr, value|
+        raise_error(attr, :invalid, "must be after #{min}") if value && value < min
+      end
+
+      return unless @check_in.end_time && @check_in.start_time && @check_in.end_time < @check_in.start_time
+
+      raise_error(:end_time, :invalid, "can't be before start_time")
+    end
+
+    def validate_attrs(attrs)
+      attrs.each do |attr|
+        yield attr, @check_in.public_send(attr)
+      end
+    end
+
+    def raise_error(attr, error, message)
+      raise ValidationError.new(@check_in, attr, error, "#{attr} #{message}")
+    end
+  end
+
+  class CWACheckInValidator < CheckInValidator
+    ALLOWED_LOCATION_TYPES = %i[
+      permanent_retail permanent_food_service permanent_craft permanent_workplace
+      permanent_educational_institution permanent_public_building permanent_other
+      temporary_cultural_event temporary_club_activity temporary_private_event
+      temporary_worship_service temporary_other
+    ].freeze
+
+    def validate
+      validate_type_of :location_type, %w[Symbol String]
+      validate_inclusion_of :location_type, ALLOWED_LOCATION_TYPES
+      validate_presence_of :default_check_in_length unless temporary_location?
+      validate_type_of :default_check_in_length, %w[Integer]
+      validate_inclusion_of :default_check_in_length, (0..1440)
+      super
+    end
+
+    def validate_dates
+      validate_presence_of :start_time, :end_time if temporary_location?
+      super
+    end
+
+    def temporary_location?
+      @check_in.location_type.to_s.start_with?('temporary')
+    end
+  end
+end

data/lib/corona_presence_tracing/version.rb

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

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: corona_presence_tracing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Albrecht Oster
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Implementation of the Corona Presence Tracing specification for check-in
+  links and QR codesusing Corona Contact Tracing apps.
+email:
+- albrecht@oster.online
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/corona_presence_tracing.rb
+- lib/corona_presence_tracing/base.rb
+- lib/corona_presence_tracing/cwa_check_in.rb
+- lib/corona_presence_tracing/proto/presence_tracing_pb.rb
+- lib/corona_presence_tracing/validator.rb
+- lib/corona_presence_tracing/version.rb
+homepage: https://github.com/A1bi/corona_presence_tracing
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/A1bi/corona_presence_tracing
+  source_code_uri: https://github.com/A1bi/corona_presence_tracing
+  changelog_uri: https://github.com/A1bi/corona_presence_tracing/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Corona check-in link and QR code generator
+test_files: []