sms-pilot-api-v1 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cdf5eab949b7c36ae220eec407cd1afce5e9fb5df2b7c09c8b7e05327bc67f5
-  data.tar.gz: a001b60a5975b0ed50aa69b4f2b66e3d974e001cacf6af949a60617a234d6fe6
+  metadata.gz: e18ed848bce6fc14c2011704a417ebcd18b26a2364d6eded6f70c4bf8e0fd37a
+  data.tar.gz: 8c0fc16b26a26194ebd2543aa231f0b41b74181141de85f4530114c2045c55ac
 SHA512:
-  metadata.gz: 7d8a78e4d68cf605f974feb7c3068245609f1fc2a2765d479c0badf013c6b43fb3b9e3480c97039befc09a9f12208c0ef3d098395c79d86a948ba040f6176763
-  data.tar.gz: 02da8904baac9232c9d4c4e6587f4dc1814a20aec9c2558ba8240db2ef8b324af72553278fd818577a32bccfa63dea6bf98c48272047ae67533cdcd687e2de1c
+  metadata.gz: 64fad357cc93e5b0901db4c15a6965881e205fbb45ef3637d196d280ef11e089595e8e402ad81030883f51472c33716f239381343a05b58d01a334879b46678a
+  data.tar.gz: 172f139edc7163d805edd08a891cbeb1e1789832693b706fe99f5fc76b41f4b40fdc6aada62977b1c84df7d69a0539dad76df465aee66371ca3d144a39ca7444

data/CHANGELOG.md

@@ -1,41 +1,78 @@
 # Changelog
 
-## [0.0.9] - 10 May 2021
+## [0.0.10] - 2021-05-11
+
+### Added
+
+- Accepts sender name in [`#initialize`](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot%2FClient:initialize)
+- Tests for `send_sms`
+
+## [0.0.9] - 2021-05-10
+
+### Added
 
 - Passes `charset` attribute to the API in [`#build_uri`](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot%2FClient:build_uri)
 - Passes `lang` attribute to the API in [`#build_uri`](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot%2FClient:build_uri)
+
+### Changed
+
 - Stores constant request params in constants
+
+### Deprecated
+
 - Deprecates [`#sms_status`](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot%2FClient:sms_status) in favor of [`#broadcast_status`](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot%2FClient:broadcast_status)
 
-## [0.0.8] - 10 May 2021
+## [0.0.8] - 2021-05-10
+
+### Added
 
