my_tank_info 1.0.0

data/lib/my_tank_info/resources/tokens.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TokensResource < Resource
+    def generate(**attributes)
+      response = post_request("api/token", body: attributes)
+      response.body.delete('"')
+    end
+  end
+end

data/lib/my_tank_info/tank_reconciliation_record_collection.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankReconciliationRecordCollection
+    attr_reader :data, :size, :site_id, :reconciliation_period, :started_at, :ended_at
+
+    def self.from_response(response, reconciliation_period:)
+      body = response.body
+
+      @collection = new(
+        data: body.map { |attrs| TankReconciliationRecord.new(attrs) },
+        reconciliation_period: reconciliation_period
+      )
+    end
+
+    def initialize(data:, reconciliation_period:)
+      @data = data
+      @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
+    end
+
+    def tanks
+      @data.map { |record|
+        records = @data.select { _1.tank_number == record.tank_number }.sort_by(&:started_at)
+        summary =
+          TankReconciliationRecordSummary.new(
+            records,
+            capacity: record.total_tanks_capacity,
+            reconciliation_period: @reconciliation_period
+          )
+
+        Tank.new(
+          name: record.name,
+          product_name: record.product_name,
+          tank_number: record.tank_number,
+          tank_numbers: record.tank_numbers,
+          capacity: record.total_tanks_capacity,
+          reconciliation_records: records,
+          reconciliation_summary: summary,
+          passed?: summary.passed?,
+          failed?: summary.failed?
+        )
+      }.uniq { |tank| tank.name }
+        .sort_by(&:tank_number)
+    end
+  end
+end

data/lib/my_tank_info/tank_reconciliation_record_summary.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class TankReconciliationRecordSummary
+    attr_reader :records
+
+    MONTHLY_FUDGE_NUMBER = 130
+    TEN_DAY_MULTIPLIER = 0.0075
+    SEVEN_DAY_MULTIPLIER = 0.005
+
+    def initialize(records, capacity:, reconciliation_period:)
+      @records = records
+      @capacity = capacity
+      @reconciliation_period = reconciliation_period
+    end
+
+    def total_deliveries_volume
+      @records.sum(&:deliveries_volume).round(0)
+    end
+
+    def total_sales_volume
+      @records.sum(&:sales_volume).round(0)
+    end
+
+    def total_over_short
+      @records.sum(&:difference_volume).round(0)
+    end
+
+    def absolute_difference_volume
+      total_over_short.abs
+    end
+
+    # Monthly Reconciliation Specific Logic
+    def total_gallons_pumped
+      total_sales_volume
+    end
+
+    def leak_check_number
+      # DROP THE LAST 2 DIGITS FROM THE PUMPED NUMBER AND ENTER ON THE LEAK CHECK
+      (total_gallons_pumped.to_f / 100).round(0).to_i
+    end
+
+    def leak_check_result
+      leak_check_number + MONTHLY_FUDGE_NUMBER
+    end
+
+    def leak_check_result_unacceptable?
+      absolute_difference_volume > leak_check_result
+    end
+
+    # 10 Day Reconciliation Specific Logic
+    def allowance_multiplier
+      [@capacity, total_deliveries_volume, total_sales_volume].max
+    end
+
+    def allowable_tolerance
+      (allowance_multiplier.to_f * TEN_DAY_MULTIPLIER).round(0).to_i
+    end
+
+    def variance_is_gt_allowable_tolerance?
+      absolute_difference_volume > allowable_tolerance
+    end
+
+    # Weekly / 7 Day Reconciliation Specific Logic
+    def weekly_number_to_check
+      [total_gallons_pumped, @capacity].max
+    end
+
+    def weekly_check_number
+      (weekly_number_to_check.to_f * SEVEN_DAY_MULTIPLIER).round(0).to_i
+    end
+
+    def total_gallons_larger_than_leak_check?
+      absolute_difference_volume > weekly_check_number
+    end
+
+    def allowable_variance
+      case @reconciliation_period
+      when :monthly
+        leak_check_result
+      when :ten_day
+        allowable_tolerance
+      when :weekly
+        weekly_check_number
+      else
+        raise ReconciliationPeriodMissingError.new
+      end
+    end
+
+    def failed?
+      case @reconciliation_period
+      when :monthly
+        leak_check_result_unacceptable?
+      when :ten_day
+        variance_is_gt_allowable_tolerance?
+      when :weekly
+        total_gallons_larger_than_leak_check?
+      else
+        raise ReconciliationPeriodMissingError.new
+      end
+    end
+
+    def passed?
+      !failed?
+    end
+  end
+
+  class ReconciliationPeriodMissingError < Error
+    def initialize
+      super("reconciliation_period must be one of the following values: :monthly, :ten_day, :weekly")
+    end
+  end
+end

