url_shortener 0.0.4 → 0.0.5

data/History.txt

@@ -28,3 +28,13 @@
   * other api call methods now return a UrlShortener::Response object
   These changes are introduced to return the api call results in a flexible manner and provide more flexibility for manipulating result output
 
+=== 0.0.5 2009-11-17
+
+* 3 additions:
+	* adds Hashie for convert hashe keys to method calls
+	* adds UrlShortener::Response::Stats
+	* adds some convenience methods to the returned results for stats
+
+* 1 changes:
+  * api call method UrlShortener::Client#stats now returns a UrlShortener::Response::Stats object
+

data/Manifest.txt

@@ -9,6 +9,7 @@ lib/url_shortener/interface.rb
 lib/url_shortener/response.rb
 lib/url_shortener/response/shorten.rb
 lib/url_shortener/response/expand.rb
+lib/url_shortener/response/stats.rb
 spec/spec_helper.rb
 spec/url_shortener/authorize_spec.rb
 spec/url_shortener/client_spec.rb
@@ -16,6 +17,7 @@ spec/url_shortener/interface_spec.rb
 spec/url_shortener/response_spec.rb
 spec/url_shortener/response/shorten_spec.rb
 spec/url_shortener/response/expand_spec.rb
+spec/url_shortener/response/stats_spec.rb
 features/request_failure.feature
 features/api_calls.feature
 features/support/env.rb

data/README.rdoc

@@ -67,7 +67,6 @@ To use the url_shortener gem you need a bit.ly login and Api key.
 
 	stats = client.stats(:hash => '1RmnUT') # => UrlShortener::Response object
 	stats.result # => returns a hash of all data returned from bitly
-	#TODO: ADD convenience methods for stats
 
 ===To get url info
 

data/lib/url_shortener.rb

@@ -4,10 +4,12 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'rubygems'
 require 'httparty'
 require 'cgi'
+require 'hashie'
 require 'url_shortener/error.rb'
 require 'url_shortener/authorize.rb'
 require 'url_shortener/client.rb'
 require 'url_shortener/interface.rb'
 require 'url_shortener/response.rb'
 require 'url_shortener/response/shorten.rb'
-require 'url_shortener/response/expand.rb'
+require 'url_shortener/response/expand.rb'
+require 'url_shortener/response/stats.rb'

data/lib/url_shortener/client.rb

@@ -33,7 +33,7 @@ module UrlShortener
     def stats(option)
       check_request_parameters(option)
       response = interface(nil, endpoint_with_options('stats',option)).get
-      UrlShortener::Response.new(response)
+      UrlShortener::Response::Stats.new(response)
     end
     
     def info(option)

data/lib/url_shortener/response.rb

@@ -1,10 +1,11 @@
 module UrlShortener
   class Response
     
-    attr_reader :result
+    attr_reader :result, :attributes
     
     def initialize(result)
       @result = result
+      @attributes = Hashie::Mash.new(result)
     end
     
   end

data/lib/url_shortener/response/stats.rb

@@ -0,0 +1,69 @@
+module UrlShortener
+  class Response::Stats < UrlShortener::Response
+    
+    def initialize(response)
+      super
+    end
+    
+    def clicks
+      attributes.clicks
+    end
+    
+    def user_clicks
+      attributes.userClicks
+    end
+    
+    def referrers
+      find_referrers
+    end
+    
+    def user_referrers
+      find_referrers(true)
+    end
+    
+    # There are user referrers and only referrers
+    def find_referrers(user_referrers=false)
+      return unless referrer_data?
+      base_referrer = user_referrers ? attributes.userReferrers : attributes.referrers
+      return unless base_referrer
+      referrer_values(base_referrer)
+    end
+    
+    private
+    
+    def referrer_values(base_referrer)
+      collect_referrers = []
+      base_referrer.nodeKeyVal.each { |base| collect_referrers << full_referrer_urls(base) if node_key?(base) }
+      collect_referrers.flatten
+    end
+    
+    def full_referrer_urls(base)
+      return unless node_key?(base)
+      resources = base.nodeKeyVal.is_a?(Array) ? base.nodeKeyVal.collect{|node| node.nodeKey} : base.nodeKeyVal.nodeKey
+      referrer_urls(base.nodeKey, resources)
+    end
+    
+    def node_key?(base)
+      !(base.nil? || base.nodeKeyVal.nil?)
+    end
+    
+    def attributes_present?
+      !(attributes.nil? || attributes.empty?)
+    end
+    
+    def referrers_present?(another_attr=nil)
+      return !(attributes.referrers.nil? || attributes.referrers.empty?) unless another_attr
+      !(attributes.send(:another_attr).nil? || attributes.send(:another_attr).empty?)
+    end
+    
+    def referrer_data?
+      attributes_present? && referrers_present?
+    end
+    
+    def referrer_urls(base_url, resources)
+      return base_url unless resources
+      resources.collect { |resource| "#{base_url}#{resource}" }
+    end
+    
+  end
+end

data/spec/url_shortener/client_spec.rb

@@ -153,6 +153,10 @@ describe UrlShortener::Client do
         @interface.should_receive(:get)
         @client.stats(:hash => @hash)
       end
+      
+      it "should return the UrlShortener::Response::Stats object" do
+        @client.stats(:hash => @hash).should be_instance_of(UrlShortener::Response::Stats)
+      end
     end
     
     describe "#info" do

data/spec/url_shortener/response/stats_spec.rb

@@ -0,0 +1,172 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe UrlShortener::Response::Stats do
+  
+  describe "#clicks" do
+    before(:each) do
+      @hashie = stub('Hashie::Mash')
+      @response = {:referrers => {:key => :val}, :clicks => '23'}
+      @stats = UrlShortener::Response::Stats.new(@response)
+      @stats.stub!(:attributes).and_return(@hashie)
+      @hashie.stub!(:clicks)
+    end
+    
+    it "should get the hash attributes" do
+      @stats.should_receive(:attributes).and_return(@hashie)
+      @stats.clicks
+    end
+    
+    it "should get the clicks from the hash attributes" do
+      @hashie.should_receive(:clicks)
+      @stats.clicks
+    end
+    
+    it "should return nil when response is empty" do
+      response = {}
+      @stats = UrlShortener::Response::Stats.new(response)
+      @stats.clicks.should eql(nil)
+    end
+  end
+  
+  describe "#user_clicks" do
+    before(:each) do
+      @hashie = stub('Hashie::Mash')
+      @response = {:referrers => {:key => :val}, :clicks => '23', :userClicks => '233'}
+      @stats = UrlShortener::Response::Stats.new(@response)
+      @stats.stub!(:attributes).and_return(@hashie)
+      @hashie.stub!(:userClicks).and_return('233')
+    end
+    
+    it "should get the hash attributes" do
+      @stats.should_receive(:attributes).and_return(@hashie)
+      @stats.user_clicks
+    end
+    
+    it "should get the user clicks from the hash attributes" do
+      @hashie.should_receive(:userClicks)
+      @stats.user_clicks
+    end
+    
+    it "should return userClicks" do
+      @stats.user_clicks.should eql('233')
+    end
+    
+    it "should return nil when response is empty" do
+      response = {}
+      @stats = UrlShortener::Response::Stats.new(response)
+      @stats.user_clicks.should eql(nil)
+    end
+  end
+  
+  describe "#referrers" do
+    before(:each) do
+      @response = {:referrers => {:nodeKeyVal => {:nodeKey => 'val'}}}
+      @stats = UrlShortener::Response::Stats.new(@response)    end
+    
+    it "should get the hash attributes" do
+      @stats.should_receive(:find_referrers)
+      @stats.referrers
+    end
+    
+  end
+  
+  describe "#user_referrers" do
+    before(:each) do
+      @response = {:referrers => {:nodeKeyVal => {:nodeKey => 'val'}}}
+      @stats = UrlShortener::Response::Stats.new(@response)    
+    end
+    
+    it "should get the hash attributes" do
+      @stats.should_receive(:find_referrers).with(true)
+      @stats.user_referrers
+    end
+    
+  end
+  
+  describe "#find_referrers" do
+    before(:each) do
+      @response = {:referrers => {:nodeKeyVal => {:nodeKey => 'val'}}}
+      @stats = UrlShortener::Response::Stats.new(@response)    
+    end
+    
+    it "should check if referrer data is present " do
+      @stats.should_receive(:referrer_data?)
+      @stats.find_referrers
+    end
+    
+    context "when no referrer data present" do
+      before(:each) do
+        @stats.stub!(:referrer_data?)
+      end
+      it "should return nil" do
+        @stats.find_referrers.should eql(nil)
+      end
+      
+      it "should try to find the attributes" do
+        @stats.should_receive(:attributes).never
+        @stats.find_referrers
+      end
+      
+      it "should not try to get the referrer values" do
+        @stats.should_receive(:referrer_values).never
+        @stats.find_referrers
+      end
+    end
+    
+    context "when referrer data is present but referrer element is not" do
+      before(:each) do
+        @hashie = stub('Hashie::Mash')
+        @stats.stub!(:referrer_data?).and_return(true)
+        @stats.stub!(:attributes).and_return(@hashie)
+        @hashie.stub!(:referrers)
+        @hashie.stub!(:userReferrers)
+      end
+      
+      it "should find the attributes" do
+        @stats.should_receive(:attributes).times.at_least(1)
+        @stats.find_referrers
+      end
+      
+      it "should get referrers if true is not passed in parameter for user referrers" do
+        @hashie.should_receive(:referrers)
+        @stats.find_referrers
+      end
+      
+      it "should not get user referrers if true is not passed in parameter for user referrers" do
+        @hashie.should_receive(:userReferrers).never
+        @stats.find_referrers
+      end
+      
+      it "should get user referrers if true is passed in parameter for user referrers" do
+        @hashie.should_receive(:userReferrers)
+        @stats.find_referrers(true)
+      end
+      
+      it "should not get referrers if true is passed in parameter for user referrers" do
+        @hashie.should_receive(:referrers).never
+        @stats.find_referrers(true)
+      end
+      
+      it "should not get referrer values when referrers are not present" do
+        @stats.should_receive(:referrer_values).never
+        @stats.find_referrers
+      end
+    end
+    
+    context "when both referrer data referrer element is present" do
+      before(:each) do
+        @hashie = stub('Hashie::Mash')
+        @stats.stub!(:referrer_data?).and_return(true)
+        @stats.stub!(:attributes).and_return(@hashie)
+        @hashie.stub!(:referrers).and_return(@hashie)
+      end
+      
+      it "should get referrer values when referrers are present" do
+        @stats.should_receive(:referrer_values).with(@hashie)
+        @stats.find_referrers
+      end
+    end
+    
+  end
+  
+end

