While writing this Sendgrid Newsletter API client in ruby I noticed several flaws in their API conception. Something like, returning 401 Status code when resources cannot be found are pretty gross but anyway this client should be mostly complete (still work in progress, scheduling etc.).
gem install newslettre
this is definitely going to change since it's tedious to pass the client
instance around. Maybe there will be a top-level wrapper to give you
access to all the modules the API defines (Identity, Newsletter,
Recipients)
Right now it works like this…
require 'newslettre'
client = Newslettre::Client.new "somebody@yourdomain.com", "reallygoodpassword"
# Accessing newsletters
client.newsletters.to_a # => [{ "name" => "webdev" }]
client.newsletters.get("webdev") # => { "name", "subject" => "Latest Web Development News", "html" => "<html>...</html>" }
client.newsletters.delete "webdev"
# Accessing recipients of a newsletter
client.newsletters.get("webdev").recipients.to_a # => [{ "list" => "web-developers" }]
client.newsletters.get("webdev").recipients.delete "web-developers"
nearly the same goes for Identity, Lists, Lists::Email and Letter::Recipients
You can also use #lists and #identities as well as the nested emails in recipient lists.
client.lists.get("web-developers").emails.delete "selective@hosted.com", "programmatic@failure.com"
Last but not least, to schedule an already existing newsletter:
client.newsletters.get("webdev").schedule! :at => Time.now
# to see when a newsletter will be delivered
client.newsletters.get("webdev").schedule # => Mon Sep 26 14:01:13 +0200 2011
# and to deschedule again
client.newsletters.get("webdev").deschedule!
though it is still far from complete, if you'd like to help out please submit pull request with passing specs (or scenarios)
you will need to add a config/newslettre.yml containing something like
this:
sendgrid:
username: "somebody@yourdomain.com"
password: "reallysecurepassword"
identity:
email: "info@yourdomain.com"
name: "Lennart Melzer"
address: "Where you live 15"
city: "Downtown"
state: "C"
zip: "12345"
country: "EF"
letter:
name: "test"
identity: "test-identity"
subject: "A letter to the world!"
html: "<html><body><h1>A rendered Headline</h1></body></html>"
text: "An unrendered Headline"
emails:
-
email: somebody@yourdomain.com
name: Some Body
-
email: someone@else.com
name: Someone Else
to make the specs pass
FAQs
Unknown package
We found that newslettre demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.