ka-ching-client 0.1.0

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task default: ['test']

data/lib/ka-ching-client.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'httpx/adapters/faraday'
+
+require_relative 'ka_ching/version'
+require_relative 'ka_ching/api_client'
+require_relative 'ka_ching/api_v1/audit_logs'
+require_relative 'ka_ching/api_v1/bookings'
+require_relative 'ka_ching/api_v1/lockings'
+require_relative 'ka_ching/api_v1/saldo'
+require_relative 'ka_ching/api_v1/admin'
+require_relative 'ka_ching/api_v1/tenants'
+require_relative 'ka_ching/api_v1/client'

data/lib/ka_ching/api_client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module KaChing
+  #
+  # The base class for all API versions.
+  #
+  class ApiClient
+    attr_accessor :conn
+    attr_reader :api_version, :base_url, :v1
+
+    def initialize(api_version: :v1, base_url: 'http://localhost:9292')
+      @api_version = api_version
+      @base_url = base_url
+    end
+
+    def build_client!(faraday: nil)
+      @conn = faraday || default_faraday
+      case @api_version
+      when :v1, 'v1'
+        @v1 = KaChing::ApiV1::Client.new(conn: @conn, base_url: @base_url)
+      else
+        raise ArgumentError, "Unknown API version: #{@api_version}"
+      end
+      self
+    end
+
+    private
+
+    def default_faraday
+      Faraday.new do |builder|
+        builder.url_prefix = @base_url
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Response::RaiseError
+        builder.use Faraday::Response::Logger
+
+        builder.adapter :httpx
+      end
+    end
+  end
+end

data/lib/ka_ching/api_v1/admin.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module KaChing
+  module ApiV1
+    #
+    # Admin Endpoint for the KaChing API V1
+    #
+    class Admin
+      extend Forwardable
+
+      def_delegators :@conn, :get, :post, :put, :patch, :delete
+
+      def initialize(conn:, api_url:)
+        @conn = conn
+        @api_url = api_url
+      end
+
+      #
+      # gets the details of a tenant database
+      #
+      # @param [String] full tenant_account_id with its database namespace, e.g. 'kaching_tenant_user_1'
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash] containing the details of the tenant database
+      #
+      def details(tenant_account_id:)
+        admin_tenant_url = build_url(tenant_account_id: tenant_account_id)
+        res = get(admin_tenant_url) do |req|
+          req.headers['Content-Type'] = 'application/json'
+        end
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
+      #
+      # creates a new tenant database
+      #
+      # @param [String] tenant_account_id without its database namespace, e.g.
+      #     'user_1' instead of 'kaching_tenant_user_1'
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash]
+      #
+      def create!(tenant_account_id:)
+        res = post(build_url) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = { tenant_account_id: tenant_account_id }.to_json
+        end
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
+      #
+      # drops a tenant database
+      #
+      # @param [String] tenant_account_id without its database namespace,
+      #     e.g. 'user_1' instead of 'kaching_tenant_user_1'
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash]
+      #
+      def drop!(tenant_account_id:)
+        res = delete(build_url) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = { tenant_account_id: tenant_account_id }.to_json
+        end
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
+      private
+
+      def build_url(tenant_account_id: nil)
+        if tenant_account_id
+          "#{@api_url}/admin/#{tenant_account_id}"
+        else
+          "#{@api_url}/admin/"
+        end
+      end
+    end
+  end
+end

data/lib/ka_ching/api_v1/audit_logs.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module KaChing
+  module ApiV1
+    #
+    # AuditLog Endpoint for the KaChing API V1
+    #
+    class AuditLogs
+      extend Forwardable
+
+      def_delegators :@conn, :get, :post, :put, :patch, :delete
+
+      def initialize(conn:, api_url:)
+        @conn = conn
+        @api_url = api_url
+      end
+
+      #
+      # Get all bookings for the current tenant of a specific year
+      #
+      # @param [String] tenant_account_id
+      # @param [Integer] year
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash] containing the bookings as array
+      #
+      def of_year(tenant_account_id:, year:)
+        res = get(build_url(tenant_account_id: tenant_account_id),
+                  { year: year })
+
+        yield res if block_given?
+        parse_bookings(JSON.parse(res.body))['audit_logs']
+      end
+
+      #
+      # Get all bookings for the current tenant of a specific year, month
+      #
+      # @param [String] tenant_account_id
+      # @param [Integer] year
+      # @param [Integer] month
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash] containing the bookings as array
+      #
+      def of_year_month(tenant_account_id:, year:, month:)
+        res = get(build_url(tenant_account_id: tenant_account_id),
+                  { year: year, month: month })
+        yield res if block_given?
+        parse_bookings(JSON.parse(res.body))['audit_logs']
+      end
+
+      #
+      # Get all bookings for the current tenant of a specific year, month, day
+      #
+      # @param [String] tenant_account_id
+      # @param [Integer] year
+      # @param [Integer] month
+      # @param [Integer] day
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash] containing the bookings as array
+      #
+      def of_year_month_day(tenant_account_id:, year:, month:, day:)
+        res = get(build_url(tenant_account_id: tenant_account_id),
+                  { year: year, month: month, day: day })
+        yield res if block_given?
+        parse_bookings(JSON.parse(res.body))['audit_logs']
+      end
+
+      private
+
+      def parse_bookings(audit_log_json)
+        audit_log_json['audit_logs'].map! do |audit_log|
+          parse_booking(audit_log, 'environment_snapshot')
+          parse_booking(audit_log, 'log_entry')
+          audit_log
+        end
+        audit_log_json
+      end
+
+      def parse_booking(audit_log, bookings_key)
+        audit_log[bookings_key] = JSON.parse(audit_log[bookings_key])
+        audit_log[bookings_key]['context'] = JSON.parse(JSON.parse(audit_log[bookings_key]['context']))
+        audit_log[bookings_key]['bookings'] = JSON.parse(audit_log[bookings_key]['bookings_json'])
+        audit_log[bookings_key]['bookings'].map! do |b|
+          b['context'] = JSON.parse(b['context'])
+          b
+        end
+        audit_log
+      end
+
+      #
+      # build the url for the bookings endpoint
+      #
+      # @param [String] tenant_account_id
+      # @param [Integer,nil] year
+      # @param [Integer,nil] month
+      # @param [Integer,nil] day
+      #
+      # @return [<Type>] <description>
+      #
+      def build_url(tenant_account_id:)
+        "#{@api_url}/#{tenant_account_id}/auditlogs"
+      end
+    end
+  end
+end

data/lib/ka_ching/api_v1/bookings.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module KaChing
+  module ApiV1
+    #
+    # Bookings Endpoint for the KaChing API V1
+    #
+    class Bookings
+      extend Forwardable
+
+      def_delegators :@conn, :get, :post, :put, :patch, :delete
+
+      def initialize(conn:, api_url:)
+        @conn = conn
+        @api_url = api_url
+      end
+
+      #
+      # Deposit money to the current tenant account
+      #
+      # @param [String] tenant_account_id without the tenant database namespace,
+      #     e.g. 'user_1' instead of 'kaching_tenant_user_1'
+      # @param [Integer] amount_cents the amount to deposit in cents
+      # @param [Integer] year the year of the booking
+      # @param [Integer] month the month of the booking
+      # @param [Integer] day the day of the booking
+      # @param [Hash] context additional context information
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash] containing the booking details
+      #
+      def deposit!(tenant_account_id:,
+                   amount_cents:,
+                   year: Date.today.year,
+                   month: Date.today.month,
+                   day: Date.today.day,
+                   context: {})
+        res = create!(tenant_account_id: tenant_account_id,
+                      booking: {
+                        action: :deposit,
+                        amount_cents: amount_cents,
+                        year: year,
+                        month: month,
+                        day: day,
+                        context: context
+                      })
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
+      #
+      # Withdraw money to the current tenant account
+      #
+      # @param [String] tenant_account_id without the tenant database namespace,
+      #     e.g. 'user_1' instead of 'kaching_tenant_user_1'
+      # @param [Integer] amount_cents the amount to deposit in cents
+      # @param [Integer] year the year of the booking
+      # @param [Integer] month the month of the booking
+      # @param [Integer] day the day of the booking
+      # @param [Hash] context additional context information
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash] containing the booking details
+      #
+      def withdraw!(tenant_account_id:,
+                    amount_cents:,
+                    year: Date.today.year,
+                    month: Date.today.month,
+                    day: Date.today.day,
+                    context: {})
+        res = create!(tenant_account_id: tenant_account_id, booking: {
+                        action: :withdraw,
+                        amount_cents: amount_cents,
+                        year: year,
+                        month: month,
+                        day: day,
+                        context: context
+                      })
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
+      #
+      # drops/deletes a booking
+      #
+      # @param [String] tenant_account_id without the tenant database namespace,
+      #     e.g. 'user_1' instead of 'kaching_tenant_user_1'
+      # @param [String] booking_id uuid of the booking
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash] containing the booking details
+      #
+      def drop!(tenant_account_id:, booking_id:)
+        drop_url = "#{build_url(tenant_account_id: tenant_account_id)}/#{booking_id}"
+        res = delete(drop_url) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = { id: booking_id }.to_json
+        end
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
+      #
+      # returns all unlocked bookings for a tenant
+      #
+      # @param [String] tenant_account_id without the tenant database namespace,
+      #     e.g. 'user_1' instead of 'kaching_tenant_user_1'
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash] containing the booking details
+      #
+      def unlocked(tenant_account_id:)
+        unlocked_url = "#{build_url(tenant_account_id: tenant_account_id)}/unlocked"
+        res = get(unlocked_url) do |req|
+          req.headers['Content-Type'] = 'application/json'
+        end
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
+      private
+
+      #
+      # post action to the current tenant account
+      #
+      # @param [String] tenant_account_id without the tenant database namespace,
+      #     e.g. 'user_1' instead of 'kaching_tenant_user_1'
+      # @param [Hash] booking the booking details
+      # @option booking [String] :action the action to perform, either :deposit or :withdraw
+      # @option booking [Integer] :amount_cents the amount to deposit in cents
+      # @option booking [Integer] :year the year of the booking
+      # @option booking [Integer] :month the month of the booking
+      # @option booking [Integer] :day the day of the booking
+      # @option booking [Hash] :context any additional context information
+      #
+      # @return [Faraday::Response] The response from the server
+      #
+      def create!(tenant_account_id:, booking:)
+        create_url = build_url(tenant_account_id: tenant_account_id)
+        post(create_url) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = booking.to_json
+        end
+      end
+
+      def build_url(tenant_account_id:)
+        "#{@api_url}/#{tenant_account_id}/bookings"
+      end
+    end
+  end
+end

data/lib/ka_ching/api_v1/client.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module KaChing
+  module ApiV1
+    #
+    # The client class is the main entry point for the KaChing API V1.
+    #
+    class Client
+      def initialize(conn:, base_url:)
+        @conn = conn
+        @base_url = base_url
+        @api_url = '/ka-ching/api/v1'
+      end
+
+      #
+      # The admin endpoint interface for the KaChing API V1
+      #
+      # @return [KaChing::ApiV1::Admin] The admin endpoint interface
+      #
+      def admin
+        @_admin ||= KaChing::ApiV1::Admin.new(conn: @conn, api_url: @api_url)
+      end
+
+      #
+      # The tenants endpoint interface for the KaChing API V1
+      #
+      # @return [KaChing::ApiV1::Tenants] The tenants endpoint interface
+      #
+      def tenants
+        @_tenants ||= KaChing::ApiV1::Tenants.new(conn: @conn, api_url: @api_url)
+      end
+
+      #
+      # The saldo endpoint interface for the KaChing API V1
+      #
+      # @return [KaChing::ApiV1::Saldo] The saldo endpoint interface
+      #
+      def saldo
+        @_saldo ||= KaChing::ApiV1::Saldo.new(conn: @conn, api_url: @api_url)
+      end
+
+      #
+      # The booking endpoint interface for the KaChing API V1
+      #
+      # @return [KaChing::ApiV1::Bookings] The booking endpoint interface
+      #
+      def bookings
+        @_bookings ||= KaChing::ApiV1::Bookings.new(conn: @conn, api_url: @api_url)
+      end
+
+      #
+      # The lockings endpoint interface for the KaChing API V1
+      #
+      # @return [KaChing::ApiV1::Lockings] The lockings endpoint interface
+      #
+      def lockings
+        @_lockings ||= KaChing::ApiV1::Lockings.new(conn: @conn, api_url: @api_url)
+      end
+
+      #
+      # The audit_logs endpoint interface for the KaChing API V1
+      #
+      # @return [KaChing::ApiV1::AuditLogs] The audit_logs endpoint interface
+      #
+      def audit_logs
+        @_audit_logs ||= KaChing::ApiV1::AuditLogs.new(conn: @conn, api_url: @api_url)
+      end
+    end
+  end
+end

data/lib/ka_ching/api_v1/lockings.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module KaChing
+  module ApiV1
+    #
+    # Lockings Endpoint for the KaChing API V1
+    #
+    class Lockings
+      extend Forwardable
+
+      def_delegators :@conn, :get, :post, :put, :patch, :delete
+
+      def initialize(conn:, api_url:)
+        @conn = conn
+        @api_url = api_url
+      end
+
+      #
+      # Locks the bookings for a specific day
+      #
+      # @param [String] action should be "lock"
+      # @param [Integer] amount_cents_saldo_user_counted what the user counted as saldo
+      # @param [Integer] year
+      # @param [Integer] month
+      # @param [Integer] day
+      # @param [Hash] context object with additional information stored with the locking
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash] the locking
+      #
+      def lock!(tenant_account_id:,
+                amount_cents_saldo_user_counted:,
+                year: Date.today.year,
+                month: Date.today.month,
+                day: Date.today.day,
+                context: {})
+        locking = {
+          action: :lock,
+          amount_cents_saldo_user_counted: amount_cents_saldo_user_counted,
+          year: Integer(year),
+          month: Integer(month),
+          day: Integer(day),
+          context: context
+        }
+        res = post(build_url(tenant_account_id: tenant_account_id)) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = locking.to_json
+        end
+        yield res if block_given?
+        res = JSON.parse(res.body)
+        res['record']['bookings_json'] = JSON.parse(res['record']['bookings_json'])
+        res['context'] = JSON.parse(JSON.parse(res['context']))
+        res
+      end
+
+      #
+      # Unlocks last locking
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash]
+      #
+      def unlock!(tenant_account_id:)
+        res = delete(build_url(tenant_account_id: tenant_account_id)) do |req|
+          req.headers['Content-Type'] = 'application/json'
+        end
+        yield res if block_given?
+        res = JSON.parse(res.body)
+        res['bookings_json'] = JSON.parse(res['bookings_json'])
+        res['context'] = JSON.parse(JSON.parse(res['context']))
+        res
+      end
+
+      def all(tenant_account_id:, page: 1, per_page: 10)
+        res = get(build_url(tenant_account_id: tenant_account_id), { page: page, per_page: per_page }) do |req|
+          req.headers['Content-Type'] = 'application/json'
+        end
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
+      #
+      # Get all lockings for a given year
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash]
+      #
+      def of_year(tenant_account_id:, year:, page: 1, per_page: 100)
+        res = get(build_url(tenant_account_id: tenant_account_id),
+                  { year: year, page: page, per_page: per_page }) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = { year: year }.to_json
+        end
+        yield res if block_given?
+        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|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = { year: year, month: month }.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|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = { year: year, month: month, day: day }.to_json
+        end
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
+      private
+
+      def build_url(tenant_account_id:)
+        "#{@api_url}/#{tenant_account_id}/lockings"
+      end
+    end
+  end
+end

data/lib/ka_ching/api_v1/saldo.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module KaChing
+  module ApiV1
+    #
+    # Saldo Endpoint for the KaChing API V1
+    #
+    class Saldo
+      extend Forwardable
+
+      def_delegators :@conn, :get, :post, :put, :patch, :delete
+
+      def initialize(conn:, api_url:)
+        @conn = conn
+        @api_url = api_url
+      end
+
+      #
+      # Get the current saldo (in cents)
+      #
+      # @param [String] tenant_account_id without the tenant database namespace,
+      #     e.g. 'user_1' instead of 'kaching_tenant_user_1'
+      #
+      # @yield [Faraday::Response] The response from the server
+      # @return [Hash] The current saldo
+      #
+      def current(tenant_account_id:)
+        res = get(build_url(tenant_account_id: tenant_account_id)) do |req|
+          req.headers['Content-Type'] = 'application/json'
+        end
+        yield res if block_given?
+        JSON.parse(res.body)
+      end
+
+      private
+
+      def build_url(tenant_account_id:)
+        "#{@api_url}/#{tenant_account_id}/saldo"
+      end
+    end
+  end
+end