veeam 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6163d719d045dea4a72b05a6dae5b14d6f8c65c09bd7e83ab6cf8143c862092a
+  data.tar.gz: 45176225fcaa997c0fefc7718340b91f0c3f2d8fea6599d150d8bfe12421c451
+SHA512:
+  metadata.gz: d2ea1e16122625bfe8611a76d2262976ffa19e387341de4345949c0fea9712ab77bec345958a135fa7b75f84d780dbed96c1d536a7e6e74c2888eeea9838cb4b
+  data.tar.gz: ee02233ed031debcb7bc6e1e50aef7ddb154e21f333dec7442ed10df9731d46211fe83fc2df7da2fa555d0d79b8003b1f8a576af7efb6030a94e7fdc1b15a17f

data/.env.template

@@ -0,0 +1,2 @@
+VEEAM_API_HOST=<your veeam api host>
+VEEAM_API_KEY=<api-key>

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,4 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-07
+- 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,122 @@
+# Veeam backup API
+
+This is a wrapper for the Veeam Service Provider Console rest API. You can see the API endpoints here https://helpcenter.veeam.com/docs/vac/rest/reference/vspc-rest.html
+
+Currently only the GET requests to get a list of tenants and backup job reports are implemented.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'veeam'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install veeam
+
+## Usage
+
+Before you start making the requests to API provide the client id and client secret and email/password using the configuration wrapping.
+
+```
+require 'veeam'
+
+# use do block
+Veeam.configure do |config|
+  config.endpoint = ENV["VEEAM_API_HOST"]
+  config.access_token = ENV["VEEAM_API_KEY"]
+  config.page_size = 100
+end
+
+# or configure with options hash
+@client = Veeam.client({ logger: Logger.new(CLIENT_LOGGER) })
+
+client = Veeam.client
+client.login
+
+companies = client.companies
+companies.each do |t|
+  puts "#{t.name}"
+end
+```
+
+## Resources
+### Authentication
+```
+# setup configuration
+#
+client.login
+```
+|Resource|API endpoint|Description|
+|:--|:--|:--|
+|.login|uses /api/v3/about to chek if creentials are correct|
+
+
+### About
+Endpoint returns general information about the currently installed version of Veeam Service Provider Console.
+```
+puts client.about.serverVersion
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.about|/api/v3/about|
+
+### Companies
+Endpoint for companies related requests 
+```
+companies = client.companies
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.companies|/api/v3/organizations/companies|
+|.company|/api/v3/organizations/companies/{id}|
+|TODO other endpoints|...|
+
+### Infrastructure
+Get list of backup servers
+```
+server = client.backup_server(id)
+
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.backup_servers|/api/v3/backupServers|
+|.backup_server|/api/v3/backupServers/{id}|
+|TODO other endpoints|...|
+
+### Alarms
+This resource collection represents Veeam Service Provider Console alarms.
+```
+client.active_alarms.each do |alarm|
+  if alarms.alarmTemplateUid.eql? "templateUid>"
+    :
+  end
+end
+
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.all_triggered_alarms .active_alarms|/api/v3/alarms/active|
+|.triggered_alarm .active_alarm|/api/v3/alarms/active/#{alarm_id}|
+|.triggered_alarm_history .alarm_history|/api/v3/alarms/active#{alarm_id}/history|
+|.all_alarm_templates .alarm_templates|/api/v3/alarms/templates|
+|.alarm_template|/api/v3/alarms/templates/#{template_id}|
+|.alarm_status_changes .alarm_template_events|/api/v3/alarms/templates/#{template_id}/events|
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/veeam.
+
+## 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/lib/veeam/api.rb

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

data/lib/veeam/authentication.rb

@@ -0,0 +1,16 @@
+
+module Veeam
+  # Deals with authentication flow and stores it within global configuration
+  module Authentication
+
+    # https://helpcenter.veeam.com/docs/vac/rest/reference/vspc-rest.html?ver=80#tag/Authentication
+    # Authorize to the Veeam portal and return access_token
+    def login(options = {})
+      raise ArgumentError, "Accesstoken/api-key not set" unless access_token
+      # only bearer token needed 
+      # will do sanitty check if token if valid
+      get("/api/v3/about")
+    end
+
+  end
+end

data/lib/veeam/client/about.rb

@@ -0,0 +1,13 @@
+module Veeam
+  class Client
+
+    # Defines methods related to About resource
+    # @see https://helpcenter.veeam.com/docs/vac/rest/reference/vspc-rest.html?ver=80#tag/About/operation/GetAboutInformation
+    module About
+      # Get all backupjob reports
+      def about
+        get('/api/v3/about')
+      end
+    end
+  end
+end

data/lib/veeam/client/alarms.rb

@@ -0,0 +1,45 @@
+module Veeam
+  class Client
+
+    # Defines methods related to alarm resources
+    # @see https://helpcenter.veeam.com/docs/vac/rest/reference/vspc-rest.html?ver=80#tag/Alarms/operation/GetAlarms
+    module Alarms
+      # Returns collection resource representation of all Veeam Service Provider Console triggered alarms.
+      def active_alarms
+        get_paged('/api/v3/alarms/active')
+      end
+      alias all_triggered_alarms active_alarms
+
+      # Returns a resource representation of a triggered alarm with the specified UID.
+      def active_alarm(alarm_id)
+        get("/api/v3/alarms/active/#{alarm_id}")
+      end
+      alias triggered_alarm active_alarm
+
+      # Returns a collection resource representation of all status changes of a triggered alarm with the 
+      # specified UID in chronological order.
+      def alarm_history(alarm_id)
+        get_paged("/api/v3/alarms/active#{alarm_id}/history")
+      end
+      alias triggered_alarm_history alarm_history
+
+      # Returns a collection resource representation of all Veeam Service Provider Console alarm templates.
+      def alarm_templates
+        get_paged('/api/v3/alarms/templates')
+      end
+      alias all_alarm_templates alarm_templates
+
+      # Returns a resource representation of a triggered alarm with the specified UID.
+      def alarm_template(template_id)
+        get("/api/v3/alarms/templates/#{template_id}")
+      end
+
+      # Returns all status changes of a triggered alarm with the specified template UID.
+      def alarm_template_events(template_id)
+        get_paged("/api/v3/alarms/templates/#{template_id}/events")
+      end
+      alias alarm_status_changes alarm_template_events
+
+    end
+  end
+end

data/lib/veeam/client/companies.rb

@@ -0,0 +1,17 @@
+module Veeam
+  class Client
+
+    # Defines methods related to companies resource
+    # @see https://helpcenter.veeam.com/docs/vac/rest/reference/vspc-rest.html?ver=80#tag/Companies/operation/GetCompanies
+    module Companies
+      # Get all backupjob reports
+      def companies
+        get_paged('/api/v3/organizations/companies')
+      end
+
+      def company(company_id)
+        get("/api/v3/organizations/companies/#{company_id}")
+      end
+    end
+  end
+end

data/lib/veeam/client/infrastructure.rb

@@ -0,0 +1,17 @@
+module Veeam
+  class Client
+
+    # Defines methods related to infrastructure resources
+    # @see https://helpcenter.veeam.com/docs/vac/rest/reference/vspc-rest.html?ver=80#tag/Backup-Servers/operation/GetBackupServers
+    module Infrastructure
+      # Get all backupjob reports
+      def backup_servers
+        get_paged('/api/v3/infrastructure/backupServers')
+      end
+
+      def backup_server(backup_id)
+        get("/api/v3/infrastructure/backupServers/#{backup_id}")
+      end
+    end
+  end
+end

data/lib/veeam/client.rb

@@ -0,0 +1,15 @@
+module Veeam
+  # Wrapper for the Veeam REST API
+  #
+  # @note All methods have been separated into modules and follow the same grouping used in api docs
+  # @see https://helpcenter.veeam.com/docs/vac/rest/reference/vspc-rest.html
+  class Client < API
+    Dir[File.expand_path('client/*.rb', __dir__)].each { |f| require f }
+
+    include Veeam::Client::About
+    include Veeam::Client::Companies
+    include Veeam::Client::Infrastructure
+    include Veeam::Client::Alarms
+
+  end
+end

data/lib/veeam/pagination.rb

@@ -0,0 +1,41 @@
+require 'uri'
+require 'json'
+
+module Veeam
+  # Defines HTTP request methods
+  # required attributes format
+  module RequestPagination
+
+    class PagingInfoPager
+      attr_reader :offset, :limit, :total
+      def initialize(page_size)
+        @offset = 0
+        @limit = page_size
+        # we halways have a first page
+        @total = @offset + 1
+      end
+      def page_options
+        { limit: @limit, offset: @offset }
+      end
+      def next_page!(data)
+        @offset += @limit
+        meta = page_info(data)
+        if meta
+          @total = meta['total'].to_i 
+        end
+      end
+
+      def more_pages?
+        @offset < @total
+      end
+
+      def page_info(body) 
+        body['meta']['pagingInfo'] if body['meta'] && body['meta']['pagingInfo'] 
+      end
+
+      def self.data(body) 
+        body['data'] ? body['data'] : body
+      end
+    end
+  end
+end

data/lib/veeam/version.rb

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

data/lib/veeam.rb

@@ -0,0 +1,33 @@
+require "wrapi"
+require File.expand_path('veeam/version', __dir__)
+require File.expand_path('veeam/pagination', __dir__)
+require File.expand_path('veeam/api', __dir__)
+require File.expand_path('veeam/client', __dir__)
+
+module Veeam
+  extend WrAPI::Configuration
+  extend WrAPI::RespondTo
+
+  DEFAULT_UA       = "Veeam Ruby API wrapper #{Veeam::VERSION}".freeze
+  # default options to remove Accept header from WrAPI
+  DEFAULT_OPTIONS  = { headers:{ 'User-Agent': DEFAULT_UA } }
+  DEFAULT_PAGINATION = RequestPagination::PagingInfoPager
+  # Alias for Veeam::Client.new
+  #
+  # @return [Veeam::Client]
+  def self.client(options = {})
+    Veeam::Client.new({
+      connection_options: DEFAULT_OPTIONS,
+      user_agent: DEFAULT_UA,
+      pagination_class: DEFAULT_PAGINATION
+    }.merge(options))
+  end
+
+  def self.reset
+    super
+    self.endpoint   = nil
+    self.user_agent = DEFAULT_UA
+    self.connection_options = DEFAULT_OPTIONS
+    self.pagination_class = DEFAULT_PAGINATION
+  end
+end

data/veeam.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/veeam/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'veeam'
+  s.version     = Veeam::VERSION
+  s.authors     = ['Janco Tanis']
+  s.email       = 'gems@jancology.com'
+  s.license     = 'MIT'
+
+  s.summary     = 'A Ruby wrapper for the Veeam backup Portal REST APIs (readonly)'
+  s.homepage    = 'https://rubygems.org/gems/veeam'
+
+  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/veeam'
+
+  # 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

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: veeam
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janco Tanis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-09 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
+- lib/veeam.rb
+- lib/veeam/api.rb
+- lib/veeam/authentication.rb
+- lib/veeam/client.rb
+- lib/veeam/client/about.rb
+- lib/veeam/client/alarms.rb
+- lib/veeam/client/companies.rb
+- lib/veeam/client/infrastructure.rb
+- lib/veeam/pagination.rb
+- lib/veeam/version.rb
+- veeam.gemspec
+homepage: https://rubygems.org/gems/veeam
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/veeam
+  source_code_uri: https://github.com/jancotanis/veeam
+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 Veeam backup Portal REST APIs (readonly)
+test_files: []