sophos_central_api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de42982e7073acef13887732efb277b3f24e31fcf34552f7857100edc20b99a2
-  data.tar.gz: 40425c2083e372ea6434f86723209ddd1673a1055ca8fc26e9bac997fb961305
+  metadata.gz: a26247b4f61c367498ff21c935dcd319058384b1684f10c220f6f7700eaa0095
+  data.tar.gz: b6975aedaa003656add82f3fbddc4c15c8f66048faebbc16987ae23e7102a5ba
 SHA512:
-  metadata.gz: 4c3655439d962b32baef1e85a1ec31e4442c103472a82d0a2388d271fccde35c2fadb43088fd07db5ef3676d99331cea568f4019f61705b54a88577a7f97e073
-  data.tar.gz: 47cc68a252b5ad954f6bb6b48aae862b27e48ab35e0bacdb8c1fb605dd4d322d2af1325ec5457bef5ad6c970d20ac5f01c23e30705bd41f50c58a0c0e55c208b
+  metadata.gz: afdda664f2c0982cc6ae3be738da6f8df8156a8a4287e73c3fc64058e6b6639b31066b17b0f6ea263613c753267902f3a91121f5478eab13ce5ef9e6f2f2bc59
+  data.tar.gz: b77d24174658993217761df3341585db908e973710e4d91eb63f8cad023e295ae83be4c9158bb810397d9ae8bd8f69ab31019afc2d1d4ae6f652c1b5654fe38d

data/CHANGELOG.md

@@ -11,3 +11,6 @@
 
 ## [0.2.0] - 2024-02-20
 - Configuration and authentication exceptions changed
+
+## [0.2.1] - 2024-07-17
+- Fix issue with paging for endpoints

data/README.md

@@ -27,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 'sophos_central_api'
 
 Sophos.configure do |config|
@@ -46,7 +46,7 @@ end
 
 ## Resources
 ### Authentication
-```
+```ruby
 # setup configuration
 #
 client.login
@@ -58,7 +58,7 @@ client.login
 
 ### Partner
 Endpoint for partner  related requests 
-```
+```ruby
 roles = client.roles
 ```
 
@@ -76,7 +76,7 @@ roles = client.roles
 ### Common
 This is the OAS 3.0 specification for the Common API in Sophos Central.
 
-```
+```ruby
 @client = Sophos.client()
 @client.login
  :
@@ -96,7 +96,7 @@ tenant = @client.tenant(id)
 
 ### Endpoints
 Returns endpoint for a provided tenant
-```
+```ruby
 @client = Sophos.client()
 @client.login
  :

data/lib/sophos/authentication.rb

@@ -17,18 +17,13 @@ module Sophos
         request.body = URI.encode_www_form( api_access_token_params )
       end
       api_process_token(response.body)
-
+      setup_connection
       # use default endpoint and replace it with global endpoint
-      partner = self.get( "/whoami/v1" )
-      if 'partner'.eql?(partner.idType) && partner.id
-        self.partner_id = partner.id
-        self.endpoint = partner.apiHosts.global
-        self.connection_options = { headers: { 'X-partner-id': self.partner_id } }
-      else
-        raise AuthenticationError.new 'Partner id not returned; response ' + response.to_s
-      end
+      self.access_token
+
     rescue Faraday::UnauthorizedError => e
-        raise AuthenticationError.new 'Unauthorized; response ' + e.to_s
+
+      raise AuthenticationError.new 'Unauthorized; response ' + e.to_s
     end
     alias login auth_token
 
@@ -44,13 +39,23 @@ module Sophos
     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 AuthenticationError.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 AuthenticationError.new 'Could not find valid access_token; response ' + response.to_s if self.access_token.nil? || self.access_token.empty?
+    end
+    
+    def setup_connection
+      partner = self.get( "/whoami/v1" )
+      if 'partner'.eql?(partner.idType) && partner.id
+        self.partner_id = partner.id
+        self.endpoint = partner.apiHosts.global
+        self.connection_options = { headers: { 'X-partner-id': self.partner_id } }
+      else
+        raise AuthenticationError.new 'Partner id not returned; response ' + partner.to_s
+      end
     end
   end
 end

data/lib/sophos/error.rb

@@ -1,9 +1,9 @@
 module Sophos
 	
-  # Generic error to be able to rescue all Zabbix errors
+  # Generic error to be able to rescue all Sophos errors
   class SophosError < StandardError; end
 
-  # Raised when Zabbix not configured correctly
+  # Raised when Sophos not configured correctly
   class ConfigurationError < SophosError; end
 
   # Error when authentication fails

data/lib/sophos/pagination.rb

@@ -24,10 +24,13 @@ module Sophos
         # ignore page size
         @page_size = page_size
         @total = @current = 1
+        @nextKey = nil
       end
 
       def page_options
-        { 'page': @current, 'pageSize': @page_size, 'pageTotal': true }
+        options = { 'page': @current, 'pageSize': @page_size, 'pageTotal': true }
+        options = options.merge({ 'pageFromKey': @nextKey }) if @current > 1
+        options
       end
 
       def next_page!(data)
@@ -40,6 +43,7 @@ module Sophos
           else
             @current += 1
           end
+          @nextKey = pages['nextKey'] if pages['nextKey']
         else
           # no page info so assume single page request
           @total = 0

data/lib/sophos/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sophos_central_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -141,7 +141,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 Sophos Central REST APIs (readonly)