skykick 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eafaae81c547995fd55e21844d23699293636cd2fac1d055c921c16308f340ff
-  data.tar.gz: e67e661fd6da88eab1204aa4680ad82be1cb67cd43e5d56512bd21419be3bba2
+  metadata.gz: 3568006d852bb95fdf9bc05a9c2847f0735858d0b30b1db54f07af5b1e8c547e
+  data.tar.gz: e714cce3f3851c064abf1fcb314f460d4d2dd34fab2fb6caba2e3a794fae4e57
 SHA512:
-  metadata.gz: e6066c80ada508164d556034e15c5db6a060393d1363deb112583c34ef19572b0a5c8e6bd1727dd293d406f26f3ba0f8c9498be8f5264d2f77000c30b2adfee1
-  data.tar.gz: 85e2993883ad13a33e8d5e90162a61b12e64b346d47f2ea59bb86765cbf61e0ab16e467dc9ea5d3379a384768d8a733993ebfa0ffbd7cc9c3128d363555f2212
+  metadata.gz: 023d97f414b04c76cdacc95857b1b2c1c956ddeed653022f79c4f5bcdf13764b32f9e8ac931de6fd0e7b03c566ac2410f1b356991c2975008668f9f602857baa
+  data.tar.gz: 0baba10c6e1b0db00d6390a3ef594b292e0f23c1f6ef99a71ec2d0d81163c24a23eb3d0c047b4201a7ddbe2f08c699b4e2ce92aeb05ba827f2454a4cb64da0c3

data/CHANGELOG.md

@@ -2,3 +2,9 @@
 
 ## [0.1.0] - 2024-02-05
 - Initial release
+
+## [0.1.1] - 2024-02-08
+- Update OData support
+
+## [0.2.0] - 2024-02-20
+- Exception handling harmonized

data/Gemfile

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

data/README.md

@@ -1,4 +1,7 @@
 # Skykick Office365 backup API
+[![Version](https://img.shields.io/gem/v/skykick.svg)](https://rubygems.org/gems/skykick)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a340908aaf944745eeda/maintainability)](https://codeclimate.com/github/jancotanis/skykick/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a340908aaf944745eeda/test_coverage)](https://codeclimate.com/github/jancotanis/skykick/test_coverage)
 
 This is a wrapper for the Skykick Office365 backup API. You can see the API endpoints here https://developers.skykick.com/apis
 
@@ -24,7 +27,7 @@ Or install it yourself as:
 
 Before you start making the requests to API provide the client id and client secret and email/password using the configuration wrapping.
 
-```
+```ruby
 require 'skykick'
 
 Skykick.configure do |config|
@@ -43,7 +46,7 @@ end
 
 ## Resources
 ### Authentication
-```
+```ruby
 # setup configuration
 #
 client.login
@@ -55,8 +58,8 @@ client.login
 
 ### Backup
 Endpoint for backup related requests 
-```
-licenses = client.tenant_licenses
+```ruby
+subscriptions = client.subscriptions
 ```
 
 |Resource|API endpoint|
@@ -77,8 +80,9 @@ licenses = client.tenant_licenses
 
 ### Alerts
 Returns Alerts for a provided Email Migration Order ID or Backup service ID.
-```
-alerts = client.alerts(subscription_id)
+```ruby
+subscriptions = client.subscriptions
+alerts = client.alerts(subscriptions.first.id)
 
 ```
 
@@ -88,7 +92,7 @@ alerts = client.alerts(subscription_id)
 
 ## 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 at https://github.com/jancotanis/skykick.
 
 ## License
 

data/Rakefile

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'dotenv'
 require 'rake/testtask'
 
+Dotenv.load
+
+system './bin/cc-test-reporter before-build'
+
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
+  at_exit do
+    system './bin/cc-test-reporter after-build'
+  end
 end
 
 require 'rubocop/rake_task'

data/lib/skykick/authentication.rb

@@ -1,4 +1,4 @@
-require 'json'
+require File.expand_path('error', __dir__)
 require 'uri'
 
 module Skykick
@@ -7,6 +7,8 @@ module Skykick
     # Authorize to the Skykick portal and return access_token
     # @see https://developers.skykick.com/Guides/Authentication
     def auth_token(options = {})
+      raise ConfigurationError.new 'Client id and/or secret not configured' unless client_id && client_secret
+
       c = connection
       c.basic_auth(client_id, client_secret)
       response = c.post('/auth/token') do |request|
@@ -15,6 +17,10 @@ module Skykick
       end
 
       api_process_token(response.body)
+
+      self.access_token
+    rescue Faraday::ForbiddenError => e
+      raise AuthenticationError.new 'Unauthorized; response ' + e.to_s
     end
     alias login auth_token
 
@@ -28,13 +34,12 @@ module Skykick
     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?
+      self.access_token  = response['access_token']
+      self.token_type    = response['token_type']
+      self.refresh_token = response['refresh_token']
+      self.token_expires = response['expires_in']
 
-      at
+      raise AuthorizationError.new 'Could not find valid access_token; response ' + response.to_s if self.access_token.nil? || self.access_token.empty?
     end
   end
 end

data/lib/skykick/client/alerts.rb

@@ -10,7 +10,7 @@ module Skykick
         # 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")
+        get_paged("Alerts/#{id}")
       end
 
       # Mark an Alert as complete.

data/lib/skykick/error.rb

@@ -0,0 +1,11 @@
+module Skykick
+	
+  # Generic error to be able to rescue all Skykick errors
+  class SkykickError < StandardError; end
+
+  # Error when configuration not sufficient
+  class ConfigurationError < SkykickError; end
+
+  # Error when authentication fails
+  class AuthenticationError < SkykickError; end
+end

data/lib/skykick/pagination.rb

@@ -0,0 +1,44 @@
+require 'uri'
+require 'json'
+
+module Skykick
+  # Defines HTTP request methods
+  # required attributes format
+  module RequestPagination
+
+    # Skykick uses Odata pagination but unfortunately does not support skipping pages.
+    # Using skip responds with "The query specified in the URI is not valid. Query option 
+    # 'Skip' is not allowed. To allow it, set the 'AllowedQueryOptions' property on 
+    # EnableQueryAttribute or QueryValidationSettings."
+    class ODataPagination
+      attr_reader :offset, :limit, :total
+      def initialize(page_size)
+        @offset = 0
+        @limit = page_size
+        # we always have a first page
+        @total = @limit
+      end
+      def page_options
+        { '$top': @limit, '$skip': @offset }
+        { '$top': @limit }
+      end
+      def next_page!(data)
+        # assume array
+        if data.count
+          @total = data.count
+        else
+          @total = 1 
+        end
+        @offset += @limit
+      end
+
+      def self.data(body) 
+        body
+      end
+      # only single page available
+      def more_pages?
+        @offset == 0
+      end
+    end
+  end
+end

data/lib/skykick/version.rb

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

data/lib/skykick.rb

@@ -1,6 +1,7 @@
 require "wrapi"
 require File.expand_path('skykick/api', __dir__)
 require File.expand_path('skykick/client', __dir__)
+require File.expand_path('skykick/pagination', __dir__)
 require File.expand_path('skykick/version', __dir__)
 
 module Skykick
@@ -9,14 +10,15 @@ module Skykick
 
   DEFAULT_ENDPOINT = 'https://apis.skykick.com'.freeze
   DEFAULT_UA = "Skykick Ruby API wrapper #{Skykick::VERSION}".freeze
+  DEFAULT_PAGINATION = Skykick::RequestPagination::ODataPagination
 
-  # Alias for Skykick::Client.new
   #
   # @return [Skykick::Client]
   def self.client(options = {})
     Skykick::Client.new({
       endpoint: DEFAULT_ENDPOINT,
-      user_agent: DEFAULT_UA
+      user_agent: DEFAULT_UA,
+      pagination_class: DEFAULT_PAGINATION
     }.merge(options))
   end
 
@@ -24,5 +26,6 @@ module Skykick
     super
     self.endpoint = DEFAULT_ENDPOINT
     self.user_agent = DEFAULT_UA
+    self.pagination_class = DEFAULT_PAGINATION
   end
 end

data/skykick.gemspec

@@ -29,8 +29,9 @@ Gem::Specification.new do |s|
   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_runtime_dependency 'wrapi', ">= 0.2.0"
   s.add_development_dependency 'dotenv'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skykick
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -28,16 +28,16 @@ dependencies:
   name: wrapi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: []
@@ -99,6 +113,8 @@ files:
 - lib/skykick/client/alerts.rb
 - lib/skykick/client/backup.rb
 - lib/skykick/connection.rb
+- lib/skykick/error.rb
+- lib/skykick/pagination.rb
 - lib/skykick/version.rb
 - skykick.gemspec
 homepage: https://rubygems.org/gems/skykick