quiz_broker_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 839a7e79c6b2ebb264aebe79fd12efb3329a6ef020b4bb88b7e9d27b01b93a4d
+  data.tar.gz: 420b141b32c8f99e5ea7dd0807e4810cc9d8ab947007ab72b95d52e3c4026b04
+SHA512:
+  metadata.gz: 7512454ccb3ce64059c645b222853a91347fb7fe837719f0c9f134d8749bb0a9fd748908d2f0edc54b0584f0561dec5bdfc73f820973b8c51bbb8a154efe3053
+  data.tar.gz: 2a365d373b825038e6a1b1d62f1c92cd7fcacf88d90a3ad5d5a992a17e081f35f1dc50575e9570690a07d4fda09f3a6b585d8ee0c147a9a01ed9078a9e5246ed

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,72 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Metrics/ClassLength:
+  Max: 200 # Default: 100
+
+Metrics/LineLength:
+  Max: 120 # Default: 80
+
+Metrics/MethodLength:
+  Max: 20 # Default: 10
+
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - quiz_broker_client.gemspec
+    - spec/**/*.rb
+
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+
+Layout/ParameterAlignment:
+  # Alignment of parameters in multi-line method calls.
+  #
+  # The `with_fixed_indentation` style aligns the following lines with one
+  # level of indentation relative to the start of the line with the method call.
+  #
+  #     method_call(a,
+  #       b)
+  EnforcedStyle: with_fixed_indentation
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Style/ClassAndModuleChildren:
+  # Checks the style of children definitions at classes and modules.
+  #
+  # Basically there are two different styles:
+  #
+  # `nested` - have each child on a separate line
+  #   class Foo
+  #     class Bar
+  #     end
+  #   end
+  #
+  # `compact` - combine definitions as much as possible
+  #   class Foo::Bar
+  #   end
+  #
+  # The compact style is only forced, for classes / modules with one child.
+  EnforcedStyle: nested
+  Enabled: false
+
+Style/Documentation:
+  # This cop checks for missing top-level documentation of classes and modules.
+  # Classes with no body and namespace modules are exempt from the check.
+  # Namespace modules are modules that have nothing in their bodies except
+  # classes or other modules.
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  # `always` will always add the frozen string literal comment to a file
+  # regardless of the Ruby version or if `freeze` or `<<` are called on a
+  # string literal. If you run code against multiple versions of Ruby, it is
+  # possible that this will create errors in Ruby 2.3.0+.
+  #
+  # See: https://wyeworks.com/blog/2015/12/1/immutable-strings-in-ruby-2-dot-3
+  EnforcedStyle: always
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-15
+
+- Initial release

data/Dockerfile

@@ -0,0 +1,16 @@
+# Build stage
+FROM instructure/ruby-passenger:2.7
+
+RUN mkdir -p coverage log
+
+USER root
+
+RUN apt-get update && apt-get install -y git
+
+USER docker
+
+COPY --chown=docker:docker . .
+
+RUN ./bin/setup
+
+CMD ["tail", "-f", "/dev/null"]

data/Jenkinsfile

@@ -0,0 +1,75 @@
+pipeline {
+  agent {
+    label 'docker'
+  }
+
+  options {
+    parallelsAlwaysFailFast()
+  }
+
+  stages {
+    stage('Build') {
+      steps {
+        sh 'docker compose build --pull'
+      }
+    }
+
+    stage('Lint') {
+      stages {
+        stage('Rubocop') {
+          steps {
+            sh '''#!/usr/bin/env bash
+            set -o pipefail
+            docker compose run --rm quiz_broker_client bundle exec rubocop --fail-level autocorrect
+            '''
+          }
+        }
+      }
+    }
+
+    stage('Spec') {
+      steps {
+        sh 'docker compose run quiz_broker_client bundle exec rspec --format doc'
+        sh '''
+        image=$(docker ps --all --no-trunc | grep spec | cut -f 1 -d " " | head -n 1)
+        docker cp "$image:/usr/src/app/coverage" .
+        '''
+        sh 'ls -als coverage'
+      }
+
+      post {
+        always {
+          publishHTML target: [
+              allowMissing: false,
+              alwaysLinkToLastBuild: false,
+              keepAll: true,
+              reportDir: 'coverage',
+              reportFiles: 'index.html',
+              reportName: 'Coverage Report'
+            ]
+        }
+      }
+    }
+
+    stage('Publish') {
+      when {
+        allOf {
+          expression { GERRIT_BRANCH == "master" }
+          environment name: "GERRIT_EVENT_TYPE", value: "change-merged"
+        }
+      }
+      steps {
+        withCredentials([string(credentialsId: 'rubygems-rw', variable: 'GEM_HOST_API_KEY')]) {
+          sh 'docker run -e GEM_HOST_API_KEY --rm quiz_broker_client /bin/bash -lc "./bin/publish.sh"'
+        }
+      }
+    }
+  }
+
+  post {
+    cleanup {
+      sh 'docker compose down --rmi=all --volumes --remove-orphans'
+    }
+  }
+}
+    

