alula-ruby 0.54.0 → 0.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fe8c069cbf129ad7f52be697c4159cad1e78ef655316eae5ee26de2e184a8df
-  data.tar.gz: cdcda384977cae4869f73892f8a0f309f2965be5b180b56500f0453dc1da27df
+  metadata.gz: 7c65ba0c26beba1371c3637219cc8e0177f6b2f75d21d74a1f08173f7ddd9ae4
+  data.tar.gz: f53a3c944df2be8b2db9b6c13caddcf919706de53b38f3c18c7d5621bbb3b48e
 SHA512:
-  metadata.gz: 7ff734d5a1ab9e49a77262d7f7b8aa05676bb526e123351f89dc4e6984f1b842fbb6b69502e8d54ddf0fb384d722d0fd23d02d0c1d052ccbc0a79bd16fd6feaf
-  data.tar.gz: b7cdcdeb6fd33066c52b8cd1f6a4ba274bfa4c793f14cc6165b547da5e32110d112135156c370d8aaf3a782e25f7c9406904697b4847730fd6c1387e99fea6c4
+  metadata.gz: c63fd1baee26d1c821a2787fd7f2ab26ed76292e11c74b6148a1f567b1c25a282d28509d3cd3ed4e8be9b55b4f89dfd1e4374377588af2c59e87179975678387
+  data.tar.gz: 296cde15d36f05120a947fcaaedaf9f8dfe0f95d60bce233178ff84eca65f2c881ab301bf1830594166b8079e445bc3144afc5f2b5147091193014dbdaee397f

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,4 @@
 | 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 |

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/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.55.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.55.0
 platform: ruby
 authors:
 - Titus Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty