mailclerk 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0746f6e459e89ebf5c23c33c940f10f4639d7b92e9bffbb7bb0f0c217608d8e9
-  data.tar.gz: 12c12b1846326a577d6423dd7b20ecf77156c50d4e3ab084327b72224a4b8023
+  metadata.gz: 227b81d20c20b98dc4fd1d582d18aa48c7687354b28a73da03480604859afae2
+  data.tar.gz: '0291df4fb61da622535bd19a1cef6662ae32732397e93e42d06bf08b4ca81c8a'
 SHA512:
-  metadata.gz: 1867bff480e230a049d3ec3f14221ca83ace81ed745cbefd1b3b7ef7ec6d6d561f7b8f9fe37b9d0d83d178f50ed28061bf6f35768f806dd4e9d27997a7f6c289
-  data.tar.gz: 5aa6071e289c6194fe43abfba94ed141200b1c385c42ac897e4c09dd0b0bf722f079f7e69b0d96d767deac7273a47a5475b31d60aac3160575dfb431e0006ffa
+  metadata.gz: 2a518499c62151117b5369f5be66ab8dc475b379780f072516e6061f29b9d2103e867ce53d9ab96ae2b457f4971b12a7e95a1f51feeae8160a37478c9c81c104
+  data.tar.gz: 794a86c97badf077d70e12ab39e6c6cf1a07a24605e27bbda8e4562df29bb75a021f6f1c56da4a1945862a84527ae08f5cd0b0357936381be40b5a703db532be

data/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="mailcerk.png" alt="Mailclerk Logo"/>
+  <img src="https://github.com/mailclerk/mailclerk-ruby/blob/main/mailclerk.png?raw=true" alt="Mailclerk Logo"/>
 </p>
 
 # Mailclerk
@@ -51,15 +51,15 @@ environmental variable: `MAILCLERK_API_KEY`. Alternatively, you can
 set it directly on the Mailclerk module:
 
 ```
-# config/initializers/mailcerk.rb
+# config/initializers/mailclerk.rb
 Mailclerk.api_key = "mc_yourprivatekey"
 ```
 
 _If you are using version control like git, we strongly recommend storing your
 production API keys in environmental variables_.
 
-The default API endpoint is `https://api.mailcerk.app`. To change this, you
-can provide a `MAILCLERK_API_URL` ENV variable or set `Mailclerk.mailcerk_url`.
+The default API endpoint is `https://api.mailclerk.app`. To change this, you
+can provide a `MAILCLERK_API_URL` ENV variable or set `Mailclerk.mailclerk_url`.
 
 ## Usage
 
@@ -99,7 +99,7 @@ Mailclerk.deliver("welcome-email", "bob@example.com")
 
 ## Tests
 
-Tests aren't current implemented. When they are, to test, run:
+Tests aren't currently implemented. When they are, to test, run:
 
 ```
 bundle exec rake

data/lib/mailclerk.rb

@@ -22,7 +22,7 @@ module Mailclerk
     end
 
     def self.version
-      "0.1.1"
+      "1.0.0"
     end
 
     def self.version_label
@@ -33,17 +33,31 @@ module Mailclerk
   class MailclerkError < StandardError
   end
   
+  class MailclerkAPIError < MailclerkError
+    attr_accessor :http_status
+    attr_accessor :http_response
+    
+    def initialize(description, http_status=nil, http_response=nil)
+      super(description)
+      self.http_status = http_status
+      self.http_response = http_response
+    end
+
+  end
+
   class Client
     def initialize(api_key, api_url=nil)
       @api_key = api_key
       @api_url = api_url || ENV['MAILCLERK_API_URL'] || DEFAULT_API_URL
       
       if @api_key.nil?
-        raise MailclerkError.new "No Mailclerk API Key provided. Set `Mailclerk.api_key`"
+        raise MailclerkError.new(
+          "No Mailclerk API Key provided. Set `Mailclerk.api_key`"
+        )
       end
 
       if @api_url.nil? || @api_url.empty?
-        raise MailclerkError.new "Mailclerk API URL empty"
+        raise MailclerkError.new("Mailclerk API URL empty")
       end
     end
     
@@ -51,7 +65,7 @@ module Mailclerk
       conn = Faraday.new(url: @api_url)
       conn.basic_auth(@api_key, '')
       
-      resp = conn.post('deliver', {
+      response = conn.post('deliver', {
         'template' => template,
         'recipient' => recipient,
         'data' => data,
@@ -60,8 +74,23 @@ module Mailclerk
         'Content-Type' => 'application/json',
         'X-Client-Version' => Identity.version_label
       })
+      
+      if response.status >= 400
+        body = response.body
+        begin
+          message = JSON.parse("{ } { }") 
+          description = "Mailclerk API Error: #{ message }"
+        rescue JSON::ParserError
+          description = "Mailclerk API Unknown Error"
+        end
+        
+        raise MailclerkAPIError.new(
+          description, response.status, response
+        )
 
-      return resp
+      end
+      
+      return response
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailclerk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Noah Litvin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday