sendgrid4r 0.5.0 → 1.0.0

data/spec/rest/whitelabel/ips_spec.rb

@@ -0,0 +1,231 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SendGrid4r::REST::Whitelabel::Ips do
+  describe 'integration test', :it do
+    before do
+      begin
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
+        @subdomain_name = ENV['SUBDOMAIN_IP']
+        @domain_name = ENV['DOMAIN']
+        @username = ENV['USERNAME']
+        @ip = ENV['IP']
+
+        # celan up test env(lists)
+        ips = @client.get_wl_ips
+        ips.each do |ip|
+          @client.delete_wl_ip(
+            id: ip.id
+          ) if ip.subdomain == @subdomain_name && ip.domain == @domain_name
+        end
+
+        @ipw = @client.post_wl_ip(
+          ip: @ip, subdomain: @subdomain_name, domain: @domain_name
+        )
+
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+        raise e
+      end
+    end
+
+    context 'without block call' do
+      it '#get_wl_ips' do
+        begin
+          ips = @client.get_wl_ips
+          expect(ips).to be_a(Array)
+          ips.each do |ip|
+            expect(ip).to be_a(SendGrid4r::REST::Whitelabel::Ips::Ip)
+          end
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#post_wl_ip' do
+        begin
+          expect(@ipw).to be_a(SendGrid4r::REST::Whitelabel::Ips::Ip)
+          expect(@ipw.id).to be_a(Numeric)
+          expect(@ipw.ip).to eq(@ip)
+          expect(@ipw.rdns).to be_a(String)
+          expect(@ipw.users).to be_a(Array)
+          expect(@ipw.subdomain).to eq(@subdomain_name)
+          expect(@ipw.domain).to eq(@domain_name)
+          expect(@ipw.valid).to eq(false)
+          expect(@ipw.legacy).to eq(false)
+          expect(@ipw.a_record).to be_a(
+            SendGrid4r::REST::Whitelabel::Ips::ARecord
+          )
+          expect(@ipw.a_record.valid).to eq(false)
+          expect(@ipw.a_record.type).to eq('a')
+          expect(@ipw.a_record.host).to be_a(String)
+          expect(@ipw.a_record.data).to eq(@ip)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#get_wl_ip' do
+        begin
+          ip = @client.get_wl_ip(id: @ipw.id)
+          expect(ip).to be_a(SendGrid4r::REST::Whitelabel::Ips::Ip)
+          expect(ip.ip).to eq(@ip)
+          expect(ip.users).to be_a(Array)
+          expect(ip.subdomain).to eq(@subdomain_name)
+          expect(ip.domain).to eq(@domain_name)
+          expect(ip.valid).to eq(false)
+          expect(ip.legacy).to eq(false)
+          expect(ip.a_record).to be_a(
+            SendGrid4r::REST::Whitelabel::Ips::ARecord
+          )
+          expect(ip.a_record.valid).to eq(false)
+          expect(ip.a_record.type).to eq('a')
+          expect(ip.a_record.host).to be_a(String)
+          expect(ip.a_record.data).to eq(@ip)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#delete_wl_ip' do
+        begin
+          @client.delete_wl_ip(id: @ipw.id)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#validate_wl_ip' do
+        begin
+          result = @client.validate_wl_ip(id: @ipw.id)
+          expect(result).to be_a(
+            SendGrid4r::REST::Whitelabel::Ips::Result
+          )
+          expect(result.valid).to be(false)
+          expect(result.validation_results.a_record.valid).to be(false)
+          expect(result.validation_results.a_record.reason).to be_a(String)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+    end
+  end
+
+  describe 'unit test', :ut do
+    let(:client) do
+      SendGrid4r::Client.new(api_key: '')
+    end
+
+    let(:ips) do
+      JSON.parse('[]')
+    end
+
+    let(:ip) do
+      JSON.parse(
+        '{'\
+          '"id": 123,'\
+          '"ip": "192.168.1.2",'\
+          '"rdns": "o1.email.example.com",'\
+          '"users": ['\
+          '],'\
+          '"subdomain": "email",'\
+          '"domain": "example.com",'\
+          '"valid": true,'\
+          '"legacy": false,'\
+          '"a_record": {'\
+            '"valid": true,'\
+            '"type": "a",'\
+            '"host": "o1.email.example.com",'\
+            '"data": "192.168.1.2"'\
+          '}'\
+        '}'
+      )
+    end
+
+    let(:result) do
+      JSON.parse(
+        '{'\
+          '"id": 1,'\
+          '"valid": true,'\
+          '"validation_results": {'\
+            '"a_record": {'\
+              '"valid": true,'\
+              '"reason": null'\
+            '}'\
+          '}'\
+        '}'
+      )
+    end
+
+    it '#get_wl_ips' do
+      allow(client).to receive(:execute).and_return(ips)
+      actual = client.get_wl_ips
+      expect(actual).to be_a(Array)
+    end
+
+    it '#post_wl_ip' do
+      allow(client).to receive(:execute).and_return(ip)
+      actual = client.post_wl_ip(ip: '', subdomain: '', domain: '')
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Ips::Ip)
+    end
+
+    it '#get_wl_ip' do
+      allow(client).to receive(:execute).and_return(ip)
+      actual = client.get_wl_ip(id: '')
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Ips::Ip)
+    end
+
+    it '#delete_wl_ip' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.delete_wl_ip(id: '')
+      expect(actual).to eq('')
+    end
+
+    it '#validate_wl_ip' do
+      allow(client).to receive(:execute).and_return(result)
+      actual = client.validate_wl_ip(id: '')
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Ips::Result)
+    end
+
+    it 'creates ip instance' do
+      actual = SendGrid4r::REST::Whitelabel::Ips.create_ip(ip)
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Ips::Ip)
+      expect(actual.id).to eq(123)
+      expect(actual.ip).to eq('192.168.1.2')
+      expect(actual.rdns).to eq('o1.email.example.com')
+      expect(actual.users).to eq([])
+      expect(actual.subdomain).to eq('email')
+      expect(actual.domain).to eq('example.com')
+      expect(actual.valid).to eq(true)
+      expect(actual.legacy).to eq(false)
+      expect(actual.a_record).to be_a(
+        SendGrid4r::REST::Whitelabel::Ips::ARecord
+      )
+      expect(actual.a_record.valid).to eq(true)
+      expect(actual.a_record.type).to eq('a')
+      expect(actual.a_record.host).to eq('o1.email.example.com')
+      expect(actual.a_record.data).to eq('192.168.1.2')
+    end
+
+    it 'creates result instance' do
+      actual = SendGrid4r::REST::Whitelabel::Ips.create_result(result)
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Ips::Result)
+      expect(actual.id).to eq(1)
+      expect(actual.valid).to eq(true)
+      expect(actual.validation_results).to be_a(
+        SendGrid4r::REST::Whitelabel::Ips::ValidationResults
+      )
+      expect(actual.validation_results.a_record).to be_a(
+        SendGrid4r::REST::Whitelabel::Ips::ValidationResult
+      )
+      expect(actual.validation_results.a_record.valid).to be(true)
+      expect(actual.validation_results.a_record.reason).to be(nil)
+    end
+  end
+end

data/spec/rest/whitelabel/links_spec.rb

@@ -0,0 +1,359 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SendGrid4r::REST::Whitelabel::Links do
+  describe 'integration test', :it do
+    before do
+      begin
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
+        @subdomain_name = ENV['SUBDOMAIN_LINK']
+        @domain_name = ENV['DOMAIN']
+        @username = ENV['USERNAME']
+        @subuser1 = ENV['SUBUSER1']
+
+        # celan up test env(lists)
+        links = @client.get_wl_links
+        links.each do |link|
+          if link.subdomain == "#{@subdomain_name}1" &&
+             link.domain == @domain_name
+            @client.delete_wl_link(id: link.id)
+          end
+        end
+
+        # post link
+        @link1 = @client.post_wl_link(
+          subdomain: @subdomain_name + '1', domain: @domain_name, default: false
+        )
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+        raise e
+      end
+    end
+
+    context 'without block call' do
+      it '#get_wl_links' do
+        begin
+          links = @client.get_wl_links
+          expect(links).to be_a(Array)
+          links.each do |link|
+            expect(link).to be_a(
+              SendGrid4r::REST::Whitelabel::Links::Link
+            )
+          end
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#post_wl_link' do
+        begin
+          expect(@link1).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+          expect(@link1.domain).to eq(@domain_name)
+          expect(@link1.subdomain).to eq(@subdomain_name + '1')
+          expect(@link1.username).to eq(@username)
+          expect(@link1.user_id).to be_a(Numeric)
+          expect(@link1.default).to eq(false)
+          expect(@link1.valid).to eq(false)
+          expect(@link1.legacy).to eq(false)
+          expect(@link1.dns.domain_cname).to be_a(
+            SendGrid4r::REST::Whitelabel::Links::Record
+          )
+          expect(@link1.dns.owner_cname).to be_a(
+            SendGrid4r::REST::Whitelabel::Links::Record
+          )
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#get_wl_link' do
+        begin
+          link1 = @client.get_wl_link(id: @link1.id)
+          expect(link1).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+          expect(link1.domain).to eq(@domain_name)
+          expect(link1.subdomain).to eq(@subdomain_name + '1')
+          expect(link1.username).to eq(@username)
+          expect(link1.user_id).to be_a(Numeric)
+          expect(link1.default).to eq(false)
+          expect(link1.valid).to eq(false)
+          expect(link1.legacy).to eq(false)
+          expect(link1.dns.domain_cname).to be_a(
+            SendGrid4r::REST::Whitelabel::Links::Record
+          )
+          expect(link1.dns.owner_cname).to be_a(
+            SendGrid4r::REST::Whitelabel::Links::Record
+          )
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#patch_wl_link' do
+        begin
+          link1 = @client.patch_wl_link(id: @link1.id, default: false)
+          expect(link1).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+          expect(link1.domain).to eq(@domain_name)
+          expect(link1.subdomain).to eq(@subdomain_name + '1')
+          expect(link1.username).to eq(@username)
+          expect(link1.user_id).to be_a(Numeric)
+          expect(link1.default).to eq(false)
+          expect(link1.valid).to eq(false)
+          expect(link1.legacy).to eq(false)
+          expect(link1.dns.domain_cname).to be_a(
+            SendGrid4r::REST::Whitelabel::Links::Record
+          )
+          expect(link1.dns.owner_cname).to be_a(
+            SendGrid4r::REST::Whitelabel::Links::Record
+          )
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#delete_wl_link' do
+        begin
+          @client.delete_wl_link(id: @link1.id)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#get_default_wl_link' do
+        begin
+          link = @client.get_default_wl_link
+          expect(link).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#validate_wl_link' do
+        begin
+          result1 = @client.validate_wl_link(id: @link1.id)
+          expect(result1).to be_a(
+            SendGrid4r::REST::Whitelabel::Links::Result
+          )
+          expect(result1.valid).to be(false)
+          expect(result1.validation_results.domain_cname.valid).to be(
+            false
+          )
+          expect(result1.validation_results.owner_cname.valid).to be(
+            false
+          )
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#get_associated_wl_link' do
+        begin
+          link1 = @client.get_associated_wl_link(username: @subuser1)
+          expect(link1).to be_a(
+            SendGrid4r::REST::Whitelabel::Links::Link
+          )
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#associate_wl_link' do
+        begin
+          @client.associate_wl_link(
+            id: @link1.id, username: @subuser1
+          )
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#disassociate_wl_link' do
+        begin
+          @client.associate_wl_link(
+            id: @link1.id, username: @subuser1
+          )
+          @client.disassociate_wl_link(username: @subuser1)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+    end
+  end
+
+  describe 'unit test', :ut do
+    let(:client) do
+      SendGrid4r::Client.new(api_key: '')
+    end
+
+    let(:links) do
+      JSON.parse('[]')
+    end
+
+    let(:link) do
+      JSON.parse(
+        '{'\
+          '"id": 1,'\
+          '"domain": "example.com",'\
+          '"subdomain": "mail",'\
+          '"username": "john@example.com",'\
+          '"user_id": 7,'\
+          '"default": false,'\
+          '"valid": true,'\
+          '"legacy": false,'\
+          '"dns": {'\
+            '"domain_cname": {'\
+              '"valid": true,'\
+              '"type": "cname",'\
+              '"host": "mail.example.com",'\
+              '"data": "sendgrid.net"'\
+            '},'\
+            '"owner_cname": {'\
+              '"valid": true,'\
+              '"type": "cname",'\
+              '"host": "7.example.com",'\
+              '"data": "sendgrid.net"'\
+            '}'\
+          '}'\
+        '}'
+      )
+    end
+
+    let(:result) do
+      JSON.parse(
+        '{'\
+          '"id": 1,'\
+          '"valid": true,'\
+          '"validation_results": {'\
+            '"domain_cname": {'\
+              '"valid": false,'\
+              '"reason": "Expected CNAME to match \"sendgrid.net.\" but found'\
+              ' \"example.com.\"."'\
+            '},'\
+            '"owner_cname": {'\
+              '"valid": true,'\
+              '"reason": null'\
+            '}'\
+          '}'\
+        '}'
+      )
+    end
+
+    it '#get_wl_links' do
+      allow(client).to receive(:execute).and_return(links)
+      actual = client.get_wl_links
+      expect(actual).to be_a(Array)
+    end
+
+    it '#post_wl_link' do
+      allow(client).to receive(:execute).and_return(link)
+      actual = client.post_wl_link(domain: '', subdomain: '')
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+    end
+
+    it '#get_wl_link' do
+      allow(client).to receive(:execute).and_return(link)
+      actual = client.get_wl_link(id: '')
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+    end
+
+    it '#patch_wl_link' do
+      allow(client).to receive(:execute).and_return(link)
+      actual = client.patch_wl_link(id: '', default: true)
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+    end
+
+    it '#delete_wl_link' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.delete_wl_link(id: '')
+      expect(actual).to eq('')
+    end
+
+    it '#get_default_wl_link' do
+      allow(client).to receive(:execute).and_return(link)
+      actual = client.get_default_wl_link(domain: '')
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+    end
+
+    it '#validate_link' do
+      allow(client).to receive(:execute).and_return(result)
+      actual = client.validate_wl_link(id: '')
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Links::Result)
+    end
+
+    it '#get_associated_wl_link' do
+      allow(client).to receive(:execute).and_return(link)
+      actual = client.get_associated_wl_link(username: '')
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+    end
+
+    it '#disassociate_wl_link' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.disassociate_wl_link(username: '')
+      expect(actual).to eq('')
+    end
+
+    it '#associate_wl_link' do
+      allow(client).to receive(:execute).and_return(link)
+      actual = client.associate_wl_link(id: '', username: '')
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+    end
+
+    it 'creates link instance' do
+      actual = SendGrid4r::REST::Whitelabel::Links.create_link(link)
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Links::Link)
+      expect(actual.id).to eq(1)
+      expect(actual.domain).to eq('example.com')
+      expect(actual.subdomain).to eq('mail')
+      expect(actual.username).to eq('john@example.com')
+      expect(actual.user_id).to eq(7)
+      expect(actual.default).to eq(false)
+      expect(actual.valid).to eq(true)
+      expect(actual.legacy).to eq(false)
+      expect(actual.dns).to be_a(SendGrid4r::REST::Whitelabel::Links::Dns)
+      expect(actual.dns.domain_cname).to be_a(
+        SendGrid4r::REST::Whitelabel::Links::Record
+      )
+      expect(actual.dns.domain_cname.host).to eq('mail.example.com')
+      expect(actual.dns.domain_cname.type).to eq('cname')
+      expect(actual.dns.domain_cname.data).to eq('sendgrid.net')
+      expect(actual.dns.domain_cname.valid).to eq(true)
+      expect(actual.dns.owner_cname).to be_a(
+        SendGrid4r::REST::Whitelabel::Links::Record
+      )
+      expect(actual.dns.owner_cname.host).to eq('7.example.com')
+      expect(actual.dns.owner_cname.type).to eq('cname')
+      expect(actual.dns.owner_cname.data).to eq('sendgrid.net')
+      expect(actual.dns.owner_cname.valid).to eq(true)
+    end
+
+    it 'creates result instance' do
+      actual = SendGrid4r::REST::Whitelabel::Links.create_result(result)
+      expect(actual).to be_a(SendGrid4r::REST::Whitelabel::Links::Result)
+      expect(actual.id).to eq(1)
+      expect(actual.valid).to eq(true)
+      expect(actual.validation_results).to be_a(
+        SendGrid4r::REST::Whitelabel::Links::ValidationResults
+      )
+      expect(actual.validation_results.domain_cname).to be_a(
+        SendGrid4r::REST::Whitelabel::Links::ValidationResult
+      )
+      expect(actual.validation_results.domain_cname.valid).to be(false)
+      expect(actual.validation_results.domain_cname.reason).to be_a(String)
+      expect(actual.validation_results.owner_cname).to be_a(
+        SendGrid4r::REST::Whitelabel::Links::ValidationResult
+      )
+      expect(actual.validation_results.owner_cname.valid).to be(true)
+      expect(actual.validation_results.owner_cname.reason).to be(nil)
+    end
+  end
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid4r
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - awwa500@gmail.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +156,9 @@ files:
 - lib/sendgrid4r/rest/subusers/subusers.rb
 - lib/sendgrid4r/rest/templates/templates.rb
 - lib/sendgrid4r/rest/templates/versions.rb
+- lib/sendgrid4r/rest/whitelabel/domains.rb
+- lib/sendgrid4r/rest/whitelabel/ips.rb
+- lib/sendgrid4r/rest/whitelabel/links.rb
 - lib/sendgrid4r/version.rb
 - sendgrid4r.gemspec
 - spec/client_spec.rb
@@ -185,6 +194,9 @@ files:
 - spec/rest/subusers/subusers_spec.rb
 - spec/rest/templates/templates_spec.rb
 - spec/rest/templates/versions_spec.rb
+- spec/rest/whitelabel/domains_spec.rb
+- spec/rest/whitelabel/ips_spec.rb
+- spec/rest/whitelabel/links_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -206,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: SendGrid Web API v3 module
@@ -244,5 +256,7 @@ test_files:
 - spec/rest/subusers/subusers_spec.rb
 - spec/rest/templates/templates_spec.rb
 - spec/rest/templates/versions_spec.rb
+- spec/rest/whitelabel/domains_spec.rb
+- spec/rest/whitelabel/ips_spec.rb
+- spec/rest/whitelabel/links_spec.rb
 - spec/spec_helper.rb
-has_rdoc: