adknowledge 0.0.3

data/spec/adknowledge/integrated_spec.rb

@@ -0,0 +1,378 @@
+require "spec_helper"
+
+describe Adknowledge::Integrated do
+  before do
+    Adknowledge.token = '3a9f34d1eee18880bbc74254ddf06448'
+  end
+
+  let :email_hashes do
+    [
+      { recipient: '004c58927df600d73d58c817bafc2155',
+        list: 9250,
+        domain: 'hotmail.com',
+        countrycode: 'US',
+        state: 'MO'
+      },
+      { recipient: 'a2a8c7a5ce7c4249663803c7d040401f',
+        list: 9250,
+        domain: 'mail.com',
+        countrycode: 'CA'
+      }
+    ]
+  end
+
+  let :request_xml do
+    %q[
+<?xml version="1.0" encoding="UTF-8"?>
+<request>
+<email>
+<recipient>004c58927df600d73d58c817bafc2155</recipient>
+<list>9250</list>
+<domain>hotmail.com</domain>
+<countrycode>US</countrycode>
+<state>MO</state>
+</email>
+<email>
+<recipient>a2a8c7a5ce7c4249663803c7d040401f</recipient>
+<list>9250</list>
+<domain>rr.com</domain>
+<countrycode>CA</countrycode>
+</email>
+</request>].gsub(/\n/, '')
+  end
+
+  let :domain1 do
+    "fga.example.com"
+  end
+
+  let :integrated do
+    described_class.new domain: domain1,
+                        subid: 101,
+                        test: true,
+                        recipients: email_hashes
+  end
+
+  context "#recipients=" do
+    subject do
+      described_class.new
+    end
+
+    context "valid" do
+
+      let :email_hashes do
+        [
+          { recipient: '004c58927df600d73d58c817bafc2155',
+            list: 9250,
+            domain: 'hotmail.com',
+            countrycode: 'US',
+            state: 'MO'
+          },
+          { recipient: 'a2a8c7a5ce7c4249663803c7d040401f',
+            list: 9250,
+            domain: 'rr.com',
+            countrycode: 'CA'
+          }
+        ]
+      end
+
+      before do
+        subject.recipients = email_hashes
+      end
+
+      it "sets the request" do
+        expect(subject.request).to eql request_xml
+      end
+
+      it "keeps the recipients" do
+        expect(subject.recipients).to eql email_hashes
+      end
+    end # valid
+
+    context "missing mandatory field" do
+
+      let :email_hashes do
+        [
+          { recipient: '004c58927df600d73d58c817bafc2155',
+            list: 9250
+          },
+          { recipient: 'a2a8c7a5ce7c4249663803c7d040401f',
+            list: 9250,
+            domain: 'rr.com',
+            countrycode: 'CA'
+          }
+        ]
+      end
+
+      it "raises an exception" do
+        expect{
+          subject.recipients = email_hashes
+        }.to raise_error ArgumentError
+      end
+
+    end # missing mandatory field
+
+  end # #recipients=
+
+  context "#query_params" do
+
+    let :domain2 do
+      "fga.examplemail.com"
+    end
+
+    context "with domain option" do
+
+      let :query_params do
+        { token: "3a9f34d1eee18880bbc74254ddf06448",
+          idomain: domain1,
+          cdomain: domain1,
+          request: request_xml,
+          subid: 101,
+          test: 1
+        }
+      end
+
+      subject do
+        integrated.query_params
+      end
+
+      it "has the token" do
+        expect(subject[:token]).to eql "3a9f34d1eee18880bbc74254ddf06448"
+      end
+
+      it "has the idomain" do
+        expect(subject[:idomain]).to eql domain1
+      end
+
+      it "has the cdomain" do
+        expect(subject[:cdomain]).to eql domain1
+      end
+
+      it "has the test option" do
+        expect(subject[:test]).to eql 1
+      end
+
+      it "has the subid" do
+        expect(subject[:subid]).to eql 101
+      end
+
+    end # with domain option
+
+    context "with cdomain/idomian" do
+
+      let :query_params do
+        { token: "3a9f34d1eee18880bbc74254ddf06448",
+          idomain: domain1,
+          cdomain: domain2,
+          request: request_xml,
+          subid: 102,
+          test: false
+        }
+      end
+
+      let :integrated do
+        described_class.new idomain: domain1,
+                            cdomain: domain2,
+                            subid: 102,
+                            test: false,
+                            recipients: email_hashes
+      end
+
+      subject do
+        integrated.query_params
+      end
+
+      it "has the cdomain" do
+        expect(subject[:cdomain]).to eql domain2
+      end
+
+      it "has the idomain" do
+        expect(subject[:idomain]).to eql domain1
+      end
+
+    end
+
+  end # #query_params
+
+  context "before map" do
+
+    context "#mapped?" do
+
+      subject do
+        integrated.mapped?
+      end
+
+      it "should be false" do
+        expect(subject).to be_false
+      end
+
+    end # #mapped?
+
+    context "#mapped_recipients" do
+
+      subject do
+        integrated.mapped_recipients
+      end
+
+      it "has no mapped recipients" do
+        expect(subject).to be_empty
+      end
+
+    end # #mapped_recipients
+
+    context "#errored_recipients" do
+
+      subject do
+        integrated.errored_recipients
+      end
+
+      it "has no errored recipients" do
+        expect(subject).to be_empty
+      end
+
+    end # #errored_recipients
+
+  end # before map
+
+  context "after map" do
+
+    context "single results" do
+
+      before do
+        VCR.use_cassette :map_single_success, record: :once do
+          integrated.map!
+        end
+      end
+
+      context "#mapped?" do
+
+        subject do
+          integrated.mapped?
+        end
+
+        it "should be true" do
+          expect(subject).to be_true
+        end
+
+      end # #mapped?
+
+      context "#mapped_recipients" do
+
+        subject do
+          integrated.mapped_recipients
+        end
+
+        it "has a mapped recipient" do
+          expect(subject.size).to eql 1
+        end
+
+        it "has a creative" do
+          expect(subject.first['creative']).to be_a Hash
+          expect(subject.first['creative']['body']).to be_a String
+          expect(subject.first['creative']['subject']).to eql "Faxes delivered to your email."
+        end
+      end
+
+      context "#errored_recipients" do
+
+        subject do
+          integrated.errored_recipients
+        end
+
+        it "has an errored recipient" do
+          expect(subject.size).to eql 1
+        end
+
+        it "has an error error" do
+          expect(subject.first['error']).to be_a Hash
+          expect(subject.first['error']['num']).to eql "10"
+          expect(subject.first['error']['str']).to eql "Domain is suppressed\n"
+        end
+
+      end # #errored_recipients
+
+    end # single results
+
+    context "multiple results" do
+
+      let :email_hashes do
+        [
+          { recipient: '004c58927df600d73d58c817bafc2155',
+            list: 9250,
+            domain: 'hotmail.com',
+            countrycode: 'US',
+            state: 'MO'
+          },
+          { recipient: '004c58927df600d73d58c817bafc2156',
+            list: 9250,
+            domain: 'aol.com'
+          },
+          { recipient: 'a2a8c7a5ce7c4249663803c7d040401f',
+            list: 9250,
+            domain: 'mail.com',
+            countrycode: 'CA'
+          },
+          { recipient: 'a2a8c7a5ce7c4249663803c7d040401e',
+            list: 9250,
+            domain: 'mail.com'
+          }
+        ]
+      end
+
+      before do
+        VCR.use_cassette :map_multi_success, record: :once do
+          integrated.map!
+        end
+      end
+
+      context "#mapped?" do
+
+        subject do
+          integrated.mapped?
+        end
+
+        it "should be true" do
+          expect(subject).to be_true
+        end
+
+      end # #mapped?
+
+      context "#mapped_recipients" do
+
+        subject do
+          integrated.mapped_recipients
+        end
+
+        it "has a mapped recipient" do
+          expect(subject.size).to eql 2
+        end
+
+        it "has a creative" do
+          expect(subject.first['creative']).to be_a Hash
+          expect(subject.first['creative']['body']).to be_a String
+          expect(subject.first['creative']['subject']).to eql "Early-bird cruise specials"
+        end
+      end
+
+      context "#errored_recipients" do
+
+        subject do
+          integrated.errored_recipients
+        end
+
+        it "has an errored recipient" do
+          expect(subject.size).to eql 2
+        end
+
+        it "has an error error" do
+          expect(subject.first['error']).to be_a Hash
+          expect(subject.first['error']['num']).to eql "10"
+          expect(subject.first['error']['str']).to eql "Domain is suppressed\n"
+        end
+
+      end # #errored_recipients
+
+    end # multiple results
+
+  end # after map
+
+end # Adknowledge::Integrated

data/spec/adknowledge/performance_spec.rb

@@ -0,0 +1,320 @@
+require 'spec_helper'
+
+describe Adknowledge::Performance do
+  before do
+    Adknowledge.token = 'b6d8610998e883b3a460fd2fcf71ead4'
+  end
+
+  context '#select' do
+    it 'changes metric selection' do
+      expect{
+        subject.select(:revenue)
+      }.to change(subject, :measures).
+           from({}).
+           to({revenue:1})
+    end
+
+    it 'supports multiple selections' do
+      expect{
+        subject.select(:revenue, :paid_clicks)
+      }.to change(subject, :measures).
+           from({}).
+           to({revenue:1, paid_clicks:1})
+    end
+
+    it 'supports chained selections' do
+      subject.select(:revenue)
+      expect{
+        subject.select(:paid_clicks)
+      }.to change(subject, :measures).
+           from({revenue:1}).
+           to({revenue:1, paid_clicks:1})
+    end
+
+    it 'errors on invalid measure' do
+      expect{ subject.select(:unvalid) }.to raise_error(ArgumentError)
+    end
+  end # #select
+
+  context '#group_by' do
+    it 'changes the dimension groupings' do
+      expect{
+        subject.group_by(:subid)
+      }.to change(subject, :dimensions).
+           from({}).
+           to({subid:1})
+    end
+
+    it 'supports multiple groupings' do
+      expect{
+        subject.group_by(:report_date, :revenue_type)
+      }.to change(subject, :dimensions).
+           from({}).
+           to({report_date:1, revenue_type:1})
+    end
+
+    it 'supports chained groupings' do
+      subject.group_by(:report_date)
+      expect{
+        subject.group_by(:revenue_type)
+      }.to change(subject, :dimensions).
+           from({report_date:1}).
+           to({report_date:1, revenue_type:1})
+    end
+
+    it 'errors on invalid dimension' do
+      expect{ subject.select(:inpossible) }.to raise_error(ArgumentError)
+    end
+  end # #group_by
+
+  context '#where' do
+    it 'changes the filter criteria' do
+      expect{
+        subject.where(start_date:0)
+      }.to change(subject, :filter).
+           from({product_guid: '*', product_id: '2'}).
+           to({product_guid: '*', product_id: '2', start_date:'0'})
+    end
+
+    it 'supports chained filtering' do
+      subject.where(start_date:0)
+      expect{
+        subject.where(domain_group:'AOL Group')
+      }.to change(subject, :filter).
+           from({product_guid: '*', product_id: '2', start_date:'0'}).
+           to({product_guid: '*', product_id: '2', start_date:'0', domain_group:'AOL Group'})
+    end
+
+    it 'errors on invalid filter' do
+      expect{ subject.where(revenue:0) }.to raise_error(ArgumentError)
+    end
+  end # #where
+
+  context '#limit' do
+    it 'sets the limit option' do
+      expect{
+        subject.limit(10)
+      }.to change(subject, :options).
+           from({}).
+           to({limit:"10"})
+    end
+
+    it 'supports chaining' do
+      expect(
+        subject.limit(10)
+      ).to be_a Adknowledge::Performance
+    end
+
+    it 'errors on invalid limit' do
+      expect{ subject.limit(:test) }.to raise_error(ArgumentError)
+    end
+  end # #limit
+
+  context '#sort' do
+    it 'sets the sort option' do
+      expect{
+        subject.sort(3)
+      }.to change(subject, :sort_option).
+           from(nil).
+           to("3")
+    end
+
+    it 'supports chaining' do
+      expect(
+        subject.sort(5)
+      ).to be_a Adknowledge::Performance
+    end
+
+    it 'errors on invalid sort' do
+      expect{ subject.limit('test') }.to raise_error(ArgumentError)
+    end
+  end # #sort
+
+  context '#full' do
+    it 'sets the full option' do
+      expect{
+        subject.full(true)
+      }.to change(subject, :options).
+           from({}).
+           to({full:"1"})
+    end
+
+    it 'supports chaining' do
+      expect(
+        subject.full(false)
+      ).to be_a Adknowledge::Performance
+    end
+
+    it 'errors on invalid full' do
+      expect{ subject.full('test') }.to raise_error(ArgumentError)
+    end
+  end # #full
+
+  context '#nocache' do
+    it 'sets the nocache option' do
+      expect{
+        subject.nocache(true)
+      }.to change(subject, :options).
+           from({}).
+           to({nocache:"1"})
+    end
+
+    it 'supports chaining' do
+      expect(
+        subject.nocache(false)
+      ).to be_a Adknowledge::Performance
+    end
+
+    it 'errors on invalid nocache' do
+      expect{ subject.nocache('test') }.to raise_error(ArgumentError)
+    end
+  end # #nocache
+
+  context '#display_all' do
+    it 'sets the display_all option' do
+      expect{
+        subject.display_all(true)
+      }.to change(subject, :options).
+           from({}).
+           to({all:"1"})
+    end
+
+    it 'supports chaining' do
+      expect(
+        subject.display_all(false)
+      ).to be_a Adknowledge::Performance
+    end
+
+    it 'errors on invalid display_all' do
+      expect{ subject.display_all('test') }.to raise_error(ArgumentError)
+    end
+  end # #display_all
+
+  context '#pivot' do
+    before do
+      subject.group_by :country_cd
+    end
+
+    it 'sets a basic pivot' do
+      expect{
+        subject.pivot :country_cd
+      }.to change(subject, :pivot_options).
+           from({}).
+           to({pivot: "country_cd"})
+    end
+
+    it 'only allows a single basic pivot' do
+      expect{ subject.pivot(:one, :two) }.to raise_error(ArgumentError)
+    end
+
+    it 'only allows grouped dimensions to be pivoted on' do
+      expect{ subject.pivot(:report_date) }.to raise_error(ArgumentError)
+    end
+
+    it 'sets a sum pivot' do
+      subject.group_by :country_cd
+      expect{
+        subject.pivot(sum: :revenue)
+      }.to change(subject, :pivot_options).
+           from({}).
+           to({sum: :revenue})
+    end
+
+    it 'only allows measurements to be summed' do
+      expect{ subject.pivot(sum: :ilresponsible) }.to raise_error(ArgumentError)
+    end
+
+    it 'replaces a previous pivot' do
+      subject.pivot :country_cd
+      expect{
+        subject.pivot(sum: :paid_clicks)
+      }.to change(subject, :pivot_options).
+           from({pivot: "country_cd"}).
+           to({sum: :paid_clicks})
+    end
+
+    it 'only allows "sum "or "count"' do
+      expect{ subject.pivot unlogical: :paid_clicks }.to raise_error(ArgumentError)
+    end
+  end # #pivot
+
+  context '#query_params' do
+
+    let :performance do
+      described_class.new.where(start_date:1).
+        select(:revenue,:paid_clicks).
+        where(domain_group: 'AOL Group').
+        group_by(:subid, :report_date).
+        pivot(:report_date).
+        nocache(true).
+        display_all(true).
+        full(true).
+        sort(2).
+        limit(20)
+    end
+
+    let :query_params do
+      { token:'b6d8610998e883b3a460fd2fcf71ead4',
+        start_date:'1',
+        measures:'revenue,paid_clicks',
+        domain_group: 'AOL Group',
+        dimensions:'subid,report_date',
+        product_guid: '*',
+        pivot: 'report_date',
+        product_id: '2',
+        nocache:'1',
+        full:'1',
+        sort:'2',
+        all:'1',
+        limit:'20'
+      }
+    end
+
+    subject do
+      performance.query_params
+    end
+
+    it 'creates query_params' do
+      expect(subject).to eql(query_params)
+    end
+  end # #query_params
+
+  context '#records' do
+
+    let :performance do
+      described_class.new.where(start_date:1).
+        select(:revenue,:paid_clicks).
+        group_by(:subid, :report_date).
+        limit(20)
+    end
+
+    before do
+      VCR.use_cassette :performance, record: :once do
+        performance.records
+      end
+    end
+
+    subject do
+      performance.records
+    end
+
+    it 'has results' do
+      expect(subject).to be_an Array
+    end
+
+    it 'has the correct dimensions' do
+      expect(subject.first).to have_key 'subid'
+      expect(subject.first).to have_key 'report_date'
+    end
+
+    it 'has the correct measures' do
+      expect(subject.first).to have_key 'paid_clicks'
+      expect(subject.first).to have_key 'revenue'
+    end
+
+    it 'has the correct count' do
+      expect(subject.size).to eql 20
+    end
+
+  end
+end