ka-ching-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d21504fd6fba444a7181caffae081ca69ba4474d6560f765054a117a7ae37cf
-  data.tar.gz: 469d2e8cc8a200c561707ce1b9ba4f4a0b40ed4f7fd30b1267444d6c5e40d77e
+  metadata.gz: '096acd110efe41626adbb730494ba86247e0c20614b294ba1bfa4d4dd7d420d9'
+  data.tar.gz: ea47b6fcb5d16b2a42a0a198c4c397eb0ebabc05f6d9755bc3a2fa31793aa982
 SHA512:
-  metadata.gz: c6936213efd58b765f085f3f8ed663c4b6b03eff0d2d1001a9d7a07fe5ff868be6e5aaa01a74dd7d9f567d7fc4e231f3d8f280bbf7b2393f502db561345afe2b
-  data.tar.gz: b69b366c3439ec9d5c8d0144a7bfb78a4404495a74f03bfd6f0167a906e14ac71efd1dedbafb9757e34d456c467e0d1f9a3b143667b213f372bfd1d4538c73a1
+  metadata.gz: 19d9b84a3e2a5c4872fe9fe0ed2746140d9da84afa925f1ef7554d2d048bd087d1032c272030269c01e8d742dfa953597561f503d0d7e50ed0e99ecede67e311
+  data.tar.gz: cb4701e66c2a1e922379a4fec71ec935982d0021dcdb7601b61bec19bbd1ad3217b55f024a01cf4bdd5028d64e9d341b6a705b57dc9a1be9c700d8155fc96489

data/CHANGELOG.md

@@ -5,6 +5,14 @@ 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.3.0] - 2023-06-27
+
+Matches ka-ching-backend version bump to v0.3.0.
+
+## [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

@@ -9,7 +9,7 @@ group :development, :test do
   gem 'minitest-vcr', '~> 1.4'
   gem 'pry', '~> 0.14.2'
   gem 'rake', '~> 13.0'
-  gem 'rubocop', '~> 1.52'
+  gem 'rubocop', '~> 1.53'
   gem 'rubocop-minitest', '~> 0.31.0'
   gem 'rubocop-performance', '~> 1.18'
   gem 'solargraph', '~> 0.49.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ka-ching-client (0.2.0)
+    ka-ching-client (0.3.0)
       faraday (~> 2.7.4)
       httpx (>= 0.22.4, < 0.25.0)
 
@@ -18,7 +18,7 @@ GEM
       rexml
     diff-lcs (1.5.0)
     e2mmap (0.1.0)
-    faraday (2.7.6)
+    faraday (2.7.7)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -32,6 +32,7 @@ GEM
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
     mini_portile2 (2.8.2)
     minispec-metadata (2.0.0)
@@ -56,7 +57,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.1)
-    racc (1.7.0)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rbs (2.8.4)
@@ -64,8 +65,9 @@ GEM
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rubocop (1.52.1)
+    rubocop (1.53.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
@@ -120,7 +122,7 @@ DEPENDENCIES
   minitest-vcr (~> 1.4)
   pry (~> 0.14.2)
   rake (~> 13.0)
-  rubocop (~> 1.52)
+  rubocop (~> 1.53)
   rubocop-minitest (~> 0.31.0)
   rubocop-performance (~> 1.18)
   solargraph (~> 0.49.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.3.0'
 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.3.0
 platform: ruby
 authors:
 - Simon Neutert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-20 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday