integra365 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f47672ce28d07c8052f4012a30e06b034c7a7d05d7d4251bcd16cfc75e420eeb
-  data.tar.gz: 1a08657cc42716f7ee24bd49a6b3edfbb05a0f0e803180583f5e64e4d681fcdb
+  metadata.gz: 9b872e0f6b5f05ab04116db74078c1c70bacecfd596c8a268c93e0dce47df35a
+  data.tar.gz: 7522cac01bff0f2f86d11b962ff62baa0223707187698b5760056a3027718fb6
 SHA512:
-  metadata.gz: d38d1a982e490ca349e3eb7e1aa83db407148fec053e4b83f3947739387d931519839becf51cf3a7fc0fc815435a08ebbb0f5defb50a04f393025cb6959af0ea
-  data.tar.gz: 33aee28e333f7fd0d71853eb0c26e424a86abbd5c635d6b9cd2aa538d503aee2daab12abe3613c744f71cef011fbbb23177fa8d49ac056556e905ad6703b810d
+  metadata.gz: feb5d102d898512bb2aa05f5001c952f26817379a69e5370c3aee76d2a27e5248ae60dcad54e1632a29414dd0ddc35bd5241061d6a57afc9b2a50234e1a0f73c
+  data.tar.gz: 5c6c963dee2b09c51bbab1dae62b76d2ad9eb9a30307a1560e167f607166641806add2a0ae8f2add89d25814a4eb105cd22844f364a05c48140a238b6536756e

data/CHANGELOG.md

@@ -1,11 +1,23 @@
-## [Unreleased]
+# Changelog
 
 ## [0.1.0] - 2024-02-05
+
 - Initial release
 
 ## [0.1.1] - 2024-02-09
+
 - new wrapi dependency for paging
 
 ## [0.2.0] - 2024-02-20
+
 - Exception harmonization
 
+## [0.3.0] - 2025-03-20
+
+- Add backup job api
+- fix issues with http error codes bad request vs unauthorized
+
+## [0.4.0] - 2025-09-08
+
+- Add backup job sessions api
+- Add constants for list type and last backup state

data/Gemfile

@@ -8,4 +8,4 @@ gemspec
 gem 'rake', '~> 13.0'
 gem 'rubocop', '~> 1.7'
 gem 'simplecov', require: false, group: :test
-gem 'wrapi'
+gem 'wrapi'

data/README.md

@@ -1,11 +1,14 @@
 # Integra Office365 backup API
+
 [![Version](https://img.shields.io/gem/v/integra365.svg)](https://rubygems.org/gems/integra365)
 [![Maintainability](https://api.codeclimate.com/v1/badges/41dec06ba5200b40b44e/maintainability)](https://codeclimate.com/github/jancotanis/integra365/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/41dec06ba5200b40b44e/test_coverage)](https://codeclimate.com/github/jancotanis/integra365/test_coverage)
 
-This is a wrapper for the Integra Office365 backup API. You can see the API endpoints here https://api.integra-bcs.nl/swagger/index.html
+This is a wrapper for the Integra Office365 backup API.
+You can see the [API endpoints](https://api.integra-bcs.nl/swagger/index.html).
 
-Currently only the GET requests to get a list of tenants and backup job reports are implemented.
+Currently only the GET requests to get a list of tenants and backup job reports
+are implemented.
 
 ## Installation
 
@@ -17,15 +20,20 @@ gem 'integra365'
 
 And then execute:
 
-    $ bundle install
+```console
+> bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install integra365
+```console
+> gem install integra365
+```
 
 ## Usage
 
-Before you start making the requests to API provide the client id and client secret and email/password using the configuration wrapping.
+Before you start making the requests to API provide the client id and client secret and
+email/password using the configuration wrapping.
 
 ```ruby
 require 'integra365'
@@ -45,19 +53,24 @@ end
 ```
 
 ## Resources
+
 ### Authentication
+
 ```ruby
 # setup configuration
 #
 client.login
 ```
+
 |Resource|API endpoint|Description|
 |:--|:--|:--|
-|.token or .login|/Api/V1/Token portal user|
+|.token or .login|/Api/V1/Token|portal user|
 |.token_refresh|/Api/V1/Token/Refresh|Refresh authentication token|
 
 ### Tenant
-Endpoint for tenant related requests 
+
+Endpoint for tenant related requests
+
 ```ruby
 licenses = client.tenant_licenses
 ```
@@ -69,8 +82,21 @@ licenses = client.tenant_licenses
 |.tenant_licenses(id) |/Api/V1/Tenants/{id}/Licenses|
 |.tenant_storage(id)|/Api/V1/Tenants/{id}/Storage|
 
+### BackupJobs
+
+Get list of backup jobs or by id and state
+
+|Resource|API endpoint|
+|:--|:--|
+|.backup_jobs|/Api/V1/BackupJobs|
+|.backup_job(id) .tenant(id)|/Api/V1/BackupJobs/{id}|
+|.backup_job_state(id)|/Api/V1/BackupJobs/{id}/State|
+|.backup_job_sessions(id)|/Api/V1/BackupJobs/{id}/Sessions|
+
 ### BackupJobReporting
+
 BackupJobReporting for status of backup jobs
+
 ```ruby
 job_statuses = client.backup_job_reporting
 
@@ -82,7 +108,7 @@ job_statuses = client.backup_job_reporting
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/integra365.
+Bug reports and pull requests are welcome on [GitHub](https://github.com/jancotanis/integra365).
 
 ## License
 

data/lib/integra365/api.rb

@@ -1,4 +1,6 @@
-require "wrapi"
+# frozen_string_literal: true
+
+require 'wrapi'
 require File.expand_path('authentication', __dir__)
 
 module Integra365

data/lib/integra365/authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('error', __dir__)
 
 module Integra365
@@ -6,9 +8,9 @@ module Integra365
     # Authorize to the Integra365 portal and return access_token
     def token(options = {})
       raise ConfigurationError.new 'Client id and/or secret not configured' unless self.username && self.password
-      api_auth('Token', options)
-    rescue Faraday::BadRequestError => e
 
+      api_auth('Token', options)
+    rescue Faraday::BadRequestError, Faraday::UnauthorizedError => e
       raise AuthenticationError.new 'Unauthorized; response ' + e.to_s
     end
     alias login token
@@ -17,9 +19,8 @@ module Integra365
     # token currrent token
     def token_refresh(token)
       api_refresh('Token/Refresh', token)
-    rescue Faraday::BadRequestError => e
-
-      raise AuthenticationError.new 'Unauthorized; response ' + e.to_s
+    rescue Faraday::BadRequestError, Faraday::UnauthorizedError => e
+      raise AuthenticationError.new 'Unauthorized; response #{e}'
     end
   end
 end

data/lib/integra365/client/backup_job_reporting.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 module Integra365
   class Client
-
     # Defines methods related to backup job reporting
     # @see https://api.integra-bcs.nl/swagger/index.html
     module BackupJobReporting
       # Get all backupjob reports
       def backup_job_reporting
-        get("BackupJobReporting")
+        get('BackupJobReporting')
       end
     end
   end

data/lib/integra365/client/backup_jobs.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Integra365
+  class Client
+    # Defines methods related to backup job reporting
+    # @see https://api.integra-bcs.nl/swagger/index.html
+    module BackupJobs
+      # Get all backupjobs
+      def backup_jobs
+        get('BackupJobs')
+      end
+
+      # Get backupjob by id
+      def backup_job(id)
+        get("BackupJobs/#{id}")
+      end
+
+      # Get backupjob state as string
+      def backup_job_state(id)
+        get("BackupJobs/#{id}/State")
+      end
+
+      # Get backupjob sessions
+      def backup_job_sessions(id)
+        get("BackupJobs/#{id}/Sessions")
+      end
+
+      # Get backupjob session
+      def backup_job_session(id, session_id)
+        get("BackupJobs/#{id}/Sessions/#{session_id}")
+      end
+    end
+  end
+end

data/lib/integra365/client/tenants.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Integra365
   class Client
-
     # Defines methods related to tenants
     # @see https://api.integra-bcs.nl/swagger/index.html
     module Tenants
@@ -9,9 +10,11 @@ module Integra365
         if id
           get("Tenants/#{id}")
         else
-          get("Tenants")
+          get('Tenants')
         end
       end
+
+      # Get tenant by id
       def tenant(id)
         tenants(id)
       end

data/lib/integra365/client.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require File.expand_path('const', __dir__)
+
 module Integra365
   # Wrapper for the Integra365 REST API
   #
@@ -7,6 +11,7 @@ module Integra365
     Dir[File.expand_path('client/*.rb', __dir__)].each { |f| require f }
 
     include Integra365::Client::Tenants
+    include Integra365::Client::BackupJobs
     include Integra365::Client::BackupJobReporting
   end
 end

data/lib/integra365/const.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Integra365
+  class Enum
+      def self.enum(array, proc=:to_s)
+        array.each do |c|
+          const_set c.upcase,c
+        end
+      end
+  end
+
+  # Represents different session line types
+  class BackupJobStatus < Enum
+    enum %w[Success Warning Error Running]
+  end
+
+  # Represents different session line types
+  class SessionListTypes
+    # Session is 
+    RUNNING = 0
+    # Warning description
+    WARNING = 1
+    # Error description
+    ERROR = 2
+    # Succes line
+    SUCCESS = 3
+    # Session stopped 
+    STOP = 4
+  end
+end
+

data/lib/integra365/error.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 module Integra365
-	
   # Generic error to be able to rescue all Integra365 errors
   class Integra365Error < StandardError; end
 
@@ -8,4 +9,4 @@ module Integra365
 
   # Error when authentication fails
   class AuthenticationError < Integra365Error; end
-end
+end

data/lib/integra365/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Integra365
-  VERSION = '0.2.0'
+  VERSION = '0.4.0'
 end

data/lib/integra365.rb

@@ -1,4 +1,6 @@
-require "wrapi"
+# frozen_string_literal: true
+
+require 'wrapi'
 require File.expand_path('integra365/api', __dir__)
 require File.expand_path('integra365/client', __dir__)
 require File.expand_path('integra365/version', __dir__)
@@ -7,8 +9,8 @@ module Integra365
   extend WrAPI::Configuration
   extend WrAPI::RespondTo
 
-  DEFAULT_ENDPOINT = 'https://api.integra-bcs.nl/Api/V1/'.freeze
-  DEFAULT_UA       = "Integra365 Ruby API wrapper #{Integra365::VERSION}".freeze
+  DEFAULT_ENDPOINT = 'https://api.integra-bcs.nl/Api/V1/'
+  DEFAULT_UA       = "Integra365 Ruby API wrapper #{Integra365::VERSION}"
 
   # Alias for Integra365::Client.new
   #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: integra365
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Janco Tanis
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2025-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,7 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: gems@jancology.com
 executables: []
 extensions: []
@@ -113,7 +111,9 @@ files:
 - lib/integra365/authentication.rb
 - lib/integra365/client.rb
 - lib/integra365/client/backup_job_reporting.rb
+- lib/integra365/client/backup_jobs.rb
 - lib/integra365/client/tenants.rb
+- lib/integra365/const.rb
 - lib/integra365/error.rb
 - lib/integra365/version.rb
 homepage: https://rubygems.org/gems/integra365
@@ -122,7 +122,6 @@ licenses:
 metadata:
   homepage_uri: https://rubygems.org/gems/integra365
   source_code_uri: https://github.com/jancotanis/integra365
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,8 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.12
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Ruby wrapper for the Integra36 backup Portal REST APIs (readonly)
 test_files: []