alula-ruby 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c9520f289b6a7b5175a8a32b3a1934d6f1ecae534f4054cfa043533d7dd6572
-  data.tar.gz: 11bf384b95594822f1a8f4c93c71f294409e78e12d63bbad4f700f3060dd222e
+  metadata.gz: d2d96c37fe6b396ea7da51191870f6cf2fdf2161ba4c584886de23ca13f71286
+  data.tar.gz: 7762865147e3ef70241bfdc8122cde25b0349f516cd264296f0b7c98cb745923
 SHA512:
-  metadata.gz: 68f0c65cda2ed0d8c83e7ac321057f986e39ccadb89df5c7c58a37b1490b46ad3158b776370f87dc8cc6c8f1e68a068f88c8f44ad4d8c5a6581344472ca84021
-  data.tar.gz: 9608f45a747a310a1f13ef6341f458ac37b6ed0ba4a5ad30e485532d7424875dd2991562f9b6402152191167fc0a8eccfc0d092b8a84cb3ece489af73d9e1581
+  metadata.gz: 6b7d9e60e505aed16f071afdbaff707ecfd63bcec9e2cd5b537c36b341744406dea9e3ad182a57e88327432069a7d15df6d427b5dd0664d7cad68feb8b6019e6
+  data.tar.gz: 7bd25d2a60a166e68ac1e8cf8daed1928b40260384cf806f7f9c4c12aef543e5187af00eefc613088842d25cd1dcff257d1a2f41e93a1a455d6367d1a9ed03ea

data/VERSION.md

@@ -2,6 +2,8 @@
 
 | Version | Date      | Description                                                                 |
 | ------- | --------- | --------------------------------------------------------------------------- |
+| v1.9.0  | 2024-07-03  | Add DeviceNotification resource with relationships        |
+| v1.8.1  | 2024-06-25  | Update client to accept impersonator authorization to change admin user langauge preference from dealer app        |
 | v1.8.0  | 2024-06-19  | Use Video API endpoints instead of core API passthrough         |
 | v1.7.0  | 2024-06-13  | Add DELETE, PATCH/POST, unregister capabilities for cameras         |
 | v1.6.0  | 2024-01-26  | Add user language attribute         |

data/bin/console

@@ -11,5 +11,41 @@ require "dotenv/load"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
+
+# setup API
+def auth_api
+  token = oauth_token
+  raise token if [Alula::Oauth::Error, Alula::RateLimitError].include? token.class
+
+  setup_client(token)
+  puts 'API configured successfully'
+end
+
+def setup_oatuh
+  Alula::Oauth.configure(
+    client_id: ENV['ALULA_API_CLIENT_ID'],
+    client_secret: ENV['ALULA_API_CLIENT_SECRET'],
+    api_url: ENV['ALULA_API_DOMAIN']
+  )
+end
+
+def oauth_token
+  setup_oatuh
+  Alula::Oauth.authenticate(
+    grant_type: :client_credentials,
+    scopes: 'rpc:devices.register rpc:devices.assign rest:*'
+  )
+end
+
+def setup_client(token)
+  Alula::Client.configure do |c|
+    c.api_url = ENV['ALULA_API_DOMAIN']
+    c.api_key = token.access_token
+    c.role = :system
+    c.video_api_url = ENV['VIDEO_API_DOMAIN']
+    c.video_api_key = ENV['VIDEO_API_DOMAIN']
+  end
+end
+
 IRB.start(__FILE__)

data/lib/alula/client.rb

@@ -65,9 +65,10 @@ module Alula
       end
 
       def build_options(http_method, resource_path, filters = {}, opts = {})
+        api_key = Alula::Client.config.impersonator_api_key || Alula::Client.config.api_key
         request_opts = {
           headers: {
-            'Authorization': "Bearer #{Alula::Client.config.api_key}",
+            'Authorization': "Bearer #{api_key}",
             'User-Agent': "#{Alula::Client.config.user_agent || 'No Agent Set'}/alula-ruby v#{Alula::VERSION}"
           }
         }.merge(opts)

data/lib/alula/client_configuration.rb

@@ -1,7 +1,8 @@
 module Alula
   class ClientConfiguration
     attr_accessor :api_url, :video_api_url, :debug, :user_agent
-    REQUEST_ATTRIBUTES = %i[api_key video_api_key customer_id internal]
+
+    REQUEST_ATTRIBUTES = %i[api_key video_api_key customer_id internal impersonator_api_key]
 
     # Using RequestStore so we're thread safe even with our non-thread-safe architecture :(
     REQUEST_ATTRIBUTES.each do |prop|

data/lib/alula/resources/device.rb

@@ -30,7 +30,7 @@ module Alula
     # relationship :eventlog, type: 'devices-eventlog', cardinality: 'To-many'
     relationship :receiver_group, type: 'receivers-groups', cardinality: 'To-one'
     # relationship :helix_users, type: 'helix-user', cardinality: 'To-many'
-    # relationship :notifications, type: 'devices-notification', cardinality: 'To-many'
+    relationship :notifications, type: 'device-notifications', cardinality: 'To-many'
     # relationship :users, type: 'devices-user', cardinality: 'To-many'
     # relationship :features_supported, type: 'devices-features-supported', cardinality: 'To-one'
     # relationship :features_disabled, type: 'devices-features-disabled', cardinality: 'To-one'

data/lib/alula/resources/device_notification.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Alula
+  class DeviceNotification < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+
+    resource_path 'devices/notifications'
+    type 'device-notifications'
+
+    relationship :device, type: 'devices', cardinality: 'To-one'
+    relationship :revisions, type: 'revisions', cardinality: 'To-many'
+    relationship :user, type: 'users', cardinality: 'To-one'
+
+    field :id,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[],
+          patchable_by: %i[]
+
+    field :alarms,
+          type: :array,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system station dealer technician user sub_user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :bypasses_disables,
+          type: :array,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system station dealer technician user sub_user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :device_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user sub_user],
+          patchable_by: %i[]
+
+    field :i_view_now,
+          type: :array,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system station dealer technician user sub_user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :open_close,
+          type: :array,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system station dealer technician user sub_user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :supervisory,
+          type: :array,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system station dealer technician user sub_user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :test_misc,
+          type: :array,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system station dealer technician user sub_user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :troubles,
+          type: :array,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system station dealer technician user sub_user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :user_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user sub_user],
+          patchable_by: %i[]
+  end
+end

data/lib/alula/resources/revision.rb

@@ -13,6 +13,7 @@ module Alula
     # Relationships
     relationship :creator, type: 'users', cardinality: 'To-one'
     relationship :device, type: 'devices', cardinality: 'To-one'
+    relationship :device_notification, type: 'device-notifications', cardinality: 'To-one'
     relationship :user, type: 'users', cardinality: 'To-one'
     relationship :dealer, type: 'dealers', cardinality: 'To-one'
 
@@ -82,7 +83,6 @@ module Alula
           creatable_by: [],
           patchable_by: []
 
-
     def document
       JSON.parse(@values['document'])
           .with_indifferent_access

data/lib/alula/resources/user.rb

@@ -12,6 +12,7 @@ module Alula
     type 'users'
 
     relationship :devices, type: 'devices', cardinality: 'To-many'
+    relationship :device_notifications, type: 'device-notifications', cardinality: 'To-many'
     relationship :dealer, type: 'dealers', cardinality: 'To-one'
     relationship :phone, type: 'users-phones', cardinality: 'To-one'
     relationship :address, type: 'users-addresses', cardinality: 'To-one'

data/lib/alula/version.rb

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

data/lib/alula.rb

@@ -60,6 +60,7 @@ require_relative 'alula/resources/revision'
 require_relative 'alula/resources/station'
 require_relative 'alula/resources/oauth_client'
 require_relative 'alula/resources/device_alias'
+require_relative 'alula/resources/device_notification'
 
 require_relative 'alula/resources/feature_plan'
 require_relative 'alula/resources/feature_planvideo'
@@ -106,34 +107,36 @@ module Alula
   # API query responses, and included models.
   @@resource_map = [
     Alula::BillingProgram,
+    Alula::Dealer,
+    Alula::DealerAccountTransfer,
+    Alula::DealerBranding,
+    Alula::DealerPhone,
+    Alula::DealerProgram,
     Alula::Device,
     Alula::DeviceAlias,
     Alula::DeviceCharge,
     Alula::DeviceCredit,
     Alula::DeviceEventLog,
+    Alula::DeviceNotification,
     Alula::DeviceProgram,
     Alula::DealerAddress,
-    Alula::DealerPhone,
-    Alula::DealerProgram,
     Alula::DeviceCellularStatus,
-    Alula::Self,
-    Alula::User,
-    Alula::UserPhone,
-    Alula::UserAddress,
-    Alula::UserPushtoken,
-    Alula::UserPreferences,
-    Alula::UserVideoProfile,
-    Alula::Dealer,
-    Alula::DealerBranding,
-    Alula::ReceiverGroup,
-    Alula::ReceiverDisabled,
-    Alula::Station,
-    Alula::DealerAccountTransfer,
+    Alula::FeatureBySubject,
     Alula::FeaturePlan,
     Alula::FeaturePlanVideo,
     Alula::FeaturePrice,
-    Alula::FeatureBySubject,
     Alula::OAuthClient,
+    Alula::ReceiverGroup,
+    Alula::ReceiverDisabled,
+    Alula::Revision,
+    Alula::Self,
+    Alula::Station,
+    Alula::User,
+    Alula::UserAddress,
+    Alula::UserPhone,
+    Alula::UserPreferences,
+    Alula::UserPushtoken,
+    Alula::UserVideoProfile
   ].each_with_object({}) do |klass, resource_map|
     resource_map[klass.get_type] = klass
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alula-ruby
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Titus Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -260,6 +260,7 @@ files:
 - lib/alula/resources/device_charge.rb
 - lib/alula/resources/device_credit.rb
 - lib/alula/resources/device_event_log.rb
+- lib/alula/resources/device_notification.rb
 - lib/alula/resources/device_program.rb
 - lib/alula/resources/event_trigger.rb
 - lib/alula/resources/event_webhook.rb