sampl 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ee012d5de21a89e26498868eda7e3ed1105ff11
-  data.tar.gz: 107d2c7b71d030753545f24d515665255d752b7e
+  metadata.gz: 37d47b8f365653696513b4a6cb807bd5a0ed8e81
+  data.tar.gz: 01237550258a62bd04d4bdfd1e749c81d41e3ef8
 SHA512:
-  metadata.gz: d2f5167fcc3f7bcd1f92a4e14c732f34371662f37837245a50db715918e4f52aa19cdfe856bcb044ea3cf6f016319b23b2b1b578792a35c625c1dc96789ef9d9
-  data.tar.gz: 2745625b79102609d700cfd875f91dac4234f39f77123f2d087fd513cedc5a5ecbc2cbb30057a135c8656d182ea8f9b4302f79f8356ff04a47b687a98064f408
+  metadata.gz: 5bb5d062a4d21449232026bde897499372ae40d570707c818f55289c778d749daaa3f2a043fffe6a2218ba3d89f6cf41330b837ca81910fd7053d4f6625e095d
+  data.tar.gz: 43ce9aa54bb3b8f65b45414fa9d1f949ea8a7b408f9891d0b7a1e2345f7be1d03426bdfa2acf11bc189e8dbfb0fed4082b7fb99a8a32c6c2895a66d026ed6966

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rake'
+gem 'httparty', '~> 0.13'
+
+group :development do
+end

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    sampl (0.0.1)
+      httparty (~> 0.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.13.1)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    multi_xml (0.5.5)
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty (~> 0.13)
+  rake
+  sampl!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 5D Lab GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,21 @@
+Sampl.rb
+=========
+
+Report tracking events from a Ruby on Rails server.
+
+Sampl.rb is a thin wrapper around HTTParty that implements PSIORI's REST API. It tries to adapt and rely on the same concepts and principles that HTTParty uses, so users already familiar with HTTParty will have an easy start with Sampl.rb.
+
+
+Usage
+-----
+
+Sampl's usage is very similar to that of HTTParty, you might already be familiar with. There are two options:
+
+A) calling the static methods of the Sampl module:
+
+```
+Sampl.track('rb_test_event', 'test', { app_token: 'your-unique-app-token', debug: true })
+```
+
+B) inheriting the module (recommended) in a custom class and implementing instance methods
+

data/lib/sampl.rb

@@ -1,3 +1,121 @@
-class Sampl
+require 'httparty'
 
+require 'sampl/version'
+
+module Sampl
+
+  def self.included(base)
+    base.extend ClassMethods
+    # the following inheritance pattern was explained in this block post by John Nunemaker:
+    # http://www.railstips.org/blog/archives/2006/11/18/class-and-instance-variables-in-ruby/
+    # We borrow its implementation from HTTParty so usage is as close to HTTParty as possible.
+    base.send :include, HTTParty::ModuleInheritableAttributes
+    base.send(:mattr_inheritable, :default_arguments)
+    base.send(:mattr_inheritable, :default_endpoint)
+    base.instance_variable_set("@default_arguments", {
+      sdk:            "Sampl.rb",
+      sdk_version:    Sampl::VERSION,
+      event_category: "custom",
+      server_side:    true
+    })
+    base.instance_variable_set("@default_endpoint", "http://events.neurometry.com/sample/v01/event")
+  end  
+  
+  module ClassMethods
+    
+    def version
+      Sampl::VERSION
+    end
+    
+    def default_arguments #:nodoc:
+      @default_arguments
+    end
+
+    def endpoint(endpoint=nil)
+      if endpoint.nil?
+        @default_endpoint
+      else
+        @default_endpoint = endpoint
+      end
+    end
+    
+    def app_token(app_token=nil)
+      if app_token.nil?
+        default_arguments[:app_token]  
+      else
+        default_arguments[:app_token] = app_token
+      end
+    end
+    
+    def server_side(flag=nil)
+      if flag.nil?
+        default_arguments[:server_side]  
+      else
+        default_arguments[:server_side] = flag
+      end
+    end
+        
+    def track(event_name, event_category="custom", arguments={}, &block)
+      perform_tracking event_name, event_category, arguments, &block
+    end
+    
+    private
+    
+      def my_blank?(value)
+        value.nil? || (value.respond_to?(:empty?) ? !!value.empty? : false)
+      end
+    
+      def perform_tracking(event_name, event_category, arguments, &block) # :nodoc:
+        # this is the central method that actually performs the tracking call
+        # with the help of HTTParty.
+        
+        arguments = arguments.merge({
+          event_name: event_name,
+          event_category: event_category # will overwrite default value, iff provided and not blank?
+        }).select { |key, value| !my_blank?(value) }
+  
+        arguments = HTTParty::ModuleInheritableAttributes.hash_deep_dup(default_arguments).merge({
+          timestamp: DateTime.now        # will be overwritten by (optional) user-provided timestamp
+        }).merge(arguments)
+        
+        HTTParty.post(endpoint, 
+                      body: { p: arguments }, 
+                      headers: { 'Accept' => 'application/json'}, 
+                      &block)
+      end
+    
+  end
+  
+  
+  class Basement    #:nodoc:
+    include Sampl   # because of the included-method this will pull the ClassMethods into Basement.
+  end
+  
+  # change the URI where to send the events. Please note this
+  # that chaging this on the static inteface of Sampl directly
+  # (Sampl.endpoint="http://my.url.com") will affect the whole
+  # app and all tracking calls to Sampl. Thus, all workers
+  # in a Rails app will send events to the same endpoint when
+  # working with the static interface. Use custom classes
+  # when in need for different endpoints.
+  def self.endpoint(endpoint=nil)
+    Basement.endpoint(endpoint)
+  end
+  
+  def self.app_token(app_token=nil)
+    Basement.app_token(app_token)
+  end
+
+  def self.server_side(flag=nil)
+    Basement.server_side(flag)
+  end
+  
+  def self.track(*args, &block)
+    Basement.track(*args, &block)
+  end
+
+  def self.version(*args, &block)
+    Basement.version(*args, &block)
+  end
+  
 end

data/lib/sampl/version.rb

@@ -0,0 +1,3 @@
+module Sampl
+  VERSION = "0.0.2"
+end

data/sampl.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "sampl/version"
+
+Gem::Specification.new do |s|
+  s.name          = 'sampl'
+  s.version       = Sampl::VERSION
+  s.date          = '2014-08-11'
+  s.summary       = %q{Report tracking events from a Ruby on Rails server.}
+  s.description   = %q{Report tracking events from a Ruby on Rails server.}
+  s.authors       = ["Sascha Lange"]
+  s.email         = 'sascha@5dlab.com'
+  s.homepage      = 'https://github.com/wackadoo/sampl.rb'
+  s.license       = 'MIT'
+  
+  s.add_dependency 'httparty', "~> 0.13"
+
+  s.post_install_message = 'Sampl on!'
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+end

data/script/release

@@ -0,0 +1,65 @@
+#!/bin/sh
+#/ Usage: release
+#/
+#/ Tag the version in the repo and push the gem.
+#/
+
+# This is a slightly modified version of httparty's release script.
+#
+# Copyright (c) 2008 John Nunemaker
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+set -e
+cd $(dirname "$0")/..
+
+[ "$1" = "--help" -o "$1" = "-h" -o "$1" = "help" ] && {
+    grep '^#/' <"$0"| cut -c4-
+    exit 0
+}
+
+gem_name=sampl
+
+# Build a new gem archive.
+rm -rf $gem_name-*.gem
+gem build -q $gem_name.gemspec
+
+# Make sure we're on the master branch.
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+tag=v`ls $gem_name-*.gem | sed "s/^$gem_name-\(.*\)\.gem$/\1/"`
+
+echo "Releasing $tag"
+
+# Make sure we haven't released this version before.
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+gem push $gem_name-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sampl
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sascha Lange
@@ -9,20 +9,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-08-11 00:00:00.000000000 Z
-dependencies: []
-description: SDK that helps sending tracking events to PSIORI's REST API. To be used
-  to send events from a Rails backend or any other Ruby program.
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: Report tracking events from a Ruby on Rails server.
 email: sascha@5dlab.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
 - lib/sampl.rb
-homepage: https://github.com/wackadoo/analytics-sample.rb
+- lib/sampl/version.rb
+- sampl.gemspec
+- script/release
+homepage: https://github.com/wackadoo/sampl.rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Sampl on!
 rdoc_options: []
 require_paths:
 - lib