hudu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee8592c8b1e645dcf0b370b7d2661b821f0a411d7bd6675b942d5e2a64d1ec20
+  data.tar.gz: 13ac2f1bcffab93943e0f3259c2c14f73c98a85cfb00952e181713501c290499
+SHA512:
+  metadata.gz: 40187b263f4388eea09aed5d54713687afdf8aad57f69c23d2d6e538ef2af0f2449af3c41eb8f5c358576282527c0f09f2e88db205eb06056b9be5b74c276c57
+  data.tar.gz: a20ac42a0c6aa74e62a2e8dc34a00f73762db7f6d43d62d6c3dde37dd3221181640050bfee855feea66b56c4a437052c3625b53334c6aabe816ae0363573ca28

data/.env.template

@@ -0,0 +1,3 @@
+HUDU_API_HOST=<your veeam api host>
+HUDU_API_KEY=<api-key>
+HUDU_TEST_COMPANY_ID=<id>

data/.gitignore

@@ -0,0 +1,44 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/data/
+*.log
+*.txt
+*.json
+*.yml
+
+# Used by dotenv library to load environment variables.
+.env
+
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-20
+- Initial release
+

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudally.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.7'
+gem 'wrapi'

data/README.md

@@ -0,0 +1,113 @@
+# Hudu API
+
+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/
+
+Currently only the GET requests to get a list of hosts, host groups and problems are implemented.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hudu'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hudu
+
+## Usage
+
+Before you start making the requests to API provide the endpoint and api key using the configuration wrapping.
+
+```ruby
+require 'hudu'
+require 'logger'
+
+# use do block
+Hudu.configure do |config|
+  config.endpoint = ENV['HUDU_API_HOST'].downcase
+  config.api_key = ENV['HUDU_API_KEY']
+end
+
+# or configure with options hash
+client = Hudu.client({ logger: Logger.new(CLIENT_LOGGER) })
+client.login
+
+```
+
+## Resources
+### Authentication
+```
+# setup 
+#
+client.login
+```
+|Resource|API endpoint|Description|
+|:--|:--|:--|
+|.login| none |uses api_info to check if credentials are correct. Raises Hudu:AuthenticationError incase this fails|
+
+
+
+### Data resources
+Endpoint for data related requests 
+```ruby
+
+# list all asset layouts/fields for a company
+assets = client.company_assets(client.companies.first.id)
+assets.each do |asset|
+  layout = client.asset_layout(asset.asset_layout_id)
+  puts "#{layout.name}: '#{asset.name}'"
+  puts "=================================================="
+  asset.fields.each do |field|
+    value = field.value || ''
+    # trim value to first 40 characters
+    puts " #{field.position.to_s.rjust(3)} #{field.label}: '#{value[0..40]}'"
+  end
+end
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.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}|
+|.asset_passwords                  | /api/v1/asset_passwords/{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}|
+|.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}|
+
+
+## Publishing
+
+1. Update version in [version.rb](lib/hudu/version.rb).
+2. Add release to [CHANGELOG.md](CHANGELOG.md)
+3. Commit.
+4. Test build.
+```
+> rake build
+
+```
+5. Release
+```
+> rake release
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/hudu.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+task default: %i[test rubocop]

data/hudu.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/hudu/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'hudu'
+  s.version     = Hudu::VERSION
+  s.authors     = ['Janco Tanis']
+  s.email       = 'gems@jancology.com'
+  s.license     = 'MIT'
+
+  s.summary     = 'A Ruby wrapper for the Hudu APIs (readonly)'
+  s.homepage    = 'https://rubygems.org/gems/hudu'
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/jancotanis/hudu'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  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_development_dependency 'dotenv'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rubocop'
+end

data/lib/hudu/api.rb

@@ -0,0 +1,34 @@
+require "wrapi"
+require File.expand_path('authentication', __dir__)
+require File.expand_path('configuration', __dir__)
+
+module Hudu
+  # @private
+  class API
+
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API and copies settings from singleton
+    def initialize(options = {})
+      options = Hudu.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Configuration
+    include WrAPI::Connection
+    include WrAPI::Request
+    include WrAPI::Authentication
+    include Authentication
+  end
+end

data/lib/hudu/authentication.rb

@@ -0,0 +1,20 @@
+require File.expand_path('error', __dir__)
+
+module Hudu
+  # Deals with authentication flow and stores it within global configuration
+  module Authentication
+
+    # 
+    # Authorize to the Hudu portal and return access_token
+    def login(options = {})
+      raise ArgumentError, "Accesstoken/api-key not set" unless api_key
+      connection_options.merge!({ headers: { "x-api-key": api_key }})
+      # only api key needed 
+      # will do sanitty check if token if valid
+      get('/api/v1/api_info')
+    rescue Faraday::Error => e
+      raise AuthenticationError, e
+    end
+
+  end
+end

data/lib/hudu/client.rb

@@ -0,0 +1,76 @@
+require File.expand_path('api', __dir__)
+
+module Hudu
+  # Wrapper for the Hudu REST API
+  #
+  # @see 
+  class Client < API
+
+  private
+    def self.api_endpoint(method, singular_method = nil, path = method)
+      # generate all and by id
+      if singular_method
+        # all records
+        self.send(:define_method, method) do |params = {}|
+          r = get_paged(api_url(path), params)
+          r = hudu_data(r,method)
+        end
+        # record by id
+        self.send(:define_method, singular_method) do |id, params = {}|
+          r = get(api_url("#{path}/" + id.to_s), params)
+          r = hudu_data(r,singular_method)
+        end
+      else
+        # normal method, return result
+        self.send(:define_method, method) do |params = {}|
+          get(api_url(path), params)
+        end
+      end
+    end
+
+  public
+    api_endpoint :api_info
+    
+    # Activity logs can be filtered on
+    #  user_id, user_email
+    #  resource_id, resource_type
+    #  action_message
+    #  start_date - Must be in ISO 8601 format
+    api_endpoint :activity_logs
+    api_endpoint :companies, :company
+    api_endpoint :articles, :article
+    api_endpoint :asset_layouts, :asset_layout
+    api_endpoint :assets, :asset
+    api_endpoint :asset_passwords, :asset_password
+    api_endpoint :folders, :folder
+    api_endpoint :procedures, :procedure
+    api_endpoint :expirations
+    api_endpoint :websites, :website
+    api_endpoint :relations
+
+    def company_articles( company_id, params = {} )
+      articles({company_id: company_id}.merge(parems))
+    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)
+    end
+
+    # return api path
+    def api_url path
+      "/api/v1/#{path}"
+    end
+
+    # 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]
+      else
+        result
+      end
+    end
+  end
+end

data/lib/hudu/configuration.rb

@@ -0,0 +1,43 @@
+require 'wrapi'
+require File.expand_path('version', __dir__)
+require File.expand_path('pagination', __dir__)
+
+module Hudu
+  # Defines constants and methods related to configuration
+  module Configuration
+    include WrAPI::Configuration
+
+    # An array of additional valid keys in the options hash when configuring a [Hudu::API]
+    VALID_OPTIONS_KEYS = (WrAPI::Configuration::VALID_OPTIONS_KEYS + [:api_key]).freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    DEFAULT_UA         = "Ruby Hudu API wrapper #{Hudu::VERSION}".freeze
+    DEFAULT_PAGINATION = RequestPagination::PagingInfoPager
+    DEFAULT_PAGE_SIZE  = 25
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      super
+      self.api_key          = nil
+      self.endpoint         = nil
+      self.user_agent       = DEFAULT_UA
+      self.page_size        = DEFAULT_PAGE_SIZE
+      self.pagination_class = DEFAULT_PAGINATION
+    end
+  end
+end
+

data/lib/hudu/error.rb

@@ -0,0 +1,8 @@
+module Hudu
+	
+  # Generic error to be able to rescue all Hudu errors
+  class HuduError < StandardError; end
+
+  # Error when authentication fails
+  class AuthenticationError < HuduError; end
+end

data/lib/hudu/pagination.rb

@@ -0,0 +1,43 @@
+require 'uri'
+require 'json'
+
+module Hudu
+
+  # Defines HTTP request methods
+  # @see https://support.hudu.com/hc/en-us/articles/11422780787735-REST-API#pagination-0-5
+  module RequestPagination
+
+    class PagingInfoPager
+      attr_reader :offset, :limit, :total
+      def initialize(page_size)
+        @page = 1
+        @page_total = @page_size = page_size
+      end
+
+      def page_options
+        { page: @page }
+      end
+
+      def next_page!(body)
+        @page += 1
+        a = PagingInfoPager.data(body)
+        @page_total = a.is_a?(Array) ? a.count : 1
+      end
+
+      def more_pages?
+        # while full page we have next page
+        @page_total == @page_size
+      end
+
+      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
+        end
+      end
+    end
+  end
+end

data/lib/hudu/version.rb

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

data/lib/hudu.rb

@@ -0,0 +1,19 @@
+require "wrapi"
+require File.expand_path('hudu/configuration', __dir__)
+require File.expand_path('hudu/client', __dir__)
+
+module Hudu
+  extend Configuration
+  extend WrAPI::RespondTo
+
+  #
+  # @return [Hudu::Client]
+  def self.client(options = {})
+    Hudu::Client.new(options)
+  end
+
+  def self.reset
+    super
+
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: hudu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janco Tanis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wrapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: minitest
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: gems@jancology.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.template"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- hudu.gemspec
+- lib/hudu.rb
+- lib/hudu/api.rb
+- lib/hudu/authentication.rb
+- lib/hudu/client.rb
+- lib/hudu/configuration.rb
+- lib/hudu/error.rb
+- lib/hudu/pagination.rb
+- lib/hudu/version.rb
+homepage: https://rubygems.org/gems/hudu
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/hudu
+  source_code_uri: https://github.com/jancotanis/hudu
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.12
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for the Hudu APIs (readonly)
+test_files: []