ternwire 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10179adca67dec7ba097d6b2595055038f15fa27f65cf87ac5c37df34b3b13fe
-  data.tar.gz: e7b1c6feff097229fa8dfc5b3735ef82531fa75cb64a169930cbbfb23dadb258
+  metadata.gz: 338741ca97eeaac7b12ef8283c7c5b75c267249484fbd439df699c7aed430233
+  data.tar.gz: 1f7fab3b820bf570c8998682ebedb01b454b57ecfd670a336d686fa030ea08e6
 SHA512:
-  metadata.gz: 478a9cb9bea050a2ecf89ee3009863c3ce36a7dcc2cf1b58a4ed72429bf7619c98d56f1e8174c22441cacaf7cac1cb9c02abe23ea6dfc1c63cb8fb3464c5810f
-  data.tar.gz: d3ed0c692a0df8003c172982bbe8f5fc7734296dddc2b15a97864999dbc4f418160552424863def77c07d00cc3db3607aee60dce83fa6f959f4745ba96d76bf3
+  metadata.gz: c545aa3654bcc0f7d0cc00fd8a99952f159ceec33e48d4b9364a33d7b594645741bbbe852cf6468b48e7d2c73b76a5b0b441a9a0ae89bf1dd48f6a3ebcea4836
+  data.tar.gz: d7745a25d65d85fab3e4ab9660ebd8688a580fc459dfe155b89dadcdfc69b96ea16ea395cc14e0626b48981a2c03ed55317cd0793a02b07c85f99b49ac202dff

data/README.md

@@ -8,11 +8,7 @@ Add `gem "ternwire"` to your Gemfile, or run `gem install ternwire`.
 ```ruby
 require "ternwire"
 
-client = Ternwire::Client.new(
-  api_key: ENV.fetch("TERNWIRE_API_KEY"),
-  base_url: ENV.fetch("TERNWIRE_API_ORIGIN"),
-  timeout: 30
-)
+client = Ternwire::Client.new(api_key: ENV.fetch("TERNWIRE_API_KEY"))
 message = client.submit_email({
   "from" => "notifications@your-verified-domain.com",
   "to" => ["recipient@example.com"],
@@ -22,6 +18,12 @@ message = client.submit_email({
 puts client.get_message(message.fetch("id"))
 ```
 
+The client sends requests to `Ternwire::DEFAULT_BASE_URL`, `https://ternwire.com`.
+Pass `base_url:` only to reach another origin, such as a local or staging server, as
+in `Ternwire::Client.new(api_key: key, base_url: "http://localhost:3001")`. Plain HTTP
+is accepted only for localhost and loopback addresses. The optional `timeout:`
+keyword sets the per-request timeout in seconds and defaults to 30.
+
 All 17 operations use snake_case names and accept or return hashes with camelCase
 JSON keys. Template deletion returns `nil`. The client is synchronous.
 `list_email_templates(cursor: nil, limit: nil)` returns one page of summaries;
@@ -35,9 +37,10 @@ Use `Ternwire::Webhooks.verify(signature_header, raw_body, signing_secret)` befo
 parsing the request. The optional `tolerance_seconds:` keyword defaults to 300.
 Use the exact body string without re-encoding or normalizing it.
 
-Set `TERNWIRE_API_KEY`, `TERNWIRE_API_ORIGIN`, `TERNWIRE_FROM`, and `TERNWIRE_TO`
-before deliberately running `ruby -Ilib examples/send.rb` from this directory.
+Set `TERNWIRE_API_KEY`, `TERNWIRE_FROM`, and `TERNWIRE_TO` before deliberately
+running `ruby -Ilib examples/send.rb` from this directory. Set `TERNWIRE_API_ORIGIN`
+as well only to send to another origin, such as `http://localhost:3001`.
 
-Use `https://ternwire.com` as the API origin. Read the full documentation at
-[ternwire.com/docs](https://ternwire.com/docs), or contact support@ternwire.com.
+Read the full documentation at [ternwire.com/docs](https://ternwire.com/docs), or
+contact support@ternwire.com.
 Released under the MIT License.

data/examples/send.rb

@@ -2,7 +2,7 @@ require "ternwire"
 
 client = Ternwire::Client.new(
   api_key: ENV.fetch("TERNWIRE_API_KEY"),
-  base_url: ENV.fetch("TERNWIRE_API_ORIGIN")
+  base_url: ENV["TERNWIRE_API_ORIGIN"]
 )
 accepted = client.submit_email({
   "from" => ENV.fetch("TERNWIRE_FROM"),

data/lib/ternwire/client.rb

@@ -4,6 +4,8 @@ require "net/http"
 require "uri"
 
 module Ternwire
+  DEFAULT_BASE_URL = "https://ternwire.com"
+
   class APIError < StandardError
     attr_reader :status, :raw_body, :body, :headers
 
@@ -19,10 +21,11 @@ module Ternwire
   end
 
   class Client
-    def initialize(api_key:, base_url:, timeout: 30)
+    def initialize(api_key:, base_url: nil, timeout: 30)
       unless /\Aem_(live|test)_[A-Za-z0-9_-]+\z/.match?(api_key)
         raise ArgumentError, "Use an em_live_ or em_test_ API key"
       end
+      base_url = DEFAULT_BASE_URL if base_url.nil?
       origin = URI.parse(base_url)
       unless %w[http https].include?(origin.scheme) && origin.host && !origin.userinfo &&
           ["", "/"].include?(origin.path) && !origin.query && !origin.fragment

data/lib/ternwire/version.rb

@@ -1,3 +1,3 @@
 module Ternwire
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ternwire
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ternwire