alula-ruby 2.6.3 → 2.8.0

data/lib/alula/singleton_dcp_command_resource.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Alula
+  # Base class for DCP command resources
+  class SingletonDcpCommandResource
+    attr_accessor :device_id, :values
+
+    BASE_PATH = '/dcp/v2/helix'
+
+    def initialize(device_id, attributes = nil)
+      @values = attributes || {}
+      construct_new_resource(device_id)
+    end
+
+    def model_name
+      self.class
+    end
+
+    def self.request(device_id:, http_method:, path: get_resource_path, payload: {}, opts: {})
+      if self == Alula::SingletonDcpCommandResource
+        raise NotImplementedError,
+              'Alula::SingletonDcpCommandResource is an abstract class and cannot be instantiated.' \
+              ' You should perform actions on its subclasses (Synchronize, etc.)'
+      end
+      if payload.empty? && payload_required?
+        raise ArgumentError, 'Payload is empty. This will result in a useless request.'
+      end
+
+      path = "#{BASE_PATH}/#{device_id}/#{path}"
+      payload = payload_to_camelcase(payload)
+      response = Alula::Client.request(http_method, path, payload, opts)
+
+      unless response.ok?
+        error = Alula::AlulaError.for_response(response)
+
+        #
+        # Some error classifications are critical and should be raised for visibility
+        # These errors do not contain meaningful data that an end-user can use to correct
+        # the error.
+        raise error if [Alula::RateLimitError, Alula::BadRequestError, Alula::ForbiddenError,
+                        Alula::UnknownError, Alula::InsufficientScopeError].include?(error.class)
+
+        return error
+      end
+
+      new(device_id, response.data)
+    end
+
+    def construct_new_resource(device_id)
+      self.device_id = device_id
+      instance_eval do
+        fields.each_key do |field|
+          camel_key = Util.camelize(field)
+          define_singleton_method(field) do
+            if @values.key?(camel_key)
+              @values[camel_key]
+            else
+              @values[field]
+            end
+          end
+          define_singleton_method("#{field}=") do |value|
+            if @values.key?(camel_key)
+              @values[camel_key] = value
+            else
+              @values[field] = value
+            end
+          end
+        end
+      end
+    end
+
+    def apply_attributes(attributes)
+      attributes.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def call
+      self.class.call(device_id: device_id, payload: @values)
+    end
+
+    def self.payload_to_camelcase(payload)
+      # recursively convert all keys to camelcase
+      payload.each_with_object({}) do |(key, value), hash|
+        hash[Util.camelize(key)] = if value.is_a?(Array)
+                                     value.map { |v| v.is_a?(Hash) ? payload_to_camelcase(v) : v }
+                                   else
+                                     value.is_a?(Hash) ? payload_to_camelcase(value) : value
+                                   end
+      end
+    end
+
+    def self.payload_required?
+      # return false unless the method is overridden
+      return false unless method_defined?(:payload_required?)
+
+      payload_required?
+    end
+  end
+end

data/lib/alula/util.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Alula
+  # Utility methods for the Alula gem
   class Util
     class << self
       #
@@ -13,10 +16,11 @@ module Alula
       # activesupport/lib/active_support/inflector/methods.rb, line 90
       def underscore(camel_cased_word)
         return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
+
         word = camel_cased_word.to_s.gsub(/::/, '/')
-        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-        word.tr!("-", "_")
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!('-', '_')
         word.downcase!
         word
       end
@@ -28,21 +32,26 @@ module Alula
 
       def camelize(under_scored_word)
         return CAMELIZE_MAPPING[under_scored_word.to_s] if CAMELIZE_MAPPING.key?(under_scored_word.to_s)
+
         words = under_scored_word.to_s.split(/-|_/)
-        words.each_with_index.map{ |el, i| i == 0 ? el.downcase : el.capitalize }.join
+        words.each_with_index.map { |el, i| i.zero? ? el.downcase : el.capitalize }.join
       end
 
       def upper_camelcase(under_scored_word)
         under_scored_word.to_s.split(/-|_/).map(&:capitalize).join
       end
 
-      def split_on_word(string, separator_match = /-|_/, &block)
+      def upper_camelcase_from_camelcase(camel_cased_word)
+        camel_cased_word.split(/(?=[A-Z])/).map(&:capitalize).join
+      end
+
+      def split_on_word(string, separator_match = /-|_/, &_block)
         string.to_s.split(separator_match)
       end
 
       # https://stackoverflow.com/questions/9381553/ruby-merge-nested-hash
       def deep_merge(first, second)
-        merger = proc do |key, v1, v2|
+        merger = proc do |_key, v1, v2|
           if Hash === v1 && Hash === v2
             v1.merge(v2, &merger)
           elsif Array === v1 && Array === v2
@@ -70,7 +79,7 @@ module Alula
 
           # Error objects contain a bunch of info, but all the good stuff
           # is stored in a sub-object named meta
-          # 
+          #
           # meta looks something like this
           # {
           #   fieldName: 'field error description',
@@ -103,6 +112,14 @@ module Alula
 
         error_object
       end
+
+      def model_errors_from_dcp_response(response)
+        return false unless response.data['error'] || response.data['message']
+
+        {
+          model: response.data['message']
+        }
+      end
     end
   end
 end

data/lib/alula/version.rb

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

data/lib/alula.rb

@@ -1,13 +1,25 @@
 require 'alula/version'
 require 'request_store'
 require 'forwardable'
+require 'logger'
 require_relative 'alula/resource_attributes'
+require_relative 'alula/dcp/resource_attributes'
 require_relative 'alula/relationship_attributes'
 require_relative 'alula/api_operations/list'
 require_relative 'alula/api_operations/request'
 require_relative 'alula/api_operations/save'
 require_relative 'alula/api_operations/delete'
 require_relative 'alula/api_resource'
+require_relative 'alula/dcp/error_handler'
+require_relative 'alula/dcp/list_object'
+require_relative 'alula/dcp_operations/list'
+require_relative 'alula/dcp_operations/request'
+require_relative 'alula/dcp_operations/save'
+require_relative 'alula/dcp_operations/delete'
+require_relative 'alula/dcp_operations/delete_staged'
+require_relative 'alula/dcp/meta'
+require_relative 'alula/dcp_resource'
+require_relative 'alula/singleton_dcp_command_resource'
 require_relative 'alula/rpc_resource'
 require_relative 'alula/rpc_response'
 require_relative 'alula/rest_resource'
@@ -67,6 +79,11 @@ require_relative 'alula/resources/feature_plan'
 require_relative 'alula/resources/feature_planvideo'
 require_relative 'alula/resources/feature_price'
 require_relative 'alula/resources/feature_bysubject'
+require_relative 'alula/resources/dcp/base_resource'
+require_relative 'alula/resources/dcp/users_data'
+require_relative 'alula/resources/dcp/users_data/user'
+require_relative 'alula/resources/dcp/users_data/installer_pin'
+require_relative 'alula/resources/dcp/config/synchronize'
 require_relative 'alula/resources/video/base_resource'
 require_relative 'alula/resources/video/device'
 require_relative 'alula/procedures/device_cellular_history_proc'
@@ -162,7 +179,7 @@ module Alula
   end
 
   def self.logger
-    @@logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    @@logger ||= defined?(Rails) ? Rails.logger : Logger.new($stdout)
   end
 
   def self.logger=(logger)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alula-ruby
 version: !ruby/object:Gem::Version
-  version: 2.6.3
+  version: 2.8.0
 platform: ruby
 authors:
 - Titus Johnson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -207,6 +207,16 @@ files:
 - lib/alula/api_resource.rb
 - lib/alula/client.rb
 - lib/alula/client_configuration.rb
+- lib/alula/dcp/error_handler.rb
+- lib/alula/dcp/list_object.rb
+- lib/alula/dcp/meta.rb
+- lib/alula/dcp/resource_attributes.rb
+- lib/alula/dcp_operations/delete.rb
+- lib/alula/dcp_operations/delete_staged.rb
+- lib/alula/dcp_operations/list.rb
+- lib/alula/dcp_operations/request.rb
+- lib/alula/dcp_operations/save.rb
+- lib/alula/dcp_resource.rb
 - lib/alula/errors.rb
 - lib/alula/filter_builder.rb
 - lib/alula/helpers/device_helpers/attribute_translations_helper.rb
@@ -259,6 +269,12 @@ files:
 - lib/alula/relationship_attributes.rb
 - lib/alula/resource_attributes.rb
 - lib/alula/resources/billing_program.rb
+- lib/alula/resources/dcp/base_resource.rb
+- lib/alula/resources/dcp/config.rb
+- lib/alula/resources/dcp/config/synchronize.rb
+- lib/alula/resources/dcp/users_data.rb
+- lib/alula/resources/dcp/users_data/installer_pin.rb
+- lib/alula/resources/dcp/users_data/user.rb
 - lib/alula/resources/dealer.rb
 - lib/alula/resources/dealer_account_transfer.rb
 - lib/alula/resources/dealer_address.rb
@@ -304,6 +320,7 @@ files:
 - lib/alula/rest_resource.rb
 - lib/alula/rpc_resource.rb
 - lib/alula/rpc_response.rb
+- lib/alula/singleton_dcp_command_resource.rb
 - lib/alula/singleton_rest_resource.rb
 - lib/alula/util.rb
 - lib/alula/version.rb