trakio-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDA5ZmZhZjI4NThhMGE5OTA2NDg0MmFlNmE0YTFhZjIzYzRiNDdkZg==
+    MGY0ZDI2ZDY3MWFiYWQ3OTEwODk3NjM4YTEyMTNiMzcwMGViYjE2ZA==
   data.tar.gz: !binary |-
-    YzU1Mzk2NDA3OGEyMzc1MDc2ZjE5NmYyODIwM2MwOGY3MDBkZDRmNA==
+    NzViZGQ0NTVkZjVmN2Y3NjFjM2VmNWJiZGMxYmFlNGJjY2U0MmYxNw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YWJlYTI0ZjY1NjNmZDYzMTJiYWY5YjcyY2ZmNWY4ZDhhM2U5ZmI5ODAyODg1
-    MDAwYTdiZDJiYzdjODJmNjBmNWJlN2Y1MDljNTllNmE3Njk2OTI5ZGM2OTZj
-    ZGIxZGY2ZTY5ZGEwMzA2MTlmYWYwZWQ0NWViYWJlYmIwOTAyYTg=
+    MmQzNTAyZjg2NDIzZmFlYmM5ZGVjNWUxMzI2ZWJiYjgwZWEzMGFkZTE5M2I3
+    YzUwZTg5ZmQyYjA2MmZkY2UyNGU3NjdmMDI2NzA0YTVkNjA5YzFiM2NiY2I2
+    NjdkYzYzM2M3MDk3MzM4NzBkMTBlMzZlOThiZTFhYzg4ODE0NTY=
   data.tar.gz: !binary |-
-    NWJmYWJlNmU3ZTU2NzcxOTk1MzY0NTY3MWEyZDhlMWE1MDk0NDgwOGE2MGEy
-    YTllZmQyMmZmMzI5MWJiMzNjNTc4M2UyZTk1ZDZjYzcwMjc1YjA2ODYwZmFm
-    MzAyNTgwNjQ4ZTdjMTdlZGEyMWZlOWY3NTg4NTVlMGNlMDk2OTY=
+    Njc2MWU5YWNiMjlkMDU1NzA1OWFlNjFkODVjMDVjMTYxNDA1NjZlMmM5N2Fh
+    OTcyMWVmMTIzY2QxYjM5Y2MzN2ExOGVkOTE3OWY2OWM3MGE0MjFhYTNiOTIx
+    YTkzNTZhNTNjNjkwMmNlZWFiOTBhNjg3ZjI3MzBhYjBhOTY4ZjM=

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+    - 2.1.0
+    - 2.0.0
+    - 1.9.3
+
+script: bundle exec rake test

data/README.md

@@ -1,7 +1,5 @@
 # Official trak.io Ruby Library
 
-# WARNING: Work in progress, this library is incomplete, it has been published but is subject to change.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,9 +14,63 @@ Or install it yourself as:
 
     $ gem install trakio-ruby
 
-## Usage
+## Examples
+
+For more indepth documentation see: http://docs.trak.io/ruby.html
+
+### Creating an instance, and then tracking an event.
+```ruby
+    # create the instance
+    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' }
+```
+
+### Creating a default instance, and then tracking an event.
+```ruby
+    # 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' }
+```
+
+### 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'] }
+
+    # 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'] }
+```
+
+### Creating an instance and using identify
+```ruby
+    # set token on default instance
+    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'] }
+```
+
+### Creating an instance and using annotate
+```ruby
+    # set token on default instance
+    Trakio.init 'my_api_token'
+
+    resp = Trakio.annotate event: 'event', channel: 'channel'
+    # resp will look like { 'status': 'success', 'trak_id': '12345', 'properties': {} }
+```
 
-TODO: Write usage instructions here
+## Creating and Running Tests
+* Tests can be run by running the following commands `bundle exec rspec`
+* Tests can be added by either adding into an existing spec file, or creating a new one.
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,5 @@
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec

data/lib/trakio/version.rb

@@ -1,3 +1,3 @@
 class Trakio
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/trakio.rb

@@ -6,9 +6,18 @@ require "json"
 class Trakio
 
   class Exceptions
-    class Uninitiated < RuntimeError; end
-    class InvalidToken < RuntimeError; end
-    class NoDistinctIdForDefaultInstance < RuntimeError; end
+    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
 
   class << self
@@ -157,7 +166,47 @@ class Trakio
     url = "#{protocol}://#{@host}/#{endpoint}"
     data = { token: @api_token, data: params }.to_json
     resp = RestClient.post url, data, :content_type => :json, :accept => :json
-    JSON.parse(resp.body, :symbolize_names => true)
+    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
+
+  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)
+      end
+    end
   end
 
 end

data/spec/trakio/annotate_spec.rb

@@ -7,8 +7,8 @@ describe Trakio do
   after {
     Trakio.default_instance = nil
   }
-  
-	describe '.annotate' do
+
+    describe '.annotate' do
 
     context "when an event is provided" do
 
@@ -131,4 +131,4 @@ describe Trakio do
 
   end
 
-end
+end

data/spec/trakio/exception_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Trakio do
+
+  subject { Trakio }
+
+  after {
+    Trakio.default_instance = nil
+  }
+
+  describe '.track' do
+
+    context "when an error is returned by the API" do
+      it "raises an exception" 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: 'error',
+            code: 401,
+            exception: "TrakioAPI::Exceptions::InvalidToken",
+            message: "Missing or invalid API token.",
+            details: "You must provide a valid API token, see http://docs.trak.io/authentication.html."
+          }.to_json)
+
+        trakio = Trakio.new 'my_api_token'
+        expect {
+          trakio.track distinct_id: 'user@example.com', event: 'my-event'
+        }.to raise_error Trakio::Exceptions::InvalidToken
+
+        stub.should have_been_requested
+
+      end
+    end
+
+    context "when no error is returned by the API" do
+      it "returns the result" 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
+    end
+
+  end # end .track
+end

data/trakio-ruby.gemspec

@@ -25,5 +25,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'fuubar'
 
   spec.add_dependency 'rest_client'
-  spec.add_dependency 'pry'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trakio-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matthew Spence
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-04 00:00:00.000000000 Z
+date: 2014-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,20 +95,6 @@ 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: :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
@@ -118,6 +104,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -128,6 +115,7 @@ files:
 - spec/trakio/alias_spec.rb
 - spec/trakio/annotate_spec.rb
 - spec/trakio/class_methods_spec.rb
+- spec/trakio/exception_spec.rb
 - spec/trakio/indentify_spec.rb
 - spec/trakio/initialize_spec.rb
 - spec/trakio/instance_methods_spec.rb
@@ -162,6 +150,7 @@ test_files:
 - spec/trakio/alias_spec.rb
 - spec/trakio/annotate_spec.rb
 - spec/trakio/class_methods_spec.rb
+- spec/trakio/exception_spec.rb
 - spec/trakio/indentify_spec.rb
 - spec/trakio/initialize_spec.rb
 - spec/trakio/instance_methods_spec.rb