trakio-ruby 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f0f9ac5b8ceaa20fd8a33d9f461a5e86c6be2ee
-  data.tar.gz: b8752c480a4f6283c43f4e814cabd24bdaddcf70
+  metadata.gz: 7197ea21e8c7439a450e60da07fd3578341f0bbd
+  data.tar.gz: 8781505a279089e009d40ed3b9bb30ccb920a20c
 SHA512:
-  metadata.gz: 7f054a3bfde7856c73967229185e4be803e971c66fda25d3c6a48355268deb903478b666175c5f6dff31d017c76f8c99755d6b6fb3fc5b370660597ed47487fc
-  data.tar.gz: b7b930459be4683ba41b95f305de49d43c42c04dc90ef2a167ae820ff317ff03174ffff400b7ead85dce2d35e1fcf067c164f2abad785c14ee8905496ac4e314
+  metadata.gz: 5ebd1fb4edd5aa85ef6c087556994cb86c86a864ae500453b11d8736c4154e019a4bf11f3e59fee3d1d2890270fbfecb02a71f1790ff6ac9c5d406c111ef8eed
+  data.tar.gz: 1c7d375387fad1e594692fe84a09b860e01489b31242a8b2e7e526cb4c54548a9f87448b6d9ea19102e321d00d0a9e231a8ee2b94c22eecd7accfa735c44edd7

data/README.md

@@ -31,7 +31,7 @@ For more indepth documentation see: http://docs.trak.io/ruby.html
     trakio = Trakio.new 'my_api_token'
     # track my-event
     resp = trakio.track distinct_id: 'user@example.com', event: 'my-event'
-    # resp will look like { 'status': 'success', 'trak_id': '12345' }
+    # resp will look like { 'status': 'success' }
 ```
 
 ### Creating a default instance, and then tracking an event.
@@ -39,22 +39,23 @@ For more indepth documentation see: http://docs.trak.io/ruby.html
     # set token on default instance
     Trakio.init 'my_api_token'
     # track our event
-    resp = Trakio.track distinct_id: 'user@example.com', event: 'my-event'
-    # resp will look like { 'status': 'success', 'trak_id': '12345' }
+    resp = Trakio.track distinct_id: 'user@example.com', company_id: 'acme_ltd', event: 'my-event'
+    # resp will look like { 'status': 'success' }
 ```
 
+
 ### Creating an instance and aliasing an entry
 ```ruby
     # set token on default instance
     Trakio.init 'my_api_token'
 
     resp = Trakio.alias distinct_id: 'u1@example.com', alias: ['u2@example.com']
-    # resp will look like { 'status': 'success', 'trak_id': '12345', 'distinct_ids': ['u1@example.com', 'u2@example.com'] }
+    # resp will look like { 'status': 'success' }
 
     # an equivilent is shown below
 
     resp = Trakio.alias distinct_id: 'u1@example.com', alias: 'u2@example.com'
-    # resp will look like { 'status': 'success', 'trak_id': '12345', 'distinct_ids': ['u1@example.com', 'u2@example.com'] }
+    # resp will look like { 'status': 'success' }
 ```
 
 ### Creating an instance and using identify
@@ -63,7 +64,16 @@ For more indepth documentation see: http://docs.trak.io/ruby.html
     Trakio.init 'my_api_token'
 
     resp = Trakio.identify distinct_id: 'user@example.com', properties: { name: 'Tobie' }
-    # resp will look like { 'status': 'success', 'trak_id': '12345', 'distinct_ids': ['user@example.com'] }
+    # resp will look like { 'status': 'success' }
+```
+
+### Creating an instance and using company
+```ruby
+    # set token on default instance
+    Trakio.init 'my_api_token'
+
+    resp = Trakio.company company_id: 'acme_ltd', properties: { name: 'Tobie' }
+    # resp will look like { 'status': 'success' }
 ```
 
 ### Creating an instance and using annotate
@@ -72,7 +82,7 @@ For more indepth documentation see: http://docs.trak.io/ruby.html
     Trakio.init 'my_api_token'
 
     resp = Trakio.annotate event: 'event', channel: 'channel'
-    # resp will look like { 'status': 'success', 'trak_id': '12345', 'properties': {} }
+    # resp will look like { 'status': 'success' }
 ```
 
 ## Creating and Running Tests

data/lib/trakio/alias.rb

@@ -0,0 +1,30 @@
+class Trakio
+  class Alias < EndPoint
+
+    def run p = {}
+      alias_ = p[:alias]
+      distinct_id = p[:distinct_id] || self.distinct_id
+      check_parameters alias_, distinct_id
+
+      params = {
+        distinct_id: distinct_id,
+        alias: alias_,
+      }
+      
+      send_request('alias', params)
+    end
+
+    def check_parameters alias_, distinct_id
+      unless distinct_id
+        raise Trakio::Exceptions::MissingParameter.new('The `distinct_id` parameter must be provided.')
+      end
+      unless alias_
+        raise Trakio::Exceptions::MissingParameter.new('The `alias` parameter must be provided.')
+      end
+      unless alias_.is_a?(String) or alias_.is_a?(Array)
+        raise Trakio::Exceptions::InvalidParameter.new('The `alias` parameter must be a string or an array.')
+      end
+    end
+
+  end
+end

data/lib/trakio/annotate.rb

@@ -0,0 +1,29 @@
+class Trakio
+  class Annotate < EndPoint
+
+    def run p = {}
+      event = p[:event]
+      properties = p[:properties] || {}
+      channel = p[:channel] || self.channel
+      check_parameters event, properties
+
+      params = {
+        event: event
+      }
+      params[:channel] = channel if channel
+      params[:properties] = properties if properties
+
+      send_request('annotate', params)
+    end
+
+    def check_parameters event, properties
+      unless event
+        raise Trakio::Exceptions::MissingParameter.new("The `event` parameter must be provided.")
+      end
+      unless properties.is_a?(Hash)
+        raise Trakio::Exceptions::InvalidParameter.new("The `properties` parameter must be a hash.")
+      end
+    end
+
+  end
+end

data/lib/trakio/company.rb

@@ -0,0 +1,41 @@
+class Trakio
+  class Company < EndPoint
+
+    def run p = {}
+      properties = p[:properties] || {}
+      company_id = p[:company_id] || self.company_id
+      check_parameters company_id, properties, (p[:people_distinct_ids] || [])
+
+      params = {
+        company_id: company_id,
+        properties: properties,
+      }
+      distinct_ids = distinct_ids_from_params p
+      params[:people_distinct_ids] = distinct_ids unless distinct_ids.empty?
+
+      send_request 'company', params
+    end
+
+    def distinct_ids_from_params p
+      ids = p[:people_distinct_ids] || []
+      distinct_id = p[:distinct_id] || self.distinct_id
+      ids << distinct_id if distinct_id
+      ids.reject!(&:nil?)
+      ids.map!(&:to_s)
+      ids
+    end
+
+    def check_parameters company_id, properties, distinct_ids
+      if !company_id
+        raise Trakio::Exceptions::MissingParameter.new('The `company_id` parameter must be provided.')
+      end
+      if !properties.is_a?(Hash)
+        raise Trakio::Exceptions::InvalidParameter.new("The `properties` parameter must be a hash.")
+      end
+      if !distinct_ids.is_a?(Array)
+        raise Trakio::Exceptions::InvalidParameter.new('The `people_distinct_ids` parameter must be an array.')
+      end
+    end
+
+  end
+end

data/lib/trakio/end_point.rb

@@ -0,0 +1,68 @@
+class Trakio
+  class EndPoint
+
+    extend Forwardable
+
+    attr_accessor :trakio
+    def_delegator :@trakio, :api_token
+    def_delegator :@trakio, :https
+    def_delegator :@trakio, :host
+    def_delegator :@trakio, :channel
+    def_delegator :@trakio, :distinct_id
+    def_delegator :@trakio, :company_id
+
+    def initialize trakio
+      self.trakio ||= trakio
+    end
+
+    protected
+
+      def send_request endpoint, params
+        protocol = https ? "https" : "http"
+        url = "#{protocol}://#{host}/#{endpoint}"
+        data = { token: api_token, data: params }.to_json
+        resp = RestClient.post url, data, :content_type => :json, :accept => :json
+        result = JSON.parse(resp.body, :symbolize_names => true)
+        return result if result[:status] == 'success'
+
+        # status must be error
+        # here we will raise the required exception as in the API
+        exception = constantize(result[:exception].sub! 'TrakioAPI::', 'Trakio::') # name of the class
+        message = result[:message] # extra information for the exception
+        raise exception.new(message)
+      end
+
+      def constantize camel_cased_word # Taken from ActiveSupport
+        names = camel_cased_word.split('::')
+
+        # Trigger a builtin NameError exception including the ill-formed constant in the message.
+        Object.const_get(camel_cased_word) if names.empty?
+
+        # Remove the first blank element in case of '::ClassName' notation.
+        names.shift if names.size > 1 && names.first.empty?
+
+        names.inject(Object) do |constant, name|
+          if constant == Object
+            constant.const_get(name)
+          else
+            candidate = constant.const_get(name)
+            next candidate if constant.const_defined?(name, false)
+            next candidate unless Object.const_defined?(name)
+
+            # Go down the ancestors to check it it's owned
+            # directly before we reach Object or the end of ancestors.
+            constant = constant.ancestors.inject do |const, ancestor|
+              break const    if ancestor == Object
+              break ancestor if ancestor.const_defined?(name, false)
+              const
+            end
+
+            # owner is in Object, so raise
+            constant.const_get(name, false)
+          end
+        end
+      end
+
+
+  end
+end

data/lib/trakio/exceptions.rb

@@ -0,0 +1,22 @@
+class Trakio
+
+  class Exceptions
+    class Uninitiated < StandardError; end
+    class NoDistinctIdForDefaultInstance < StandardError; end
+    class NoCompanyIdForDefaultInstance < StandardError; end
+    class DataObjectInvalidJson < StandardError; end
+    class DataObjectInvalidBase64 < StandardError; end
+    class DataObjectInvalidType < StandardError; end
+    class InvalidToken < StandardError; end
+    class MissingParameter < StandardError; end
+    class InvalidParameter < StandardError; end
+    class MissingProperty < StandardError; end
+    class InvalidProperty < StandardError; end
+    class RouteNotFound < StandardError; end
+    class PropertiesObjectInvalid < StandardError; end
+    class RequestInvalidJson < StandardError; end
+    class RevenuePropertyInvalid < StandardError; end
+    class InternalServiceError < StandardError; end
+  end
+
+end

data/lib/trakio/identify.rb

@@ -0,0 +1,66 @@
+class Trakio
+  class Identify < EndPoint
+
+    def run p = {}
+      properties = p[:properties] || {}
+      distinct_id = p[:distinct_id] || self.distinct_id
+      company_id = p[:company_id] || self.company_id
+      check_parameters distinct_id, properties
+      properties = process_companies company_id, properties
+
+      params = {
+        distinct_id: distinct_id,
+        properties: properties
+      }
+
+      send_request 'identify', params
+    end
+
+    def process_companies company_id, properties
+
+      # String company should be moved to company_name
+      if properties[:company].is_a? String
+        properties[:company_name] = properties.delete :company
+      end
+
+      # Company must be an array
+      [:company, :companies].each do |x|
+        properties[x] ||= []
+        unless properties[x].is_a?(Array)
+          properties[x] = [properties[x]]
+        end
+      end
+
+      # Merge companies and company
+      properties[:company] += properties.delete(:companies) || []
+
+      check_companies properties[:company]
+
+      # Inject current company
+      if company_id && properties[:company].none?{ |x| x[:company_id] == company_id }
+        properties[:company] << { company_id: company_id }
+      end
+
+      # Clean up company
+      properties.delete(:company) if properties[:company].empty?
+
+      properties
+    end
+
+    def check_parameters distinct_id, properties
+      unless properties.is_a?(Hash)
+        raise Trakio::Exceptions::InvalidParameter.new("The `properties` parameter must be a hash.")
+      end
+      unless distinct_id
+        raise Trakio::Exceptions::MissingParameter.new('The `distinct_id` parameter must be provided.')
+      end
+    end
+
+    def check_companies companies
+      unless companies.all?{ |x| x.is_a?(Hash) } && companies.all?{ |x| x.include? :company_id }
+        raise Trakio::Exceptions::InvalidProperty.new('The `companies` property must be an array of hashes each with a value for `company_id`')
+      end
+    end
+
+  end
+end

data/lib/trakio/track.rb

@@ -0,0 +1,72 @@
+class Trakio
+  class Track < EndPoint
+
+    def run p = {}
+      event = p[:event]
+      distinct_id = p[:distinct_id] || self.distinct_id
+      company_id = p[:company_id] || self.company_id
+      channel = p[:channel] || self.channel
+      properties = p[:properties] || {}
+      check_parameters event, distinct_id, company_id, properties
+
+      params = {
+        event: event
+      }
+      params[:time] = process_time p[:time]
+      params[:channel] = channel if channel
+      params[:properties] = properties if properties && !properties.empty?
+      params[:company_id] = company_id if company_id
+      params[:distinct_id] = distinct_id if distinct_id
+
+      send_request('track', params)
+    end
+
+    def page_view p
+      args = { event: 'Page view' }
+      distinct_id = p[:distinct_id] || self.distinct_id
+      url = p[:url]
+      title = p[:title]
+      check_page_view_parameters url
+
+      properties = {
+        url: url,
+      }
+      properties[:title] = title if title
+      args[:properties] = properties
+      args[:distinct_id] = distinct_id if distinct_id
+
+      run args  # right now page_view is an alias of track
+    end
+
+    def process_time time
+      if time
+        if !time.is_a? String
+          time.iso8601
+        else
+          time
+        end
+      else
+        DateTime.now.iso8601
+      end
+    end
+
+    def check_parameters event, distinct_id, company_id, properties
+      unless event
+        raise Trakio::Exceptions::MissingParameter.new("The `event` parameter must be provided.")
+      end
+      unless distinct_id || company_id
+        raise Trakio::Exceptions::MissingParameter.new('Either a `company_id` or `distinct_id` parameter must be provided.')
+      end
+      unless properties.is_a?(Hash)
+        raise Trakio::Exceptions::InvalidParameter.new("The `properties` parameter must be a hash.")
+      end
+    end
+
+    def check_page_view_parameters url
+      unless url
+        raise Trakio::Exceptions::InvalidParameter.new("The `url` parameter must be provided.")
+      end
+    end
+
+  end
+end

data/lib/trakio/version.rb

@@ -1,3 +1,3 @@
 class Trakio
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/lib/trakio.rb

@@ -1,3 +1,10 @@
+require "trakio/end_point"
+require "trakio/alias"
+require "trakio/annotate"
+require "trakio/company"
+require "trakio/exceptions"
+require "trakio/identify"
+require "trakio/track"
 require "trakio/version"
 require "rest_client"
 require "json"
@@ -6,20 +13,12 @@ require "date"
 
 class Trakio
 
-  class Exceptions
-    class Uninitiated < StandardError; end
-    class NoDistinctIdForDefaultInstance < StandardError; end
-    class DataObjectInvalidJson < StandardError; end
-    class DataObjectInvalidBase64 < StandardError; end
-    class DataObjectInvalidType < StandardError; end
-    class InvalidToken < StandardError; end
-    class MissingParameter < StandardError; end
-    class RouteNotFound < StandardError; end
-    class PropertiesObjectInvalid < StandardError; end
-    class RequestInvalidJson < StandardError; end
-    class RevenuePropertyInvalid < StandardError; end
-    class InternalServiceError < StandardError; end
-  end
+  attr_accessor :api_token
+  attr_accessor :https
+  attr_accessor :host
+  attr_accessor :channel
+  attr_accessor :distinct_id
+  attr_accessor :company_id
 
   class << self
 
@@ -27,6 +26,7 @@ class Trakio
       api_token, params = args
       raise Trakio::Exceptions::InvalidToken.new('Missing API Token') unless api_token
       raise Trakio::Exceptions::NoDistinctIdForDefaultInstance if params and params.has_key?(:distinct_id)
+      raise Trakio::Exceptions::NoCompanyIdForDefaultInstance if params and params.has_key?(:company_id)
       @default_instance = Trakio.new(*args)
     end
 
@@ -39,13 +39,15 @@ class Trakio
       @default_instance = instance
     end
 
-    def distinct_id
+    def distinct_id value=nil
       raise Trakio::Exceptions::NoDistinctIdForDefaultInstance
     end
+    alias :distinct_id= :distinct_id
 
-    def distinct_id=(distinct_id)
-      raise Trakio::Exceptions::NoDistinctIdForDefaultInstance
+    def company_id value=nil
+      raise Trakio::Exceptions::NoCompanyIdForDefaultInstance
     end
+    alias :company_id= :company_id
 
     def method_missing(method, *args, &block)
       # passes to the default_instance so that
@@ -55,14 +57,6 @@ class Trakio
 
   end
 
-  attr_accessor :api_token
-
-  # the following are set via params
-  attr_accessor :https
-  attr_accessor :host
-  attr_accessor :channel # channel is some form of category
-  attr_accessor :distinct_id
-
   def initialize(*args)
     api_token, params = args
     api_token = Trakio.default_instance.api_token unless api_token
@@ -71,158 +65,33 @@ class Trakio
     @https = true
     @host = 'api.trak.io/v1'
 
-    %w{https host channel distinct_id}.each do |name|
+    %w{https host channel distinct_id company_id}.each do |name|
       instance_variable_set("@#{name}", params[name.to_sym]) if params && params.has_key?(name.to_sym)
     end
   end
 
-  def track(parameters)
-    parameters.default = nil
-
-    event = parameters[:event] or raise "No event specified"
-
-    channel = parameters[:channel]
-    channel = @channel unless channel
-
-    properties = parameters[:properties]
-
-    params = {
-      distinct_id: distinct_id_from_parameters(parameters),
-      event: event,
-    }
-    if parameters[:time] # if specified
-      params[:time] = parameters[:time]
-      params[:time] = params[:time].iso8601 unless params[:time].is_a? String
-    else # if nots specified default to now
-      params[:time] = DateTime.now.iso8601
-    end
-    params[:channel] = channel if channel
-    params[:properties] = properties if properties
-
-    send_request('track', params)
-  end
-
-  def identify(parameters)
-    parameters.default = nil
-
-    properties = parameters[:properties]
-    raise "Properties must be specified" unless properties and properties.length > 0
-
-    params = {
-      distinct_id: distinct_id_from_parameters(parameters),
-      properties: properties,
-    }
-    send_request('identify', params)
-  end
-
-  def alias(parameters)
-    parameters.default = nil
-
-    alias_ = parameters[:alias]
-    raise "No alias specified" unless alias_
-    raise "alias must be string or array" unless alias_.is_a?(String) or alias_.is_a?(Array)
-
-    params = {
-      distinct_id: distinct_id_from_parameters(parameters),
-      alias: alias_,
-    }
-    send_request('alias', params)
-  end
-
-  def annotate(parameters)
-    parameters.default = nil
-
-    event = parameters[:event]
-    raise "No event specified" unless event
-
-    properties = parameters[:properties]
-    properties = {} unless properties
-
-    channel = parameters[:channel]
-    channel = @channel unless channel
-
-    params = {
-      event: event,
-    }
-    params[:channel] = channel if channel
-    params[:properties] = properties if properties
-    send_request('annotate', params)
-  end
-
-  def page_view(parameters)
-    parameters.default = nil
-    args = {
-      event: 'Page view'
-    }
-
-    distinct_id = distinct_id_from_parameters(parameters)
-    args[:distinct_id] = distinct_id if distinct_id
-
-    raise "Must specify URL" unless parameters.has_key?(:url)
-    raise "Must specify Title" unless parameters.has_key?(:title)
-
-    properties = {
-      url: parameters[:url],
-      title: parameters[:title],
-    }
-    args[:properties] = properties
-
-    track args  # right now page_view is an alias of track
+  ['Alias', 'Annotate', 'Company', 'Identify', 'Track'].each do |method_object|
+    Trakio.class_eval "
+      def #{method_object.downcase} *args
+        @#{method_object.downcase} ||= #{method_object}.new(self)
+        @#{method_object.downcase}.run(*args)
+      end
+    "
   end
 
-  def send_request(endpoint, params)
-    protocol = @https ? "https" : "http"
-    url = "#{protocol}://#{@host}/#{endpoint}"
-    data = { token: @api_token, data: params }.to_json
-    resp = RestClient.post url, data, :content_type => :json, :accept => :json
-    result = JSON.parse(resp.body, :symbolize_names => true)
-    return result if result[:status] == 'success'
-
-    # status must be error
-    # here we will raise the required exception as in the API
-    exception = constantize(result[:exception].sub! 'TrakioAPI::', 'Trakio::') # name of the class
-    message = result[:message] # extra information for the exception
-    raise exception.new(message)
+  def page_view *args
+    @track ||= Track.new(self)
+    @track.page_view(*args)
   end
 
   protected
 
-  def constantize(camel_cased_word) # Taken from ActiveSupport
-    names = camel_cased_word.split('::')
-
-    # Trigger a builtin NameError exception including the ill-formed constant in the message.
-    Object.const_get(camel_cased_word) if names.empty?
-
-    # Remove the first blank element in case of '::ClassName' notation.
-    names.shift if names.size > 1 && names.first.empty?
-
-    names.inject(Object) do |constant, name|
-      if constant == Object
-        constant.const_get(name)
-      else
-        candidate = constant.const_get(name)
-        next candidate if constant.const_defined?(name, false)
-        next candidate unless Object.const_defined?(name)
-
-        # Go down the ancestors to check it it's owned
-        # directly before we reach Object or the end of ancestors.
-        constant = constant.ancestors.inject do |const, ancestor|
-          break const    if ancestor == Object
-          break ancestor if ancestor.const_defined?(name, false)
-          const
-        end
-
-        # owner is in Object, so raise
-        constant.const_get(name, false)
+    ['distinct','company'].each do |x|
+      define_method :"#{x}_id_from_parameters" do |parameters|
+        id = parameters[:"#{x}_id"]
+        id = self.instance_variable_get("@#{x}_id") unless id
+        id
       end
     end
-  end
-
-  def distinct_id_from_parameters parameters
-    distinct_id = parameters[:distinct_id]
-    distinct_id = @distinct_id unless distinct_id
-    raise "No distinct_id specified" unless distinct_id
-    distinct_id
-  end
 
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ Coveralls.wear!
 require 'trakio'
 require 'webmock/rspec'
 require 'json'
+require 'pry'
 require 'active_support/core_ext/numeric/time'
 require 'active_support/core_ext/date/calculations'
 

data/spec/trakio/alias_spec.rb

@@ -59,7 +59,7 @@ describe Trakio do
     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
+        expect { trakio.alias distinct_id: 'user@example.com' }.to raise_error Trakio::Exceptions::MissingParameter
       end
     end
 
@@ -90,7 +90,7 @@ describe Trakio do
       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
+          expect { trakio.alias alias: 'alias1@example.com' }.to raise_error Trakio::Exceptions::MissingParameter
         end
       end
 

data/spec/trakio/annotate_spec.rb

@@ -109,21 +109,14 @@ describe Trakio do
       context "when a channel is provided" do
         it "raises an error" do
           trakio = Trakio.new 'my_api_token'
-          expect { trakio.annotate channel: 'channel' }.to raise_error RuntimeError
+          expect { trakio.annotate channel: 'channel' }.to raise_error Trakio::Exceptions::MissingParameter
         end
       end
 
       context "when properties are provided" do
         it "raises 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 "raises an error" do
-          trakio = Trakio.new 'my_api_token'
-          expect { trakio.annotate }.to raise_error ArgumentError
+          expect { trakio.annotate properties: { name: 'tobie' } }.to raise_error Trakio::Exceptions::MissingParameter
         end
       end
 

data/spec/trakio/class_methods_spec.rb

@@ -41,6 +41,14 @@ describe Trakio do
         end
       end
 
+      context "when a company_id is provided" do
+        it "raises an exception" do
+          expect{
+            Trakio.init 'my_api_token', company_id: 'acme_ldt'
+          }.to raise_error Trakio::Exceptions::NoCompanyIdForDefaultInstance
+        end
+      end
+
       context "when a channel is provided" do
         it "sets the channel option" do
           Trakio.init 'my_api_token', channel: 'my-channel'
@@ -145,6 +153,17 @@ describe Trakio do
 
   end
 
+  describe '.company' do
+    it "calls company on the default Trakio instance" do
+      default_instance = double(Trakio)
+
+      Trakio.default_instance = default_instance
+      expect(Trakio.default_instance).to receive(:company)
+
+      Trakio.company
+    end
+  end
+
 
   describe '.distinct_id' do
     it "raise an error" do
@@ -152,6 +171,13 @@ describe Trakio do
     end
   end
 
+
+  describe '.company_id' do
+    it "raise an error" do
+      expect{ Trakio.company_id }.to raise_error Trakio::Exceptions::NoCompanyIdForDefaultInstance
+    end
+  end
+
   describe '.channel' do
 
     it "calls channel on the default Trakio instance" do

data/spec/trakio/company_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+describe Trakio do
+
+  subject { Trakio }
+
+  after {
+    Trakio.default_instance = nil
+  }
+
+  describe '#company' do
+
+    context "when a company_id is provided" do
+
+      context "when properties are provided" do
+
+        it "sends an company request" do
+          stub = stub_request(:post, "https://api.trak.io/v1/company").
+            with(:body => {
+              token: 'my_api_token',
+              data: {
+                company_id: 'acme_ltd',
+                properties: {
+                  name: 'Acme Ltd',
+                },
+              }
+            }).to_return(:body => {
+              status: 'success'
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token'
+          trakio.company company_id: 'acme_ltd', properties: { name: 'Acme Ltd' }
+
+          expect(stub).to have_been_requested
+        end
+
+      end
+
+    end
+
+    context "when a company_id isn't provided but is set on instance" do
+
+      context "when properties are provided" do
+
+        it "sends an company request" do
+          stub = stub_request(:post, "https://api.trak.io/v1/company").
+            with(:body => {
+              token: 'my_api_token',
+              data: {
+                company_id: 'acme_ltd',
+                properties: {
+                  name: 'Acme Ltd',
+                },
+              }
+            }).to_return(:body => {
+              status: 'success'
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token', company_id: 'acme_ltd'
+          trakio.company properties: { name: 'Acme Ltd' }
+
+          expect(stub).to have_been_requested
+        end
+
+      end
+
+      context "when distinct_id is provided" do
+
+        context "via arguments" do
+
+          it "adds it to the company's people_distinct_ids" do
+            stub = stub_request(:post, "https://api.trak.io/v1/company").
+              with(:body => {
+                token: 'my_api_token',
+                data: {
+                  company_id: 'acme_ltd',
+                  properties: {
+                    name: 'Acme Ltd',
+                  },
+                  people_distinct_ids: ['existing_distinct_id','distinct_id']
+                }
+              }.to_json).to_return(:body => {
+                status: 'success'
+              }.to_json)
+
+            trakio = Trakio.new 'my_api_token', company_id: 'not_the_company_id_to_use', distinct_id: 'not_the_distinct_id_to_use'
+            trakio.company company_id: 'acme_ltd', distinct_id: 'distinct_id', properties: { name: 'Acme Ltd' }, people_distinct_ids: ['existing_distinct_id']
+
+            expect(stub).to have_been_requested
+          end
+
+        end
+
+        context "via configuration" do
+
+          it "adds it to the company's people_distinct_ids" do
+            stub = stub_request(:post, "https://api.trak.io/v1/company").
+              with(body: {
+                token: 'my_api_token',
+                data: {
+                  company_id: 'acme_ltd',
+                  properties: {
+                    name: 'Acme Ltd',
+                  },
+                  people_distinct_ids: ['existing_distinct_id', '1234','distinct_id']
+                }
+              }.to_json).to_return(:body => {
+                status: 'success'
+              }.to_json)
+
+            trakio = Trakio.new 'my_api_token', company_id: 'acme_ltd', distinct_id: 'distinct_id'
+            trakio.company properties: { name: 'Acme Ltd' }, people_distinct_ids: ['existing_distinct_id', 1234]
+
+            expect(stub).to have_been_requested
+          end
+
+        end
+
+        context "and is not an array" do
+
+          it "raises an error" do
+            trakio = Trakio.new 'my_api_token', company_id: 'acme_ltd'
+            expect {
+              trakio.company properties: { name: 'Acme Ltd' }, people_distinct_ids: 1234
+            }.to raise_error Trakio::Exceptions::InvalidParameter
+          end
+
+        end
+
+      end
+
+    end
+
+    context "when a company_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: 'Acme Ltd' } }.to raise_error Trakio::Exceptions::MissingParameter
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/trakio/identify_spec.rb

@@ -67,15 +67,87 @@ describe Trakio 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
+          expect { trakio.identify properties: { name: 'Tobie' } }.to raise_error Trakio::Exceptions::MissingParameter
         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
+
+    context "when distinct_id and company_id are both set" do
+
+      context "via arguments" do
+
+        it "adds it to the company's people_distinct_ids" 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',
+                  company: [{ company_id: 'massive_dynamics', role: 'widgets' }, { company_id: 'acme_ltd' }]
+                },
+              }
+            }.to_json).to_return(:body => {
+              status: 'success'
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token'
+          trakio.identify distinct_id: 'user@example.com', company_id: 'acme_ltd', properties: { name: 'Tobie', company: { company_id: 'massive_dynamics', role: 'widgets' } }
+
+          expect(stub).to have_been_requested
         end
+
+      end
+
+      context "via configuration" do
+
+        it "adds it to the company's people_distinct_ids" 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',
+                  company: [{ company_id: 'massive_dynamics', role: 'widgets' }, { company_id: 'monarch', role: 'widgets' }, { company_id: 'acme_ltd' }],
+                },
+              }
+            }.to_json).to_return(:body => {
+              status: 'success'
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token', distinct_id: 'user@example.com', company_id: 'acme_ltd'
+          trakio.identify properties: { name: 'Tobie', company: [{ company_id: 'massive_dynamics', role: 'widgets' }], companies: [{ company_id: 'monarch', role: 'widgets' }]  }
+
+          expect(stub).to have_been_requested
+        end
+
+      end
+
+      context "but company is also passed in properties" do
+
+        it "doesn't send duplicates" 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',
+                  company: [{ company_id: 'massive_dynamics', role: 'widgets' }, { company_id: 'monarch', role: 'widgets' }],
+                },
+              }
+            }.to_json).to_return(:body => {
+              status: 'success'
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token', distinct_id: 'user@example.com', company_id: 'monarch'
+          trakio.identify properties: { name: 'Tobie', company: [{ company_id: 'massive_dynamics', role: 'widgets' }], companies: [{ company_id: 'monarch', role: 'widgets' }]  }
+
+          expect(stub).to have_been_requested
+        end
+
       end
 
     end

data/spec/trakio/initialize_spec.rb

@@ -36,6 +36,13 @@ describe Trakio do
         end
       end
 
+      context "when a company_id is provided" do
+        it "sets that for this instance" do
+          trakio = Trakio.new "my_api_token", company_id: 'acme_ltd'
+          expect(trakio.company_id).to eql 'acme_ltd'
+        end
+      end
+
       context "when a https option is provided" do
         it "sets https option" do
           trakio = Trakio.new 'my_api_token', https: false

data/spec/trakio/instance_methods_spec.rb

@@ -37,6 +37,35 @@ describe Trakio do
 
   end
 
+  describe '#company_id=' do
+
+    it "sets the company_id to be used by this Interface" do
+      trakio = Trakio.new 'api_token'
+      trakio.company_id = 'acme_ltd'
+      expect(trakio.instance_variable_get('@company_id')).to eql 'acme_ltd'
+    end
+
+    context "when this is the default Interface" do
+
+      it "raises an exception" do
+        Trakio.init 'my_api_token'
+        expect{ Trakio.company_id = 'acme_ltd' }.to raise_error Trakio::Exceptions::NoCompanyIdForDefaultInstance
+      end
+
+    end
+
+  end
+
+  describe '#company_id' do
+
+    it "returns the current value" do
+      trakio = Trakio.new 'api_token'
+      trakio.instance_variable_set('@company_id','acme_ltd')
+      expect(trakio.company_id).to eql 'acme_ltd'
+    end
+
+  end
+
   describe '#channel=' do
 
     it "sets the channel to be used by this Interface" do

data/spec/trakio/page_view_spec.rb

@@ -39,16 +39,6 @@ describe Trakio do
           expect(stub).to have_been_requested
         end
       end
-
-      context "when a title is not specified" do
-        it "raises an error" do
-          trakio = Trakio.new 'my_api_token'
-          expect {
-            trakio.page_view distinct_id: 'user@example.com',
-              url: 'http://test.test/test'
-          }.to raise_error RuntimeError
-        end
-      end
     end
 
     context "when a url is not specified" do
@@ -56,16 +46,7 @@ describe Trakio do
         trakio = Trakio.new 'my_api_token'
         expect {
           trakio.page_view distinct_id: 'user@example.com'
-        }.to raise_error RuntimeError
-      end
-
-      context "when a title is specified" do
-        it "raises an error" do
-          trakio = Trakio.new 'my_api_token'
-          expect {
-            trakio.page_view distinct_id: 'user@example.com', title: 'Test Title'
-          }.to raise_error RuntimeError
-        end
+        }.to raise_error Trakio::Exceptions::InvalidParameter
       end
     end
 

data/spec/trakio/track_spec.rb

@@ -190,22 +190,94 @@ describe Trakio do
 
         it "raises an exception" do
           trakio = Trakio.new 'my_api_token'
-          expect { trakio.track distinct_id: 'user@example.com' }.to raise_error RuntimeError
+          expect { trakio.track distinct_id: 'user@example.com' }.to raise_error Trakio::Exceptions::MissingParameter
         end
 
       end
 
     end
 
-    context "when a distinct_id isn't provided" do
+    context "when a company_id is provided as an argument" 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: {
+              time: /.+/,
+              company_id: 'acme_ltd',
+              event: 'my-event'
+            }
+          }).to_return(:body => {
+            status: 'success',
+          }.to_json)
 
