alula-ruby 0.54.0 → 0.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fe8c069cbf129ad7f52be697c4159cad1e78ef655316eae5ee26de2e184a8df
-  data.tar.gz: cdcda384977cae4869f73892f8a0f309f2965be5b180b56500f0453dc1da27df
+  metadata.gz: 74c4d19ef1d5c29584d0cc44323a1fbf63fe80d5ab6eacfc09c78f1316511caf
+  data.tar.gz: ba207cd8c9f29e07a564c561da49e36650d98ff19ee043bbcfbe4e468b181481
 SHA512:
-  metadata.gz: 7ff734d5a1ab9e49a77262d7f7b8aa05676bb526e123351f89dc4e6984f1b842fbb6b69502e8d54ddf0fb384d722d0fd23d02d0c1d052ccbc0a79bd16fd6feaf
-  data.tar.gz: b7cdcdeb6fd33066c52b8cd1f6a4ba274bfa4c793f14cc6165b547da5e32110d112135156c370d8aaf3a782e25f7c9406904697b4847730fd6c1387e99fea6c4
+  metadata.gz: a702cb33c8448b1be68e4b5046fb7b54f878b8d1b23bb77db03953e3a785d43bfc054f10895c6a63bb2c45aa02a5bbd1b24ba90a625a4cf7510417ffb3e39f1b
+  data.tar.gz: d1095d24d4c0cf1de9297ea32c796b1edc6f9df0bd1165cae6a4bc890f06ebb3e08a560a75292b28613d385990d1bcf409f438593dff1aafce132acec3ac3c26

data/.rspec

@@ -1,3 +1 @@
---format documentation
---color
 --require spec_helper

data/README.md

@@ -40,21 +40,23 @@ creds = Alula::Oauth.authenticate(username: "a username", password: "a password"
 ```
 
 ## Configuring
-
+There are two types of settings in the `Alula::Client` configuration:
+The first one are the ones that will have a fixed value in the application lifecicle so its better to put them in an initializer.
 ```ruby
-Alula::Client.config.api_key = your API key
-Alula::Client.config.api_url = The environment URL you will be accessing
-Alula::Client.config.user_agent = A short name for your script/application
+Alula::Client.configure do |c|
+  c.api_key = # your API key
+  c.debug = # if set to true will log requests to the API
+  c.user_agent = # A short name for your script/application
+end
 ```
--or-
+The second one are the ones that are stored in the request Rack env, so those need to set on each request (to the application).
 ```ruby
 Alula::Client.configure do |d|
-  c.api_key = your API key
-  c.api_url = The environment URL you will be accessing
-  c.user_agent = A short name for your script/application
+  c.api_key = # your API key
+  c.role = # User/Customer role
+  c.customer_id = # The user_id, optional, only for video API requests
 end
 ```
-**Note:** You will also need to add the configuration option `customer_id` to access resources of the video API.
 
 ## Usage
 

data/VERSION.md

@@ -86,3 +86,6 @@
 | v0.52.0 | 2022-06-15  | Filter receiver connections based on station id |
 | v0.53.0 | 2022-06-15  | Filter feature plans on name |
 | v0.54.0 | 2022-06-21  | Add support for devices from the video API |
+| v0.55.0 | 2022-06-25  | Add some devices helpers and improves specs |
+| v0.56.0 | 2022-07-08  | Add save! that raises an exception |
+| v0.57.0 | 2022-07-19  | Add Alula Messenger to device object |

data/lib/alula/api_operations/save.rb

@@ -24,6 +24,10 @@ module Alula
           handle_errors(response)
         end
 
+        def save!
+          save || raise(ValidationError.new(self.errors))
+        end
+
         def create
           data = {
             attributes: as_patchable_json
@@ -78,4 +82,4 @@ module Alula
       end
     end
   end
-end
+end

data/lib/alula/client.rb

@@ -14,7 +14,7 @@ module Alula
       end
 
       def configure
-        yield config
+        yield config if block_given?
       end
 
       def request(http_method, resource_path, filters = {}, opts = {})

data/lib/alula/client_configuration.rb

@@ -1,6 +1,7 @@
 module Alula
   class ClientConfiguration
-    REQUEST_ATTRIBUTES = %i[api_key api_url debug customer_id user_agent]
+    attr_accessor :api_url, :debug, :user_agent
+    REQUEST_ATTRIBUTES = %i[api_key customer_id]
 
     # Using RequestStore so we're thread safe even with our non-thread-safe architecture :(
     REQUEST_ATTRIBUTES.each do |prop|

data/lib/alula/errors.rb

@@ -166,4 +166,12 @@ module Alula
       false
     end
   end
+
+  class ValidationError < AlulaError
+    attr_reader :errors
+
+    def initialize(errors)
+      @errors = errors
+    end
+  end
 end

data/lib/alula/resources/device.rb

@@ -712,5 +712,12 @@ module Alula
           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/video/base_resource.rb

@@ -31,6 +31,21 @@ module Alula
       end
 
       api_name :video
+
+      def construct_from(json_object)
+        @raw_data = json_object.dup
+        @values = json_object
+
+        self.id = json_object['id'] unless [nil, ''].include?(json_object['id'])
+
+        @dirty_attributes = Set.new
+        @errors = ModelErrors.new(self.class)
+
+        @related_models = {}
+        cache_links(json_object['relationships'] || {})
+
+        self
+      end
     end
   end
 end

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

@@ -11,6 +11,14 @@ module Alula
       field :name, type: :string
       field :serial_number, type: :string
       field :verification_code, type: :string
+
+      def is_jsw?
+        manufacturer == 'jsw'
+      end
+
+      def is_hik?
+        manufacturer == 'hikvision'
+      end
     end
   end
 end

data/lib/alula/version.rb

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

data/lib/alula.rb

@@ -130,10 +130,10 @@ module Alula
   end
 
   def self.logger
-    RequestStore.store['logger'] ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    @@logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
   end
 
   def self.logger=(logger)
-    RequestStore.store['logger'] = logger
+    @@logger = logger
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alula-ruby
 version: !ruby/object:Gem::Version
-  version: 0.54.0
+  version: 0.57.0
 platform: ruby
 authors:
 - Titus Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty