integra365 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2446f113b5f0bb83e671601702793a41c37aa97cd5d5e79de5bd91eb4933d085
+  data.tar.gz: c12c1bfd326ee06b34760c1da8b1dee0d89b88a7a7638f10930b149251380418
+SHA512:
+  metadata.gz: 5dd0575779cec82d17aa8ab9a6a9800dee64468ec7c1a18aeb83817ee9003ce75f91f6b4014c17ac136ddbf9047a8e014901c9c594b701a73e183f696c75475c
+  data.tar.gz: 57e8a3a3f67af0c94b77276e9dbfd03a013c1060b8b63b1886ca4fdb950d6641bed68a39cfcffc95d04c4468fe5a171fef15532c727b272640a25bafa4d99c06

data/.env.template

@@ -0,0 +1,2 @@
+INTEGRA365_USER=<username/mail>
+INTEGRA365_PASSWORD=<password>

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-05
+- 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,86 @@
+# Integra Office365 backup API
+
+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
+
+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 'integra365'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ 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.
+
+```
+require 'integra365'
+
+Integra365.configure do |config|
+  config.username = ENV["INTEGRA365_USER"]
+  config.password = ENV["INTEGRA365_PASSWORD"]
+end
+
+client = Integra365.client
+client.login
+
+tenants = client.tenants
+tenants.each do |t|
+  puts "#{t.friendlyName} - #{t.tenantName}"
+end
+```
+
+## Resources
+### Authentication
+```
+# setup configuration
+#
+client.login
+```
+|Resource|API endpoint|Description|
+|:--|:--|:--|
+|.token or .login|/Api/V1/Token portal user|
+|.token_refresh|/Api/V1/Token/Refresh|Refresh authentication token|
+
+### Tenant
+Endpoint for tenant related requests 
+```
+licenses = client.tenant_licenses
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.tenants|/Api/V1/Tenants/{id}|
+|.get_tenant_by_id(id) .tenant(id)|/Api/V1/Tenants/{id}|
+|.tenant_licenses(id) |/Api/V1/Tenants/{id}/Licenses|
+|.tenant_storage(id)|/Api/V1/Tenants/{id}/Storage|
+
+### BackupJobReporting
+BackupJobReporting for status of backup jobs
+```
+job_statuses = client.backup_job_reporting
+
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.backup_job_reporting|/Api/V1/BackupJobReporting|
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/integra365.
+
+## 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/integra365.gemspec

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

data/lib/integra365/api.rb

@@ -0,0 +1,31 @@
+require "wrapi"
+require File.expand_path('authentication', __dir__)
+
+module Integra365
+  # @private
+  class API
+    # @private
+    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API and copies settings from singleton
+    def initialize(options = {})
+      options = Integra365.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/integra365/authentication.rb

@@ -0,0 +1,17 @@
+
+module Integra365
+  # Deals with authentication flow and stores it within global configuration
+  module Authentication
+    # Authorize to the Integra365 portal and return access_token
+    def token(options = {})
+      api_auth("Token", options)
+    end
+    alias login token
+
+    # Return an access token from authorization
+    # token currrent token
+    def token_refresh(token)
+      api_refresh("Token/Refresh", token)
+    end
+  end
+end

data/lib/integra365/client/backup_job_reporting.rb

@@ -0,0 +1,13 @@
+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")
+      end
+    end
+  end
+end

data/lib/integra365/client/tenants.rb

@@ -0,0 +1,35 @@
+module Integra365
+  class Client
+
+    # Defines methods related to tenants
+    # @see https://api.integra-bcs.nl/swagger/index.html
+    module Tenants
+      # Get all tenants
+      def tenants(id = nil)
+        if id
+          get("Tenants/#{id}")
+        else
+          get("Tenants")
+        end
+      end
+      def tenant(id)
+        tenants(id)
+      end
+      alias get_tenant_by_id tenant
+
+      # Get license consumption history for a tenant
+      #
+      # @see https://api.integra-bcs.nl/swagger/index.html#operations-Tenants-get_Api_V1_Tenants__id__Licenses
+      def tenant_licenses(id)
+        get("Tenants/#{id}/Licenses")
+      end
+
+      # Get storage consumption history for a tenant
+      #
+      # @see https://api.integra-bcs.nl/swagger/index.html
+      def tenant_storage(id)
+        get("Tenants/#{id}/Storage")
+      end
+    end
+  end
+end

data/lib/integra365/client.rb

@@ -0,0 +1,12 @@
+module Integra365
+  # Wrapper for the Integra365 REST API
+  #
+  # @note All methods have been separated into modules and follow the same grouping used in api docs
+  # @see https://api.integra-bcs.nl/swagger/index.html
+  class Client < API
+    Dir[File.expand_path('client/*.rb', __dir__)].each { |f| require f }
+
+    include Integra365::Client::Tenants
+    include Integra365::Client::BackupJobReporting
+  end
+end

data/lib/integra365/version.rb

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

data/lib/integra365.rb

@@ -0,0 +1,19 @@
+require "wrapi"
+require File.expand_path('integra365/api', __dir__)
+require File.expand_path('integra365/client', __dir__)
+require File.expand_path('integra365/version', __dir__)
+
+module Integra365
+  extend WrAPI::Configuration
+  extend WrAPI::RespondTo
+
+  # Alias for Integra365::Client.new
+  #
+  # @return [Integra365::Client]
+  def self.client(options = {})
+    Integra365::Client.new({
+      endpoint: 'https://api.integra-bcs.nl/Api/V1/'.freeze,
+      user_agent: "Integra365 Ruby API wrapper #{Integra365::VERSION}".freeze
+    }.merge(options))
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: integra365
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janco Tanis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-05 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.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !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
+- integra365.gemspec
+- lib/integra365.rb
+- lib/integra365/api.rb
+- lib/integra365/authentication.rb
+- lib/integra365/client.rb
+- lib/integra365/client/backup_job_reporting.rb
+- lib/integra365/client/tenants.rb
+- lib/integra365/version.rb
+homepage: https://rubygems.org/gems/integra365
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/integra365
+  source_code_uri: https://github.com/jancotanis/integra365
+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 Integra36 backup Portal REST APIs (readonly)
+test_files: []