sms-pilot-api-v1 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef5f991fb1af59f48bbc7ccab3e1ab3b417c76fc22a584922fa5bca8879e294c
-  data.tar.gz: 83031cf779a24ed4b1d44de6d08f33ef611a0b9fdc63742c14ec792080c54fa5
+  metadata.gz: 398583e8c6b3d5ab1ffa33d2e85a412fd779d3332775980d447e2354cdfaf19e
+  data.tar.gz: dfc1c5f424e7c95e9a0829883b701d66da85134d18dc2267e76f3db7756d357a
 SHA512:
-  metadata.gz: 84a60a7e124256682fd89d4d411c7402feb6597b0541493c2bd08b88b95a515cdf4ae9c0fb435939d7b6f98a56b2d9dd513cd344023bb2f446fbcffc8507eac0
-  data.tar.gz: d0a91bb376ef6090356040cc8eddca2272ce1917e044a7a7cea43f6fe812d265ea1c548eb63e95b5c163a1baed78758bb35a5a0075dea096674bbd4649f0a4ab
+  metadata.gz: d48222754c8acd857fa867385250ce8de32d92c10e624dfef768077f6399eb289258ddb89137d327a243e5d7a59e4527509c7bfb186fed885e6452284030b079
+  data.tar.gz: f5d14f8fc7558024c8fa5a49a3b2e270487de1cd6d2d4e8aa93d45c10e4d948837c8ac4dc13d85e115ae2ce24e956eaefb3ae43d943bfe2732eee93478a55be6

data/.inch.yml

@@ -0,0 +1,11 @@
+files:
+
+  # defaults to ["{app,lib}/**/*.rb"]
+  included:
+    - lib/sms_pilot/client.rb
+
+  # defaults to []
+  excluded:
+    - lib/sms_pilot.rb
+    - lib/sms_pilot/errors.rb
+    - lib/sms_pilot/version.rb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.0.7] - 9 May 2021
+
+- Returns original values from validation methods
+- Offloads parsing response body to a method
+- Improves documentation
+- Adds CodeClimate badges
+- Writes tests for `#initialize` and `#api_key`
+
 ## [0.0.6] - 9 May 2021
 
 - Corrects cost type

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sms-pilot-api-v1 (0.0.5)
+    sms-pilot-api-v1 (0.0.6)
 
 GEM
   remote: https://rubygems.org/
@@ -37,4 +37,4 @@ DEPENDENCIES
   sms-pilot-api-v1!
 
 BUNDLED WITH
-   2.2.11
+   2.2.17

data/README.md

@@ -1,6 +1,9 @@
 # SmsPilot API v1 client
 
 [![Gem Version](https://badge.fury.io/rb/sms-pilot-api-v1.svg)](https://badge.fury.io/rb/sms-pilot-api-v1)
+[![Maintainability](https://api.codeclimate.com/v1/badges/42765c3098d5f531a3f7/maintainability)](https://codeclimate.com/github/sergeypedan/sms-pilot-api-v1/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/42765c3098d5f531a3f7/test_coverage)](https://codeclimate.com/github/sergeypedan/sms-pilot-api-v1/test_coverage)
+[![Inch CI documentation](https://inch-ci.org/github/sergeypedan/sms-pilot-api-v1.svg?branch=master&style=flat)](https://inch-ci.org/github/sergeypedan/sms-pilot-api-v1)
 
 Simple wrapper around SMS pilot API v1. Version 1 because it returns more data within its standard response.
 

data/lib/sms_pilot.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+# Module that for now encompasses only API client
+#
+module SmsPilot
+end
+
 require_relative "sms_pilot/version"
 require_relative "sms_pilot/errors"
 require_relative "sms_pilot/client"

data/lib/sms_pilot/client.rb

@@ -24,7 +24,7 @@ module SmsPilot
   #   @return [nil, String] phone after normalization
   #
   # @!attribute [r] response_body
-  #   Response format is JSON (because we request it that way in {#build_uri}.
+  #   Response format is JSON (because we request it that way in {#build_uri}).
   #   @example
   #     "{\"send\":[{\"server_id\":\"10000\",\"phone\":\"79021234567\",\"price\":\"1.68\",\"status\":\"0\"}],\"balance\":\"20006.97\",\"cost\":\"1.68\"}"
   #   @return [nil, String] Unmodified HTTP resonse body that API returned
@@ -32,26 +32,6 @@ module SmsPilot
   #   @see #response_headers
   #   @see #response_status
   #
-  # @!attribute [r] response_data
-  #   Parsed <tt>@response_body</tt>. May be an empty <tt>Hash</tt> if parsing fails.
-  #   @example
-  #     {
-  #       "balance" => "20006.97",
-  #       "cost" => "1.68",
-  #       "send" => [
-  #         {
-  #           "phone" => "79021234567",
-  #           "price" => "1.68",
-  #           "server_id" => "10000",
-  #           "status" => "0"
-  #         }
-  #       ]
-  #     }
-  #   @return [Hash]
-  #   @see #response_body
-  #   @see #response_headers
-  #   @see #response_status
-  #
   # @!attribute [r] response_headers
   #   @example
   #     {
@@ -94,7 +74,6 @@ module SmsPilot
     attr_reader :locale
     attr_reader :phone
     attr_reader :response_body
-    attr_reader :response_data
     attr_reader :response_headers
     attr_reader :response_status
     attr_reader :url
@@ -122,7 +101,6 @@ module SmsPilot
       @response_status  = nil
       @response_headers = {}
       @response_body    = nil
-      @response_data    = {}
       @url              = nil
     end
 
@@ -159,19 +137,10 @@ module SmsPilot
       @response_status  = response.code.to_i
       @response_headers = response.each_capitalized.to_h
 
-      unless response.is_a?(Net::HTTPSuccess)
-        @error = "HTTP request failed with code #{response.code}"
-        return false
-      end
+      @error = "HTTP request failed with code #{response.code}"   and return false unless response.is_a?(Net::HTTPSuccess)
+      @error = "#{error_description} (error code: #{error_code})" and return false if rejected?
 
-      @response_data = JSON.parse @response_body
-
-      if rejected?
-        @error = "#{error_description} (error code: #{error_code})"
-        return false
-      end
-
-      return true
+      true
 
     rescue JSON::ParserError => error
       @error = "API returned invalid JSON. #{error.message}"
@@ -196,7 +165,7 @@ module SmsPilot
     #   client.balance #=> 20215.25
     #
     def balance
-      @response_data["balance"]&.to_f if sms_sent?
+      response_data["balance"]&.to_f if sms_sent?
     end
 
 
@@ -237,7 +206,36 @@ module SmsPilot
     #
     def rejected?
       return false if sms_sent?
-      @response_data["error"].is_a? Hash
+      response_data["error"].is_a? Hash
+    end
+
+
+    # Parses <tt>@response_body</tt> and memoizes result in <tt>@response_data</tt>
+    #
+    # @example
+    #   {
+    #     "balance" => "20006.97",
+    #     "cost" => "1.68",
+    #     "send" => [
+    #       {
+    #         "phone" => "79021234567",
+    #         "price" => "1.68",
+    #         "server_id" => "10000",
+    #         "status" => "0"
+    #       }
+    #     ]
+    #   }
+    #
+    # @return [Hash]
+    # @raise [JSON::ParserError] which is rescued in {#send_sms}
+    #
+    # @see #response_body
+    # @see #response_headers
+    # @see #response_status
+    #
+    def response_data
+      return {} unless @response_body
+      @response_data ||= JSON.parse @response_body
     end
 
 
@@ -268,7 +266,7 @@ module SmsPilot
     #   client.sms_cost #=> 2.63
     #
     def sms_cost
-      @response_data["cost"]&.to_f if sms_sent?
+      response_data["cost"]&.to_f if sms_sent?
     end
 
 
@@ -283,7 +281,7 @@ module SmsPilot
     #   client.sms_sent? #=> true
     #
     def sms_sent?
-      @response_data["send"] != nil
+      response_data["send"] != nil
     end
 
 
@@ -312,15 +310,20 @@ module SmsPilot
 
 
     # The URI we will send an HTTP request to
-    #
     # @private
-    # @return [URI]
-    # @raise [URI::InvalidURIError] but is very unlikely because we provide the URL ourselves
     #
     # @example
     #   build_uri("79021234567", "Hello, World!")
     #   #=> #<URI::HTTPS https://smspilot.ru/api.php?apikey=XXX…&format=json&send=Hello%2C+World%21&to=79021234567>
     #
+    # @return [URI]
+    # @raise [URI::InvalidURIError] but is very unlikely because we provide the URL ourselves
+    #
+    # @see #api_key
+    # @see #phone
+    # @see #validate_phone!
+    # @see #validate_message!
+    #
     private def build_uri(phone, text)
       URI.parse(API_ENDPOINT).tap do |uri|
         uri.query = URI.encode_www_form({ apikey: @api_key, format: :json, send: text, to: phone })
@@ -331,6 +334,7 @@ module SmsPilot
     # Cleans up your phone from anything but digits. Also replaces 8 to 7 if it is the first digit.
     #
     # @private
+    # @param [String] phone
     # @return [String]
     #
     # @example
@@ -377,9 +381,10 @@ module SmsPilot
 
 
     # Validates message
-    #
     # @private
-    # @return [nil]
+    #
+    # @param [String] message
+    # @return [String] the original value passed into the method, only if it was valid
     #
     # @raise [SmsPilot::InvalidMessageError] if you pass anythig but a String with the <tt>message</tt> argument
     # @raise [SmsPilot::InvalidMessageError] if your message is empty
@@ -387,13 +392,15 @@ module SmsPilot
     private def validate_message!(message)
       fail SmsPilot::InvalidMessageError, "SMS message must be a String, you pass a #{ message.class} (#{ message})" unless message.is_a? String
       fail SmsPilot::InvalidMessageError, "SMS message cannot be empty" if  message == ""
+      message
     end
 
 
     # Validates phone
-    #
     # @private
-    # @return [nil]
+    #
+    # @param [String] phone
+    # @return [String] the original value passed into the method, only if it was valid
     #
     # @raise [SmsPilot::InvalidPhoneError] if you pass anythig but a String with the <tt>phone</tt> argument
     # @raise [SmsPilot::InvalidPhoneError] if your phone is empty
@@ -403,6 +410,7 @@ module SmsPilot
       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?
+      phone
     end
 
     # @!endgroup

data/lib/sms_pilot/version.rb

@@ -3,6 +3,6 @@
 module SmsPilot
 
   # Gem version
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 
 end

data/sms-pilot-api-v1.gemspec

@@ -15,10 +15,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata = {
-    "changelog_uri"     => "#{spec.homepage}/blob/master/CHANGELOG.md",
+        "changelog_uri" => "#{spec.homepage}/blob/master/CHANGELOG.md",
     "documentation_uri" => "https://rubydoc.info/github/sergeypedan/#{spec.name}/master/",
-    "homepage_uri"      =>  spec.homepage,
-    "source_code_uri"   =>  spec.homepage
+         "homepage_uri" =>  spec.homepage,
+      "source_code_uri" =>  spec.homepage
   }
 
   # Specify which files should be added to the gem when it is released.
@@ -27,7 +27,10 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|pkg|doc)/}) }
   end
 
-  spec.bindir        =  "bin"
+  spec.bindir        =  "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  # spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms-pilot-api-v1
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Sergey Pedan
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-05-08 00:00:00.000000000 Z
+date: 2021-05-09 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
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".inch.yml"
 - ".rspec"
 - ".yardopts"
 - CHANGELOG.md