-- Adds [`#broadcast_id`](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot%2FClient:broadcast_id) method
-- Adds [roadmap section](https://github.com/sergeypedan/sms-pilot-api-v1#roadmap) in the Readme
+- [`#broadcast_id`](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot%2FClient:broadcast_id) method
+- [roadmap section](https://github.com/sergeypedan/sms-pilot-api-v1#roadmap) in the Readme
 
-## [0.0.7] - 9 May 2021
+## [0.0.7] - 2021-05-09
+
+### Changed
 
 - Returns original values from validation methods
 - Offloads parsing response body to a method
 - Improves documentation
+
+### Added
+
 - Adds CodeClimate badges
 - Writes tests for [`#initialize`](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot%2FClient:initialize)
 - Writes tests for [`#api_key`](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot%2FClient:api_key)
 
-## [0.0.6] - 9 May 2021
+## [0.0.6] - 2021-05-09
+
+### Fixed
 
 - Corrects cost type
+
+### Changed
+
 - Switches to PRY in console
 
-## [0.0.5] - 9 May 2021
+## [0.0.5] - 2021-05-09
+
+### Added
 
 - Adds locale support (RU / EN)
 
-## [0.0.4] - 9 May 2021
+## [0.0.4] - 2021-05-09
+
+### Fixed
 
-- Drop dependence on HTTP.rb gem
 - Corrects what [`#send_sms`](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot%2FClient:send_sms) returns (could return String errors instead of Booleans)
+
+### Changed
+
+- Drop dependence on HTTP.rb gem
+
+### Added
+
 - Adds extensive [documentation](https://rubydoc.info/github/sergeypedan/sms-pilot-api-v1/master/SmsPilot/Client) via YARD & RubyDoc
 
-## [0.0.3] - 6 May 2021
+## [0.0.3] - 2021-05-06
 
 - Initial release

data/Gemfile

@@ -6,5 +6,9 @@ source "https://rubygems.org"
 gemspec
 
 gem "pry"
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
+gem "rake"
+
+group :test do
+  gem "rspec"
+  gem "webmock"
+end

data/Gemfile.lock

@@ -6,13 +6,20 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.3)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
+    hashdiff (1.0.1)
     method_source (1.0.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (4.0.6)
     rake (13.0.3)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -26,15 +33,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   x86_64-darwin-17
 
 DEPENDENCIES
   pry
-  rake (~> 13.0)
-  rspec (~> 3.0)
+  rake
+  rspec
   sms-pilot-api-v1!
+  webmock
 
 BUNDLED WITH
    2.2.17

data/README.md

@@ -76,6 +76,7 @@ See [structured documentation](https://rubydoc.info/github/sergeypedan/sms-pilot
 
 ```ruby
 client.send_sms("+7 (902) 123-45-67", "Привет, мир!")
+client.send_sms("+7 (902) 123-45-67", "Привет, мир!", "ФССПРФ")
 # => true
 ```
 

data/lib/sms_pilot/client.rb

@@ -131,13 +131,15 @@ module SmsPilot
     #
     # @example
     #   client.send_sms("+7 (902) 123-45-67", "Привет, мир!") # => true
+    #   client.send_sms("+7 (902) 123-45-67", "Привет, мир!", "ФССПРФ") # => true
     #
-    def send_sms(phone, message)
+    def send_sms(phone, message, sender_name = nil)
       validate_phone! phone
       validate_message! message
+      validate_sender_name! sender_name
 
       @phone = normalize_phone(phone)
-      @uri   = build_uri(@phone, message)
+      @uri   = build_uri(@phone, message, sender_name)
 
       response = persist_response_details Net::HTTP.get_response(@uri)
 
@@ -358,21 +360,29 @@ module SmsPilot
     # @return [URI]
     # @raise [URI::InvalidURIError] but is almost impossible, because we provide the URL ourselves
     #
+    # @param [String] phone
+    # @param [String] text
+    # @param [nil, String] sender_name
+    #
     # @see #api_key
     # @see #phone
     # @see #validate_phone!
     # @see #validate_message!
-    #
-    private def build_uri(phone, text)
+    # @see #validate_sender_name!
+    #
+    private def build_uri(phone, text, sender_name)
+      attributes = {
+        apikey:  @api_key,
+        charset: REQUEST_CHARSET,
+        format:  REQUEST_ACCEPT_FORMAT,
+        lang:    @locale,
+        send:    text,
+        to:      phone
+      }
+      attributes = attributes.merge({ sender: sender_name }) if sender_name
+
       URI.parse(API_ENDPOINT).tap do |uri|
-        uri.query = URI.encode_www_form({
-          apikey:  @api_key,
-          charset: REQUEST_CHARSET,
-          format:  REQUEST_ACCEPT_FORMAT,
-          lang:    @locale,
-          send:    text,
-          to:      phone
-        })
+        uri.query = URI.encode_www_form(attributes)
       end
     end
 
@@ -476,6 +486,21 @@ module SmsPilot
       phone
     end
 
+
+    # Validates sender name
+    # @private
+    #
+    # @param [nil, String] sender_name
+    # @return [String] the original value passed into the method, only if it was valid
+    #
+    # @raise [SmsPilot::InvalidSenderNameError] if you pass anything but <tt>nil</tt> or non-empty <tt>String</tt>
+    #
+    private def validate_sender_name!(sender_name)
+      fail SmsPilot::InvalidSenderNameError, "sender name must be either nil or String" unless [NilClass, String].include? sender_name.class
+      fail SmsPilot::InvalidSenderNameError, "sender name cannot be empty" if sender_name == ""
+      sender_name
+    end
+
     # @!endgroup
 
   end

data/lib/sms_pilot/errors.rb

@@ -2,9 +2,10 @@
 
 module SmsPilot
 
-  class InvalidAPIkeyError  < ArgumentError; end
-  class InvalidMessageError < ArgumentError; end
-  class InvalidPhoneError   < ArgumentError; end
-  class InvalidLocaleError  < ArgumentError; end
+  class InvalidAPIkeyError     < ArgumentError; end
+  class InvalidLocaleError     < ArgumentError; end
+  class InvalidMessageError    < ArgumentError; end
+  class InvalidPhoneError      < ArgumentError; end
+  class InvalidSenderNameError < ArgumentError; end
 
 end

data/lib/sms_pilot/version.rb

@@ -3,6 +3,6 @@
 module SmsPilot
 
   # Gem version
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms-pilot-api-v1
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Sergey Pedan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies: []
 description: Simple wrapper around SMS pilot API v1. Version 1 because it returns
   more data within its standard response