trakio-ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7197ea21e8c7439a450e60da07fd3578341f0bbd
-  data.tar.gz: 8781505a279089e009d40ed3b9bb30ccb920a20c
+  metadata.gz: 1dc646d1ad49f9c56f9d126bb1d56aeb3f229b14
+  data.tar.gz: 512212ca3ac321f3da958b8551e22f9d5490580b
 SHA512:
-  metadata.gz: 5ebd1fb4edd5aa85ef6c087556994cb86c86a864ae500453b11d8736c4154e019a4bf11f3e59fee3d1d2890270fbfecb02a71f1790ff6ac9c5d406c111ef8eed
-  data.tar.gz: 1c7d375387fad1e594692fe84a09b860e01489b31242a8b2e7e526cb4c54548a9f87448b6d9ea19102e321d00d0a9e231a8ee2b94c22eecd7accfa735c44edd7
+  metadata.gz: 23623f51b3df64328df6569c66cbabc6d66cf9305c9d89e21a3d9a8bd58111367c73ad8f8e1119e62c236bfe5432be065bba3cc0d4369a50b379e1bd0269c649
+  data.tar.gz: 01d94782da9dae35c3af49889c762b733b5b5e3c18bcca6ac649e3a27a0b54e2cf31568d6afb9aac2bfe2b9cd19e4a6bc787df3dc9281ced070acb5924247689

data/lib/trakio.rb

@@ -1,97 +1,7 @@
-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"
-require "date"
-
+require 'trakio_client'
 
 class Trakio
 
-  attr_accessor :api_token
-  attr_accessor :https
-  attr_accessor :host
-  attr_accessor :channel
-  attr_accessor :distinct_id
-  attr_accessor :company_id
-
-  class << self
-
-    def init(*args)
-      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
-
-    def default_instance
-      raise Trakio::Exceptions::Uninitiated unless @default_instance
-      @default_instance
-    end
-
-    def default_instance=(instance)
-      @default_instance = instance
-    end
-
-    def distinct_id value=nil
-      raise Trakio::Exceptions::NoDistinctIdForDefaultInstance
-    end
-    alias :distinct_id= :distinct_id
-
-    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
-      # Trakio.channel returns Trakio.default_instance.channel
-      @default_instance.send(method, *args, &block)
-    end
-
-  end
-
-  def initialize(*args)
-    api_token, params = args
-    api_token = Trakio.default_instance.api_token unless api_token
-
-    @api_token = api_token or raise Trakio::Exceptions::InvalidToken.new('Missing API Token')
-    @https = true
-    @host = 'api.trak.io/v1'
-
-    %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
-
-  ['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 page_view *args
-    @track ||= Track.new(self)
-    @track.page_view(*args)
-  end
-
-  protected
-
-    ['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
+  include TrakioClient
 
 end

data/lib/trakio/client.rb

@@ -0,0 +1,7 @@
+require 'trakio_client'
+
+module Trakio
+  class Client
+    include TrakioClient
+  end
+end

data/lib/trakio_client.rb

@@ -0,0 +1,100 @@
+require "trakio_client/end_point"
+require "trakio_client/alias"
+require "trakio_client/annotate"
+require "trakio_client/company"
+require "trakio_client/exceptions"
+require "trakio_client/identify"
+require "trakio_client/track"
+require "trakio_client/version"
+require "rest_client"
+require "json"
+require "date"
+
+
+module TrakioClient
+
+  def self.included base
+    base.extend ClassMethods
+    base.send :attr_accessor, :api_token
+    base.send :attr_accessor, :https
+    base.send :attr_accessor, :host
+    base.send :attr_accessor, :channel
+    base.send :attr_accessor, :distinct_id
+    base.send :attr_accessor, :company_id
+  end
+
+  module ClassMethods
+
+    def init(*args)
+      api_token, params = args
+      raise Exceptions::InvalidToken.new('Missing API Token') unless api_token
+      raise Exceptions::NoDistinctIdForDefaultInstance if params and params.has_key?(:distinct_id)
+      raise Exceptions::NoCompanyIdForDefaultInstance if params and params.has_key?(:company_id)
+      @default_instance = self.new(*args)
+    end
+
+    def default_instance
+      raise Exceptions::Uninitiated unless @default_instance
+      @default_instance
+    end
+
+    def default_instance=(instance)
+      @default_instance = instance
+    end
+
+    def distinct_id value=nil
+      raise Exceptions::NoDistinctIdForDefaultInstance
+    end
+    alias :distinct_id= :distinct_id
+
+    def company_id value=nil
+      raise Exceptions::NoCompanyIdForDefaultInstance
+    end
+    alias :company_id= :company_id
+
+    def method_missing(method, *args, &block)
+      # passes to the default_instance so that
+      # Trakio.channel returns Trakio.default_instance.channel
+      @default_instance.send(method, *args, &block)
+    end
+
+  end
+
+  def initialize(*args)
+    api_token, params = args
+    api_token = self.class.default_instance.api_token unless api_token
+
+    @api_token = api_token or raise Exceptions::InvalidToken.new('Missing API Token')
+    @https = true
+    @host = 'api.trak.io/v1'
+
+    %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
+
+  ['Alias', 'Annotate', 'Company', 'Identify', 'Track'].each do |method_object|
+    TrakioClient.module_eval "
+      def #{method_object.downcase} *args
+        @#{method_object.downcase} ||= TrakioClient::#{method_object}.new(self)
+        @#{method_object.downcase}.run(*args)
+      end
+    "
+  end
+
+  def page_view *args
+    @track ||= Track.new(self)
+    @track.page_view(*args)
+  end
+
+  protected
+
+    ['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

data/lib/{trakio → trakio_client}/alias.rb

@@ -1,4 +1,4 @@
-class Trakio
+module TrakioClient
   class Alias < EndPoint
 
     def run p = {}
@@ -10,19 +10,19 @@ class Trakio
         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.')
+        raise Exceptions::MissingParameter.new('The `distinct_id` parameter must be provided.')
       end
       unless alias_
-        raise Trakio::Exceptions::MissingParameter.new('The `alias` parameter must be provided.')
+        raise 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.')
+        raise Exceptions::InvalidParameter.new('The `alias` parameter must be a string or an array.')
       end
     end
 

data/lib/{trakio → trakio_client}/annotate.rb

@@ -1,4 +1,4 @@
-class Trakio
+module TrakioClient
   class Annotate < EndPoint
 
     def run p = {}
@@ -18,10 +18,10 @@ class Trakio
 
     def check_parameters event, properties
       unless event
-        raise Trakio::Exceptions::MissingParameter.new("The `event` parameter must be provided.")
+        raise 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.")
+        raise Exceptions::InvalidParameter.new("The `properties` parameter must be a hash.")
       end
     end
 

data/lib/{trakio → trakio_client}/company.rb

@@ -1,4 +1,4 @@
-class Trakio
+module TrakioClient
   class Company < EndPoint
 
     def run p = {}
@@ -27,13 +27,13 @@ class Trakio
 
     def check_parameters company_id, properties, distinct_ids
       if !company_id
-        raise Trakio::Exceptions::MissingParameter.new('The `company_id` parameter must be provided.')
+        raise 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.")
+        raise 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.')
+        raise Exceptions::InvalidParameter.new('The `people_distinct_ids` parameter must be an array.')
       end
     end
 

data/lib/{trakio → trakio_client}/end_point.rb

@@ -1,4 +1,4 @@
-class Trakio
+module TrakioClient
   class EndPoint
 
     extend Forwardable
@@ -27,7 +27,7 @@ class Trakio
 
         # 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
+        exception = constantize("TrakioClient::Exceptions::#{result[:exception]}") # name of the class
         message = result[:message] # extra information for the exception
         raise exception.new(message)
       end

data/lib/{trakio → trakio_client}/exceptions.rb

@@ -1,4 +1,4 @@
-class Trakio
+module TrakioClient
 
   class Exceptions
     class Uninitiated < StandardError; end

data/lib/{trakio → trakio_client}/identify.rb

@@ -1,4 +1,4 @@
-class Trakio
+module TrakioClient
   class Identify < EndPoint
 
     def run p = {}
@@ -49,16 +49,16 @@ class Trakio
 
     def check_parameters distinct_id, properties
       unless properties.is_a?(Hash)
-        raise Trakio::Exceptions::InvalidParameter.new("The `properties` parameter must be a hash.")
+        raise 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.')
+        raise 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`')
+        raise Exceptions::InvalidProperty.new('The `companies` property must be an array of hashes each with a value for `company_id`')
       end
     end
 

data/lib/{trakio → trakio_client}/track.rb

@@ -1,4 +1,4 @@
-class Trakio
+module TrakioClient
   class Track < EndPoint
 
     def run p = {}
@@ -52,19 +52,19 @@ class Trakio
 
     def check_parameters event, distinct_id, company_id, properties
       unless event
-        raise Trakio::Exceptions::MissingParameter.new("The `event` parameter must be provided.")
+        raise 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.')
+        raise 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.")
+        raise 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.")
+        raise Exceptions::InvalidParameter.new("The `url` parameter must be provided.")
       end
     end
 

data/lib/trakio_client/version.rb

@@ -0,0 +1,3 @@
+module TrakioClient
+  VERSION = "0.2.1"
+end

data/spec/trakio/exception_spec.rb

@@ -23,7 +23,7 @@ describe Trakio do
           }).to_return(:body => {
             status: 'error',
             code: 401,
-            exception: "TrakioAPI::Exceptions::InvalidToken",
+            exception: "InvalidToken",
             message: "Missing or invalid API token.",
             details: "You must provide a valid API token, see http://docs.trak.io/authentication.html."
           }.to_json)

data/trakio-ruby.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'trakio/version'
+require 'trakio_client/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "trakio-ruby"
-  spec.version       = Trakio::VERSION
+  spec.version       = TrakioClient::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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trakio-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Matthew Spence
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,14 +154,16 @@ 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
+- lib/trakio/client.rb
+- lib/trakio_client.rb
+- lib/trakio_client/alias.rb
+- lib/trakio_client/annotate.rb
+- lib/trakio_client/company.rb
+- lib/trakio_client/end_point.rb
+- lib/trakio_client/exceptions.rb
+- lib/trakio_client/identify.rb
+- lib/trakio_client/track.rb
+- lib/trakio_client/version.rb
 - spec/spec_helper.rb
 - spec/trakio/alias_spec.rb
 - spec/trakio/annotate_spec.rb

data/lib/trakio/version.rb

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