cloudally 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f46745c7981091945d40c86bd68e6004dff4ea39ecaa436225c9d5df00a535
-  data.tar.gz: 2bf09895b3b8df0b1741f87b41c1f8d2a16c4b5fbb53c0047b9eaa5adcc7e399
+  metadata.gz: 3e29633647fb8984a79c99fcd163a8ec7a394aee08e70fa9b769841ac8a2f0b4
+  data.tar.gz: 6231ffb138601eb3719500f778758b9824a83a3e51032d25d4420ef9bbe605f2
 SHA512:
-  metadata.gz: '068f074ab511b4f91073553debfb77f96a81a0e7e82f1c3f02d02618be89c50217acb19fa18f964ee73270e9cb740654b426a159d60d84b846bed9eadceabc2e'
-  data.tar.gz: 78b7f883e82d2e0bd2e25654d74223c3409ace9bc1f64d6f374b3ca8e5b565bfece1de7bd822e3ec6d0891ec4102939358d56e91c270380288461d120dd0735a
+  metadata.gz: bf7fb20897ffd7c2c443824dab575b922458ffb1c12f55e15ab220412d174b44a90744a1c764537e3a44d3f5a496c72ef207f352c49bb569d189c6a56957aaa1
+  data.tar.gz: 2ba40d29f87ead154cf16f18ba26080fd4469de2b96d7c4cf9c02d7bd1b84ae999df2caed48dd95511eda0102b23ca7c6394fe46c0c15fd43aebae07f4828c3e

data/CHANGELOG.md

@@ -17,3 +17,10 @@
 
 ## [0.2.1] - 2024-01-30
 -  use wrapi gem
+
+## [0.2.2] - 2024-02-08
+-  updated wrapi pagination
+
+## [0.3.0] - 2024-02-21
+-  Harmonization exceptions
+

data/Gemfile

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

data/README.md

@@ -1,4 +1,7 @@
 # Cloudally API
+[![Version](https://img.shields.io/gem/v/cloudally.svg)](https://rubygems.org/gems/cloudally)
+[![Maintainability](https://api.codeclimate.com/v1/badges/fc344d88ac45777b3168/maintainability)](https://codeclimate.com/github/jancotanis/cloudally/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/fc344d88ac45777b3168/test_coverage)](https://codeclimate.com/github/jancotanis/cloudally/test_coverage)
 
 
 This is a wrapper for the CloudAlly portal API v1. You can see the API endpoints here https://api.cloudally.com/documentation

data/Rakefile

@@ -1,14 +1,22 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+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"]
+  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"
+require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 task default: %i[test rubocop]

data/cloudally.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

data/lib/cloudally/authentication.rb

@@ -1,25 +1,36 @@
+require 'faraday'
+require File.expand_path('error', __dir__)
 
 module CloudAlly
   # Deals with authentication flow and stores it within global configuration
   module Authentication
     # Authorize to the CloudAlly portal and return access_token
     def auth(options = {})
+      raise raise ConfigurationError.new "client_id and/or client_secret empty" unless client_id && client_secret
       api_auth('/auth', options)
+    rescue Faraday::UnauthorizedError => e
+      raise AuthenticationError.new e.to_s
     end
     alias login auth
 
     # Return an access token from authorization
     def auth_refresh(token)
       api_refresh('/auth/refresh', token)
+    rescue Faraday::UnauthorizedError => e
+      raise AuthenticationError.new e.to_s
     end
 
     # Authorize to the partner portal and return access_token
     def auth_partner(options = {})
+      raise raise ConfigurationError.new "client_id and/or client_secret empty" unless client_id && client_secret
       api_auth('/auth/partner', options)
+    rescue Faraday::ServerError, Faraday::UnauthorizedError => e
+      raise AuthenticationError.new e.to_s
     end
     alias partner_login auth_partner
   private
     def api_access_token_params
+      raise raise ConfigurationError.new "username and/or password empty" unless username && password
       {
         email: username,
         password: password

data/lib/cloudally/error.rb

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

data/lib/cloudally/pagination.rb

@@ -0,0 +1,37 @@
+require 'uri'
+require 'json'
+
+module CloudAlly
+  # Defines HTTP request methods
+  # required attributes format
+  module RequestPagination
+
+    class Pager
+      def initialize(page_size)
+        @page = 1
+        @page_size = page_size
+        @total = @page + 1
+        @next_page = ''
+      end
+      def page_options
+        following_page = { pageSize: @page_size }
+        unless @next_page.empty?
+          following_page.merge!({ page: @page, nextPageToken: @next_page }) 
+        else
+          following_page
+        end
+      end
+      def next_page!(data)
+        @page += 1
+        @total = data['totalPages'].to_i
+        @next_page = data['nextPageToken']
+      end
+      def self.data(body) 
+        body['data'] ? body['data'] : body
+      end
+      def more_pages?
+        @page < @total
+      end
+    end
+  end
+end

data/lib/cloudally/version.rb

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

data/lib/cloudally.rb

@@ -3,6 +3,7 @@ require "wrapi"
 require File.expand_path('cloudally/api', __dir__)
 require File.expand_path('cloudally/client', __dir__)
 require File.expand_path('cloudally/version', __dir__)
+require File.expand_path('cloudally/pagination', __dir__)
 
 module CloudAlly
   extend WrAPI::Configuration
@@ -10,6 +11,7 @@ module CloudAlly
 
   DEFAULT_ENDPOINT  = 'https://api.cloudally.com/v1/'.freeze
   DEFAULT_USERAGENT = "CloudAlly Ruby API wrapper #{CloudAlly::VERSION}".freeze
+  DEFAULT_PAGINATION = CloudAlly::RequestPagination::Pager
 
   # Alias for CloudAlly::Client.new
   #
@@ -17,7 +19,8 @@ module CloudAlly
   def self.client(options = {})
     CloudAlly::Client.new({
       endpoint: DEFAULT_ENDPOINT,
-      user_agent: DEFAULT_USERAGENT
+      user_agent: DEFAULT_USERAGENT,
+      pagination_class: DEFAULT_PAGINATION
     }.merge(options))
   end
   
@@ -25,5 +28,6 @@ module CloudAlly
     super
     self.endpoint = DEFAULT_ENDPOINT
     self.user_agent = DEFAULT_USERAGENT
+    self.pagination_class = DEFAULT_PAGINATION
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudally
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,14 +30,14 @@ dependencies:
     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: []
@@ -92,12 +106,15 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/cc-test-reporter.exe
 - cloudally.gemspec
 - lib/cloudally.rb
 - lib/cloudally/api.rb
 - lib/cloudally/authentication.rb
 - lib/cloudally/client.rb
 - lib/cloudally/client/partners.rb
+- lib/cloudally/error.rb
+- lib/cloudally/pagination.rb
 - lib/cloudally/version.rb
 homepage: https://rubygems.org/gems/cloudally
 licenses: