enveloop 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1af89bdd26c1380d6f05ebf9b9ab9e86c29617eeb689760c88dd81f7009397cd
-  data.tar.gz: 51c5c8a2ffc6e557e469b14a5dac3b1b04628c484525189598a893c55de7630f
+  metadata.gz: 0c04cdee8d0a0fc537a9270f9bbb29417eae1bb2c70edd2b6a9d9b985c50f91c
+  data.tar.gz: 730ad713a4258f0f418ed383006073f9a98e861258abd198b7c60ef5d15f5530
 SHA512:
-  metadata.gz: 3048366a973c5115ac2e9c5dafae487441c62d4f43d6106dc9886f3dbca336d41870195f25d15bdb5f4fc3811bd47ad49d2fa40face26866921f01e6b0b830ca
-  data.tar.gz: de31f9fb4c68cab0c0773e4e1a192a1fc9ff64904254f4e5468c35addbd1f94d419f44792448bd1781831e385f17ad1c9832e6bc5ed5216b26f85c95964498a9
+  metadata.gz: 80fe49dc8664b0317b9a7f6f81b603abcedbe38f89b3f8c444bc0cd73536ba06cc9740a02aa23b3e5b70c74af6dc3dc910c0d7a156f1f75841048f41eef90d24
+  data.tar.gz: db4ead56d96c4567ab983c99c34a65a7d659aff8b71ed8889631669e9a83e6372385fc93c43987dbb99345da415f608d0f20f3574c5705e2442a7ed4ac2d27e6

data/CHANGELOG.md

@@ -7,4 +7,12 @@
 
 > ## Version 0.1.1
 
-* Add Response class
+* Add Response class
+
+> ## Version 0.1.2
+
+* add `template_info` to fetch the template body and see waht variables are defined on a template
+
+> ## Version 0.1.3
+
+* change `user_variables` to `template_variables` in API call

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enveloop (0.1.1)
+    enveloop (0.1.3)
       faraday
 
 GEM

data/README.md

@@ -20,22 +20,34 @@ Or install it yourself as:
 
 ## Usage
 
+Setup the client connection:
+
 ```ruby
 require 'enveloop'
 
 enveloop = Enveloop::Client.new(api_key: ENV['ENVELOOP_API_TOKEN'])
+```
 
+Send a message: 
+
+```ruby
 enveloop.send_message(
   template: 'welcome-email',
   to: 'user@email.com',
   from: 'welcome@myapp.com',
   subject: 'Welcome to MyApp',
-  user_variables: {
+  template_variables: {
     first_name: 'John',
   }
 )
 ```
 
+Get information about a template (variables and body html):
+
+```ruby
+enveloop.template_info(template: 'welcome-email')
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -44,7 +56,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/enveloop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/enveloop/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/enveloophq/enveloop-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/enveloophq/enveloop-ruby/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -53,4 +65,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Enveloop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/enveloop/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Enveloop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/enveloophq/enveloop-ruby/blob/master/CODE_OF_CONDUCT.md).

data/lib/enveloop/client.rb

@@ -5,12 +5,12 @@ module Enveloop
       @api_key = api_key
     end
 
-    def send_message(template:, to:, from:, subject:, user_variables: {})
+    def send_message(template:, to:, from:, subject:, template_variables: {})
       data = {
         to: to,
         from: from,
         subject: subject,
-        userVariables: user_variables
+        templateVariables: template_variables
       }
 
       conn = Faraday.new(
@@ -25,7 +25,21 @@ module Enveloop
         req.body = data.to_json
       end
 
-      return Response.new(status: response.status, body: response.body)
+      return MessageResponse.new(status: response.status, body: response.body)
+    end
+
+    def template_info(template:)
+      conn = Faraday.new(
+        url: @endpoint,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "token #{@api_key}"
+        }
+      )
+
+      response = conn.get("/templates/#{template}")
+
+      return TemplateResponse.new(status: response.status, body: response.body)
     end
   end
 end

data/lib/enveloop/{response.rb → message_response.rb}

@@ -1,5 +1,5 @@
 module Enveloop
-  class Response
+  class MessageResponse
     attr_reader :status, :message, :error
 
     def initialize(status: 200, body: nil)
@@ -7,12 +7,9 @@ module Enveloop
 
       if status == 200
         @message = JSON.parse(body)
-        @error = nil
       elsif status == 500
-        @message = nil
         @error = JSON.parse(body)['error']
       else
-        @message = nil
         @error = 'Unknown error'
       end
     end

data/lib/enveloop/template_response.rb

@@ -0,0 +1,21 @@
+module Enveloop
+  class TemplateResponse
+    attr_reader :status, :template, :error
+
+    def initialize(status: 200, body: nil)
+      @status = status
+
+      if status == 200
+        @template = JSON.parse(body)
+      elsif status == 500
+        @error = JSON.parse(body)['error']
+      else
+        @error = 'Unknown error'
+      end
+    end
+
+    def success?
+      @status == 200
+    end
+  end
+end

data/lib/enveloop/version.rb

@@ -1,3 +1,3 @@
 module Enveloop
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/enveloop.rb

@@ -3,7 +3,8 @@ require "json"
 
 require "enveloop/version"
 require 'enveloop/client'
-require 'enveloop/response'
+require 'enveloop/message_response'
+require 'enveloop/template_response'
 
 module Enveloop
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enveloop
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Ben Wyrosdick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -45,7 +45,8 @@ files:
 - enveloop.gemspec
 - lib/enveloop.rb
 - lib/enveloop/client.rb
-- lib/enveloop/response.rb
+- lib/enveloop/message_response.rb
+- lib/enveloop/template_response.rb
 - lib/enveloop/version.rb
 homepage: https://github.com/enveloophq/ruby_enveloop
 licenses: