sophos_central_api 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed2be4896987431b40e0fc3b01f61addc9b58485aa3f1157493dadb070a792e2
-  data.tar.gz: 848756dcc5fd520b1f5584acad7a9a318caf569cfd4bbef377b9e646fbc6c5f6
+  metadata.gz: a26247b4f61c367498ff21c935dcd319058384b1684f10c220f6f7700eaa0095
+  data.tar.gz: b6975aedaa003656add82f3fbddc4c15c8f66048faebbc16987ae23e7102a5ba
 SHA512:
-  metadata.gz: b0e6aff68a24b83ae099fbb6d4273dc3cfa918b36223fefca96951b51f352081c50bfeef5f246205daf0ec98281a837f32390d151704340e2f048193479a2bf8
-  data.tar.gz: 5aec805aaf3ab8988af7dc8adc50fb4e41564e94bf1cfdfa1fd05b6251bd7ac6a0af0a87fc94b1e619e408b5e1e8266d8ddfa3d86fd2a92bb4dd39c2112731d1
+  metadata.gz: afdda664f2c0982cc6ae3be738da6f8df8156a8a4287e73c3fc64058e6b6639b31066b17b0f6ea263613c753267902f3a91121f5478eab13ce5ef9e6f2f2bc59
+  data.tar.gz: b77d24174658993217761df3341585db908e973710e4d91eb63f8cad023e295ae83be4c9158bb810397d9ae8bd8f69ab31019afc2d1d4ae6f652c1b5654fe38d

data/CHANGELOG.md

@@ -8,3 +8,9 @@
 
 ## [0.1.2] - 2024-02-15
 - Fix initialization issue
+
+## [0.2.0] - 2024-02-20
+- Configuration and authentication exceptions changed
+
+## [0.2.1] - 2024-07-17
+- Fix issue with paging for endpoints

data/Gemfile

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

data/README.md

@@ -1,4 +1,7 @@
 # Sophos Central Partner API
+[![Version](https://img.shields.io/gem/v/sophos_central_api.svg)](https://rubygems.org/gems/sophos_central_api)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0e0c212559aad49a915c/maintainability)](https://codeclimate.com/github/jancotanis/sophos/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0e0c212559aad49a915c/test_coverage)](https://codeclimate.com/github/jancotanis/sophos/test_coverage)
 
 This is a wrapper for the Sophos Central Partner API. You can see the API endpoints here https://developer.sophos.com/getting-started
 
@@ -9,7 +12,7 @@ Currently only the GET requests to customers, endpoints and alerts are implement
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sophos_partner_api'
+gem 'sophos_central_api'
 ```
 
 And then execute:
@@ -18,14 +21,14 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install sophos_partner_api
+    $ gem install sophos_central_api
 
 ## Usage
 
 Before you start making the requests to API provide the client id and client secret and email/password using the configuration wrapping.
 
-```
-require 'sophos_partner_api'
+```ruby
+require 'sophos_central_api'
 
 Sophos.configure do |config|
   config.client_id = ENV["SOPHOS_CLIENT_ID"]
@@ -43,7 +46,7 @@ end
 
 ## Resources
 ### Authentication
-```
+```ruby
 # setup configuration
 #
 client.login
@@ -55,7 +58,7 @@ client.login
 
 ### Partner
 Endpoint for partner  related requests 
-```
+```ruby
 roles = client.roles
 ```
 
@@ -73,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
  :
@@ -93,7 +96,7 @@ tenant = @client.tenant(id)
 
 ### Endpoints
 Returns endpoint for a provided tenant
-```
+```ruby
 @client = Sophos.client()
 @client.login
  :

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/sophos/authentication.rb

@@ -1,5 +1,7 @@
+require 'faraday'
 require 'json'
 require 'uri'
+require File.expand_path('error', __dir__)
 
 module Sophos
   # Deals with authentication flow and stores it within global configuration
@@ -8,22 +10,20 @@ module Sophos
     # Authorize to the Sophos portal and return access_token
     # @see https://developer.sophos.com/getting-started
     def auth_token(options = {})
+      raise ConfigurationError.new 'Client id and/or secret not configured' unless client_id && client_secret
       # use id endpoint instead of global api
       response = connection.post(id_endpoint+'/api/v2/oauth2/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)
-
+      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 raise StandardError.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
     end
     alias login auth_token
 
@@ -39,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 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 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/client/endpoint.rb

@@ -11,23 +11,23 @@ module Sophos
       Helper::def_api_call :downloads, Helper::endpoint_url(:downloads)
 
       # @see https://developer.sophos.com/docs/endpoint-v1/1/routes/endpoint-groups/get
-      Helper::def_api_call :endpoint_groups, Helper::endpoint_url(:endpoint_groups), true
+      Helper::def_api_call :endpoint_groups, Helper::endpoint_url(:endpoint_groups), :endpoint_group
       def endpoint_group_endpoints(group_id)
         get_paged Helper::endpoint_url("endpoint-groups/#{group_id}/endpoints")
       end
 
       # @see https://developer.sophos.com/docs/endpoint-v1/1/routes/migrations/get
-      Helper::def_api_call :migrations, Helper::endpoint_url(:migrations), true
+      Helper::def_api_call :migrations, Helper::endpoint_url(:migrations), :migration
       def migration_endpoints(migration_id)
         get_paged Helper::endpoint_url("migrations/#{migration_id}/endpoints")
       end
 
       # @see https://developer.sophos.com/docs/endpoint-v1/1/routes/policies/get
-      Helper::def_api_call :policies, Helper::endpoint_url(:policies), true
+      Helper::def_api_call :policies, Helper::endpoint_url(:policies), :policy
 
       # Get all the endpoints for the specified tenant. No endpoint method defined as this clashes with api endpoint method
       # @see https://developer.sophos.com/docs/endpoint-v1/1/routes/endpoints/get
-      Helper::def_api_call :endpoints, Helper::endpoint_url(:endpoints), false
+      Helper::def_api_call :endpoints, Helper::endpoint_url(:endpoints)
       def endpoint_isolation(endpoint_id)
         get Helper::endpoint_url("endpoints/#{endpoint_id}/isolation")
       end

data/lib/sophos/client/helper.rb

@@ -8,26 +8,17 @@ module Sophos
         method_name.to_s.gsub('_', '-')
       end
 
-      def self.singular method_name
-        method_name = method_name.to_s.gsub(/s$/, '') 
-        method_name.gsub(/ie$/, 'y').to_sym
-      end
-
-      def self.common_url(method)
-        "/common/v1/#{sanitize(method)}"
-      end
-
-      def self.endpoint_url(method)
-        "/endpoint/v1/#{sanitize(method)}"
-      end
-
-      def self.partner_url(method)
-        "/partner/v1/#{sanitize(method)}"
+      def self.common_url(method) self.url('common', method); end
+      def self.endpoint_url(method) self.url('endpoint', method); end
+      def self.partner_url(method) self.url('partner', method); end
+      
+      def self.url(api,method)
+        "/#{api}/v1/#{sanitize(method)}"
       end
 
       # generate end point for 'endpoint' and 'endpoints'
-      def self.def_api_call(method, url, id_field = false, paged = true)
-        if id_field
+      def self.def_api_call(method, url, singular_method = nil, paged = true)
+        if singular_method
           self.send(:define_method, method) do |id = nil, params = {}|
             if id
               get("#{url}/#{id}", params)
@@ -36,8 +27,7 @@ module Sophos
             end
           end
           # strip trailing 's'
-          singlr = self.singular(method) #method.to_s.chop.to_sym
-          self.send(:define_method, singlr) do |id, params = {}|
+          self.send(:define_method, singular_method) do |id, params = {}|
             get("#{url}/#{id}", params)
           end
         else

data/lib/sophos/client/partner.rb

@@ -8,13 +8,13 @@ module Sophos
     module Partner
 
       # @see https://developer.sophos.com/docs/partner-v1/1/routes/tenants/get
-      Helper::def_api_call :tenants, Helper::partner_url(:tenants), true
+      Helper::def_api_call :tenants, Helper::partner_url(:tenants), :tenant
 
       # @see https://developer.sophos.com/docs/partner-v1/1/routes/roles/get
-      Helper::def_api_call :roles, Helper::partner_url(:roles), true
+      Helper::def_api_call :roles, Helper::partner_url(:roles), :role
 
       # @see https://developer.sophos.com/docs/partner-v1/1/routes/admins/get
-      Helper::def_api_call :admins, Helper::partner_url(:admins), true
+      Helper::def_api_call :admins, Helper::partner_url(:admins), :admin
 
       # Get the list of role assignments for given admin.
       # @see https://developer.sophos.com/docs/partner-v1/1/routes/admins/%7BadminId%7D/role-assignments/get

data/lib/sophos/configuration.rb

@@ -7,7 +7,7 @@ module Sophos
   module Configuration
     include WrAPI::Configuration
 
-    # An array of additional valid keys in the options hash when configuring a {Sophos::API}
+    # An array of additional valid keys in the options hash when configuring a [Sophos::API]
     VALID_OPTIONS_KEYS = (WrAPI::Configuration::VALID_OPTIONS_KEYS + [:partner_id, :tenant_id, :id_endpoint]).freeze
 
     # @private

data/lib/sophos/error.rb

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

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.1.2'
+  VERSION = '0.2.1'
 end

data/lib/sophos_central_api.rb

@@ -9,6 +9,6 @@ module Sophos
   #
   # @return [Sophos::Client]
   def self.client(options = {})
-    Sophos::Client.new
+    Sophos::Client.new(options)
   end
 end

data/sophos_central_api.gemspec

@@ -32,5 +32,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'wrapi', ">= 0.3.0"
   s.add_development_dependency 'dotenv'
   s.add_development_dependency 'minitest'
+  s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sophos_central_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-15 00:00:00.000000000 Z
+date: 2024-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,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'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +106,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/cc-test-reporter.exe
 - lib/sophos/api.rb
 - lib/sophos/authentication.rb
 - lib/sophos/client.rb
@@ -100,6 +115,7 @@ files:
 - lib/sophos/client/helper.rb
 - lib/sophos/client/partner.rb
 - lib/sophos/configuration.rb
+- lib/sophos/error.rb
 - lib/sophos/pagination.rb
 - lib/sophos/version.rb
 - lib/sophos_central_api.rb
@@ -125,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)