jonuts-garb 0.2.3 → 0.2.4

data/README.md

@@ -5,12 +5,14 @@ garb
 
   http://github.com/vigetlabs/garb
 
-Changes
-=======
+Important Changes
+=================
+
+  Version 0.2.4 requires happymapper from rubygems, version 0.2.5. Be sure to update.
 
   Version 0.2.0 makes major changes (compared to 0.1.0) to the way garb is used to build reports.
-  There is now both a module that gets included for generating defined classes.
-  As well as, slight changes to the way that the Report class can be used.
+  There is now both a module that gets included for generating defined classes,
+  as well as, slight changes to the way that the Report class can be used.
 
 Description
 -----------
@@ -27,9 +29,15 @@ Login
   
     > Garb::Session.login(username, password)
 
+Accounts
+--------
+    > Garb::Account.all
+
 Profiles
 --------
 
+    > Garb::Account.first.profiles
+    
     > Garb::Profile.all
     > profile = Garb::Profile.all.first
 
@@ -141,7 +149,7 @@ SSL
   Next, be sure to download http://curl.haxx.se/ca/cacert.pem into your application somewhere.
   Then, define a constant CA_CERT_FILE and point to that file.
 
-  For whatever reason, simply create a new certificate store and setting the defaults would
+  For whatever reason, simply creating a new certificate store and setting the defaults would
   not validate the google ssl certificate as authentic.
 
 TODOS
@@ -156,12 +164,15 @@ TODOS
 Requirements
 ------------
 
-  libxml
-  happymapper
+  happymapper >= 0.2.5 (should also install libxml)
 
 Install
 -------
 
+    sudo gem install garb
+
+    OR
+
     sudo gem install vigetlabs-garb -s http://gems.github.com
 
 License

data/Rakefile

@@ -17,7 +17,7 @@ spec = Gem::Specification.new do |s|
   s.files             = %w(README.md Rakefile) + Dir.glob("lib/**/*")
   s.test_files        = Dir.glob("test/**/*")
 
-  s.add_dependency("jnunemaker-happymapper", [">= 0.2.2"])
+  s.add_dependency("happymapper", [">= 0.2.5"])
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/lib/extensions/array.rb

@@ -0,0 +1,16 @@
+class Array
+  def group_by
+    h = Hash.new
+
+    each do |element|
+      key = yield(element)
+      if h.has_key?(key)
+        h[key] << element
+      else
+        h[key] = [element]
+      end
+    end
+
+    h.map{|k,v| v}
+  end
+end

data/lib/extensions/string.rb

@@ -10,4 +10,8 @@ class String
   def to_ga
     "ga:#{self}"
   end
-end
+
+  def from_ga
+    self.gsub(/^ga\:/, '')
+  end
+end

data/lib/extensions/symbol.rb

@@ -15,6 +15,8 @@ class Symbol
   def desc
     Operator.new(self, '-', true)
   end
+  # aliasing this, as it interferes with DataMapper's Symbol#desc
+  alias :dsc :desc
 
   operator  :eql => '==',
             :not_eql => '!=',
@@ -33,4 +35,4 @@ class Symbol
   def to_ga
     "ga:#{self.to_s.lower_camelized}"
   end
-end
+end

data/lib/garb/account.rb

@@ -0,0 +1,15 @@
+module Garb
+  class Account
+    attr_reader :id, :name, :profiles
+
+    def initialize(profiles)
+      @id = profiles.first.account_id    
+      @name = profiles.first.account_name
+      @profiles = profiles
+    end
+
+    def self.all
+      Profile.all.group_by{|p| p.account_id}.map{|profiles| new(profiles)}
+    end
+  end
+end

data/lib/garb/data_request.rb

@@ -1,5 +1,6 @@
 module Garb
   class DataRequest
+    class HTTPRequestError < StandardError;end
 
     def initialize(base_url, parameters={})
       @base_url = base_url
@@ -20,7 +21,7 @@ module Garb
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       response = http.get("#{uri.path}#{query_string}", 'Authorization' => "GoogleLogin auth=#{Session.auth_token(email)}")
-      raise response.body.inspect unless response.is_a?(Net::HTTPOK)
+      raise HTTPRequestError, response.body.inspect unless response.is_a?(Net::HTTPOK)
       response
     end
 

data/lib/garb/profile.rb

@@ -1,7 +1,7 @@
 module Garb
   class Profile
     
-    attr_reader :table_id, :title, :account_name, :email
+    attr_reader :table_id, :title, :account_name, :account_id, :email
     
     class Property
       include HappyMapper
@@ -11,18 +11,20 @@ module Garb
       
       attribute :name, String
       attribute :value, String
+
+      def instance_name
+        name.from_ga.underscored
+      end
     end
 
     class Entry
       include HappyMapper
       
       tag 'entry'
-      
-      element :id, Integer
+
       element :title, String
       element :tableId, String, :namespace => 'dxp'
-      
-      # has_one :table_id, TableId
+
       has_many :properties, Property
     end
 
@@ -30,18 +32,21 @@ module Garb
       @email = Session.email(email)
       @title = entry.title
       @table_id = entry.tableId
-      @account_name = entry.properties.detect{|p| p.name == 'ga:accountName'}.value
+
+      entry.properties.each do |p|
+        instance_variable_set :"@#{p.instance_name}", p.value
+      end
     end
 
     def id
-      @table_id.sub(/^ga:/, '')
+      @table_id.from_ga
     end
 
     def self.all(email=nil)
       email = Session.email(email)
       url = "https://www.google.com/analytics/feeds/accounts/#{email}"
       response = DataRequest.new(url).send_request(email)
-      Entry.parse(response.body).map {|e| Garb::Profile.new(e, email)}
+      Entry.parse(response.body).map {|entry| new(entry, email)}
     end
   end
 end

data/lib/garb/version.rb

@@ -3,11 +3,11 @@ module Garb
 
     MAJOR = 0
     MINOR = 2
-    TINY  = 3
+    TINY  = 4
 
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')
     end
 
   end
-end
+end

data/lib/garb.rb

@@ -12,6 +12,7 @@ require 'garb/authentication_request'
 require 'garb/data_request'
 require 'garb/session'
 require 'garb/profile'
+require 'garb/account'
 require 'garb/report_parameter'
 require 'garb/report_response'
 require 'garb/resource'
@@ -20,7 +21,7 @@ require 'garb/report'
 require 'extensions/string'
 require 'extensions/operator'
 require 'extensions/symbol'
-require 'extensions/happymapper'
+require 'extensions/array'
 
 module Garb
   # :stopdoc:

data/test/unit/account_test.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+module Garb
+  class AccountTest < Test::Unit::TestCase
+    context "The Account class" do
+      should "have an array of accounts with all profiles" do
+        p1 = stub(:account_id => '1111', :account_name => 'Blog 1')
+        p2 = stub(:account_id => '1112', :account_name => 'Blog 2')
+        Profile.stubs(:all).returns([p1,p2,p1,p2])
+        Account.expects(:new).with([p1,p1]).returns('account1')
+        Account.expects(:new).with([p2,p2]).returns('account2')
+        assert_equal ['account1','account2'], Account.all
+      end
+    end
+
+    context "An instance of the Account class" do
+      context "when creating a new account from an array of profiles" do
+        setup do
+          profile = stub(:account_id => '1111', :account_name => 'Blog 1')
+          @profiles = [profile,profile]
+          @account = Account.new(@profiles)
+        end
+
+        should "take the account id from the first profile" do
+          assert_equal @profiles.first.account_id, @account.id
+        end
+
+        should "take the account name from the first profile" do
+          assert_equal @profiles.first.account_name, @account.name
+        end
+
+        should "store the array of profiles" do
+          assert_equal @profiles, @account.profiles
+        end
+      end
+    end
+  end
+end

data/test/unit/profile_test.rb

@@ -52,6 +52,14 @@ module Garb
       should "have a value for :id" do
         assert_equal '12345', @profile.id
       end
+
+      should "have a value for :account_id" do
+        assert_equal '1111', @profile.account_id
+      end
+
+      should "have a value for :account_name" do
+        assert_equal 'Blog Beta', @profile.account_name
+      end
       
     end
 

data/test/unit/string_test.rb

@@ -5,5 +5,9 @@ class StringTest < Test::Unit::TestCase
     should 'prefix a string with ga: for GA' do
       assert_equal 'ga:bob', 'bob'.to_ga
     end
+
+    should 'remove ga: prefix' do
+      assert_equal 'bob', 'ga:bob'.from_ga
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jonuts-garb
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Tony Pitale
@@ -11,18 +11,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-11 00:00:00 -07:00
+date: 2009-06-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: jnunemaker-happymapper
+  name: happymapper
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.2
+        version: 0.2.5
     version: 
 description: 
 email: tony.pitale@viget.com
@@ -36,11 +36,12 @@ files:
 - README.md
 - Rakefile
 - lib/extensions
-- lib/extensions/happymapper.rb
+- lib/extensions/array.rb
 - lib/extensions/operator.rb
 - lib/extensions/string.rb
 - lib/extensions/symbol.rb
 - lib/garb
+- lib/garb/account.rb
 - lib/garb/authentication_request.rb
 - lib/garb/data_request.rb
 - lib/garb/oauth_session.rb
@@ -58,6 +59,7 @@ files:
 - test/fixtures/report_feed.xml
 - test/test_helper.rb
 - test/unit
+- test/unit/account_test.rb
 - test/unit/authentication_request_test.rb
 - test/unit/data_request_test.rb
 - test/unit/garb_test.rb
@@ -95,7 +97,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Google Analytics API Ruby Wrapper
 test_files: 
 - test/fixtures
@@ -104,6 +106,7 @@ test_files:
 - test/fixtures/report_feed.xml
 - test/test_helper.rb
 - test/unit
+- test/unit/account_test.rb
 - test/unit/authentication_request_test.rb
 - test/unit/data_request_test.rb
 - test/unit/garb_test.rb

data/lib/extensions/happymapper.rb

@@ -1,67 +0,0 @@
-require 'libxml'
-
-module HappyMapper
-
-  module ClassMethods
-    include LibXML
-
-    def parse(xml, options = {})
-      # locally scoped copy of namespace for this parse run
-      namespace = @namespace
-
-      if xml.is_a?(XML::Node)
-        node = xml
-      else
-        if xml.is_a?(XML::Document)
-          node = xml.root
-        else
-          node = XML::Parser.string(xml).parse.root
-        end
-
-        root = node.name == tag_name
-      end
-
-      # This is the entry point into the parsing pipeline, so the default
-      # namespace prefix registered here will propagate down
-      namespaces = node.namespaces
-      if namespaces && namespaces.default
-        already_assigned = namespaces.definitions.detect do |defn|
-          namespaces.default && namespaces.default.href == defn.href && defn.prefix
-        end
-        namespaces.default_prefix = DEFAULT_NS unless already_assigned
-        namespace ||= DEFAULT_NS
-      end
-
-      xpath = root ? '/' : './/'
-      xpath += "#{namespace}:" if namespace
-      xpath += tag_name
-      # puts "parse: #{xpath}"
-      
-      nodes = node.find(xpath)
-      collection = nodes.collect do |n|
-        obj = new
-        
-        attributes.each do |attr| 
-          obj.send("#{attr.method_name}=", 
-                    attr.from_xml_node(n, namespace))
-        end
-        
-        elements.each do |elem|
-          obj.send("#{elem.method_name}=", 
-                    elem.from_xml_node(n, namespace))
-        end
-        
-        obj
-      end
-
-      # per http://libxml.rubyforge.org/rdoc/classes/LibXML/XML/Document.html#M000354
-      nodes = nil
-
-      if options[:single] || root
-        collection.first
-      else
-        collection
-      end
-    end
-  end
-end