my_tank_info 1.0.0

data/lib/my_tank_info/object.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class Object
+    def initialize(attributes)
+      @attributes = OpenStruct.new(attributes)
+    end
+
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+      attribute.is_a?(Hash) ? Object.new(attribute) : attribute
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      true
+    end
+  end
+end

data/lib/my_tank_info/objects/alarm.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class Alarm < Object
+  end
+end

data/lib/my_tank_info/objects/alarm_note.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class AlarmNote < Object
+  end
+end

data/lib/my_tank_info/objects/csld_result.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class CsldResult < Object
+  end
+end

data/lib/my_tank_info/objects/environmental_sitegroup.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class EnvironmentalSitegroup < Object
+    def sites
+      @attributes.sites.map { |site| Site.new(site) }
+    end
+  end
+end

data/lib/my_tank_info/objects/inventory_sitegroup.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class InventorySitegroup < Object
+    def sites
+      @attributes.sites.map { |site| Site.new(site) }
+    end
+  end
+end

data/lib/my_tank_info/objects/line_leak_result.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class LineLeakResult < Object
+  end
+end

data/lib/my_tank_info/objects/notification_code.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class NotificationCode < Object
+  end
+end

data/lib/my_tank_info/objects/notification_contact.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class NotificationContact < Object
+  end
+end

data/lib/my_tank_info/objects/notification_rule.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class NotificationRule < Object
+    def contacts
+      @attributes.contacts.map { |contact| NotificationContact.new(contact) }
+    end
+  end
+end

data/lib/my_tank_info/objects/notification_rule_contact.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class NotificationRuleContact < Object
+  end
+end

data/lib/my_tank_info/objects/notification_site.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class NotificationSite < Object
+  end
+end

data/lib/my_tank_info/objects/sensor_status_result.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class SensorStatusResult < Object
+  end
+end

data/lib/my_tank_info/objects/site.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class Site < Object
+  end
+end

data/lib/my_tank_info/objects/sitegroup_inventory_dashboard.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class SitegroupInventoryDashboard < Object
+    def sites
+      @attributes.sites.map { |site| Site.new(site) }
+    end
+  end
+end

data/lib/my_tank_info/objects/tank.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class Tank < Object
+  end
+end

data/lib/my_tank_info/objects/tank_daily_usage_record.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankDailyUsageRecord < Object
+  end
+end

data/lib/my_tank_info/objects/tank_delivery_record.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankDeliveryRecord < Object
+  end
+end

data/lib/my_tank_info/objects/tank_inventory_record.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankInventoryRecord < Object
+  end
+end

data/lib/my_tank_info/objects/tank_leak_result.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankLeakResult < Object
+  end
+end

data/lib/my_tank_info/objects/tank_reconciliation_record.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankReconciliationRecord < Object
+    def name
+      [tank_number, product_name].join(" - ")
+    end
+
+    def tank_number
+      tank_numbers.join(", ")
+    end
+
+    def started_at
+      DateTime.parse(start_date_time)
+    end
+
+    def is_missing?
+      is_missing
+    end
+
+    def book_inventory
+      (start_volume + deliveries_volume) - sales_volume
+    end
+
+    # Used for Weekly reconciliation
+    def removed_from_ust
+      (start_volume + deliveries_volume) - end_volume
+    end
+  end
+end

data/lib/my_tank_info/objects/tank_rule.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankRule < Object
+  end
+end

data/lib/my_tank_info/objects/tank_runout_record.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankRunoutRecord < Object
+  end
+end

data/lib/my_tank_info/resource.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, default_headers.merge(headers))
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, default_headers.merge(headers))
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, default_headers.merge(headers))
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, default_headers.merge(headers))
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, default_headers.merge(headers))
+    end
+
+    private
+
+    def enforce_required_attributes(required_attrs:, attrs:)
+      attr_keys = attrs.keys
+      required_attrs_present = required_attrs.all? { |req_attr| attr_keys.include?(req_attr) }
+
+      unless required_attrs_present
+        missing_attrs = required_attrs - attr_keys
+        error_message = "You must provide values for all required attributes: #{missing_attrs.join(", ")}"
+        raise MissingRequiredAttributeError, error_message
+      end
+    end
+
+    def default_headers
+      {Authorization: "Bearer #{client.api_key}"}
+    end
+
+    def handle_response(response)
+      message = response.body
+
+      case response.status
+      when 400
+        raise Error, "Your request was malformed - #{message}"
+      when 401
+        raise Error, "You did not supply valid authentication credentials - #{message}"
+      when 403
+        raise RequestForbiddenError, "You are not allowed to perform that action - #{message}"
+      when 404
+        raise Error, "This resource could not be found"
+      when 429
+        raise Error, "Your request exceeded the API rate limit - #{message}"
+      when 500
+        raise InternalServerError, "We were unable to perform the request due to server-side problems - #{message}"
+      end
+
+      response
+    end
+  end
+
+  class MissingRequiredAttributeError < Error; end
+
+  class RequestForbiddenError < Error; end
+
+  class InternalServerError < Error; end
+end

