sophos_central_api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4001f1778a4cbba03903acb2007aeca8c0840b351baf9654e2e238efb5b1650a
-  data.tar.gz: fd8467571f6574c9647faab25aa1fc3016a6e1321a179ba5a94de32911cb4fc2
+  metadata.gz: de42982e7073acef13887732efb277b3f24e31fcf34552f7857100edc20b99a2
+  data.tar.gz: 40425c2083e372ea6434f86723209ddd1673a1055ca8fc26e9bac997fb961305
 SHA512:
-  metadata.gz: df69465b988d9cdc9460ea1e3220eb5e8516386b1c1b6b54d44885c23724c6eac20084053eb7002bc0b1d7bca600e181000879bac27192f0fc2aa4fea14311d1
-  data.tar.gz: 5766c1061673b8fc638573094111ca4c0023c25d02c58480cc824874187c981e39dce26aeaf93c6ccbacde44b0c862589f973db52789de5d3bb26023dff3ac98
+  metadata.gz: 4c3655439d962b32baef1e85a1ec31e4442c103472a82d0a2388d271fccde35c2fadb43088fd07db5ef3676d99331cea568f4019f61705b54a88577a7f97e073
+  data.tar.gz: 47cc68a252b5ad954f6bb6b48aae862b27e48ab35e0bacdb8c1fb605dd4d322d2af1325ec5457bef5ad6c970d20ac5f01c23e30705bd41f50c58a0c0e55c208b

data/.env.template

@@ -1,2 +1,3 @@
 SOPHOS_CLIENT_ID=<SOPHOS_CLIENT_ID>
 SOPHOS_CLIENT_SECRET=<SOPHOS_CLIENT_SECRET>
+TEST_TENANT=<TENANT ID>

data/CHANGELOG.md

@@ -6,3 +6,8 @@
 ## [0.1.1] - 2024-02-14
 - Convienience method added to get client for a teannt api host
 
+## [0.1.2] - 2024-02-15
+- Fix initialization issue
+
+## [0.2.0] - 2024-02-20
+- Configuration and authentication exceptions changed

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'
+require 'sophos_central_api'
 
 Sophos.configure do |config|
   config.client_id = ENV["SOPHOS_CLIENT_ID"]

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,6 +10,7 @@ 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'
@@ -22,8 +25,10 @@ module Sophos
         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
+        raise AuthenticationError.new 'Partner id not returned; response ' + response.to_s
       end
+    rescue Faraday::UnauthorizedError => e
+        raise AuthenticationError.new 'Unauthorized; response ' + e.to_s
     end
     alias login auth_token
 
@@ -43,7 +48,7 @@ module Sophos
       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?
+      raise AuthenticationError.new 'Could not find valid access_token; response ' + response.to_s if at.nil? || at.empty?
 
       at
     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

@@ -7,36 +7,14 @@ module Sophos
     # @see https://developer.sophos.com/docs/partner-v1/1/overview
     module Partner
 
-      def self.__def_partner_call(method, id_field = nil)
-        if id_field
-          self.send(:define_method, method) do |id = nil|
-            url = partner_url(method)
-            if id
-              get(partner_url("#{method}/#{id}"))
-            else
-              get_paged(url)
-            end
-          end
-          # strip trailing 's'
-          singular = method.to_s.chop.to_sym
-          self.send(:define_method, singular) do |id, params = nil|
-            get(partner_url("#{method}/#{id}", params))
-          end
-        else
-          self.send(:define_method, method) do
-            get_paged(partner_url(method))
-          end
-        end
-      end
-
       # @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
@@ -61,11 +39,6 @@ module Sophos
         get_paged(Helper::partner_url("billing/usage/#{year}/#{month}"), params)
       end
 
-    private
-
-      def __partner_url(method, id = nil)
-        "/partner/v1/#{method}"
-      end
     end
   end
 end

data/lib/sophos/configuration.rb

@@ -1,20 +1,47 @@
 require 'wrapi'
+require File.expand_path('version', __dir__)
+require File.expand_path('pagination', __dir__)
 
 module Sophos
   # Defines constants and methods related to configuration
   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
     attr_accessor *VALID_OPTIONS_KEYS
 
+    DEFAULT_ENDPOINT = 'https://api.central.sophos.com'.freeze
+    DEFAULT_ID_ENDPOINT = 'https://id.sophos.com'.freeze
+    DEFAULT_UA = "Sophos Ruby API wrapper #{Sophos::VERSION}".freeze
+    DEFAULT_PAGINATION = Sophos::RequestPagination::PagesPagination
+    DEFAULT_PAGE_SIZE = 100
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
     # Reset all configuration options to defaults
     def reset
       super
       self.partner_id = nil
+      self.tenant_id = nil
+
+      self.endpoint = DEFAULT_ENDPOINT
+      self.id_endpoint = DEFAULT_ID_ENDPOINT
+      self.user_agent = DEFAULT_UA
+      self.page_size = DEFAULT_PAGE_SIZE
+      self.pagination_class = DEFAULT_PAGINATION
     end
   end
 end

data/lib/sophos/error.rb

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

data/lib/sophos/version.rb

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

data/lib/sophos_central_api.rb

@@ -1,37 +1,14 @@
 require "wrapi"
 require File.expand_path('sophos/api', __dir__)
 require File.expand_path('sophos/client', __dir__)
-require File.expand_path('sophos/pagination', __dir__)
-require File.expand_path('sophos/version', __dir__)
 
 module Sophos
   extend Configuration
   extend WrAPI::RespondTo
 
-  DEFAULT_ENDPOINT = 'https://api.central.sophos.com'.freeze
-  DEFAULT_ID_ENDPOINT = 'https://id.sophos.com'.freeze
-  DEFAULT_UA = "Sophos Ruby API wrapper #{Sophos::VERSION}".freeze
-  DEFAULT_PAGINATION = Sophos::RequestPagination::PagesPagination
-  DEFAULT_PAGE_SIZE = 100
-
   #
   # @return [Sophos::Client]
   def self.client(options = {})
-    Sophos::Client.new({
-      endpoint: DEFAULT_ENDPOINT,
-      id_endpoint: DEFAULT_ID_ENDPOINT,
-      user_agent: DEFAULT_UA,
-      page_size: DEFAULT_PAGE_SIZE,
-      pagination_class: DEFAULT_PAGINATION
-    }.merge(options))
-  end
-
-  def self.reset
-    super
-    self.endpoint = DEFAULT_ENDPOINT
-    self.id_endpoint = DEFAULT_ID_ENDPOINT
-    self.user_agent = DEFAULT_UA
-    self.page_size = DEFAULT_PAGE_SIZE
-    self.pagination_class = DEFAULT_PAGINATION
+    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.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-14 00:00:00.000000000 Z
+date: 2024-02-20 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