yield-sdk 0.5.1 → 0.7.0

data/lib/yield/sdk/modules/customer/customer_base_client.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "uri"
+
+require_relative "../../api/api_client"
+require_relative "../../types/page"
+require_relative "payloads/customer_row"
+require_relative "payloads/customer_list_payload"
+
+module Yield
+  module SDK
+    module Customer
+      class BaseClient
+        def initialize(api_client)
+          @api = api_client
+        end
+
+        def list(params = nil)
+          payload = params.nil? ? nil : CustomerListPayload.build(params)
+          response = @api.run_query("/customer/list", payload)
+
+          API::Client.process_response(response, &Page.build_with(&CustomerRow.method(:from_payload)))
+        end
+      end
+    end
+  end
+end

data/lib/yield/sdk/modules/customer/customer_client.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "customer_base_client"
+
+module Yield
+  module SDK
+    module Customer
+      class Client
+        def initialize(base_client)
+          @base = base_client
+        end
+
+        def list(params = nil)
+          @base.list(params).data
+        end
+      end
+    end
+  end
+end

data/lib/yield/sdk/modules/customer/payloads/customer_credit_line_info.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../../../types/money"
+require_relative "../../../utils/type_utils"
+
+module Yield
+  module SDK
+    module Customer
+      CustomerCreditLineInfo = Data.define(
+        :credit_limit,
+        :amount_available,
+      ) do
+        def self.from_payload(payload)
+          new(
+            credit_limit: Money.from_payload(TypeUtils.expect_string(payload[:credit_limit])),
+            amount_available: Money.from_payload(TypeUtils.expect_string(payload[:amount_available])),
+          )
+        end
+      end
+    end
+  end
+end

data/lib/yield/sdk/modules/customer/payloads/customer_list_payload.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "../../../types/cursor_payload"
+
+module Yield
+  module SDK
+    module Customer
+      class CustomerListPayload
+        def self.build(params)
+          {
+            limit: params[:limit],
+            after: params[:after].nil? ? nil : CursorPayload.build(params[:after]),
+            customer_code: params[:customer_code],
+            extra_system_id: params[:extra_system_id],
+          }
+        end
+      end
+    end
+  end
+end

data/lib/yield/sdk/modules/customer/payloads/customer_row.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "../../../utils/type_utils"
+require_relative "customer_credit_line_info"
+
+module Yield
+  module SDK
+    module Customer
+      CustomerRow = Data.define(
+        :id,
+        :registered_name,
+        :trade_name,
+        :customer_code,
+        :credit_line,
+      ) do
+        def self.from_payload(payload)
+          new(
+            id: TypeUtils.expect_string(payload[:id]),
+            registered_name: TypeUtils.expect_string(payload[:registered_name]),
+            trade_name: payload[:trade_name].nil? ? nil : TypeUtils.expect_string(payload[:trade_name]),
+            customer_code: payload[:customer_code].nil? ? nil : TypeUtils.expect_string(payload[:customer_code]),
+            credit_line: payload[:credit_line].nil? ? nil : CustomerCreditLineInfo.from_payload(TypeUtils.expect_record(payload[:credit_line])),
+          )
+        end
+      end
+    end
+  end
+end

data/lib/yield/sdk/modules/order/order_base_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "uri"
+
 require_relative "../../api/api_client"
 require_relative "payloads/order"
 require_relative "payloads/order_create_payload"
@@ -13,7 +15,8 @@ module Yield
         end
 
         def fetch(id)
-          response = @api.run_query("/order/fetch/#{id}")
+          encoded_id = URI.encode_uri_component(id)
+          response = @api.run_query("/order/fetch/#{encoded_id}")
 
           API::Client.process_response(response, &Order.method(:from_payload))
         end

data/lib/yield/sdk/modules/order/payloads/order.rb

@@ -3,25 +3,35 @@
 require "date"
 
 require_relative "../../../types/money"
-require_relative "../../../utils"
+require_relative "../../../utils/type_utils"
 require_relative "order_customer_info"
 require_relative "order_status"
 
 module Yield
   module SDK
     module Order
-      class Order < Data.define(:id, :order_number, :status, :customer, :date, :total_amount, :note, :payment_link, :creation_time)
+      Order = Data.define(
+        :id,
+        :order_number,
+        :status,
+        :customer,
+        :date,
+        :total_amount,
+        :note,
+        :payment_link,
+        :creation_time,
+      ) do
         def self.from_payload(payload)
           new(
-            id: Utils.assert_string(payload[:id]),
-            order_number: Utils.assert_string(payload[:order_number]),
-            status: Utils.assert_variant(OrderStatus::ALL, payload[:status]),
-            customer: payload[:customer].nil? ? nil : OrderCustomerInfo.from_payload(Utils.assert_hash(payload[:customer])),
-            date: Date.parse(Utils.assert_string(payload[:date])),
-            total_amount: Money.from_payload(Utils.assert_string(payload[:total_amount])),
-            note: payload[:note].nil? ? nil : Utils.assert_string(payload[:note]),
-            payment_link: payload[:payment_link].nil? ? nil : Utils.assert_string(payload[:payment_link]),
-            creation_time: Time.parse(Utils.assert_string(payload[:creation_time]))
+            id: TypeUtils.expect_string(payload[:id]),
+            order_number: TypeUtils.expect_string(payload[:order_number]),
+            status: TypeUtils.expect_variant(OrderStatus::ALL, payload[:status]),
+            customer: payload[:customer].nil? ? nil : OrderCustomerInfo.from_payload(TypeUtils.expect_record(payload[:customer])),
+            date: TypeUtils.expect_date(TypeUtils.expect_string(payload[:date])),
+            total_amount: Money.from_payload(TypeUtils.expect_string(payload[:total_amount])),
+            note: payload[:note].nil? ? nil : TypeUtils.expect_string(payload[:note]),
+            payment_link: payload[:payment_link].nil? ? nil : TypeUtils.expect_string(payload[:payment_link]),
+            creation_time: TypeUtils.expect_time(TypeUtils.expect_string(payload[:creation_time])),
           )
         end
       end

data/lib/yield/sdk/modules/order/payloads/order_create_payload.rb

@@ -10,7 +10,7 @@ module Yield
           {
             customer_id: params[:customer_id],
             total_amount: MoneyPayload.build(params[:total_amount]),
-            note: params[:note]
+            note: params[:note],
           }
         end
       end

data/lib/yield/sdk/modules/order/payloads/order_customer_info.rb

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
 
-require_relative "../../../utils"
+require_relative "../../../utils/type_utils"
 
 module Yield
   module SDK
     module Order
-      class OrderCustomerInfo < Data.define(:id, :registered_name, :trade_name)
+      OrderCustomerInfo = Data.define(
+        :id,
+        :registered_name,
+        :trade_name,
+        :customer_code,
+      ) do
         def self.from_payload(payload)
           new(
-            id: Utils.assert_string(payload[:id]),
-            registered_name: Utils.assert_string(payload[:registered_name]),
-            trade_name: payload[:trade_name].nil? ? nil : Utils.assert_string(payload[:trade_name])
+            id: TypeUtils.expect_string(payload[:id]),
+            registered_name: TypeUtils.expect_string(payload[:registered_name]),
+            trade_name: payload[:trade_name].nil? ? nil : TypeUtils.expect_string(payload[:trade_name]),
+            customer_code: payload[:customer_code].nil? ? nil : TypeUtils.expect_string(payload[:customer_code]),
           )
         end
       end

data/lib/yield/sdk/modules/order/payloads/order_status.rb

@@ -4,7 +4,7 @@ module Yield
   module SDK
     module Order
       module OrderStatus
-        ALL = %i[pending confirmed fulfilled cancelled].freeze
+        ALL = %i[pending confirmed fulfilled cancelled].freeze # : Array[:pending | :confirmed | :fulfilled | :cancelled]
       end
     end
   end

data/lib/yield/sdk/modules/self/payloads/self_info.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
-require_relative "../../../utils"
+require_relative "../../../utils/type_utils"
 require_relative "self_organization_info"
 
 module Yield
   module SDK
     module Self
-      class SelfInfo < Data.define(:id, :name, :organization)
+      SelfInfo = Data.define(
+        :id,
+        :name,
+        :organization,
+      ) do
         def self.from_payload(payload)
           new(
-            id: Utils.assert_string(payload[:id]),
-            name: Utils.assert_string(payload[:name]),
-            organization: SelfOrganizationInfo.from_payload(Utils.assert_hash(payload[:organization]))
+            id: TypeUtils.expect_string(payload[:id]),
+            name: TypeUtils.expect_string(payload[:name]),
+            organization: SelfOrganizationInfo.from_payload(TypeUtils.expect_record(payload[:organization])),
           )
         end
       end

data/lib/yield/sdk/modules/self/payloads/self_organization_info.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
-require_relative "../../../utils"
+require_relative "../../../utils/type_utils"
 
 module Yield
   module SDK
     module Self
-      class SelfOrganizationInfo < Data.define(:id, :registered_name, :trade_name)
+      SelfOrganizationInfo = Data.define(
+        :id,
+        :registered_name,
+        :trade_name,
+      ) do
         def self.from_payload(payload)
           new(
-            id: Utils.assert_string(payload[:id]),
-            registered_name: Utils.assert_string(payload[:registered_name]),
-            trade_name: payload[:trade_name].nil? ? nil : Utils.assert_string(payload[:trade_name])
+            id: TypeUtils.expect_string(payload[:id]),
+            registered_name: TypeUtils.expect_string(payload[:registered_name]),
+            trade_name: payload[:trade_name].nil? ? nil : TypeUtils.expect_string(payload[:trade_name]),
           )
         end
       end

data/lib/yield/sdk/types/cursor_payload.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "page"
+
+module Yield
+  module SDK
+    class CursorPayload
+      def self.build(cursor)
+        if cursor.is_a?(String)
+          cursor
+        elsif cursor.is_a?(Page)
+          cursor.last&.id
+        else
+          cursor.id
+        end
+      end
+    end
+  end
+end

data/lib/yield/sdk/types/money.rb

@@ -4,12 +4,15 @@ require "bigdecimal"
 
 module Yield
   module SDK
-    class Money < Data.define(:currency_code, :value)
+    Money = Data.define(:currency_code, :value) do
       def self.from_payload(payload)
         m = payload.match(/^([A-Z]{3}) (-?\d+(?:\.\d+)?)$/)
-        raise ArgumentError, "Invalid money: #{payload}" if m.nil?
+        raise ArgumentError, "Invalid money: \"#{payload}\"" if m.nil?
 
-        new(currency_code: m[1].to_sym, value: BigDecimal(m[2]))
+        # Defined for type-checking reasons
+        m1 = m[1] # : String
+        m2 = m[2] # : String
+        new(currency_code: m1.to_sym, value: BigDecimal(m2))
       end
     end
   end

data/lib/yield/sdk/types/money_payload.rb

@@ -4,9 +4,13 @@ module Yield
   module SDK
     class MoneyPayload
       def self.build(money)
-        return money if money.is_a?(String)
-
-        "#{money.currency_code} #{money.value.to_s("F")}"
+        if money.is_a?(String)
+          money
+        elsif money.is_a?(Array)
+          "#{money[0]} #{money[1].to_s("F")}"
+        else
+          "#{money.currency_code} #{money.value.to_s("F")}"
+        end
       end
     end
   end

data/lib/yield/sdk/types/page.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "../utils/type_utils"
+
+module Yield
+  module SDK
+    class Page
+      include Enumerable
+
+      attr_accessor :has_more
+
+      def initialize(items:, has_more:)
+        @items = items
+        @has_more = has_more
+      end
+
+      def self.build_with(&from_payload_block)
+        lambda { |payload|
+          Page.new(
+            items: TypeUtils.expect_record_list(payload[:items]).map(&from_payload_block),
+            has_more: TypeUtils.expect_boolean(payload[:has_more]),
+          )
+        }
+      end
+
+      def to_a
+        @items.dup
+      end
+
+      def size
+        @items.size
+      end
+
+      def length
+        size
+      end
+
+      def [](index)
+        @items[index]
+      end
+
+      def last
+        @items.last
+      end
+
+      def each(&block)
+        @items.each(&block)
+      end
+    end
+  end
+end

data/lib/yield/sdk/utils/type_utils.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "date"
+require "time"
+
+module Yield
+  module SDK
+    module TypeUtils
+      module_function
+
+      def expect_boolean(data)
+        raise TypeError, "Expected bool, got #{data.class}" unless data == true || data == false
+
+        data # : bool
+      end
+
+      def expect_integer(data)
+        raise TypeError, "Expected Integer, got #{data.class}" unless data.is_a?(Integer)
+
+        data
+      end
+
+      def expect_string(data)
+        raise TypeError, "Expected String, got #{data.class}" unless data.is_a?(String)
+
+        data
+      end
+
+      def expect_date(data)
+        raise TypeError, "Expected String, got #{data.class}" unless data.is_a?(String)
+
+        m = data.match(/^(\d{4})-(\d{2})-(\d{2})$/)
+        raise ArgumentError, "Invalid date: \"#{data}\"" if m.nil?
+
+        Date.new(m[1].to_i, m[2].to_i, m[3].to_i)
+      end
+
+      def expect_time(data)
+        raise TypeError, "Expected String, got #{data.class}" unless data.is_a?(String)
+
+        Time.strptime(data, "%FT%T.%L%Z")
+      end
+
+      def expect_variant(variants, data) # steep:ignore MethodBodyTypeMismatch
+        raise TypeError, "Expected String, got #{data.class}" unless data.is_a?(String)
+
+        symbol = data.downcase.to_sym
+
+        raise ArgumentError, "Invalid variant: \"#{data}\"" unless variants.include?(symbol) # steep:ignore ArgumentTypeMismatch
+
+        symbol
+      end
+
+      def expect_record(data)
+        raise TypeError, "Expected Hash, got #{data.class}" unless data.is_a?(Hash)
+
+        data
+      end
+
+      def expect_list(data)
+        raise TypeError, "Expected Array, got #{data.class}" unless data.is_a?(Array)
+
+        data
+      end
+
+      def expect_record_list(data)
+        expect_list(data).map(&method(:expect_record))
+      end
+    end
+  end
+end

data/lib/yield/sdk/version.rb

@@ -2,13 +2,13 @@
 
 module Yield
   module SDK
-    VERSION = "0.5.1"
+    VERSION = "0.7.0"
 
     module_function
 
     def client_version
-      runtime_major_version = RUBY_ENGINE_VERSION.match(/^\d+(\.\d+)?/)[0]
-      runtime_version = "#{RUBY_ENGINE} #{runtime_major_version}"
+      m = RUBY_ENGINE_VERSION.match(/^\d+(\.\d+)?/)
+      runtime_version = m.nil? ? RUBY_ENGINE : "#{RUBY_ENGINE} #{m[0]}"
 
       "Yield-SDK-Ruby/#{VERSION} (#{runtime_version})"
     end

data/lib/yield/sdk.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+require "backports/3.2.0/data" unless defined?(Data)
+
 require_relative "sdk/client"
 require_relative "sdk/version"
 
 module Yield
   module SDK
-    class Error < StandardError; end
   end
 end

data/sig/vendor/faraday.rbs

@@ -0,0 +1,23 @@
+# Ideally we should use RBS collections, but it's very incomplete and full of untyped:
+# https://github.com/ruby/gem_rbs_collection/blob/main/gems/faraday/2.5/faraday.rbs
+# Even the yard docs offer better specs:
+# https://gemdocs.org/gems/faraday/2.13.1/
+# We could contribute back, but it's much easier to scope this based on our actual usage.
+
+class Faraday::Connection
+  def run_request: (:get | :post method, String url, String? body, Hash[String, String]? headers) -> Faraday::Response
+end
+
+class Faraday::Response
+  attr_reader status: Integer
+  attr_reader body: String
+  attr_reader headers: Hash[String, String]
+
+  def success?: () -> bool
+  def []: (String) -> String?
+end
+
+module Faraday
+  def self.new: (?String) -> Faraday::Connection
+    | (?String) { (Faraday::Connection) -> void } -> Faraday::Connection
+end

data/sig/yield/sdk/api/api_client.rbs

@@ -0,0 +1,26 @@
+module Yield
+  module SDK
+    module API
+      class Client
+        def initialize: (String api_key, ?base_url: String?, ?conn: Faraday::Connection?) -> void
+
+        def self.extract_api_key: (String) -> [String, String]
+        def self.build_signature: (String hmac_key, String timestamp, String path, ?String? body) -> String
+        def self.process_response: [R] (Faraday::Response response) { (Hash[Symbol, Object]) -> R } -> Result[R]
+
+        def run_query: (String, ?Hash[Symbol, String | Integer | nil]?) -> Faraday::Response
+        def run_command: (String, Object) -> Faraday::Response
+
+        private
+
+        @base_url: String
+        @api_key_token: String
+        @api_key_hmac_key: String
+        @conn: Faraday::Connection
+        @client_version: String
+
+        def call_endpoint: (:get | :post, String, Object?) -> Faraday::Response
+      end
+    end
+  end
+end

data/sig/yield/sdk/api/api_error.rbs

@@ -0,0 +1,13 @@
+module Yield
+  module SDK
+    module API
+      class Error < StandardError
+        attr_reader status_code: Integer
+        attr_reader request_id: String?
+        attr_reader details: ErrorDetails
+
+        def initialize: (Integer, String?, ErrorDetails) -> void
+      end
+    end
+  end
+end

data/sig/yield/sdk/api/api_error_details.rbs

@@ -0,0 +1,14 @@
+module Yield
+  module SDK
+    module API
+      class ErrorDetails
+        attr_reader type: String
+        attr_reader body: Hash[String, Object]?
+        attr_reader exception: StandardError?
+
+        def initialize: (String, Hash[String, Object]?, StandardError?) -> void
+          | (type: String, body: Hash[String, Object]?, exception: StandardError?) -> void
+      end
+    end
+  end
+end

data/sig/yield/sdk/api/api_result.rbs

@@ -0,0 +1,19 @@
+module Yield
+  module SDK
+    module API
+      class Result[T]
+        attr_reader status_code: Integer
+        attr_reader request_id: String?
+        attr_reader data: T
+        attr_reader error: ErrorDetails?
+
+        def initialize: (status_code: Integer, request_id: String?, data: T, error: ErrorDetails?) -> void
+
+        def self.success: [D] (Integer, String?, D) -> Result[D]
+        def self.failure: (Integer, String?, String, Hash[String, Object]?, StandardError?) -> Result[untyped]
+
+        def ok?: -> bool
+      end
+    end
+  end
+end

data/sig/yield/sdk/base_client.rbs

@@ -0,0 +1,13 @@
+module Yield
+  module SDK
+    class BaseClient
+      attr_reader api: API::Client
+
+      attr_reader customer: Customer::BaseClient
+      attr_reader order: Order::BaseClient
+      attr_reader self: Self::BaseClient
+
+      def initialize: (String api_key, ?base_url: String?, ?conn: Faraday::Connection?) -> void
+    end
+  end
+end

data/sig/yield/sdk/client.rbs

@@ -0,0 +1,13 @@
+module Yield
+  module SDK
+    class Client
+      attr_reader base: BaseClient
+
+      attr_reader customer: Customer::Client
+      attr_reader order: Order::Client
+      attr_reader self: Self::Client
+
+      def initialize: (String api_key, ?base_url: String?, ?conn: Faraday::Connection?) -> void
+    end
+  end
+end

data/sig/yield/sdk/modules/customer/customer_base_client.rbs

@@ -0,0 +1,11 @@
+module Yield
+  module SDK
+    module Customer
+      class BaseClient
+        @api: API::Client
+        def initialize: (API::Client) -> void
+        def list: (?customer_list_params?) -> API::Result[Page[CustomerRow]]
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/customer/customer_client.rbs

@@ -0,0 +1,11 @@
+module Yield
+  module SDK
+    module Customer
+      class Client
+        @base: BaseClient
+        def initialize: (BaseClient) -> void
+        def list: (?customer_list_params?) -> Page[CustomerRow]
+      end
+    end
+  end
+end