data/spec/url_shortener/response_spec.rb

@@ -4,12 +4,24 @@ describe UrlShortener::Response do
   
   describe ".new" do
     before(:each) do
-      @response = {:a_key => 'value'}
+      @response_hash = {:a_key => 'value'}
+      @attribute = stub('Hashie::Mash')
+      Hashie::Mash.stub!(:new).and_return(@attribute)
+      @response = UrlShortener::Response.new(@response_hash)
     end
     
-    it "should set the result attribute" do
-      response = UrlShortener::Response.new(@response)
-      response.result.should eql(@response)
+    it "should set the result method" do
+      @response.result.should eql(@response_hash)
+    end
+    
+    it "should set the attrubutes" do
+      @response.attributes.should eql(@attribute)
+    end
+    
+    it "should initialize a new Hashie::Mash attribute" do
+      Hashie::Mash.should_receive(:new).with(@response_hash)
+      @response.attributes    
+      UrlShortener::Response.new(@response_hash)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: url_shortener
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Nasir Jamal
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-15 00:00:00 +00:00
+date: 2009-11-17 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,10 +18,20 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 0.4.5
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.1.4
+    version: 
 description: Url Shortener is a Ruby library / gem and API wrapper for bit.ly to shorten/expand the urls and retrieve other information about them.
 email: nas35_in@yahoo.com
 executables: []
@@ -42,6 +52,7 @@ files:
 - lib/url_shortener/response.rb
 - lib/url_shortener/response/shorten.rb
 - lib/url_shortener/response/expand.rb
+- lib/url_shortener/response/stats.rb
 has_rdoc: true
 homepage: http://github.com/nas/url_shortener
 licenses: []
@@ -78,6 +89,7 @@ test_files:
 - spec/url_shortener/response_spec.rb
 - spec/url_shortener/response/shorten_spec.rb
 - spec/url_shortener/response/expand_spec.rb
+- spec/url_shortener/response/stats_spec.rb
 - features/api_calls.feature
 - features/request_failure.feature
 - features/support/env.rb