ka-ching-client 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d21504fd6fba444a7181caffae081ca69ba4474d6560f765054a117a7ae37cf
-  data.tar.gz: 469d2e8cc8a200c561707ce1b9ba4f4a0b40ed4f7fd30b1267444d6c5e40d77e
+  metadata.gz: bac54083b8081e1e66eef09715fd734594f926efb9632d559c16939183aa9360
+  data.tar.gz: ccc12ba3b2bd625e9305ebac3a329d6038cb975615d79c7f32775344b9d19367
 SHA512:
-  metadata.gz: c6936213efd58b765f085f3f8ed663c4b6b03eff0d2d1001a9d7a07fe5ff868be6e5aaa01a74dd7d9f567d7fc4e231f3d8f280bbf7b2393f502db561345afe2b
-  data.tar.gz: b69b366c3439ec9d5c8d0144a7bfb78a4404495a74f03bfd6f0167a906e14ac71efd1dedbafb9757e34d456c467e0d1f9a3b143667b213f372bfd1d4538c73a1
+  metadata.gz: 62ec0f7c7f0724ab6b124f88c309d88d1394450ac81c1c797a390ed2cc3cdb4784a2c44993de9dbb3978dfe67c3573699c8f6344da064039e0171045fec41e14
+  data.tar.gz: e97d23adab7dc7e92a5a4d1947f5cf2467c5d459f47977e30c46ed692c908759401b7c8e90604d5974fb44f54086ba44d3568e513c093cbdef48101b3506b4ff

data/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.1] - 2023-06-24
+
+- [#8](https://github.com/simonneutert/ka-ching-client/pull/8) adds ability to reset the tenant database `admin#reset!` - [@simonneutert](https://github.com/simonneutert).
+
 ## [0.2.0] - 2023-06-20
 
 - [#6](https://github.com/simonneutert/ka-ching-client/pull/6) tests endpoints for lockings to backend API `active`/`inactive` - [@simonneutert](https://github.com/simonneutert).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ka-ching-client (0.2.0)
+    ka-ching-client (0.2.1)
       faraday (~> 2.7.4)
       httpx (>= 0.22.4, < 0.25.0)
 

data/README.md

@@ -34,6 +34,7 @@ KaChing::Client is a Ruby API client for the [KaChing Backend project / simonneu
     - [details](#details)
     - [create!](#create)
     - [drop!](#drop-1)
+    - [reset!](#reset)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -267,7 +268,7 @@ All tenants related endpoints.
 Get all tenants paginated.
 
 ```ruby
-res = client.v1.tenants.all(page: 1)
+res = client.v1.tenants.all(page: 1, per_page: 1000)
 ```
 
 #### active
@@ -275,7 +276,7 @@ res = client.v1.tenants.all(page: 1)
 Get all active tenants paginated.
 
 ```ruby
-res = client.v1.tenants.active(page: 1)
+res = client.v1.tenants.active(page: 1, per_page: 1000)
 ```
 
 #### inactive
@@ -283,7 +284,7 @@ res = client.v1.tenants.active(page: 1)
 Get all inactive tenants paginated.
 
 ```ruby
-res = client.v1.tenants.inactive(page: 1)
+res = client.v1.tenants.inactive(page: 1, per_page: 1000)
 ```
 
 ### Admin
@@ -314,6 +315,14 @@ Drop/Delete a tenant database.
 res = client.v1.admin.drop!(tenant_account_id: 'testuser_1')
 ```
 
+#### reset!
+
+Reset a tenant database.
+
+```ruby
+res = client.v1.admin.reset!(tenant_account_id: 'testuser_1')
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ka_ching/api_v1/admin.rb

@@ -50,6 +50,22 @@ module KaChing
         JSON.parse(res.body)
       end
 
+      #
+      # resets a tenant database
+      #
+      # @param [String] tenant_account_id without its database namespace
+      #
+      # @return [Hash] containing the details of the response
+      #
+      def reset!(tenant_account_id:)
+        reset_url = "#{build_url(tenant_account_id: tenant_account_id)}/reset"
+        res = post(reset_url) do |req|
+          req.headers['Content-Type'] = 'application/json'
+        end
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
       #
       # drops a tenant database
       #

data/lib/ka_ching/api_v1/tenants.rb

@@ -22,10 +22,11 @@ module KaChing
       #
       # @return [Array<Hash>] An array of tenant detail hashes
       #
-      def all(page: 1)
+      def all(page: 1, per_page: 1000)
         all_url = build_url
-        res = get("#{all_url}/all/#{page}") do |req|
+        res = get("#{all_url}/all") do |req|
           req.headers['Content-Type'] = 'application/json'
+          req.body = { page: page, per_page: per_page }.to_json
         end
         yield res if block_given?
         JSON.parse(res.body)
@@ -40,8 +41,9 @@ module KaChing
       #
       def active(page: 1)
         active_url = build_url
-        res = get("#{active_url}/active/#{page}}") do |req|
+        res = get("#{active_url}/active") do |req|
           req.headers['Content-Type'] = 'application/json'
+          req.body = { page: page, per_page: per_page }.to_json
         end
         yield res if block_given?
         JSON.parse(res.body)
@@ -56,8 +58,9 @@ module KaChing
       #
       def inactive(page: 1)
         inactive_url = build_url
-        res = get("#{inactive_url}/all/#{page}}") do |req|
+        res = get("#{inactive_url}/inactive}") do |req|
           req.headers['Content-Type'] = 'application/json'
+          req.body = { page: page, per_page: per_page }.to_json
         end
         yield res if block_given?
         JSON.parse(res.body)
@@ -65,8 +68,12 @@ module KaChing
 
       private
 
-      def build_url
-        "#{@api_url}/tenants"
+      def build_url(tenant_account_id: nil)
+        if tenant_account_id
+          "#{@api_url}/tenants/#{tenant_account_id}"
+        else
+          "#{@api_url}/tenants"
+        end
       end
     end
   end

data/lib/ka_ching/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ka-ching-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Simon Neutert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-20 00:00:00.000000000 Z
+date: 2023-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday