Add Query Params and Basic Functionality Test

Author: smashedr

.github/workflows/test.yaml

@@ -0,0 +1,86 @@
+name: "Test"
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [master]
+    #paths: &paths
+    paths:
+      - ".github/workflows/test.yaml"
+      - "src/**"
+      - "tests/**"
+      - "pyproject.toml"
+  #pull_request:
+  #  paths: *paths
+
+jobs:
+  build:
+    name: "Build"
+    if: ${{ !contains(github.event.head_commit.message, '#notest') }}
+    uses: ./.github/workflows/build.yaml
+    with:
+      name: test
+
+    permissions:
+      contents: read
+
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    needs: [build]
+    strategy:
+      fail-fast: false
+      matrix:
+        version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+    name: "Test ${{ matrix.version }}"
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v6
+
+      - name: "Debug event.json"
+        if: ${{ !github.event.act }}
+        continue-on-error: true
+        run: cat "${GITHUB_EVENT_PATH}"
+
+      - name: "Debug CTX github"
+        if: ${{ !github.event.act }}
+        continue-on-error: true
+        env:
+          GITHUB_CTX: ${{ toJSON(github) }}
+        run: echo "$GITHUB_CTX"
+
+      - name: "Debug Environment"
+        if: ${{ !github.event.act }}
+        continue-on-error: true
+        run: env
+
+      - name: "Download Artifact"
+        uses: actions/download-artifact@v6
+        with:
+          name: test
+          path: dist
+
+      - name: "Setup Python ${{ matrix.version }}"
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.version }}
+          cache: "pip"
+
+      - name: "Install ${{ matrix.version }}"
+        run: |
+          python -V
+          python -m pip install -U pip pytest
+          python -m pip install dist/*.whl
+
+      #- name: "Debug ${{ matrix.version }}"
+      #  run: |
+      #    ls -lAhR dist/
+
+      - name: "Test ${{ matrix.version }}"
+        #continue-on-error: ${{ contains('dev', matrix.version) }}
+        run: |
+          pytest -s

README.md

@@ -76,8 +76,8 @@ vultr = Vultr('VULTR_API_KEY')
 List plans and get available regions for that plan
 
 ```python
-plans = vultr.list_plans()
-plan = plans[0]  # 0 seems to be the basic 5 dollar plan
+plans = vultr.list_plans({'type': 'vc2'})  # vc2 - Cloud Compute
+plan = plans[0]  # 0 seems to be the base plan
 regions = vultr.list_regions()
 available = vultr.filter_regions(regions, plan['locations'])
 ```
@@ -98,26 +98,23 @@ sshkey = vultr.create_key('key-name', 'ssh-rsa AAAA...')
 Create a new instance
 
 ```python
-hostname = 'my-new-host'
 data = {
-    'region': available[0]['id'],
-    'plan': plan['id'],
     'os_id': ubuntu_lts['id'],
     'sshkey_id': [sshkey['id']],
-    'hostname': hostname,
-    'label': hostname,
+    'hostname': 'my-new-host',
+    'label': 'my-new-host',
 }
-instance = vultr.create_instance(**data)
+instance = vultr.create_instance(available[0], plan, **data)
 ```
 
 Arbitrary Methods `get`, `post`, `patch`, `delete`
 
 ```python
-# vultr.list_instances()
-instances = vultr.get('instances')
-# vultr.create_key()
+# vultr.get('url', params)
+instances = vultr.get('instances', {'type': 'vc2'})
+# vultr.post('url', **kwargs)
 sshkey = vultr.post('ssh-keys', name='key-name', ssh_key='ssh-rsa AAAA...')
-# vultr.delete_instance()
+# vultr.delete('url')
 vultr.delete(f"instances/019ad1a8-2aa3-7650-83d1-8520d65ed6af")
 ```
 

docs/index.md

@@ -54,8 +54,8 @@ vultr = Vultr('VULTR_API_KEY')
 List plans and get available regions for that plan
 
 ```python
-plans = vultr.list_plans()
-plan = plans[0]  # 0 seems to be the basic 5 dollar plan
+plans = vultr.list_plans({'type': 'vc2'})  # vc2 - Cloud Compute
+plan = plans[0]  # 0 seems to be the base plan
 regions = vultr.list_regions()
 available = vultr.filter_regions(regions, plan['locations'])
 ```
@@ -76,26 +76,23 @@ sshkey = vultr.create_key('key-name', 'ssh-rsa AAAA...')
 Create a new instance
 
 ```python
-hostname = 'my-new-host'
 data = {
-    'region': available[0]['id'],
-    'plan': plan['id'],
     'os_id': ubuntu_lts['id'],
     'sshkey_id': [sshkey['id']],
-    'hostname': hostname,
-    'label': hostname,
+    'hostname': 'my-new-host',
+    'label': 'my-new-host',
 }
-instance = vultr.create_instance(**data)
+instance = vultr.create_instance(available[0], plan, **data)
 ```
 
 Arbitrary Methods `get`, `post`, `patch`, `delete`
 
 ```python
-# vultr.list_instances()
-instances = vultr.get('instances')
-# vultr.create_key()
+# vultr.get('url', params)
+instances = vultr.get('instances', {'type': 'vc2'})
+# vultr.post('url', **kwargs)
 sshkey = vultr.post('ssh-keys', name='key-name', ssh_key='ssh-rsa AAAA...')
-# vultr.delete_instance()
+# vultr.delete('url')
 vultr.delete(f"instances/019ad1a8-2aa3-7650-83d1-8520d65ed6af")
 ```
 

src/vultr/vultr.py

@@ -16,8 +16,8 @@ def __init__(self, api_key: Optional[str] = None):
         if self.api_key:
             self._session.headers.update({"Authorization": f"Bearer {self.api_key}"})
 
-    def get(self, url: str):
-        return self._get(f"{self.url}/{url.lstrip('/')}")
+    def get(self, url: str, params: Optional[dict] = None):
+        return self._get(f"{self.url}/{url.lstrip('/')}", params)
 
     def post(self, url: str, **kwargs):
         return self._post(f"{self.url}/{url.lstrip('/')}", kwargs)
@@ -28,29 +28,31 @@ def patch(self, url: str, **kwargs):
     def delete(self, url: str):
         return self._delete(f"{self.url}/{url.lstrip('/')}")
 
-    def list_os(self):
+    def list_os(self, params: Optional[dict] = None):
         url = f"{self.url}/os"
-        return self._get(url)["os"]
+        return self._get(url, params)["os"]
 
-    def list_plans(self):
+    def list_plans(self, params: Optional[dict] = None):
         url = f"{self.url}/plans"
-        return self._get(url)["plans"]
+        return self._get(url, params)["plans"]
 
-    def list_regions(self):
+    def list_regions(self, params: Optional[dict] = None):
         url = f"{self.url}/regions"
-        return self._get(url)["regions"]
+        return self._get(url, params)["regions"]
 
-    def list_instances(self):
+    def list_instances(self, params: Optional[dict] = None):
         url = f"{self.url}/instances"
-        return self._get(url)["instances"]
+        return self._get(url, params)["instances"]
 
-    def get_instance(self, instance: Union[str, dict]):
+    def get_instance(self, instance: Union[str, dict], params: Optional[dict] = None):
         instance_id = self._get_obj_key(instance)
         url = f"{self.url}/instances/{instance_id}"
-        return self._get(url)["instance"]
+        return self._get(url, params)["instance"]
 
-    def create_instance(self, region: str, plan: str, **kwargs):
-        data = {"region": region, "plan": plan}
+    def create_instance(
+        self, region: Union[str, dict], plan: Union[str, dict], **kwargs
+    ):
+        data = {"region": self._get_obj_key(region), "plan": self._get_obj_key(plan)}
         data.update(kwargs)
         url = f"{self.url}/instances"
         return self._post(url, data)["instance"]
@@ -65,14 +67,14 @@ def delete_instance(self, instance: Union[str, dict]):
         url = f"{self.url}/instances/{instance_id}"
         return self._delete(url)
 
-    def list_keys(self):
+    def list_keys(self, params: Optional[dict] = None):
         url = f"{self.url}/ssh-keys"
-        return self._get(url)["ssh_keys"]
+        return self._get(url, params)["ssh_keys"]
 
-    def get_key(self, key: Union[str, dict]):
+    def get_key(self, key: Union[str, dict], params: Optional[dict] = None):
         key_id = self._get_obj_key(key)
         url = f"{self.url}/ssh-keys/{key_id}"
-        return self._get(url)["ssh_key"]
+        return self._get(url, params)["ssh_key"]
 
     def create_key(self, name: str, key: str, **kwargs):
         data = {"name": name, "ssh_key": key}
@@ -90,14 +92,14 @@ def delete_key(self, key: Union[str, dict]):
         url = f"{self.url}/ssh-keys/{key_id}"
         return self._delete(url)
 
-    def list_scripts(self):
+    def list_scripts(self, params: Optional[dict] = None):
         url = f"{self.url}/startup-scripts"
-        return self._get(url)["startup_scripts"]
+        return self._get(url, params)["startup_scripts"]
 
-    def get_script(self, script: Union[str, dict]):
+    def get_script(self, script: Union[str, dict], params: Optional[dict] = None):
         script_id = self._get_obj_key(script)
         url = f"{self.url}/startup-scripts/{script_id}"
-        return self._get(url)["startup_script"]
+        return self._get(url, params)["startup_script"]
 
     def create_script(self, name: str, script: str, **kwargs):
         data = {"name": name, "script": script}
@@ -115,10 +117,10 @@ def delete_script(self, script: Union[str, dict]):
         url = f"{self.url}/startup-scripts/{script_id}"
         return self._delete(url)
 
-    def list_ipv4(self, instance: Union[str, dict]):
+    def list_ipv4(self, instance: Union[str, dict], params: Optional[dict] = None):
         instance_id = self._get_obj_key(instance)
         url = f"{self.url}/instances/{instance_id}/ipv4"
-        return self._get(url)["ipv4s"]
+        return self._get(url, params)["ipv4s"]
 
     def create_ipv4(self, instance: Union[str, dict], **kwargs):
         instance_id = self._get_obj_key(instance)
@@ -155,8 +157,8 @@ def filter_scripts(scripts: list, name: str) -> dict:
     def filter_regions(regions: list, locations: list) -> list:
         return [d for d in regions if d["id"] in locations]
 
-    def _get(self, url):
-        r = self._session.get(url, timeout=10)
+    def _get(self, url, params: Optional[dict] = None):
+        r = self._session.get(url, params=params, timeout=10)
         if not r.ok:
             r.raise_for_status()
         return r.json()

tests/test_all.py

@@ -0,0 +1,10 @@
+from vultr import Vultr
+
+
+vultr = Vultr()
+
+
+def test_free():
+    per_page = 100
+    plans = vultr.get("plans", {"type": "vc2", "per_page": per_page})
+    assert len(plans["plans"]) == min(plans["meta"]["total"], per_page)