getclicky 0.1.beta1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rspec
+.autotest
+test.rb

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.rdoc

@@ -0,0 +1,89 @@
+= Getclicky API Analytics Library
+
+A swiss knife ruby wrapper for Getclicky API Analytics. For more information see: http://getclicky.com/help/api.
+
+== Installation
+
+  gem install getclicky
+
+== Usage
+
+=== Ruby wrapper
+
+First, you'll need to set up your site_id and sitekey. You can discover this information by accessing settings in your account at http://getclicky.com.
+
+  Getclicky.configure do |config|
+    config.site_id = "your site id here"
+    config.sitekey = "your site key here"
+  end
+
+Then you can simply instantiate a new Getclicky::Client object.
+
+  getclicky = Getclicky::Client.new
+
+=== Usage
+					
+All types in API are methods here looks, you can find all types http://getclicky.com/help/api:
+
+  getClicky.pages()
+	
+  getClicky.tweets()
+	
+  getClicky.visitors()
+	
+In each method you can pass optional parameters as a hash looks:
+
+  getClicky.visitors(:date => "last-7-days", :daily => 1)
+	
+  getClicky.item(:date => "last-7-days", :item => "google.com")
+	
+  getClicky.visitors_list(:domain => "google.com")
+	
+By default getclicky API returns XML as data, but you can change adding :output in parameter like:
+
+===== JSON
+
+  getClicky.visitors(:output => "json", :date => "last-7-days", :daily => 1)
+	
+===== CSV
+
+  getClicky.visitors(:output => "csv", :date => "last-7-days", :daily => 1)
+	
+===== PHP
+
+  getClicky.visitors(:output => "php", :date => "last-7-days", :daily => 1)
+	
+	
+This library does't support multiple types yet.
+
+== Roadmap
+
+* Multiple types for request
+* Improve the tests
+	
+== Maintainer
+
+* Peterson Ferreira (petersonferreiras@gmail.com)
+
+== License
+
+(The 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/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new

data/getclicky.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "getclicky"
+
+Gem::Specification.new do |s|
+  s.name        = "getclicky"
+  s.version     = Getclicky::Version::STRING
+  s.authors     = ["Peterson Ferreira"]
+  s.email       = ["petersonferreiras@gmail.com"]
+  s.homepage    = "http://github.com/petersonferreira/getclicky"
+  s.summary     = %q{Ruby Wrapper for GetClicky API Analytics}
+  s.description = s.summary
+  
+  s.add_dependency "activesupport"            , "~> 3.0"
+  s.add_dependency "httparty"                 , "~> 0.7.8"
+  s.add_development_dependency "rspec"        , "~> 2.6"
+  s.add_development_dependency "test_notifier", "~> 0.3"
+  s.add_development_dependency "fakeweb"      , "~> 1.3"
+  s.add_development_dependency "ruby-debug19" , "~> 0.11"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/getclicky.rb

@@ -0,0 +1,52 @@
+# Getclicky API Analytics Ruby Client Library
+#
+# Allows access to the getclicky.com Analytics API using the ruby programming language.
+#
+# Copyright (c) 2011+ Peterson Ferreira
+# See LICENSE for details
+#
+require "httparty"
+require "active_support/core_ext/object/to_param"
+require "active_support/core_ext/object/to_query"
+require "active_support/inflector"
+require "active_support/core_ext/string/strip"
+require "active_support/core_ext/object/blank"
+
+# A Ruby class to call the Getclicky API Analytics.
+# You might use this if you want to see data of Getclicky in your application.
+#
+module Getclicky
+  autoload :Client  , "getclicky/client"
+  autoload :Request , "getclicky/request"
+  autoload :Response, "getclicky/response"
+  autoload :Types   , "getclicky/types"
+  autoload :Version , "getclicky/version"
+  
+  # Class implemented to abstract 404 errors.
+  #
+  class Getclicky::NotFoundError < StandardError; end
+  
+  class << self
+    # Set the site_id that will do requests to the API.
+    # Will be required in every request.
+    #
+    attr_accessor :site_id
+    
+    # Set the sitekey that will do request to the API.
+    # Will be required in every request.
+    #
+    attr_accessor :sitekey
+  end
+  
+  # API endpoint of Getclicky
+  #
+  def self.endpoint
+    ENV.fetch("GETCLICKY_ENDPOINT", "http://api.getclicky.com/api/stats/4")
+  end
+  
+  # Yield Getclicky module so you can easily configure options
+  #
+  def self.configure(&block)
+    yield Getclicky
+  end
+end

data/lib/getclicky/client.rb

@@ -0,0 +1,14 @@
+module Getclicky
+  class Client    
+    # Dynamically defines the methods to be called by type
+    #
+    Getclicky::Types::ALL.each do |type|
+      class_eval <<-RUBY, __FILE__, __LINE__  
+        def #{type.to_s.downcase}(params = {})                                            # def pages(params = {})
+          response = Getclicky::Request.get(:#{type.to_s.gsub(/[_]/, '-')}, params = {})  #   response = Getclicky::Request.get(:pages, params = {})
+          response.data                                                                   #   response.data
+        end                                                                               # end
+      RUBY
+    end
+  end
+end

data/lib/getclicky/request.rb

@@ -0,0 +1,34 @@
+# Getclicky API Analytics Ruby Client Library
+#
+# Allows access to the getclicky.com Analytics API using the ruby programming language.
+#
+# Copyright (c) 2011+ Peterson Ferreira
+# See LICENSE for details
+#
+module Getclicky
+  module Request  
+    include HTTParty
+    extend self
+    
+    # Handle all HTTP::Get request, wrapping all the logic
+    # like endpoint and more.
+    #
+    def get(type, params = {})
+      response = self.class.get(Getclicky.endpoint, :query => build_params(type, params))
+      
+      case response.code
+      when "404"
+        raise Getclicky::NotFoundError
+      else
+        Getclicky::Response.new(response)
+      end
+    end
+    
+    # Build the hash of options for given a resquest to API
+    #
+    def build_params(type, params = {})
+      query = { :site_id => Getclicky.site_id, :sitekey => Getclicky.sitekey, :type => type }
+      query.merge(params)
+    end
+  end
+end

data/lib/getclicky/response.rb

@@ -0,0 +1,20 @@
+# Getclicky API Analytics Ruby Client Library
+#
+# Allows access to the getclicky.com Analytics API using the ruby programming language.
+#
+# Copyright (c) 2011+ Peterson Ferreira
+# See LICENSE for details
+#
+module Getclicky
+  class Response    
+    attr_accessor :request
+    
+    def initializer(request)
+      @request = request
+    end
+    
+    def data
+      @request.body
+    end
+  end
+end

data/lib/getclicky/types.rb

@@ -0,0 +1,62 @@
+# Getclicky API Analytics Ruby Client Library
+#
+# Allows access to the getclicky.com Analytics API using the ruby programming language.
+#
+# Copyright (c) 2011+ Peterson Ferreira
+# See LICENSE for details
+#
+module Getclicky
+  module Types
+    
+    # Request types that the API accepts.
+    #
+    ALL = [
+      :pages,
+      :pages_entrance,
+      :pages_exit,
+      :downloads,
+      :clicks,
+      :links,
+      :links_domains,
+      :links_outbound,
+      :searches,
+      :searches_keywords,
+      :searches_engines,
+      :goals,
+      :split_tests,
+      :campaigns,
+      :countries,
+      :cities,
+      :regions,
+      :languages,
+      :web_browsers,
+      :operating_systems,
+      :screen_resolutions,
+      :hostnames,
+      :organizations,
+      :engagement_actions,
+      :engagement_times,
+      :segmentation,
+      :visitors_most_active,
+      :traffic_sources,
+      :tweets,
+      :shorturls,
+      :visitors_list,
+      :actions_list,
+      :searches_recent,
+      :searches_unique,
+      :links_recent,
+      :links_unique,
+      :visitors,
+      :visitors_unique,
+      :actions,
+      :actions_average,
+      :time_average,
+      :time_average_pretty,
+      :time_total,
+      :time_total_pretty,
+      :bounce_rate,
+      :visitors_online
+    ] 
+  end
+end

data/lib/getclicky/version.rb

@@ -0,0 +1,15 @@
+# Getclicky API Analytics Ruby Client Library
+#
+# Allows access to the getclicky.com Analytics API using the ruby programming language.
+#
+# Copyright (c) 2011+ Peterson Ferreira
+# See LICENSE for details
+#
+module Getclicky
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = "beta1"
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/spec/getclicky/client_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Getclicky::Client do
+  context "methods for request type" do
+    Getclicky::Types::ALL.each do |type|
+      class_eval <<-RUBY, __FILE__, __LINE__  
+        it "should be implement #{type.to_s} method" do
+          subject.should respond_to(type)
+        end
+      RUBY
+    end
+  end
+end

data/spec/getclicky/request_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe Getclicky::Request do
+  it "should be set the right parameters" do
+    params = subject.build_params(:pages, :limit => 10, :hourly => 1)
+    params.should == { :site_id => Getclicky.site_id, :sitekey => Getclicky.sitekey, :type => :pages, :limit => 10, :hourly => 1}
+  end
+end

data/spec/getclicky_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe Getclicky do
+  describe "configure" do
+    it "should be set site_id" do
+      Getclicky.configure { |c| c.site_id = "123" }
+      Getclicky.site_id.should == "123"
+    end
+    
+    it "should be set sitekey" do
+      Getclicky.configure { |c| c.sitekey = "123" }
+      Getclicky.sitekey.should == "123"
+    end
+  end
+  
+  describe "endpoint" do
+    it "should be returns the real url" do
+      ENV.delete("GETCLICKY_ENDPOINT")
+      Getclicky.endpoint.should == "http://api.getclicky.com/api/stats/4"
+    end
+    
+    it "should be changes the url" do
+      ENV["GETCLICKY_ENDPOINT"] = "http://getclicky.com"
+      Getclicky.endpoint.should == "http://getclicky.com"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require "bundler"
+Bundler.setup(:default, :development)
+Bundler.require(:default, :development)
+
+require "getclicky"
+require "rspec"
+require "test_notifier/runner/rspec"
+
+FakeWeb.allow_net_connect = false
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|file| require file}
+
+RSpec.configure do |config|
+  config.include Helpers
+    
+  # config.before do
+  #   ENV.delete("GETCLICKY_ENDPOINT")
+  # end
+end

data/spec/support/helpers.rb

@@ -0,0 +1,10 @@
+module Helpers
+  
+  def default_credentials!
+    Getclicky.configure do |config|
+      config.username = "john"
+      config.api_key = "abc"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: getclicky
+version: !ruby/object:Gem::Version
+  version: 0.1.beta1
+  prerelease: 4
+platform: ruby
+authors:
+- Peterson Ferreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70254699111300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254699111300
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70254699110800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254699110800
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70254699110340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70254699110340
+- !ruby/object:Gem::Dependency
+  name: test_notifier
+  requirement: &70254699109860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70254699109860
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70254699109400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70254699109400
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70254699108920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: *70254699108920
+description: Ruby Wrapper for GetClicky API Analytics
+email:
+- petersonferreiras@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- getclicky.gemspec
+- lib/getclicky.rb
+- lib/getclicky/client.rb
+- lib/getclicky/request.rb
+- lib/getclicky/response.rb
+- lib/getclicky/types.rb
+- lib/getclicky/version.rb
+- spec/getclicky/client_spec.rb
+- spec/getclicky/request_spec.rb
+- spec/getclicky_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+homepage: http://github.com/petersonferreira/getclicky
+licenses: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Ruby Wrapper for GetClicky API Analytics
+test_files:
+- spec/getclicky/client_spec.rb
+- spec/getclicky/request_spec.rb
+- spec/getclicky_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb