gatekeeper_api_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9bbeca19cfee61257aa8fa4dea9cc09e371da8240c97821723ccda148e552ddc
+  data.tar.gz: d9782808bedfa188148d7d44e0d53d53bb365cba3d33387a3dbe84bca5d92ccf
+SHA512:
+  metadata.gz: c545e300c3b2d004897be956516f2077d4593a5b68c0a8469269e509430037a5d701d5c7cbe5b930d31ff78ff7dd06631d49670f88c74f2b0bdf499a4b4a1f76
+  data.tar.gz: d63eed0e59cfcb27d32579522a1585b3e6c47e36205810b7973eef8e85d844b94199550290e3f93cf7b30d9df9e9742e02d00f46ca08fe56f374f566e10a18fc

data/.github/workflows/continuous-integration.yml

@@ -0,0 +1,29 @@
+name: continuous-integration
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - main
+jobs:
+  build:
+    # https://github.com/actions/runner-images/blob/main/images/linux/Ubuntu2204-Readme.md
+    runs-on: ubuntu-22.04
+    if: "! contains(github.event.head_commit.message, 'skip ci')"
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          # ruby-version: from .ruby-version
+          bundler-cache: true
+
+      - name: Run RSpec
+        run: |
+          bin/rspec spec --fail-fast --format progress
+        env:
+          RUBYOPT: -W0

data/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    # https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2404-Readme.md
+    runs-on: ubuntu-24.04
+
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Publish the gem to RubyGems
+      - uses: rubygems/release-gem@v1
+          

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 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.3.7

data/GEM_VERSION

@@ -0,0 +1 @@
+1.0.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gatekeeper_api_client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    gatekeeper_api_client (1.0.0)
+      rollbar (~> 3.6)
+      tzinfo (~> 2.0)
+      tzinfo-data (~> 1.2025)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.3.5)
+    diff-lcs (1.6.1)
+    rake (13.2.1)
+    rollbar (3.6.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2025.2)
+      tzinfo (>= 1.0.0)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.6)
+  gatekeeper_api_client!
+  rake (~> 13.2)
+  rspec (~> 3.13)
+
+BUNDLED WITH
+   2.6.7

data/README.md

@@ -0,0 +1,44 @@
+# Gatekeeper API Client
+Common logic for consuming the GateKeeper API.
+
+## Installation
+Add this line to your application's Gemfile:
+```
+source "https://rubygems.pkg.github.com/inforlife" do
+  gem "gatekeeper_api_client", "1.0.0"
+end 
+```
+
+## Usage
+The application using this gem must have defined the following environemnt variables:
+ - `GATEKEEPER_API_KEY`
+ - `GATEKEEPER_TIMEZONE`
+ - `GATEKEEPER_URL`
+
+### Transit
+To post a `transit`, build an object with a record and send the `post` message to it.
+
+```
+Transit.new(record).post
+```
+
+The record must respond to:
+- `authorized`
+- `badge_number`
+- `date`
+- `sensor_code`
+- `time`
+- `valid?`
+
+### Employee
+To post an `employee`, build an object with a record and send the `post` message to it.
+
+```
+Employee.new(record).post
+```
+
+The record must respond to:
+- `employee_name`
+- `badge_number`
+- `department_name`
+- `valid?`

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/gatekeeper_api_client.gemspec

@@ -0,0 +1,30 @@
+version = File.read(File.expand_path("GEM_VERSION", __dir__)).strip
+
+Gem::Specification.new do |s|
+  s.name        = "gatekeeper_api_client"
+  s.version     = version
+  s.summary     = "The GateKeeper API Client."
+  s.description = "The common logic for consuming the GateKeeper API."
+
+  s.required_ruby_version = ">= 3.3.7"
+
+  s.license = "MIT"
+
+  s.author   = "Sigfrid Dusci"
+  s.email    = "sig@inforlife.ch"
+  s.homepage = "https://github.com/inforlife/gatekeeper-api-client"
+
+  # 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.
+  s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+
+  s.add_runtime_dependency "tzinfo",       "~> 2.0"
+  s.add_runtime_dependency "tzinfo-data",  "~> 1.2025"
+  s.add_runtime_dependency "rollbar",      "~> 3.6"
+
+  s.add_development_dependency "bundler",     "~> 2.6"
+  s.add_development_dependency "rake",        "~> 13.2"
+  s.add_development_dependency "rspec",       "~> 3.13"
+end

data/lib/gatekeeper_api_client/client_error.rb

@@ -0,0 +1,2 @@
+class ClientError < StandardError
+end

data/lib/gatekeeper_api_client/error_handler.rb

@@ -0,0 +1,5 @@
+class ErrorHandler
+  def self.call(error)
+    Rollbar.error(error)
+  end
+end

data/lib/gatekeeper_api_client/gateway.rb

@@ -0,0 +1,23 @@
+class Gateway
+  ENDPOINTS = { Transit: "transits",
+                Employee: "employees" }.freeze
+
+  def initialize(object)
+    @object = object
+  end
+
+  def post
+    uri = URI.parse("#{ENV["GATEKEEPER_URL"]}/api/#{ENDPOINTS[@object.class.name.to_sym]}")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+
+    request = Net::HTTP::Post.new(uri.request_uri)
+    request.content_type = "application/json"
+    request["Authorization"] = "Bearer #{ENV["GATEKEEPER_API_KEY"]}"
+    request.body = JSON.generate(@object.to_json)
+
+    response = http.request(request)
+
+    raise ClientError, response.body if Integer(response.code) != 201    
+  end
+end

data/lib/gatekeeper_api_client/resources/employee.rb

@@ -0,0 +1,17 @@
+class Employee < Resource
+  def initialize(record, on_error: ErrorHandler)
+    super(record, on_error: on_error)
+  end
+
+  def to_json
+    {"employee":
+      {
+        "name": @record.employee_name,
+        "badge_number": @record.badge_number,
+        "department_name": @record.department_name
+      }
+    }
+  end
+end
+
+

data/lib/gatekeeper_api_client/resources/resource.rb

@@ -0,0 +1,14 @@
+class Resource
+  def initialize(record, on_error: ErrorHandler)
+    @record = record
+    @error_handler = on_error
+  end
+
+  def post
+    if @record.valid?
+      RetryingGateway.new(Gateway.new(self)).post
+    else
+      @error_handler.call(@record)
+    end
+  end
+end

data/lib/gatekeeper_api_client/resources/transit.rb

@@ -0,0 +1,18 @@
+class Transit < Resource
+  def initialize(record, on_error: ErrorHandler)
+    super(record, on_error: on_error)
+  end
+
+  def to_json
+    {"transit":
+      {
+        "occurred_at": UtcTime.parse(@record.date, @record.time),
+        "badge_number": @record.badge_number,
+        "sensor_code": @record.sensor_code,
+        "authorized": @record.authorized == "1"
+      }
+    }
+  end
+end
+
+

data/lib/gatekeeper_api_client/retrying_gateway.rb

@@ -0,0 +1,16 @@
+class RetryingGateway < DelegateClass(Gateway)
+  def initialize(inner, on_error: ErrorHandler)
+    super(inner)
+    @error_handler = on_error
+  end
+
+  def post(tries: 3)
+    super()
+  rescue => error
+    if (tries -= 1) > 0
+      retry
+    else
+      @error_handler.call(error)
+    end
+  end
+end

data/lib/gatekeeper_api_client/utc_time.rb

@@ -0,0 +1,12 @@
+class UtcTime
+  def self.parse(record_date, record_time)
+    date = record_date.tr('.', '-')
+    time = record_time.tr('.', ':')
+
+    timezone.local_to_utc(Time.parse([date, time].join(" ")))
+  end
+
+  def self.timezone
+    TZInfo::Timezone.get(ENV["GATEKEEPER_TIMEZONE"])
+  end
+end

data/lib/gatekeeper_api_client.rb

@@ -0,0 +1,17 @@
+require "net/http"
+require "rollbar"
+require "tzinfo"
+require "delegate"
+
+require "gatekeeper_api_client/client_error"
+require "gatekeeper_api_client/error_handler"
+require "gatekeeper_api_client/gateway"
+require "gatekeeper_api_client/retrying_gateway"
+require "gatekeeper_api_client/utc_time"
+
+require "gatekeeper_api_client/resources/resource"
+require "gatekeeper_api_client/resources/employee"
+require "gatekeeper_api_client/resources/transit"
+
+module GateKeerApiClient
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: gatekeeper_api_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sigfrid Dusci
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2025'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2025'
+- !ruby/object:Gem::Dependency
+  name: rollbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: The common logic for consuming the GateKeeper API.
+email: sig@inforlife.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/continuous-integration.yml"
+- ".github/workflows/publish.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- GEM_VERSION
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/rspec
+- gatekeeper_api_client.gemspec
+- lib/gatekeeper_api_client.rb
+- lib/gatekeeper_api_client/client_error.rb
+- lib/gatekeeper_api_client/error_handler.rb
+- lib/gatekeeper_api_client/gateway.rb
+- lib/gatekeeper_api_client/resources/employee.rb
+- lib/gatekeeper_api_client/resources/resource.rb
+- lib/gatekeeper_api_client/resources/transit.rb
+- lib/gatekeeper_api_client/retrying_gateway.rb
+- lib/gatekeeper_api_client/utc_time.rb
+homepage: https://github.com/inforlife/gatekeeper-api-client
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: The GateKeeper API Client.
+test_files: []