alula-ruby 0.50.1

data/lib/alula/resources/user.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+module Alula
+  class User < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+
+    resource_path 'users'
+    type 'users'
+
+    relationship :devices, type: 'devices', 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'
+    relationship :pushtokens, type: 'users-pushtokens', cardinality: 'To-many'
+    relationship :preferences, type: 'users-preferences', cardinality: 'To-one'
+    relationship :videoprofiles, type: 'users-videoprofiles', cardinality: 'To-many'
+
+    # 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: [],
+          patchable_by: []
+
+    field :username,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :password,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: []
+
+    field :u_type,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: []
+
+    field :user_type,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: [],
+          symbolize: true
+
+    field :u_level,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :parent_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: []
+
+    field :dealer_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: []
+
+    field :station_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+
+    field :last_login,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :date_entered,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+
+    field :date_modified,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+
+    field :entered_by,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :modified_by,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :pwch,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :features_selected,
+          type: :object,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system station dealer technician],
+          patchable_by: %i[system station dealer technician]
+
+    field :eula,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :def_mod,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :rg_activated,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :company_name,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :name_first,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :name_last,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :email,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    field :time_offset,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+
+    field :timezone,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: %i[system station dealer technician user sub_user]
+
+    def user_role
+      # pre-alula api users will be u_type 32, newer ones are 96. need to differentiate
+      # between account users and account owners by checking if they own themselves
+      {
+        2 => :system,
+        4 => :station,
+        8 => :dealer,
+        16 => :technician,
+        32 => :user,
+        64 => :sub_user,
+        96 => :account_user,
+        320 => :local_access_user
+      }[(u_type == 96 && parent_id == id ? 32 : u_type)]
+    end
+
+    def user_role_name
+      {
+        system: 'System',
+        station: 'Station',
+        dealer: 'Dealer',
+        technician: 'Technician',
+        user: 'Account Owner',
+        sub_user: 'Sub-User',
+        account_user: 'Account User',
+        local_access_user: 'Local Access User'
+      }[user_role]
+    end
+  end
+end

data/lib/alula/resources/user_address.rb

@@ -0,0 +1,121 @@
+##
+# Create, view, and configure users’ and sub-users’ address contact information.
+module Alula
+  class UserAddress < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+
+    # You should update this to be a slash-separated, literal path to the resource
+    # without the prefix /api/v1 or the suffix of an ID
+    resource_path 'users/addresses'
+    type 'users-addresses'
+
+    # Relationships
+    relationship :user, type: 'users', 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: [],
+          patchable_by: []
+
+    field :username,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+
+    field :address1,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :address2,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :st_number,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :st_name,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :st_direction,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :city,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :state,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :zip_code,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :country,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :time_offset,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :timezone,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :company_name,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+  end
+end

data/lib/alula/resources/user_phone.rb

@@ -0,0 +1,116 @@
+module Alula
+  class UserPhone < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+
+    resource_path 'users/phones'
+    type 'users-phones'
+
+    # Relationships
+    # None
+
+    # 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: [],
+          patchable_by: []
+
+    field :username,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+
+    field :phone_pri_contact,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :phone_pri_ct,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :phone_sec_contact,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :phone_sec_ct,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :contact_type,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :co_ph_pri,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :co_ph_sec,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :co_ph_sales,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :co_ph_service,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :co_ph_billing,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :cell_text,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :company_name,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+  end
+end

data/lib/alula/resources/user_preferences.rb

@@ -0,0 +1,57 @@
+module Alula
+  # The Generic Preferences for a User
+  class UserPreferences < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+
+    resource_path 'users/preferences'
+    type 'users-preferences'
+
+    # 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: [],
+          patchable_by: []
+
+    field :user_id,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+
+    field :key,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :value,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :data,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+
+    field :inherited,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user, :subuser]
+  end
+end

data/lib/alula/resources/user_pushtoken.rb

@@ -0,0 +1,75 @@
+# The Push Tokens for a User
+module Alula
+  # The Push Tokens for a User
+  class UserPushtoken < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+
+    resource_path 'users/pushtokens'
+    type 'users-pushtokens'
+
+    # Relationships
+    relationship :user, type: :users, 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: %i[system user subuser],
+          patchable_by: []
+
+    field :user_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: %i[system user subuser],
+          patchable_by: []
+
+    field :key,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: %i[system user subuser],
+          patchable_by: %i[system user subuser]
+
+    field :type,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: %i[system user subuser],
+          patchable_by: %i[system user subuser]
+
+    field :version,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: %i[system user subuser],
+          patchable_by: %i[system user subuser]
+
+    field :video,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system user subuser],
+          patchable_by: %i[system user subuser]
+
+    field :doorbell,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system user subuser],
+          patchable_by: %i[system user subuser]
+
+    field :security,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: %i[system user subuser],
+          patchable_by: %i[system user subuser]
+  end
+end

data/lib/alula/resources/user_videoprofile.rb

@@ -0,0 +1,38 @@
+module Alula
+  class UserVideoProfile < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+
+    resource_path 'users/videoprofiles'
+    type 'users-videoprofiles'
+
+    relationship :user, type: :users, 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: [],
+          patchable_by: []
+
+    field :camera_plan_count,
+          type: :number,
+          sortable: true,
+          filterable: false,
+          creatable_by: [:system, :station, :dealer, :technician],
+          patchable_by: [:system, :station, :dealer, :technician]
+
+    field :clip_plan_count,
+          type: :number,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:system, :station, :dealer, :technician],
+          patchable_by: [:system, :station, :dealer, :technician]
+  end
+end

data/lib/alula/rest_resource.rb

@@ -0,0 +1,17 @@
+module Alula
+  class RestResource < ApiResource
+    # TODO: Not sure if the period replace is applicatble to our use
+    #       determine as we add child resources
+    def self.resource_url(id = nil)
+      if self == RestResource
+        raise NotImplementedError, "Cannot call resource_url on a RestResource. Try using Device or Customer instead."
+      end
+      "/rest/v1/#{self.get_resource_path(id)}"
+    end
+
+    def resource_url(param_id = nil)
+      our_id = [id, param_id].compact.first
+      self.class.resource_url(our_id)
+    end
+  end
+end

data/lib/alula/rpc_resource.rb

@@ -0,0 +1,40 @@
+module Alula
+  class RpcResource
+    def self.request(http_method:, path:, payload:, handler:, wrap: true, opts: {})
+      response = Alula::Client.request(http_method, path, wrap ? wrap_payload(payload) : payload, opts)
+
+      unless response.ok? && ok?(response)
+        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
+
+      handler.new(response)
+    end
+
+    ##
+    # RPC endpoints tend to return a 200 OK even if the response failed. Examine
+    # the response body to determine if there was an error.
+    def self.ok?(response)
+      error = response.data['error'] && !response.data['error'].empty?
+      errors = response.data['errors'] && !response.data['errors'].empty?
+
+      !(error || errors)
+    end
+
+    def self.wrap_payload(payload)
+      {
+        id: SecureRandom.uuid,
+        jsonrpc: '2.0',
+        params: payload
+      }
+    end
+  end
+end