chartbeat 0.1.0 → 0.2.0

data/README.md

@@ -23,8 +23,8 @@ historical calls and options
     c.alerts           :since => 1276980619
     c.snapshots        :timestamp => 1276980619
     c.stats
-    c.data_series
-    c.day_data_series
+    c.data_series      #not working right now
+    c.day_data_series  :timestamp => 1276980619, :type => 'paths'
     
 other calls and options
 

data/Rakefile

@@ -10,7 +10,8 @@ begin
     gem.email = "almshaw@gmail.com"
     gem.homepage = "http://github.com/ashaw/chartbeat"
     gem.authors = ["Al Shaw"]
-    gem.add_dependency "httparty"
+    gem.add_dependency "rest-client"
+    gem.add_dependency "crack"
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "fakeweb"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/chartbeat.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chartbeat}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Al Shaw"]
-  s.date = %q{2010-06-19}
+  s.date = %q{2010-09-17}
   s.description = %q{A Ruby wrapper for the Chartbeat API}
   s.email = %q{almshaw@gmail.com}
   s.extra_rdoc_files = [
@@ -54,16 +54,19 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<crack>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<fakeweb>, [">= 0"])
     else
-      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<crack>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<fakeweb>, [">= 0"])
     end
   else
-    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<crack>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<fakeweb>, [">= 0"])
   end

data/lib/chartbeat.rb

@@ -1,124 +1,35 @@
-require 'httparty'
+require 'crack'
+require 'rest_client'
 
 class Chartbeat
-  include HTTParty
-  
-  base_uri 'chartbeat.com/api'   
-  format :json
-  
+  YESTERDAY         = Time.now.to_i - 86400
+  BASE_URI          = 'chartbeat.com/api'
+  METHODS           = [:pages, :pathsummary, :recent, :summize, :toppages, :histogram, :summary]
+  DASHAPI_METHODS   = [:alerts, :snapshots, :stats, :data_series, :day_data_series]
+  DEFAULT_ARG_VALS  = {:path => '/', :keys => 'n', :types => 'n', :since => YESTERDAY, 
+                       :timestamp => YESTERDAY, :days => 1, :minutes => 20, :type => 'path', 
+                       :breaks => 'n'}
+
   # c = Chartbeat.new :apikey => 'yourkey', :host => 'yourdomain.com'
   def initialize(opts = {})
-    self.class.default_params :apikey => opts[:apikey]
-    self.class.default_params :host => opts[:host]
-  end
-  
-  #
-  # real-time calls
-  #
-  
-  # c.pages :path => '/'
-  def pages(opts = {})
-    q = { :path => nil
-        }.merge!(opts)
-        
-    self.class.get("/pages/", :query => q)
-  end
-  
-  def pathsummary(opts = {})
-    q = { :keys => 'n',
-          :types => 'n'
-        }.merge!(opts)
-    
-    self.class.get("/pathsummary/", :query => q)
+    raise RuntimeError, "You must provide an API key or host" unless opts[:apikey] && opts[:host]
+    @apikey = opts[:apikey]
+    @host = opts[:host]
   end
-  
-  def recent(opts = {})
-    q = { :limit => nil,
-          :path => '/' 
-         }.merge!(opts)
     
-    self.class.get("/recent/", :query => q)
-  end
-  
-  def summize(opts = {})
-    q = { :path => '/'
-        }.merge!(opts)
-        
-    self.class.get("/summize/", :query => q)
-  end
-  
-  def toppages(opts = {})
-    q = { :limit => nil
-        }.merge!(opts)
-        
-    self.class.get("/toppages/", :query => q)
-  end
-  
-  #
-  # historical calls
-  #
-  
-  YESTERDAY = Time.now.to_i - 86400
-  
-  #defaults to yesterday
-  def alerts(opts = {})
-    q = { :since => YESTERDAY 
-        }.merge!(opts)
-        
-    self.class.get("/dashapi/alerts/", :query => q)
-  end
-  
-  def snapshots(opts = {})
-    q = { :timestamp => YESTERDAY
-        }.merge!(opts)
-        
-    self.class.get("/dashapi/snapshots/", :query => q)
-  end
-  
-  def stats
-    self.class.get("/dashapi/stats/")
-  end
-  
-  #NOT WORKING, "We're most likely pushing out some new changes."
-  def data_series(opts = {})
-    q = { :timestamp => YESTERDAY,
-          :days => 1,
-          :minutes => 20,
-          :type => 'path',
-          :val => nil
-        }.merge!(opts)
+  def method_missing(m, *args)
+    super unless METHODS.include?(m) || DASHAPI_METHODS.include?(m)
     
-    self.class.get("/dashapi/data_series/", :query => q)
-  end
-  
-  def day_data_series(opts = {})
-    q = { :timestamp => YESTERDAY,
-          :type => 'paths'
-        }.merge!(opts)
-   
-   self.class.get("/dashapi/day_data_series/", :query => q) 
+    query = *args
+    query_to_perform = {:apikey => @apikey, :host => @host}
+    DEFAULT_ARG_VALS.each do |k,v|
+      if query && query[k]
+        v = query[k]
+      end
+      query_to_perform[k] = v
+    end
+    prefix = DASHAPI_METHODS.include?(m) ? '/dashapi' : ''
+    data = Crack::JSON.parse(RestClient.get("http://" + BASE_URI + prefix + '/' + m.to_s + '/', :params => query_to_perform))
   end
-  
-  #
-  # other calls
-  #
-  
-  def histogram(opts = {})
-    q = { :keys => 'n',
-          :breaks => 'n',
-          :path => nil
-        }.merge!(opts)
-  
-    self.class.get('/histogram/', :query => q)
-  end
-
-  def summary(opts = {})
-    q = { :keys => 'n',
-          :types => 'n',
-          :path => nil
-        }.merge!(opts)
     
-    self.class.get('/summary/', :query => q)
-  end
-  
 end

data/spec/chartbeat_spec.rb

@@ -4,97 +4,97 @@ HOST = 'fakehost.com'
 KEY = 'fake_key'
 
 describe "Chartbeat" do
-	
-	before :each do
-		@c = Chartbeat.new :apikey => KEY, :host => HOST	
-	end
-	
+  
+  before :each do
+    @c = Chartbeat.new :apikey => KEY, :host => HOST  
+  end
+  
   it "should get and parse the 'pages' endpoint" do
-		register_uri("http://chartbeat.com/api/pages/?apikey=#{KEY}&host=#{HOST}&path=", "pages")
-		
-		pages = @c.pages
-		titles = pages['titles'].to_a
-		titles[0][1].should eql('Talking Points Memo | Breaking News and Analysis')
+    register_uri("http://chartbeat.com/api/pages/", "pages")
+    
+    pages = @c.pages
+    titles = pages['titles'].to_a
+    titles[0][1].should eql('Talking Points Memo | Breaking News and Analysis')
   end
   
   it "should get and parse the 'pathsummary' endpoint" do
-  	register_uri("http://chartbeat.com/api/pathsummary/?apikey=#{KEY}&host=#{HOST}&keys=n&types=n", "pathsummary")
-  	
-  	pathsummary = @c.pathsummary.to_a
-  	pathsummary[0][0].should eql('/2010/06/the_gaza_flotilla_raid_what_do_we_know.php')
+    register_uri("http://chartbeat.com/api/pathsummary/", "pathsummary")
+    
+    pathsummary = @c.pathsummary.to_a
+    pathsummary[0][0].should eql('/2010/06/the_gaza_flotilla_raid_what_do_we_know.php')
   end
   
   it "should get and parse the 'recent' endpoint" do
-  	register_uri("http://chartbeat.com/api/recent/?apikey=#{KEY}&host=#{HOST}&path=%2F&limit=", "recent")
-  	
-  	recent = @c.recent
-  	recent[0]['i'].should eql('Talking Points Memo | Breaking News and Analysis')
+    register_uri("http://chartbeat.com/api/recent/", "recent")
+    
+    recent = @c.recent
+    recent[0]['i'].should eql('Talking Points Memo | Breaking News and Analysis')
   end
   
   it "should get and parse the 'summize' endpoint" do
-  	register_uri("http://chartbeat.com/api/summize/?apikey=#{KEY}&host=#{HOST}&path=%2F", "summize")
-  	
-  	summize = @c.summize
-		summize['new'].should eql(40)
-		summize['idle'].should eql(382)
+    register_uri("http://chartbeat.com/api/summize/", "summize")
+    
+    summize = @c.summize
+    summize['new'].should eql(40)
+    summize['idle'].should eql(382)
   end
 
   it "should get and parse the 'toppages' endpoint" do
-  	register_uri("http://chartbeat.com/api/toppages/?apikey=#{KEY}&host=#{HOST}&limit=", "toppages")
-  	
-  	toppages = @c.toppages
-  	toppages[0]['i'].should eql('Talking Points Memo | Breaking News and Analysis')
-  	toppages[0]['path'].should eql('/')
+    register_uri("http://chartbeat.com/api/toppages/", "toppages")
+    
+    toppages = @c.toppages
+    toppages[0]['i'].should eql('Talking Points Memo | Breaking News and Analysis')
+    toppages[0]['path'].should eql('/')
   end
-	
-	# Not implemented yet because chartbeat is returning blank arrays for this call
+  
+  # Not implemented yet because chartbeat is returning blank arrays for this call
   it "should get and parse the 'alerts' endpoint"
 
   it "should get and parse the 'snapshots' endpoint" do
-  	register_uri("http://chartbeat.com/api/dashapi/snapshots/?apikey=#{KEY}&host=#{HOST}&timestamp=#{Chartbeat::YESTERDAY}","snapshots")
-  	
-  	snapshots = @c.snapshots.to_a
-  	
-  	titles = snapshots[0]
-  	geo = snapshots[1]
-  	visitlength = snapshots[2]
-  	
-  	titles[1]['/2010/06/jon-stewart-barton-was-actually-reading-disdainful-asshle-digest-at-the-bp-hearings-video.php?ref=fpblg'].should eql ("Jon Stewart: Barton Was Actually Reading 'Disdainful Assh*le Digest' At The BP Hearings (VIDEO) | TPM LiveWire")
+    register_uri("http://chartbeat.com/api/dashapi/snapshots/","snapshots")
+    
+    snapshots = @c.snapshots.to_a
+    
+    titles = snapshots[0]
+    geo = snapshots[1]
+    visitlength = snapshots[2]
+    
+    titles[1]['/2010/06/jon-stewart-barton-was-actually-reading-disdainful-asshle-digest-at-the-bp-hearings-video.php?ref=fpblg'].should eql ("Jon Stewart: Barton Was Actually Reading 'Disdainful Assh*le Digest' At The BP Hearings (VIDEO) | TPM LiveWire")
     geo[1]['countries']['US'].should eql(474)
     visitlength[1][0]['idle'].should eql(101.0)    
   end
 
   it "should get and parse the 'stats' endpoint" do
-  	register_uri("http://chartbeat.com/api/dashapi/stats/?apikey=#{KEY}&host=#{HOST}","stats")
-  	
-  	stats = @c.stats
-  	
-  	stats['read_min'].should eql(5)
-  	stats['people_max'].should eql(3742)
+    register_uri("http://chartbeat.com/api/dashapi/stats/","stats")
+    
+    stats = @c.stats
+    
+    stats['read_min'].should eql(5)
+    stats['people_max'].should eql(3742)
   end
-	
-	# Not implemented yet. Chartbeat is returning an error for this call at this time.
+  
+  # Not implemented yet. Chartbeat is returning an error for this call at this time.
   it "should get and parse the 'data_series' endpoint"
 
   it "should get and parse the 'day_data_series' endpoint" do
-    register_uri("http://chartbeat.com/api/dashapi/day_data_series/?apikey=#{KEY}&host=#{HOST}&type=paths&timestamp=#{Chartbeat::YESTERDAY}","day_data_series")
-  	
-  	day_data_series = @c.day_data_series.to_a
-  	day_data_series[0][0].should eql("/archives/2010/06/painfully_funny php")
+    register_uri("http://chartbeat.com/api/dashapi/day_data_series/","day_data_series")
+    
+    day_data_series = @c.day_data_series.to_a
+    day_data_series[0][0].should eql("/archives/2010/06/painfully_funny php")
   end
 
   it "should get and parse the 'histogram' endpoint" do
-    register_uri("http://chartbeat.com/api/histogram/?apikey=#{KEY}&host=#{HOST}&keys=n&breaks=n&path=","histogram")
-		
-		histogram = @c.histogram
-		histogram['n']['data']['sumOfSquares'].should eql(91.0)
+    register_uri("http://chartbeat.com/api/histogram/","histogram")
+    
+    histogram = @c.histogram
+    histogram['n']['data']['sumOfSquares'].should eql(91.0)
   end
 
   it "should get and parse the 'summary' endpoint" do
-    register_uri("http://chartbeat.com/api/summary/?apikey=#{KEY}&host=#{HOST}&keys=n&types=n&path=","summary")
+    register_uri("http://chartbeat.com/api/summary/","summary")
 
-		summary = @c.summary
-		summary['n']['data']['sumOfSquares'].should eql(99.0)
-	end
-	
+    summary = @c.summary
+    summary['n']['data']['sumOfSquares'].should eql(99.0)
+  end
+  
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
 require 'chartbeat'
 require 'fakeweb'
 require 'spec'
@@ -15,7 +16,8 @@ def fixture_file(filename)
 end
 
 def register_uri(uri, method)
-  FakeWeb.register_uri(:get, uri, :body => fixture_file("#{method}.json"))
+  query_string = "?breaks=n&type=path&types=n&path=%2F&since=#{Chartbeat::YESTERDAY}&apikey=fake_key&timestamp=#{Chartbeat::YESTERDAY}&days=1&keys=n&minutes=20&host=fakehost.com"
+  FakeWeb.register_uri(:get, "#{uri}#{query_string}", :body => fixture_file("#{method}.json"))
 end
 
 Spec::Runner.configure do |config| 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chartbeat
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Al Shaw
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-19 00:00:00 -04:00
+date: 2010-09-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: httparty
+  name: rest-client
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -33,9 +33,23 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: crack
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,11 +61,11 @@ dependencies:
         - 9
         version: 1.2.9
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: fakeweb
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -61,7 +75,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 description: A Ruby wrapper for the Chartbeat API
 email: almshaw@gmail.com
 executables: []