data/lib/my_tank_info/resources/active_alarms.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class ActiveAlarmsResource < Resource
+    def list(site_id: nil, **params)
+      response = get_request("api/alarms", params: params)
+
+      if site_id.nil?
+        Collection.from_response(response, type: Alarm)
+      else
+        Collection.from_response(
+          response,
+          type: Alarm,
+          filter_attribute: :site_id,
+          filter_value: site_id
+        )
+      end
+    end
+
+    def list_notes(alarm_id:)
+      response = get_request("api/alarms/#{alarm_id}/notes")
+      Collection.from_response(response, type: AlarmNote)
+    end
+
+    def retrieve(alarm_id:)
+      Alarm.new get_request("api/alarms/#{alarm_id}").body
+    end
+  end
+end

data/lib/my_tank_info/resources/alarm_history.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class AlarmHistoryResource < Resource
+    def list(site_id: nil, **params)
+      response =
+        if site_id.nil?
+          get_request("api/alarmhistory", params: params)
+        else
+          get_request("api/sites/#{site_id}/alarmhistory", params: params)
+        end
+
+      Collection.from_response(response, type: Alarm)
+    end
+
+    def list_notes(alarm_id:)
+      response = get_request("api/alarmhistory/#{alarm_id}/notes")
+      Collection.from_response(response, type: AlarmNote)
+    end
+
+    def retrieve(alarm_id:)
+      Alarm.new get_request("api/alarmhistory/#{alarm_id}").body
+    end
+  end
+end

data/lib/my_tank_info/resources/alarm_notes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class AlarmNotesResource < Resource
+    def create(alarm_id:, **attributes)
+      AlarmNote.new post_request("api/alarmhistory/#{alarm_id}/notes", body: attributes).body
+    end
+
+    def delete(alarm_id:, note_id:)
+      delete_request("api/alarmhistory/#{alarm_id}/notes/#{note_id}")
+    end
+  end
+end

data/lib/my_tank_info/resources/csld_results.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class CsldResultsResource < Resource
+    def list(site_id:, **params)
+      response = get_request("api/environmental/sites/#{site_id}/csldstatuses", params: params)
+      Collection.from_response(response, type: CsldResult)
+    end
+  end
+end

data/lib/my_tank_info/resources/environmental_sitegroups.rb

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

data/lib/my_tank_info/resources/inventory_sitegroups.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class InventorySitegroupsResource < Resource
+    def list(environmental: true)
+      Collection.from_response(get_request("api/sitegroups"), type: InventorySitegroup)
+    end
+  end
+end

data/lib/my_tank_info/resources/line_leak_results.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class LineLeakResultsResource < Resource
+    def list(site_id:, **params)
+      response = get_request("api/environmental/sites/#{site_id}/lineleaks", params: params)
+      Collection.from_response(response, type: LineLeakResult)
+    end
+  end
+end

data/lib/my_tank_info/resources/notification_contacts.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class NotificationContactsResource < Resource
+    def list
+      response = get_request("api/admin/notificationcontacts")
+      Collection.from_response(response, type: NotificationContact)
+    end
+
+    def list_sites(contact_id:)
+      response = get_request("api/admin/notificationcontacts/#{contact_id}/sites")
+      Collection.from_response(response, type: NotificationSite)
+    end
+
+    def retrieve(contact_id:)
+      NotificationContact.new get_request("api/admin/notificationcontacts/#{contact_id}").body
+    end
+
+    def update(contact_id:, **attributes)
+      request = put_request("api/admin/notificationcontacts/#{contact_id}", body: attributes)
+      NotificationContact.new request.body
+    end
+
+    def create(**attributes)
+      NotificationContact.new post_request("api/admin/notificationcontacts", body: attributes).body
+    end
+
+    def delete(contact_id:)
+      NotificationContact.new delete_request("api/admin/notificationcontacts/#{contact_id}").body
+    end
+  end
+end

data/lib/my_tank_info/resources/notification_rules.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class NotificationRulesResource < Resource
+    def list_codes
+      response = get_request("api/admin/notificationrules/codes")
+      Collection.from_response(response, type: NotificationCode)
+    end
+
+    def list_contacts(rule_id:)
+      response = get_request("api/admin/notificationrules/#{rule_id}/contacts")
+      Collection.from_response(response, type: NotificationRuleContact)
+    end
+
+    def list(code_id:)
+      response = get_request("api/admin/notificationrules?codeId=#{code_id}")
+      Collection.from_response(response, type: NotificationRule)
+    end
+
+    def update(rule_id:, **attributes)
+      put_request("api/admin/notificationrules/#{rule_id}", body: attributes)
+    end
+
+    def delete(rule_id:)
+      delete_request("api/admin/notificationrules/#{rule_id}")
+    end
+  end
+end

data/lib/my_tank_info/resources/sensor_status_results.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class SensorStatusResultsResource < Resource
+    def list(site_id:, **params)
+      response = get_request("api/environmental/sites/#{site_id}/sensorstatuses", params: params)
+      Collection.from_response(response, type: SensorStatusResult)
+    end
+  end
+end

data/lib/my_tank_info/resources/sitegroup_inventory_dashboards.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class SitegroupInventoryDashboardsResource < Resource
+    def list(sitegroup_id:)
+      Collection.from_response(
+        get_request("api/sitegroups/#{sitegroup_id}/inventory/dashboard"),
+        type: SitegroupInventoryDashboard
+      )
+    end
+  end
+end

data/lib/my_tank_info/resources/tank_daily_usage.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankDailyUsageResource < Resource
+    def list(tank_id:)
+      response = get_request("api/tanks/#{tank_id}/dailyusage")
+      Collection.from_response(response, type: TankDailyUsageRecord)
+    end
+  end
+end

data/lib/my_tank_info/resources/tank_deliveries.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankDeliveriesResource < Resource
+    def list(tank_id:, **params)
+      response = get_request("api/tanks/#{tank_id}/deliveries", params: params)
+      Collection.from_response(response, type: TankDeliveryRecord)
+    end
+
+    def update(tank_id:, delivery_id:, **attributes)
+      required_attributes = [
+        :start_date_and_time,
+        :start_gross,
+        :stop_date_and_time,
+        :stop_gross,
+        :delivery_net,
+        :delivery_gross,
+        :bol_number
+      ]
+
+      enforce_required_attributes(required_attrs: required_attributes, attrs: attributes)
+
+      request = put_request("api/tanks/#{tank_id}/deliveries/#{delivery_id}", body: attributes)
+      TankDeliveryRecord.new request.body
+    end
+  end
+end

data/lib/my_tank_info/resources/tank_inventory.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankInventoryResource < Resource
+    def list(tank_id:, **params)
+      response = get_request("api/tanks/#{tank_id}/inventory", params: params)
+      Collection.from_response(response, type: TankInventoryRecord)
+    end
+  end
+end

data/lib/my_tank_info/resources/tank_leak_results.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankLeakResultsResource < Resource
+    def list(site_id:, **params)
+      response = get_request("api/environmental/sites/#{site_id}/tankleaks", params: params)
+      Collection.from_response(response, type: TankLeakResult)
+    end
+  end
+end

data/lib/my_tank_info/resources/tank_reconciliation_records.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankReconciliationRecordsResource < Resource
+    def list(site_id:, reconciliation_period:, **params)
+      response = get_request("api/recon/sites/#{site_id}", params: params)
+      TankReconciliationRecordCollection.from_response(
+        response,
+        reconciliation_period: reconciliation_period
+      )
+    end
+
+    def retrieve(site_id:, reconciliation_period:, started_at:)
+      date =
+        if started_at.instance_of?(DateTime) ||
+            started_at.instance_of?(Date) ||
+            started_at.instance_of?(Time)
+          started_at.strftime(MYTI_DATE_TIME_FORMAT)
+        else
+          started_at
+        end
+
+      response = get_request("api/recon/sites/#{site_id}/#{date}")
+      TankReconciliationRecordCollection.from_response(
+        response,
+        reconciliation_period: reconciliation_period
+      )
+    end
+
+    def update(site_id:, started_at:, **attributes)
+      put("api/recon/sites/#{site_id}/#{date}", body: attributes)
+    end
+  end
+end

data/lib/my_tank_info/resources/tank_rules.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankRulesResource < Resource
+    def list(tank_id:)
+      response = get_request("/api/tanks/#{tank_id}/rules")
+      Collection.from_response(response, type: TankRule)
+    end
+
+    def update(tank_id:, attributes:)
+      response = put_request("api/tanks/#{tank_id}/rules", body: attributes)
+      Collection.from_response(response, type: TankRule)
+    end
+  end
+end

data/lib/my_tank_info/resources/tank_runout.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankRunoutResource < Resource
+    def list(tank_id:)
+      response = get_request("api/tanks/#{tank_id}/runout")
+      Collection.from_response(response, type: TankRunoutRecord)
+    end
+  end
+end

data/lib/my_tank_info/resources/tanks.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TanksResource < Resource
+    def list(site_id: nil)
+      response = get_request("api/tanks")
+
+      if site_id.nil?
+        Collection.from_response(response, type: Tank)
+      else
+        Collection.from_response(
+          response,
+          type: Tank,
+          filter_attribute: :site_id,
+          filter_value: site_id
+        )
+      end
+    end
+
+    def retrieve(tank_id:)
+      Tank.new get_request("api/tanks/#{tank_id}").body
+    end
+  end
+end