alula-ruby 1.10.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59c0a310113d936038d7403de4c1dfa5d90bf8fbb960e17c1ef66761bf8aad43
-  data.tar.gz: 597408051879859c200fc483c88982dd7b1cff056d731f5e0e0e6eadb646146b
+  metadata.gz: 7aea00c9f68b3480d7f0f8cd06e749844deaa4463b3d58a1de2d4313d4b8c30d
+  data.tar.gz: 02fff4cc28c21d167ab150878ac237f7817fe7a9c263e74fdf5870689c960563
 SHA512:
-  metadata.gz: 97db75fe5030f83ca1929c37cfb135bd5be82bd156495593f18c06517cd4094bea53c332f30fa9172a282e91c35036490a4c09894bae81563989e60f9af4b4e9
-  data.tar.gz: 0e764d69e7fdf2018a3b074dc3cca6bffc58663a385415eaa1e3b7499c6c40981f8ecb61060383daa8101da738a6da8b443091dc172425ef861efb3d2e28e39e
+  metadata.gz: 347e820ffc7916c366756d7bb1702f59b3c55bc01d39cfc5e0fc8a70d7ecae45bd7d75fe9a5f06cc565ecb239c214ced9e53c0f9919731370e3c0c9f287e8010
+  data.tar.gz: 0e2c99e918c0a4d4efd52b3068725edc355fdac293acf83d9dc707f76ce97792e720ad399f36930c14f14188663b9312ac55a8e360a32417fe8234fc74ac1f79

data/README.md

@@ -440,6 +440,11 @@ Note: You do need to be authorized against our private ECR registry. This is man
 
 Occasionally under heavy use the dockerized API may lose or drop its databases, resulting in the test suite erroring completly and very quickly. To fix this simply restart the API with `docker-compose -f alula-docker-compose.yml down && docker-compose -f alula-docker-compose.yml up -d`
 
+### Adding a new device
+
+Optional: When a new device is added, methods for it can be exposed inside lib/alula/helpers/device_helpers/program_id_helper.rb. The device ID can be added to existing consts or new methods can be
+created for the specific device. 
+
 ## Importing GEM in AC Docker
 
 Most of the times, the work we do in alula ruby includes just updating the model/procedures and push the changes, without having to worry about the configuration mentioned above. When we make changes to alula ruby locally we need to test if the gem file works.

data/VERSION.md

@@ -2,6 +2,7 @@
 
 | Version | Date        | Description                                                                 |
 | ------- | ------------| --------------------------------------------------------------------------- |
+| v2.0.0  | 2024-10-17  | Add device helpers, breaking change - removed `is_` from methods returning a boolean |
 | v1.10.5 | 2024-10-11  | Adding chime_info proc |
 | v1.10.4 | 2024-10-07  | Adding sd_card_status to camera record, restructured sd status proc accessors |
 | v1.10.3 | 2024-10-07  | Updating get_sd_status_proc to match video API's update |

data/lib/alula/helpers/device_helpers/attribute_translations_helper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Alula
+  module DeviceHelpers
+    #
+    # Relies on the implementing class having reader properties of `auto_cfg`.
+    # Translates it into a usable string
+    module AttributeTranslationsHelper
+      PANEL_NAME_MAP = {
+        0 => 'Honeywell/Vista',
+        1 => 'Honeywell/Vista+Passive',
+        2 => 'Honeywell/Lynx',
+        3 => 'Honeywell/Lynx+Passive',
+        4 => 'DSC/Depricated',
+        5 => 'GE-Interlogix/Caddx',
+        6 => 'DSC/Alexor',
+        7 => 'DSC/PowerSeries',
+        8 => 'Dialer Capture or Keyswitch',
+        9 => 'GE-Interlogix/Concord',
+        10 => '',
+        11 => 'Gateway',
+        12 => 'GE Simon XT/XTi',
+        13 => 'Cinch',
+        14 => 'Helix',
+        15 => 'Clare D3',
+        19 => 'No Panel'
+      }.freeze
+
+      #
+      # autoCfg contains multiple pieces of information depending on how you examine it.
+      # Doing a bitwise operation with 0xff takes the last 8 bits,
+      # which is the connected panel ID.
+      # https://ipdatatel.atlassian.net/wiki/spaces/SYS/pages/16482314/auto+cfg
+      def panel_name
+        panel_id = auto_cfg.to_i & 0xff
+        self.class::PANEL_NAME_MAP[panel_id] || "Unknown (#{panel_id})"
+      end
+    end
+  end
+end

data/lib/alula/helpers/device_helpers/program_id_helper.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Alula
+  module DeviceHelpers
+    # Helper methods for determining the device type based on the program ID
+    module ProgramIdHelper
+      CONNECT_PROGRAM_IDS = [
+        211, # D3
+        4096, # Camera
+        35, # BAT-FIRE
+        34, # BAT-CONNECT
+        33, # CONNECT-XT
+        32, # CONNECT+
+        36, # CONNECT-XiP
+        38, # WTP-01 (is ALDER-WTP)
+        39, # BAT-Mini
+        40, # CONNECT-FLX
+        41, # CONNECT+PRO
+        42, # CONNECT+PRO-SC
+        43, # BAT-Mini AV
+        44, # WTP-02 (is ALDER-WTP_WIFI)
+        45, # Connect-FLX-Z
+        46, # Connect-FLX-DUAL
+        47  # Connect-FLX-DUAL-Z
+      ].freeze
+
+      GSM_PROGRAM_IDS = [
+        15, 271, # IPD-BAT-CDMA
+        16, 272, # IPD-BAT-CDMA-WIFI
+        17, # IPD-BAT-CDMA-L
+        783, # BAT-LTE
+        788 # BAT-LTE-WIFI
+      ].freeze
+
+      KAMI_CAMERA_PROGRAM_IDS = [
+        3072,
+        3073,
+        3074,
+        3075,
+        3076,
+        3090
+      ].freeze
+
+      EUFY_CAMERA_PROGRAM_IDS = [
+        3086,
+        3087,
+        3088,
+        3089,
+        3091
+      ].freeze
+
+      XIP_FAMILY_PROGRAM_IDS = [
+        36, # CONNECT-XiP
+        40, # C+Flex
+        41, # C+Pro
+        42, # C+Pro-SC
+        45, # C+Flex-Z
+        46, # C+Flex-Dual
+        47  # C+Flex-Dual-Z
+      ].freeze
+
+      def connect_device?
+        self.class::CONNECT_PROGRAM_IDS.include?(program_id)
+      end
+
+      def legacy_device?
+        !connect_device?
+      end
+
+      def gsm_device?
+        self.class::GSM_PROGRAM_IDS.include?(program_id)
+      end
+
+      def connect_xt?
+        program_id == 33
+      end
+
+      def alder_wtp?
+        program_id == 38
+      end
+
+      def kami_camera?
+        self.class::KAMI_CAMERA_PROGRAM_IDS.include?(program_id)
+      end
+
+      def eufy_camera?
+        self.class::EUFY_CAMERA_PROGRAM_IDS.include?(program_id)
+      end
+
+      def connect_xip?
+        program_id == 36
+      end
+
+      def bat_mini?
+        [39, 43].include?(program_id)
+      end
+
+      def xip_family?
+        self.class::XIP_FAMILY_PROGRAM_IDS.include?(program_id)
+      end
+    end
+  end
+end

data/lib/alula/resources/device.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alula
   class Device < Alula::RestResource
     extend Alula::ResourceAttributes
@@ -6,8 +8,10 @@ module Alula
     extend Alula::ApiOperations::List
     extend Alula::ApiOperations::Save
 
-    include Alula::DeviceAttributeTranslations
+    include Alula::DeviceHelpers::AttributeTranslationsHelper
+    include Alula::DeviceHelpers::ProgramIdHelper
 
+    # Nested class for features_selected field
     class FeaturesSelected < Alula::ObjectField
       field :alarm_transmission, type: :boolean
       field :alarm_notifications, type: :boolean
@@ -89,35 +93,35 @@ module Alula
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :interactive_enabled,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :remote_user_logging_feature_enabled,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :push_notification_enabled,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :user_sync_disabled,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :auto_cfg,
           type: :string,
@@ -180,7 +184,7 @@ module Alula
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :online_status,
           type: :string,
@@ -229,63 +233,63 @@ module Alula
           sortable: true,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :station_phone_number,
           type: :string,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :station_account_number,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :station_aux_number,
           type: :string,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :override_account_number,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :signal_suppress_open_close,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :signal_suppress_bypass,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :open_close_suppression,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :convert_sia_to_contact_id,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :downloader_phone_number,
           type: :string,
@@ -299,112 +303,112 @@ module Alula
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :network_trouble_timeout,
           type: :string,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :physical_address1,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_address2,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_street_number,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_street_name,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_street_direction,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_city,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_state,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_zip,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_site_number,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_suite,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_floor,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :physical_description,
           type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user]
+          patchable_by: %i[system station dealer technician user]
 
     field :two_way_voice_enabled,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :sia_two_way_voice_enabled,
           type: :boolean,
           sortable: false,
           filterable: false,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician]
+          patchable_by: %i[system station dealer technician]
 
     field :date_deactivated,
           type: :date,
@@ -454,7 +458,7 @@ module Alula
           sortable: false,
           filterable: true,
           creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician],
+          patchable_by: %i[system station dealer technician],
           use: FeaturesSelected
 
     field :any_trouble,

data/lib/alula/resources/video/device.rb

@@ -90,11 +90,11 @@ module Alula
             patchable_by: %i[system station dealer user],
             creatable_by: %i[system station dealer user]
 
-      def is_jsw?
+      def jsw?
         manufacturer == 'jsw'
       end
 
-      def is_hik?
+      def hik?
         manufacturer == 'hikvision'
       end
     end

data/lib/alula/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Alula
-  VERSION = '1.10.5'
+  VERSION = '2.0.0'
 end

data/lib/alula.rb

@@ -24,7 +24,8 @@ require_relative 'alula/client_configuration'
 require_relative 'alula/errors'
 require_relative 'alula/list_object'
 require_relative 'alula/oauth'
-require_relative 'alula/helpers/device_attribute_translations'
+require_relative 'alula/helpers/device_helpers/attribute_translations_helper'
+require_relative 'alula/helpers/device_helpers/program_id_helper'
 require_relative 'alula/resources/billing_program'
 require_relative 'alula/resources/device'
 require_relative 'alula/resources/device_charge'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alula-ruby
 version: !ruby/object:Gem::Version
-  version: 1.10.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Titus Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -209,7 +209,8 @@ files:
 - lib/alula/client_configuration.rb
 - lib/alula/errors.rb
 - lib/alula/filter_builder.rb
-- lib/alula/helpers/device_attribute_translations.rb
+- lib/alula/helpers/device_helpers/attribute_translations_helper.rb
+- lib/alula/helpers/device_helpers/program_id_helper.rb
 - lib/alula/helpers/jwt_helper.rb
 - lib/alula/list_object.rb
 - lib/alula/meta.rb

data/lib/alula/helpers/device_attribute_translations.rb

@@ -1,68 +0,0 @@
-module Alula
-
-  #
-  # Relies on the implementing class having reader properties of `program_id`
-  # and `auto_cfg`. Translates those values into usable strings
-  module DeviceAttributeTranslations
-    PROGRAM_ID_MAP = {
-      32 => 'CONNECT+',
-      35 => 'BAT-FIRE',
-      34 => 'BAT-CONNECT',
-      211 => 'CLARE-D3',
-      4096 => 'CAMERA',
-      783 => 'BAT-LTE',
-      0 => 'IPD-BAT',
-      1 => 'IPD-BAT',
-      2 => 'IPD-BAT',
-      3 => 'IPD-BAT-ZKI',
-      4 => 'IPD-BAT',
-      8 => 'IPD-BAT',
-      6 => 'IPD-ZGW',
-      9 => 'IPD-BAT-U',
-      11 => 'IPD-ZGW',
-      15 => 'IPD-BAT-CDMA',
-      16 => 'IPD-BAT-WIFI',
-      17 => 'IPD-BAT-CDMA-L',
-      18 => 'IPD-MPWC',
-      19 => 'IPD-CAT-CDMA',
-      20 => 'IPD-BAT-CDMA-WIFI',
-      22 => 'IPD-CAT-XT',
-      33 => 'IGM',
-      271 => 'IPD-BAT-CDMA1'
-    }.freeze
-
-    PANEL_NAME_MAP = {
-      0 => 'Honeywell/Vista',
-      1 => 'Honeywell/Vista+Passive',
-      2 => 'Honeywell/Lynx',
-      3 => 'Honeywell/Lynx+Passive',
-      4 => 'DSC/Depricated',
-      5 => 'GE-Interlogix/Caddx',
-      6 => 'DSC/Alexor',
-      7 => 'DSC/PowerSeries',
-      8 => 'Dialer Capture or Keyswitch',
-      9 => 'GE-Interlogix/Concord',
-      10 => '',
-      11 => 'Gateway',
-      12 => 'GE Simon XT/XTi',
-      13 => 'Cinch',
-      14 => 'Helix',
-      15 => 'Clare D3',
-      19 => 'No Panel',
-    }.freeze
-
-    def device_name
-      self.class::PROGRAM_ID_MAP[self.program_id] || "Unknown (#{self.program_id})"
-    end
-
-    #
-    # autoCfg contains multiple pieces of information depending on how you examine it. 
-    # Doing a bitwise operation with 0xff takes the last 8 bits,
-    # which is the connected panel ID.
-    # https://ipdatatel.atlassian.net/wiki/spaces/SYS/pages/16482314/auto+cfg
-    def panel_name
-      panel_id = auto_cfg.to_i & 0xff
-      self.class::PANEL_NAME_MAP[panel_id] || "Unknown (#{panel_id})"
-    end
-  end
-end