-        it "raises an error" do
-          trakio = Trakio.new 'my_api_token'
-          expect { trakio.track event: 'my-event' }.to raise_error RuntimeError
-        end
+        trakio = Trakio.new 'my_api_token'
+        resp = trakio.track company_id: 'acme_ltd', event: 'my-event'
+
+        expect(resp[:status]).to eql 'success'
+
+        expect(stub).to have_been_requested
+      end
+
+    end
+
+    context "when a company_id is configured" 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: {
+              time: /.+/,
+              company_id: 'acme_ltd',
+              event: 'my-event'
+            }
+          }).to_return(:body => {
+            status: 'success'
+          }.to_json)
+
+        trakio = Trakio.new 'my_api_token', company_id: 'acme_ltd'
+        resp = trakio.track event: 'my-event'
+
+        expect(resp[:status]).to eql 'success'
+
+        expect(stub).to have_been_requested
+      end
+
+    end
+
+    context "when both a company_id and distinct_id are provided as arguments" 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: {
+              time: /.+/,
+              distinct_id: '1234567',
+              company_id: 'acme_ltd',
+              event: 'my-event'
+            }
+          }).to_return(:body => {
+            status: 'success'
+          }.to_json)
+
+        trakio = Trakio.new 'my_api_token'
+        resp = trakio.track event: 'my-event', distinct_id: '1234567', company_id: 'acme_ltd'
+
+        expect(resp[:status]).to eql 'success'
+
+        expect(stub).to have_been_requested
+      end
+
+    end
+
+    context "when neither distinct_id or company_id is provided" do
 
+      it "raises an error" do
+        trakio = Trakio.new 'my_api_token'
+        expect { trakio.track event: 'my-event' }.to raise_error Trakio::Exceptions::MissingParameter
       end
 
     end

data/trakio-ruby.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'fuubar'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'activesupport'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trakio-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthew Spence
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -140,17 +154,24 @@ files:
 - Rakefile
 - lib/trakio-ruby.rb
 - lib/trakio.rb
+- lib/trakio/alias.rb
+- lib/trakio/annotate.rb
+- lib/trakio/company.rb
+- lib/trakio/end_point.rb
+- lib/trakio/exceptions.rb
+- lib/trakio/identify.rb
+- lib/trakio/track.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/company_spec.rb
 - spec/trakio/exception_spec.rb
 - spec/trakio/identify_spec.rb
 - spec/trakio/initialize_spec.rb
 - spec/trakio/instance_methods_spec.rb
 - spec/trakio/page_view_spec.rb
-- spec/trakio/protected_instance_methods_spec.rb
 - spec/trakio/track_spec.rb
 - trakio-ruby.gemspec
 homepage: https://trak.io
@@ -182,10 +203,10 @@ test_files:
 - spec/trakio/alias_spec.rb
 - spec/trakio/annotate_spec.rb
 - spec/trakio/class_methods_spec.rb
+- spec/trakio/company_spec.rb
 - spec/trakio/exception_spec.rb
 - spec/trakio/identify_spec.rb
 - spec/trakio/initialize_spec.rb
 - spec/trakio/instance_methods_spec.rb
 - spec/trakio/page_view_spec.rb
-- spec/trakio/protected_instance_methods_spec.rb
 - spec/trakio/track_spec.rb

data/spec/trakio/protected_instance_methods_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-
-describe Trakio do
-
-  subject { Trakio }
-  let(:trakio) { Trakio.init 'my_api_token' }
-
-  after { Trakio.default_instance = nil }
-
-  before { Trakio.send(:public, *Trakio.protected_instance_methods) }
-
-  describe '#distinct_id_from_parameters' do
-
-    context "when the :distinct_id key is provided in parameters" do
-      it "returns that value" do
-        expect(trakio.distinct_id_from_parameters({ distinct_id: 'my_distinct_id'})).to eq 'my_distinct_id'
-      end
-    end
-
-    context "when the :distinct_id key isn't provided in parameters" do
-
-      it "returns @distinct_id" do
-        trakio.distinct_id = 'other_distinct_id'
-        expect(trakio.distinct_id_from_parameters({ distinct_id: nil})).to eq 'other_distinct_id'
-      end
-
-
-      context "and @distinct_id has not been set" do
-
-        it "raises an exception" do
-          expect{ trakio.distinct_id_from_parameters({ distinct_id: nil}) }.to raise_error RuntimeError
-        end
-
-      end
-
-    end
-
-  end
-
-end