proxy-cheap-client 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cccaf84349c42eebaab6e20aff252f195abfec2f6fd69aff2d9c12d7c20176eb
-  data.tar.gz: 20bca5cfae76856c4fd84b73ecd1524ffd1d92c879464002459cb82b377bfbd8
+  metadata.gz: 6c5ac4012c4d9c09bbeffcbb708a9e0621303fd375cbe2de06c9956809def96e
+  data.tar.gz: 537ad65c4a55cce1e07f10006b728f2b7c0830cda33d23cc467d69d39b5b0a13
 SHA512:
-  metadata.gz: ab860018b35b4ac7d354de8f0aa5b06300898d794b06e8530b17a6e2830581655a57eac6781fb128be0c043e9d66b7990cfc481216936b9bbe4b2bf9973c192e
-  data.tar.gz: c9e825ce0041e783d55f610c25046290dfffa79fa79a0d4d9b2bd0178e198fc7c8bfd72abff49edf1292400724b79379633e6dad49d2a60575173b884b2ec088
+  metadata.gz: b1b030162bf6fd28039d83ebfe134d7cc6cfe4ca345d56adf46faf3dd1ea0aac045b5ce9ac5e63d199a09c0fb4366d10e5039ad69a34a96c34de86b9c7289fb1
+  data.tar.gz: 7cfbe3a80af18ba15f5b13f3605fd00544e45796b8a090ec71636199681a4fb530b7fde25fad9f2bf4530882de6ac8b557eca481cb2e60e1f6163fd1ee419c8f

data/README.md

