gatekeeper_api_client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bbeca19cfee61257aa8fa4dea9cc09e371da8240c97821723ccda148e552ddc
-  data.tar.gz: d9782808bedfa188148d7d44e0d53d53bb365cba3d33387a3dbe84bca5d92ccf
+  metadata.gz: 1d9b20bd2b992c579069eb699d9d7c40a83799c9739e912e9f43055a78c0e67a
+  data.tar.gz: 2ddf2106753c80d179f485272410975df40b902b6cd2bf75a78a47f2c9c9fb0c
 SHA512:
-  metadata.gz: c545e300c3b2d004897be956516f2077d4593a5b68c0a8469269e509430037a5d701d5c7cbe5b930d31ff78ff7dd06631d49670f88c74f2b0bdf499a4b4a1f76
-  data.tar.gz: d63eed0e59cfcb27d32579522a1585b3e6c47e36205810b7973eef8e85d844b94199550290e3f93cf7b30d9df9e9742e02d00f46ca08fe56f374f566e10a18fc
+  metadata.gz: 2816c70a73798ce585ce70de29f7ad31f069f8a6eaccbef60a1183d0eff2693834a9e3aa085efeee772bbabe21c85d4a2d6a240194292c65428e104f653b1167
+  data.tar.gz: 909b70b4b0ba0551ca8c39aae6e941ab8b3ba5405e392ba56876772d8b1b7deda780ecd189dde1d2505c17d0fc15125adc338c68ca0772a85dde7775cb8f96b2

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

@@ -11,7 +11,6 @@ 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

data/.gitignore

@@ -8,4 +8,7 @@
 /tmp/
 
 # rspec failure tracking
-.rspec_status
+.rspec_status
+
+# Gem files
+*.gem

data/GEM_VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gatekeeper_api_client (1.0.0)
+    gatekeeper_api_client (1.1.0)
       rollbar (~> 3.6)
       tzinfo (~> 2.0)
       tzinfo-data (~> 1.2025)

data/README.md

@@ -3,17 +3,13 @@ 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 
+```gem "gatekeeper_api_client", "1.1.0"
 ```
 
 ## Usage
-The application using this gem must have defined the following environemnt variables:
- - `GATEKEEPER_API_KEY`
- - `GATEKEEPER_TIMEZONE`
- - `GATEKEEPER_URL`
+The application using this gem must have defined the following environment variables:
+ - `GATEKEEPER_API_KEY`: The authentication key.
+ - `GATEKEEPER_URL`: The URL to post data.
 
 ### Transit
 To post a `transit`, build an object with a record and send the `post` message to it.
@@ -23,12 +19,11 @@ Transit.new(record).post
 ```
 
 The record must respond to:
-- `authorized`
-- `badge_number`
-- `date`
-- `sensor_code`
-- `time`
-- `valid?`
+- `authorized` returns a string.
+- `badge_number` returns a string.
+- `sensor_code` returns a string.
+- `time` returns a Time (with Timezone) object.
+- `valid?` returns a boolean,
 
 ### Employee
 To post an `employee`, build an object with a record and send the `post` message to it.
@@ -38,7 +33,7 @@ Employee.new(record).post
 ```
 
 The record must respond to:
-- `employee_name`
-- `badge_number`
-- `department_name`
-- `valid?`
+- `employee_name` returns a string.
+- `badge_number` returns a string.
+- `department_name` returns a string.
+- `valid?` returns a boolean.

data/lib/gatekeeper_api_client/client_error.rb

@@ -1,2 +1,5 @@
 class ClientError < StandardError
+  def initialize(code, body)
+    super([Net::HTTPResponse::CODE_TO_OBJ[code], body].join(" | "))
+  end
 end

data/lib/gatekeeper_api_client/gateway.rb

@@ -18,6 +18,6 @@ class Gateway
 
     response = http.request(request)
 
-    raise ClientError, response.body if Integer(response.code) != 201    
+    raise ClientError.new(response.code, response.body) if Integer(response.code) != 201   
   end
 end

data/lib/gatekeeper_api_client/resources/transit.rb

@@ -6,7 +6,7 @@ class Transit < Resource
   def to_json
     {"transit":
       {
-        "occurred_at": UtcTime.parse(@record.date, @record.time),
+        "occurred_at": @record.time.utc,
         "badge_number": @record.badge_number,
         "sensor_code": @record.sensor_code,
         "authorized": @record.authorized == "1"

data/lib/gatekeeper_api_client/retrying_gateway.rb

@@ -11,6 +11,7 @@ class RetryingGateway < DelegateClass(Gateway)
       retry
     else
       @error_handler.call(error)
+      raise
     end
   end
 end

data/lib/gatekeeper_api_client.rb

@@ -7,7 +7,6 @@ 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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gatekeeper_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sigfrid Dusci
@@ -119,7 +119,6 @@ files:
 - 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

data/lib/gatekeeper_api_client/utc_time.rb

@@ -1,12 +0,0 @@
-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