getclicky 0.1.beta1 → 0.1.beta2

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2011 Peterson Ferreira
+
+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

@@ -26,32 +26,28 @@ Then you can simply instantiate a new Getclicky::Client object.
 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)
+  getClicky.visitors(:output => :json, :date => "last-7-days", :daily => 1)
 	
 ===== CSV
 
-  getClicky.visitors(:output => "csv", :date => "last-7-days", :daily => 1)
+  getClicky.visitors(:output => :csv, :date => "last-7-days", :daily => 1)
 	
 ===== PHP
 
-  getClicky.visitors(:output => "php", :date => "last-7-days", :daily => 1)
+  getClicky.visitors(:output => :php, :date => "last-7-days", :daily => 1)
 	
 	
 This library does't support multiple types yet.
@@ -63,27 +59,4 @@ This library does't support multiple types yet.
 	
 == 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.
+* Peterson Ferreira (petersonferreiras@gmail.com)

data/lib/getclicky/client.rb

@@ -1,13 +1,14 @@
 module Getclicky
-  class Client    
-    # Dynamically defines the methods to be called by type
+  class Client
+    # Dynamically defines the methods to be called.
+    # This is a interface of library.
     #
     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
+      class_eval <<-RUBY, __FILE__, __LINE__
+        def #{type.to_s.downcase}(params = {})                      # def pages(params = {})
+          response = Getclicky::Request.new(:#{type}, params).get   #   response = Getclicky::Request.new(:pages, params).get
+          response.data                                             #   response.data
+        end                                                         # end
       RUBY
     end
   end

data/lib/getclicky/request.rb

@@ -1,21 +1,19 @@
-# 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  
+  class Request  
     include HTTParty
-    extend self
+      
+    attr_accessor :type, :params
+              
+    def initialize(type, params = {})
+      @type = type
+      @params = params
+    end
     
     # 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))
-      
+    #    
+    def get
+      response = self.class.get(Getclicky.endpoint, :query => build_params(@type, @params))
+
       case response.code
       when "404"
         raise Getclicky::NotFoundError
@@ -23,12 +21,12 @@ module Getclicky
         Getclicky::Response.new(response)
       end
     end
-    
-    # Build the hash of options for given a resquest to API
+
+    # 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.merge(params)
+      query.merge(params) if params
     end
   end
 end

data/lib/getclicky/response.rb

@@ -1,20 +1,13 @@
-# 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
+    attr_accessor :item
     
-    def initializer(request)
-      @request = request
+    def initialize(item)
+      @item = item
     end
-    
+      
     def data
-      @request.body
+      @item.body
     end
   end
 end

data/lib/getclicky/types.rb

@@ -1,13 +1,5 @@
-# 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
-    
+  module Types    
     # Request types that the API accepts.
     #
     ALL = [

data/lib/getclicky/version.rb

@@ -1,15 +1,8 @@
-# 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"
+    PATCH = "beta2"
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/getclicky/client_spec.rb

@@ -1,13 +1,13 @@
 require "spec_helper"
 
 describe Getclicky::Client do
-  context "methods for request type" do
+  context "should be create methods to make request to API" 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
 end

data/spec/getclicky/request_spec.rb

@@ -1,8 +1,23 @@
 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}
+  
+  subject {
+    Getclicky::Request.new(:pages, :limit => 10, :hourly => 1)
+  }
+  
+  its(:type) { should eql (:pages) }
+  its(:params) { should eql ({:limit => 10, :hourly => 1})}
+  
+  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}
+    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}
+    end
   end
 end

data/spec/getclicky_spec.rb

@@ -7,7 +7,7 @@ describe Getclicky do
       Getclicky.site_id.should == "123"
     end
     
-    it "should be set sitekey" do
+    it "should be set site_key" do
       Getclicky.configure { |c| c.sitekey = "123" }
       Getclicky.sitekey.should == "123"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getclicky
 version: !ruby/object:Gem::Version
-  version: 0.1.beta1
+  version: 0.1.beta2
   prerelease: 4
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-11 00:00:00.000000000Z
+date: 2011-08-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70254699111300 !ruby/object:Gem::Requirement
+  requirement: &70272461720840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70254699111300
+  version_requirements: *70272461720840
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70254699110800 !ruby/object:Gem::Requirement
+  requirement: &70272461720340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.7.8
   type: :runtime
   prerelease: false
-  version_requirements: *70254699110800
+  version_requirements: *70272461720340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70254699110340 !ruby/object:Gem::Requirement
+  requirement: &70272461719860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70254699110340
+  version_requirements: *70272461719860
 - !ruby/object:Gem::Dependency
   name: test_notifier
-  requirement: &70254699109860 !ruby/object:Gem::Requirement
+  requirement: &70272461719400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *70254699109860
+  version_requirements: *70272461719400
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70254699109400 !ruby/object:Gem::Requirement
+  requirement: &70272461718940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70254699109400
+  version_requirements: *70272461718940
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70254699108920 !ruby/object:Gem::Requirement
+  requirement: &70272461718480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '0.11'
   type: :development
   prerelease: false
-  version_requirements: *70254699108920
+  version_requirements: *70272461718480
 description: Ruby Wrapper for GetClicky API Analytics
 email:
 - petersonferreiras@gmail.com
@@ -86,6 +86,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - README.rdoc
 - Rakefile
 - getclicky.gemspec
@@ -120,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.7
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: Ruby Wrapper for GetClicky API Analytics