neverbounce-api 1.0.0

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

@@ -0,0 +1,142 @@
+
+module NeverBounce; module API; module Response
+  describe Container do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+    it_behaves_like "properly inherited"
+
+    describe "#body_hash" do
+      it "requires `raw`" do
+        expect { newo.body_hash }.to raise_error(AttributeError, "Attribute must be set: raw")
+      end
+
+      it "generally works" do
+        r = newo(raw: '{"a":10}')
+        expect(r.body_hash).to eq({"a" => 10})
+      end
+    end
+
+    describe ".oattr" do
+      # NOTE: Tests for this section are a few "matrix" scenarios which reasonably cover possible combinations.
+      context "case 1" do
+        let(:klass) do
+          Class.new(described_class) do
+            oattr :a, :scalar
+            oattr :b, :scalar, type: :integer
+            oattr :c, :scalar, type: :integer, allow_nil: true
+            oattr :d, :writer
+            oattr :e, :custom
+            oattr :f, :scalar, type: :float
+            oattr :g, :scalar, type: :float, allow_nil: true
+
+            def d
+              @d ||= body_hash.fetch("d")
+            end
+
+            def e
+              @e ||= body_hash.fetch("e")
+            end
+
+            def e=(v)
+              @e = v
+            end
+          end
+        end
+
+        it "generally works" do
+          expect(klass.oattrs).to eq [:a, :b, :c, :d, :e, :f, :g]
+
+          r = klass.new(body_hash: {})
+          expect { r.a }.to raise_error KeyError
+          expect { r.d }.to raise_error KeyError
+          expect { r.e }.to raise_error KeyError
+          expect { r.f }.to raise_error KeyError
+
+          # Numeric conversion, valid values.
+          r = klass.new(body_hash: {
+            "b" => "12",
+            "c" => "34",
+            "f" => "1.2",
+            "g" => "3.4",
+          })
+          expect(r.b).to eq 12
+          expect(r.c).to eq 34
+          expect(r.f).to eq 1.2
+          expect(r.g).to eq 3.4
+
+          # Numeric conversion, empty strings.
+          r = klass.new(body_hash: {
+            "b" => "",
+            "c" => "",
+            "f" => "",
+            "g" => "",
+          })
+          expect { r.b }.to raise_error(ArgumentError, /^invalid value for Integer/)
+          expect { r.c }.to raise_error(ArgumentError, /^invalid value for Integer/)
+          expect { r.f }.to raise_error(ArgumentError, /^invalid value for Float/)
+          expect { r.g }.to raise_error(ArgumentError, /^invalid value for Float/)
+
+          # Numeric conversion, invalid strings.
+          r = klass.new(body_hash: {
+            "b" => "xyz",
+            "c" => "xyz",
+            "f" => "xyz",
+            "g" => "xyz",
+          })
+          expect { r.b }.to raise_error(ArgumentError, /^invalid value for Integer/)
+          expect { r.c }.to raise_error(ArgumentError, /^invalid value for Integer/)
+          expect { r.f }.to raise_error(ArgumentError, /^invalid value for Float/)
+          expect { r.g }.to raise_error(ArgumentError, /^invalid value for Float/)
+
+          # Nill allowance.
+          r = klass.new(body_hash: {
+            "b" => nil,
+            "c" => nil,
+            "f" => nil,
+            "g" => nil,
+          })
+          expect { r.b }.to raise_error(TypeError, /nil into Integer/)
+          expect(r.c).to be nil
+          expect { r.f }.to raise_error(TypeError, /nil into Float/)
+          expect(r.g).to be nil
+
+          # Complete set.
+          r = klass.new(body_hash: {
+            "a" => "hello",
+            "b" => 10,
+            "c" => 20,
+            "d" => [1, 2, 3],
+            "e" => {kk: 1},
+            "f" => 1.5,
+            "g" => 2.6,
+          })
+
+          expect { r.touch }.not_to raise_error   # An important one.
+
+          expect(r.a).to eq "hello"
+          expect(r.b).to eq 10
+          expect(r.c).to eq 20
+          expect(r.d).to eq([1, 2, 3])
+          expect(r.e).to eq({kk: 1})
+          expect(r.f).to eq 1.5
+          expect(r.g).to eq 2.6
+
+          # Accessors.
+          r.a += "!"
+          expect(r.a).to eq "hello!"
+          r.b += 1
+          expect(r.b).to eq 11
+          r.c += 1
+          expect(r.c).to eq 21
+          r.d += [4]
+          expect(r.d).to eq [1, 2, 3, 4]
+          r.f += 0.1
+          expect(r.f).to eq 1.6
+          r.g += 0.1
+          expect(r.g).to eq 2.7
+        end
+      end
+    end
+  end
+end; end; end

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

@@ -0,0 +1,31 @@
+
+describe NeverBounce::API::Response::CreditsInfo::Base do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+  it_behaves_like "properly inherited"
+
+  let(:klass) do
+    Class.new(described_class) do
+      attr_accessor :subscription_type
+    end
+  end
+
+  describe "#monthly?" do
+    it "generally works" do
+      r = klass.new
+      r.subscription_type = :monthly
+      expect(r.monthly?).to be true
+      expect(r.paid?).to be false
+    end
+  end
+
+  describe "#paid?" do
+    it "generally works" do
+      r = klass.new
+      r.subscription_type = :paid
+      expect(r.monthly?).to be false
+      expect(r.paid?).to be true
+    end
+  end
+end

data/spec/lib/never_bounce/api/response/credits_info/monthly_spec.rb

@@ -0,0 +1,11 @@
+
+describe NeverBounce::API::Response::CreditsInfo::Monthly do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+  it_behaves_like "properly inherited"
+
+  describe "#subscription_type" do
+    it { expect(newo.subscription_type).to eq :monthly }
+  end
+end

data/spec/lib/never_bounce/api/response/credits_info/paid_spec.rb

@@ -0,0 +1,11 @@
+
+describe NeverBounce::API::Response::CreditsInfo::Paid do
+  include_dir_context __dir__
+
+  it_behaves_like "instantiatable"
+  it_behaves_like "properly inherited"
+
+  describe "#subscription_type" do
+    it { expect(newo.subscription_type).to eq :paid }
+  end
+end

data/spec/lib/never_bounce/api/response/feature/job_status_fields/total_spec.rb

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

data/spec/lib/never_bounce/api/response/feature/job_status_fields_spec.rb

@@ -0,0 +1,42 @@
+
+module NeverBounce; module API; module Response; module Feature
+  describe JobStatusFields do
+    context "when invalid class" do
+      it "generally works" do
+        feature = described_class
+        expect { Class.new { feature.load(self) } }.to raise_error(ArgumentError, /is not an ancestor of Response::Container$/)
+      end
+    end
+
+    context "when valid class" do
+      it "generally works" do
+        feature = described_class
+
+        klass = Class.new(Response::StatusMessage) { feature.load(self) }
+
+        # Use a complete real-world example.
+        r = klass.new(body_hash: {"status"=>"success", "id"=>302499, "job_status"=>"complete", "filename"=>"20170815-103321.csv", "created_at"=>"2017-08-15 17:19:41", "started_at"=>"2017-08-15 17:19:42", "finished_at"=>"2017-08-15 17:19:45", "total"=>{"records"=>11, "billable"=>12, "processed"=>13, "valid"=>14, "invalid"=>15, "catchall"=>16, "disposable"=>17, "unknown"=>18, "duplicates"=>19, "bad_syntax"=>20}, "bounce_estimate"=>34.56, "percent_complete"=>100, "execution_time"=>99})
+        expect(r.id).to eq 302499
+        expect(r.job_status).to eq "complete"
+        expect(r.filename).to eq "20170815-103321.csv"
+        expect(r.created_at).to eq "2017-08-15 17:19:41"
+        expect(r.started_at).to eq "2017-08-15 17:19:42"
+        expect(r.finished_at).to eq "2017-08-15 17:19:45"
+        expect(r.bounce_estimate).to eq 34.56
+        expect(r.percent_complete).to eq 100
+        expect(r.execution_time).to eq 99
+        expect(total = r.total).to be_a described_class::Total
+        expect(total.records).to eq 11
+        expect(total.billable).to eq 12
+        expect(total.processed).to eq 13
+        expect(total.valid).to eq 14
+        expect(total.invalid).to eq 15
+        expect(total.catchall).to eq 16
+        expect(total.disposable).to eq 17
+        expect(total.unknown).to eq 18
+        expect(total.duplicates).to eq 19
+        expect(total.bad_syntax).to eq 20
+      end
+    end
+  end
+end; end; end; end

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

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

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

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

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

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

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

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

data/spec/lib/never_bounce/api/response/jobs_results/jobs_results_item_spec.rb

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

data/spec/lib/never_bounce/api/response/jobs_results/jobs_results_query_spec.rb

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

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

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

data/spec/lib/never_bounce/api/response/jobs_search/jobs_search_query_spec.rb

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

data/spec/lib/never_bounce/api/response/jobs_search/jobs_search_result_spec.rb

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,8 @@
+
+shared_context __dir__ do
+  shared_examples "properly inherited" do
+    it "doesn't have duplicate oattrs" do
+      expect((oattrs = described_class.oattrs).uniq).to eq oattrs
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+
+module NeverBounce; module API
+  describe Session do
+    include_dir_context __dir__
+
+    it_behaves_like "instantiatable"
+
+    describe "#server_raw" do
+      let(:m) { :server_raw }
+      context "when NOK" do
+        it "generally works" do
+          r = newo(
+            server_obj: Class.new do
+              def code; 123; end
+              def ok?; false; end
+            end.new
+          )
+          expect { r.send(m) }.to raise_error(RequestError, "Code not OK: 123")
+        end
+      end
+
+      context "when OK" do
+        it "generally works" do
+          r = newo(
+            server_obj: Class.new do
+              def body; "abc"; end
+              def ok?; true; end
+            end.new,
+          )
+          expect(r.send(m)).to eq "abc"
+        end
+      end
+    end # describe "#server_raw"
+
+    describe "#robj_hash_preview" do
+      let(:m) { :robj_hash_preview }
+
+      context "when unknown content type" do
+        it "generally works" do
+          r = newo(server_content_type: "type/a")
+          expect(r.send(m)).to be false
+        end
+      end
+
+      context "when 'application/json'" do
+        it "generally works" do
+          r = newo(
+            server_content_type: "application/json",
+            server_raw: "xyz",
+          )
+          expect { r.send(m) }.to raise_error(FormatError, /^JSON::ParserError: /)
+
+          r = newo(
+            server_content_type: "application/json",
+            server_raw: '{"a":12,"b":"abc"}',
+          )
+          expect(r.send(m)).to eq({"a" => 12, "b" => "abc"})
+        end
+      end
+    end
+
+    describe "#robj_klass_and_attrs" do
+      let(:m) { :robj_klass_and_attrs }
+
+      # A minimum viable instance for tests below.
+      def newo(attrs = {})
+        request_klass = Class.new do
+          def self.response_klass; Response::JobsParse; end
+        end
+
+        Class.new(described_class) do
+          def server_obj; raise "This must never be called"; end
+        end.new({
+          request: request_klass.new,
+          server_raw: "server_raw",
+        }.merge(attrs))
+      end
+
+      it "validates `robj_hash_preview`" do
+        r = newo(robj_hash_preview: "abc")
+        expect { r.send(m) }.to raise_error(AttributeError, "Unknown `robj_hash_preview`: \"abc\"")
+      end
+
+      it "works for raw data" do
+        r = newo(
+          robj_hash_preview: false,
+        )
+        #expect { r.send(m) }.to raise_error(FormatError, /^Key 'status' not found: /)
+        expect(r.send(m)).to eq [Response::JobsParse, {:raw => "server_raw"}]
+      end
+
+      it "works for invalid data" do
+        # Valid JSON.
+        r = newo(
+          robj_hash_preview: {"a" => 12},
+        )
+        expect { r.send(m) }.to raise_error(FormatError, /^Key 'status' not found: /)
+      end
+
+      it "works for valid data" do
+        r = newo(
+          robj_hash_preview: {"status" => "success"},
+        )
+        expect(r.send(m)).to eq [Response::JobsParse, {:body_hash=>{"status"=>"success"}}]
+
+        r = newo(
+          robj_hash_preview: {"status" => "not-a-success"},   # Not necessarily "error".
+        )
+        expect(r.send(m)).to eq [Response::ErrorMessage, {:body_hash=>{"status"=>"not-a-success"}}]
+      end
+    end
+
+    describe "#server_obj" do
+      it "requires `request`" do
+        r = newo
+        expect { r.server_obj }.to raise_error "Attribute must be set: request"
+      end
+
+      it "generally works" do
+        # See implementation notes below.
+        r = newo(
+          httparty: (httparty = cllggr.new),
+          request: Request::JobsParse.new(api_key: "api_key", job_id: "123"),
+        )
+        expect(r.server_obj).to eq 1    # Result of `cllggr`.
+        args = httparty._calls[0]
+        expect(args).to be_a Array
+        expect(args).not_to be_empty
+      end
+    end
+  end
+end; end
+
+# Implementation notes:
+#
+# * We test class's general abilities on a real request class.
+# * Consider this great hack to debug tests easier:
+#     Class.new(described_class) do
+#      def server_obj; raise "This must never be called"; end
+#    end.new(...)