game_analytics 0.0.1

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 game_analytics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 William Lipa
+
+MIT License
+
+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,56 @@
+# GameAnalytics
+
+The GameAnalytics gem saves metrics data to gameanalytics.com.  It is lightweight and performs the metrics
+update on a separate worker thread to avoid interfering with normal request processing.
+
+The gem prioritizes avoiding disruption to the host application over rigorously saving all
+metrics data whatever the circumstances.  That is, if there are problems talking to gameanalytics.com,
+some metrics data may be dropped, but the host application should continue on as normal.
+
+Metrics data is held in memory in the worker process until it is either saved on gameanalytics.com or
+dropped due to falling behind.  The latter should be an unusual circumstance when gameanalytics.com is
+available.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'game_analytics'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install game_analytics
+
+## Usage
+
+Configure the gem with your GameAnalytics keys by placing code like the following in
+your initializer:
+
+    GameAnalytics.config(
+      :game_key => '123451234512345123451234512345',
+      :secret_key => '123451234512345123451234512345'
+    )
+
+In your application, create Metric objects of the appropriate GameAnalytics types
+(Design, Business, Quality, or User), and send them to the service:
+
+    m = GameAnalytics::Metric::Business.new(:user_id => '-100', :session_id => '-100',
+      :build => 'development', :message => 'test')
+    GameAnalytics.client.enqueue m
+    
+You can also send arrays of objects in a single service request:
+
+    GameAnalytics.client.enqueue [m1, m2]
+
+
+## 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/game_analytics.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'game_analytics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "game_analytics"
+  spec.version       = GameAnalytics::VERSION
+  spec.authors       = ["wlipa"]
+  spec.email         = ["dojo@masterleep.com"]
+  spec.description   = %q{Lightweight and non-disruptive interface to save metrics data to gameanalytics.com}
+  spec.summary       = %q{saves metrics data to gameanalytics.com}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('httpclient')
+  spec.add_dependency('rails')
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/game_analytics/client.rb

@@ -0,0 +1,45 @@
+module GameAnalytics
+class Client
+  
+  include Common
+
+
+  def initialize
+    @queue = Queue.new
+    @worker_mutex = Mutex.new
+  end
+
+  def enqueue(metric)
+    return if disabled
+    ensure_worker_running
+    @queue << metric
+    nil
+  end
+
+
+private
+
+  def ensure_worker_running
+    return if worker_running?
+    @worker_mutex.synchronize do
+      return if worker_running?
+      start_worker
+    end
+  end
+
+  def worker_running?
+    @worker_thread && @worker_thread.alive?
+  end
+
+  def start_worker
+    @worker_thread = Thread.new do
+      begin
+        Worker.new(@queue).run
+      rescue => ex
+        logger.info "GameAnalytics worker thread exception: #{ex}"
+      end
+    end
+  end
+
+end
+end

data/lib/game_analytics/common.rb

@@ -0,0 +1,21 @@
+module GameAnalytics
+module Common
+  
+  def logger
+    GameAnalytics.logger
+  end
+  
+  def options
+    GameAnalytics.options
+  end
+  
+  def client
+    GameAnalytics.client
+  end
+  
+  def disabled
+    GameAnalytics.disabled
+  end
+
+end
+end

data/lib/game_analytics/metric.rb

@@ -0,0 +1,41 @@
+module GameAnalytics
+class Metric
+  
+  include Common
+  
+  
+  def initialize(data={})
+    @data = data
+    needs = required_keys - data.keys
+    raise "missing required fields #{needs}" unless needs.empty?
+  end
+  
+  def as_json(options={})
+    @data
+  end
+  
+  def required_keys
+    [:user_id, :session_id, :build, :event_id]
+  end
+
+
+  class Design < Metric
+  end
+  
+  class User < Metric
+  end
+  
+  class Business < Metric
+    
+    def required_keys
+      super + [:currency, :amount]
+    end
+    
+  end
+  
+  class Quality < Metric
+  end
+
+
+end
+end

data/lib/game_analytics/version.rb

@@ -0,0 +1,5 @@
+module GameAnalytics
+  
+  VERSION = "0.0.1"
+
+end

data/lib/game_analytics/worker.rb

@@ -0,0 +1,35 @@
+require 'digest/md5'
+require 'httpclient'
+
+module GameAnalytics
+class Worker
+  
+  include Common
+
+
+  def initialize(q)
+    @queue = q
+    @http = HTTPClient.new
+    @url_base = "http://api.gameanalytics.com/1/#{options[:game_key]}"
+  end
+  
+  def process(unit)
+    klass = unit.is_a?(Array) ? unit.first.class : unit.class
+    category = klass.name.demodulize.downcase
+    json_data = unit.to_json
+    hd = Digest::MD5.hexdigest(json_data + options[:secret_key])
+    url = "#{@url_base}/#{category}"
+    logger.info "GameAnalytics <: #{url} #{json_data} #{hd}"
+    resp = @http.post(url, :body => json_data, :header => { 'Authorization' => hd })
+    logger.info "GameAnalytics >: #{resp.content} (#{resp.status})"
+  end
+  
+  def run
+    logger.info "GameAnalytics worker running"
+    loop do
+      process @queue.pop
+    end
+  end
+
+end
+end

data/lib/game_analytics.rb

@@ -0,0 +1,25 @@
+require 'game_analytics/common'
+require 'game_analytics/client'
+require 'game_analytics/metric'
+require 'game_analytics/version'
+require 'game_analytics/worker'
+
+
+module GameAnalytics
+
+  class << self
+    attr_accessor :options, :logger, :disabled
+  end
+
+
+  def self.config(opts)
+    @options = opts
+    @logger = opts[:logger] || Rails.logger
+    @disabled = opts[:disabled]
+  end
+  
+  def self.client
+    @client ||= Client.new
+  end
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: game_analytics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- wlipa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lightweight and non-disruptive interface to save metrics data to gameanalytics.com
+email:
+- dojo@masterleep.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- game_analytics.gemspec
+- lib/game_analytics.rb
+- lib/game_analytics/client.rb
+- lib/game_analytics/common.rb
+- lib/game_analytics/metric.rb
+- lib/game_analytics/version.rb
+- lib/game_analytics/worker.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: saves metrics data to gameanalytics.com
+test_files: []