trakio-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDA5ZmZhZjI4NThhMGE5OTA2NDg0MmFlNmE0YTFhZjIzYzRiNDdkZg==
+  data.tar.gz: !binary |-
+    YzU1Mzk2NDA3OGEyMzc1MDc2ZjE5NmYyODIwM2MwOGY3MDBkZDRmNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YWJlYTI0ZjY1NjNmZDYzMTJiYWY5YjcyY2ZmNWY4ZDhhM2U5ZmI5ODAyODg1
+    MDAwYTdiZDJiYzdjODJmNjBmNWJlN2Y1MDljNTllNmE3Njk2OTI5ZGM2OTZj
+    ZGIxZGY2ZTY5ZGEwMzA2MTlmYWYwZWQ0NWViYWJlYmIwOTAyYTg=
+  data.tar.gz: !binary |-
+    NWJmYWJlNmU3ZTU2NzcxOTk1MzY0NTY3MWEyZDhlMWE1MDk0NDgwOGE2MGEy
+    YTllZmQyMmZmMzI5MWJiMzNjNTc4M2UyZTk1ZDZjYzcwMjc1YjA2ODYwZmFm
+    MzAyNTgwNjQ4ZTdjMTdlZGEyMWZlOWY3NTg4NTVlMGNlMDk2OTY=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trakio-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,29 @@
+# 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:
+
+    gem 'trakio-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trakio-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/trakio.rb

@@ -0,0 +1,163 @@
+require "trakio/version"
+require "rest_client"
+require "json"
+
+
+class Trakio
+
+  class Exceptions
+    class Uninitiated < RuntimeError; end
+    class InvalidToken < RuntimeError; end
+    class NoDistinctIdForDefaultInstance < RuntimeError; end
+  end
+
+  class << self
+
+    def init(*args)
+      api_token, params = args
+      raise Trakio::Exceptions::InvalidToken.new('Missing API Token') unless api_token
+      if params and params.has_key?(:distinct_id)
+        raise Trakio::Exceptions::NoDistinctIdForDefaultInstance
+      end
+      @default_instance = Trakio.new(*args)
+    end
+
+    def default_instance
+      if @default_instance
+        @default_instance
+      else
+        raise Trakio::Exceptions::Uninitiated
+      end
+    end
+
+    def default_instance=(instance)
+      @default_instance = instance
+    end
+
+    def distinct_id
+      raise Trakio::Exceptions::NoDistinctIdForDefaultInstance
+    end
+
+    def distinct_id=(distinct_id)
+      raise Trakio::Exceptions::NoDistinctIdForDefaultInstance
+    end
+
+    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
+
+  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
+
+    @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}.each do |name|
+      if params && params.has_key?(name.to_sym)
+        instance_variable_set("@#{name}", params[name.to_sym])
+      end
+    end
+  end
+
+  def track(parameters)
+    parameters.default = nil
+
+    distinct_id = parameters[:distinct_id]
+    distinct_id = @distinct_id unless distinct_id
+    raise "No distinct_id specified" unless distinct_id
+
+    event = parameters[:event] or raise "No event specified"
+
+    channel = parameters[:channel]
+    channel = @channel unless channel
+
+    properties = parameters[:properties]
+
+    params = {
+      distinct_id: distinct_id,
+      event: event,
+    }
+    params[:channel] = channel if channel
+    params[:properties] = properties if properties
+
+    send_request('track', params)
+  end
+
+  def identify(parameters)
+    parameters.default = nil
+
+    distinct_id = parameters[:distinct_id]
+    distinct_id = @distinct_id unless distinct_id
+    raise "No distinct_id specified" unless distinct_id
+
+    properties = parameters[:properties]
+    raise "Properties must be specified" unless properties and properties.length > 0
+
+    params = {
+      distinct_id: distinct_id,
+      properties: properties,
+    }
+    send_request('identify', params)
+  end
+
+  def alias(parameters)
+    parameters.default = nil
+
+    distinct_id = parameters[:distinct_id]
+    distinct_id = @distinct_id unless distinct_id
+    raise "No distinct_id specified" unless distinct_id
+
+    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,
+      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 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
+    JSON.parse(resp.body, :symbolize_names => true)
+  end
+
+end

data/lib/trakio/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'trakio'
+require 'webmock/rspec'
+require 'json'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.color = true
+  config.formatter = "Fuubar"
+  config.filter_run_excluding :wip => true
+end