amocrm 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0868d231f31c616122c77b9729183ccb25578c30feeb37aaf2eb89f0d2dfb2ab'
-  data.tar.gz: '09b00b9d5ea30f36660b7a3d7edece52d786a29158f80023faa9b521e54c783b'
+  metadata.gz: 953688e737dbd47ad20302d617670f8e6e719896ebc97174d0d1e90388008fcd
+  data.tar.gz: 858c425ffcc05c3c2f61b75f4d0481fb0f3daa27461eb9b47ebccca47338a0d0
 SHA512:
-  metadata.gz: 2d3195bdce0a6fbecc42c2aaae5650be0d0745d17384054906f1e25384bb1432e246adaef1371b477d8e1e4783987b6d533096a890919643baf894ba188f65ab
-  data.tar.gz: f72512cd8056814d16264da2b25dae821b3e2127e82df5bf6db0a74221861e3a0a2f235fcd66db953dbb41a5a127965839b864f98d78e57423991e9f338242dd
+  metadata.gz: 9ade2d543faf32eef73ff10de52644776f4a01fff2ab270d2d8587dc38edc0421e5b9a48cae999b0ce340e0119272a448ef5b4298d22f873311162265a49476e
+  data.tar.gz: 751aed99a3da0659b98129161b649d5a76ec158a766b0a2e9eaed33a0242f6a72707c530683201c2d90b38382fcbe0aa5447033a177502db97ae3ce6ac9ad0b5

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.3.0 (2026-02-06)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/Hexlet/amocrm-ruby/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** api update ([63b728e](https://github.com/Hexlet/amocrm-ruby/commit/63b728e195a95b6116d954797cd4224626c3fd28))
+
+## 0.2.0 (2026-02-06)
+
+Full Changelog: [v0.1.2...v0.2.0](https://github.com/Hexlet/amocrm-ruby/compare/v0.1.2...v0.2.0)
+
+### Features
+
+* **api:** api update ([c47313c](https://github.com/Hexlet/amocrm-ruby/commit/c47313c8d4d72d7fa64f8ae3492f1474287132e6))
+
 ## 0.1.2 (2026-02-04)
 
 Full Changelog: [v0.1.1...v0.1.2](https://github.com/Hexlet/amocrm-ruby/compare/v0.1.1...v0.1.2)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "amocrm", "~> 0.1.2"
+gem "amocrm", "~> 0.3.0"
 ```
 
 <!-- x-release-please-end -->
@@ -26,7 +26,10 @@ gem "amocrm", "~> 0.1.2"
 require "bundler/setup"
 require "amocrm"
 
-amocrm = Amocrm::Client.new(api_key: "My API Key")
+amocrm = Amocrm::Client.new(
+  token: ENV["AMOCRM_AUTH_TOKEN"], # This is the default and can be omitted
+  subdomain: "My-Subdomain"
+)
 
 response = amocrm.v4.leads.unsorted.create_forms(
   body: [{metadata: {}, source_name: "source_name", source_uid: "source_uid"}]
@@ -83,7 +86,7 @@ You can use the `max_retries` option to configure or disable this:
 # Configure the default for all requests:
 amocrm = Amocrm::Client.new(
   max_retries: 0, # default is 2
-  api_key: "My API Key"
+  subdomain: "My-Subdomain"
 )
 
 # Or, configure per-request:
@@ -101,7 +104,7 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
 # Configure the default for all requests:
 amocrm = Amocrm::Client.new(
   timeout: nil, # default is 60
-  api_key: "My API Key"
+  subdomain: "My-Subdomain"
 )
 
 # Or, configure per-request:

data/lib/amocrm/client.rb

@@ -16,14 +16,28 @@ module Amocrm
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
     # @return [String]
-    attr_reader :api_key
+    attr_reader :token
+
+    # @return [String]
+    attr_reader :subdomain
 
     # @return [Amocrm::Resources::V4]
     attr_reader :v4
 
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @token.nil?
+
+      {"authorization" => "Bearer #{@token}"}
+    end
+
     # Creates and returns a new client for interacting with the API.
     #
-    # @param api_key [String, nil] Defaults to `ENV["AMOCRM_API_KEY"]`
+    # @param token [String, nil] Defaults to `ENV["AMOCRM_AUTH_TOKEN"]`
+    #
+    # @param subdomain [String, nil] Defaults to `ENV["AMOCRM_SUBDOMAIN"]`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["AMOCRM_BASE_URL"]`
@@ -36,20 +50,25 @@ module Amocrm
     #
     # @param max_retry_delay [Float]
     def initialize(
-      api_key: ENV["AMOCRM_API_KEY"],
+      token: ENV["AMOCRM_AUTH_TOKEN"],
+      subdomain: ENV["AMOCRM_SUBDOMAIN"],
       base_url: ENV["AMOCRM_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://{subdomain}.amocrm.ru"
+      base_url ||= "https://#{subdomain}.amocrm.ru"
 
-      if api_key.nil?
-        raise ArgumentError.new("api_key is required, and can be set via environ: \"AMOCRM_API_KEY\"")
+      if token.nil?
+        raise ArgumentError.new("token is required, and can be set via environ: \"AMOCRM_AUTH_TOKEN\"")
+      end
+      if subdomain.nil?
+        raise ArgumentError.new("subdomain is required, and can be set via environ: \"AMOCRM_SUBDOMAIN\"")
       end
 
-      @api_key = api_key.to_s
+      @token = token.to_s
+      @subdomain = subdomain.to_s
 
       super(
         base_url: base_url,

data/lib/amocrm/internal/transport/base_client.rb

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

data/lib/amocrm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Amocrm
-  VERSION = "0.1.2"
+  VERSION = "0.3.0"
 end

data/rbi/amocrm/client.rbi

@@ -11,15 +11,24 @@ module Amocrm
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
     sig { returns(String) }
-    attr_reader :api_key
+    attr_reader :token
+
+    sig { returns(String) }
+    attr_reader :subdomain
 
     sig { returns(Amocrm::Resources::V4) }
     attr_reader :v4
 
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
-        api_key: T.nilable(String),
+        token: T.nilable(String),
+        subdomain: T.nilable(String),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
@@ -28,8 +37,10 @@ module Amocrm
       ).returns(T.attached_class)
     end
     def self.new(
-      # Defaults to `ENV["AMOCRM_API_KEY"]`
-      api_key: ENV["AMOCRM_API_KEY"],
+      # Defaults to `ENV["AMOCRM_AUTH_TOKEN"]`
+      token: ENV["AMOCRM_AUTH_TOKEN"],
+      # Defaults to `ENV["AMOCRM_SUBDOMAIN"]`
+      subdomain: ENV["AMOCRM_SUBDOMAIN"],
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["AMOCRM_BASE_URL"]`
       base_url: ENV["AMOCRM_BASE_URL"],

data/rbi/amocrm/internal/transport/base_client.rbi

@@ -171,6 +171,11 @@ module Amocrm
         )
         end
 
+        # @api private
+        sig { overridable.returns(T::Hash[String, String]) }
+        private def auth_headers
+        end
+
         # @api private
         sig { returns(String) }
         private def user_agent

data/sig/amocrm/client.rbs

@@ -8,12 +8,17 @@ module Amocrm
 
     DEFAULT_MAX_RETRY_DELAY: Float
 
-    attr_reader api_key: String
+    attr_reader token: String
+
+    attr_reader subdomain: String
 
     attr_reader v4: Amocrm::Resources::V4
 
+    private def auth_headers: -> ::Hash[String, String]
+
     def initialize: (
-      ?api_key: String?,
+      ?token: String?,
+      ?subdomain: String?,
       ?base_url: String?,
       ?max_retries: Integer,
       ?timeout: Float,

data/sig/amocrm/internal/transport/base_client.rbs

@@ -85,6 +85,8 @@ module Amocrm
           ?idempotency_header: String?
         ) -> void
 
+        private def auth_headers: -> ::Hash[String, String]
+
         private def user_agent: -> String
 
         private def generate_idempotency_key: -> String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amocrm
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Amocrm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-05 00:00:00.000000000 Z
+date: 2026-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi