sendgrid4r 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f0dc04ae5fecf0e518c08377aa8e12b3073eaa9
-  data.tar.gz: 522e99261f8f6f33632f5fe92864f2118631b8af
+  metadata.gz: fb22cf3a6851051dc9aff2ccd01bb58f44f05d6b
+  data.tar.gz: 78395e30015b6182fdf8bdc61bf773d1a0b2c0f3
 SHA512:
-  metadata.gz: 28a8693931daa73ec378ee71da02bedb7b125db5fa6d200822de0e4b3a889ea913f02264fd2024ea4088e10297df90ad24765e735176997efcb53d2d74a23f05
-  data.tar.gz: ed1ca6766cb1af59c82b020d79513fa24b8a460012e313d02bf0a077c1a6c582943cc416836e54e89c81575209776085b646f66ebd5431dbc0e44547ac37c945
+  metadata.gz: 4e38ab32b44f3bf59f2c5feb724af2ad0b3d1c128e99f8f490a41a4fecd2d2b44e42c2dd690c65654c2e68d706b465ed6e2fc57c028fbb893f8ecffb1ed1f45e
+  data.tar.gz: d34d0ed4873dc08367e41c88101095b967b10c292807f39132fc994ab415e3a5551c843ba8ba5b4ee6aaeaebfb404865fee394bd3d22c5999da3bf3a06182fe1

data/.rubocop.yml

@@ -0,0 +1,21 @@
+# メソッド名のprefixに「set_」「get_」を許可
+AccessorMethodName:
+  Enabled: false
+
+# メソッドの行数上限を変更
+MethodLength:
+  CountComments: true  # count full line comments?
+  Max: 20
+
+# 引数上限を変更
+ParameterLists:
+  Max: 6
+  CountKeywordArgs: true
+
+# AbcSizeの上限を変更
+AbcSize:
+  Max: 20
+
+# %r 内で利用できるスラッシュの数の制限変更
+RegexpLiteral:
+  MaxSlashes: 0

data/.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
 rvm:
-#  - "1.9.3"
-#  - "2.0.0"
-  - "2.1.0"
+  - "2.1"
 before_script:
   - bundle install
 script:
+  - rubocop --fail-level=W
   - rspec

data/README.md

@@ -3,381 +3,11 @@
 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)
+[![Build Status](https://travis-ci.org/awwa/sendgrid4r.svg?branch=master)](https://travis-ci.org/awwa/sendgrid4r)
 
-## Installation
+# [Documentation](https://github.com/awwa/sendgrid4r/wiki)
 
-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
-Retrieve all suppression groups associated with your account.
-```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 information on a single 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 new suppression group.
-```Ruby
-new_group = client.post_group("group_name", "group_desc")
-```
-
-##### PATCH
-Update a suppression group.
-```Ruby
-new_group.name = "group_edit"
-new_group.description = "group_desc_edit"
-client.patch_group(new_group.id, new_group)
-```
-
-##### DELETE
-Delete a 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(100)
-emails.each{|email|
-  puts email
-}
-```
-
-##### DELETE
-Delete a recipient email from the suppressions list for a given group.
-```Ruby
-client.delete_suppressed_email(100, "email1@address.com")
-```
-
-#### 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, including warm up status and pools.
-```Ruby
-ips = client.get_ips
-ips.each{|ip|
-  puts ip.ip            # => "xxx.xxx.xxx.xxx"
-  puts ip.pools         # => ["new_test5"]
-  puts ip.warmup        # => true/false
-  puts ip.start_date    # => 1409616000
-}
-```
-
-##### GET
-See which pools an IP address belongs to.
-```Ruby
-ip = client.get_ip("xxx.xxx.xxx.xxx")
-puts ip.ip            # => "xxx.xxx.xxx.xxx"
-puts ip.pools         # => ["new_test5"]
-puts ip.warmup        # => true/false
-```
-
-##### POST
-Add an IP to a pool.
-```Ruby
-ip = client.post_ip_to_pool("pool_name", "xxx.xxx.xxx.xxx")
-puts ip.ip            # => "xxx.xxx.xxx.xxx"
-puts ip.pool_name     # => "new_test5"
-```
-
-##### DELETE
-Remove an IP address from a pool.
-```Ruby
-client.delete_ip_from_pool("pool_name", "xxx.xxx.xxx.xxx")
-```
-
-#### IP Pools
-
-##### GET
-List all IP pools.
-```Ruby
-pools = client.get_pools
-puts pools.inspect    # => ["marketing","transactional"]
-```
-
-##### POST
-Create an IP pool.
-```Ruby
-pool = client.post_pool("name")
-puts pool.name        # => "name"
-```
-
-##### GET
-List the IPs in a specified pool.
-```Ruby
-pool = client.get_pool("name")
-puts pool.name        # => "name"
-puts pool.ips.inspect # => ["167.89.21.3"]
-```
-
-##### PUT
-Update an IP pool’s name
-```Ruby
-client.put_pool("name", "new_name")
-puts pool.name        # => "name"
-puts pool.ips.inspect # => ["167.89.21.3"]
-```
-
-##### DELETE
-Delete an IP pool.
-```Ruby
-client.delete_pool("name")
-```
-
-#### 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
+# Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/sendgrid4r/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/lib/auth.rb

@@ -1,18 +1,16 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
 module SendGrid4r
+  #
+  # SendGrid Web API v3 data container for authentication
+  #
   class Auth
+    attr_reader :username, :password
 
     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

@@ -1,22 +1,21 @@
 # -*- encoding: utf-8 -*-
-$:.unshift File.dirname(__FILE__)
+$LOAD_PATH.unshift File.dirname(__FILE__)
 
-require "auth"
-require "sendgrid4r/rest/api"
-require "sendgrid4r/factory/version_factory"
+require 'auth'
+require 'sendgrid4r/rest/api'
+require 'sendgrid4r/factory/version_factory'
 
 module SendGrid4r
-
+  #
+  # SendGrid Web API v3 Client implementation
+  #
   class Client
-
     include SendGrid4r::REST::API
 
-    BASE_URL = "https://api.sendgrid.com/v3"
+    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

@@ -1,15 +1,25 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
 module SendGrid4r
+  #
+  # SendGrid Web API v3 Factory Class implementation
+  #
   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
+    def create(
+      name:, subject: '<%subject%>',
+      html_content: '<%body%>', plain_content: '<%body%>', active: 1)
+      SendGrid4r::REST::Templates::Version.new(
+        nil,
+        nil,
+        nil,
+        active,
+        name,
+        html_content,
+        plain_content,
+        subject,
+        nil
+      )
     end
-
   end
 end

data/lib/sendgrid4r/rest/api.rb

@@ -1,15 +1,28 @@
-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/addresses"
-require "sendgrid4r/rest/pools"
-require "sendgrid4r/rest/warmup"
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/templates/templates'
+require 'sendgrid4r/rest/templates/versions'
+require 'sendgrid4r/rest/asm/groups'
+require 'sendgrid4r/rest/asm/suppressions'
+require 'sendgrid4r/rest/asm/global_suppressions'
+require 'sendgrid4r/rest/settings/enforced_tls'
+require 'sendgrid4r/rest/ips/addresses'
+require 'sendgrid4r/rest/ips/pools'
+require 'sendgrid4r/rest/ips/warmup'
+require 'sendgrid4r/rest/categories/categories'
+require 'sendgrid4r/rest/stats/stats'
+require 'sendgrid4r/rest/stats/global'
+require 'sendgrid4r/rest/stats/category'
+require 'sendgrid4r/rest/stats/subuser'
+require 'sendgrid4r/rest/stats/advanced'
+require 'sendgrid4r/rest/stats/parse'
 
 module SendGrid4r
   module REST
+    #
+    # SendGrid Web API v3
+    #
     module API
       include SendGrid4r::REST::Templates
       include SendGrid4r::REST::Templates::Versions
@@ -20,6 +33,12 @@ module SendGrid4r
       include SendGrid4r::REST::Ips::Addresses
       include SendGrid4r::REST::Ips::Warmup
       include SendGrid4r::REST::Ips::Pools
+      include SendGrid4r::REST::Categories::Categories
+      include SendGrid4r::REST::Stats::Global
+      include SendGrid4r::REST::Stats::Category
+      include SendGrid4r::REST::Stats::Subuser
+      include SendGrid4r::REST::Stats::Advanced
+      include SendGrid4r::REST::Stats::Parse
     end
   end
 end

data/lib/sendgrid4r/rest/asm/global_suppressions.rb

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Asm
+      #
+      # SendGrid Web API v3 Advanced Suppression Manager - Global Suppressions
+      #
+      module GlobalSuppressions
+        include SendGrid4r::REST::Request
+
+        def self.url(email_address = nil)
+          url = "#{SendGrid4r::Client::BASE_URL}/asm/suppressions/global"
+          url = "#{url}/#{email_address}" unless email_address.nil?
+          url
+        end
+
+        def post_global_suppressed_emails(recipient_emails)
+          params = { recipient_emails: recipient_emails }
+          resp = post(
+            @auth,
+            SendGrid4r::REST::Asm::GlobalSuppressions.url,
+            params
+          )
+          resp['recipient_emails']
+        end
+
+        def get_global_suppressed_email(email_address)
+          resp = get(
+            @auth,
+            SendGrid4r::REST::Asm::GlobalSuppressions.url(email_address)
+          )
+          resp['recipient_email']
+        end
+
+        def delete_global_suppressed_email(email_address)
+          delete(
+            @auth, SendGrid4r::REST::Asm::GlobalSuppressions.url(email_address))
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/asm/groups.rb

@@ -0,0 +1,69 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Asm
+      #
+      # SendGrid Web API v3 Advanced Suppression Manager - Groups
+      #
+      module Groups
+        include SendGrid4r::REST::Request
+
+        Group = Struct.new(
+          :id, :name, :description, :last_email_sent_at, :unsubscribes)
+
+        def self.create_group(resp)
+          Group.new(
+            resp['id'],
+            resp['name'],
+            resp['description'],
+            resp['last_email_sent_at'],
+            resp['unsubscribes']
+          )
+        end
+
+        def post_group(name, description)
+          params = { name: name, description: description }
+          resp = post(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups", params
+          )
+          SendGrid4r::REST::Asm::Groups.create_group(resp)
+        end
+
+        def get_groups
+          resp_a = get(@auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups")
+          groups = []
+          resp_a.each do |resp|
+            groups.push(SendGrid4r::REST::Asm::Groups.create_group(resp))
+          end
+          groups
+        end
+
+        def get_group(group_id)
+          resp = get(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups/#{group_id}"
+          )
+          SendGrid4r::REST::Asm::Groups.create_group(resp)
+        end
+
+        def patch_group(group_id, group)
+          resp = patch(
+            @auth,
+            "#{SendGrid4r::Client::BASE_URL}/asm/groups/#{group_id}",
+            group.to_h
+          )
+          SendGrid4r::REST::Asm::Groups.create_group(resp)
+        end
+
+        def delete_group(group_id)
+          delete(
+            @auth, "#{SendGrid4r::Client::BASE_URL}/asm/groups/#{group_id}"
+          )
+        end
+      end
+    end
+  end
+end