alula-ruby 2.28.0 → 2.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcb258dad7e245a45f246024798af440cdb6b096ab8ba173be27c01529812b37
-  data.tar.gz: 8ca1dba0f83e8afffdf3eb52dafe32f42909776467c2ece8d2ced16b5ad89396
+  metadata.gz: e01ef49bc046ae1795d32869b79a7e4b92996c0d35e3cee3cfd2de8df534dcd2
+  data.tar.gz: 62d790ddc15244480f6ab1e08d5b77738a92aaeb94a6d286c2a82c9229694267
 SHA512:
-  metadata.gz: 015ad618b930d39fc7b6cf547b2e8699c23ec59261f6a16aa166cb2dabfcdc3bae4ef58a84c1f1650d9570ad36019d632c2474db774c5a872ab3a17fa33bf410
-  data.tar.gz: 61181e47309b1f12db9702d6d8923cfb4612675b25e05914106eae4d613dcb86abecc33faed94b0e76bbb5075f041d044d5705556cba55b97a29721fb2adc09e
+  metadata.gz: 107146e1b827e0f7d8418ca3339d114c27f18750658e73af54e25b6190e65b0857983c93dd8862105b7ffdd2f039a0f1c142db6e2ae948c8b882d5912c561e2c
+  data.tar.gz: f095933709d5855fca510bfe3700409e6f1e97e2ab116dc1f9e88f2e845c94ec45ed2f41457536a03b4ab4038f23f5f9ad055b07127d6ebb7e8b49ffa626fb17

data/VERSION.md

@@ -2,6 +2,8 @@
 
 | Version | Date        | Description                                                                 |
 | ------- | ------------| --------------------------------------------------------------------------- |
+| v2.30.0 | 2025-12-16  | Adds M2MCentralStation and PermittedCentralStation |
+| v2.29.0 | 2025-12-01  | Adds User Impersonation Requests and new Meta |
 | v2.28.0 | 2025-11-19  | Add product_sku Device property |
 | v2.27.1 | 2025-11-14  | Add ONVIF feature support for CONNECT-FLX-DUAL and CONNECT-FLX-DUAL-Z devices |
 | v2.27.0 | 2025-10-02  | Add nfc_get_branding proc to get dealer branding from tag id |

data/alula-docker-compose.yml

@@ -70,6 +70,9 @@ services:
       IPDAPI_RL_DEFAULT_MAX_HITS: ${IPDAPI_RL_DEFAULT_MAX_HITS:-10000}
       IPDAPI_RL_LOGIN_MAX_HITS: ${IPDAPI_RL_LOGIN_MAX_HITS:-1000}
       IPDAPI_TRUST_PROXY: loopback
+      IPDAPI_M2M_API_BASE_URL: https://app.m2mservices.com/
+      IPDAPI_M2M_API_USERNAME: user
+      IPDAPI_M2M_API_PASSWORD: pass
       IPDAPI_WS_WORK_EVENTS_ENABLED: true
       IPDAPI_WS_WORK_VIGILANCE_BATCH_WINDOW_MSEC: ${IPDAPI_WS_WORK_VIGILANCE_BATCH_WINDOW_MSEC:-5000}
       IPDAPI_WS_WORK_VIGILANCE_CANCEL_BATCH_WINDOW_MSEC: ${IPDAPI_WS_WORK_VIGILANCE_CANCEL_BATCH_WINDOW_MSEC:-10000}

data/lib/alula/client.rb

@@ -18,8 +18,37 @@ module Alula
       end
 
       def request(http_method, resource_path, filters = {}, opts = {})
+        if resource_path.match(%r{^/m2m/})
+          request_m2m(http_method, resource_path, filters, opts)
+        else
+          request_alula(http_method, resource_path, filters, opts)
+        end
+      end
+
+      private
+
+      def request_m2m(http_method, resource_path, filters = {}, opts = {})
+        validate_request!(http_method, resource_path)
+        request_opts = build_options_m2m(http_method, resource_path, filters, opts)
+        api_url = config.api_url
+        request_resource_path = resource_path
+
+        # TODO: Handle network failures
+        response = make_request(http_method, api_url + request_resource_path, request_opts)
+
+        begin
+          resp = M2MResponse.from_httparty_response(response)
+        rescue JSON::ParserError
+          # TODO: Should be able to send better info up with this
+          raise 'Unable to decode JSON'
+        end
+
+        resp
+      end
+
+      def request_alula(http_method, resource_path, filters = {}, opts = {})
         validate_request!(http_method, resource_path) unless resource_path.match(%r{^/public/v1})
-        request_opts = build_options(http_method, resource_path, filters, opts)
+        request_opts = build_options_alula(http_method, resource_path, filters, opts)
         api_url = video_request?(resource_path) ? config.video_api_url : config.api_url
         request_resource_path = video_request?(resource_path) ? resource_path.gsub(%r{^/video}, '') : resource_path
 
@@ -36,8 +65,6 @@ module Alula
         resp
       end
 
-      private
-
       def validate_request!(http_method, resource_path)
         config.ensure_api_key_set
         config.ensure_api_url_set
@@ -64,7 +91,27 @@ module Alula
         resource_path.match(%r{^/video})
       end
 
-      def build_options(http_method, resource_path, filters = {}, opts = {})
+      def build_options_m2m(http_method, resource_path, filters = {}, opts = {})
+        api_key = Alula::Client.config.impersonator_api_key || Alula::Client.config.api_key
+        request_opts = {
+          headers: {
+            'Authorization': "Bearer #{api_key}",
+            'User-Agent': "#{Alula::Client.config.user_agent || 'No Agent Set'}/alula-ruby v#{Alula::VERSION}"
+          }
+        }.merge(opts)
+
+        request_opts[:headers]['Content-Type'] = 'application/json'
+        request_opts[:body] = opts[:multipart] ? filters : JSON.generate(filters)
+
+        if Alula::Client.config.debug
+          request_opts[:debug_output] = Alula.logger
+          logger Alula.logger, :info
+        end
+
+        request_opts
+      end
+
+      def build_options_alula(http_method, resource_path, filters = {}, opts = {})
         api_key = Alula::Client.config.impersonator_api_key || Alula::Client.config.api_key
         request_opts = {
           headers: {

data/lib/alula/errors.rb

@@ -231,4 +231,32 @@ module Alula
       @errors = errors
     end
   end
+
+  class M2MError < AlulaError
+    attr_reader :error_code
+
+    def self.for_response(response)
+      if response.data['Success'] == false
+        self.m2m_error_for_response(response)
+      else
+        super response
+      end
+    end
+
+    private
+
+    def self.m2m_error_for_response(response)
+      error_code = response.data['ErrorCode']
+      error = response.data['ErrorString']
+      message = self.build_message(error, error_code)
+      BadRequestError.new(message)
+    end
+
+    def self.build_message(error, code)
+      return error unless error.to_s.strip.empty?
+      return "M2M request failed with code #{code}" if code
+
+      'M2M request failed'
+    end
+  end
 end

data/lib/alula/m2m_response.rb

@@ -0,0 +1,22 @@
+require_relative 'alula_response'
+
+module Alula
+  class M2MResponse < AlulaResponse
+    attr_accessor :data, :http_body, :http_headers, :http_status, :raw, :rate_limit
+
+    def ok?
+      super && self.data['Success'] == true
+    end
+
+    def self.from_httparty_response(response)
+      resp = M2MResponse.new
+      resp.data = response.parsed_response
+      resp.http_body = response.body
+      resp.http_headers = response.headers
+      resp.rate_limit = Alula::RateLimit.new(response.headers)
+      resp.http_status = response.code
+      resp.raw = response
+      resp
+    end
+  end
+end

data/lib/alula/m2m_rest_resource.rb

@@ -0,0 +1,17 @@
+module Alula
+  class M2MRestResource < ApiResource
+    def self.resource_url(id = nil)
+      if self == M2MRestResource
+        raise NotImplementedError, "Cannot call resource_url on a M2MRestResource. Try using M2MCentralStation instead."
+      end
+      base_path = "/m2m/bll/v3/external"
+      return base_path if id.nil?
+
+      [base_path, id].join('/').gsub(%r{/+}, '/').sub(%r{/$}, '')
+    end
+
+    def resource_url(id = nil)
+      self.class.resource_url(id)
+    end
+  end
+end

data/lib/alula/meta.rb

@@ -1,16 +1,70 @@
 module Alula
   class Meta
-    attr_reader :page, :total, :number, :size
+    attr_reader :page, :total, :number, :size, :custom_attributes
 
     def initialize(meta)
-      return unless meta['page']
+      meta_hash = coerce_to_hash(meta)
 
-      @page = Alula::Pagination.new(meta['page'])
+      page_data = extract_page(meta_hash)
+      build_pagination(page_data)
 
-      # TODO: TJ Deprecate, the meta can hold a lot more than the page
-      @total = @page.total
-      @number = @page.number
-      @size = @page.size
+      @custom_attributes = build_custom_attributes(meta_hash)
+    end
+
+    def [](key)
+      custom_attributes[normalize_key(key)]
+    end
+
+    def fetch(key, *args, &block)
+      custom_attributes.fetch(normalize_key(key), *args, &block)
+    end
+
+    def method_missing(method_name, *args, &block)
+      return custom_attributes[method_name] if custom_attributes.key?(method_name)
+
+      super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      custom_attributes.key?(method_name) || super
+    end
+
+    private
+
+    def coerce_to_hash(meta)
+      return {} unless meta.respond_to?(:each_pair)
+
+      meta.each_pair.each_with_object({}) do |(key, value), result|
+        result[key.to_s] = value
+      end
+    end
+
+    def extract_page(meta_hash)
+      meta_hash.delete('page') || meta_hash.delete(:page)
+    end
+
+    def build_pagination(page_data)
+      if page_data
+        @page = Alula::Pagination.new(page_data)
+        @total = @page.total
+        @number = @page.number
+        @size = @page.size
+      else
+        @page = nil
+        @total = nil
+        @number = nil
+        @size = nil
+      end
+    end
+
+    def build_custom_attributes(meta_hash)
+      meta_hash.each_with_object({}) do |(key, value), attributes|
+        attributes[normalize_key(key)] = value
+      end
+    end
+
+    def normalize_key(key)
+      Util.underscore(key.to_s).to_sym
     end
   end
 end

data/lib/alula/resources/m2m/m2m_central_station.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+# Please forget about abstractions if working with M2M API. Endpoints are
+# inconsistent and do not follow REST principles.
+module Alula
+  class M2MCentralStation < Alula::M2MRestResource
+    extend Alula::ResourceAttributes
+
+    DEFAULT_PAGE_NUMBER = 1
+
+    field :app_name,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+
+    field :primary_proxy,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :backup_proxy,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    class << self
+      def list(filters = {}, opts = {})
+        built_filters = {}
+        pagination = filters.delete(:page)
+        if pagination
+          built_filters['Page'] = pagination[:number]
+          built_filters['PageSize'] = pagination[:size]
+        end
+        response = Alula::Client.request(:post, resource_url('GetAvailableCentralStations'), built_filters, opts)
+        if response.ok?
+          list = construct_list_from_response(self, response.data.fetch('ResponseBody', {}), pagination)
+          list.rate_limit = response.rate_limit
+          list
+        else
+          error_class = M2MError.for_response(response)
+          raise error_class
+        end
+      end
+
+      def retrieve(id)
+        built_filters = {}
+        built_filters['AppName'] = id
+        response = Alula::Client.request(:post, self.resource_url('GetCentralStationProxies'), built_filters, {})
+        if response.ok?
+          item = build_model(self, response.data.fetch('ResponseBody', {}))
+          item.rate_limit = response.rate_limit
+          item
+        else
+          error_class = M2MError.for_response(response)
+          raise error_class
+        end
+      end
+
+      def method_missing(method, *args, &block)
+        query = QueryInterface.new(self)
+        return query.public_send(method, *args, &block) if query.respond_to?(method)
+
+        super
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        QueryInterface.new(self).respond_to?(method, include_private) || super
+      end
+
+      private
+
+      def construct_list_from_response(klass, response_body, pagination)
+        list = ListObject.new(klass)
+        Array(response_body.fetch('AvailableCentralStations', [])).each do |item|
+          next unless item.is_a?(Hash)
+
+          list << build_model(klass, item)
+        end
+
+        list.set_meta Meta.new(
+          'page' => {
+            'total' => response_body['TotalCount'] || list.length,
+            'number' => pagination[:number],
+            'size' => pagination[:size]
+          }
+        )
+        list
+      end
+
+      def build_model(klass, attributes)
+        sanitized_attributes = attributes.each_with_object({}) do |(key, value), memo|
+          memo[Util.camelize(Util.underscore(key.to_s))] = value
+        end
+
+        klass.new(sanitized_attributes['appName'], sanitized_attributes)
+      end
+
+      def extract_page_value(pagination, key)
+        return nil unless pagination.is_a?(Hash)
+
+        pagination[key] || pagination[key.to_s]
+      end
+    end
+  end
+end

data/lib/alula/resources/permitted_central_station.rb

@@ -0,0 +1,55 @@
+module Alula
+  class PermittedCentralStation < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+    extend Alula::ApiOperations::Delete
+
+    resource_path 'dealers/permittedCentralStations'
+    type 'dealers-permittedCentralStations'
+
+
+    relationship :dealer, type: 'dealers', cardinality: 'To-one'
+
+    # Resource Fields
+    # Not all params are used at the moment. See Alula::ResourceAttributes for details
+    # on how params are parsed,
+    field :id,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: []
+
+    field :dealer_id,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: []
+    
+    field :remote_central_station_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+      
+    field :created_by,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    
+    field :created_at,
+          type: :date,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+  end
+end

data/lib/alula/resources/user_impersonation.rb

@@ -0,0 +1,27 @@
+module Alula
+  class UserImpersonation < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::Save
+    
+
+    resource_path 'users/impersonation'
+    type 'users-impersonation'
+
+    # Resource Fields
+    # Not all params are presented here at the moment
+    field :id,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :status,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: %i[dealer]
+  end
+end

data/lib/alula/version.rb

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

data/lib/alula.rb

@@ -11,6 +11,8 @@ 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/m2m_rest_resource'
+require_relative 'alula/m2m_response'
 
 require_relative 'alula/dcp/error_handler'
 require_relative 'alula/dcp/list_object'
@@ -121,6 +123,7 @@ require_relative 'alula/resources/self'
 require_relative 'alula/resources/user'
 require_relative 'alula/resources/user_phone'
 require_relative 'alula/resources/user_address'
+require_relative 'alula/resources/user_impersonation'
 require_relative 'alula/resources/user_pushtoken'
 require_relative 'alula/resources/user_preferences'
 require_relative 'alula/resources/user_videoprofile'
@@ -146,9 +149,11 @@ require_relative 'alula/resources/feature_price'
 require_relative 'alula/resources/feature_bysubject'
 require_relative 'alula/resources/nfc_tag'
 require_relative 'alula/resources/sim_card'
+require_relative 'alula/resources/permitted_central_station'
 require_relative 'alula/resources/dcp/config/synchronize'
 require_relative 'alula/resources/video/base_resource'
 require_relative 'alula/resources/video/device'
+require_relative 'alula/resources/m2m/m2m_central_station'
 
 require_relative 'alula/procedures/device_cellular_history_proc'
 require_relative 'alula/procedures/device_rateplan_get_proc'
@@ -236,6 +241,8 @@ module Alula
     Alula::ReceiverBind,
     Alula::Revision,
     Alula::Self,
+    Alula::M2MCentralStation,
+    Alula::PermittedCentralStation,
     Alula::Station,
     Alula::User,
     Alula::UserAddress,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alula-ruby
 version: !ruby/object:Gem::Version
-  version: 2.28.0
+  version: 2.30.0
 platform: ruby
 authors:
 - Titus Johnson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-19 00:00:00.000000000 Z
+date: 2025-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -225,6 +225,8 @@ files:
 - lib/alula/helpers/device_helpers/program_id_helper.rb
 - lib/alula/helpers/jwt_helper.rb
 - lib/alula/list_object.rb
+- lib/alula/m2m_response.rb
+- lib/alula/m2m_rest_resource.rb
 - lib/alula/meta.rb
 - lib/alula/monkey_patches.rb
 - lib/alula/oauth.rb
@@ -341,8 +343,10 @@ files:
 - lib/alula/resources/feature_planvideo.rb
 - lib/alula/resources/feature_price.rb
 - lib/alula/resources/helix_user.rb
+- lib/alula/resources/m2m/m2m_central_station.rb
 - lib/alula/resources/nfc_tag.rb
 - lib/alula/resources/oauth_client.rb
+- lib/alula/resources/permitted_central_station.rb
 - lib/alula/resources/receiver.rb
 - lib/alula/resources/receiver_bind.rb
 - lib/alula/resources/receiver_connection.rb
@@ -355,6 +359,7 @@ files:
 - lib/alula/resources/token_exchange.rb
 - lib/alula/resources/user.rb
 - lib/alula/resources/user_address.rb
+- lib/alula/resources/user_impersonation.rb
 - lib/alula/resources/user_phone.rb
 - lib/alula/resources/user_preferences.rb
 - lib/alula/resources/user_pushtoken.rb