hudu 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee8592c8b1e645dcf0b370b7d2661b821f0a411d7bd6675b942d5e2a64d1ec20
-  data.tar.gz: 13ac2f1bcffab93943e0f3259c2c14f73c98a85cfb00952e181713501c290499
+  metadata.gz: 6de79a28de35dea4c3ac9ebd26823427f839192e44113fe67f9d5f5e845cade1
+  data.tar.gz: 1bada2b529ac16cc376b85f33b953a451a23f8e955dcc2068814171bcbf0509c
 SHA512:
-  metadata.gz: 40187b263f4388eea09aed5d54713687afdf8aad57f69c23d2d6e538ef2af0f2449af3c41eb8f5c358576282527c0f09f2e88db205eb06056b9be5b74c276c57
-  data.tar.gz: a20ac42a0c6aa74e62a2e8dc34a00f73762db7f6d43d62d6c3dde37dd3221181640050bfee855feea66b56c4a437052c3625b53334c6aabe816ae0363573ca28
+  metadata.gz: 59adb93ef27db882adc800a183ffbe1b7297e96a11014492ff61774395d0969a79603bd442c452f028fae38fc2b6a9ac591f66151276b94bc4d9b154bddda8f6
+  data.tar.gz: bdf2dfd500420081eb4b530f3621f90ae21f3204e0c817e7e33da8c1baae660425e2c844059693c5f5048d7ee1d16e26159987a7ff1d6562dbc716453e06ea97

data/CHANGELOG.md

@@ -3,3 +3,6 @@
 ## [0.1.0] - 2024-02-20
 - Initial release
 
+## [0.2.0] - 2024-03-13
+- update_company_asset added
+

data/Gemfile

@@ -2,9 +2,10 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in cloudally.gemspec
+# Specify your gem's dependencies in hudu.gemspec
 gemspec
 
 gem 'rake', '~> 13.0'
 gem 'rubocop', '~> 1.7'
+gem 'simplecov', require: false, group: :test
 gem 'wrapi'

data/README.md

@@ -1,6 +1,9 @@
 # Hudu API
+[![Version](https://img.shields.io/gem/v/hudu.svg)](https://rubygems.org/gems/hudu)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e02c3f2cd2f13261597d/maintainability)](https://codeclimate.com/github/jancotanis/hudu/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/e02c3f2cd2f13261597d/test_coverage)](https://codeclimate.com/github/jancotanis/hudu/test_coverage)
 
-This is a wrapper for the Hudu rest API. You can see the API endpoints here https://www.zabbix.com/documentation/current/en/manual/api/reference/
+This is a wrapper for the Hudu rest API. 
 
 Currently only the GET requests to get a list of hosts, host groups and problems are implemented.
 
@@ -75,19 +78,19 @@ end
 |:--|:--|
 |.api_info                         | /api/v1/api_info|
 |.activity_logs                    | /api/v1/activity_logs|
-|.companies, :company(id)          | /api/v1/companies/{id}|
-|.articles, :article(id)           | /api/v1/articles/{id}|
-|.asset_layouts, :asset_layout(id) | /api/v1/asset_layouts/{id}|
-|.assets, :asset(id)               | /api/v1/assets/{id}|
+|.companies, company(id)           | /api/v1/companies/{id}|
+|.articles, article(id)            | /api/v1/articles/{id}|
+|.asset_layouts, asset_layout(id)  | /api/v1/asset_layouts/{id}|
+|.assets, asset(id)                | /api/v1/assets/{id}|
 |.asset_passwords                  | /api/v1/asset_passwords/{id}|
-|.folders, :folder(id)             | /api/v1/folders/{id}|
-|.procedures, :procedure(id)       | /api/v1/procedures/{id}|
+|.folders, folder(id)              | /api/v1/folders/{id}|
+|.procedures, procedure(id)        | /api/v1/procedures/{id}|
 |.expirations                      | /api/v1/expirations|
-|.websites, :website(id)           | /api/v1/websites/{id}|
+|.websites, website(id)            | /api/v1/websites/{id}|
 |.relations                        | /api/v1/relations|
-|.company_articles(id)             |/api/v1/companies/{id}/articles|
-|.company_assets(id)               |/api/v1/companies/{id}/assets|
-|.company_asset(id,asset_id)       |/api/v1/companies/{id}/assets/{asset_id}|
+|.company_articles(id)             | /api/v1/companies/{id}/articles|
+|.company_assets(id)               | /api/v1/companies/{id}/assets|
+|.company_asset(id,asset_id)       | /api/v1/companies/{id}/assets/{asset_id}|
 
 
 ## Publishing

data/Rakefile

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'dotenv'
 require 'rake/testtask'
 
+Dotenv.load
+
+system './bin/cc-test-reporter before-build'
+
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
+  at_exit do
+    system './bin/cc-test-reporter after-build'
+  end
 end
 
 require 'rubocop/rake_task'

data/hudu.gemspec

@@ -29,8 +29,9 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.platform = Gem::Platform::RUBY
   s.add_runtime_dependency 'faraday'
-  s.add_runtime_dependency 'wrapi', ">= 0.2.0"
+  s.add_runtime_dependency 'wrapi', ">= 0.3.0"
   s.add_development_dependency 'dotenv'
   s.add_development_dependency 'minitest'
+  s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rubocop'
 end

data/lib/hudu/api.rb

@@ -1,6 +1,7 @@
 require "wrapi"
 require File.expand_path('authentication', __dir__)
 require File.expand_path('configuration', __dir__)
+require File.expand_path('connection', __dir__)
 
 module Hudu
   # @private
@@ -27,6 +28,7 @@ module Hudu
 
     include Configuration
     include WrAPI::Connection
+    include Connection
     include WrAPI::Request
     include WrAPI::Authentication
     include Authentication

data/lib/hudu/asset_helper.rb

@@ -0,0 +1,32 @@
+module Hudu
+
+  class AssetHelper
+    # Construct asset for updates, assuem it is an entity
+    def self.construct_asset asset
+      custom_asset = asset.attributes.slice( *%w(
+        id company_id asset_layout_id slug name 
+        primary_serial primary_model primary_mail 
+        primary_manufacturer ) 
+      )
+      custom_asset['custom_fields'] = self.custom_fields(asset.fields)
+      { asset: custom_asset }
+    end
+
+    # create new asset from layout
+    def self.create_asset name, asset_layout_id, fields
+      custom_asset = { 
+        asset: {
+          name: name,
+          asset_layout_id: asset_layout_id,
+          custom_fields: self.custom_fields(fields)
+        }
+      }
+    end
+  
+  private
+    def self.custom_fields(fields)
+      [fields.map{|field| [field.label.downcase.gsub(' ','_'),field.value]}.to_h]
+    end
+
+  end
+end

data/lib/hudu/client.rb

@@ -1,4 +1,5 @@
 require File.expand_path('api', __dir__)
+require File.expand_path('asset_helper', __dir__)
 
 module Hudu
   # Wrapper for the Hudu REST API
@@ -17,7 +18,7 @@ module Hudu
         end
         # record by id
         self.send(:define_method, singular_method) do |id, params = {}|
-          r = get(api_url("#{path}/" + id.to_s), params)
+          r = get(api_url("#{path}/#{id}"), params)
           r = hudu_data(r,singular_method)
         end
       else
@@ -26,6 +27,17 @@ module Hudu
           get(api_url(path), params)
         end
       end
+      # update
+      self.send(:define_method, "update_#{method}") do |id=nil,params = {}|
+        r = put(api_url("#{path}/#{id}"), params)
+        r = hudu_data(r,method)
+      end
+      # create
+      self.send(:define_method, "create_#{method}") do |id=nil,params = {}|
+        r = post(api_url("#{path}/#{id}"), params)
+        r = hudu_data(r,method)
+      end
+      
     end
 
   public
@@ -47,16 +59,24 @@ module Hudu
     api_endpoint :expirations
     api_endpoint :websites, :website
     api_endpoint :relations
+    api_endpoint :magic_dashes, :magic_dash, 'magic_dash'
 
     def company_articles( company_id, params = {} )
-      articles({company_id: company_id}.merge(parems))
+      articles({company_id: company_id}.merge(params))
     end
-    
     def company_assets(id,params={})
       get_paged(api_url("companies/#{id}/assets"), params)
     end
-    def company_asset(id,asset_id,params={})
-      get(api_url("companies/#{id}/assets/#{asset_id}"), params)
+    def company_asset(company_id,asset_id,params={})
+      get(api_url("companies/#{company_id}/assets/#{asset_id}"), params)
+    end
+
+    def update_company_asset(asset)
+      hudu_data(put(api_url("companies/#{asset.company_id}/assets/#{asset.id}"), AssetHelper.construct_asset(asset),false),:asset)
+    end
+
+    def create_company_asset(company_id,asset_layout, fields)
+      hudu_data(post(api_url("companies/#{company_id}/assets"), AssetHelper.create_asset(asset_layout.name,asset_layout.id,fields),false),:asset)
     end
 
     # return api path
@@ -66,8 +86,8 @@ module Hudu
 
     # hudu returns data as {resource:{}} or {resource:[]} 
     def hudu_data(result,resource)
-      if result.is_a?(Hash) && result[resource.to_s]
-        result[resource.to_s]
+      if result.is_a?(WrAPI::Request::Entity) && result.attributes[resource.to_s]
+        result.send resource.to_s
       else
         result
       end

data/lib/hudu/connection.rb

@@ -0,0 +1,20 @@
+require File.expand_path('rate_throttle_middleware', __dir__)
+
+module Hudu
+  # Create connection including authorization parameters with default Accept format and User-Agent
+  # By default
+  # - Bearer authorization is access_token is not nil override with @setup_authorization
+  # - Headers setup for client-id and client-secret when client_id and client_secret are not nil @setup_headers
+  # @private
+  module Connection
+    private
+
+    def connection
+      unless @connection
+        @connection = super
+        @connection.use RateThrottleMiddleware, limit: 250, period: 60
+      end
+      @connection
+    end
+  end
+end

data/lib/hudu/pagination.rb

@@ -15,7 +15,7 @@ module Hudu
       end
 
       def page_options
-        { page: @page }
+        { page: @page, page_size: @page_size }
       end
 
       def next_page!(body)
@@ -31,12 +31,14 @@ module Hudu
 
       def self.data(body) 
         # assume hash {"resource":[...]}, get first key and return array data
-        k,v = body.first
-        if v.is_a?(Array) || v.is_a?(Hash)
-          v
-        else
-          body
+        result = body 
+        if result && result.respond_to?(:first)
+          k,v = body.first
+          if v.is_a?(Array) || v.is_a?(Hash)
+            result = v
+          end
         end
+        result
       end
     end
   end

data/lib/hudu/rate_throttle_middleware.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+require 'thread'
+
+# A Faraday middleware for rate limiting requests.
+#
+# This middleware ensures that the number of requests made through a Faraday connection
+# does not exceed a specified limit within a given time period.
+#
+# @example Add middleware to a Faraday connection
+#   connection = Faraday.new(url: 'https://api.example.com') do |faraday|
+#     faraday.use RateThrottleMiddleware, limit: 300, period: 60
+#     faraday.adapter Faraday.default_adapter
+#   end
+#
+# @see https://github.com/lostisland/faraday Faraday Documentation
+#
+class RateThrottleMiddleware < Faraday::Middleware
+  # Initializes the RateThrottleMiddleware.
+  #
+  # @param app [#call] The next middleware or the actual Faraday adapter.
+  # @param limit [Integer] The maximum number of requests allowed within the specified period. Default is 300.
+  # @param period [Integer] The time period in seconds over which the limit applies. Default is 60 seconds.
+  #
+  # @example
+  #   middleware = RateThrottleMiddleware.new(app, limit: 300, period: 60)
+  #
+  def initialize(app, limit: 300, period: 60)
+    super(app)
+    @limit = limit
+    @period = period
+    @requests = []
+    @mutex = Mutex.new
+    @condition = ConditionVariable.new
+  end
+
+  def call(env)
+    throttle_request
+    @app.call(env)
+  end
+
+private
+
+  def throttle_request
+    @mutex.synchronize do
+      now = Time.now.to_f
+      # Clear requests older than the rate limit period
+      while !@requests.empty? && @requests[0] < (now - @period)
+        @requests.pop
+      end
+
+      # Wait if the request limit is reached
+      while @requests.size >= @limit
+        sleep_time = @requests[0] + @period - now
+puts "<#{sleep_time}>"
+        @condition.wait(@mutex, sleep_time) if sleep_time > 0
+        now = Time.now.to_f
+        while !@requests.empty? && @requests[0] < (now - @period)
+          @requests.pop
+        end
+      end
+
+      # Record the new request
+      @requests.push(Time.now.to_f)
+      @condition.broadcast
+    end
+  end
+end

data/lib/hudu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hudu
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hudu
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +106,18 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/cc-test-reporter.exe
 - hudu.gemspec
 - lib/hudu.rb
 - lib/hudu/api.rb
+- lib/hudu/asset_helper.rb
 - lib/hudu/authentication.rb
 - lib/hudu/client.rb
 - lib/hudu/configuration.rb
+- lib/hudu/connection.rb
 - lib/hudu/error.rb
 - lib/hudu/pagination.rb
+- lib/hudu/rate_throttle_middleware.rb
 - lib/hudu/version.rb
 homepage: https://rubygems.org/gems/hudu
 licenses:
@@ -122,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.12
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A Ruby wrapper for the Hudu APIs (readonly)