alula-ruby 0.52.0 → 0.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d70e6b19a48a6d0f719e2a74afb2de8c5bf5d7f28d6630714f7514207f778587
-  data.tar.gz: 052ee14ef70d6e8d3eaa337093e40380a3a18dbf902f68f274397521f45caf59
+  metadata.gz: 7c65ba0c26beba1371c3637219cc8e0177f6b2f75d21d74a1f08173f7ddd9ae4
+  data.tar.gz: f53a3c944df2be8b2db9b6c13caddcf919706de53b38f3c18c7d5621bbb3b48e
 SHA512:
-  metadata.gz: 16cbb354ab4a5a02e03c6dedd5d83444cbbde95e6d5598ff1a95bb9e2012ce82645bb212c4b92d21e3ee87183e019c0482fbcb0c8eadb6360910a087bbd6c624
-  data.tar.gz: 215a9df71a1f06d44e0aa81274ee5396deb35b722bd898b33160d47cf75bcc521f7c43d2799a6cc24da4cca06816e45caa7f818fe3cba7432738ac3fe4036a89
+  metadata.gz: c63fd1baee26d1c821a2787fd7f2ab26ed76292e11c74b6148a1f567b1c25a282d28509d3cd3ed4e8be9b55b4f89dfd1e4374377588af2c59e87179975678387
+  data.tar.gz: 296cde15d36f05120a947fcaaedaf9f8dfe0f95d60bce233178ff84eca65f2c881ab301bf1830594166b8079e445bc3144afc5f2b5147091193014dbdaee397f

data/.rspec

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

data/README.md

@@ -40,11 +40,22 @@ 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.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
+```
+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.api_key = your API key
-Alula::Client.api_url = The environment URL you will be accessing
-Alula::Client.user_agent = A short name for your script/application
+Alula::Client.configure do |d|
+  c.api_key = # your API key
+  c.role = # User/Customer role
+  c.customer_id = # The user_id, optional, only for video API requests
+end
 ```
 
 ## Usage
@@ -52,7 +63,7 @@ Alula::Client.user_agent = A short name for your script/application
 Once you have obtained an access token, configure the client to use that token. You should perform this initialization at the start of every request, and at the start of any thread that performs work. The Alula-Ruby client uses the `RequestStore` gem to stash its configuration data in `Thread.current`, so keep this limitation in mind.
 
 ```ruby
-Alula::Client.api_key = "your access token"
+Alula::Client.config.api_key = "your access token"
 ```
 
 If you need to save any records, you will also need to tell the `Alula::Client` about your users' authorized role. Depending on the role certain fields may be writeable or protected. You can set your role one of 3 ways:
@@ -61,13 +72,10 @@ If you need to save any records, you will also need to tell the `Alula::Client`
 myself = Alula::Self.retrieve
 
 # The user role is inferred from the Alula::Self object
-Alula::Client.role = myself
+Alula::Client.config.role = myself
 
 # Explicitly set the role via a role symbol
-Alula::Client.role = :dealer
-
-# Explicitly set the role via a u_type integer
-Alula::Client.u_type = 8
+Alula::Client.config.role = :dealer
 ```
 
 Any method will do, you just need to perform one of these prior to attempting to save a resource. Role symbols map to uType resources. The Alula Gem supports the following roles & their corrisponding uType:

data/VERSION.md

@@ -84,3 +84,6 @@
 | v0.50.1 | 2022-03-21  | Publishes gem to Github and Rubygems |
 | v0.51.0 | 2022-03-29  | Be able to delete Device Programs |
 | 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/alula.gemspec

@@ -27,12 +27,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency "httparty", "~> 0.18.1"
   spec.add_dependency 'request_store', '~> 1.0'
 
+  spec.add_development_dependency "activesupport"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "nokogiri", "~> 1.10.3"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "nokogiri", "~> 1.10.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.21.2"
   spec.add_development_dependency "timecop"
 end

data/lib/alula/api_operations/request.rb

@@ -41,4 +41,4 @@ module Alula
       end
     end
   end
-end
+end

data/lib/alula/client.rb

@@ -5,47 +5,24 @@ module Alula
   class Client
     include HTTParty
     class << self
-      # Has pseudo accessors :api_key, :api_url, :user_agent, :debug
       DEFAULT_CUSTOM_OPTIONS = {
         omitRelationships: true
       }
 
-      def request(http_method, resource_path, filters = {}, opts = {})
-        ensure_api_key_set
-        ensure_role_set if %i[patch post put].include? http_method
-        ensure_method_allowable(http_method)
-
-        raise Alula::NotConfiguredError, 'did you forget to set the Alula::Client.api_url config option?' unless api_url
-
-        request_opts = {
-          headers: {
-            'Authorization': "Bearer #{api_key}",
-            'User-Agent': "#{user_agent || 'No Agent Set'}/alula-ruby v#{Alula::VERSION}"
-          }
-        }.merge(opts)
+      def config
+        @_config ||= Alula::ClientConfiguration.new
+      end
 
-        request_opts[:headers]['Content-Type'] = 'application/json' unless opts[:multipart]
-        case http_method
-        when :patch,
-             :post
-          request_opts[:body] = opts[:multipart] ? filters : JSON.generate(filters)
-        when :get
-          if resource_path.match(%r{^/rest})
-            request_opts = request_opts.merge build_rest_options(filters)
-          elsif resource_path.match(%r{^/rpc})
-            request_opts = request_opts.merge build_rest_options(filters)
-          end
-        when :delete
-          # Nothing special
-        end
+      def configure
+        yield config if block_given?
+      end
 
-        if debug == true
-          request_opts[:debug_output] = Alula.logger
-          logger Alula.logger, :info
-        end
+      def request(http_method, resource_path, filters = {}, opts = {})
+        validate_request!(http_method, resource_path)
+        request_opts = build_options(http_method, resource_path, filters, opts)
 
         # TODO: Handle network failures
-        response = make_request(http_method, api_url + resource_path, request_opts)
+        response = make_request(http_method, config.api_url + resource_path, request_opts)
 
         begin
           resp = AlulaResponse.from_httparty_response(response)
@@ -57,62 +34,56 @@ module Alula
         resp
       end
 
-      def make_request(http_method, full_url, request_opts)
-        send(http_method, full_url, request_opts)
-      end
-
-      #
-      # Using RequestStore so we're thread safe even with our non-thread-safe architecture :(
-      %i[api_key api_url user_agent debug].each do |prop|
-        define_method(prop) do
-          RequestStore.store["alula_#{prop}"]
-        end
-
-        define_method("#{prop}=") do |value|
-          RequestStore.store["alula_#{prop}"] = value
-        end
-      end
-
-      #
-      # Stash the user type as a role for us to infer from later
-      # You can set a symbolized role via role = :user, or provide the string userType
-      # We cast to a symbolized role for ease of use in consumers.
-      def role=(user_type)
-        unless user_type.is_a?(Symbol) || user_type.is_a?(String)
-          raise Alula::InvalidRoleError, 'Role must be symbol or string'
-        end
-
-        RequestStore.store['alula_role'] = Util.underscore(user_type).to_sym
-      end
+      private
 
-      def role
-        RequestStore.store['alula_role']
+      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})
+        ensure_method_allowable(http_method)
+        config.ensure_role_set if %i[patch post put].include? http_method
       end
 
-      def ensure_api_key_set
-        if api_key.nil?
-          raise Alula::NotConfiguredError,
-                'Set your API access token before making requests with Alula::Client.api_key = {access_token}'
-        end
+      def make_request(http_method, full_url, request_opts)
+        send(http_method, full_url, request_opts)
       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 in #{self::OBJECT_NAME} class"
+          raise "Unable to send a request with #{http_method} http method"
         end
       end
 
-      def ensure_role_set
-        if role.nil?
-          message = 'User role not configured! You must set '\
-                    'Alula::Client.role '\
-                    'before attempting to save any resources'
+      def build_options(http_method, resource_path, filters = {}, opts = {})
+        request_opts = {
+          headers: {
+            'Authorization': "Bearer #{Alula::Client.config.api_key}",
+            'User-Agent': "#{Alula::Client.config.user_agent || 'No Agent Set'}/alula-ruby v#{Alula::VERSION}"
+          }
+        }.merge(opts)
 
-          raise Alula::NotConfiguredError, message
+        request_opts[:headers]['Content-Type'] = 'application/json' unless opts[:multipart]
+        case http_method
+        when :patch,
+             :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
+        when :delete
+          # Nothing special
         end
-      end
 
-      private
+        if Alula::Client.config.debug
+          request_opts[:debug_output] = Alula.logger
+          logger Alula.logger, :info
+        end
+
+        request_opts
+      end
 
       def build_rest_options(filters)
         request_opts = {}
@@ -137,6 +108,10 @@ module Alula
       def build_rpc_options(filters)
         filters
       end
+
+      def add_customer_id(request_opts)
+        request_opts[:query] = { 'customerId' => config.customer_id }
+      end
     end
   end
 end

data/lib/alula/client_configuration.rb

@@ -0,0 +1,62 @@
+module Alula
+  class ClientConfiguration
+    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|
+      define_method(prop) do
+        RequestStore.store["alula_#{prop}"]
+      end
+
+      define_method("#{prop}=") do |value|
+        RequestStore.store["alula_#{prop}"] = value
+      end
+    end
+
+    # Stash the user type as a role for us to infer from later
+    # You can set a symbolized role via role = :user, or provide the string userType
+    # We cast to a symbolized role for ease of use in consumers.
+    def role=(user_type)
+      unless user_type.is_a?(Symbol) || user_type.is_a?(String)
+        raise Alula::InvalidRoleError, 'Role must be symbol or string'
+      end
+
+      RequestStore.store['alula_role'] = Util.underscore(user_type).to_sym
+    end
+
+    def role
+      RequestStore.store['alula_role']
+    end
+
+    def ensure_api_key_set
+      if api_key.nil?
+        raise Alula::NotConfiguredError,
+              'Set your API access token before making requests with Alula::Client.config.api_key = {access_token}'
+      end
+    end
+
+    def ensure_api_url_set
+      if api_url.nil?
+        raise Alula::NotConfiguredError, 'did you forget to set the Alula::Client.config.api_url config option?'
+      end
+    end
+
+    def ensure_customer_id_set
+      unless customer_id
+        raise Alula::NotConfiguredError,
+              'Set your customer_id before making requests to the video API'
+      end
+    end
+
+    def ensure_role_set
+      if role.nil?
+        message = 'User role not configured! You must set '\
+                  'Alula::Client.config.role '\
+                  'before attempting to save any resources'
+
+        raise Alula::NotConfiguredError, message
+      end
+    end
+  end
+end

data/lib/alula/resource_attributes.rb

@@ -11,14 +11,11 @@ module Alula
       base.include(InstanceMethods)
     end
 
-
     #
     # Class methods for defining how fields and types work
     # NOTE: We're not using real getters and setters here. I want the method signature
     #       to match how most other Ruby class configuration is done, and that is with
     #       simple methods that take params.
-
-
     def resource_path(name)
       @resource_path = name
     end
@@ -148,7 +145,7 @@ module Alula
     end
 
     def field_patchable?(opts, record_persisted)
-      user_role = Alula::Client.role
+      user_role = Alula::Client.config.role
 
       # different permission arrays are used for updates vs creates
       perm_key = record_persisted == true ? :patchable_by : :creatable_by

data/lib/alula/resources/feature_plan.rb

@@ -29,7 +29,7 @@ module Alula
     field :name,
           type: :string,
           sortable: true,
-          filterable: false,
+          filterable: true,
           creatable_by: [:system],
           patchable_by: [:system]
 

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

@@ -0,0 +1,51 @@
+module Alula
+  module Video
+    class BaseResource < Alula::ApiResource
+      extend Alula::ResourceAttributes
+
+      class << self
+        def api_name(name = nil)
+          if name
+            @api_name = name
+          elsif @api_name
+            @api_name
+          else
+            superclass.api_name
+          end
+        end
+
+        # Infer resource name from classname if not provided
+        def resource_name(name = nil)
+          if name
+            @resource_name = name
+          elsif @resource_name
+            @resource_name
+          else
+            @resource_name = self.name.split('::').last.downcase.to_sym
+          end
+        end
+
+        def resource_url(id = nil)
+          "/#{api_name}/v1/#{resource_name}/#{id}"
+        end
+      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

@@ -0,0 +1,24 @@
+module Alula
+  module Video
+    class Device < Alula::Video::BaseResource
+      extend Alula::ApiOperations::Request
+
+      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
+
+      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.52.0'
+  VERSION = '0.55.0'
 end

data/lib/alula.rb

@@ -21,8 +21,9 @@ require_relative 'alula/query_interface'
 require_relative 'alula/util'
 require_relative 'alula/rate_limit'
 
-require_relative 'alula/errors'
 require_relative 'alula/client'
+require_relative 'alula/client_configuration'
+require_relative 'alula/errors'
 require_relative 'alula/list_object'
 require_relative 'alula/oauth'
 
@@ -61,6 +62,9 @@ require_relative 'alula/resources/feature_planvideo'
 require_relative 'alula/resources/feature_price'
 require_relative 'alula/resources/feature_bysubject'
 
+require_relative 'alula/resources/video/base_resource'
+require_relative 'alula/resources/video/device'
+
 require_relative 'alula/procedures/device_cellular_history_proc'
 require_relative 'alula/procedures/device_rateplan_get_proc'
 require_relative 'alula/procedures/device_register_proc'
@@ -126,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.52.0
+  version: 0.55.0
 platform: ruby
 authors:
 - Titus Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,33 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -95,47 +109,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.10.3
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +201,7 @@ files:
 - lib/alula/api_operations/save.rb
 - lib/alula/api_resource.rb
 - lib/alula/client.rb
+- lib/alula/client_configuration.rb
 - lib/alula/errors.rb
 - lib/alula/filter_builder.rb
 - lib/alula/helpers/device_attribute_translations.rb
@@ -250,6 +265,8 @@ files:
 - lib/alula/resources/user_preferences.rb
 - lib/alula/resources/user_pushtoken.rb
 - lib/alula/resources/user_videoprofile.rb
+- lib/alula/resources/video/base_resource.rb
+- lib/alula/resources/video/device.rb
 - lib/alula/rest_resource.rb
 - lib/alula/rpc_resource.rb
 - lib/alula/rpc_response.rb