garf-core 0.0.6__tar.gz → 0.0.8__tar.gz

{garf_core-0.0.6 → garf_core-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: garf-core
-Version: 0.0.6
+Version: 0.0.8
 Summary: Abstracts fetching data from API based on provided SQL-like query.
 Author-email: "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>
 License: Apache 2.0

{garf_core-0.0.6 → garf_core-0.0.8}/garf_core/__init__.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '0.0.6'
+__version__ = '0.0.8'

{garf_core-0.0.6 → garf_core-0.0.8}/garf_core/api_clients.py

@@ -19,6 +19,7 @@ import abc
 import dataclasses
 from collections.abc import Sequence
 
+import requests
 from typing_extensions import override
 
 
@@ -34,16 +35,40 @@ class GarfApiResponse:
   results: list
 
 
+class GarfApiError(Exception):
+  """API specific exception."""
+
+
 class BaseClient(abc.ABC):
   """Base API client class."""
 
   @abc.abstractmethod
   def get_response(
-    self, request: GarfApiRequest = GarfApiRequest()
+    self, request: GarfApiRequest = GarfApiRequest(), **kwargs: str
   ) -> GarfApiResponse:
     """Method for getting response."""
 
 
+class RestApiClient(BaseClient):
+  """Specifies REST client."""
+
+  OK = 200
+
+  def __init__(self, endpoint: str, **kwargs: str) -> None:
+    """Initializes RestApiClient."""
+    self.endpoint = endpoint
+    self.query_args = kwargs
+
+  @override
+  def get_response(
+    self, request: GarfApiRequest = GarfApiRequest(), **kwargs: str
+  ) -> GarfApiResponse:
+    response = requests.get(f'{self.endpoint}/{request.resource_name}')
+    if response.status_code == self.OK:
+      return GarfApiResponse(response.json())
+    raise GarfApiError('Failed to get data from API')
+
+
 class FakeApiClient(BaseClient):
   """Fake class for specifying API client."""
 

{garf_core-0.0.6 → garf_core-0.0.8}/garf_core/report_fetcher.py

@@ -38,21 +38,30 @@ class ApiReportFetcher:
 
   Attributes:
       api_client: a client used for connecting to API.
+      parser: Type of parser to convert API response.
+      query_specification_builder: Class to perform query parsing.
   """
 
   def __init__(
     self,
     api_client: api_clients.BaseApiClient,
     parser: parsers.BaseParser = parsers.ListParser,
+    query_specification_builder: query_editor.QuerySpecification = (
+      query_editor.QuerySpecification
+    ),
+    **kwargs: str,
   ) -> None:
     """Instantiates ApiReportFetcher based on provided api client.
 
     Args:
       api_client: Instantiated api client.
-      parser: Parser.
+      parser: Type of parser to convert API response.
+      query_specification_builder: Class to perform query parsing.
     """
     self.api_client = api_client
     self.parser = parser()
+    self.query_specification_builder = query_specification_builder
+    self.query_args = kwargs
 
   async def afetch(
     self,
@@ -63,12 +72,12 @@ class ApiReportFetcher:
     """Asynchronously fetches data from API based on query_specification.
 
     Args:
-        query_specification: Query text that will be passed to API
-            alongside column_names, customizers and virtual columns.
-        args: Arguments that need to be passed to the query.
+      query_specification: Query text that will be passed to API
+        alongside column_names, customizers and virtual columns.
+      args: Arguments that need to be passed to the query.
 
     Returns:
-        GarfReport with results of query execution.
+      GarfReport with results of query execution.
     """
     return self.fetch(query_specification, args, **kwargs)
 
@@ -81,19 +90,19 @@ class ApiReportFetcher:
     """Fetches data from API based on query_specification.
 
     Args:
-        query_specification: Query text that will be passed to API
-            alongside column_names, customizers and virtual columns.
-        args: Arguments that need to be passed to the query.
+      query_specification: Query text that will be passed to API
+        alongside column_names, customizers and virtual columns.
+      args: Arguments that need to be passed to the query.
 
     Returns:
-        GarfReport with results of query execution.
+      GarfReport with results of query execution.
 
     Raises:
-        GarfExecutorException:
-            When customer_ids are not provided or API returned error.
+      GarfExecutorException:
+        When customer_ids are not provided or API returned error.
     """
     if not isinstance(query_specification, query_editor.QuerySpecification):
-      query_specification = query_editor.QuerySpecification(
+      query_specification = self.query_specification_builder(
         text=str(query_specification),
         args=args,
       )
@@ -103,3 +112,26 @@ class ApiReportFetcher:
     return report.GarfReport(
       results=parsed_response, column_names=query.column_names
     )
+
+
+class RestApiReportFetcher(ApiReportFetcher):
+  """Fetches data from an REST API endpoint.
+
+  Attributes:
+    api_client: Initialized RestApiClient.
+    parser: Type of parser to convert API response.
+  """
+
+  def __init__(
+    self,
+    endpoint: str,
+    parser: parsers.BaseParser = parsers.DictParser,
+  ) -> None:
+    """Instantiates RestApiReportFetcher.
+
+    Args:
+      endpoint: URL of API endpoint.
+      parser: Type of parser to convert API response.
+    """
+    self.api_client = api_clients.RestApiClient(endpoint)
+    self.parser = parser()

{garf_core-0.0.6 → garf_core-0.0.8}/garf_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: garf-core
-Version: 0.0.6
+Version: 0.0.8
 Summary: Abstracts fetching data from API based on provided SQL-like query.
 Author-email: "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>
 License: Apache 2.0

{garf_core-0.0.6 → garf_core-0.0.8}/garf_core.egg-info/SOURCES.txt

@@ -11,5 +11,6 @@ garf_core/report_fetcher.py
 garf_core.egg-info/PKG-INFO
 garf_core.egg-info/SOURCES.txt
 garf_core.egg-info/dependency_links.txt
+garf_core.egg-info/entry_points.txt
 garf_core.egg-info/requires.txt
 garf_core.egg-info/top_level.txt

garf_core-0.0.8/garf_core.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[garf]
+rest = garf_core.report_fetcher

{garf_core-0.0.6 → garf_core-0.0.8}/pyproject.toml

@@ -33,6 +33,9 @@ dynamic=["version"]
 [tool.setuptools.dynamic]
 version = {attr = "garf_core.__version__"}
 
+[project.entry-points.garf]
+rest = "garf_core.report_fetcher"
+
 [project.optional-dependencies]
 pandas=[
   "pandas",