RubyGems - newslettre - Versions diffs - 0.0.1 - Mend

newslettre 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/.gitignore +5 -0
data/.rspec +3 -0
data/Gemfile +4 -0
data/README.md +84 -0
data/Rakefile +13 -0
data/features/cassettes/cucumber_tags/sendgrid_adding_recipients.yml +185 -0
data/features/cassettes/cucumber_tags/sendgrid_removing_recipients.yml +208 -0
data/features/recipients.feature +20 -0
data/features/step_definitions/recipients_steps.rb +63 -0
data/features/support/env.rb +25 -0
data/lib/newslettre.rb +9 -0
data/lib/newslettre/api_module.rb +17 -0
data/lib/newslettre/client.rb +49 -0
data/lib/newslettre/identity.rb +21 -0
data/lib/newslettre/letter.rb +48 -0
data/lib/newslettre/lists.rb +49 -0
data/lib/newslettre/version.rb +3 -0
data/newslettre.gemspec +29 -0
data/spec/cassettes/Newslettre/Newslettre_Identity.yml +24 -0
data/spec/cassettes/Newslettre/Newslettre_Identity/with_a_new_identity.yml +72 -0
data/spec/cassettes/Newslettre/Newslettre_Letter.yml +24 -0
data/spec/cassettes/Newslettre/Newslettre_Letter/with_a_new_letter.yml +118 -0
data/spec/cassettes/Newslettre/Newslettre_Lists.yml +24 -0
data/spec/cassettes/Newslettre/Newslettre_Lists/with_a_new_list.yml +70 -0
data/spec/cassettes/Newslettre/Newslettre_Lists_Email.yml +117 -0
data/spec/cassettes/Newslettre/http_actions.yml +24 -0
data/spec/cassettes/upon_raising_errors.yml +25 -0
data/spec/newslettre_spec.rb +174 -0
data/spec/spec_helper.rb +17 -0
metadata +158 -0

data/.gitignore ADDED

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+config/newslettre.yml

data/.rspec ADDED

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require ./spec/spec_helper

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+# Specify your gem's dependencies in newslettre.gemspec
+gemspec

data/README.md ADDED

@@ -0,0 +1,84 @@
+# Newslettre
+While writing this [Sendgrid Newsletter API](http://docs.sendgrid.com/documentation/api/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.).
+## Installation
+``` ruby
+    gem install newslettre
+```
+## Usage
+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…
+``` ruby
+  require 'newslettre'
+  client = Newslettre::Client.new :email => "somebody@yourdomain.com",
+  :password => "reallygoodpassword"
+  letters = Newslettre::Letter.new client
+  letters.list # => [{ "name" => "webdev" }]
+  letters.get "webdev" # => { "name", "subject" => "Latest Web Development News", "html" =>  "<html>...</html>" }
+  letters.delete "webdev"
+```
+nearly the same goes for `Identity`, `Lists`, `Lists::Email` and `Letter::Recipients`
+## Development
+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:
+``` yaml
+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

data/Rakefile ADDED

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts  = "features --format pretty"
+end
+task :default => :spec

data/features/cassettes/cucumber_tags/sendgrid_adding_recipients.yml ADDED

@@ -0,0 +1,185 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/delete.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&name=Superior%20Soy%20Beans%20Discount!
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:13 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/lists/delete.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&list=Junk-food%20addicts
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:13 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/identity/delete.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&identity=Bourne
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:14 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/identity/add.json?address=Oranienstra%C3%9Fe%206&api_key=<<PASSWORD>>&api_user=<<USERNAME>>&city=Berlin&country=DE&email=<<USERNAME>>&identity=Bourne&name=Mathias%20Fiedler&state=B&zip=10997
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:15 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/add.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&html=%3Ch1%3Emeow%3C/h1%3E&identity=Bourne&name=Superior%20Soy%20Beans%20Discount!&subject=Superior%20Soy%20Beans%20Discount!&text=Super%20Cool!
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:16 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/lists/add.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&list=Junk-food%20addicts
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:17 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/recipients/add.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&list=Junk-food%20addicts&name=Superior%20Soy%20Beans%20Discount!
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:18 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/recipients/get.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&name=Superior%20Soy%20Beans%20Discount!
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:19 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '[{"list": "Junk-food addicts"}]'
+    http_version: '1.1'

data/features/cassettes/cucumber_tags/sendgrid_removing_recipients.yml ADDED

@@ -0,0 +1,208 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/delete.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&name=Superior%20Soy%20Beans%20Discount!
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:20 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/lists/delete.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&list=Junk-food%20addicts
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:21 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/identity/delete.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&identity=Bourne
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:21 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/identity/add.json?address=Oranienstra%C3%9Fe%206&api_key=<<PASSWORD>>&api_user=<<USERNAME>>&city=Berlin&country=DE&email=<<USERNAME>>&identity=Bourne&name=Mathias%20Fiedler&state=B&zip=10997
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:22 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/add.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&html=%3Ch1%3Emeow%3C/h1%3E&identity=Bourne&name=Superior%20Soy%20Beans%20Discount!&subject=Superior%20Soy%20Beans%20Discount!&text=Super%20Cool!
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:23 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/lists/add.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&list=Junk-food%20addicts
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:24 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/recipients/add.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&list=Junk-food%20addicts&name=Superior%20Soy%20Beans%20Discount!
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:25 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/recipients/delete.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&list=Junk-food%20addicts&name=Superior%20Soy%20Beans%20Discount!
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:26 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/recipients/get.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&name=Superior%20Soy%20Beans%20Discount!
+    body: !!null
+    headers: !!null
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:59:26 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '[]'
+    http_version: '1.1'