my_tank_info 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cac3de797757a7f6e4848ab35ba9fad75b144db0e7f514591eed1ee7393cd2be
-  data.tar.gz: c77d732d609e34790b253d2ecaf8f0e77efe430dbf56fb19c5cee784f385c444
+  metadata.gz: d3e7c6f697556e4c4a6eaf626521b15ef3d470460e9a38ccb812b9b9713a1aaa
+  data.tar.gz: 896fa52437a96b14fb8d9ad8fed4e5beb1c162a82b633246ed6b342f4409ecc8
 SHA512:
-  metadata.gz: 203baf9c369abfb79d74217291cd23c9d6c7abb0a4353a761209c4799c9756abc996e15b44aaccac7d447e8ec826ccf136063989662684b0aecdcc8e18100f11
-  data.tar.gz: e0472c0a4903efa0e3bb2b19e87c8d53561e71aa4b7309c3375eb5660ac1ae553914983baf82721c75c75f78f077c420dbba55c09c24b1f0d11f070b7aaa234c
+  metadata.gz: 813ed609bb3e702b3462194ad3e85c88239b13e5c6edd4dfcd0ba997668a14e078b8ad5444f43ab96bb61f50c855ff84cbeba84f0a6d7eecf20a1e3fbda3a066
+  data.tar.gz: 231d543fac4faf52a520cf17b42ab0d9488667183ccbabe07da87ad8e40ed83ec9d004f627701f221e0f9131ef8d25897f0bf8be2a501b16f42a0ee157040c37

data/CHANGELOG.md

@@ -1,5 +1,16 @@
-## [Unreleased]
+## [1.1.1] - 2021-10-18
+- Fix bug in NotificationContact delete logic
 
-## [0.1.0] - 2021-09-14
+## [1.1.0] - 2021-09-23
+- Added a specific error class ``MyTankInfo::UnauthorizedError`` so that it's easier to identify and react to scenarios when your api_key is wrong or has expired
 
+## [1.0.2] - 2021-09-21
+- Add convenience methods for accessing UOM on TankReconciliationRecordCollection
+- Fix bug that prevented tank reconciliation records from being updated
+
+## [1.0.1] - 2021-09-20
+- Updates Faraday gem to 1.8.0
+- Fixes Gemfile lock version of the gem
+
+## [1.0.0] - 2021-09-20
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_tank_info (0.1.0)
+    my_tank_info (1.1.0)
       faraday (~> 1.7)
       faraday_middleware (~> 1.1)
 
@@ -9,7 +9,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    faraday (1.7.2)
+    faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)

data/README.md

@@ -36,7 +36,7 @@ Once the token is generated it should be stored for use on all subsequent API re
 Practically speaking you'll need to store the username/password for then account you'd like to access
 so that you can periodically generate a new API token prior to expiration.
 
-Alternatively you can have your code catch _403 Forbidden_ errors and use that as a sign that a new API token is needed.
+Alternatively you can have your code catch ``MyTankInfo::UnauthorizedError`` errors and use that as a sign that a new API token is needed.
 
 This is also the only call you can perform without providing an :api_key to the client
 
@@ -70,7 +70,7 @@ client.tank_leak_results.list(site_id: 123)
 client.line_leak_results.list(site_id: 123)
 
 # View Sensor Status Results for a site
-# Will return empty if the site does not have Continuous iI-tank Leak Detection (CITLD), which is
+# Will return empty if the site does not have Continuous In-Tank Leak Detection (CITLD), which is
 # often referred to as CSLD or (Continuous Statistical Leak Detection)
 client.csld_results.list(site_id: 123)
 
@@ -123,6 +123,27 @@ tank.passed?
 # provided reconciliation_period to decide if tank has failed
 tank.failed?
 ```
+```ruby
+date = "2021-09-11T00:09:00-04:00" # date must match the standard MyTankInfo format (%Y-%m-%dT%H:%M:%S%:z)
+client.tank_reconciliation_records.retrieve(site_id: 1, date: date, reconciliation_period: :monthly)
+
+attrs = [
+  {
+    id: "1368902",
+    product_name: "E-10",
+    start_date_time: "2021-09-16T02:00:00.0000000-05:00",
+    end_date_time: "2021-09-17T02:00:00.0000000-05:00",
+    tank_numbers: "1",
+    start_volume: "7252",
+    end_volume: "7936",
+    deliveries_volume: "2004",
+    sales_volume: "1319",
+    water_height: "0"
+  }
+]
+client.tank_reconciliation_records.update(site_id: 1, date: date, reconciliation_period: :monthly, attributes: attrs)
+```
+
 
 
 ### Inventory API

data/lib/my_tank_info/resource.rb

@@ -52,7 +52,7 @@ module MyTankInfo
       when 400
         raise Error, "Your request was malformed - #{message}"
       when 401
-        raise Error, "You did not supply valid authentication credentials - #{message}"
+        raise UnauthorizedError, "You did not supply valid authentication credentials - #{message}"
       when 403
         raise RequestForbiddenError, "You are not allowed to perform that action - #{message}"
       when 404
@@ -67,6 +67,8 @@ module MyTankInfo
     end
   end
 
+  class UnauthorizedError < Error; end
+
   class MissingRequiredAttributeError < Error; end
 
   class RequestForbiddenError < Error; end

data/lib/my_tank_info/resources/environmental_sitegroups.rb

@@ -2,7 +2,7 @@
 
 module MyTankInfo
   class EnvironmentalSitegroupsResource < Resource
-    def list(environmental: true)
+    def list
       Collection.from_response(get_request("api/environmental/sitegroups"), type: EnvironmentalSitegroup)
     end
   end

data/lib/my_tank_info/resources/notification_contacts.rb

@@ -26,7 +26,7 @@ module MyTankInfo
     end
 
     def delete(contact_id:)
-      NotificationContact.new delete_request("api/admin/notificationcontacts/#{contact_id}").body
+      delete_request("api/admin/notificationcontacts/#{contact_id}")
     end
   end
 end

data/lib/my_tank_info/resources/tank_reconciliation_records.rb

@@ -10,14 +10,14 @@ module MyTankInfo
       )
     end
 
-    def retrieve(site_id:, reconciliation_period:, started_at:)
+    def retrieve(site_id:, date:, reconciliation_period:)
       date =
-        if started_at.instance_of?(DateTime) ||
-            started_at.instance_of?(Date) ||
-            started_at.instance_of?(Time)
-          started_at.strftime(MYTI_DATE_TIME_FORMAT)
+        if date.instance_of?(DateTime) ||
+            date.instance_of?(Date) ||
+            date.instance_of?(Time)
+          date.strftime(MYTI_DATE_TIME_FORMAT)
         else
-          started_at
+          date
         end
 
       response = get_request("api/recon/sites/#{site_id}/#{date}")
@@ -27,8 +27,13 @@ module MyTankInfo
       )
     end
 
-    def update(site_id:, started_at:, **attributes)
-      put("api/recon/sites/#{site_id}/#{date}", body: attributes)
+    def update(site_id:, date:, reconciliation_period:, attributes:)
+      response = put_request("api/recon/sites/#{site_id}/#{date}", body: attributes)
+
+      TankReconciliationRecordCollection.from_response(
+        response,
+        reconciliation_period: reconciliation_period
+      )
     end
   end
 end

data/lib/my_tank_info/tank_reconciliation_record_collection.rb

@@ -2,7 +2,8 @@
 
 module MyTankInfo
   class TankReconciliationRecordCollection
-    attr_reader :data, :size, :site_id, :reconciliation_period, :started_at, :ended_at
+    attr_reader :data, :size, :site_id, :reconciliation_period, :started_at, :ended_at,
+      :volume_uom, :height_uom
 
     def self.from_response(response, reconciliation_period:)
       body = response.body
@@ -18,9 +19,12 @@ module MyTankInfo
       @size = @data.size
       @reconciliation_period = reconciliation_period
 
-      @site_id = @data.first.site_id
-      @started_at = @data.min_by(&:started_at).started_at
-      @ended_at = @data.max_by(&:started_at).started_at
+      @site_id = @data.first&.site_id
+      @started_at = @data.min_by(&:started_at)&.started_at
+      @ended_at = @data.max_by(&:started_at)&.started_at
+
+      @volume_uom = @data.first&.volume_uom
+      @height_uom = @data.first&.height_uom
     end
 
     def tanks

data/lib/my_tank_info/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MyTankInfo
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_tank_info
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Kyle Keesling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday