go_squared 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Wout Fierens
+
+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.markdown

@@ -0,0 +1,119 @@
+# go_squared gem
+
+## What is it?
+A Ruby gem wrapping the gosquared.com API.
+
+## Who should use it?
+Any Ruby on Rails developer who wants/needs to load trends from GoSquared Statistics.
+
+## Usage
+
+### Installation
+
+    gem install go_squared
+
+
+### Initialization
+
+Initialize the connection for a given site:
+
+    @gs = GoSquared.new('Your API Key', 'GSN-123456-A')
+
+
+### Metrics
+
+To fetch the pageviews metric simply do:
+
+    @pageviews = @gs.trends.pageviews
+
+All available metrics are:
+
+- pageviews _(Total number of pageviews and uniques per unit time)_
+- topcontent _(Top performing content)_
+- ppv _(Pages per view per unit time)_
+- browsers _(Browsers)_
+- platforms _(Platforms)_
+- referrers _(Referrers)_
+- locations _(Locations)_
+- languages _(Languages)_
+- screens _(Screen sizes)_
+- capabilities _(Flash & Java availability)_
+- queries _(Search queries)_
+- keywords _(Search keywords)_
+- nvr _(New vs Returning visitors per unit time)_
+- sources _(Organic - search engine - sources)_
+- toplanding _(Top landing pages)_
+- topexit _(Top exit pages)_
+
+
+### Method chain
+
+By default trends form one month ago until now are fetched.
+To get a custom timeframe:
+
+    @pageviews = @gs.trends.pageviews.from(14.days.ago).to(7.days.ago)
+
+All chainable methods are:
+
+- from _(defaults to 1.month.ago)_
+- to _(defaults to Time.now)_
+- period _(last specified period of time - overrides from/to - options are 'day', 'week', 'month' and 'year' - defaults to 'week')_
+- timezone _(defaults to 'UTC')_
+- group_by _(options are 'day', 'week', 'month' and 'year' - defaults to 'day')_
+- limit _(must be an integer - defaults to 30)_
+
+
+### Fetch data
+
+Up till now no data has been fetched.
+To get the raw XML:
+
+    @xml = @pageviews.xml
+
+To get an array of ruby Hashes with symbolized keys:
+
+    @stats = @pageviews.from_xml
+
+The latter will return something like:
+    
+    {:hits=>"41", :uniques=>"28", :stat_start=>"1298736000", :time_grouping=>"2011057", :display_time=>"Sat, 26 Feb 11"}
+    {:hits=>"126", :uniques=>"77", :stat_start=>"1298764800", :time_grouping=>"2011058", :display_time=>"Sun, 27 Feb 11"}
+    {:hits=>"105", :uniques=>"56", :stat_start=>"1298851200", :time_grouping=>"2011059", :display_time=>"Mon, 28 Feb 11"}
+    ...
+
+
+## Important
+
+This gem is written for Rails 3.
+Rails 2 might work but it's not tested.
+
+Note that this gem is still under development.
+It only covers the trends section of the gosquared.com API.
+
+
+## Contributing to go_squared
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Wout Fierens. See LICENSE.txt for
+further details.
+
+
+
+
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "go_squared"
+  gem.homepage = "http://github.com/wout/go_squared"
+  gem.license = "MIT"
+  gem.summary = %Q{A ruby wrapper for the GoSquared API }
+  gem.description = %Q{Currently only the trends part is covered}
+  gem.email = "wout@boysabroad.com"
+  gem.authors = ["Wout Fierens"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  
+  #gem.add_dependency 'active_support', '>= 2.0.0'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "go_squared #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/go_squared/core_extensions.rb

@@ -0,0 +1,10 @@
+class Hash
+  def recursive_symbolize_keys!
+    symbolize_keys!
+    # symbolize each hash in .values
+    values.each{|h| h.recursive_symbolize_keys! if h.is_a?(Hash) }
+    # symbolize each hash inside an array in .values
+    values.select{|v| v.is_a?(Array) }.flatten.each{|h| h.recursive_symbolize_keys! if h.is_a?(Hash) }
+    self
+  end
+end

data/lib/go_squared/trends.rb

@@ -0,0 +1,92 @@
+class GoSquared
+  class Trends
+    METRICS = %w(pageviews topcontent ppv browsers platforms referrers locations languages screens capabilities queries keywords nvr sources toplanding topexit)
+    
+    def initialize api_key, site_id
+      @api_key  = api_key
+      @site_id  = site_id
+      
+      @start    = 1.month.ago.to_i
+      @end      = Time.now.to_i
+      @metric   = :pageviews
+      @group    = :day
+    end
+    
+    METRICS.each do |metric|
+      define_method metric do
+        self.on(metric)
+      end
+    end
+    
+    def on metric
+      @metric = metric.to_sym
+      self
+    end
+    
+    def from time
+      @start = time.to_i
+      self
+    end
+    
+    def to time
+      @end = time.to_i
+      self
+    end
+    
+    def timezone value
+      @timezone = value
+      self
+    end
+    
+    def group_by group
+      @group = group.to_sym
+      self
+    end
+    
+    def limit value
+      @limit = value
+      self
+    end
+    
+    def period value
+      @period = value
+      self
+    end
+    
+    def xml
+      fetch
+    end
+    
+    def from_xml
+      hash = Hash.from_xml(xml)
+      
+      hash.recursive_symbolize_keys!
+      
+      hash[:data][@group].blank? ? hash[:data] : hash[:data][@group]
+    end
+    
+    private
+      
+      def fetch
+        res = Net::HTTP.start('api.gosquared.com') do |http|
+          params = []
+          params << "api_key=#{ @api_key }"
+          params << "sid=#{ @site_id }"
+          params << "metric=#{ @metric }"
+          params << "start=#{ @start }"
+          params << "end=#{ @end }"
+          params << "grouping=#{ @group }"    if @group
+          params << "limit=#{ @limit }"       if @limit
+          params << "period=#{ @period }"     if @period
+          params << "timezone=#{ @timezone }" if @timezone
+          
+          http.get("/trends.xml?#{ params.join('&') }")
+        end
+        
+        res.body
+      rescue e
+        "<data><error>#{ e }</error></data>"
+      end
+    
+  end
+end

data/lib/go_squared.rb

@@ -0,0 +1,21 @@
+require 'net/http'
+require 'active_support/core_ext/hash/conversions'
+
+require 'go_squared/core_extensions'
+require 'go_squared/trends'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+class GoSquared
+  
+  def initialize api_key, site_id
+    @api_key = api_key
+    @site_id = site_id
+  end
+  
+  def trends
+    GoSquared::Trends.new(@api_key, @site_id)
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'go_squared'
+
+class Test::Unit::TestCase
+end

data/test/test_go_squared.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGoSquared < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: go_squared
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Wout Fierens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-13 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Currently only the trends part is covered
+email: wout@boysabroad.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/go_squared.rb
+- lib/go_squared/core_extensions.rb
+- lib/go_squared/trends.rb
+- test/helper.rb
+- test/test_go_squared.rb
+has_rdoc: true
+homepage: http://github.com/wout/go_squared
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -3715000075723790159
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the GoSquared API
+test_files: 
+- test/helper.rb
+- test/test_go_squared.rb