neverbounce-api 1.0.0

data/lib/never_bounce/api/version.rb

@@ -0,0 +1,4 @@
+
+module NeverBounce; module API
+  VERSION = "1.0.0"
+end; end

data/lib/neverbounce-api.rb

@@ -0,0 +1,4 @@
+
+# Main gem require. Load all libraries.
+# Upon a convention, the require named same as gem does all loading job.
+Dir[File.join(__dir__, "**/*.rb")].each { |fn| require fn }

data/lib/neverbounce.rb

@@ -0,0 +1,3 @@
+
+# A "convenience" require for doc examples etc.
+require_relative "neverbounce-api"

data/neverbounce-api.gemspec

@@ -0,0 +1,20 @@
+
+require_relative "lib/never_bounce/api/version"
+
+Gem::Specification.new do |s|
+  s.name = "neverbounce-api"
+  s.summary = "The official NeverBounce API library for Ruby"
+
+  s.authors = ["NeverBounce"]
+  s.email = ["support@neverbounce.com"]
+  s.homepage = "https://neverbounce.com"
+  s.license = "MIT"
+  s.version = NeverBounce::API::VERSION
+
+  s.files = `git ls-files`.split("\n")
+  s.required_ruby_version = ">= 2.0.0"
+  s.require_paths = ["lib"]
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_dependency("httparty", "~> 0.15")
+end

data/spec/lib/never_bounce/api/client_spec.rb

@@ -0,0 +1,199 @@
+
+module NeverBounce; module API
+  describe Client do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe "attributes" do
+      describe "#api_key" do
+        it "generally works" do
+          r = newo
+          expect { r.api_key }.to raise_error(AttributeError, "Attribute must be set: api_key")
+          r.api_key = "api_key"
+          expect(r.api_key).to eq "api_key"
+        end
+      end
+    end # describe "attributes"
+
+    describe "requests" do
+      let(:klass) do
+        Class.new(described_class) do
+          def response_to(request)
+            # Short-circuit with a signature. The signature ensures we get control here.
+            [:response_to, request]
+          end
+        end
+      end
+
+      # Build a "good" object with typically enough attributes to work.
+      def goodo(attrs = {})
+        klass.new({
+          api_key: "api_key",
+        }.merge(attrs))
+      end
+
+      describe "#account_info" do
+        it "generally works" do
+          sc = goodo.account_info
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::AccountInfo
+          expect(request.to_httparty).to be_a Array
+        end
+      end
+
+      describe "#jobs_create" do
+        let(:m) { :jobs_create }
+        it "generally works" do
+          client = goodo
+          expect { client.send(m) }.to raise_error(ArgumentError, "Input not given, use `remote_input` or `supplied_input`")
+
+          client = goodo
+          expect { client.send(m, remote_input: "remote", supplied_input: "supplied") }.to raise_error(ArgumentError, "`remote_input` and `supplied_input` can't both be given")
+
+          # NOTE: A few scenarios, redundantly testing as much attributes as possible.
+
+          sc = client.send(m, remote_input: "remote_input")
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::JobsCreate
+          expect(request.to_httparty).to be_a Array
+          expect(request.input).to eq "remote_input"
+          expect(request.input_location).to eq "remote_url"
+          expect(request.filename).to match /^\d{8}-\d{6}\.csv$/
+
+          sc = client.send(m, supplied_input: [["email", "name"]])
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::JobsCreate
+          expect(request.to_httparty).to be_a Array
+          expect(request.input).to eq [["email", "name"]]
+          expect(request.input_location).to eq "supplied"
+          expect(request.filename).to match /^\d{8}-\d{6}\.csv$/
+
+          sc = client.send(m, auto_parse: true, auto_start: true, filename: "filename", run_sample: true, supplied_input: [["email", "name"]])
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::JobsCreate
+          expect(request.to_httparty).to be_a Array
+          expect(request.auto_parse).to be true
+          expect(request.auto_start).to be true
+          expect(request.input).to eq [["email", "name"]]
+          expect(request.input_location).to eq "supplied"
+          expect(request.filename).to eq "filename"
+          expect(request.run_sample).to be true
+        end
+      end
+
+      describe "#jobs_delete" do
+        it "generally works" do
+          sc = goodo.jobs_delete(job_id: 12)
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::JobsDelete
+          expect(request.to_httparty).to be_a Array
+          expect(request.job_id).to eq 12
+        end
+      end
+
+      describe "#jobs_download" do
+        it "generally works" do
+          sc = goodo.jobs_download(job_id: 12)
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::JobsDownload
+          expect(request.to_httparty).to be_a Array
+          expect(request.job_id).to eq 12
+        end
+      end
+
+      describe "#jobs_parse" do
+        it "generally works" do
+          sc = goodo.jobs_parse(auto_start: true, job_id: 12)
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::JobsParse
+          expect(request.to_httparty).to be_a Array
+          expect(request.auto_start).to be true
+          expect(request.job_id).to eq 12
+        end
+      end
+
+      describe "#jobs_results" do
+        it "generally works" do
+          sc = goodo.jobs_results(job_id: 12, page: 34, per_page: 56)
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::JobsResults
+          expect(request.to_httparty).to be_a Array
+          expect(request.job_id).to eq 12
+          expect(request.page).to eq 34
+          expect(request.per_page).to eq 56
+        end
+      end
+
+      describe "#jobs_search" do
+        it "generally works" do
+          sc = goodo.jobs_search(job_id: 12, page: 34, per_page: 56)
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::JobsSearch
+          expect(request.to_httparty).to be_a Array
+          expect(request.job_id).to eq 12
+          expect(request.page).to eq 34
+          expect(request.per_page).to eq 56
+        end
+      end
+
+      describe "#jobs_start" do
+        it "generally works" do
+          sc = goodo.jobs_start(job_id: 12, run_sample: true)
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::JobsStart
+          expect(request.to_httparty).to be_a Array
+          expect(request.job_id).to eq 12
+          expect(request.run_sample).to be true
+        end
+      end
+
+      describe "#jobs_status" do
+        it "generally works" do
+          sc = goodo.jobs_status(job_id: 12)
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::JobsStatus
+          expect(request.to_httparty).to be_a Array
+          expect(request.job_id).to eq 12
+        end
+      end
+
+      describe "#single_check" do
+        it "generally works" do
+          sc = goodo.single_check(address_info: true, credits_info: true, email: "alice@isp.com", timeout: 12)
+          expect(sc).to be_a Array
+          signature, request = sc
+          expect(signature).to eq :response_to
+          expect(request).to be_a Request::SingleCheck
+          expect(request.to_httparty).to be_a Array
+          expect(request.address_info).to be true
+          expect(request.credits_info).to be true
+          expect(request.email).to eq "alice@isp.com"
+          expect(request.timeout).to eq 12
+        end
+      end
+    end
+  end
+end; end

data/spec/lib/never_bounce/api/feature/basic_initialize_spec.rb

@@ -0,0 +1,25 @@
+
+describe NeverBounce::API::Feature::BasicInitialize do
+  let(:klass) do
+    feature = described_class
+    Class.new do
+      feature.load(self)
+
+      attr_accessor :a, :b
+
+      private
+
+      def c=(value)
+        @c = value
+      end
+    end
+  end
+
+  it "generally works" do
+    r = klass.new(a: 12, b: "34")
+    expect(r.a).to eq 12
+    expect(r.b).to eq "34"
+
+    expect { klass.new(c: 12) }.to raise_error(NoMethodError, /\bprivate method `c='/)
+  end
+end

data/spec/lib/never_bounce/api/feature/eigencache_spec.rb

@@ -0,0 +1,28 @@
+
+describe NeverBounce::API::Feature::Eigencache do
+  let(:klass) do
+    feature = described_class
+
+    Class.new do
+      feature.load(self)
+
+      def a
+        _cache[:a] ||= "a"
+      end
+
+      def a=(value)
+        _cache[:a] = value
+      end
+    end
+  end
+
+  it "generally works" do
+    r = klass.new
+    expect(r.a).to eq "a"
+    expect(r.inspect).not_to match "@a"
+
+    r.a = "a+"
+    expect(r.a).to eq "a+"
+    expect(r.inspect).not_to match "@a"
+  end
+end

data/spec/lib/never_bounce/api/feature/igetset_spec.rb

@@ -0,0 +1,45 @@
+
+describe NeverBounce::API::Feature::Igetset do
+  let(:klass) do
+    feature = described_class
+
+    Class.new do
+      feature.load(self)
+
+      attr_writer :is_a, :is_b
+
+      def is_a
+        igetset(:is_a) do
+          seq << :is_a_block
+          false
+        end
+      end
+
+      def is_b
+        igetset(:is_a) do
+          seq << :is_b_block
+          nil
+        end
+      end
+
+      # Store call sequence here.
+      def seq
+        @log ||= []
+      end
+    end
+  end
+
+  it "generally works" do
+    r = klass.new
+    expect(r.seq).to eq []
+    expect(r.is_a).to be false
+    expect(r.is_a).to be false
+    expect(r.seq).to eq [:is_a_block]   # Block evaluation is logged once.
+
+    r = klass.new
+    expect(r.seq).to eq []
+    expect(r.is_b).to be nil
+    expect(r.is_b).to be nil
+    expect(r.seq).to eq [:is_b_block]
+  end
+end

data/spec/lib/never_bounce/api/feature/oattrs_spec.rb

@@ -0,0 +1,72 @@
+
+describe NeverBounce::API::Feature::Oattrs do
+  let(:parent_klass) do
+    feature = described_class
+
+    Class.new do
+      feature.load(self)
+
+      oattr :parent_a, :writer
+
+      def parent_a
+        @parent_a ||= "parent_a"
+      end
+    end
+  end
+
+  let(:klass) do
+    feature = described_class
+
+    Class.new(parent_klass) do
+      feature.load(self)
+
+      oattr :a, :writer
+      oattr :b, :custom
+
+      def a
+        @a ||= "a"
+      end
+
+      def b
+        @b ||= "b"
+      end
+
+      def b=(value)
+        @b = value
+      end
+    end
+  end
+
+  describe "attribute access" do
+    include_dir_context __dir__
+
+    it "generally works" do
+      r = parent_klass.new
+      expect(r.parent_a).to eq "parent_a"
+      r.parent_a = "yo"
+      expect(r.parent_a).to eq "yo"
+
+      r = klass.new
+      expect(r.b).to eq "b"
+      r.b = "yo"
+      expect(r.b).to eq "yo"
+    end
+  end
+
+  describe ".attrs" do
+    it "generally works" do
+      expect(parent_klass.oattrs).to eq [:parent_a]
+      expect(klass.oattrs).to eq [:parent_a, :a, :b]
+    end
+  end
+
+  describe "#touch" do
+    it "generally works" do
+      r = klass.new
+      expect(r.touch).to eq r
+      expect(r.inspect).to include '@parent_a="parent_a"'
+      expect(r.inspect).to include '@a="a"'
+      expect(r.inspect).to include '@b="b"'
+    end
+  end
+end

data/spec/lib/never_bounce/api/feature/require_attr_spec.rb

@@ -0,0 +1,25 @@
+
+module NeverBounce; module API; module Feature
+  describe RequireAttr do
+    let(:klass) do
+      feature = described_class
+      Class.new do
+        feature.load(self)
+
+        attr_accessor :a
+
+        def b
+          v = require_attr :a
+          [v, "b"]
+        end
+      end
+    end
+
+    it "generally works" do
+      r = klass.new
+      expect { r.b }.to raise_error(AttributeError, "Attribute must be set: a")
+      r.a = "a"
+      expect(r.b).to eq ["a", "b"]
+    end
+  end
+end; end; end

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

@@ -0,0 +1,29 @@
+
+module NeverBounce; module API; module Request
+  describe AccountInfo do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe ".response_klass" do
+      it { expect(described_class.response_klass).to eq Response::AccountInfo }
+    end
+
+    describe "#to_httparty" do
+      it "generally works" do
+        r = newo
+        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/account/info"
+        expect(data).to include(:body, :headers)
+        expect(data.fetch(:body)).to eq "{\"key\":\"api_key\"}"
+        expect(data.fetch(:headers)).to include("Content-Type", "User-Agent")
+      end
+    end
+  end
+end; end; end