data/README.md

@@ -0,0 +1,24 @@
+# QuizBrokerClient
+Ruby client for New Quizzes broker interactions
+
+## Development
+First copy the compose override example file:
+```
+cp docker-compose.override.yml.example docker-compose.override.yml
+```
+
+This project uses [Compose watch](https://docs.docker.com/compose/file-watch/) to sync files between host and container.
+
+Compose watch will also rebuild the container (and install gems)
+if new dependencies are added to the gemspec.
+
+To build the container and start file watching, run the following
+```
+docker compose watch
+```
+
+## Testing
+Run the following command to execute the test suite:
+```
+docker compose run quiz_broker_client rake spec
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/quiz_broker_client/authorized_contexts.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module QuizBrokerClient::AuthorizedContexts
+  extend QuizBrokerClient::DynamoDB
+
+  AUTHORIZED_CONTEXTS_ATTRIBUTE = 'contexts'
+
+  class << self
+    def for(subject:)
+      response = get_item(
+        common_params.merge(
+          key: {
+            subject: subject
+          }
+        )
+      )
+
+      return Set.new if response.item.nil?
+
+      response.item[AUTHORIZED_CONTEXTS_ATTRIBUTE]
+    end
+
+    def set(subject:, contexts:)
+      put_item(
+        common_params.merge(
+          item: {
+            subject: subject,
+            created_at: Time.now.to_i,
+            delete_at: Time.now.to_i + QuizBrokerClient.configuration.ttl.to_i,
+            AUTHORIZED_CONTEXTS_ATTRIBUTE => Set.new(contexts)
+          }
+        )
+      )
+
+      true
+    end
+
+    private
+
+    def common_params
+      {
+        table_name: QuizBrokerClient.configuration.authorized_contexts_table_name
+      }
+    end
+  end
+end

data/lib/quiz_broker_client/configuration.rb

@@ -0,0 +1,9 @@
+module QuizBrokerClient
+  class Configuration
+    attr_accessor :authorized_contexts_table_name, :ttl
+
+    def initialize
+      @ttl = 43_200 # 12 hours
+    end
+  end
+end

data/lib/quiz_broker_client/dynamodb/client.rb

@@ -0,0 +1,23 @@
+module QuizBrokerClient::DynamoDB
+  methods = %i[get_item put_item]
+
+  methods.each do |method|
+    define_method(method) do |*args|
+      client.send(method, *args)
+    rescue Aws::DynamoDB::Errors::ServiceError,
+           Aws::Errors::MissingCredentialsError => e
+      clear_client!
+      raise e
+    end
+  end
+
+  private
+
+  def clear_client!
+    @_client = nil
+  end
+
+  def client
+    @_client ||= Aws::DynamoDB::Client.new
+  end
+end

data/lib/quiz_broker_client/dynamodb.rb

@@ -0,0 +1,4 @@
+require 'aws-sdk-dynamodb'
+require_relative 'dynamodb/client'
+
+module QuizBrokerClient::DynamoDB; end

data/lib/quiz_broker_client/version.rb

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

data/lib/quiz_broker_client.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'quiz_broker_client/version'
+require_relative 'quiz_broker_client/configuration'
+require_relative 'quiz_broker_client/dynamodb'
+require_relative 'quiz_broker_client/authorized_contexts'
+
+module QuizBrokerClient
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @_configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/quiz_broker_client.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/quiz_broker_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'quiz_broker_client'
+  spec.version = QuizBrokerClient::VERSION
+  spec.authors = ['Weston Dransfield']
+  spec.email = ['wdransfield@instructure.com']
+
+  spec.summary = 'Ruby client for New Quizzes broker interactions'
+  spec.description = 'Serves as the client for reading and writing to brokered data in Canvas New Quizzes'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile docker-compose])
+    end
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'aws-sdk-dynamodb', '~> 1', '>= 1.85.0'
+
+  spec.add_development_dependency 'byebug', '~> 9.0', '>= 9.0.5'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: quiz_broker_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Weston Dransfield
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dynamodb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.85.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.85.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+- !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: Serves as the client for reading and writing to brokered data in Canvas
+  New Quizzes
+email:
+- wdransfield@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Dockerfile
+- Jenkinsfile
+- README.md
+- Rakefile
+- lib/quiz_broker_client.rb
+- lib/quiz_broker_client/authorized_contexts.rb
+- lib/quiz_broker_client/configuration.rb
+- lib/quiz_broker_client/dynamodb.rb
+- lib/quiz_broker_client/dynamodb/client.rb
+- lib/quiz_broker_client/version.rb
+- quiz_broker_client.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.6
+signing_key: 
+specification_version: 4
+summary: Ruby client for New Quizzes broker interactions
+test_files: []