garb 0.8.0 → 0.8.1

data/lib/garb.rb

@@ -28,6 +28,12 @@ require 'garb/report_response'
 require 'garb/resource'
 require 'garb/report'
 
+# management
+require 'garb/management/feed'
+require 'garb/management/account'
+require 'garb/management/web_property'
+require 'garb/management/profile'
+
 require 'support'
 
 module Garb
@@ -46,4 +52,15 @@ module Garb
     thing.to_s.gsub(/^ga\:/, '').underscore
   end
   alias :from_ga :from_google_analytics
+
+  def parse_properties(entry)
+    entry['dxp:property'].inject({}) do |hash, p|
+      hash[Garb.from_ga(p['name'])] = p['value']
+      hash
+    end
+  end
+
+  def parse_link(entry, rel)
+    entry['link'].detect {|link| link["rel"] == rel}['href']
+  end
 end

data/lib/garb/management/account.rb

@@ -0,0 +1,32 @@
+module Garb
+  module Management
+    class Account
+      attr_reader :session, :path
+      attr_reader :id, :title, :name
+
+      def self.all(session = Session)
+        feed = Feed.new(session, '/accounts') # builds request and parses response
+
+        feed.entries.map {|entry| new(entry, session)}
+      end
+
+      def initialize(entry, session)
+        @session = session
+        @path = Garb.parse_link(entry, "self").gsub(Feed::BASE_URL, '')
+        @title = entry['title'].gsub('Google Analytics Account ', '')
+
+        properties = Garb.parse_properties(entry)
+        @id = properties["account_id"]
+        @name = properties["account_name"]
+      end
+
+      def web_properties
+        @web_properties ||= WebProperty.for_account(self) # will call path
+      end
+
+      def profiles
+        @profiles ||= Profile.for_account(self)
+      end
+    end
+  end
+end

data/lib/garb/management/feed.rb

@@ -0,0 +1,26 @@
+module Garb
+  module Management
+    class Feed
+      BASE_URL = "https://www.google.com/analytics/feeds/datasources/ga"
+
+      attr_reader :request
+
+      def initialize(session, path)
+        @request = DataRequest.new(session, BASE_URL+path)
+      end
+
+      def parsed_response
+        @parsed_response ||= Crack::XML.parse(response.body)
+      end
+
+      def entries
+        # possible to have nil entries, yuck
+        parsed_response ? [parsed_response['feed']['entry']].flatten.reject {|e| e.nil?} : []
+      end
+
+      def response
+        @response ||= request.send_request
+      end
+    end
+  end
+end

data/lib/garb/management/goal.rb

@@ -0,0 +1,20 @@
+module Garb
+  class Goal
+    attr_reader :name, :number, :value, :destination
+
+    def initialize(attributes={})
+      return unless attributes.is_a?(Hash)
+
+      @name = attributes['name']
+      @number = attributes['number'].to_i
+      @value = attributes['value'].to_f
+      @active = (attributes['active'] == 'true')
+
+      @destination = Destination.new(attributes[Garb.to_ga('destination')])
+    end
+
+    def active?
+      @active
+    end
+  end
+end

data/lib/garb/management/profile.rb

@@ -0,0 +1,42 @@
+module Garb
+  module Management
+    class Profile
+
+      include ProfileReports
+
+      attr_reader :session, :path
+      attr_reader :id, :title, :account_id, :web_property_id
+
+      def self.all(session = Session, path = '/accounts/~all/webproperties/~all/profiles')
+        feed = Feed.new(session, path)
+        feed.entries.map {|entry| new(entry, session)}
+      end
+
+      def self.for_account(account)
+        all(account.session, account.path+'/webproperties/~all/profiles')
+      end
+
+      def self.for_web_property(web_property)
+        all(web_property.session, web_property.path+'/profiles')
+      end
+
+      def initialize(entry, session)
+        @session = session
+        @path = Garb.parse_link(entry, "self").gsub(Feed::BASE_URL, '')
+        @title = entry['title'].gsub('Google Analytics Profile ', '')
+
+        properties = Garb.parse_properties(entry)
+        @id = properties['profile_id']
+        @account_id = properties['account_id']
+        @web_property_id = properties['web_property_id']
+      end
+
+      # def path
+      #   ['/accounts', self.account_id, 'webproperties', self.web_property_id, 'profiles', self.id].join('/')
+      # end
+
+      # def goals
+      # end
+    end
+  end
+end

data/lib/garb/management/web_property.rb

@@ -0,0 +1,30 @@
+module Garb
+  module Management
+    class WebProperty
+      attr_reader :session, :path
+      attr_reader :id, :account_id
+
+      def self.all(session = Session, path='/accounts/~all/webproperties')
+        feed = Feed.new(session, path)
+        feed.entries.map {|entry| new(entry, session)}
+      end
+
+      def self.for_account(account)
+        all(account.session, account.path+'/webproperties')
+      end
+
+      def initialize(entry, session)
+        @session = session
+        @path = Garb.parse_link(entry, "self").gsub(Feed::BASE_URL, '')
+
+        properties = Garb.parse_properties(entry)
+        @id = properties["web_property_id"]
+        @account_id = properties["account_id"]
+      end
+
+      def profiles
+        @profiles ||= Profile.for_web_property(self)
+      end
+    end
+  end
+end

data/lib/garb/profile.rb

@@ -11,8 +11,8 @@ module Garb
       @table_id = entry['dxp:tableId']
       @goals = (entry[Garb.to_ga('goal')] || []).map {|g| Goal.new(g)}
 
-      entry['dxp:property'].each do |p|
-        instance_variable_set :"@#{Garb.from_ga(p['name'])}", p['value']
+      Garb.parse_properties(entry).each do |k,v|
+        instance_variable_set :"@#{k}", v
       end
     end
 
@@ -24,6 +24,7 @@ module Garb
       AccountFeedRequest.new(session).entries.map {|entry| new(entry, session)}
     end
 
+    # ActiveSupport::Deprecation.warn
     def self.first(id, session = Session)
       all(session).detect {|profile| profile.id == id || profile.web_property_id == id }
     end

data/lib/garb/resource.rb

@@ -44,6 +44,18 @@ module Garb
       @segment = "gaid::#{id.to_i}"
     end
 
+    def segment
+      @segment
+    end
+
+    def set_instance_klass(klass)
+      @instance_klass = klass
+    end
+
+    def instance_klass
+      @instance_klass || OpenStruct
+    end
+
     def results(profile, opts = {}, &block)
       @profile = profile.is_a?(Profile) ? profile : Profile.first(profile, opts.fetch(:session, Session))
 
@@ -55,7 +67,7 @@ module Garb
 
         instance_eval(&block) if block_given?
 
-        ReportResponse.new(send_request_for_body).results
+        ReportResponse.new(send_request_for_body, instance_klass).results
       else
         []
       end
@@ -72,7 +84,7 @@ module Garb
     end
 
     def segment_params
-      @segment ? {'segment' => @segment} : {}
+      segment.nil? ? {} : {'segment' => segment}
     end
 
     def params

data/lib/garb/version.rb

@@ -3,7 +3,7 @@ module Garb
 
     MAJOR = 0
     MINOR = 8
-    TINY  = 0
+    TINY  = 1
 
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

data/test/unit/garb/management/account_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+module Garb
+  module Management
+    class AccountTest < MiniTest::Unit::TestCase
+      context "The Account class" do
+        should "turn entries for path into array of accounts" do
+          feed = stub(:entries => ["entry1"])
+          Feed.stubs(:new).returns(feed)
+
+          Account.stubs(:new)
+          Account.all
+
+          assert_received(Feed, :new) {|e| e.with(Session, '/accounts')}
+          assert_received(feed, :entries)
+          assert_received(Account, :new) {|e| e.with("entry1", Session)}
+        end
+      end
+
+      context "an Account" do
+        setup do
+          entry = {
+            "title" => "Google Analytics Account Garb",
+            "link" => [{"rel" => "self", "href" => Feed::BASE_URL+"/accounts/123456"}],
+            "dxp:property" => [
+              {"name" => "ga:accountId", "value" => "123456"},
+              {"name" => "ga:accountName", "value" => "Garb"}
+            ]
+          }
+          @account = Account.new(entry, Session)
+        end
+
+        should "extract id and title from GA entry" do
+          assert_equal "Garb", @account.title
+          assert_equal "123456", @account.id
+        end
+
+        should "extract a name from GA entry properties" do
+          assert_equal "Garb", @account.name
+        end
+
+        should "combine the Account.path and the id into an new path" do
+          assert_equal "/accounts/123456", @account.path
+        end
+
+        should "have a reference to the session it was created with" do
+          assert_equal Session, @account.session
+        end
+
+        should "have web properties"
+      end
+    end
+  end
+end

data/test/unit/garb/management/profile_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+module Garb
+  module Management
+    class ProfileTest < MiniTest::Unit::TestCase
+      context "The Profile class" do
+        should "turn entries for path into array of profile" do
+          feed = stub(:entries => ["entry1"])
+          Feed.stubs(:new).returns(feed)
+
+          Profile.stubs(:new)
+          Profile.all
+
+          assert_received(Feed, :new) {|e| e.with(Session, '/accounts/~all/webproperties/~all/profiles')}
+          assert_received(feed, :entries)
+          assert_received(Profile, :new) {|e| e.with("entry1", Session)}
+        end
+
+        should "find all web properties for a given account"
+        should "find all web properties for a given web_property"
+      end
+
+      context "A Profile" do
+        setup do
+          entry = {
+            "title" => "Google Analytics Profile example.com",
+            "link" => [{"rel" => "self", "href" => Feed::BASE_URL+"/accounts/1189765/webproperties/UA-1189765-1/profiles/98765"}],
+            "dxp:property" => [
+              {"name" => "ga:profileId", "value" => "98765"},
+              {"name" => "ga:accountId", "value" => "1189765"},
+              {"name" => "ga:webPropertyId", "value" => 'UA-1189765-1'}
+            ]
+          }
+          @profile = Profile.new(entry, Session)
+        end
+
+        should "have a title" do
+          assert_equal "example.com", @profile.title
+        end
+
+        should "have an id" do
+          assert_equal '98765', @profile.id
+        end
+
+        should "have an account_id" do
+          assert_equal '1189765', @profile.account_id
+        end
+
+        should "have a web_property_id" do
+          assert_equal 'UA-1189765-1', @profile.web_property_id
+        end
+
+        should "have a path" do
+          assert_equal "/accounts/1189765/webproperties/UA-1189765-1/profiles/98765", @profile.path
+        end
+      end
+    end
+  end
+end

data/test/unit/garb/management/web_property_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+module Garb
+  module Management
+    class WebPropertyTest < MiniTest::Unit::TestCase
+      context "the WebProperty class" do
+        should "turn entries for path into array of web properties" do
+          feed = stub(:entries => ["entry1"])
+          Feed.stubs(:new).returns(feed)
+
+          WebProperty.stubs(:new)
+          WebProperty.all
+
+          assert_received(Feed, :new) {|e| e.with(Session, '/accounts/~all/webproperties')}
+          assert_received(feed, :entries)
+          assert_received(WebProperty, :new) {|e| e.with("entry1", Session)}
+        end
+
+        should "find all web properties for a given account" do
+          WebProperty.stubs(:all)
+          WebProperty.for_account(stub(:session => Session, :path => '/accounts/123456'))
+
+          assert_received(WebProperty, :all) do |e|
+            e.with(Session, '/accounts/123456/webproperties')
+          end
+        end
+      end
+
+      context "a WebProperty" do
+        setup do
+          entry = {
+            "link" => [{"rel" => "self", "href" => Feed::BASE_URL+"/accounts/1189765/webproperties/UA-1189765-1"}],
+            "dxp:property" => [
+              {"name" => "ga:accountId", "value" => "1189765"},
+              {"name" => "ga:webPropertyId", "value" => 'UA-1189765-1'}
+            ]
+          }
+
+          @web_property = WebProperty.new(entry, Session)
+        end
+
+        should "have an id" do
+          assert_equal "UA-1189765-1", @web_property.id
+        end
+
+        should "have an account_id" do
+          assert_equal "1189765", @web_property.account_id
+        end
+
+        should "have profiles" do
+          Profile.stubs(:for_web_property)
+          @web_property.profiles
+          assert_received(Profile, :for_web_property) {|e| e.with(@web_property)}
+        end
+      end
+    end
+  end
+end

data/test/unit/garb/resource_test.rb

@@ -11,7 +11,7 @@ class ResourceTest < MiniTest::Unit::TestCase
     should "get results from GA" do
       profile = stub(:is_a? => true)
       TestReport.expects(:send_request_for_body).returns('xml')
-      Garb::ReportResponse.expects(:new).with('xml').returns(mock(:results => 'analytics'))
+      Garb::ReportResponse.expects(:new).with('xml', OpenStruct).returns(mock(:results => 'analytics'))
 
       assert_equal 'analytics', TestReport.results(profile)
     end
@@ -20,12 +20,23 @@ class ResourceTest < MiniTest::Unit::TestCase
       profile = '123'
       session = Garb::Session.new
       TestReport.expects(:send_request_for_body).returns('xml')
-      Garb::ReportResponse.expects(:new).with('xml').returns(mock(:results => 'analytics'))
+      Garb::ReportResponse.expects(:new).with('xml', OpenStruct).returns(mock(:results => 'analytics'))
       Garb::Profile.expects(:first).with(profile, session).returns(mock('Garb::Profile'))
 
       assert_equal 'analytics', TestReport.results(profile, :session => session)
     end
 
+    should "permit setting a segment id" do
+      TestReport.set_segment_id 1
+      assert_equal "gaid::1", TestReport.segment
+    end
+
+    should "permit setting a klass used for instantiation of results" do
+      TestKlass = Class.new(OpenStruct)
+      TestReport.set_instance_klass TestKlass
+      assert_equal TestKlass, TestReport.instance_klass
+    end
+
     should "return an empty result set if profile is invalid" do
       profile = '123'
       TestReport.expects(:send_request_for_body).never

data/test/unit/garb_test.rb

@@ -10,5 +10,17 @@ class GarbTest < MiniTest::Unit::TestCase
     should 'remove ga: prefix' do
       assert_equal 'bob', Garb.from_google_analytics('ga:bob')
     end
+
+    should "have a helper to parse properties out of entries" do
+      entry = {"dxp:property"=>[{"name"=>"ga:accountId", "value"=>"1189765"}, {"name"=>"ga:webPropertyId", "value"=>"UA-1189765-1"}]}
+
+      assert_equal({"account_id" => '1189765', "web_property_id" => "UA-1189765-1"}, Garb.parse_properties(entry))
+    end
+
+    should "parse out the self link" do
+      entry = {"link" => [{"rel" => "self", "href" => "http://google.com/accounts/12345"}]}
+
+      assert_equal "http://google.com/accounts/12345", Garb.parse_link(entry, "self")
+    end
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: garb
 version: !ruby/object:Gem::Version 
+  hash: 61
   prerelease: false
   segments: 
   - 0
   - 8
-  - 0
-  version: 0.8.0
+  - 1
+  version: 0.8.1
 platform: ruby
 authors: 
 - Tony Pitale
@@ -14,34 +15,40 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-08 00:00:00 -04:00
+date: 2010-10-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: crack
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 0
-        version: "0"
+        - 1
+        - 6
+        version: 0.1.6
   type: :runtime
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: crack
+  name: activesupport
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
+        - 2
+        - 2
         - 0
-        version: "0"
+        version: 2.2.0
   type: :runtime
-  prerelease: false
   version_requirements: *id002
 description: 
 email: tony.pitale@viget.com
@@ -61,6 +68,11 @@ files:
 - lib/garb/destination.rb
 - lib/garb/filter_parameters.rb
 - lib/garb/goal.rb
+- lib/garb/management/account.rb
+- lib/garb/management/feed.rb
+- lib/garb/management/goal.rb
+- lib/garb/management/profile.rb
+- lib/garb/management/web_property.rb
 - lib/garb/profile.rb
 - lib/garb/profile_reports.rb
 - lib/garb/report.rb
@@ -89,6 +101,9 @@ files:
 - test/unit/garb/destination_test.rb
 - test/unit/garb/filter_parameters_test.rb
 - test/unit/garb/goal_test.rb
+- test/unit/garb/management/account_test.rb
+- test/unit/garb/management/profile_test.rb
+- test/unit/garb/management/web_property_test.rb
 - test/unit/garb/oauth_session_test.rb
 - test/unit/garb/profile_reports_test.rb
 - test/unit/garb/profile_test.rb
@@ -114,6 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -122,6 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -144,6 +161,9 @@ test_files:
 - test/unit/garb/destination_test.rb
 - test/unit/garb/filter_parameters_test.rb
 - test/unit/garb/goal_test.rb
+- test/unit/garb/management/account_test.rb
+- test/unit/garb/management/profile_test.rb
+- test/unit/garb/management/web_property_test.rb
 - test/unit/garb/oauth_session_test.rb
 - test/unit/garb/profile_reports_test.rb
 - test/unit/garb/profile_test.rb