neverbounce-api 1.0.0

data/spec/lib/never_bounce/api/request/base_spec.rb

@@ -0,0 +1,6 @@
+
+describe NeverBounce::API::Request::Base do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+end

data/spec/lib/never_bounce/api/request/jobs_create_spec.rb

@@ -0,0 +1,89 @@
+
+module NeverBounce; module API; module Request
+  describe JobsCreate do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe "#mode_h" do
+      it "generally works" do
+        r = newo()
+        expect(r.mode_h).to eq({})
+        r = newo(auto_start: nil, auto_parse: nil, run_sample: nil)
+        expect(r.mode_h).to eq({})
+        r = newo(auto_start: false, auto_parse: false, run_sample: false)
+        expect(r.mode_h).to eq({auto_start: false, auto_parse: false, run_sample: false})
+        r = newo(auto_start: true, auto_parse: true, run_sample: true)
+        expect(r.mode_h).to eq({auto_start: true, auto_parse: true, run_sample: true})
+      end
+    end
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq API::Response::JobsCreate }
+    end
+
+    describe "#to_h" do
+      let(:m) { :to_h }
+      context "for input specification" do
+        def goodo(attrs = {})
+          newo({
+            api_key: "api_key",
+            filename: "filename",
+          }.merge(attrs))
+        end
+
+        it "generally works" do
+          # NOTE: Logical order: type, then value.
+          r = goodo(input_location: "unk", input: "input")
+          expect { r.send(m) }.to raise_error(AttributeError, 'Unknown `input_location`: "unk"')
+
+          r = goodo(input_location: "remote_url", input: "input")
+          expect(h = r.send(m)).to be_a Hash
+          expect(h).to include(input_location: "remote_url", input: "input")
+
+          r = goodo(input_location: "supplied", input: "plain")
+          expect { r.send(m) }.to raise_error(AttributeError, 'Invalid `input` for `input_location` == "supplied": "plain"')
+
+          r = goodo(input_location: "supplied", input: ["a", "b"])
+          expect { r.send(m) }.to raise_error(AttributeError, 'Invalid `input` element: "a"')
+
+          r = goodo(input_location: "supplied", input: [["a"], ["b"]])
+          expect { r.send(m) }.to raise_error(AttributeError, 'Invalid `input` element: ["a"]')
+
+          r = goodo(input_location: "supplied", input: [["alice@isp.com", "Alice Roberts"], ["b"]])
+          expect { r.send(m) }.to raise_error(AttributeError, 'Invalid `input` element: ["b"]')
+
+          r = goodo(input_location: "supplied", input: [["alice@isp.com", "Alice Roberts"], ["b", "bb", "bbb"]])
+          expect { r.send(m) }.to raise_error(AttributeError, 'Invalid `input` element: ["b", "bb", "bbb"]')
+
+          r = goodo(input_location: "supplied", input: [["alice@isp.com", "Alice Roberts"], ["bob.smith@gmail.com", "Bob Smith"]])
+          expect(h = r.send(m)).to be_a Hash
+          expect(h).to include(input: [["alice@isp.com", "Alice Roberts"], ["bob.smith@gmail.com", "Bob Smith"]])
+        end
+      end
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: input")
+        r.input = "input"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: input_location")
+        r.input_location = "remote_url"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: filename")
+        r.filename = "filename"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: api_key")
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(method).to eq :post
+        expect(url).to eq "https://api.neverbounce.com/v4/jobs/create"
+        expect(data).to include(:body, :headers)
+        expect(data.fetch(:body)).to eq "{\"input\":\"input\",\"input_location\":\"remote_url\",\"filename\":\"filename\",\"key\":\"api_key\"}"
+        expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
+      end
+    end
+  end
+end; end; end

data/spec/lib/never_bounce/api/request/jobs_delete_spec.rb

