sophos_central_api 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04451b9de1b30bc8215d2ba53c65dc525e8d26e1ab0c9029aee862226af6f51b
-  data.tar.gz: 4cf4dbe623d1938faeaf5b53287726276b64dd5cc81b3911dfb0ec033498c31b
+  metadata.gz: ed2be4896987431b40e0fc3b01f61addc9b58485aa3f1157493dadb070a792e2
+  data.tar.gz: 848756dcc5fd520b1f5584acad7a9a318caf569cfd4bbef377b9e646fbc6c5f6
 SHA512:
-  metadata.gz: 5bd33c2679d91ad9735a9b6e8ed28720da5f630a532ca8437449e4270b8dc9b89ead74f7d328403835d64ca070e37b524665637bb5171150a90e6613d8545116
-  data.tar.gz: 8cb69af1e71db88d60772dd6b3d3a2112bb2787a8333913e4e86b2e25130c03ad3620b167c17ceedabd58b89db931c895c36e203d16b4d8d32ae0976e2d1ef65
+  metadata.gz: b0e6aff68a24b83ae099fbb6d4273dc3cfa918b36223fefca96951b51f352081c50bfeef5f246205daf0ec98281a837f32390d151704340e2f048193479a2bf8
+  data.tar.gz: 5aec805aaf3ab8988af7dc8adc50fb4e41564e94bf1cfdfa1fd05b6251bd7ac6a0af0a87fc94b1e619e408b5e1e8266d8ddfa3d86fd2a92bb4dd39c2112731d1

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

@@ -3,3 +3,8 @@
 ## [0.1.0] - 2024-02-14
 - Initial release
 
+## [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

data/README.md

@@ -70,6 +70,27 @@ roles = client.roles
 |.billing_usage(year, month)	  |/partner/v1/billing-usage/{year}/{month}|
 
 
+### Common
+This is the OAS 3.0 specification for the Common API in Sophos Central.
+
+```
+@client = Sophos.client()
+@client.login
+ :
+tenant = @client.tenant(id)
+# create client for tenant
+@client.client(tenant).endpoints
+
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.alerts, .alert(id)								|.../alerts/|
+|.directory_user_groups, .directory_user_groups(id)	|.../directory/user-groups|
+|.directory_user_group_users(id)					|.../directory/user-groups/{id}/users|
+|.directory_users, .directory_user(id)				|.../directory/users|
+|.directory_user_groups(id)							|.../directory/users/{id}/groups|
+
 ### Endpoints
 Returns endpoint for a provided tenant
 ```
@@ -83,7 +104,6 @@ tenant = @client.tenant(id)
 
 |Resource|API endpoint|
 |:--|:--|
-
 |.downloads								|.../downloads/|
 |.endpoint_groups, .endpoint_group(id)	|.../endpoint-groupss/|
 |.migrations, .migration(id)			|.../migrations|

data/lib/sophos/client/partner.rb

@@ -7,28 +7,6 @@ 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
 
@@ -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/client.rb

@@ -9,12 +9,25 @@ module Sophos
   class Client < API
     require File.expand_path('client/partner', __dir__)
 
+    # get client to access api host for given tenant
+    # @return [TenantClient]
+    def client(tenant)
+      tenant_client(tenant.apiHost, tenant.id) if tenant
+    end
+
+    # get teannt client to access api host for given tenant id
+    # @return [TenantClient]
     def tenant_client( api_host, tenant_id )
-      TenantClient.new(self.config.merge({ access_token: access_token, endpoint: api_host, tenant_id: tenant_id, connection_options: { headers: { 'X-Tenant-ID': tenant_id } } }))
+      # create client and copy access_token and set default headers
+      TenantClient.new(self.config.merge({
+        access_token: access_token,
+        endpoint: api_host,
+        tenant_id: tenant_id,
+        connection_options: { headers: { 'X-Tenant-ID': tenant_id } }
+      }))
     end
 
     include Sophos::Client::Partner
-
   end
 
   # Wrapper for the Sophos Central REST API for tenant related calls

data/lib/sophos/configuration.rb

@@ -1,4 +1,6 @@
 require 'wrapi'
+require File.expand_path('version', __dir__)
+require File.expand_path('pagination', __dir__)
 
 module Sophos
   # Defines constants and methods related to configuration
@@ -11,10 +13,35 @@ module Sophos
     # @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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sophos
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 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
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sophos_central_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-14 00:00:00.000000000 Z
+date: 2024-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday