getclicky 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,84 @@
+# Getclicky API Analytics Library
+
+A swiss knife ruby wrapper for Getclicky API Analytics. For more information see: http://getclicky.com/help/api.
+
+## Installation
+
+``` ruby
+## Gemfile for Rails 3, Sinatra, and Merb
+gem 'getclicky', '~> 0.1'
+```
+
+## 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.
+
+``` ruby
+Getclicky.configure do |config|
+  config.site_id = "your site id here"
+  config.sitekey = "your site key here"
+  config.admin_sitekey = "your admin site key, if applicable"
+end
+```
+
+Then you can simply instantiate a new Getclicky::Client object.
+
+``` ruby
+getclicky = Getclicky::Client.new
+```
+					
+All types in API are methods here looks, you can find all types http://getclicky.com/help/api:
+
+``` ruby
+getclicky.pages()
+getclicky.tweets()
+getclicky.visitors()
+```
+	
+In each method you can pass optional parameters as a hash looks:
+
+``` ruby
+getclicky.visitors(:date => "last-7-days", :daily => 1)
+getclicky.item(:date => "last-7-days", :item => "google.com")
+getclicky.visitors_list(:domain => "google.com")
+```
+
+You can also request more than one data type in a single request:
+
+``` ruby
+getclicky.multiple([:pages, :downloads], {:date => "last-7-days"})
+```
+	
+By default getclicky API returns an array of [Hashies](https://github.com/intridea/hashie) as data, but you can change by providing an :output parameter like:
+
+##### JSON
+
+``` ruby
+getclicky.visitors(:output => :json, :date => "last-7-days", :daily => 1)
+```
+	
+##### CSV
+
+``` ruby
+getclicky.visitors(:output => :csv, :date => "last-7-days", :daily => 1)
+```
+	
+##### PHP
+
+``` ruby
+getclicky.visitors(:output => :php, :date => "last-7-days", :daily => 1)
+```
+	
+Enjoy!
+
+## Roadmap
+
+* Improve the tests
+	
+## Author
+* Peterson Ferreira ([refactoringever.com](refactoringever.com))
+
+## Collaborators
+* Bobby Uhlenbrock ([github.com/uhlenbrock](github.com/uhlenbrock))

data/getclicky.gemspec

@@ -11,7 +11,8 @@ Gem::Specification.new do |s|
   s.summary     = %q{Ruby Wrapper for GetClicky API Analytics}
   s.description = s.summary
 
-  s.add_dependency "httparty"                 , "~> 0.7.8"
+  s.add_dependency "httparty"                 , "~> 0.8.0"
+  s.add_dependency "hashie"                   , "~> 1.1.0"
   s.add_development_dependency "rspec"        , "~> 2.6"
   s.add_development_dependency "test_notifier", "~> 0.3"
   s.add_development_dependency "fakeweb"      , "~> 1.3"

data/lib/getclicky.rb

@@ -24,6 +24,11 @@ module Getclicky
     # Will be required in every request.
     #
     attr_accessor :sitekey
+    
+    # Set the admin sitekey.
+    # Only used for certain requests.
+    #
+    attr_accessor :admin_sitekey
   end
   
   # API endpoint of Getclicky

data/lib/getclicky/client.rb

@@ -11,5 +11,11 @@ module Getclicky
         end                                                         # end
       RUBY
     end
+    
+    def multiple(types = [], params = {})
+      valid_types = types.reject { |t| !Getclicky::Types::ALL.include?(t.intern) }
+      response = Getclicky::Request.new(valid_types.join(','), params).get
+      response.data
+    end
   end
 end

data/lib/getclicky/request.rb

@@ -18,14 +18,14 @@ module Getclicky
       when "404"
         raise Getclicky::NotFoundError
       else
-        Getclicky::Response.new(response)
+        Getclicky::Response.new(response.parsed_response, @params[:output])
       end
     end
 
     # Build the hash of options for make resquest to API
     #
     def build_params(type, params = {})
-      query = { :site_id => Getclicky.site_id, :sitekey => Getclicky.sitekey, :type => type }
+      query = { :site_id => Getclicky.site_id, :sitekey => Getclicky.sitekey, :type => type, :output => :json }
       query.merge(params) if params
     end
   end

data/lib/getclicky/response.rb

@@ -1,13 +1,45 @@
+require "hashie"
+
 module Getclicky
-  class Response    
-    attr_accessor :item
+  class Response
+    attr_accessor :item, :format
     
-    def initialize(item)
+    class << self
+      attr_accessor :mash_class
+    end
+    
+    self.mash_class = ::Hashie::Mash
+    
+    def initialize(item, format = nil)
       @item = item
+      @format = format
     end
       
     def data
-      @item.body
+      @format.nil? ? mashify_data : @item
+    end
+    
+    def mashify_data
+      if @item.size.eql?(1)
+        parse(@item.first['dates'])
+      elsif @item.size > 1
+        {}.tap do |results|
+          @item.collect { |r| results[r['type'].intern] = parse(r['dates']) }
+        end
+      else
+        @item
+      end
+    end
+    
+    def parse(body)
+      case body
+      when Hash
+        self.class.mash_class.new(body)
+      when Array
+        body.map { |item| item.is_a?(Hash) ? self.class.mash_class.new(item) : item }
+      else
+        body
+      end
     end
   end
 end

data/lib/getclicky/version.rb

@@ -2,7 +2,7 @@ module Getclicky
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 0
+    PATCH = 1
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/getclicky/request_spec.rb

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe Getclicky::Request do
-  
   subject {
     Getclicky::Request.new(:pages, :limit => 10, :hourly => 1)
   }
@@ -12,12 +11,22 @@ describe Getclicky::Request do
   context "method build_params" 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}
+      params.should == { :site_id => Getclicky.site_id, :sitekey => Getclicky.sitekey, :type => :pages, :limit => 10, :hourly => 1, :output => :json}
     end
   
     it "should be leave hash parameters blank" do
       params = subject.build_params(:pages)
-      params.should == { :site_id => Getclicky.site_id, :sitekey => Getclicky.sitekey, :type => :pages}
+      params.should == { :site_id => Getclicky.site_id, :sitekey => Getclicky.sitekey, :type => :pages, :output => :json}
+    end
+    
+    it "should default to an output format of json" do
+      params = subject.build_params(:pages)
+      params.should == { :site_id => Getclicky.site_id, :sitekey => Getclicky.sitekey, :type => :pages, :output => :json}
+    end
+    
+    it "should allow overriding the output format" do
+      params = subject.build_params(:pages, :output => :xml)
+      params.should == { :site_id => Getclicky.site_id, :sitekey => Getclicky.sitekey, :type => :pages, :output => :xml}
     end
   end
 end

data/spec/getclicky/response_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Getclicky::Response do
+  subject {
+    Getclicky::Response.new([{
+      "type"=>"pages",
+      "dates"=>
+        [{"date"=>"2011-09-27",
+          "items"=>
+          [{"value"=>"6",
+            "value_percent"=>"66.7",
+            "title"=>"Test Page",
+            "stats_url"=>"http://getclicky.com/stats/visitors",
+            "url"=>"http://blackbookemg.dev/posts"},
+          {"value"=>"1",
+            "value_percent"=>"11.1",
+            "title"=>"Test Page 2",
+            "stats_url"=>
+            "http://getclicky.com/stats/visitors",
+            "url"=>"http://blackbookemg.dev/requests/1"}
+          ]}
+        ]
+      }])
+  }
+  
+  its(:item) { should be_an_instance_of Array }
+  its(:data) { should be_an_instance_of Array }
+  
+  context "when using" do
+    it "should return an array of Hashie objects" do
+      subject.data.each do |d|
+        d.should be_an_instance_of Hashie::Mash
+      end
+    end
+  end
+end

data/spec/getclicky_spec.rb

@@ -11,6 +11,11 @@ describe Getclicky do
       Getclicky.configure { |c| c.sitekey = "123" }
       Getclicky.sitekey.should == "123"
     end
+    
+    it "should be set admin_sitekey" do
+      Getclicky.configure { |c| c.admin_sitekey = "123" }
+      Getclicky.admin_sitekey.should == "123"
+    end
   end
   
   describe "endpoint" do
@@ -20,8 +25,8 @@ describe Getclicky do
     end
     
     it "should be changes the url" do
-      ENV["GETCLICKY_ENDPOINT"] = "http://getclicky.com"
-      Getclicky.endpoint.should == "http://getclicky.com"
+      ENV["GETCLICKY_ENDPOINT"] = "http://api.getclicky.com/api/stats/4"
+      Getclicky.endpoint.should == "http://api.getclicky.com/api/stats/4"
     end
   end
 end

data/spec/spec_helper.rb

@@ -13,7 +13,13 @@ 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
+  config.before do
+    ENV.delete("GETCLICKY_ENDPOINT")
+  end
+  
+  Getclicky.configure do |config|
+    config.site_id = nil
+    config.sitekey = nil
+    config.admin_sitekey = nil
+  end
 end

data/spec/support/helpers.rb

@@ -1,10 +1,8 @@
 module Helpers
-  
   def default_credentials!
     Getclicky.configure do |config|
-      config.username = "john"
-      config.api_key = "abc"
+      config.site_id = "32020"
+      config.site_key = "2e05fe2778b6"
     end
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getclicky
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-19 00:00:00.000000000Z
+date: 2011-09-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70246881759080 !ruby/object:Gem::Requirement
+  requirement: &70195420885440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.8
+        version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70246881759080
+  version_requirements: *70195420885440
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70195420884800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70195420884800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70246881758560 !ruby/object:Gem::Requirement
+  requirement: &70195420884180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70246881758560
+  version_requirements: *70195420884180
 - !ruby/object:Gem::Dependency
   name: test_notifier
-  requirement: &70246881758080 !ruby/object:Gem::Requirement
+  requirement: &70195420880680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *70246881758080
+  version_requirements: *70195420880680
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70246881757460 !ruby/object:Gem::Requirement
+  requirement: &70195420879980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +65,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70246881757460
+  version_requirements: *70195420879980
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70246881756980 !ruby/object:Gem::Requirement
+  requirement: &70195420879480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +76,7 @@ dependencies:
         version: '0.11'
   type: :development
   prerelease: false
-  version_requirements: *70246881756980
+  version_requirements: *70195420879480
 description: Ruby Wrapper for GetClicky API Analytics
 email:
 - petersonferreiras@gmail.com
@@ -76,7 +87,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - getclicky.gemspec
 - lib/getclicky.rb
@@ -87,6 +98,7 @@ files:
 - lib/getclicky/version.rb
 - spec/getclicky/client_spec.rb
 - spec/getclicky/request_spec.rb
+- spec/getclicky/response_spec.rb
 - spec/getclicky_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
@@ -110,13 +122,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.8.9
 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/response_spec.rb
 - spec/getclicky_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb

data/README.rdoc

@@ -1,79 +0,0 @@
-# Getclicky API Analytics Library
-
-A swiss knife ruby wrapper for Getclicky API Analytics. For more information see: http://getclicky.com/help/api.
-
-## Installation
-
-``` ruby
-## Gemfile for Rails 3, Sinatra, and Merb
-gem 'will_paginate', '~> 3.0'
-```
-
-
-## 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.
-
-``` ruby
-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.
-
-``` ruby
-getclicky = Getclicky::Client.new
-```
-
-### Usage
-					
-All types in API are methods here looks, you can find all types http://getclicky.com/help/api:
-
-``` ruby
-getClicky.pages()
-getClicky.tweets()
-getClicky.visitors()
-```
-	
-In each method you can pass optional parameters as a hash looks:
-
-``` ruby
-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
-
-``` ruby
-getClicky.visitors(:output => :json, :date => "last-7-days", :daily => 1)
-```
-	
-##### CSV
-
-``` ruby
-  getClicky.visitors(:output => :csv, :date => "last-7-days", :daily => 1)
-```
-	
-##### PHP
-
-``` ruby
-  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)