@@ -0,0 +1,31 @@
+
+module NeverBounce; module API; module Request
+  describe JobsDelete do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq Response::JobsDelete }
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: job_id")
+        r.job_id = "123"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: api_key")
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(method).to eq :post
+        expect(url).to eq "https://api.neverbounce.com/v4/jobs/delete"
+        expect(data).to include(:body, :headers)
+        expect(data.fetch(:body)).to eq("{\"job_id\":\"123\",\"key\":\"api_key\"}")
+        expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
+      end
+    end
+  end
+end; end; end

data/spec/lib/never_bounce/api/request/jobs_download_spec.rb

@@ -0,0 +1,31 @@
+
+module NeverBounce; module API; module Request
+  describe JobsDownload do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq Response::JobsDownload }
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: job_id")
+        r.job_id = "123"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: api_key")
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(method).to eq :get
+        expect(url).to eq "https://api.neverbounce.com/v4/jobs/download"
+        expect(data).to include(:body, :headers)
+        expect(data.fetch(:body)).to eq("{\"job_id\":\"123\",\"key\":\"api_key\"}")
+        expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
+      end
+    end
+  end
+end; end; end

data/spec/lib/never_bounce/api/request/jobs_parse_spec.rb

@@ -0,0 +1,44 @@
+
+module NeverBounce; module API; module Request
+  describe JobsParse do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe "#mode_h" do
+      it "generally works" do
+        r = newo()
+        expect(r.mode_h).to eq({})
+        r = newo(auto_start: nil)
+        expect(r.mode_h).to eq({})
+        r = newo(auto_start: false)
+        expect(r.mode_h).to eq({auto_start: false})
+        r = newo(auto_start: true)
+        expect(r.mode_h).to eq({auto_start: true})
+      end
+    end
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq Response::JobsParse }
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: job_id")
+        r.job_id = "123"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: api_key")
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(method).to eq :post
+        expect(url).to eq "https://api.neverbounce.com/v4/jobs/parse"
+        expect(data).to include(:body, :headers)
+        expect(data.fetch(:body)).to eq("{\"job_id\":\"123\",\"key\":\"api_key\"}")
+        expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
+      end
+    end
+  end
+end; end; end

data/spec/lib/never_bounce/api/request/jobs_results_spec.rb

@@ -0,0 +1,42 @@
+
+module NeverBounce; module API; module Request
+  describe JobsResults do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe "#mode_h" do
+      it "generally works" do
+        r = newo()
+        expect(r.mode_h).to eq({})
+        r = newo(page: nil, per_page: nil)
+        expect(r.mode_h).to eq({})
+        r = newo(page: 12, per_page: 34)
+        expect(r.mode_h).to eq({page: 12, items_per_page: 34})
+      end
+    end
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq API::Response::JobsResults }
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: job_id")
+        r.job_id = "123"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: api_key")
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(method).to eq :get
+        expect(url).to eq "https://api.neverbounce.com/v4/jobs/results"
+        expect(data).to include(:body, :headers)
+        expect(data.fetch(:body)).to eq "{\"job_id\":\"123\",\"key\":\"api_key\"}"
+        expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
+      end
+    end
+  end
+end; end; end

data/spec/lib/never_bounce/api/request/jobs_search_spec.rb

@@ -0,0 +1,40 @@
+
+module NeverBounce; module API; module Request
+  describe JobsSearch do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe "#mode_h" do
+      it "generally works" do
+        r = newo()
+        expect(r.mode_h).to eq({})
+        r = newo(job_id: nil, page: nil, per_page: nil)
+        expect(r.mode_h).to eq({})
+        r = newo(job_id: "abc", page: 12, per_page: 34)
+        expect(r.mode_h).to eq({job_id: "abc", page: 12, items_per_page: 34})
+      end
+    end
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq API::Response::JobsSearch }
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo(job_id: "abc", page: 12, per_page: 34)
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: api_key")
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(method).to eq :get
+        expect(url).to eq "https://api.neverbounce.com/v4/jobs/search"
+        expect(data).to include(:body, :headers)
+        expect(data.fetch(:body)).to eq "{\"key\":\"api_key\",\"job_id\":\"abc\",\"page\":12,\"items_per_page\":34}"
+        expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
+      end
+    end
+  end
+end; end; end

data/spec/lib/never_bounce/api/request/jobs_start_spec.rb

@@ -0,0 +1,44 @@
+
+module NeverBounce; module API; module Request
+  describe JobsStart do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe "#mode_h" do
+      it "generally works" do
+        r = newo()
+        expect(r.mode_h).to eq({})
+        r = newo(run_sample: nil)
+        expect(r.mode_h).to eq({})
+        r = newo(run_sample: false)
+        expect(r.mode_h).to eq({run_sample: false})
+        r = newo(run_sample: true)
+        expect(r.mode_h).to eq({run_sample: true})
+      end
+    end
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq Response::JobsStart }
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: job_id")
+        r.job_id = "123"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: api_key")
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(method).to eq :post
+        expect(url).to eq "https://api.neverbounce.com/v4/jobs/start"
+        expect(data).to include(:body, :headers)
+        expect(data.fetch(:body)).to eq("{\"job_id\":\"123\",\"key\":\"api_key\"}")
+        expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
+      end
+    end
+  end
+end; end; end

data/spec/lib/never_bounce/api/request/jobs_status_spec.rb

@@ -0,0 +1,31 @@
+
+module NeverBounce; module API; module Request
+  describe JobsStatus do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq API::Response::JobsStatus }
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: job_id")
+        r.job_id = "123"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: api_key")
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(method).to eq :get
+        expect(url).to eq "https://api.neverbounce.com/v4/jobs/status"
+        expect(data).to include(:body, :headers)
+        expect(data.fetch(:body)).to eq "{\"job_id\":\"123\",\"key\":\"api_key\"}"
+        expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
+      end
+    end
+  end
+end; end; end

data/spec/lib/never_bounce/api/request/single_check_spec.rb

@@ -0,0 +1,44 @@
+
+module NeverBounce; module API; module Request
+  describe SingleCheck do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe "#mode_h" do
+      it "generally works" do
+        r = newo()
+        expect(r.mode_h).to eq({})
+        r = newo(address_info: nil, credits_info: nil, timeout: nil)
+        expect(r.mode_h).to eq({})
+        r = newo(address_info: false, credits_info: false)
+        expect(r.mode_h).to eq({address_info: false, credits_info: false})
+        r = newo(address_info: true, credits_info: true, timeout: 12)
+        expect(r.mode_h).to eq({address_info: true, credits_info: true, timeout: 12})
+      end
+    end
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq Response::SingleCheck }
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo(address_info: true, credits_info: true, timeout: 12)
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: email")
+        r.email = "email"
+        expect { r.to_httparty }.to raise_error(AttributeError, "Attribute must be set: api_key")
+        r.api_key = "api_key"
+
+        res = r.to_httparty
+        expect(res).to be_a Array
+        method, url, data = res
+        expect(method).to eq :get
+        expect(url).to eq "https://api.neverbounce.com/v4/single/check"
+        expect(data).to include(:body, :headers)
+        expect(data.fetch(:body)).to eq "{\"email\":\"email\",\"key\":\"api_key\",\"address_info\":true,\"credits_info\":true,\"timeout\":12}"
+        expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
+      end
+    end
+  end
+end; end; end

data/spec/lib/never_bounce/api/response/account_info/job_counts_spec.rb

@@ -0,0 +1,7 @@
+
+describe NeverBounce::API::Response::AccountInfo::JobCounts do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+  it_behaves_like "properly inherited"
+end

data/spec/lib/never_bounce/api/response/account_info_spec.rb

@@ -0,0 +1,9 @@
+
+describe NeverBounce::API::Response::AccountInfo do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+  it_behaves_like "properly inherited"
+
+  # OPTIMIZE: Feed real data here some day.
+end

data/spec/lib/never_bounce/api/response/address_info_spec.rb

@@ -0,0 +1,7 @@
+
+describe NeverBounce::API::Response::AddressInfo do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+  it_behaves_like "properly inherited"
+end

data/spec/lib/never_bounce/api/response/base_spec.rb

@@ -0,0 +1,6 @@
+
+describe NeverBounce::API::Response::Base do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+end