@@ -4,7 +4,7 @@ Ruby client for the Proxy-Cheap.com API.
 
 [![Gem Version](https://img.shields.io/gem/v/proxy-cheap-client.svg)](https://rubygems.org/gems/proxy-cheap-client) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE.txt)
 
-### Features
+**Features:**
 
 * Retrieve account balance
 * List proxies
@@ -12,19 +12,39 @@ Ruby client for the Proxy-Cheap.com API.
 * Get list of supported countries
 * Order new residential proxies
 
-### Requirements
+**Requirements:**
 
 * Ruby 2.7+
 * Internet access to Proxy-Cheap.com API
 * API key and API secret from Proxy-Cheap.com
 
-### Installation
+**Outlook:**
+
+- [1. Installation](#1-installation)
+- [2. Configuration](#2-configuration)
+- [3. Usage Example](#3-usage-example)
+- [4. Load Proxies](#4-load-proxies)
+- [5. Load Specific Proxy](#5-load-specific-proxy)
+- [6. Enable auto-extend for a proxy](#6-enable-auto-extend-for-a-proxy)
+- [7. Disable auto-extend](#7-disable-auto-extend)
+- [8. Supported Countries](#8-supported-countries)
+- [9. Order Residential Proxies](#9-order-residential-proxies)
+- [10. Order Proxies](#10-order-proxies)
+- [11. Order Expenses](#11-order-expenses)
+- [12. Proxies of an Old Order](#12-proxies-of-an-old-order)
+- [13. Using Multiple Credentials](#13-using-multiple-credentials)
+- [14. Error Handling](#14-error-handling)
+- [15. Publishing](#15-publishing)
+- [16. Contributing](#16-contributing)
+- [17. License](#17-license)
+
+## 1. Installation
 
 ```bash
 gem install proxy-cheap-client
 ```
 
-### Configuration
+## 2. Configuration
 
 The client requires both an API key and API secret.
 
@@ -37,7 +57,7 @@ client = ProxyCheapClient::Client.new(
 )
 ```
 
-### Usage Example
+## 3. Usage Example
 
 ```ruby
 require "proxy-cheap-client"
@@ -52,7 +72,7 @@ balance = client.balance
 puts "Balance: #{balance.amount} #{balance.currency}"
 ```
 
-### Load Proxies
+## 4. Load Proxies
 
 ```ruby
 proxies = client.proxies
@@ -61,35 +81,35 @@ proxies.each do |p|
 end
 ```
 
-### Load Specific Proxy
+## 5. Load Specific Proxy
 
 ```ruby
 proxy = ProxyCheapClient::Proxy.load('12345')
 puts "Proxy details: #{proxy.to_h}"
 ```
 
-### Enable auto-extend for a proxy
+## 6. Enable auto-extend for a proxy
 
 ```ruby
 proxy.enable_auto_extend
 puts "Auto-extend enabled"
 ```
 
-### Disable auto-extend
+## 7. Disable auto-extend
 
 ```ruby
 proxy.disable_auto_extend
 puts "Auto-extend disabled"
 ```
 
-### Supported Countries
+## 8. Supported Countries
 
 ```ruby
 arr = client.countries
 puts "Supported Countries: #{arr}"
 ```
 
-### Order Residential Proxies
+## 9. Order Residential Proxies
 
 ```ruby
 order = client.order_static_residential_proxy(
@@ -99,13 +119,47 @@ order = client.order_static_residential_proxy(
 )
 ```
 
-### Order Proxies
+## 10. Order Proxies
 
 ```ruby
 order.proxies
 ```
 
-### Error Handling
+## 11. Order Expenses
+
+```ruby
+puts "Total Price: #{order.total_price} USD"
+# => "Total Price: 3.39 USD"
+```
+
+## 12. Proxies of an Old Order
+
+```ruby
+# Get proxies for an order by Order ID
+proxies = client.order_proxies("019b85aa-7e12-7b10-a26e-46fc5adfdcf4")
+proxies.each do |p|
+  puts "Proxy #{p.id}: #{p.ip}:#{p.port}"
+end
+# => Proxy 1742085: 176.46.143.42:45842
+# => ...
+```
+
+## 13. Using Multiple Credentials
+
+```ruby
+...
+
+# Reset the client connection
+ProxyCheapClient::Client.reset_connection
+
+# Initialize the client with other API credentials.
+client = ProxyCheapClient::Client.new(
+  api_key: PROXY_CHEAP_API_KEY,
+  api_secret: PROXY_CHEAP_API_SECRET
+)
+```
+
+## 14. Error Handling
 
 The client raises specific exceptions for failure modes:
 
@@ -130,7 +184,7 @@ rescue ProxyCheapClient::Error => e
 end
 ```
 
-### Publishing
+## 15. Publishing
 
 Build and push to RubyGems:
 
@@ -141,13 +195,13 @@ gem push proxy-cheap-client-#{ProxyCheapClient::VERSION}.gem
 
 Make sure you have an account on RubyGems.org and appropriate credentials configured in `~/.gem/credentials`.
 
-### Contributing
+## 16. Contributing
 
 1. Fork the repository.
 2. Create a feature branch: `git checkout -b feature/xyz`
 3. Run tests (add test suite if missing).
 4. Open a pull request with a clear description.
 
-### License
+## 17. License
 
 This project is licensed under the MIT License. See `LICENSE.txt` for details.

data/lib/proxy_cheap_client/client.rb

@@ -12,6 +12,10 @@ module ProxyCheapClient
   class Client < Base
     API_BASE = "https://api.proxy-cheap.com"
 
+    def self.reset_connection
+      @@conn = nil
+    end
+
     # Initialize the client with API credentials.
     # @param api_key [String] API key (or set PROXY_CHEAP_API_KEY env var)
     # @param api_secret [String] API secret (or set PROXY_CHEAP_API_SECRET env var)
@@ -21,13 +25,15 @@ module ProxyCheapClient
       api_secret:, 
       timeout: 10
     )
+      raise "Client already initialized" if defined?(@@conn) && @@conn
+
       @api_key = api_key
       @api_secret = api_secret
 
       raise AuthenticationError, "API key missing" unless @api_key && !@api_key.strip.empty?
       raise AuthenticationError, "API secret missing" unless @api_secret && !@api_secret.strip.empty?
 
-      @conn = Faraday.new(url: API_BASE) do |f|
+      @@conn = Faraday.new(url: API_BASE) do |f|
         f.request :json
         f.response :raise_error
         f.options.timeout = timeout
@@ -40,10 +46,6 @@ module ProxyCheapClient
       raise RequestError, "Connection failure: #{e.message}"
     end
 
-    def conn
-      @conn
-    end
-
     # retrieve the array of countries with number of available proxies per country
     def countries
       config = self.configuration(
@@ -61,7 +63,19 @@ module ProxyCheapClient
     # @return [Balance]
     def balance
       resp = request(:get, "account/balance")
-      Balance.new(resp, self)
+      Balance.new(resp)
+    end
+
+    # Get order proxies by order ID.
+    # @param order_id [String] Order ID
+    # @return [Array<Proxy>]
+    def order_proxies(order_id)
+      resp = request(:get, "orders/#{order_id}/proxies")
+      arr = []
+      resp.each do |p|
+        arr << ProxyCheapClient::Proxy.new(p)
+      end
+      arr
     end
 
     # Get all user proxies.
@@ -71,7 +85,8 @@ module ProxyCheapClient
       # API may return proxies directly as an array or wrapped in a "data" key
       proxy_list = resp.is_a?(Hash) && resp.key?("data") ? resp["data"] : resp
       proxy_list = resp.is_a?(Hash) && resp.key?("proxies") ? resp["proxies"] : resp
-      Array(proxy_list).map { |p| Proxy.new(p, self) }
+      proxy_list.select! { |h| h["connection"] && h["connection"]["publicIp"] } # static residential proxies always have publicIp
+      Array(proxy_list).map { |p| Proxy.new(p) }
     end
     
     # Convenience method to order a static residential proxy.
@@ -112,7 +127,7 @@ module ProxyCheapClient
     # @return [Configuration]
     def configuration(params = {})
       resp = request(:post, "order/configuration", params)
-      Configuration.new(resp, self)
+      Configuration.new(resp)
     end # def configuration
 
     # Execute an order with the given configuration.
@@ -126,7 +141,7 @@ module ProxyCheapClient
       # "totalPrice"=>"3.39"}
 
       # Return order model (API returns order descriptor including id/status)
-      Order.new(resp, self)
+      Order.new(resp)
     end # def order
   end # class Client
 end # module ProxyCheapClient

data/lib/proxy_cheap_client/models/balance.rb

@@ -1,12 +1,11 @@
 module ProxyCheapClient
   #module Models
     class Balance < Base
-      attr_reader :amount, :currency, :conn
+      attr_reader :amount, :currency
 
-      def initialize(attrs = {}, client)
+      def initialize(attrs)
         @amount = attrs["balance"] || attrs["amount"]
         @currency = attrs["currency"] || "USD"
-        @conn = client.conn
       end
 
       def to_h

data/lib/proxy_cheap_client/models/base.rb

@@ -1,20 +1,27 @@
 module ProxyCheapClient
   class Base
+    # Define a static class attribute `conn`
+    @@conn = nil
+
+    def conn
+      @@conn
+    end
+
     # Make an HTTP request to the API.
     # @note Some API endpoints (whitelist, extend-period, buy-bandwidth) use GET
     #       requests with JSON body, which is non-standard but matches the official API behavior.
-    def request(method, path, body = nil)
+    def self.request(method, path, body = nil)
       response = case method.to_s.downcase.to_sym
                  when :get
                    if body
-                     @conn.get(path) { |r| r.body = body.to_json }
+                     @@conn.get(path) { |r| r.body = body.to_json }
                    else
-                     @conn.get(path)
+                     @@conn.get(path)
                    end
                  when :post
-                   @conn.post(path) { |r| r.body = body.to_json if body }
+                   @@conn.post(path) { |r| r.body = body.to_json if body }
                  when :patch
-                   @conn.patch(path) { |r| r.body = body.to_json if body }
+                   @@conn.patch(path) { |r| r.body = body.to_json if body }
                  else
                    raise RequestError, "Unsupported HTTP method: #{method}"
                  end
@@ -50,13 +57,22 @@ module ProxyCheapClient
         status_code: e.response&.dig(:status),
         response_body: extract_error_body(e)
       )
+    end # self.request
+
+    # Make an HTTP request to the API.
+    # @note Some API endpoints (whitelist, extend-period, buy-bandwidth) use GET
+    #       requests with JSON body, which is non-standard but matches the official API behavior.
+    def request(method, path, body = nil)
+      self.class.request(method, path, body)
     end # request
 
-    def extract_error_body(error)
+    private
+    
+    def self.extract_error_body(error)
       error.response&.dig(:body)
-    end # extract_error_body
+    end # self.extract_error_body
 
-    def extract_error_message(error)
+    def self.extract_error_message(error)
       body = extract_error_body(error)
       return error.message unless body
 
@@ -66,9 +82,9 @@ module ProxyCheapClient
       rescue JSON::ParserError
         body
       end
-    end # extract_error_message
+    end # self.extract_error_message
 
-    def parse_response(response)
+    def self.parse_response(response)
       return {} if response.body.nil? || response.body.empty?
 
       begin
@@ -82,6 +98,6 @@ module ProxyCheapClient
       end
 
       data
-    end # parse_response
+    end # self.parse_response
   end # class Base
 end # module ProxyCheapClient

data/lib/proxy_cheap_client/models/configuration.rb

@@ -1,15 +1,14 @@
 module ProxyCheapClient
   #module Models
     class Configuration < Base
-      attr_reader :data, :price, :currency, :packages, :available, :conn
+      attr_reader :data, :price, :currency, :packages, :available
 
-      def initialize(attrs = {}, client)
+      def initialize(attrs)
         @data = attrs
         @price = attrs["price"] || attrs["totalPrice"]
         @currency = attrs["currency"] || "USD"
         @packages = attrs["packages"]
         @available = attrs["available"]
-        @conn = client.conn
       end
 
       def to_h

data/lib/proxy_cheap_client/models/order.rb

@@ -6,11 +6,10 @@ module ProxyCheapClient
                   #:status, 
                   #:proxies, 
                   #:created_at, 
-                  :total_price, 
+                  :total_price
                   #:currency,
-                  :conn
 
-      def initialize(attrs = {}, client)
+      def initialize(attrs)
         @data = attrs
         @id = attrs["id"] || attrs["orderId"]
         #@status = attrs["status"]
@@ -18,7 +17,6 @@ module ProxyCheapClient
         #@created_at = attrs["createdAt"] || attrs["created_at"]
         @total_price = attrs["totalPrice"] || attrs["total_price"]
         #@currency = attrs["currency"]
-        @conn = client.conn
       end # initialize
 
       def to_h

data/lib/proxy_cheap_client/models/proxy.rb

@@ -4,9 +4,9 @@ module ProxyCheapClient
       attr_reader :data, :id, :ip, :port, :type, :expires_at, 
                   #:auto_renew, :auto_extend,
                   :country, :isp, :username, :password, :protocol, :bandwidth_limit,
-                  :bandwidth_used, :status, :conn
+                  :bandwidth_used, :status
 
-      def initialize(attrs = {}, client)
+      def initialize(attrs)
         @data = attrs
         @id = attrs["id"]
         @ip = attrs["ip"] || attrs["host"] || (attrs["connection"] && attrs["connection"]['connectIp']) 
@@ -16,14 +16,13 @@ module ProxyCheapClient
         #@auto_renew = attrs["autoRenew"] || attrs["auto_renew"] || attrs["isAutoExtendEnabled"]
         #@auto_extend = attrs["isAutoExtendEnabled"] || attrs["autoExtend"]
         @country = attrs["countryCode"]
-        isp = attrs["metadata"]['ispName']
+        @isp = attrs["metadata"]['ispName']
         @username = attrs["username"] || (attrs["authentication"] && attrs["authentication"]['username'])
         @password = attrs["password"] || (attrs["authentication"] && attrs["authentication"]['password'])
         @protocol = attrs["protocol"] || attrs["proxyProtocol"] || attrs["proxyType"]
         @bandwidth_limit = attrs["bandwidthLimit"] || attrs["bandwidth_limit"] || (attrs["bandwidth"] && attrs["bandwidth"]['total'])
         @bandwidth_used = attrs["bandwidthUsed"] || attrs["bandwidth_used"] || (attrs["bandwidth"] && attrs["bandwidth"]['used'])
         @status = attrs["status"]
-        @conn = client.conn
       end # def initialize
 
       def to_h
@@ -45,36 +44,7 @@ module ProxyCheapClient
           status: status
         }
       end # to_h
-=begin
-      # Change whitelisted IPs for a proxy.
-      # @note The official API uses GET with request body for this operation.
-      # @param proxy_id [Integer] Proxy ID
-      # @param ips [Array<String>] List of IPs to whitelist
-      # @return [Hash] API response
-      def whitelist(proxy_id, ips = [])
-        request(:get, "proxies/#{proxy_id}/whitelist-ip", { ips: ips })
-      end
-
-      # Extend a proxy period.
-      # @note The official API uses GET with request body for this operation.
-      # @param proxy_id [Integer] Proxy ID
-      # @param months [Integer] Number of months to extend (minimum 1)
-      # @return [Hash] API response
-      def extend_period(proxy_id, months)
-        raise ArgumentError, "You must extend for at least 1 month" unless months && months >= 1
-        request(:get, "proxies/#{proxy_id}/extend-period", { periodInMonths: months })
-      end
 
-      # Buy additional bandwidth for a proxy.
-      # @note The official API uses GET with request body for this operation.
-      # @param proxy_id [Integer] Proxy ID
-      # @param bandwidth_gb [Integer] Amount of bandwidth in GB (minimum 1)
-      # @return [Hash] API response
-      def buy_bandwidth(proxy_id, bandwidth_gb)
-        raise ArgumentError, "You must buy at least 1 GB" unless bandwidth_gb && bandwidth_gb >= 1
-        request(:get, "proxies/#{proxy_id}/buy-bandwidth", { bandwidth: bandwidth_gb })
-      end
-=end
       # Get info on a specific proxy.
       # @param proxy_id [Integer] Proxy ID
       # @return [Proxy]
@@ -82,27 +52,7 @@ module ProxyCheapClient
         resp = request(:get, "proxies/#{proxy_id}")
         Proxy.new(resp)
       end # proxy
-=begin
-      def auto_extend?
-        !!@data.dig("autoExtend", "isEnabled")
-      end
-
-      def get_name
-        @data["name"]
-      end
 
-      def set_name(name)
-        response = @conn.patch("proxies/#{@data['id']}") do |req|
-          req.headers['Content-Type'] = 'application/json'
-          req.body = { name: name }.to_json
-        end
-        if response.success?
-          @data["name"] = name
-        else
-          raise "Failed to set proxy name (HTTP #{response.status})"
-        end
-      end
-=end
       # Enable auto-extend for a proxy.
       # @param proxy_id [Integer] Proxy ID
       # @return [Hash] API response

data/lib/proxy_cheap_client/version.rb

@@ -1,3 +1,3 @@
 module ProxyCheapClient
-  VERSION = "1.0.7"
+  VERSION = "1.0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxy-cheap-client
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Leandro Sardi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-12-28 00:00:00.000000000 Z
+date: 2026-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday