sendgrid4r 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 568b1050de08f8eca17e627d9a39b1b8e23225a9
+  data.tar.gz: b38ba6b0a6745268940558d8416ac29be5365d00
+SHA512:
+  metadata.gz: 29e018b98d2356945f6a003fbdf768a04886a65cee01402c0ba14e6023d414ca05af0c3acec11ed7947607ac1a3533d764b8999fe14fce0e186e4284e5e70df2
+  data.tar.gz: 9c841443a41546dfa7f77bfd1c3b82f37c93170672467958fe2cfbb0b6c96e62695cad154d38c7423baebc3ae0076680c4243cc3693d20dc3d5958121738e820

data/.env.example

@@ -0,0 +1,2 @@
+SENDGRID_USERNAME=sendgrid username
+SENDGRID_PASSWORD=sendgrid_password

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+#  - "1.9.3"
+#  - "2.0.0"
+  - "2.1.0"
+before_script:
+  - bundle install
+script:
+  - rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 awwa500@gmail.com
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,324 @@
+# Sendgrid4r
+
+This gem allows you to quickly and easily access to SendGrid Web API v3 for Ruby.
+See [api reference](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) for more detail
+
+[![Build Status](https://travis-ci.org/awwa/sendgrid_template_engine_ruby.svg?branch=master)](https://travis-ci.org/awwa/sendgrid_template_engine_ruby.svg?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sendgrid4r'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sendgrid4r
+
+## Usage
+
+### Create a client instance
+
+Create a SendGrid::Client instance for API call.
+
+```Ruby
+require "sendgrid4r"
+client = Sendgrid4r::Client.new("user", "pass")
+```
+
+----
+### Advanced Suppression Manager
+
+#### Groups
+
+##### GET
+Get all groups.
+```Ruby
+groups = client.get_groups
+groups.each{|group|
+  puts group.id                 # => 100
+  puts group.name               # => "Newsletters"
+  puts group.description        # => "Our monthly newsletter."
+  puts group.last_email_sent_at # => "2014-09-04 01:34:43"
+  puts group.unsubscribes       # => 400
+}
+```
+
+##### GET
+Get the suppression group.
+```Ruby
+group = client.get_group(100)
+puts group.id                 # => 100
+puts group.name               # => "Newsletters"
+puts group.description        # => "Our monthly newsletter."
+puts group.last_email_sent_at # => "2014-09-04 01:34:43"
+puts group.unsubscribes       # => 400
+```
+
+##### POST
+Create a suppression group.
+```Ruby
+new_group = client.post_group("group_name", "group_desc")
+```
+
+##### PATCH
+Edit the suppression group.
+```Ruby
+new_group.name = "group_edit"
+new_group.description = "group_desc_edit"
+client.patch_group(new_group.id, new_group)
+```
+
+##### DELETE
+Delete the suppression group.
+```Ruby
+client.delete_group(100)
+```
+
+#### Suppressions
+
+##### POST
+Add recipient emails to the suppressions list for a given group.
+```Ruby
+emails = client.post_suppressed_emails(group.id, ["email1@address.com", "email2@address.com", "email3@address.com"])
+```
+
+##### GET
+Get suppressions associated with a recipient email.
+```Ruby
+suppressions = client.get_suppressions("email@address.com")
+suppressions.each{|suppression|
+  puts suppression.id           # => 1
+  puts suppression.name         # => "Weekly Newsletter"
+  puts suppression.description  # => "The weekly newsletter"
+  puts suppression.suppressed   # => true/false
+}
+```
+
+##### GET
+Retrieve suppressed emails for a group.
+```Ruby
+emails = client.get_suppressed_emails(group.id)
+emails.each{|email|
+  puts email
+}
+```
+
+##### DELETE
+Delete a recipient email from the suppressions list for a given group.
+```Ruby
+client.delete_group(group.id)
+```
+
+#### Global Suppressions
+
+##### POST
+Add recipient emails to the global suppression group.
+```Ruby
+emails = client.post_global_suppressed_emails(["email1@address.com", "email2@address.com", "email3@address.com"])
+```
+
+##### GET
+Check if an address is in the global suppressions group.
+```Ruby
+email1 = client.get_global_suppressed_email("email1@address.com")
+```
+
+##### DELETE
+Delete a recipient email from the global suppressions group.
+```Ruby
+client.delete_global_suppressed_email("email1@address.com")
+```
+
+----
+### IP Management
+
+#### IP Addresses
+
+##### GET
+See a list of all IPs and the IPs warm up status.
+```Ruby
+ips = client.get_ips
+ips.each{|ip|
+  puts ip.ip            # => "xxx.xxx.xxx.xxx"
+  puts ip.warmup        # => true/false
+  puts ip.start_date    # => 1409616000
+}
+```
+
+#### IP Warmup
+
+##### GET
+Get all IPs that are currently warming up.
+```Ruby
+warmup_ips = client.get_warmup_ips
+warmup_ips.each{|warmup_ip|
+  puts warmup_ip.ip         # => "xxx.xxx.xxx.xxx"
+  puts warmup_ip.start_date # => 1409616000
+}
+```
+
+##### GET
+Get warmup status for a particular IP.
+```Ruby
+warmup_ip = client.get_warmup_ip("xxx.xxx.xxx.xxx")
+puts warmup_ip.ip         # => "xxx.xxx.xxx.xxx"
+puts warmup_ip.start_date # => 1409616000
+```
+
+##### POST
+Add an IP to warmup.
+```Ruby
+client.post_warmup_ip("xxx.xxx.xxx.xxx")
+```
+
+##### DELETE
+Remove an IP from warmup.
+```Ruby
+client.delete_warmup_ip("xxx.xxx.xxx.xxx")
+```
+
+----
+### Settings
+
+#### Enforced TLS
+
+##### GET
+Get the current Enforced TLS settings.
+```Ruby
+enforced_tls = client.get_enforced_tls
+puts enforced_tls.require_tls         # => true/false
+puts enforced_tls.require_valid_cert  # => true/false
+```
+
+##### PATCH
+Change the Enforced TLS settings.
+```Ruby
+enforced_tls = client.get_enforced_tls
+enforced_tls.require_tls = true
+enforced_tls.require_valid_cert = true
+client.patch_enforced_tls(enforced_tls)
+```
+
+----
+### Template Engine
+
+#### Templates
+
+##### GET
+Retrieve all templates.
+```Ruby
+templates = client.get_templates
+templates.each {|template|
+  puts template.id
+  puts template.name
+  template.versions.each {|ver|
+    puts ver.id
+    puts ver.template_id
+    puts ver.active
+    puts ver.name
+    puts ver.updated_at
+  }
+}
+```
+
+##### GET
+Retrieve a single template
+```Ruby
+template = client.get_template(template_id)
+puts template.id
+puts template.name
+template.versions.each {|ver|
+  puts ver.id
+  puts ver.template_id
+  puts ver.active
+  puts ver.name
+  puts ver.updated_at
+}
+```
+
+##### POST
+Create a template
+```Ruby
+client.post_template("new_template_name")
+```
+
+##### PATCH
+Edit a template.
+```Ruby
+client.patch_template(template_id, "edit_template_name")
+```
+
+##### DELETE
+Delete a template.
+```Ruby
+client.delete_template(template_id)
+```
+
+#### Versions
+
+##### GET
+Retrieve a specific version of template.
+```Ruby
+ver = client.get_version(template_id, version_id)
+puts ver.id
+puts ver.template_id
+puts ver.active
+puts ver.name
+puts ver.html_content
+puts ver.plain_content
+puts ver.subject
+puts ver.update_at
+```
+
+##### POST
+Create a new version
+```Ruby
+factory = SendGrid4r::VersionFactory.new
+ver1 = factory.create("version1_name")
+ver1 = client.post_version(template_id, ver1)
+puts ver1.name          # => "version1_name"
+puts ver1.subject       # => "<%subject%>"
+puts ver1.html_content  # => "<%body%>"
+puts ver1.plain_content # => "<%body%>"
+puts ver1.active        # => 1
+
+ver2 = factory.create("version2_name", "<%subject%> ver2", "<%body%> ver2", "<%body%> ver2", 1)
+ver2 = client.post_version(template_id, ver2)
+```
+
+##### POST
+Activate a version.
+```Ruby
+client.activate_version(template_id, version_id)
+```
+
+##### PATCH
+Edit a version.
+```Ruby
+edit_ver = client.get_version(template_id, version_id)
+edit_ver.name = "edit_version"
+edit_ver.subject = "edit<%subject%>edit"
+edit_ver.html_content = "edit<%body%>edit"
+edit_ver.plain_content = "edit<%body%>edit"
+edit_ver.active = 0
+client.patch_version(template_id, version_id, edit_ver)
+```
+
+##### DELETE
+Delete a version.
+```Ruby
+client.delete_version(template_id, version_id)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sendgrid4r/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/auth.rb

@@ -0,0 +1,18 @@
+module SendGrid4r
+  class Auth
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+
+    def get_username
+      @username
+    end
+
+    def get_password
+      @password
+    end
+
+  end
+end

data/lib/client.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.dirname(__FILE__)
+
+require "auth"
+require "sendgrid4r/rest/api"
+require "sendgrid4r/factory/version_factory"
+
+module SendGrid4r
+
+  class Client
+
+    include SendGrid4r::REST::API
+
+    BASE_URL = "https://api.sendgrid.com/v3"
+
+    def initialize(username, password)
+      @auth = Auth.new(username, password)
+    end
+
+  end
+
+end

data/lib/sendgrid4r/factory/version_factory.rb

@@ -0,0 +1,15 @@
+module SendGrid4r
+  class VersionFactory
+
+    def create(name, subject = "<%subject%>", html_content = "<%body%>", plain_content = "<%body%>", active = 1)
+      ver = SendGrid4r::REST::Templates::Version.new()
+      ver.name = name
+      ver.subject = subject
+      ver.html_content = html_content
+      ver.plain_content = plain_content
+      ver.active = active
+      ver
+    end
+
+  end
+end

data/lib/sendgrid4r/rest/api.rb

@@ -0,0 +1,23 @@
+require "sendgrid4r/rest/templates"
+require "sendgrid4r/rest/versions"
+require "sendgrid4r/rest/groups"
+require "sendgrid4r/rest/suppressions"
+require "sendgrid4r/rest/global_suppressions"
+require "sendgrid4r/rest/enforced_tls"
+require "sendgrid4r/rest/ip_addresses"
+require "sendgrid4r/rest/warmup"
+
+module SendGrid4r
+  module REST
+    module API
+      include SendGrid4r::REST::Templates
+      include SendGrid4r::REST::Templates::Versions
+      include SendGrid4r::REST::Asm::Groups
+      include SendGrid4r::REST::Asm::Suppressions
+      include SendGrid4r::REST::Asm::GlobalSuppressions
+      include SendGrid4r::REST::Settings::EnforcedTls
+      include SendGrid4r::REST::Ips::IpAddresses
+      include SendGrid4r::REST::Ips::Warmup
+    end
+  end
+end

data/lib/sendgrid4r/rest/enforced_tls.rb

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.dirname(__FILE__)
+
+require "sendgrid4r/rest/request"
+
+module SendGrid4r
+  module REST
+    module Settings
+      module EnforcedTls
+
+        include SendGrid4r::REST::Request
+
+        def get_enforced_tls
+          response = get(@auth, "#{SendGrid4r::Client::BASE_URL}/user/settings/enforced_tls")
+          EnforcedTls.create(response)
+        end
+
+        def patch_enforced_tls(params)
+          response = patch(@auth, "#{SendGrid4r::Client::BASE_URL}/user/settings/enforced_tls", params.to_hash)
+          EnforcedTls.create(response)
+        end
+
+        class EnforcedTls
+
+          attr_accessor :require_tls, :require_valid_cert
+
+          def self.create(value)
+            obj = EnforcedTls.new
+            obj.require_tls = value["require_tls"]
+            obj.require_valid_cert = value["require_valid_cert"]
+            obj
+          end
+
+          def to_hash
+            hash = Hash.new
+            hash["require_tls"]         = @require_tls        if @require_tls != nil
+            hash["require_valid_cert"]  = @require_valid_cert if @require_valid_cert != nil
+            hash
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/sendgrid4r/rest/global_suppressions.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.dirname(__FILE__)
+
+require "sendgrid4r/rest/request"
+
+module SendGrid4r
+  module REST
+    module Asm
+      module GlobalSuppressions
+
+        include SendGrid4r::REST::Request
+
+        def post_global_suppressed_emails(recipient_emails)
+          params = Hash.new
+          params["recipient_emails"] = recipient_emails
+          response = post(@auth, "#{SendGrid4r::Client::BASE_URL}/asm/suppressions/global", params.to_hash)
+          recipient_emails = response["recipient_emails"]
+          recipient_emails
+        end
+
+        def get_global_suppressed_email(email_address)
+          response = get(@auth, "#{SendGrid4r::Client::BASE_URL}/asm/suppressions/global/#{email_address}")
+          email_address = response["recipient_email"]
+          email_address
+        end
+
+        def delete_global_suppressed_email(email_address)
+          delete(@auth, "#{SendGrid4r::Client::BASE_URL}/asm/suppressions/global/#{email_address}")
+        end
+
+      end
+    end
+
+  end
+end

data/lib/sendgrid4r/rest/groups.rb

@@ -0,0 +1,69 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.dirname(__FILE__)
+
+require "sendgrid4r/rest/request"
+
+module SendGrid4r
+  module REST
+    module Asm
+      module Groups
+
+        include SendGrid4r::REST::Request
+
+        def get_groups
+          response = get(@auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups")
+          groups = Array.new
+          response.each{|grp|
+            group = Group.create(grp)
+            groups.push(group)
+          } if response.length != 0
+          groups
+        end
+
+        def get_group(group_id)
+          Group.create(get(@auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups/#{group_id}"))
+        end
+
+        def post_group(name, description)
+          params = Hash.new
+          params["name"] = name
+          params["description"] = description
+          Group.create(post(@auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups", params))
+        end
+
+        def patch_group(group_id, group)
+          Group.create(patch(@auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups/#{group_id}", group.to_hash))
+        end
+
+        def delete_group(group_id)
+          delete(@auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups/#{group_id}")
+        end
+
+        class Group
+
+          attr_accessor :id, :name, :description, :last_email_sent_at, :unsubscribes
+
+          def self.create(value)
+            obj = Group.new
+            obj.id = value["id"]
+            obj.name = value["name"]
+            obj.description = value["description"]
+            obj.last_email_sent_at = value["last_email_sent_at"]
+            obj.unsubscribes = value["unsubscribes"]
+            obj
+          end
+
+          def to_hash
+            hash = {
+              "name" => @name,
+              "description" => @description,
+            }
+            hash
+          end
+
+        end
+      end
+    end
+
+  end
+end

data/lib/sendgrid4r/rest/ip_addresses.rb

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.dirname(__FILE__)
+
+require "sendgrid4r/rest/request"
+
+module SendGrid4r
+  module REST
+    module Ips
+      module IpAddresses
+
+        include SendGrid4r::REST::Request
+
+        def get_ips
+          response = get(@auth, "#{SendGrid4r::Client::BASE_URL}/ips")
+          ips = Array.new
+          response.each{|ip|
+            ip_address = IpAddress.create(ip)
+            ips.push(ip_address)
+          } if response.length > 0
+          ips
+        end
+
+        class IpAddress
+
+          attr_accessor :ip, :pools, :warmup, :start_date
+
+          def self.create(value)
+            obj = IpAddress.new
+            obj.ip = value["ip"]
+            obj.pools = []
+            # TODO Implements if ip pools GA
+            # value["pools"].each{|pool|
+            #   ver = Pool.create(pool)
+            #   obj.pools.push(ver)
+            # }
+            obj.warmup = value["warmup"]
+            obj.start_date = value["start_date"]
+            obj
+          end
+
+        end
+      end
+    end
+
+  end
+end