feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 19
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hexlet%2Fcloudpayments-21652c2d2e6a5aab678ca435ba09ef698ff34270021f349660b84d5d98bf3923.yml
-openapi_spec_hash: 356a7298b2abac3fdf72ad5ee046b952
-config_hash: 039ea7c50406040341fca19f6c331be6
+configured_endpoints: 6
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hexlet%2Fcloudpayments-4a7c87f457029686206224a4785cd5e539dd42d905f84a68dbd440f24b3ba055.yml
+openapi_spec_hash: ce4157583083d05eaf8e5ec45216c112
+config_hash: d26a7d37520b517e14ffae7f7ab0119b

README.md

@@ -26,13 +26,17 @@ gem "cloudpayments", "~> 0.0.2"
 require "bundler/setup"
 require "cloudpayments"
 
-cloudpayments = Cloudpayments::Client.new(
-  api_key: ENV["PETSTORE_API_KEY"] # This is the default and can be omitted
+cloudpayments = Cloudpayments::Client.new(public_id: "My Public ID", api_secret: "My API Secret")
+
+response = cloudpayments.payments.charge(
+  amount: 100,
+  card_cryptogram_packet: "cryptogram_data",
+  ip_address: "127.0.0.1",
+  currency: "RUB",
+  description: "Оплата заказа"
 )
 
-order = cloudpayments.store.orders.create(pet_id: 1, quantity: 1, status: "placed")
-
-puts(order.id)
+puts(response)
 ```
 
 ### Handling errors
@@ -41,7 +45,12 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  store = cloudpayments.store.list_inventory
+  payment = cloudpayments.payments.charge(
+    amount: 100,
+    card_cryptogram_packet: "cryptogram_data",
+    ip_address: "127.0.0.1",
+    currency: "RUB"
+  )
 rescue Cloudpayments::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -80,11 +89,19 @@ You can use the `max_retries` option to configure or disable this:
 ```ruby
 # Configure the default for all requests:
 cloudpayments = Cloudpayments::Client.new(
-  max_retries: 0 # default is 2
+  max_retries: 0, # default is 2
+  public_id: "My Public ID",
+  api_secret: "My API Secret"
 )
 
 # Or, configure per-request:
-cloudpayments.store.list_inventory(request_options: {max_retries: 5})
+cloudpayments.payments.charge(
+  amount: 100,
+  card_cryptogram_packet: "cryptogram_data",
+  ip_address: "127.0.0.1",
+  currency: "RUB",
+  request_options: {max_retries: 5}
+)
 ```
 
 ### Timeouts
@@ -94,11 +111,19 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
 ```ruby
 # Configure the default for all requests:
 cloudpayments = Cloudpayments::Client.new(
-  timeout: nil # default is 60
+  timeout: nil, # default is 60
+  public_id: "My Public ID",
+  api_secret: "My API Secret"
 )
 
 # Or, configure per-request:
-cloudpayments.store.list_inventory(request_options: {timeout: 5})
+cloudpayments.payments.charge(
+  amount: 100,
+  card_cryptogram_packet: "cryptogram_data",
+  ip_address: "127.0.0.1",
+  currency: "RUB",
+  request_options: {timeout: 5}
+)
 ```
 
 On timeout, `Cloudpayments::Errors::APITimeoutError` is raised.
@@ -129,7 +154,11 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 
 ```ruby
 response =
-  cloudpayments.store.list_inventory(
+  cloudpayments.payments.charge(
+    amount: 100,
+    card_cryptogram_packet: "cryptogram_data",
+    ip_address: "127.0.0.1",
+    currency: "RUB",
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -175,46 +204,36 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-cloudpayments.store.orders.create(pet_id: 1, quantity: 1, status: "placed")
+cloudpayments.payments.charge(
+  amount: 100,
+  card_cryptogram_packet: "cryptogram_data",
+  ip_address: "127.0.0.1",
+  currency: "RUB",
+  description: "Оплата заказа"
+)
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-cloudpayments.store.orders.create(pet_id: 1, quantity: 1, status: "placed")
-
-# You can also splat a full Params class:
-params = Cloudpayments::Store::OrderCreateParams.new(pet_id: 1, quantity: 1, status: "placed")
-cloudpayments.store.orders.create(**params)
-```
-
-### Enums
-
-Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
-
-```ruby
-# :available
-puts(Cloudpayments::Pet::Status::AVAILABLE)
-
-# Revealed type: `T.all(Cloudpayments::Pet::Status, Symbol)`
-T.reveal_type(Cloudpayments::Pet::Status::AVAILABLE)
-```
-
-Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
-
-```ruby
-# Using the enum constants preserves the tagged type information:
-cloudpayments.pets.create(
-  status: Cloudpayments::Pet::Status::AVAILABLE,
-  # …
+cloudpayments.payments.charge(
+  amount: 100,
+  card_cryptogram_packet: "cryptogram_data",
+  ip_address: "127.0.0.1",
+  currency: "RUB",
+  description: "Оплата заказа"
 )
 
-# Literal values are also permissible:
-cloudpayments.pets.create(
-  status: :available,
-  # …
+# You can also splat a full Params class:
+params = Cloudpayments::PaymentChargeParams.new(
+  amount: 100,
+  card_cryptogram_packet: "cryptogram_data",
+  ip_address: "127.0.0.1",
+  currency: "RUB",
+  description: "Оплата заказа"
 )
+cloudpayments.payments.charge(**params)
 ```
 
 ## Versioning

lib/cloudpayments.rb

@@ -52,36 +52,17 @@
 require_relative "cloudpayments/internal/transport/base_client"
 require_relative "cloudpayments/internal/transport/pooled_net_requester"
 require_relative "cloudpayments/client"
-require_relative "cloudpayments/models/pet"
-require_relative "cloudpayments/models/order"
-require_relative "cloudpayments/models/user"
-require_relative "cloudpayments/models/category"
-require_relative "cloudpayments/models/pet_create_params"
-require_relative "cloudpayments/models/pet_delete_params"
-require_relative "cloudpayments/models/pet_find_by_status_params"
-require_relative "cloudpayments/models/pet_find_by_status_response"
-require_relative "cloudpayments/models/pet_find_by_tags_params"
-require_relative "cloudpayments/models/pet_find_by_tags_response"
-require_relative "cloudpayments/models/pet_retrieve_params"
-require_relative "cloudpayments/models/pet_update_by_id_params"
-require_relative "cloudpayments/models/pet_update_params"
-require_relative "cloudpayments/models/pet_upload_image_params"
-require_relative "cloudpayments/models/pet_upload_image_response"
-require_relative "cloudpayments/models/store/order_create_params"
-require_relative "cloudpayments/models/store/order_delete_params"
-require_relative "cloudpayments/models/store/order_retrieve_params"
-require_relative "cloudpayments/models/store_list_inventory_params"
-require_relative "cloudpayments/models/store_list_inventory_response"
-require_relative "cloudpayments/models/user_create_params"
-require_relative "cloudpayments/models/user_create_with_list_params"
-require_relative "cloudpayments/models/user_delete_params"
-require_relative "cloudpayments/models/user_login_params"
-require_relative "cloudpayments/models/user_login_response"
-require_relative "cloudpayments/models/user_logout_params"
-require_relative "cloudpayments/models/user_retrieve_params"
-require_relative "cloudpayments/models/user_update_params"
+require_relative "cloudpayments/models/payment_auth_params"
+require_relative "cloudpayments/models/payment_auth_response"
+require_relative "cloudpayments/models/payment_charge_params"
+require_relative "cloudpayments/models/payment_charge_response"
+require_relative "cloudpayments/models/payment_confirm_params"
+require_relative "cloudpayments/models/payment_confirm_response"
+require_relative "cloudpayments/models/payment_post3ds_params"
+require_relative "cloudpayments/models/payment_post3ds_response"
+require_relative "cloudpayments/models/payment_refund_params"
+require_relative "cloudpayments/models/payment_refund_response"
+require_relative "cloudpayments/models/payment_void_params"
+require_relative "cloudpayments/models/payment_void_response"
 require_relative "cloudpayments/models"
-require_relative "cloudpayments/resources/pets"
-require_relative "cloudpayments/resources/store"
-require_relative "cloudpayments/resources/store/orders"
-require_relative "cloudpayments/resources/users"
+require_relative "cloudpayments/resources/payments"

lib/cloudpayments/client.rb

@@ -16,27 +16,19 @@ class Client < Cloudpayments::Internal::Transport::BaseClient
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
     # @return [String]
-    attr_reader :api_key
+    attr_reader :public_id
 
-    # @return [Cloudpayments::Resources::Pets]
-    attr_reader :pets
-
-    # @return [Cloudpayments::Resources::Store]
-    attr_reader :store
+    # @return [String]
+    attr_reader :api_secret
 
-    # @return [Cloudpayments::Resources::Users]
-    attr_reader :users
-
-    # @api private
-    #
-    # @return [Hash{String=>String}]
-    private def auth_headers
-      {"api_key" => @api_key}
-    end
+    # @return [Cloudpayments::Resources::Payments]
+    attr_reader :payments
 
     # Creates and returns a new client for interacting with the API.
     #
-    # @param api_key [String, nil] Defaults to `ENV["PETSTORE_API_KEY"]`
+    # @param public_id [String, nil] Defaults to `ENV["CLOUDPAYMENTS_PUBLIC_ID"]`
+    #
+    # @param api_secret [String, nil] Defaults to `ENV["CLOUDPAYMENTS_API_SECRET"]`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["CLOUDPAYMENTS_BASE_URL"]`
@@ -49,20 +41,25 @@ class Client < Cloudpayments::Internal::Transport::BaseClient
     #
     # @param max_retry_delay [Float]
     def initialize(
-      api_key: ENV["PETSTORE_API_KEY"],
+      public_id: ENV["CLOUDPAYMENTS_PUBLIC_ID"],
+      api_secret: ENV["CLOUDPAYMENTS_API_SECRET"],
       base_url: ENV["CLOUDPAYMENTS_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
     )
-      base_url ||= "https://petstore3.swagger.io/api/v3"
+      base_url ||= "https://api.cloudpayments.ru"
 
-      if api_key.nil?
-        raise ArgumentError.new("api_key is required, and can be set via environ: \"PETSTORE_API_KEY\"")
+      if public_id.nil?
+        raise ArgumentError.new("public_id is required, and can be set via environ: \"CLOUDPAYMENTS_PUBLIC_ID\"")
+      end
+      if api_secret.nil?
+        raise ArgumentError.new("api_secret is required, and can be set via environ: \"CLOUDPAYMENTS_API_SECRET\"")
       end
 
-      @api_key = api_key.to_s
+      @public_id = public_id.to_s
+      @api_secret = api_secret.to_s
 
       super(
         base_url: base_url,
@@ -72,9 +69,7 @@ def initialize(
         max_retry_delay: max_retry_delay
       )
 
-      @pets = Cloudpayments::Resources::Pets.new(client: self)
-      @store = Cloudpayments::Resources::Store.new(client: self)
-      @users = Cloudpayments::Resources::Users.new(client: self)
+      @payments = Cloudpayments::Resources::Payments.new(client: self)
     end
   end
 end

lib/cloudpayments/internal/transport/base_client.rb

@@ -215,11 +215,6 @@ def initialize(
           @max_retry_delay = max_retry_delay
         end
 
-        # @api private
-        #
-        # @return [Hash{String=>String}]
-        private def auth_headers = {}
-
         # @api private
         #
         # @return [String]
@@ -276,7 +271,6 @@ def initialize(
 
           headers = Cloudpayments::Internal::Util.normalized_headers(
             @headers,
-            auth_headers,
             req[:headers].to_h,
             opts[:extra_headers].to_h
           )

lib/cloudpayments/internal/type/base_model.rb

@@ -441,11 +441,10 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false)
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `order` is a `Cloudpayments::Order`
-        #   order => {
-        #     id: id,
-        #     complete: complete,
-        #     pet_id: pet_id
+        #   # `payment_confirm_response` is a `Cloudpayments::Models::PaymentConfirmResponse`
+        #   payment_confirm_response => {
+        #     success: success,
+        #     message: message
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

lib/cloudpayments/internal/type/union.rb

@@ -4,6 +4,17 @@ module Cloudpayments
   module Internal
     module Type
       # @api private
+      #
+      # @example
+      #   # `payment_auth_response` is a `Cloudpayments::Models::PaymentAuthResponse`
+      #   case payment_auth_response
+      #   when Cloudpayments::Models::PaymentAuthResponse::UnionMember0
+      #     puts(payment_auth_response.success)
+      #   when Cloudpayments::Models::PaymentAuthResponse::UnionMember1
+      #     puts(payment_auth_response.message)
+      #   else
+      #     puts(payment_auth_response)
+      #   end
       module Union
         include Cloudpayments::Internal::Type::Converter
         include Cloudpayments::Internal::Util::SorbetRuntimeSupport