simplyq 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5567d4d53527951f2a3009d7f97053293935c7cc35e0b58b84bb958dc7c7c7a
-  data.tar.gz: 0a911e6b8b50a80d2c1b72453ca25f03a7ebf31307e9e32f8ed80e25d1243aa1
+  metadata.gz: e296a474be7441e712a63199525f127f6446c2e582ce68ec99ea9e54e40b3ef4
+  data.tar.gz: f94decb3fd372fd2946937c7894a154536c85de340c3b0cd0e50dc1b0f6732b9
 SHA512:
-  metadata.gz: 82cb81ab6da6d446736a3e990184bc3c9b1f85c1d6f6bb06f91bcb517a2c1629a6dc5204635dab7a01340987907261fa7df2c02ae5331162679cfe1d7a5ad9c5
-  data.tar.gz: 982f118097a4cae8a784bf9bd1453fef495f5b670fe3d510d1ca6acc7dafb90a8777d5bc20a0771b203833f839323ec388fb72848ea101e76533d3961f66d37e
+  metadata.gz: d9af3ed40c1ee1307f2046c22bc333a94033be9c58ccb8c5ad8e19b164516cd140c3bf685863e3b73721b6e24b8c4e520ff717bb5f4eb37c91e14aae23deed2f
+  data.tar.gz: b1033a970943c68da1de0e3e43d666283c8f9cb4353f60b75f9d61959b948f7257b34f3454c8e1f4d4d1049b62d52cada8bfd9acb03ca13da65ffbf015b480fe

data/CHANGELOG.md

@@ -4,7 +4,13 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 ## main
 
-## 0.9.0 - 2023-04-204
+## 0.10.0 - 2023-05-05
+
+ENHANCEMENTS:
+
+- Support automatic selection of API endpoint based on api key [PR #52](https://github.com/simplyqio/apis/pull/59)
+
+## 0.9.0 - 2023-04-20
 
 ENHANCEMENTS:
 

data/lib/simplyq/client.rb

@@ -55,11 +55,11 @@ module Simplyq
       "Unexpected error communicating when trying to connect to " \
       "SimplyQ (%s). You may be seeing this message because your DNS is not " \
       "working or you don't have an internet connection.  To check, try " \
-      "running `host api.simplyq.com` from the command line."
+      "running `host us.api.simplyq.io` from the command line."
     ERROR_MESSAGE_SSL =
       "Could not establish a secure connection to SimplyQ (%s), you " \
       "may need to upgrade your OpenSSL version. To check, try running " \
-      "`openssl s_client -connect api.simplyq.com:443` from the command " \
+      "`openssl s_client -connect us.api.simplyq.io:443` from the command " \
       "line."
 
     ERROR_MESSAGE_TIMEOUT_SUFFIX =
@@ -108,12 +108,12 @@ module Simplyq
         config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n" if config.debugging
 
         unless response.success?
-          if response.status.zero?
-            # Errors from libcurl will be made visible here
-            raise ApiError.new(response.reason_phrase, http_status: 0)
-          else
-            raise specific_http_error(response, get_http_error_data(response).merge(params: opts[:query_params]))
-          end
+          raise ApiError.new(response.reason_phrase, http_status: 0) if response.status.zero?
+
+          # Errors from libcurl will be made visible here
+
+          raise specific_http_error(response, get_http_error_data(response).merge(params: opts[:query_params]))
+
         end
       rescue *NETWORK_ERROR_MESSAGES_MAP.keys => e
         handle_network_error(e)
@@ -292,12 +292,12 @@ module Simplyq
     end
 
     def basic_auth(conn)
-      if config.username && config.password
-        if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new("2.0")
-          conn.request(:authorization, :basic, config.username, config.password)
-        else
-          conn.request(:basic_auth, config.username, config.password)
-        end
+      return unless config.username && config.password
+
+      if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new("2.0")
+        conn.request(:authorization, :basic, config.username, config.password)
+      else
+        conn.request(:basic_auth, config.username, config.password)
       end
     end
   end

data/lib/simplyq/configuration.rb

@@ -4,8 +4,13 @@ require "logger"
 
 module Simplyq
   class Configuration
+    REGIONAL_ENDPOINTS = {
+      "us" => "https://us.api.simplyq.io",
+      "eu" => "https://eu.api.simplyq.io"
+    }.freeze
+
     # Defines API keys used with API Key authentications.
-    attr_accessor :api_key
+    attr_reader :api_key
 
     # Defines the api version
     attr_accessor :api_version
@@ -67,13 +72,14 @@ module Simplyq
 
     attr_accessor :timeout
 
-    attr_accessor :base_url
+    attr_writer :base_url
 
     attr_accessor :debugging
 
     attr_reader :open_timeout
     attr_reader :read_timeout
     attr_reader :write_timeout
+    attr_reader :region
 
     def self.setup
       new.tap do |instance|
@@ -89,7 +95,6 @@ module Simplyq
 
       @client_side_validation = true
 
-      @base_url = "https://api.simplyq.io"
       @middlewares = Hash.new { |h, k| h[k] = [] }
       @logger = defined?(Rails) ? Rails.logger : Logger.new($stdout)
 
@@ -101,6 +106,12 @@ module Simplyq
       Configuration.new
     end
 
+    def api_key=(api_key)
+      @api_key = api_key
+
+      @region = "us" unless REGIONAL_ENDPOINTS.keys.include?(@region = api_key.split("_").first)
+    end
+
     # Gets Basic Auth token string
     def basic_auth_token
       "Basic #{["#{username}:#{password}"].pack("m").delete("\r\n")}"
@@ -110,22 +121,10 @@ module Simplyq
       "Bearer #{@api_key}"
     end
 
-    # TODO: Remove
-    # def base_path=(base_path)
-    #   # Add leading and trailing slashes to base_path
-    #   @base_path = "/#{base_path}".gsub(%r{/+}, "/")
-    #   @base_path = "" if @base_path == "/"
-    # end
-
-    # TODO: Remove
-    # Returns base URL for specified operation based on server settings
-    # def base_url(operation = nil)
-    #   index = server_operation_index.fetch(operation, server_index)
-    #   return "#{scheme}://#{[host, base_path].join("/").gsub(%r{/+}, "/")}".sub(%r{/+\z}, "") if index.nil?
-
-    #   server_url(index, server_operation_variables.fetch(operation, server_variables),
-    #              operation_server_settings[operation])
-    # end
+    # Returns base URL for specified operation based on api key
+    def base_url
+      @base_url || REGIONAL_ENDPOINTS[region]
+    end
 
     # Adds middleware to the stack
     def use(*middleware)
@@ -155,8 +154,8 @@ module Simplyq
     # @see https://github.com/lostisland/faraday/blob/v2.3.0/lib/faraday/rack_builder.rb#L92-L143
     def set_faraday_middleware(operation, key, *args, &block)
       unless %i[request response use insert insert_before insert_after swap delete].include?(operation)
-        raise ArgumentError, "Invalid faraday middleware operation #{operation}. Must be" \
-                             " :request, :response, :use, :insert, :insert_before, :insert_after, :swap or :delete."
+        raise ArgumentError, "Invalid faraday middleware operation #{operation}. Must be " \
+                             ":request, :response, :use, :insert, :insert_before, :insert_after, :swap or :delete."
       end
 
       @middlewares[operation] << [key, args, block]
@@ -175,10 +174,10 @@ module Simplyq
         end
       end
 
-      if @middlewares.key?(:delete)
-        @middlewares[:delete].each do |key, _args, _block|
-          connection.builder.delete(key)
-        end
+      return unless @middlewares.key?(:delete)
+
+      @middlewares[:delete].each do |key, _args, _block|
+        connection.builder.delete(key)
       end
     end
   end

data/lib/simplyq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Simplyq
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplyq
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - simplyq-dxtimer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday