skykick 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7eb504e67e460c967701af6aeee5480111a27080571dad031543cd2051d4aeb
-  data.tar.gz: 2066d5b75aa42485f0e121b2921dcd826b2103374119f9cd75155a1e9fec2b9d
+  metadata.gz: 4e219c7c7f5e5af499eb2dfa75b4f26ec1b44a0feec1f388debf960f7c623e91
+  data.tar.gz: 2cec92749ffd33a36a0ea36d583dd025f304c8672c5bf1469146986642bd72f2
 SHA512:
-  metadata.gz: d72996b30a489b055633198d433492e6d4ecc60382b6547b4d922dd42bc52f5d676c09903d575e72f23cd902175ba52756c180c70033abd55427e572972d5eda
-  data.tar.gz: 75339902414d3ad99dbc346769471a1bb06d638f3f0cd0da0a0bc94080803d43573ad2595dba2b1bea1efb6c858616f57dfbd013965d41a41d61f871cb831033
+  metadata.gz: b152d1d931fd129b0c921c3d9634831c6037f0d5cca1eb10f9ea16daaae1d886c5234e8a736be2a1a13b76daa3eae0b196bc81eacdc45703d42f8595e35359b0
+  data.tar.gz: dda82313a9f6208348f1381ae01e08773591033cce4a90d2cc61d215bd8a189a9025d2bdf96aae5861b504c4de68432f230523c8309159b0c456fc643887e575

data/CHANGELOG.md

@@ -5,3 +5,9 @@
 
 ## [0.1.1] - 2024-02-08
 - Update OData support
+
+## [0.2.0] - 2024-02-20
+- Exception handling harmonized
+
+## [0.2.1] - 2024-03-06
+- Upgrade faraday 2

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,7 +58,7 @@ client.login
 
 ### Backup
 Endpoint for backup related requests 
-```
+```ruby
 subscriptions = client.subscriptions
 ```
 
@@ -77,7 +80,7 @@ subscriptions = client.subscriptions
 
 ### Alerts
 Returns Alerts for a provided Email Migration Order ID or Backup service ID.
-```
+```ruby
 subscriptions = client.subscriptions
 alerts = client.alerts(subscriptions.first.id)
 
@@ -89,7 +92,7 @@ alerts = client.alerts(subscriptions.first.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,14 +7,20 @@ 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)
+      c.request :authorization, :basic, 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)
+
+      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/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/version.rb

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

data/skykick.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |s|
   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.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -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: []
@@ -92,6 +106,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/cc-test-reporter.exe
 - lib/skykick.rb
 - lib/skykick/api.rb
 - lib/skykick/authentication.rb
@@ -99,6 +114,7 @@ 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
@@ -123,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.12
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A Ruby wrapper for the Skykick backup Portal REST APIs (readonly)