sms-pilot-api-v1 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1438f40054c6f5347c861fddb4530b2f86f7321ef4998eba159c18e70db520c
-  data.tar.gz: fccbb5e7fb2c505e5a8bd80cc9e1410db5673b71aa2ac6ffac0bf41a89610797
+  metadata.gz: 2f18c87d0d06449a2d1990eefe98e92a66e2e543e6d37cadb8a59597fb165232
+  data.tar.gz: 27b96c2afab4411c63474d807692336d32e95196d1172114f5ffaf9ddbb6d650
 SHA512:
-  metadata.gz: 86070669bff561d19b18242c595acc0bfc22ea6607bead4456e74391671e143ee6f1e269b1d4cd989d751d3ffda4c68fd85144d331a7e0499a64d7c114e344be
-  data.tar.gz: '028935012e1fd06b533aa264d8d46f0eb87ee245fc08fe5bad688c89ceb2db77610ae75caea32a3193145d0d442f4f2d32f31e1b218a6951ef78e49c6b40e558'
+  metadata.gz: 5f59608daac142c675c71485c2ab63fa0a1291ebecc887f939a3a272d586a806f8cea5068174064ba9ff193172f0975836512136ac3a75f7b843f3afb1ab113e
+  data.tar.gz: 9aeae9908fd518c5156b472f27c618f57c48d1370e09a2ffa8ab40430c083a908bc684fc15e3a1e76397f1d47b66c4c43c7c87da0fa89651a7006e5210317ddd

data/CHANGELOG.md

@@ -1,11 +1,11 @@
 # Changelog
 
-## [0.0.4] - 2021-05-09
+## [0.0.4] - 9 May 2021
 
 - Drop dependence on HTTP.rb gem
 - Corrects what `#send_sms` returns (could return String errors instead of Booleans)
 - Adds extensive [documentation](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot/Client) via YARD & RubyDoc
 
-## [0.0.3] - 2021-05-06
+## [0.0.3] - 6 May 2021
 
 - Initial release

data/README.md

@@ -33,6 +33,7 @@ bin/console
 require "sms_pilot"
 
 client = SmsPilot::Client.new(api_key: "XXXXXXXXXXXXYYYYYYYYYYYYZZZZZZZZXXXXXXXXXXXXYYYYYYYYYYYYZZZZZZZZ")
+client = SmsPilot::Client.new(api_key: "XXXXXXXXXXXXYYYYYYYYYYYYZZZZZZZZXXXXXXXXXXXXYYYYYYYYYYYYZZZZZZZZ", locale: :en) # Available locales are [:en, :ru]
 #<SmsPilot::Client:0x00007fb1c602d490 @api_key="XXXXX...", @error=nil, @response_status=nil, @response_headers=nil, @response_body=nil, @response_data={}, @url=nil>
 ```
 

data/lib/sms_pilot.rb

@@ -3,4 +3,3 @@
 require_relative "sms_pilot/version"
 require_relative "sms_pilot/errors"
 require_relative "sms_pilot/client"
-

data/lib/sms_pilot/client.rb

@@ -7,7 +7,7 @@ require "uri"
 module SmsPilot
 
   # @!attribute [r] api_key
-  #   @return [String] Your API key.
+  #   @return [String] Your API key
   #
   # @!attribute [r] error
   #   Error message returned from the API, combined with the error code
@@ -17,6 +17,12 @@ module SmsPilot
   #   @see #error_code
   #   @see #error_description
   #
+  # @!attribute [r] locale
+  #   @return [Symbol] Chosen locale (affects only the language of errors)
+  #
+  # @!attribute [r] phone
+  #   @return [nil, String] phone after normalization
+  #
   # @!attribute [r] response_body
   #   Response format is JSON (because we request it that way in {#build_uri}.
   #   @example
@@ -81,9 +87,11 @@ module SmsPilot
     # Check current API endpoint URL at {https://smspilot.ru/apikey.php#api1}
     #
     API_ENDPOINT = "https://smspilot.ru/api.php".freeze
+    AVAILABLE_LOCALES = [:ru, :en].freeze
 
     attr_reader :api_key
     attr_reader :error
+    attr_reader :locale
     attr_reader :phone
     attr_reader :response_body
     attr_reader :response_data
@@ -102,12 +110,10 @@ module SmsPilot
     # @example
     #   client = SmsPilot::Client.new(api_key: ENV["SMS_PILOT_API_KEY"])
     #
-    def initialize(api_key:)
-      fail SmsPilot::InvalidAPIkeyError, "API key must be a String, you pass a #{api_key.class} (#{api_key})" unless api_key.is_a? String
-      fail SmsPilot::InvalidAPIkeyError, "API key cannot be empty" if api_key == ""
-
-      @api_key          = api_key
+    def initialize(api_key:, locale: AVAILABLE_LOCALES[0])
+      @api_key          = validate_api_key!(api_key)
       @error            = nil
+      @locale           = validate_locale!(locale)
       @response_status  = nil
       @response_headers = {}
       @response_body    = nil
@@ -213,7 +219,8 @@ module SmsPilot
     # @see https://smspilot.ru/apikey.php#err Error codes at the API documentation website
     #
     def error_description
-      @response_data.dig("error", "description_ru") if rejected?
+      method_name = (@locale == :ru) ? "description_ru" : "description"
+      @response_data.dig("error", method_name) if rejected?
     end
 
 
@@ -330,24 +337,42 @@ module SmsPilot
     end
 
 
-    # Validates phone
+    # @!group Validations
 
+    # Validates api_key
+    #
     # @private
-    # @return [nil]
+    # @return [String] the original value passed into the method, only if it was valid
+    # @param [String] api_key
+
+    # @raise [SmsPilot::InvalidError] if api_key is not a String
+    # @raise [SmsPilot::InvalidError] if api_key is an empty String
     #
-    # @raise [SmsPilot::InvalidPhoneError] if you pass anythig but a String with the <tt>phone</tt> argument
-    # @raise [SmsPilot::InvalidPhoneError] if your phone is empty
-    # @raise [SmsPilot::InvalidPhoneError] if your phone has no digits
+    private def validate_api_key!(api_key)
+      fail SmsPilot::InvalidAPIkeyError, "API key must be a String, you pass a #{api_key.class} (#{api_key})" unless api_key.is_a? String
+      fail SmsPilot::InvalidAPIkeyError, "API key cannot be empty" if api_key == ""
+      return api_key
+    end
+
+
+    # Validates locale
     #
-    private def validate_phone!(phone)
-      fail SmsPilot::InvalidPhoneError, "phone must be a String, you pass a #{phone.class} (#{phone})" unless phone.is_a? String
-      fail SmsPilot::InvalidPhoneError, "phone cannot be empty" if phone == ""
-      fail SmsPilot::InvalidPhoneError, "phone must contain digits" if phone.scan(/\d/).none?
+    # @private
+    # @return [Symbol] the original value passed into the method, only if it was valid
+    # @param [Symbol] locale
+
+    # @raise [SmsPilot::InvalidError] if locale is not a Symbol
+    # @raise [SmsPilot::InvalidError] if locale is unrecognized
+    #
+    private def validate_locale!(locale)
+      fail SmsPilot::InvalidLocaleError, "locale must be a Symbol" unless locale.is_a? Symbol
+      fail SmsPilot::InvalidLocaleError, "API does not support locale :#{locale}; choose one of #{AVAILABLE_LOCALES.inspect}" unless AVAILABLE_LOCALES.include? locale
+      return locale
     end
 
 
     # Validates message
-
+    #
     # @private
     # @return [nil]
     #
@@ -359,5 +384,23 @@ module SmsPilot
       fail SmsPilot::InvalidMessageError, "SMS message cannot be empty" if  message == ""
     end
 
+
+    # Validates phone
+    #
+    # @private
+    # @return [nil]
+    #
+    # @raise [SmsPilot::InvalidPhoneError] if you pass anythig but a String with the <tt>phone</tt> argument
+    # @raise [SmsPilot::InvalidPhoneError] if your phone is empty
+    # @raise [SmsPilot::InvalidPhoneError] if your phone has no digits
+    #
+    private def validate_phone!(phone)
+      fail SmsPilot::InvalidPhoneError, "phone must be a String, you pass a #{phone.class} (#{phone})" unless phone.is_a? String
+      fail SmsPilot::InvalidPhoneError, "phone cannot be empty" if phone == ""
+      fail SmsPilot::InvalidPhoneError, "phone must contain digits" if phone.scan(/\d/).none?
+    end
+
+    # @!endgroup
+
   end
 end

data/lib/sms_pilot/errors.rb

@@ -5,5 +5,6 @@ module SmsPilot
   class InvalidAPIkeyError  < ArgumentError; end
   class InvalidMessageError < ArgumentError; end
   class InvalidPhoneError   < ArgumentError; end
+  class InvalidLocaleError  < ArgumentError; end
 
 end

data/lib/sms_pilot/version.rb

@@ -3,6 +3,6 @@
 module SmsPilot
 
   # Gem version
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sms-pilot-api-v1
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Sergey Pedan