alula-ruby 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f16a5d5af860eb10eb005fd515b1f3a5c14054c10f893399311fa265288da01e
-  data.tar.gz: 31e9bc85d0883308067b14df4b199813f19eb67a039474bcb263d79a4dc9381d
+  metadata.gz: 546e50f62f86038f53f08d44774263b5adce9d74b5ea2fa4d2795195e3f93877
+  data.tar.gz: ad18a4e2275bc8811c89c5d1ae00514757e6e39808fe9d8176847f6b85779bf7
 SHA512:
-  metadata.gz: bea969dc3209e921a2e3f011a9e5186713274ab6071666b4a03ba4f77eeaabd5cf6102f7053fe2e82afdb09c28301dd2313fc6aadec1627dd5deadde5472ec30
-  data.tar.gz: 0fba4a8346c91cb940c98739263cba2d73121b8c3045bf49716c1b440b98b7917357ec6fd3a37263b8afafa30c65210f7e50bdd644d089de7428747c4169665a
+  metadata.gz: a19f8278b5db084bfae605d419bac5511cc6a0e260c985f002ed8827bad68d27658ee59e9faf2dc33fe9d301eee270ccb8cf83dd85c8a134a5c0edbcf058f59a
+  data.tar.gz: 5803162edb7262f6f56e155503d13bd4b77036b02de069fabc6f37a0e622a92e7c3c40c73fbdf96b32696e5e4174b58cecd658f8271120e1004956e1020f7680

data/README.md

@@ -386,7 +386,22 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Alula Ruby runs its unit & integratin tests against a copy of the API running in Docker. The remote API is cleaned up (DB truncated & re-seeded fresh) between every `describe` or `context` block.
 
-1. Set up local Core API cluster/swarm using `make`:
+1.  Authenticate with AWS
+
+    Set the registry account number to refer to
+
+    ```bash
+    export AWS_ECR_REGISTRY_ID=613707345027 #409473619697
+    ```
+
+    Then execute AWS login where the `$env` is whatever profile name your Shared Services account is setup under in AWS CLI SSO.
+
+    ```bash
+    aws ecr get-login-password --profile $env | docker login \
+      --username AWS --password-stdin $AWS_ECR_REGISTRY_ID.dkr.ecr.$AWS_REGION.amazonaws.com
+    ```
+
+2.  Set up local Core API cluster/swarm using `make`:
 
         make up
 
@@ -394,29 +409,37 @@ Alula Ruby runs its unit & integratin tests against a copy of the API running in
 
         alula-docker-compose -I @test-helper --registry '6z1wlx5zf1.execute-api.us-east-1.amazonaws.com/' -- up -d
 
-    Note: You do need to be authorized against our private ECR registry. This is manual, talk with an Alula Lead to get pointed in the right direction. TODO: Write out what we need to do for this.
+Note: You do need to be authorized against our private ECR registry. This is manual, talk with an Alula Lead to get pointed in the right direction. TODO: Write out what we need to do for this.
 
-1. Configure your local .env file, you can copy-paste `.env.example` over to `.env`
+1.  Configure your local .env file, you can copy-paste `.env.example` over to `.env`
 
-1. Run the complete test suite:
+1.  Run the complete test suite:
 
-       `bundle exec rspec`
+    `bundle exec rspec`
 
-1. Run a specific test file:
+1.  Run a specific test file:
 
         `bundle exec rspec ./spec/alula/oauth_spec.rb`
 
-1. Run Guard to have tests run on file change
+1.  Run Guard to have tests run on file change
 
         `bundle exec guard`
 
-1. Update all Docker images to the latest images:
+1.  If you're using the Ruby Test Explorer extension to run the tests within VS Code, SimpleCov has a dry run error preventing auto detection. You need to turn off minimum coverage to get the dry run command it uses to find tests to work.
+
+    ```ruby
+    SimpleCov.start do
+      add_filter '/spec/'
+      minimum_coverage 0
+    end
+    ```
+
+1.  Update all Docker images to the latest images:
 
     `docker compose -f alula-docker-compose.yml pull`
 
 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`
 
-
 ## 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,10 +2,12 @@
 
 | Version | Date      | Description                                                                 |
 | ------- | --------- | --------------------------------------------------------------------------- |
-| v1.1.0  | 2023-08-01 | Fixes Ruby 3 argument errors in filter builder. Gets test suite running again in circle |
-| v1.0.2  | 2023-05-30 | Includes v0.69.11 - fix for a field not being underscoreable |
-| v1.0.1  | 2023-05-30 | Includes v0.69.10 |
-| v1.0.0  | 2023-05-30 | Ruby 3 support with some breaking changes |
+| v1.2.1  | 2023-08-17  | Fix types on OAuth clients         |
+| v1.2.0  | 2023-08-10  | Support objects and saving to objects natively         |
+| v1.1.0  | 2023-08-01  | Fixes Ruby 3 argument errors in filter builder. Gets test suite running again in circle |
+| v1.0.2  | 2023-05-30  | Includes v0.69.11 - fix for a field not being underscoreable |
+| v1.0.1  | 2023-05-30  | Includes v0.69.10 |
+| v1.0.0  | 2023-05-30  | Ruby 3 support with some breaking changes |
 | v0.69.10| 2023-06-14  | Dealer phone relationship |
 | v0.69.9 | 2023-04-18  | Dealer Program resource update |
 | v0.69.8 | 2023-03-29  | Use isCamera and isPanel API fields |

data/lib/alula/api_resource.rb

@@ -99,6 +99,8 @@ module Alula
           else
             obj[key] = val.to_s
           end
+        elsif val.is_a? Alula::ObjectField
+          obj[key] = val.as_json
         else
           obj[key] = val
         end

data/lib/alula/filter_builder.rb

@@ -182,16 +182,28 @@ module Alula
     # Transform the field name into an API-valid lowerCamelCase
     # format and return it.
     def validate_field_filterability!(field_name)
+
+      # Use the parent of a features_selected.alarm_transmission (features_selected) to check filterability
       underscored = Util.underscore(field_name).to_sym
+      mod_field_name = underscored.to_s.split('.')[0].to_sym
+
+      # Used to save the actual where, so we don't use the parent object here
       camelized   = Util.camelize(underscored).to_s
 
-      unless model_class.get_fields.include?(underscored)
-        error = "Field `#{underscored}` does not exist resource `#{model_class}`"
+      unless model_class.get_fields.include?(mod_field_name)
+        error = "Field `#{mod_field_name}` does not exist resource `#{model_class}`"
+        raise Alula::InvalidFilterFieldError.new(error)
+      end
+
+      unless model_class.filterable_fields.include?(mod_field_name)
+        error = "Field `#{mod_field_name}` is not filterable on resource `#{model_class}`"
         raise Alula::InvalidFilterFieldError.new(error)
       end
 
-      unless model_class.filterable_fields.include?(underscored)
-        error = "Field `#{underscored}` is not filterable on resource `#{model_class}`"
+      # Make sure that we are filtering on the actual field name, not the parent
+      field_settings = model_class.get_fields[mod_field_name]
+      if field_settings[:type] == :object && field_settings[:use] && underscored.to_s.split('.').length == 1
+        error = "Field `#{mod_field_name}` is not filterable on resource `#{model_class}`. Please specify child property"
         raise Alula::InvalidFilterFieldError.new(error)
       end
 
@@ -203,16 +215,28 @@ module Alula
     # Transform the field name into an API-validated lowerCamelCase
     # TODO: This doesn't belong here, should be on its own include I think
     def validate_field_sortability!(field_name)
+
+      # Use the parent of a features_selected.alarm_transmission (features_selected) to check sortability
       underscored = Util.underscore(field_name).to_sym
+      mod_field_name = underscored.to_s.split('.')[0].to_sym
+
+      # Used to save the actual where, so we don't use the parent object here
       camelized   = Util.camelize(underscored).to_s
 
-      unless model_class.get_fields.include?(underscored)
-        error = "Field `#{underscored}` does not exist resource `#{model_class}`"
-        raise Alula::InvalidFilterFieldError.new(error)
+      unless model_class.get_fields.include?(mod_field_name)
+        error = "Field `#{mod_field_name}` does not exist resource `#{model_class}`"
+        raise Alula::InvalidSortFieldError.new(error)
       end
 
-      unless model_class.sortable_fields.include?(underscored)
-        error = "Field `#{underscored}` is not sortable on resource `#{model_class}`"
+      unless model_class.sortable_fields.include?(mod_field_name)
+        error = "Field `#{mod_field_name}` is not sortable on resource `#{model_class}`"
+        raise Alula::InvalidSortFieldError.new(error)
+      end
+      
+      # Make sure that we are sorting on the actual field name, not the parent
+      field_settings = model_class.get_fields[mod_field_name] 
+      if field_settings[:type] == :object && field_settings[:use] && underscored.to_s.split('.').length == 1
+        error = "Field `#{mod_field_name}` is not sortable on resource `#{model_class}`. Please specify child property"
         raise Alula::InvalidSortFieldError.new(error)
       end
 

data/lib/alula/resource_attributes.rb

@@ -7,6 +7,10 @@ module Alula
         @type = nil
         @http_methods = []
         @fields = {}
+
+        def mark_dirty(field_name, old_value, new_value)
+          @dirty_attributes << field_name if old_value != new_value
+        end
       end
       base.include(InstanceMethods)
     end
@@ -60,6 +64,8 @@ module Alula
             rescue ArgumentError
               value
             end
+          elsif opts[:type] == :object && opts[:use] && !value.nil? && value.respond_to?(:each)
+            opts[:use].new(@dirty_attributes, field_name, value)
           elsif opts[:type] == :boolean
             [true, 'true', 1, '1'].include? value
           elsif opts[:symbolize] == true
@@ -87,16 +93,12 @@ module Alula
             new_value = [true, 'true', 1, '1'].include? new_value
           end
 
-          #
           # Mark the attribute as dirty if the new value is different
-          @dirty_attributes << field_name if @values[jsonKey] != new_value
-
+          mark_dirty(field_name, @values[jsonKey], new_value)
           #
           # Assign the new value (always assigned even if a duplicate)
           @values[jsonKey] = new_value
         end
-
-
       end
     end
 
@@ -200,4 +202,47 @@ module Alula
       end
     end
   end
+
+  class ObjectField
+    extend ResourceAttributes
+
+    # Assume properties is camel case
+    def initialize(dirty_attributes, parent_field, properties = {})
+      @values = properties
+      @parent_dirty_attributes = dirty_attributes
+      @parent_field = parent_field
+      # Not used, just to make resource attributes happy
+      @dirty_attributes = Set.new
+
+      return unless properties
+      valid_fields = self.class.get_fields
+
+      properties.dup.each do |key, value|
+        jsonKey = key;
+        ruby_key = Alula::Util.underscore(key.to_s)
+
+        self.public_send("#{ruby_key}=", value) if valid_fields.key?(ruby_key.to_sym)
+      end
+    end
+    def mark_dirty(field_name, old_value, new_value)
+      @parent_dirty_attributes << @parent_field if old_value != new_value
+    end
+
+    def as_json
+      self.field_names.each_with_object({}) do |ruby_key, obj|
+        key      = Util.camelize(ruby_key)
+        val = self.send(ruby_key)
+
+        if self.date_fields.include?(ruby_key) && ![nil, ''].include?(val)
+          if val.respond_to? :strftime
+            obj[key] = val.strftime('%Y-%m-%dT%H:%M:%S.%L%z')
+          else
+            obj[key] = val.to_s
+          end
+        else
+          obj[key] = val
+        end
+      end
+    end
+  end
 end

data/lib/alula/resources/device.rb

@@ -7,6 +7,18 @@ module Alula
     extend Alula::ApiOperations::Save
 
     include Alula::DeviceAttributeTranslations
+
+
+    class FeaturesSelected < Alula::ObjectField
+      field :alarm_transmission, type: :boolean
+      field :alarm_notifications, type: :boolean
+      field :interactive_services, type: :boolean
+      field :home_automation, type: :boolean
+      field :two_way_voice, type: :boolean
+      field :vigilance, type: :boolean
+      field :alarm_verification, type: :boolean
+      field :alula_messenger, type: :boolean
+     end
     
     resource_path 'devices'
     type 'devices'
@@ -443,9 +455,10 @@ module Alula
     field :features_selected,
           type: :object,
           sortable: false,
-          filterable: false,
+          filterable: true,
           creatable_by: [],
-          patchable_by: []
+          patchable_by: [:system, :station, :dealer, :technician],
+          use: FeaturesSelected
 
     field :any_trouble,
           type: :boolean,
@@ -678,60 +691,5 @@ module Alula
           creatable_by: [],
           patchable_by: []
 
-    field 'features_selected.alarm_transmission'.to_sym,
-          type: :boolean,
-          sortable: false,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
-
-    field 'features_selected.alarm_notifications'.to_sym,
-          type: :boolean,
-          sortable: false,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
-
-    field 'features_selected.interactive_services'.to_sym,
-          type: :boolean,
-          sortable: false,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
-
-    field 'features_selected.home_automation'.to_sym,
-          type: :boolean,
-          sortable: false,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
-
-    field 'features_selected.two_way_voice'.to_sym,
-          type: :boolean,
-          sortable: false,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
-
-    field 'features_selected.vigilance'.to_sym,
-          type: :boolean,
-          sortable: false,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
-
-    field 'features_selected.alarm_verification'.to_sym,
-          type: :boolean,
-          sortable: false,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
-
-    field 'features_selected.alula_messenger'.to_sym,
-          type: :boolean,
-          sortable: false,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
   end
 end

data/lib/alula/resources/oauth_client.rb

@@ -48,14 +48,14 @@ module Alula
           patchable_by: [:system]
     
     field :scope,
-          type: :date,
+          type: :string,
           sortable: false,
           filterable: false,
           creatable_by: [:system],
           patchable_by: [:system]
     
     field :user_id,
-          type: :date,
+          type: :string,
           sortable: false,
           filterable: true,
           creatable_by: [:system],

data/lib/alula/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alula-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Titus Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty