analytico 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Gemini SBS LLC.
+
+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.rdoc

@@ -0,0 +1,15 @@
+= Analytico Ruby Client
+
+Tracks your app's impressions and custom metrics.
+
+== Status
+
+This gem is currently unreleased.
+
+== Copyright
+
+Copyright (c) 2010 Gemini SBS LLC. See LICENSE for details.
+
+== Author
+
+* (Mauricio Gomes)[http://github.com/mgomes]

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/analytico/client.rb

@@ -0,0 +1,72 @@
+module Analytico
+
+  class Client
+
+    @@connection = nil
+    @@debug = false
+
+    class << self
+
+      def set_credentials(api_key)
+        @@connection = Connection.new(api_key)
+        @@connection.debug = @@debug
+        true
+      end
+
+      def debug=(debug_flag)
+        @@debug = debug_flag
+        @@connection.debug = @@debug if @@connection
+      end
+
+      def debug
+        @@debug
+      end
+      
+      def add_impression(*args)
+        raise NoConnectionEstablished  if @@connection.nil?
+        
+        options = extract_options!(args)
+        if options[:fqdn].nil? || options[:ip].nil?
+          return true
+        end
+        params = Hash.new
+        params[:impression] = options
+        params[:impression][:api_key] = @@connection.api_key
+        
+        response = post(Endpoint.impressions, params)
+        HashUtils.recursively_symbolize_keys(response)
+      end
+      
+      def add_metric(fqdn, name, value)
+        raise NoConnectionEstablished  if @@connection.nil?
+        
+        params = Hash.new
+        params[:metric] = Hash.new
+        params[:metric][:api_key] = @@connection.api_key
+        params[:metric][:fqdn] = fqdn
+        params[:metric][:name] = name
+        params[:metric][:value] = value
+        
+        response = post(Endpoint.metrics, params)
+        HashUtils.recursively_symbolize_keys(response)
+      end
+
+      def post(endpoint, data=nil)
+        @@connection.post endpoint, data
+      end
+
+    private
+
+      def extract_options!(args)
+        if args.last.is_a?(Hash)
+          return args.pop
+        else
+          return {}
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/analytico/connection.rb

@@ -0,0 +1,105 @@
+module Analytico
+
+  class Connection
+
+    attr_accessor :debug
+    attr_reader :api_key, :default_options
+
+    def initialize(api_key)
+      @api_key = api_key
+      @default_options = { }
+      @debug = false
+    end
+
+    def post(endpoint, data=nil)
+      request :post, endpoint, data
+    end
+
+  private
+
+    def request(method, endpoint, data=nil)
+      headers = { 'User-Agent' => "Analytico Ruby Client v#{VERSION}",
+                  'Content-Type' => "application/json" }
+      
+      if data.nil?
+        data = @default_options
+      else
+        data.merge!(@default_options)
+      end
+
+      if debug
+        puts "request: #{method.to_s.upcase} #{endpoint}"
+        puts "headers:"
+        headers.each do |key, value|
+          puts "#{key}=#{value}"
+        end
+        if [:post, :put].include?(method)
+          puts "data:"
+          puts Yajl::Encoder.encode data
+        end
+      end
+
+      begin
+        data = Yajl::Encoder.encode data
+      rescue
+        logger("there was an error encoding your submission: #{$!}")
+        return nil
+      end
+        
+      response = send_request(method, endpoint, headers, data)
+
+      if debug
+        if response.nil?
+          puts "There was an error processing the response from Analytico."
+        else
+          puts "\nresponse: #{response.code}"
+          puts "headers:"
+          response.header.each do |key, value|
+            puts "#{key}=#{value}"
+          end
+          puts "body:"
+          puts response.body
+        end
+      end
+
+      if response.nil? || response.body.empty?
+        content = nil
+      else
+        begin
+          content = Yajl::Parser.new.parse(response.body)
+        rescue
+          logger("received invalid response: #{$!}")
+          return "{}"
+        end
+      end
+
+      content
+    end
+
+    def send_request(method, endpoint, headers, data=nil)      
+      begin
+        response = RestClient::Request.execute(:method => :post, 
+                                                :url => endpoint, 
+                                                :payload => data, 
+                                                :headers => headers, 
+                                                :timeout => 0.1)
+      rescue => e
+        logger("there was an error transmitting your entry: #{$!}")
+        return nil
+      end
+
+      response
+    end
+    
+    def logger(error_msg)
+      msg = "%%%% There was an error communicating with Analytico: #{error_msg}"
+      if defined? Rails
+        Rails.logger.info msg
+      else
+        STDERR.puts msg
+      end
+    end
+
+  end
+
+end

data/lib/analytico/endpoint.rb

@@ -0,0 +1,23 @@
+module Analytico
+
+  class Endpoint
+
+    class << self
+      
+      def impressions
+        endpoint_url "impressions.json"
+      end
+      
+      def metrics
+        endpoint_url "metrics.json"
+      end
+
+      def endpoint_url(path)
+        [REALM, path].join('/')
+      end
+
+    end
+
+  end
+
+end

data/lib/analytico/hash_utils.rb

@@ -0,0 +1,28 @@
+module Analytico
+  
+  class HashUtils
+    
+    def self.symbolize_keys(hash)
+      hash.inject({}) do |options, (key, value)|
+        options[(key.to_sym rescue key) || key] = value
+        options
+      end
+    end
+
+    def self.recursively_symbolize_keys(object)
+      if object.is_a? Hash
+        symbolized_hash = symbolize_keys(object)
+        symbolized_hash.each do |key, value|
+          symbolized_hash[key] = recursively_symbolize_keys(value)
+        end
+        symbolized_hash
+      elsif object.is_a? Array
+        object.map {|value| recursively_symbolize_keys(value) }
+      else
+        object
+      end
+    end
+    
+  end
+  
+end

data/lib/analytico/railtie/rack_impression.rb

@@ -0,0 +1,13 @@
+module AnalyticoController
+  
+  private
+  
+    def analytico_impression
+      Analytico::Client.add_impression(:fqdn => request.host, :ip => request.ip, :user_agent => request.user_agent, :referrer => request.referrer, :url => request.path)
+		end
+  
+end
+
+if defined? ActionController
+  ActionController::Base.send :include, AnalyticoController
+end

data/lib/analytico.rb

@@ -0,0 +1,24 @@
+require 'uri'
+require 'yajl'
+require 'rest_client'
+
+# Analytico specific libs
+require 'analytico/connection'
+require 'analytico/endpoint'
+require 'analytico/hash_utils'
+require 'analytico/client'
+
+# Rails integration libs
+require 'analytico/railtie/rack_impression'
+
+module Analytico
+  
+  REALM = "http://analytico.heroku.com"
+  VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
+
+  class AnalyticoError < StandardError; end
+  class InsufficentArguments < AnalyticoError; end
+  class InvalidAPIKey < AnalyticoError; end
+  class NoConnectionEstablished < AnalyticoError; end
+  
+end

data/spec/analytico_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AnalyticoRuby" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'analytico'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: analytico
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Mauricio Gomes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 7
+        - 7
+        version: 0.7.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id004
+description: Ruby client for the Analytico impression and app metric tracking service.
+email: mgomes@geminisbs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- VERSION
+- lib/analytico.rb
+- lib/analytico/client.rb
+- lib/analytico/connection.rb
+- lib/analytico/endpoint.rb
+- lib/analytico/hash_utils.rb
+- lib/analytico/railtie/rack_impression.rb
+- spec/analytico_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/geminisbs/analytico_ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby client for Analytico
+test_files: 
+- spec/analytico_spec.rb
+- spec/spec_helper.rb