sms_kit 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dda699a256d6ad3fc4bb852f118e9550de117cc1b3c9cef3a1f0162e9bb3bb8
-  data.tar.gz: 34c514ac25b7527f955eff138fa741ecf1d7a9db531da42261c4919645bc7869
+  metadata.gz: b0e876bf680c9b0490171824da6b64d301615ed69764200d0ba62e81d765cec2
+  data.tar.gz: 57ca22cbb144df9fdd21599c751fcaeff567a1229be125b165ec3dbb0c3df9c7
 SHA512:
-  metadata.gz: 6ff9da64ea1931927b400db9127665fcf791cd1f1bdf472fb851420d48f33f1f1ba9a9062e0b5a1d7f7dce8a6de3f99bfe47e85ac668264fe81be58521e835dd
-  data.tar.gz: 42909029a02ecee36d541b4ae09bb283abdab1bd5b241816fe0b80d04075512556c2076719e1344a4d72aab920234088e4b498751158c627dff1c0428ea788ab
+  metadata.gz: b378096ffdb0e52464a8aade1193cfb43e911cf2307b6660291d750de40b3c1c5dd214b3585c7fd1e75a5b84ef1cc4eca7c70b91c8baf46f8039808b0eb82eb7
+  data.tar.gz: 3f9820b7aab4f7a538e4abbc5e6f99758d92172987a19e9d08a8be6bff4e025e4a6f48473b52ac705d22de01f1386321a027a9af1e002ddfce8d29d331ec54e0

data/README.md

@@ -9,7 +9,7 @@ The goal is to offer one streamlined API for any provider adapter.
 
 Add this line to your application's Gemfile:
 
-    gem 'sms_kit', github: 'jamii-Technologies/sms_kit'
+    gem 'sms_kit'
 
 And then execute:
 
@@ -76,6 +76,26 @@ MyProvider.deliver TextMessage.new
 
 ```
 
+### Custom Provider
+
+```rb
+class MyProvider < SmsKit::Provider
+  # default url that the built-in http client will use
+  HTTP_ENDPOINT = 'https://www.example.com'.freeze
+
+  # ...
+
+  # custom connection configuration
+  # the default implementation (`super`) accepts a block
+  # which yields you a faraday instance
+  def connection
+    super do |conn|
+      conn.headers[:user_agent] = 'custom user agent'
+    end
+  end
+end
+```
+
 #### Error handling
 
 SmsKit will throw a `SmsKit::DeliveryError` if something goes wrong.

data/lib/sms_kit.rb

@@ -10,6 +10,4 @@ module SmsKit
   extend Logging
 
   class DeliveryError < StandardError; end
-
-  USER_AGENT = "SmsKit #{VERSION}"
 end

data/lib/sms_kit/http.rb

@@ -1,7 +1,9 @@
+require 'sms_kit/version'
 require 'faraday'
 
 module SmsKit
   module HTTP
+    USER_AGENT = "SmsKit/#{VERSION} (https://rubygems.org/gems/sms_kit)"
 
     def uri
       @uri ||= URI.parse self.class.const_get 'HTTP_ENDPOINT'
@@ -16,7 +18,11 @@ module SmsKit
     end
 
     def connection
-      @conn ||= Faraday.new "#{uri.scheme}://#{uri.host}", ssl: { verify: true } do |f|
+      if 'https' != uri.scheme
+        warn "[SmsKit] Provider '#{self.class.name}' is using an unencrypted connection: #{uri}"
+      end
+
+      @conn ||= Faraday.new "#{uri.scheme}://#{uri.host}" do |f|
         f.headers[:user_agent] = USER_AGENT
         f.response :logger, SmsKit.logger
         f.adapter Faraday.default_adapter

data/lib/sms_kit/providers/central_ict.rb

@@ -3,7 +3,7 @@ require 'sms_kit/provider'
 module SmsKit
   class CentralICT < Provider
 
-    HTTP_ENDPOINT = 'http://api.de.centralict.net/controller/cgi/'
+    HTTP_ENDPOINT = 'https://api.de.centralict.net/controller/cgi/'
 
     def deliver
       response        = get params

data/lib/sms_kit/version.rb

@@ -1,3 +1,3 @@
 module SmsKit
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/test/fixtures/vcr_cassettes/central_ict/failure.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://api.de.centralict.net/controller/cgi/?body&call=message_sender&dst&pin=&src=123456&subject=&type=SMS&uid=
+    uri: https://api.de.centralict.net/controller/cgi/?body&call=message_sender&dst&pin=&src=123456&subject=&type=SMS&uid=
     body:
       encoding: US-ASCII
       string: ''

data/test/fixtures/vcr_cassettes/central_ict/success.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://api.de.centralict.net/controller/cgi/?body=foo+bar&call=message_sender&dst=12345&pin=&src=123456&subject=&type=SMS&uid=
+    uri: https://api.de.centralict.net/controller/cgi/?body=foo+bar&call=message_sender&dst=12345&pin=&src=123456&subject=&type=SMS&uid=
     body:
       encoding: US-ASCII
       string: ''

data/test/fixtures/vcr_cassettes/stub_provider/success.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://api.example.com/
+    uri: https://api.example.com/
     body:
       encoding: UTF-8
       string: '{"to":123456789,"text":"hello world"}'

data/test/helper.rb

@@ -20,6 +20,10 @@ end
 
 require 'sms_kit/provider'
 class ExampleProvider < SmsKit::Provider
+  HTTP_ENDPOINT = 'https://www.example.com'.freeze
+end
+
+class InsecureProvider < SmsKit::Provider
   HTTP_ENDPOINT = 'http://www.example.com'.freeze
 end
 

data/test/http_test.rb

@@ -3,7 +3,7 @@ require 'helper'
 class MockProvider < ExampleProvider
   def connection
     super do |conn|
-      conn.headers[:user_agent] = 'customer user agent'
+      conn.headers[:user_agent] = 'custom user agent'
     end
   end
 end
@@ -11,12 +11,28 @@ end
 class HttpTest < MiniTest::Test
 
   def setup
+    @default = ExampleProvider.new
     @mock = MockProvider.new
+    @insecure = InsecureProvider.new
   end
 
   def test_connection_config
     conn = @mock.connection
-    assert_equal 'customer user agent', conn.headers[:user_agent]
+    assert_equal 'custom user agent', conn.headers[:user_agent]
+  end
+
+  def test_default_user_agent
+    assert_equal \
+      "SmsKit/#{SmsKit::VERSION} (https://rubygems.org/gems/sms_kit)",
+      @default.connection.headers[:user_agent]
+  end
+
+  def test_insecure_warning
+    _, err = capture_io do
+      @insecure.connection
+    end
+    expected = "[SmsKit] Provider 'InsecureProvider' is using an unencrypted connection: http://www.example.com\n"
+    assert_equal expected, err
   end
 
 end

data/test/provider_test.rb

@@ -2,7 +2,7 @@ require 'helper'
 require 'sms_kit/provider'
 
 class StubProvider < SmsKit::Provider
-  HTTP_ENDPOINT = 'http://api.example.com'.freeze
+  HTTP_ENDPOINT = 'https://api.example.com'.freeze
 
   def deliver options = {}
     response = post data.to_json

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sms_kit
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - glaszig
@@ -11,89 +11,103 @@ cert_chain: []
 date: 2020-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.13'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.11.3
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.11.3
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.0'
 description: SmsKit offers a streamlined API for sending text messages through any
   supported provider.
 email: