alula-ruby 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e8587f55af4a330e24dfdb5f5e6df0ca0cb581f16d38a05b132925b03df0152
-  data.tar.gz: 5af4c678137eb61daf3d7416644a95beaffa85c41870294775b3e4d801a88ccb
+  metadata.gz: 4c9520f289b6a7b5175a8a32b3a1934d6f1ecae534f4054cfa043533d7dd6572
+  data.tar.gz: 11bf384b95594822f1a8f4c93c71f294409e78e12d63bbad4f700f3060dd222e
 SHA512:
-  metadata.gz: 744017971308b19fc198941335cfe71b2cdc4bbf0c223d41fb7dbb9cc325cfe13f667f7f59fd7c9d8dbb6a2fd7c2e38d301566e24e7729239c4fd213083f71f7
-  data.tar.gz: 2343e372fd84218e713abfaa2574e4ead77a180c27057cee0bdfc5fcd354184ce01b953041ebf87b503e743622dedf51cb9a357d33cd4a7ead1f0eb378d7bab1
+  metadata.gz: 68f0c65cda2ed0d8c83e7ac321057f986e39ccadb89df5c7c58a37b1490b46ad3158b776370f87dc8cc6c8f1e68a068f88c8f44ad4d8c5a6581344472ca84021
+  data.tar.gz: 9608f45a747a310a1f13ef6341f458ac37b6ed0ba4a5ad30e485532d7424875dd2991562f9b6402152191167fc0a8eccfc0d092b8a84cb3ece489af73d9e1581

data/.ruby-version

@@ -1 +1 @@
-3.0.6
+3.3.0

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:3.0.6-alpine
+FROM ruby:3.3.0-alpine
 
 RUN gem install bundler
 

data/VERSION.md

@@ -2,6 +2,8 @@
 
 | Version | Date      | Description                                                                 |
 | ------- | --------- | --------------------------------------------------------------------------- |
+| 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         |
 | v1.5.0  | 2024-01-09  | Add more known errors that use a different format         |
 | v1.4.0  | 2024-01-04  | Add more known errors that use a different format, bugfix for `NotImplementedError` raising         |

data/alula-docker-compose.yml

@@ -73,6 +73,7 @@ services:
       IPDAPI_WS_WORK_VIGILANCE_CANCEL_BATCH_WINDOW_MSEC: ${IPDAPI_WS_WORK_VIGILANCE_CANCEL_BATCH_WINDOW_MSEC:-10000}
       IPDAPI_WS_WORK_VIGILANCE_CANCEL_TERMINATE_DELAY_MSEC: ${IPDAPI_WS_WORK_VIGILANCE_CANCEL_TERMINATE_DELAY_MSEC:-500}
       IPDAPI_WS_WORK_VIGILANCE_TERMINATE_DELAY_MSEC: ${IPDAPI_WS_WORK_VIGILANCE_TERMINATE_DELAY_MSEC:-500}
+      LOG_LEVEL: warn
       MARIADB_ADDRESS: mariadb
       MARIADB_PASS: ""
       MARIADB_USER: root
@@ -82,13 +83,14 @@ services:
       MONGODB_USER: ipd
       RMQ_EPHEMERAL_ADDRESS: amqp://rmq-ephemeral
       RMQ_PERSISTENT_ADDRESS: amqp://rmq-persistent
+      REDIS_ADDRESS: redis-ipdapi
     healthcheck:
-      interval: 15s
-      retries: 5
+      interval: 5s
+      retries: 10
       start_period: 30s
-      test: curl -s http://localhost/public/v1/healthcheck/default || exit -1
-      timeout: 15s
-    image: 6z1wlx5zf1.execute-api.us-east-1.amazonaws.com/alula/ipdapi:latest-master
+      test: apk add curl && curl -s http://localhost/public/v1/healthcheck/default || exit -1
+      timeout: 10s
+    image: 613707345027.dkr.ecr.us-east-1.amazonaws.com/api/ipdapi:staging
     networks:
       mesh_net:
     profiles:
@@ -101,23 +103,24 @@ services:
     ports:
       - "8080:80"
   mariadb:
+    hostname: mariadb
+    image: mariadb:10.3
     command:
       - --wait_timeout=28800
       - --max_connections=2048
     environment:
-      MYSQL_ALLOW_EMPTY_PASSWORD: "true"
-    healthcheck:
-      interval: 15s
-      retries: 5
-      test: [CMD, mysqladmin, ping, -h, localhost]
-      timeout: 15s
-    image: mariadb:10.3
-    networks:
-      mesh_net:
+      MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
     volumes:
       - mariadb_data:/var/lib/mysql
       - ./utils/mariadb/init:/docker-entrypoint-initdb.d
       - ./utils/mariadb/conf:/etc/mysql/conf.d
+    healthcheck:
+      test: mysql -D mysql --silent --execute "SELECT 1;"
+      interval: 30s
+      timeout: 10s
+      retries: 5
+    networks:
+      mesh_net:
   mongodb:
     command: --replSet api0 --bind_ip_all
     environment:
@@ -154,6 +157,19 @@ services:
     image: rabbitmq:management
     networks:
       mesh_net:
+  redis-ipdapi:
+    container_name: redis-ipdapi
+    image: redis:6.0.9-alpine
+    healthcheck:
+      test: ['CMD', 'redis-cli', '--raw', 'incr', 'ping']
+      interval: 1s
+      timeout: 5s
+      retries: 30
+    networks:
+      mesh_net:
+    ports:
+      - 6379:6379
+    restart: always
 version: "3.9"
 volumes:
   dcp-mongo:

data/bin/ipdapi-startup.sh

@@ -4,4 +4,4 @@ echo "INIT $(date +%s)" > /var/run/alula/ipdapi-status
 cat scripts/npm | grep -v npm | bash
 node app/migrations.js --create --up
 echo "READY $(date +%s)" >> /var/run/alula/ipdapi-status
-npm start
+exec node app/main.js

data/lib/alula/api_operations/save.rb

@@ -13,6 +13,7 @@ module Alula
               attributes: as_patchable_json
             }
           }
+          payload[:data].delete(:id) if video_request?(resource_url)
 
           response = Alula::Client.request(:patch, resource_url, payload, {})
 
@@ -79,6 +80,10 @@ module Alula
             raise Alula::UnknownError, "Unknown HTTP response code, aborting. Code: #{response.http_status}"
           end
         end
+
+        def video_request?(resource_path)
+          resource_path.match(%r{^/video})
+        end
       end
     end
   end

data/lib/alula/client.rb

@@ -7,7 +7,7 @@ module Alula
     class << self
       DEFAULT_CUSTOM_OPTIONS = {
         omitRelationships: true
-      }
+      }.freeze
 
       def config
         @_config ||= Alula::ClientConfiguration.new
@@ -18,13 +18,13 @@ module Alula
       end
 
       def request(http_method, resource_path, filters = {}, opts = {})
-        unless resource_path.match(%r{^/public/v1})
-          validate_request!(http_method, resource_path)
-        end
-
+        validate_request!(http_method, resource_path) unless resource_path.match(%r{^/public/v1})
         request_opts = build_options(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
+
         # TODO: Handle network failures
-        response = make_request(http_method, config.api_url + resource_path, request_opts)
+        response = make_request(http_method, api_url + request_resource_path, request_opts)
 
         begin
           resp = AlulaResponse.from_httparty_response(response)
@@ -41,7 +41,11 @@ module Alula
       def validate_request!(http_method, resource_path)
         config.ensure_api_key_set
         config.ensure_api_url_set
-        config.ensure_customer_id_set if resource_path.match(%r{^/video})
+        if video_request?(resource_path)
+          config.ensure_video_api_url_set
+          config.ensure_video_api_key_set
+          config.ensure_customer_id_set
+        end
         ensure_method_allowable(http_method)
         config.ensure_role_set if %i[patch post put].include? http_method
       end
@@ -51,9 +55,13 @@ module Alula
       end
 
       def ensure_method_allowable(http_method)
-        unless %i[get post put patch delete].include?(http_method)
-          raise "Unable to send a request with #{http_method} http method"
-        end
+        return if %i[get post put patch delete].include?(http_method)
+
+        raise "Unable to send a request with #{http_method} http method"
+      end
+
+      def video_request?(resource_path)
+        resource_path.match(%r{^/video})
       end
 
       def build_options(http_method, resource_path, filters = {}, opts = {})
@@ -63,6 +71,7 @@ module Alula
             'User-Agent': "#{Alula::Client.config.user_agent || 'No Agent Set'}/alula-ruby v#{Alula::VERSION}"
           }
         }.merge(opts)
+        handle_video_request(request_opts) if video_request?(resource_path) # Add token for all video requests
 
         request_opts[:headers]['Content-Type'] = 'application/json' unless opts[:multipart]
         case http_method
@@ -70,11 +79,7 @@ module Alula
              :post
           request_opts[:body] = opts[:multipart] ? filters : JSON.generate(filters)
         when :get
-          if resource_path.match(%r{^/(rest|rpc)})
-            request_opts = request_opts.merge build_rest_options(filters)
-          elsif resource_path.match(%r{^/video})
-            add_customer_id(request_opts)
-          end
+          request_opts = request_opts.merge build_rest_options(filters) if resource_path.match(%r{^/(rest|rpc)})
         when :delete
           # Nothing special
         end
@@ -111,8 +116,17 @@ module Alula
         filters
       end
 
-      def add_customer_id(request_opts)
-        request_opts[:query] = { 'customerId' => config.customer_id }
+      def handle_video_request(request_opts)
+        if Alula::Client.config.internal
+          set_token(request_opts, { internal: true })
+        else
+          set_token(request_opts, { customerId: Alula::Client.config.customer_id })
+        end
+      end
+
+      def set_token(request_opts, payload)
+        jwt = TokenExchange.fetch_video_token(payload)
+        request_opts[:headers]['token'] = jwt
       end
     end
   end

data/lib/alula/client_configuration.rb

@@ -1,7 +1,7 @@
 module Alula
   class ClientConfiguration
-    attr_accessor :api_url, :debug, :user_agent
-    REQUEST_ATTRIBUTES = %i[api_key customer_id]
+    attr_accessor :api_url, :video_api_url, :debug, :user_agent
+    REQUEST_ATTRIBUTES = %i[api_key video_api_key customer_id internal]
 
     # Using RequestStore so we're thread safe even with our non-thread-safe architecture :(
     REQUEST_ATTRIBUTES.each do |prop|
@@ -42,11 +42,25 @@ module Alula
       end
     end
 
+    def ensure_video_api_url_set
+      return unless video_api_url.nil?
+
+      raise Alula::NotConfiguredError,
+            'did you forget to set the Alula::Client.config.video_api_url config option?'
+    end
+
+    def ensure_video_api_key_set
+      return if video_api_key
+
+      raise Alula::NotConfiguredError,
+            'Set your video API access token before making requests to the video API'
+    end
+
     def ensure_customer_id_set
-      unless customer_id
-        raise Alula::NotConfiguredError,
-              'Set your customer_id before making requests to the video API'
-      end
+      return if internal || customer_id
+
+      raise Alula::NotConfiguredError,
+            'Set your customer_id before making requests to the video API'
     end
 
     def ensure_role_set

data/lib/alula/errors.rb

@@ -87,6 +87,8 @@ module Alula
           NotFoundError.new(message)
         when 'Device Not Found'
           NotFoundError.new(message)
+        when 'Unable to unregister device'
+          NotFoundError.new(message)
         else
           Alula.logger.error response
           raise NotImplementedError, "Unable to derive error for #{response.data['error'].to_json}"
@@ -128,6 +130,8 @@ module Alula
           NotFoundError.new(message)
         when 'Device Not Found'
           NotFoundError.new(message)
+        when 'Unable to unregister device'
+          NotFoundError.new(message)
         else
           Alula.logger.error response
           raise NotImplementedError, "Unable to derive error for #{response.data['errors'].to_json}"

data/lib/alula/helpers/jwt_helper.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+require 'base64'
+require 'openssl'
+
+module Alula
+  # Helper class to build JWT tokens
+  # Used for internal video API calls or video API calls with a customer ID
+  module JwtHelper
+    ONE_HOUR = 60 * 60
+    class << self
+      def build_jwt_token(jwt_payload)
+        jwt_secret = Alula::Client.config.video_api_key
+
+        header = build_jwt_header
+
+        token_data = add_timestamp_to_payload(jwt_payload)
+
+        encoded_header = convert_to_base64(JSON.generate(header))
+        encoded_data = convert_to_base64(JSON.generate(token_data))
+
+        token = "#{encoded_header}.#{encoded_data}"
+        signature = sign_token(token, jwt_secret)
+
+        "#{token}.#{signature}"
+      end
+
+      def build_jwt_header
+        {
+          'typ' => 'JWT',
+          'alg' => 'HS256'
+        }
+      end
+
+      def add_timestamp_to_payload(payload)
+        current_timestamp = Time.now.to_i
+        payload.merge(
+          {
+            'iat' => current_timestamp,
+            'exp' => current_timestamp + ONE_HOUR # expiry time is 60 minutes from time of creation
+          }
+        )
+      end
+
+      def sign_token(token, secret)
+        signature = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), secret, token)
+        convert_to_base64(signature)
+      end
+
+      def convert_to_base64(source)
+        # Encode in classical base64,
+        encoded_source = Base64.strict_encode64(source)
+
+        # Remove padding equal characters,
+        encoded_source = encoded_source.gsub('=', '')
+
+        # Replace characters according to base64url specifications,
+        encoded_source.tr('+/', '-_')
+      end
+    end
+  end
+end

data/lib/alula/procedures/video_unregister_proc.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Alula
+  class VideoUnregisterProc < Alula::RpcResource
+    class Response < Alula::RpcResponse
+    end
+
+    def self.call(device_id:)
+      payload = {
+        deviceId: device_id
+      }
+
+      request(
+        http_method: :post,
+        path: '/rpc/v1/video/unregister',
+        payload: payload,
+        handler: Response
+      )
+    end
+  end
+end

data/lib/alula/resources/token_exchange.rb

@@ -1,17 +1,65 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/jwt_helper'
+
 module Alula
+  # Helper class to generate OAuth access tokens (core API) and JWT tokens (VSP API)
   class TokenExchange
-    def self.token_for_user(user_id)
-      url = '/rest/v1/oauth/accesstokens'
-      payload = { data: { attributes: { userId: user_id } } }
-      opts = {}
-
-      response = Alula::Client.request(:post, url, payload, opts)
-
-      if response.ok?
-        ImpersonatedToken.new(response.data['data']['attributes'])
-      else
-        error_class = AlulaError.for_response(response)
-        raise error_class
+    class << self
+      def token_for_user(user_id)
+        url = '/rest/v1/oauth/accesstokens'
+        payload = { data: { attributes: { userId: user_id } } }
+        opts = {}
+
+        response = Alula::Client.request(:post, url, payload, opts)
+
+        if response.ok?
+          ImpersonatedToken.new(response.data['data']['attributes'])
+        else
+          error_class = AlulaError.for_response(response)
+          raise error_class
+        end
+      end
+
+      def fetch_video_token(payload)
+        cache_key = generate_cache_key(payload)
+        cached_token, expiry = retrieve_cached_token(cache_key)
+
+        if cached_token && Time.now.to_i < expiry
+          jwt_token = cached_token
+        else
+          jwt_token = build_jwt_token(payload)
+          expiry = Time.now.to_i + JwtHelper::ONE_HOUR # 1 hour expiry
+          store_token_in_cache(cache_key, jwt_token, expiry)
+        end
+
+        jwt_token
+      end
+
+      private
+
+      def build_jwt_token(payload)
+        JwtHelper.build_jwt_token(payload)
+      end
+
+      def store_token_in_cache(cache_key, jwt_token, expiry)
+        @token_cache ||= {}
+        @token_cache[cache_key] = [jwt_token, expiry]
+      end
+
+      def retrieve_cached_token(cache_key)
+        @token_cache ||= {}
+        @token_cache[cache_key]
+      end
+
+      def generate_cache_key(payload)
+        if payload[:internal]
+          'jwt_token_internal'
+        elsif payload[:customerId]
+          "jwt_token_customer_#{payload[:customerId]}"
+        else
+          raise ArgumentError, 'Invalid payload'
+        end
       end
     end
 

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

@@ -32,6 +32,11 @@ module Alula
 
       api_name :video
 
+      # Instance method
+      def resource_url(id = self.id)
+        "/#{self.class.api_name}/v1/#{self.class.resource_name}/#{id}"
+      end
+
       def construct_from(json_object)
         @raw_data = json_object.dup
         @values = json_object

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

@@ -2,15 +2,88 @@ module Alula
   module Video
     class Device < Alula::Video::BaseResource
       extend Alula::ApiOperations::Request
+      extend Alula::ApiOperations::Save
+      extend Alula::ApiOperations::Delete
 
-      field :account_id, type: :string
-      field :active, type: :boolean
-      field :brand, type: :string
-      field :hardware_id, type: :string
-      field :manufacturer, type: :string
-      field :name, type: :string
-      field :serial_number, type: :string
-      field :verification_code, type: :string
+      field :account_id,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :active,
+            type: :boolean,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :brand,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :hardware_id,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :manufacturer,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :name,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :serial_number,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :verification_code,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :timezone,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :timezone_id,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :daylight_saving,
+            type: :number,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :time_format,
+            type: :number,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :customer_id,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :online,
+            type: :object,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :settings,
+            type: :object,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
+
+      field :model,
+            type: :string,
+            patchable_by: %i[system station dealer user],
+            creatable_by: %i[system station dealer user]
 
       def is_jsw?
         manufacturer == 'jsw'

data/lib/alula/version.rb

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

data/lib/alula.rb

@@ -94,6 +94,7 @@ require_relative 'alula/procedures/user_plansvideo_price_get'
 require_relative 'alula/procedures/user_get_locked_proc'
 require_relative 'alula/procedures/user_unlock_proc'
 require_relative 'alula/procedures/user_password_reset_proc'
+require_relative 'alula/procedures/video_unregister_proc'
 
 module Alula
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alula-ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Titus Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -210,6 +210,7 @@ files:
 - lib/alula/errors.rb
 - lib/alula/filter_builder.rb
 - lib/alula/helpers/device_attribute_translations.rb
+- lib/alula/helpers/jwt_helper.rb
 - lib/alula/list_object.rb
 - lib/alula/meta.rb
 - lib/alula/monkey_patches.rb
@@ -240,6 +241,7 @@ files:
 - lib/alula/procedures/user_transfer_reject.rb
 - lib/alula/procedures/user_transfer_request.rb
 - lib/alula/procedures/user_unlock_proc.rb
+- lib/alula/procedures/video_unregister_proc.rb
 - lib/alula/query_interface.rb
 - lib/alula/rate_limit.rb
 - lib/alula/relationship_attributes.rb