trakio-ruby 0.1.0

data/spec/trakio/initialize_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe Trakio do
+
+  subject { Trakio }
+
+  after {
+    Trakio.default_instance = nil
+  }
+
+  describe '.initialize' do
+
+    context "when an API token is provided" do
+
+      it "creates a new Trakio instance" do
+        expect(Trakio.new "my_api_token").to be_a Trakio
+      end
+
+      it "sets the API token for this instance" do
+        trakio = Trakio.new 'my_api_token'
+        expect(trakio.api_token).to eql 'my_api_token'
+      end
+
+
+      context "when a channel is provided" do
+        it "sets channel for this instance" do
+          trakio = Trakio.new "my_api_token", channel: 'my-channel'
+          expect(trakio.channel).to eql 'my-channel'
+        end
+      end
+
+      context "when a distinct_id is provided" do
+        it "sets that for this instance" do
+          trakio = Trakio.new "my_api_token", distinct_id: 'user@example.com'
+          expect(trakio.distinct_id).to eql 'user@example.com'
+        end
+      end
+
+      context "when a https option is provided" do
+        it "sets https option" do
+          trakio = Trakio.new 'my_api_token', https: false
+          expect(trakio.https).to be_false
+        end
+      end
+
+      context "when a https option isn't provided" do
+        it "defaults to true" do
+          trakio = Trakio.new 'my_api_token'
+          expect(trakio.https).to be_true
+        end
+      end
+
+      context "when a host is provided" do
+        it "sets host option" do
+          trakio = Trakio.new '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 = Trakio.new '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 "gets it from the default instance" do
+        Trakio.init "my_api_token"
+        trakio = Trakio.new
+        expect(trakio.api_token).to eql 'my_api_token'
+      end
+
+      context "when there is no default instance" do
+        it "raises an exception" do
+          expect{ Trakio.new }.to raise_error Trakio::Exceptions::Uninitiated
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/trakio/instance_methods_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe Trakio do
+
+  subject { Trakio }
+
+  after {
+    Trakio.default_instance = nil
+  }
+
+  describe '.distinct_id=' do
+
+    it "sets the distinct_id to be used by this Interface" do
+      trakio = Trakio.new 'api_token'
+      trakio.distinct_id = 'user@example.com'
+      expect(trakio.instance_variable_get('@distinct_id')).to eql 'user@example.com'
+    end
+
+    context "when this is the default Interface" do
+
+      it "raises an exception" do
+        Trakio.init 'my_api_token'
+        expect{ Trakio.distinct_id = 'user@example.com' }.to raise_error Trakio::Exceptions::NoDistinctIdForDefaultInstance
+      end
+
+    end
+
+  end
+
+  describe '.distinct_id' do
+
+    it "returns the current value" do
+      trakio = Trakio.new 'api_token'
+      trakio.instance_variable_set('@distinct_id','user@example.com')
+      expect(trakio.distinct_id).to eql 'user@example.com'
+    end
+
+  end
+
+  describe '.channel=' do
+
+    it "sets the channel to be used by this Interface" do
+      trakio = Trakio.new 'api_token'
+      trakio.channel = 'my-channel'
+      expect(trakio.instance_variable_get('@channel')).to eql 'my-channel'
+    end
+
+  end
+
+  describe '.channel' do
+
+    it "returns the current value" do
+      trakio = Trakio.new 'api_token'
+      trakio.instance_variable_set('@channel','my-channel')
+      expect(trakio.channel).to eql 'my-channel'
+    end
+
+  end
+
+  describe '.https=' do
+
+    it "sets whether https is to be used by this Interface" do
+      trakio = Trakio.new 'api_token'
+      trakio.https = false
+      expect(trakio.instance_variable_get('@https')).to be_false
+    end
+
+  end
+
+  describe '.https' do
+
+    it "returns the current value" do
+      trakio = Trakio.new 'api_token'
+      trakio.instance_variable_set('@https',false)
+      expect(trakio.https).to be_false
+    end
+
+    it "defaults to true" do
+      trakio = Trakio.new 'api_token'
+      expect(trakio.https).to be_true
+    end
+
+  end
+
+  describe '.host=' do
+
+    it "sets the host to be used by this Interface" do
+      trakio = Trakio.new 'api_token'
+      trakio.host = "lvh.me:3000"
+      expect(trakio.instance_variable_get('@host')).to eql "lvh.me:3000"
+    end
+
+  end
+
+  describe '.host' do
+
+    it "returns the current value" do
+      trakio = Trakio.new 'api_token'
+      trakio.instance_variable_set('@host',"lvh.me:3000")
+      expect(trakio.host).to eql "lvh.me:3000"
+    end
+
+    it "defaults to api.trak.io/v1" do
+      trakio = Trakio.new 'api_token'
+      expect(trakio.host).to eql "api.trak.io/v1"
+    end
+
+  end
+
+end

data/spec/trakio/track_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+
+describe Trakio do
+
+  subject { Trakio }
+
+  after {
+    Trakio.default_instance = nil
+  }
+
+  describe '.track' do
+
+    context "when a distinct_id is provided" do
+
+      context "when an event is provided" do
+
+        it "sends a track request to api.trak.io" do
+          stub = stub_request(:post, "https://api.trak.io/v1/track").
+            with(:body => {
+              token: 'my_api_token',
+              data: {
+                distinct_id: 'user@example.com',
+                event: 'my-event'
+              }
+            }).to_return(:body => {
+              status: 'success',
+              trak_id: '1234567890'
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token'
+          resp = trakio.track distinct_id: 'user@example.com', event: 'my-event'
+
+          expect(resp[:status]).to eql 'success'
+          expect(resp[:trak_id]).to eql '1234567890'
+
+          stub.should have_been_requested
+        end
+
+        context "when a channel is provided" do
+
+          it "sends a track request to api.trak.io" do
+            stub = stub_request(:post, "https://api.trak.io/v1/track").
+              with(:body => {
+                token: 'my_api_token',
+                data: {
+                  distinct_id: 'user@example.com',
+                  event: 'my-event',
+                  channel: 'my-channel'
+                }
+              }).to_return(:body => {
+                status: 'success',
+                trak_id: '1234567890'
+              }.to_json)
+
+            trakio = Trakio.new 'my_api_token'
+            resp = trakio.track distinct_id: 'user@example.com', event: 'my-event',
+              channel: 'my-channel'
+
+            expect(resp[:status]).to eql 'success'
+            expect(resp[:trak_id]).to eql '1234567890'
+
+            stub.should have_been_requested
+          end
+
+        end
+
+        context "when a channel isn't provided and there is one on the instance" do
+
+          it "sends a track request to api.trak.io" do
+            stub = stub_request(:post, "https://api.trak.io/v1/track").
+              with(:body => {
+                token: 'my_api_token',
+                data: {
+                  distinct_id: 'user@example.com',
+                  event: 'my-event',
+                  channel: 'my-channel'
+                }
+              }).to_return(:body => {
+                status: 'success',
+                trak_id: '1234567890'
+              }.to_json)
+
+            trakio = Trakio.new "my_api_token", channel: 'my-channel'
+            resp = trakio.track distinct_id: 'user@example.com', event: 'my-event'
+
+            expect(resp[:status]).to eql 'success'
+            expect(resp[:trak_id]).to eql '1234567890'
+
+            stub.should have_been_requested
+          end
+
+        end
+
+        context "when properties are provided" do
+
+          it "sends a track request to api.trak.io" do
+            stub = stub_request(:post, "https://api.trak.io/v1/track").
+              with(:body => {
+                token: 'my_api_token',
+                data: {
+                  distinct_id: 'user@example.com',
+                  event: 'my-event',
+                  channel: 'my-channel',
+                  properties: {
+                    foo:  'bar'
+                  }
+                }
+              }).to_return(:body => {
+                status: 'success',
+                trak_id: '1234567890'
+              }.to_json)
+
+            trakio = Trakio.new "my_api_token"
+            resp = trakio.track distinct_id: 'user@example.com', event: 'my-event',
+              channel: 'my-channel', properties: { foo: 'bar' }
+
+            expect(resp[:status]).to eql 'success'
+            expect(resp[:trak_id]).to eql '1234567890'
+
+            stub.should have_been_requested
+          end
+
+        end
+
+      end
+
+      context "when an event isn't provided" do
+
+        it "raises an exception" do
+          trakio = Trakio.new 'my_api_token'
+          expect { trakio.track distinct_id: 'user@example.com' }.to raise_error RuntimeError
+        end
+
+      end
+
+    end
+
+    context "when a distinct_id isn't provided" do
+
+      context "when an event is provided" do
+
+        it "raises an error" do
+          trakio = Trakio.new 'my_api_token'
+          expect { trakio.track event: 'my-event' }.to raise_error RuntimeError
+        end
+
+      end
+
+    end
+
+    context "when a distinct_id isn't provided but its set on the instance" do
+
+      context "when an event is provided" do
+
+        it "sends a track request to api.trak.io" do
+          stub = stub_request(:post, "https://api.trak.io/v1/track").
+            with(:body => {
+              token: 'my_api_token',
+              data: {
+                distinct_id: 'user@example.com',
+                event: 'my-event',
+              }
+            }).to_return(:body => {
+              status: 'success',
+              trak_id: '1234567890'
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token', distinct_id: 'user@example.com'
+          trakio.track event: 'my-event'
+
+          stub.should have_been_requested
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/trakio-ruby.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trakio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trakio-ruby"
+  spec.version       = Trakio::VERSION
+  spec.authors       = ["Matthew Spence", "Tobie Warburton"]
+  spec.email         = ["matt@trak.io", "tobie.warburton@gmail.com"]
+  spec.description   = "Official trak.io ruby library for Ruby"
+  spec.summary       = "Official trak.io ruby library for Ruby"
+  spec.homepage      = "https://github.com/trakio/trakio-ruby"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'fuubar'
+
+  spec.add_dependency 'rest_client'
+  spec.add_dependency 'pry'
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: trakio-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Spence
+- Tobie Warburton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Official trak.io ruby library for Ruby
+email:
+- matt@trak.io
+- tobie.warburton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/trakio.rb
+- lib/trakio/version.rb
+- spec/spec_helper.rb
+- spec/trakio/alias_spec.rb
+- spec/trakio/annotate_spec.rb
+- spec/trakio/class_methods_spec.rb
+- spec/trakio/indentify_spec.rb
+- spec/trakio/initialize_spec.rb
+- spec/trakio/instance_methods_spec.rb
+- spec/trakio/track_spec.rb
+- trakio-ruby.gemspec
+homepage: https://github.com/trakio/trakio-ruby
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Official trak.io ruby library for Ruby
+test_files:
+- spec/spec_helper.rb
+- spec/trakio/alias_spec.rb
+- spec/trakio/annotate_spec.rb
+- spec/trakio/class_methods_spec.rb
+- spec/trakio/indentify_spec.rb
+- spec/trakio/initialize_spec.rb
+- spec/trakio/instance_methods_spec.rb
+- spec/trakio/track_spec.rb