trakio-ruby 0.1.0

data/spec/trakio/alias_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Trakio do
+
+  subject { Trakio }
+
+  after {
+    Trakio.default_instance = nil
+  }
+
+  describe '.alias' do
+
+    context "when an array alias is provided" do
+      it "sends an array" do
+        stub = stub_request(:post, "https://api.trak.io/v1/alias").
+          with(:body => {
+            token: 'my_api_token',
+            data: {
+              distinct_id: 'user@example.com',
+              alias: [
+                'alias1@example.com',
+              ],
+            }
+          }).to_return(:body => {
+            status: 'success',
+            trak_id: '1234567890',
+            distinct_ids: ['user@example.com', 'alias1@example.com'],
+          }.to_json)
+
+        trakio = Trakio.new 'my_api_token'
+        trakio.alias distinct_id: 'user@example.com', alias: ['alias1@example.com']
+
+        stub.should have_been_requested
+      end
+    end
+
+    context "when a string alias is provided" do
+      it "sends a string" do
+        stub = stub_request(:post, "https://api.trak.io/v1/alias").
+          with(:body => {
+            token: 'my_api_token',
+            data: {
+              distinct_id: 'user@example.com',
+              alias: 'alias1@example.com',
+            }
+          }).to_return(:body => {
+            status: 'success',
+            trak_id: '1234567890',
+            distinct_ids: ['user@example.com', 'alias1@example.com'],
+          }.to_json)
+
+        trakio = Trakio.new 'my_api_token'
+        trakio.alias distinct_id: 'user@example.com', alias: 'alias1@example.com'
+
+        stub.should have_been_requested
+      end
+    end
+
+    context "when no alias is provided" do
+      it "raises an error" do
+        trakio = Trakio.new 'my_api_token'
+        expect { trakio.alias distinct_id: 'user@example.com' }.to raise_error RuntimeError
+      end
+    end
+
+    context "when no distinct_id is provided" do
+
+      context "when there is one set on the instance" do
+        it "sends a request" do
+          stub = stub_request(:post, "https://api.trak.io/v1/alias").
+            with(:body => {
+              token: 'my_api_token',
+              data: {
+                distinct_id: 'user@example.com',
+                alias: 'alias1@example.com',
+              }
+            }).to_return(:body => {
+              status: 'success',
+              trak_id: '1234567890',
+              distinct_ids: ['user@example.com', 'alias1@example.com'],
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token', distinct_id: 'user@example.com'
+          trakio.alias alias: 'alias1@example.com'
+
+          stub.should have_been_requested
+        end
+      end
+
+      context "when there is not one set on the instance" do
+        it "raises an error" do
+          trakio = Trakio.new 'my_api_token'
+          expect { trakio.alias alias: 'alias1@example.com' }.to raise_error RuntimeError
+        end
+      end
+
+    end
+
+  end
+end

data/spec/trakio/annotate_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe Trakio do
+
+  subject { Trakio }
+
+  after {
+    Trakio.default_instance = nil
+  }
+  
+	describe '.annotate' do
+
+    context "when an event is provided" do
+
+      context "when a channel is provided" do
+        it "should send a request with the channel" do
+          stub = stub_request(:post, "https://api.trak.io/v1/annotate").
+            with(:body => {
+            token: 'my_api_token',
+            data: {
+              event: 'event',
+              channel: 'channel',
+              properties: {},
+            }
+          }).to_return(:body => {
+            status: 'success',
+            trak_id: '1234567890',
+          }.to_json)
+
+          trakio = Trakio.new 'my_api_token'
+          trakio.annotate event: 'event', channel: 'channel'
+
+          stub.should have_been_requested
+        end
+      end
+
+      context "when a channel isnt provided" do
+        context "when there is a channel set on the instance" do
+          it "should send a request with the channel" do
+            stub = stub_request(:post, "https://api.trak.io/v1/annotate").
+              with(:body => {
+              token: 'my_api_token',
+              data: {
+                event: 'event',
+                channel: 'channel',
+                properties: {},
+              }
+            }).to_return(:body => {
+              status: 'success',
+              trak_id: '1234567890',
+            }.to_json)
+
+            trakio = Trakio.new 'my_api_token', channel: 'channel'
+            trakio.annotate event: 'event'
+
+            stub.should have_been_requested
+          end
+        end
+      end
+
+      context "when properties are provided" do
+        it "should send a request with the properties" do
+          stub = stub_request(:post, "https://api.trak.io/v1/annotate").
+            with(:body => {
+              token: 'my_api_token',
+              data: {
+                event: 'event',
+                properties: {
+                  details: 'details',
+                },
+              }
+            }).to_return(:body => {
+              status: 'success',
+              trak_id: '1234567890',
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token'
+          trakio.annotate event: 'event', properties: { details: 'details' }
+
+          stub.should have_been_requested
+        end
+      end
+
+      context "when properties are not provided" do
+        it "should send a request with empty properties" do
+          stub = stub_request(:post, "https://api.trak.io/v1/annotate").
+            with(:body => {
+              token: 'my_api_token',
+              data: {
+                event: 'event',
+                properties: {},
+              }
+            }).to_return(:body => {
+              status: 'success',
+              trak_id: '1234567890',
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token'
+          trakio.annotate event: 'event'
+
+          stub.should have_been_requested
+        end
+      end
+
+    end
+
+    context "when an event is not provided" do
+
+      context "when a channel is provided" do
+        it "should raise an error" do
+          trakio = Trakio.new 'my_api_token'
+          expect { trakio.annotate channel: 'channel' }.to raise_error RuntimeError
+        end
+      end
+
+      context "when properties are provided" do
+        it "should raise an error" do
+          trakio = Trakio.new 'my_api_token'
+          expect { trakio.annotate properties: { name: 'tobie' } }.to raise_error RuntimeError
+        end
+      end
+
+      context "when no arguments are provided" do
+        it "should raise an error" do
+          trakio = Trakio.new 'my_api_token'
+          expect { trakio.annotate }.to raise_error ArgumentError
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/trakio/class_methods_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+
+describe Trakio do
+
+  subject { Trakio }
+
+  after {
+    Trakio.default_instance = nil
+  }
+
+  describe '#default_instance' do
+
+    context "when a default instance hasn't been created" do
+      it "raises an exception" do
+        expect{ Trakio.default_instance }.to raise_error Trakio::Exceptions::Uninitiated
+      end
+    end
+
+    context "when a default instance has already been created" do
+      it "returns that" do
+        Trakio.init 'my_api_token'
+        expect(Trakio.default_instance).to be_a Trakio
+      end
+    end
+
+  end
+
+  describe '#init' do
+
+    context "when an API token is provided" do
+
+      it "creates a default Trakio::Interface" do
+        Trakio.init 'my_api_token'
+      end
+
+      context "when a distinct_id is provided" do
+        it "raises an exception" do
+          expect{
+            Trakio.init 'my_api_token', distinct_id: 'user@example.com'
+          }.to raise_error Trakio::Exceptions::NoDistinctIdForDefaultInstance
+        end
+      end
+
+      context "when a channel is provided" do
+        it "sets the channel option" do
+          Trakio.init 'my_api_token', channel: 'my-channel'
+          expect(Trakio.channel).to eql 'my-channel'
+        end
+      end
+
+      context "when a https is provided" do
+        it "sets https option" do
+          Trakio.init 'my_api_token', https: false
+          expect(Trakio.https).to be_false
+        end
+      end
+
+      context "when a https isn't provided" do
+        it "defaults to true" do
+          Trakio.init 'my_api_token'
+          expect(Trakio.https).to be_true
+        end
+      end
+
+      context "when a host is provided" do
+        it "sets host option" do
+          Trakio.init 'my_api_token', host: 'lvh.me:3007'
+          expect(Trakio.host).to eql 'lvh.me:3007'
+        end
+      end
+
+      context "when a host isn't provided" do
+        it "defaults to api.trak.io/v1" do
+          Trakio.init 'my_api_token'
+          expect(Trakio.host).to eql 'api.trak.io/v1'
+        end
+      end
+
+    end
+
+    context "when an API token isn't provided" do
+      it "raises an exception" do
+        expect{ Trakio.init }.to raise_error Trakio::Exceptions::InvalidToken
+      end
+    end
+
+  end
+
+  describe '#track' do
+    it "calls track on the default Trakio instance" do
+      default_instance = double(Trakio)
+
+      Trakio.default_instance = default_instance
+      expect(Trakio.default_instance).to receive(:track)
+
+      Trakio.track distinct_id: 'tobie.warburton@gmail.com', event: 'test-event'
+    end
+  end
+
+  describe '#identify' do
+    it "calls identify on the default Trakio instance" do
+      default_instance = double(Trakio)
+
+      Trakio.default_instance = default_instance
+      expect(Trakio.default_instance).to receive(:identify)
+
+      Trakio.identify
+    end
+  end
+
+  describe '#alias' do
+    it "calls alias on the default Trakio instance" do
+      default_instance = double(Trakio)
+
+      Trakio.default_instance = default_instance
+      expect(Trakio.default_instance).to receive(:alias)
+
+      Trakio.alias
+    end
+  end
+
+  describe '#annotate' do
+
+    it "calls annotate on the default Trakio instance" do
+      default_instance = double(Trakio)
+
+      Trakio.default_instance = default_instance
+      expect(Trakio.default_instance).to receive(:annotate)
+
+      Trakio.annotate
+    end
+
+  end
+
+  describe '#page_view' do
+
+    it "calls page_view on the default Trakio instance" do
+      default_instance = double(Trakio)
+
+      Trakio.default_instance = default_instance
+      expect(Trakio.default_instance).to receive(:page_view)
+
+      Trakio.page_view
+    end
+
+  end
+
+
+  describe '#distinct_id' do
+    it "raise an error" do
+      expect{ Trakio.distinct_id }.to raise_error Trakio::Exceptions::NoDistinctIdForDefaultInstance
+    end
+  end
+
+  describe '#channel' do
+
+    it "calls channel on the default Trakio instance" do
+      default_instance = double(Trakio)
+
+      Trakio.default_instance = default_instance
+      expect(Trakio.default_instance).to receive(:channel)
+
+      Trakio.channel
+    end
+
+  end
+
+end

data/spec/trakio/indentify_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Trakio do
+
+  subject { Trakio }
+
+  after {
+    Trakio.default_instance = nil
+  }
+
+  describe '.identify' do
+
+    context "when a distinct_id is provided" do
+      context "when properties are provided" do
+        it "sends an identify request" do
+          stub = stub_request(:post, "https://api.trak.io/v1/identify").
+            with(:body => {
+              token: 'my_api_token',
+              data: {
+                distinct_id: 'user@example.com',
+                properties: {
+                  name: 'Tobie',
+                },
+              }
+            }).to_return(:body => {
+              status: 'success',
+              trak_id: '1234567890',
+              distinct_ids: ['user@example.com'],
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token'
+          trakio.identify distinct_id: 'user@example.com', properties: { name: 'Tobie' }
+
+          stub.should have_been_requested
+        end
+      end
+    end
+
+    context "when a distinct_id isn't provided but is set on instance" do
+      context "when properties are provided" do
+        it "sends an identify request" do
+          stub = stub_request(:post, "https://api.trak.io/v1/identify").
+            with(:body => {
+              token: 'my_api_token',
+              data: {
+                distinct_id: 'user@example.com',
+                properties: {
+                  name: 'Tobie',
+                },
+              }
+            }).to_return(:body => {
+              status: 'success',
+              trak_id: '1234567890',
+              distinct_ids: ['user@example.com'],
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token', distinct_id: 'user@example.com'
+          trakio.identify properties: { name: 'Tobie' }
+
+          stub.should have_been_requested
+        end
+      end
+    end
+
+    context "when a distinct_id isn't provided" do
+
+      context "when properties are provided" do
+        it "raises an error" do
+          trakio = Trakio.new 'my_api_token'
+          expect { trakio.identify properties: { name: 'Tobie' } }.to raise_error RuntimeError
+        end
+      end
+
+      context "when properties aren't provided" do
+        it "raises an error" do
+          trakio = Trakio.new 'my_api_token', distinct_id: 'user@example.com'
+          expect { trakio.identify }.to raise_error ArgumentError
+        end
+      end
+
+    end
+
+  end
+
+end