skykick 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eafaae81c547995fd55e21844d23699293636cd2fac1d055c921c16308f340ff
+  data.tar.gz: e67e661fd6da88eab1204aa4680ad82be1cb67cd43e5d56512bd21419be3bba2
+SHA512:
+  metadata.gz: e6066c80ada508164d556034e15c5db6a060393d1363deb112583c34ef19572b0a5c8e6bd1727dd293d406f26f3ba0f8c9498be8f5264d2f77000c30b2adfee1
+  data.tar.gz: 85e2993883ad13a33e8d5e90162a61b12e64b346d47f2ea59bb86765cbf61e0ab16e467dc9ea5d3379a384768d8a733993ebfa0ffbd7cc9c3128d363555f2212

data/.env.template

@@ -0,0 +1,2 @@
+SKYKICK_CLIENT_ID=<SKYKICK_CLIENT_ID>
+SKYKICK_CLIENT_SECRET=<SKYKICK_CLIENT_SECRET>

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,95 @@
+# Skykick Office365 backup API
+
+This is a wrapper for the Skykick Office365 backup API. You can see the API endpoints here https://developers.skykick.com/apis
+
+Currently only the GET requests to endpoints /Backup and /Alerts are implemented (readonly).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'skykick'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install skykick
+
+## Usage
+
+Before you start making the requests to API provide the client id and client secret and email/password using the configuration wrapping.
+
+```
+require 'skykick'
+
+Skykick.configure do |config|
+  config.client_id = ENV["SKYKICK_CLIENT_ID"]
+  config.client_secret = ENV["SKYKICK_CLIENT_SECRET"]
+end
+@client = Skykick.client()
+@client.login
+
+dc = @client.datacenters
+
+dc.each do |t|
+  puts "#{t.name}"
+end
+```
+
+## Resources
+### Authentication
+```
+# setup configuration
+#
+client.login
+```
+|Resource|API endpoint|Description|
+|:--|:--|:--|
+|.auth_token or .login|https://apis.skykick.com/auth/token|
+
+
+### Backup
+Endpoint for backup related requests 
+```
+licenses = client.tenant_licenses
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|autodiscover                     |https://apis.skykick.com/Backup/{id}/autodiscover                    |
+|datacenters                      |https://apis.skykick.com/Backup/datacenters                          |
+|exchange_mailboxe                |https://apis.skykick.com/Backup/{id}/mailboxes/{mailboxId}           |
+|exchange_mailboxes               |https://apis.skykick.com/Backup/{id}/mailboxes                       |
+|lastsnapshotstats                |https://apis.skykick.com/Backup/{backupServiceId}/lastsnapshotstats  |
+|retention_periods                |https://apis.skykick.com/Backup/{id}/retentionperiod                 |
+|sharePoint_sites                 |https://apis.skykick.com/Backup/{id}/sites                           |
+|sku                              |https://apis.skykick.com/Backup/{id}/sku                             |
+|storage_settings                 |https://apis.skykick.com/Backup/{id}/storagesettings                 |
+|subscription_settings            |https://apis.skykick.com/Backup/{id}/subscriptionsettings            |
+|subscriptions                    |https://apis.skykick.com/Backup/                                     |
+|partner_subscriptions(partner_id)|https://apis.skykick.com/Backup/{partner_id}                         |
+
+
+### Alerts
+Returns Alerts for a provided Email Migration Order ID or Backup service ID.
+```
+alerts = client.alerts(subscription_id)
+
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.alerts|/Alerts|
+
+## 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/lib/skykick/api.rb

@@ -0,0 +1,32 @@
+require "wrapi"
+require File.expand_path('connection', __dir__)
+require File.expand_path('authentication', __dir__)
+
+module Skykick
+  # @private
+  class API
+    # @private
+    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API and copies settings from singleton
+    def initialize(options = {})
+      options = Skykick.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 Connection
+    include WrAPI::Request
+    include WrAPI::Authentication
+    include Authentication
+  end
+end

data/lib/skykick/authentication.rb

@@ -0,0 +1,40 @@
+require 'json'
+require 'uri'
+
+module Skykick
+  # Deals with authentication flow and stores it within global configuration
+  module Authentication
+    # Authorize to the Skykick portal and return access_token
+    # @see https://developers.skykick.com/Guides/Authentication
+    def auth_token(options = {})
+      c = connection
+      c.basic_auth(client_id, client_secret)
+      response = c.post('/auth/token') do |request|
+        request.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        request.body = URI.encode_www_form( api_access_token_params )
+      end
+
+      api_process_token(response.body)
+    end
+    alias login auth_token
+
+  private
+
+    def api_access_token_params
+      {
+        grant_type: 'client_credentials',
+        scope: 'Partner'
+      }
+    end
+
+    def api_process_token(response)
+      at = self.access_token = response['access_token']
+      self.token_type        = response['token_type']
+      self.refresh_token     = response['refresh_token']
+      self.token_expires     = response['expires_in']
+      raise StandardError.new 'Could not find valid access_token; response ' + response.to_s if at.nil? || at.empty?
+
+      at
+    end
+  end
+end

data/lib/skykick/client/alerts.rb

@@ -0,0 +1,22 @@
+module Skykick
+  class Client
+
+    # All alert related api calls
+    # @see https://developers.skykick.com/
+    module Alerts
+
+      # Returns first 500 Alerts for a provided Email Migration Order ID or Backup service ID.
+      def alerts(id)
+        # This endpoint supports the following OData query parameters: $top
+        # $top - default of 25 and max of 500 
+        # this is not implemented
+        get("Alerts/#{id}?$top=500")
+      end
+
+      # Mark an Alert as complete.
+      def mark_as_complete(id)
+        post("Alerts/#{id}")
+      end
+    end
+  end
+end

data/lib/skykick/client/backup.rb

@@ -0,0 +1,77 @@
+module Skykick
+  class Client
+
+    # All backup related api calls
+    # @see https://developers.skykick.com/
+    module Backup
+
+      # Returns a list of supported Azure data centers.
+      def datacenters
+          get('Backup/datacenters')
+      end
+
+      # Gets a list of placed Backup subscription orders
+      def subscriptions()
+          get('Backup')
+      end
+
+      # Gets a list of placed Backup subscription orders
+      def partner_subscriptions(partner_id)
+          get("Backup/#{partner_id}")
+      end
+
+      # Returns Backup subscription settings. Settings include the enabled 
+      # state for Exchange and SharePoint Backups and total count of enabled
+      # Exchange mailboxes and SharePoint sites as well as the state of the subscription.
+      def subscription_settings(id)
+          get("Backup/#{id}/subscriptionsettings")
+      end
+
+      # Returns storage settings for a Backup subscription.
+      def storage_settings(id)
+          get("Backup/#{id}/storagesettings")
+      end
+
+      # Gets SKU/promo details for a Backup service.
+      def sku(id)
+          get("Backup/#{id}/sku")
+      end
+
+      # Returns a list of SharePoint site URLs and statuses (enabled/disabled)
+      # for a Backup subscription.
+      def sharepoint_sites(id)
+          get("Backup/#{id}/sites")
+      end
+
+      # Returns the data retention periods for a Backup subscription. There are different
+      # retention periods for Exchange and SharePoint Data.
+      #
+      # Please Note: We are aware of the spelling error of the word "retention" in the response 
+      # field ExchangeRentionPeriodInDays. This is not a mistake in the documentation, but has 
+      # been left this way as not to disrupt any existing integrations with this endpoint.
+      def retentionperiod(id)
+          get("Backup/#{id}/retentionperiod")
+      end
+
+      # Gets stats for snapshots from SKDataWarehouse for all mailboxes of a given backupServiceId
+      def lastsnapshotstats(id)
+          get("Backup/#{id}/lastsnapshotstats")
+      end
+
+      # Returns a list of Exchange mailboxes and statuses (enabled/disabled) for a Backup subscription.
+      def exchange_mailboxes(id)
+          get("Backup/#{id}/mailboxes")
+      end
+
+      # Returns a list of Exchange mailboxes and statuses (enabled/disabled) for a Backup subscription.
+      def exchange_mailbox(id, mailbox_id)
+          get("Backup/#{id}/mailboxes/#{mailbox_id}")
+      end
+
+      # Returns the Exchange and SharePoint auto-discover states (enabled/disabled) of a Backup subscription.
+      def autodiscover(id)
+          get("Backup/#{id}/autodiscover")
+      end
+    end
+  end
+end

data/lib/skykick/client.rb

@@ -0,0 +1,12 @@
+module Skykick
+  # Wrapper for the Skykick REST API
+  #
+  # @note All methods have been separated into modules and follow the same grouping used in api docs
+  # @see https://developers.skykick.com/Guides/Authentication
+  class Client < API
+    Dir[File.expand_path('client/*.rb', __dir__)].each { |f| require f }
+
+    include Skykick::Client::Backup
+    include Skykick::Client::Alerts
+  end
+end

data/lib/skykick/connection.rb

@@ -0,0 +1,33 @@
+require 'faraday'
+
+module Skykick
+
+  # 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 Ocp-Apim-Subscription-Key when client_id and client_secret are not nil @setup_headers
+  # @private
+  module Connection
+    include WrAPI::Connection
+
+    # callback method to setup api headers
+    def setup_headers(connection)
+      connection.headers['Ocp-Apim-Subscription-Key'] = client_secret if client_secret
+    end
+
+    # callback method to setup logger
+    def setup_logger_filtering(connection, logger)
+      connection.response :logger, logger, { headers: true, bodies: true } do |l|
+        # filter json content
+        l.filter(/("password":")(.+?)(".*)/, '\1[REMOVED]\3')
+        l.filter(/("accessToken":")(.+?)(".*)/, '\1[REMOVED]\3')
+        # filter header content
+        l.filter(/(client-secret:.)([^&]+)/, '\1[REMOVED]')
+        l.filter(/(Authorization:.)([^&]+)/, '\1[REMOVED]')
+        # skykick
+        l.filter(/(Ocp-Apim-Subscription-Key: ")(.+?)(\")/, '\1[REMOVED]\3')
+        l.filter(/("access_token":")(.+?)(".*)/, '\1[REMOVED]\3')
+      end
+    end
+  end
+end

data/lib/skykick/version.rb

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

data/lib/skykick.rb

@@ -0,0 +1,28 @@
+require "wrapi"
+require File.expand_path('skykick/api', __dir__)
+require File.expand_path('skykick/client', __dir__)
+require File.expand_path('skykick/version', __dir__)
+
+module Skykick
+  extend WrAPI::Configuration
+  extend WrAPI::RespondTo
+
+  DEFAULT_ENDPOINT = 'https://apis.skykick.com'.freeze
+  DEFAULT_UA = "Skykick Ruby API wrapper #{Skykick::VERSION}".freeze
+
+  # Alias for Skykick::Client.new
+  #
+  # @return [Skykick::Client]
+  def self.client(options = {})
+    Skykick::Client.new({
+      endpoint: DEFAULT_ENDPOINT,
+      user_agent: DEFAULT_UA
+    }.merge(options))
+  end
+
+  def self.reset
+    super
+    self.endpoint = DEFAULT_ENDPOINT
+    self.user_agent = DEFAULT_UA
+  end
+end

data/skykick.gemspec

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

metadata

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