data/lib/my_tank_info/version.rb

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

data/lib/my_tank_info.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "my_tank_info/version"
+
+module MyTankInfo
+  MYTI_DATE_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S%:z"
+
+  autoload :Client, "my_tank_info/client"
+  autoload :Object, "my_tank_info/object"
+  autoload :Resource, "my_tank_info/resource"
+  autoload :Collection, "my_tank_info/collection"
+  autoload :Error, "my_tank_info/error"
+  autoload :TankReconciliationRecordCollection, "my_tank_info/tank_reconciliation_record_collection"
+
+  autoload :TankReconciliationRecordSummary, "my_tank_info/tank_reconciliation_record_summary"
+
+  autoload :EnvironmentalSitegroup, "my_tank_info/objects/environmental_sitegroup"
+  autoload :InventorySitegroup, "my_tank_info/objects/inventory_sitegroup"
+  autoload :Site, "my_tank_info/objects/site"
+  autoload :Tank, "my_tank_info/objects/tank"
+  autoload :Alarm, "my_tank_info/objects/alarm"
+  autoload :AlarmNote, "my_tank_info/objects/alarm_note"
+  autoload :TankLeakResult, "my_tank_info/objects/tank_leak_result"
+  autoload :LineLeakResult, "my_tank_info/objects/line_leak_result"
+  autoload :CsldResult, "my_tank_info/objects/csld_result"
+  autoload :SensorStatusResult, "my_tank_info/objects/sensor_status_result"
+
+  autoload :SitegroupInventoryDashboard, "my_tank_info/objects/sitegroup_inventory_dashboard"
+  autoload :TankDailyUsageRecord, "my_tank_info/objects/tank_daily_usage_record"
+  autoload :TankDeliveryRecord, "my_tank_info/objects/tank_delivery_record"
+  autoload :TankInventoryRecord, "my_tank_info/objects/tank_inventory_record"
+  autoload :TankRunoutRecord, "my_tank_info/objects/tank_runout_record"
+  autoload :TankRule, "my_tank_info/objects/tank_rule"
+
+  autoload :TankReconciliationRecord, "my_tank_info/objects/tank_reconciliation_record"
+
+  autoload :NotificationContact, "my_tank_info/objects/notification_contact"
+  autoload :NotificationSite, "my_tank_info/objects/notification_site"
+  autoload :NotificationRule, "my_tank_info/objects/notification_rule"
+  autoload :NotificationCode, "my_tank_info/objects/notification_code"
+  autoload :NotificationRuleContact, "my_tank_info/objects/notification_rule_contact"
+
+  autoload :ActiveAlarmsResource, "my_tank_info/resources/active_alarms"
+  autoload :AlarmHistoryResource, "my_tank_info/resources/alarm_history"
+  autoload :AlarmNotesResource, "my_tank_info/resources/alarm_notes"
+
+  autoload :EnvironmentalSitegroupsResource, "my_tank_info/resources/environmental_sitegroups"
+  autoload :TankLeakResultsResource, "my_tank_info/resources/tank_leak_results"
+  autoload :LineLeakResultsResource, "my_tank_info/resources/line_leak_results"
+  autoload :CsldResultsResource, "my_tank_info/resources/csld_results"
+  autoload :SensorStatusResultsResource, "my_tank_info/resources/sensor_status_results"
+
+  autoload :TankReconciliationRecordsResource, "my_tank_info/resources/tank_reconciliation_records"
+
+  autoload :InventorySitegroupsResource, "my_tank_info/resources/inventory_sitegroups"
+  autoload :SitegroupInventoryDashboardsResource, "my_tank_info/resources/sitegroup_inventory_dashboards"
+  autoload :TanksResource, "my_tank_info/resources/tanks"
+  autoload :TankDailyUsageResource, "my_tank_info/resources/tank_daily_usage"
+  autoload :TankDeliveriesResource, "my_tank_info/resources/tank_deliveries"
+  autoload :TankInventoryResource, "my_tank_info/resources/tank_inventory"
+  autoload :TankRunoutResource, "my_tank_info/resources/tank_runout"
+  autoload :TankRulesResource, "my_tank_info/resources/tank_rules"
+
+  autoload :NotificationContactsResource, "my_tank_info/resources/notification_contacts"
+  autoload :NotificationRulesResource, "my_tank_info/resources/notification_rules"
+
+  autoload :TokensResource, "my_tank_info/resources/tokens"
+end

data/my_tank_info.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/my_tank_info/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "my_tank_info"
+  spec.version = MyTankInfo::VERSION
+  spec.authors = ["Kyle Keesling"]
+  spec.email = ["me@kylekeesling.com"]
+
+  spec.summary = "A ruby gem to communicate with MyTankInfo (mytankinfo.com)"
+  spec.homepage = "https://github.com/kylekeesling/my_tank_info"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kylekeesling/my_tank_info"
+  spec.metadata["changelog_uri"] = "https://github.com/kylekeesling/my_tank_info/CHANGELOG.md"
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: my_tank_info
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kyle Keesling
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description:
+email:
+- me@kylekeesling.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/my_tank_info.rb
+- lib/my_tank_info/client.rb
+- lib/my_tank_info/collection.rb
+- lib/my_tank_info/error.rb
+- lib/my_tank_info/errors/missing_required_attribute_error.rb
+- lib/my_tank_info/object.rb
+- lib/my_tank_info/objects/alarm.rb
+- lib/my_tank_info/objects/alarm_note.rb
+- lib/my_tank_info/objects/csld_result.rb
+- lib/my_tank_info/objects/environmental_sitegroup.rb
+- lib/my_tank_info/objects/inventory_sitegroup.rb
+- lib/my_tank_info/objects/line_leak_result.rb
+- lib/my_tank_info/objects/notification_code.rb
+- lib/my_tank_info/objects/notification_contact.rb
+- lib/my_tank_info/objects/notification_rule.rb
+- lib/my_tank_info/objects/notification_rule_contact.rb
+- lib/my_tank_info/objects/notification_site.rb
+- lib/my_tank_info/objects/sensor_status_result.rb
+- lib/my_tank_info/objects/site.rb
+- lib/my_tank_info/objects/sitegroup_inventory_dashboard.rb
+- lib/my_tank_info/objects/tank.rb
+- lib/my_tank_info/objects/tank_daily_usage_record.rb
+- lib/my_tank_info/objects/tank_delivery_record.rb
+- lib/my_tank_info/objects/tank_inventory_record.rb
+- lib/my_tank_info/objects/tank_leak_result.rb
+- lib/my_tank_info/objects/tank_reconciliation_record.rb
+- lib/my_tank_info/objects/tank_rule.rb
+- lib/my_tank_info/objects/tank_runout_record.rb
+- lib/my_tank_info/resource.rb
+- lib/my_tank_info/resources/active_alarms.rb
+- lib/my_tank_info/resources/alarm_history.rb
+- lib/my_tank_info/resources/alarm_notes.rb
+- lib/my_tank_info/resources/csld_results.rb
+- lib/my_tank_info/resources/environmental_sitegroups.rb
+- lib/my_tank_info/resources/inventory_sitegroups.rb
+- lib/my_tank_info/resources/line_leak_results.rb
+- lib/my_tank_info/resources/notification_contacts.rb
+- lib/my_tank_info/resources/notification_rules.rb
+- lib/my_tank_info/resources/sensor_status_results.rb
+- lib/my_tank_info/resources/sitegroup_inventory_dashboards.rb
+- lib/my_tank_info/resources/tank_daily_usage.rb
+- lib/my_tank_info/resources/tank_deliveries.rb
+- lib/my_tank_info/resources/tank_inventory.rb
+- lib/my_tank_info/resources/tank_leak_results.rb
+- lib/my_tank_info/resources/tank_reconciliation_records.rb
+- lib/my_tank_info/resources/tank_rules.rb
+- lib/my_tank_info/resources/tank_runout.rb
+- lib/my_tank_info/resources/tanks.rb
+- lib/my_tank_info/resources/tokens.rb
+- lib/my_tank_info/tank_reconciliation_record_collection.rb
+- lib/my_tank_info/tank_reconciliation_record_summary.rb
+- lib/my_tank_info/version.rb
+- my_tank_info.gemspec
+homepage: https://github.com/kylekeesling/my_tank_info
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kylekeesling/my_tank_info
+  source_code_uri: https://github.com/kylekeesling/my_tank_info
+  changelog_uri: https://github.com/kylekeesling/my_tank_info/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.25
+signing_key:
+specification_version: 4
+summary: A ruby gem to communicate with MyTankInfo (mytankinfo.com)
+test_files: []