my_tank_info 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cac3de797757a7f6e4848ab35ba9fad75b144db0e7f514591eed1ee7393cd2be
+  data.tar.gz: c77d732d609e34790b253d2ecaf8f0e77efe430dbf56fb19c5cee784f385c444
+SHA512:
+  metadata.gz: 203baf9c369abfb79d74217291cd23c9d6c7abb0a4353a761209c4799c9756abc996e15b44aaccac7d447e8ec826ccf136063989662684b0aecdcc8e18100f11
+  data.tar.gz: e0472c0a4903efa0e3bb2b19e87c8d53561e71aa4b7309c3375eb5660ac1ae553914983baf82721c75c75f78f077c420dbba55c09c24b1f0d11f070b7aaa234c

data/.github/workflows/main.yml

@@ -0,0 +1,17 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.2
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-09-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at me@kylekeesling.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in my_tank_info.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "standard"

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    my_tank_info (0.1.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    faraday (1.7.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    minitest (5.14.4)
+    multipart-post (2.1.1)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.5)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    standard (1.3.0)
+      rubocop (= 1.20.0)
+      rubocop-performance (= 1.11.5)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  my_tank_info!
+  rake (~> 13.0)
+  standard
+
+BUNDLED WITH
+   2.2.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Kyle Keesling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,253 @@
+# MyTankInfo
+
+[![Ruby](https://github.com/kylekeesling/my_tank_info/actions/workflows/main.yml/badge.svg)](https://github.com/kylekeesling/my_tank_info/actions/workflows/main.yml)
+
+A simple Ruby gem for interacting with the [MyTankInfo](http://mytankinfo.com) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'my_tank_info'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install my_tank_info
+
+## Usage
+
+### Creating a Client
+
+```ruby
+client = MyTankInfo::Client.new(api_key: ENV["MYTANKINFO_API_KEY"])
+```
+
+### API Tokens
+You must obtain an API token in order to use this gem. Tokens appear to last for 1 year before the expire.
+
+Once the token is generated it should be stored for use on all subsequent API requests.
+
+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.
+
+This is also the only call you can perform without providing an :api_key to the client
+
+```ruby
+client.generate_api_token(username:, password:)
+```
+### Environmental API
+```ruby
+# Return a list of all sitegroups for the account
+client.environmental_sitegroups
+
+# Active Alarms records be retrived either as a full list, or filtered by :site_id
+# Will return empty if there are no active alarms
+client.active_alarms.list
+client.active_alarms.list(site_id: 123)
+```
+
+In addition to the defined parameters below you may also pass ``:report_start_date`` and ``:report_end_date`` as optional parameters to retrive records for a given timeframe
+
+```ruby
+# Alarm History records be retrived either as a full list, or filtered by :site_id
+client.alarm_history.list
+client.alarm_history.list(site_id: 123)
+
+# View Tank Leak Test Results for a site
+# Will return empty if the site does not have line tank leak detection configured
+client.tank_leak_results.list(site_id: 123)
+
+# View Line Leak Test Results for a site
+# Will return empty if the site does not have line leak detection configured
+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
+# often referred to as CSLD or (Continuous Statistical Leak Detection)
+client.csld_results.list(site_id: 123)
+
+# View Sensor Status Results for a site
+# Will return empty if the site does not have any sensors
+client.sensor_status_results.list(site_id: 123)
+```
+
+### Reconciliation API
+You may also pass ``:report_start_date`` and ``:report_end_date`` as optional parameters to retrive records for a given timeframe
+
+```ruby
+# reconciliation_period must be one of the following - :weekly, :ten_day, :monthly
+client.tank_reconciliation_records.list(site_id: 123, reconciliation_period: :monthly)
+```
+
+This call returns a special collection object called `TankReconciliationRecordCollection` that gives you a number
+of convienience methods for accessing the data in a easily usable way:
+
+```ruby
+collection = client.tank_reconciliation_records.list(site_id: 123, reconciliation_period: :monthly)
+
+collection.started_at
+collection.ended_at
+
+# returns a collection of TankReconciliationRecords
+collection.data
+
+# this returns a collection of Tank objects
+tanks = collection.tanks
+tank = tanks.fist
+
+tank.name # 1 - Unleaded
+tank.product_name # Unleaded
+tank.tank_number # 1
+tank.capacity # 5000
+
+# collection of TankReconciliationRecords belonging only to this tank
+tank.reconciliation_records
+
+# returns TankReconciliationRecordSummary object which provides
+# a number of calculations based upon the provided reconciliation_period
+tank.reconciliation_summary
+
+# evaluates associated reconciliation_records based upon the
+# provided reconciliation_period to decide if tank has passed
+tank.passed?
+
+# evaluates associated reconciliation_records based upon the
+# provided reconciliation_period to decide if tank has failed
+tank.failed?
+```
+
+
+### Inventory API
+```ruby
+# Will return a list of all sitegroups for the account, along with a host of additional data relating
+# to corresponding sites and their current inventory and alarm status
+client.inventory_sitegroups.list
+
+# Tanks can be retrived either as a full list, or filtered by :site_id
+client.tanks.list
+client.tanks.list(site_id: 123)
+
+# Will return a list all sites belonging to a sitegroup, along with a host of additional data relating
+# each site's current inventory and alarm status
+client.sitegroup_inventory_dashboards.list(sitegroup_id: 1)
+
+# Returns daily inventory usage over the previous 4 weeks for a given tank
+client.tank_daily_usage.list(tank_id: 1)
+
+# Returns deliveries made to the given tank over a time period.
+# Supports :report_start_date and :report_end_date parameters
+client.tank_deliveries.list(tank_id: 1)
+
+
+## To update a tank delivery, the folowing params are required in the update request
+params = {
+  start_date_and_time: "2021-08-10T11:48:00.0000000-04:00",
+  start_gross: 500,
+  stop_date_and_time: "2021-08-10T12:48:00.0000000-04:00",
+  stop_gross: 600,
+  delivery_net: 100,
+  delivery_gross: 105,
+  bol_number: "123"
+}
+
+client.tank_deliveries.update(tank_id: 1, delivery_id: 1, **params)
+
+# Returns inventory readings for the given tank over a time period.
+# Supports :report_start_date and :report_end_date parameters
+client.tank_inventory.list(tank_id: 1)
+
+# Returns recent inventory records for a tank (similiar to client.tank_deliveries.list)
+# with an extra record indicating the estimated runout.
+
+# The period of time over which the records are queried varies depending on how far out in the
+# future the estimated runout is. But the results will contain inventory records from at least
+# the last two days and at most the last 28 days.
+
+client.tank_runout.list(tank_id: 1)
+```
+
+### Admin API
+
+#### Notification Contacts
+```ruby
+client.notification_contacts.list
+
+# A list of all sites that the contact is setup to recieve notifications about
+# Note: will be empty if contact is setup to recieve updates for all sites (default_contact_settings: 1)
+client.notification_contacts.list_sites(contact_id: 1)
+
+client.notification_contacts.retrieve(contact_id: 1)
+
+
+# Updating and creating a NotificationContact record requires the following params
+params = {
+  first_name: "Kyle",
+  last_name: "Keesling",
+  email: "kyle@example.com",
+  sms_phone: "555-555-5555",
+  contact_method: 3, # 1 (SMS), 2 (Email), 3 (SMS & Email)
+  is_active: true,
+  default_contact_settings: 1 # 0 (None/No Sites), 1 (All Sites), 2 (Only Selected Sites)
+}
+
+client.notification_contacts.update(contact_id: 1, **params)
+
+client.notification_contacts.create(**params)
+
+client.notification_contacts.delete(contact_id: 1)
+```
+
+#### Notification Rules
+```ruby
+# Provides a list of all alarm/warning codes that rules can be defined for
+client.notification_rules.list_codes
+
+# List all contacts associated with a rule
+client.notification_rules.list_contacts(rule_id: 1)
+
+# List all rules that have been defined for a given code
+client.notification_rules.list(code_id: 1)
+
+# Updating a rule requires that you pass along an array of the
+# contacts who the rule should apply to as well as the prefereed
+# contact method. isSuppressed will silence the rule without
+# actually deleting it
+params = {
+  contacts: [
+    {
+      contactId: 3110,
+      contactMethod: 3 # 1 (SMS), 2 (Email), 3 (SMS & Email)
+    }
+  ],
+  isSuppressed: false
+}
+
+client.notification_rules.update(rule_id: 1, **params)
+
+client.notification_rules.delete(rule_id: 1)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kylekeesling/my_tank_info. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kylekeesling/my_tank_info/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MyTankInfo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kylekeesling/my_tank_info/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: %i[test]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "my_tank_info"
+
+client = MyTankInfo::Client.new(api_key: ENV["MYTANKINFO_API_KEY"])
+
+puts
+puts "We've created a 'client' variable as a MyTankInfo::Client using ENV['MYTANKINFO_API_KEY'] as the API key."
+puts
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/my_tank_info/client.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+module MyTankInfo
+  class Client
+    BASE_URL = "https://app.mytankinfo.com"
+    attr_reader :api_key
+
+    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+      @stubs = stubs
+    end
+
+    def environmental_sitegroups
+      EnvironmentalSitegroupsResource.new(self)
+    end
+
+    def active_alarms
+      ActiveAlarmsResource.new(self)
+    end
+
+    def alarm_history
+      AlarmHistoryResource.new(self)
+    end
+
+    def alarm_notes
+      AlarmNotesResource.new(self)
+    end
+
+    def tank_leak_results
+      TankLeakResultsResource.new(self)
+    end
+
+    def line_leak_results
+      LineLeakResultsResource.new(self)
+    end
+
+    def csld_results
+      CsldResultsResource.new(self)
+    end
+
+    def sensor_status_results
+      SensorStatusResultsResource.new(self)
+    end
+
+    def inventory_sitegroups
+      InventorySitegroupsResource.new(self)
+    end
+
+    def tanks
+      TanksResource.new(self)
+    end
+
+    def sitegroup_inventory_dashboards
+      SitegroupInventoryDashboardsResource.new(self)
+    end
+
+    def tank_daily_usage
+      TankDailyUsageResource.new(self)
+    end
+
+    def tank_deliveries
+      TankDeliveriesResource.new(self)
+    end
+
+    def tank_inventory
+      TankInventoryResource.new(self)
+    end
+
+    def tank_runout
+      TankRunoutResource.new(self)
+    end
+
+    def tank_rules
+      TankRulesResource.new(self)
+    end
+
+    def tank_reconciliation_records
+      TankReconciliationRecordsResource.new(self)
+    end
+
+    def notification_contacts
+      NotificationContactsResource.new(self)
+    end
+
+    def notification_rules
+      NotificationRulesResource.new(self)
+    end
+
+    def generate_api_token(username:, password:)
+      TokensResource.new(self).generate(username: username, password: password)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+        conn.adapter @adapter, @stubs
+      end
+    end
+  end
+end

data/lib/my_tank_info/collection.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module MyTankInfo
+  class Collection
+    attr_reader :data, :size
+
+    def self.from_response(response, type:, filter_attribute: nil, filter_value: nil)
+      body =
+        if response.body.instance_of?(Hash)
+          [response.body]
+        else
+          response.body
+        end
+
+      @collection = new(
+        data: body.map { |attrs| type.new(attrs) },
+        filter_attribute: filter_attribute,
+        filter_value: filter_value
+      )
+    end
+
+    def initialize(data:, filter_attribute: nil, filter_value: nil)
+      @data =
+        if filter_attribute && filter_value
+          data.select { |item| item.send(filter_attribute) == filter_value }
+        else
+          data
+        end
+
+      @size = @data.size
+    end
+  end
+end

data/lib/my_tank_info/error.rb

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

data/lib/my_tank_info/errors/missing_required_attribute_error.rb

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