ka-ching-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e16582171eb9b2444e49108b7aa5e5510f8d1b161083c246e4f0ef3d7b4403e
-  data.tar.gz: a35cf46ed2c2cd17ca08c18807b3e2b1467b426e33cfddd4fa60a23a4d488aa5
+  metadata.gz: 6d21504fd6fba444a7181caffae081ca69ba4474d6560f765054a117a7ae37cf
+  data.tar.gz: 469d2e8cc8a200c561707ce1b9ba4f4a0b40ed4f7fd30b1267444d6c5e40d77e
 SHA512:
-  metadata.gz: 7ccca54c865747187c51e8b89a11b78fbb91296e3a60a3ded4a17df30b443e0d055963f782538f9c7e1e871135ecfc94eca94ffc8b7ea0868b05ccf6939a3d80
-  data.tar.gz: c7effcd12a68700eeec10a980983aa2e1bda4ee86bb7b0f37902429e8cb6e62a62411b605213077029c1d04f347e97325d4d75323f768c1841f8f15501321ea9
+  metadata.gz: c6936213efd58b765f085f3f8ed663c4b6b03eff0d2d1001a9d7a07fe5ff868be6e5aaa01a74dd7d9f567d7fc4e231f3d8f280bbf7b2393f502db561345afe2b
+  data.tar.gz: b69b366c3439ec9d5c8d0144a7bfb78a4404495a74f03bfd6f0167a906e14ac71efd1dedbafb9757e34d456c467e0d1f9a3b143667b213f372bfd1d4538c73a1

data/CHANGELOG.md

@@ -5,4 +5,13 @@ 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).
 
-## [Unreleased] - yyyy-mm-dd
+## [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).
+- [#5](https://github.com/simonneutert/ka-ching-client/pull/5) adjusts endpoints for lockings to backend API - [@simonneutert](https://github.com/simonneutert).
+- [#2](https://github.com/simonneutert/ka-ching-backend/pull/2) changes attribute/column from `realized` to `realized_at` [@simonneutert](https://github.com/simonneutert).
+- [#1](https://github.com/simonneutert/ka-ching-client/pull/1) fixes entry in Readme after gem release - [simonneutert](https://github.com/simonneutert).
+
+## [0.1.0] - 2023-06-12
+
+Initial release.

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'minitest', '~> 5.0'
+  gem 'minitest', '~> 5.18'
   gem 'minitest-vcr', '~> 1.4'
   gem 'pry', '~> 0.14.2'
   gem 'rake', '~> 13.0'

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    ka-ching-client (0.1.0)
+    ka-ching-client (0.2.0)
       faraday (~> 2.7.4)
-      httpx (>= 0.22.4, < 0.24.0)
+      httpx (>= 0.22.4, < 0.25.0)
 
 GEM
   remote: https://rubygems.org/
@@ -24,7 +24,7 @@ GEM
     faraday-net_http (3.0.2)
     hashdiff (1.0.1)
     http-2-next (0.5.1)
-    httpx (0.23.4)
+    httpx (0.24.0)
       http-2-next (>= 0.4.1)
     jaro_winkler (1.5.6)
     json (2.6.3)
@@ -33,13 +33,17 @@ GEM
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     method_source (1.0.0)
+    mini_portile2 (2.8.2)
     minispec-metadata (2.0.0)
       minitest
-    minitest (5.18.0)
+    minitest (5.18.1)
     minitest-vcr (1.4.0)
       minispec-metadata (~> 2.0)
       minitest (>= 4.7.5)
       vcr (>= 2.9)
+    nokogiri (1.15.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
     nokogiri (1.15.2-arm64-darwin)
       racc (~> 1.4)
     nokogiri (1.15.2-x86_64-linux)
@@ -107,11 +111,12 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  ruby
   x86_64-linux
 
 DEPENDENCIES
   ka-ching-client!
-  minitest (~> 5.0)
+  minitest (~> 5.18)
   minitest-vcr (~> 1.4)
   pry (~> 0.14.2)
   rake (~> 13.0)

data/README.md

@@ -20,16 +20,16 @@ KaChing::Client is a Ruby API client for the [KaChing Backend project / simonneu
     - [unlock!](#unlock)
     - [all paginated](#all-paginated)
     - [of\_year](#of_year)
-    - [of\_year\_month](#of_year_month)
-    - [of\_year\_month\_day](#of_year_month_day)
+    - [active](#active)
+    - [inactive](#inactive)
   - [AuditLogs](#auditlogs)
     - [of\_year](#of_year-1)
-    - [of\_year\_month](#of_year_month-1)
-    - [of\_year\_month\_day](#of_year_month_day-1)
+    - [of\_year\_month](#of_year_month)
+    - [of\_year\_month\_day](#of_year_month_day)
   - [Tenants](#tenants)
     - [all](#all)
-    - [active](#active)
-    - [inactive](#inactive)
+    - [active](#active-1)
+    - [inactive](#inactive-1)
   - [Admin](#admin)
     - [details](#details)
     - [create!](#create)
@@ -40,8 +40,6 @@ KaChing::Client is a Ruby API client for the [KaChing Backend project / simonneu
 
 ## Installation
 
-TODO: Replace `ka-ching-client` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
     $ bundle add ka-ching-client
@@ -189,7 +187,7 @@ Get all lockings for a tenant paginated.
 res = client.v1.lockings.all(
   tenant_account_id: 'testuser_1',
   page: 1,
-  per_page: 10
+  per_page: 10,
 )
 ```
 
@@ -201,28 +199,25 @@ Get lockings for a tenant by year.
 res = client.v1.lockings.of_year(tenant_account_id: 'testuser_1', year: 2019)
 ```
 
-#### of_year_month
+#### active
 
-Get lockings for a tenant by year and month.
+Get active lockings for a tenant for a year.
 
 ```ruby
-res = client.v1.lockings.of_year(
+res = client.v1.lockings.active(
   tenant_account_id: 'testuser_1',
   year: 2019,
-  month: 11
 )
 ```
 
-#### of_year_month_day
+#### inactive
 
-Get lockings for a tenant by year, month and day.
+Get inactive lockings for a tenant for a year.
 
 ```ruby
-res = client.v1.lockings.of_year(
+res = client.v1.lockings.inactive(
   tenant_account_id: 'testuser_1',
   year: 2019,
-  month: 11,
-  day: 21
 )
 ```
 

data/UPGRADING.md

@@ -0,0 +1,8 @@
+# Upgrading ka-ching-client
+
+## 0.1.0 to 0.2.0
+
+### Changes
+
+* [#5](https://github.com/simonneutert/ka-ching-client/pull/5) Endpoints for lockings do not support `of_year_month` and `of_year_month_day` anymore. Therefor `active` and `inactive` were added to `Lockings` endpoints.
+- [#1](https://github.com/simonneutert/ka-ching-client/pull/1) attribute/column was `realized` and is from now on `realized_at`.

data/lib/ka_ching/api_v1/lockings.rb

@@ -94,33 +94,25 @@ module KaChing
         JSON.parse(res.body)
       end
 
-      #
-      # Get all lockings for a given year in month
-      #
-      # @yield [Faraday::Response] The response from the server
-      # @return [Hash]
-      #
-      def of_year_month(tenant_account_id:, year:, month:, page: 1, per_page: 100)
-        res = get(build_url(tenant_account_id: tenant_account_id),
-                  { year: year, month: month, page: page, per_page: per_page }) do |req|
+      def active(tenant_account_id:, year: nil, page: 1, per_page: 100)
+        params = { page: page, per_page: per_page }
+        body_params = { active: 'true' }
+        body_params.merge!({ year: year }) if year
+        res = get(build_url(tenant_account_id: tenant_account_id), params) do |req|
           req.headers['Content-Type'] = 'application/json'
-          req.body = { year: year, month: month }.to_json
+          req.body = body_params.to_json
         end
         yield res if block_given?
         JSON.parse(res.body)
       end
 
-      #
-      # Get all lockings for a given year in month at day
-      #
-      # @yield [Faraday::Response] The response from the server
-      # @return [Hash]
-      #
-      def of_year_month_day(tenant_account_id:, year:, month:, day:)
-        res = get(build_url(tenant_account_id: tenant_account_id).to_s,
-                  { year: year, month: month, day: day, page: page, per_page: per_page }) do |req|
+      def inactive(tenant_account_id:, year: nil, page: 1, per_page: 100)
+        params = { page: page, per_page: per_page }
+        body_params = { inactive: 'true' }
+        body_params.merge!({ year: year }) if year
+        res = get(build_url(tenant_account_id: tenant_account_id), params) do |req|
           req.headers['Content-Type'] = 'application/json'
-          req.body = { year: year, month: month, day: day }.to_json
+          req.body = body_params.to_json
         end
         yield res if block_given?
         JSON.parse(res.body)

data/lib/ka_ching/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ka-ching-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Simon Neutert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-12 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -33,7 +33,7 @@ dependencies:
         version: 0.22.4
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 0.22.4
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0
 description: This gem is a client for the ka-ching API.
 email:
 - simonneutert@users.noreply.github.com
@@ -61,6 +61,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- UPGRADING.md
 - lib/ka-ching-client.rb
 - lib/ka_ching/api_client.rb
 - lib/ka_ching/api_v1/admin.rb
@@ -94,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
 summary: This gem is a client for the ka-ching API.