garb-authsub 0.7.0

data/lib/garb/filter_parameters.rb

@@ -0,0 +1,37 @@
+module Garb
+  class FilterParameters
+    def self.define_operators(*methods)
+      methods.each do |method|
+        class_eval <<-CODE
+          def #{method}(field, value)
+            self.parameters << {SymbolOperator.new(field, :#{method}) => value}
+          end
+        CODE
+      end
+    end
+
+    define_operators :eql, :not_eql, :gt, :gte, :lt, :lte, :matches,
+      :does_not_match, :contains, :does_not_contain, :substring, :not_substring
+
+    attr_accessor :parameters
+
+    def initialize
+      self.parameters = []
+    end
+
+    def filters(&block)
+      instance_eval &block
+    end
+
+    def to_params
+      value = self.parameters.map do |param|
+        param.map do |k,v|
+          next unless k.is_a?(SymbolOperator)
+          "#{URI.encode(k.to_google_analytics, /[=<>]/)}#{CGI::escape(v.to_s)}"
+        end.join(',') # Hash AND
+      end.join(';') # Array OR
+
+      value.empty? ? {} : {'filters' => value}
+    end
+  end
+end

data/lib/garb/profile.rb

@@ -0,0 +1,57 @@
+module Garb
+  class Profile
+
+    include ProfileReports
+
+    attr_reader :session, :table_id, :title, :account_name, :account_id, :web_property_id
+    
+    class Property
+      include HappyMapper
+      
+      tag 'property'
+      namespace 'http://schemas.google.com/analytics/2009'
+      
+      attribute :name, String
+      attribute :value, String
+
+      def instance_name
+        Garb.from_google_analytics(name)
+      end
+    end
+
+    class Entry
+      include HappyMapper
+      
+      tag 'entry'
+
+      element :title, String
+      element :tableId, String, :namespace => 'http://schemas.google.com/analytics/2009'
+
+      has_many :properties, Property
+    end
+
+    def initialize(entry, session)
+      @session = session
+      @title = entry.title
+      @table_id = entry.tableId
+
+      entry.properties.each do |p|
+        instance_variable_set :"@#{p.instance_name}", p.value
+      end
+    end
+
+    def id
+      Garb.from_google_analytics(@table_id)
+    end
+
+    def self.all(session = Session)
+      url = "https://www.google.com/analytics/feeds/accounts/default"
+      response = DataRequest.new(session, url).send_request      
+      Entry.parse(response.body).map {|entry| new(entry, session)}
+    end
+
+    def self.first(id, session = Session)
+      all(session).detect {|profile| profile.id == id || profile.web_property_id == id }
+    end
+  end
+end

data/lib/garb/profile_reports.rb

@@ -0,0 +1,15 @@
+module Garb
+  module ProfileReports
+    def self.add_report_method(klass)
+      # demodulize leaves potential to redefine
+      # these methods given different namespaces
+      method_name = klass.to_s.demodulize.underscore
+
+      class_eval <<-CODE
+        def #{method_name}(opts = {}, &block)
+          #{klass}.results(self, opts, &block)
+        end
+      CODE
+    end
+  end
+end

data/lib/garb/report.rb

@@ -0,0 +1,26 @@
+module Garb
+  class Report
+    include Resource
+
+    MONTH = 2592000
+    URL = "https://www.google.com/analytics/feeds/data"
+
+    def initialize(profile, opts={})
+      @profile = profile
+
+      @start_date = opts.fetch(:start_date, Time.now - MONTH)
+      @end_date = opts.fetch(:end_date, Time.now)
+      @limit = opts.fetch(:limit, nil)
+      @offset = opts.fetch(:offset, nil)
+
+      metrics opts.fetch(:metrics, [])
+      dimensions opts.fetch(:dimensions, [])
+      sort opts.fetch(:sort, [])
+    end
+
+    def results
+      ReportResponse.new(send_request_for_body).results
+    end
+
+  end
+end

data/lib/garb/report_parameter.rb

@@ -0,0 +1,25 @@
+module Garb
+  class ReportParameter
+
+    attr_reader :elements
+    
+    def initialize(name)
+      @name = name
+      @elements = []
+    end
+    
+    def name
+      @name.to_s
+    end
+    
+    def <<(element)
+      (@elements += [element].flatten).compact!
+      self
+    end
+    
+    def to_params
+      value = self.elements.map{|param| Garb.to_google_analytics(param)}.join(',')
+      value.empty? ? {} : {self.name => value}
+    end
+  end
+end

data/lib/garb/report_response.rb

@@ -0,0 +1,62 @@
+module Garb  
+  class ReportResponse
+    # include Enumerable
+
+    def initialize(response_body)
+      @xml = response_body
+    end
+    
+    def parse      
+      entries = Entry.parse(@xml)
+      
+      @results = entries.collect do |entry|
+        hash = {}
+        
+        entry.metrics.each do |m|
+          name = m.name.sub(/^ga\:/,'').underscore
+          hash.merge!({name => m.value})
+        end
+        
+        entry.dimensions.each do |d|
+          name = d.name.sub(/^ga\:/,'').underscore
+          hash.merge!({name => d.value})
+        end
+        
+        OpenStruct.new(hash)
+      end
+    end
+
+    def results
+      @results || parse
+    end
+    
+    class Metric
+      include HappyMapper
+
+      tag 'metric'
+      namespace 'http://schemas.google.com/analytics/2009'
+
+      attribute :name, String
+      attribute :value, String
+    end
+  
+    class Dimension
+      include HappyMapper
+
+      tag 'dimension'
+      namespace 'http://schemas.google.com/analytics/2009'
+
+      attribute :name, String
+      attribute :value, String
+    end
+  
+    class Entry
+      include HappyMapper
+    
+      tag 'entry'
+
+      has_many :metrics, Metric
+      has_many :dimensions, Dimension
+    end
+  end
+end

data/lib/garb/reports.rb

@@ -0,0 +1,5 @@
+require 'reports/exits'
+require 'reports/visits'
+require 'reports/bounces'
+require 'reports/pageviews'
+require 'reports/unique_pageviews'

data/lib/garb/reports/bounces.rb

@@ -0,0 +1,5 @@
+class Bounces
+  extend Garb::Resource
+
+  metric :bounces
+end

data/lib/garb/reports/exits.rb

@@ -0,0 +1,5 @@
+class Exits
+  extend Garb::Resource
+
+  metric :exits
+end

data/lib/garb/reports/pageviews.rb

@@ -0,0 +1,5 @@
+class Pageviews
+  extend Garb::Resource
+
+  metric :pageviews
+end

data/lib/garb/reports/unique_pageviews.rb

@@ -0,0 +1,5 @@
+class UniquePageviews
+  extend Garb::Resource
+
+  metric :unique_pageviews
+end

data/lib/garb/reports/visits.rb

@@ -0,0 +1,5 @@
+class Visits
+  extend Garb::Resource
+
+  metric :visits
+end

data/lib/garb/resource.rb

@@ -0,0 +1,92 @@
+module Garb
+  module Resource
+    MONTH = 2592000
+    URL = "https://www.google.com/analytics/feeds/data"
+
+    def self.extended(base)
+      # define a method on a module that gets included into profile
+      # Exits would make:
+      # to enable profile.exits(options_hash, &block)
+      # returns Exits.results(self, options_hash, &block)
+      # every class defined which extends Resource will add to the module
+      ProfileReports.add_report_method(base)
+    end
+
+    %w(metrics dimensions sort).each do |parameter|
+      class_eval <<-CODE
+        def #{parameter}(*fields)
+          @#{parameter} ||= ReportParameter.new(:#{parameter})
+          @#{parameter} << fields
+        end
+
+        def clear_#{parameter}
+          @#{parameter} = ReportParameter.new(:#{parameter})
+        end
+      CODE
+    end
+
+    def filters(*hashes, &block)
+      @filter_parameters ||= FilterParameters.new
+
+      hashes.each do |hash|
+        @filter_parameters.parameters << hash
+      end
+
+      @filter_parameters.filters(&block) if block_given?
+      @filter_parameters
+    end
+
+    def clear_filters
+      @filter_parameters = FilterParameters.new
+    end
+
+    def results(profile, opts = {}, &block)
+      @profile = profile.is_a?(Profile) ? profile : Profile.first(profile, opts.fetch(:session, Session))
+
+      if @profile
+        @start_date = opts.fetch(:start_date, Time.now - MONTH)
+        @end_date = opts.fetch(:end_date, Time.now)
+        @limit = opts.fetch(:limit, nil)
+        @offset = opts.fetch(:offset, nil)
+
+        instance_eval(&block) if block_given?
+
+        ReportResponse.new(send_request_for_body).results
+      else
+        []
+      end
+    end
+
+    def page_params
+      {'max-results' => @limit, 'start-index' => @offset}.reject{|k,v| v.nil?}
+    end
+
+    def default_params
+      {'ids' => @profile.table_id,
+        'start-date' => format_time(@start_date),
+        'end-date' => format_time(@end_date)}
+    end
+
+    def params
+      [
+        metrics.to_params,
+        dimensions.to_params,
+        sort.to_params,
+        filters.to_params,
+        page_params
+      ].inject(default_params) do |p, i|
+        p.merge(i)
+      end
+    end
+
+    def format_time(t)
+      t.strftime('%Y-%m-%d')
+    end
+
+    def send_request_for_body
+      request = DataRequest.new(@profile.session, URL, params)
+      response = request.send_request
+      response.body
+    end
+  end
+end

data/lib/garb/session.rb

@@ -0,0 +1,29 @@
+module Garb
+  class Session
+    module Methods
+      attr_accessor :auth_token, :access_token, :authsub_token, :email
+
+      # use only for single user authentication
+      def login(email, password, opts={})
+        self.email = email
+        auth_request = AuthenticationRequest.new(email, password, opts)
+        self.auth_token = auth_request.auth_token(opts)
+      end
+
+      def single_user?
+        auth_token && auth_token.is_a?(String)
+      end
+
+      def oauth_user?
+        !access_token.nil?
+      end
+      
+      def authsub_user?
+        !authsub_token.nil?
+      end
+    end
+
+    include Methods
+    extend Methods
+  end
+end

data/lib/garb/version.rb

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

data/lib/support.rb

@@ -0,0 +1,39 @@
+class SymbolOperator
+  def initialize(field, operator)
+    @field, @operator = field, operator
+  end unless method_defined?(:initialize)
+
+  def to_google_analytics
+    operators = {
+      :eql => '==',
+      :not_eql => '!=',
+      :gt => '>',
+      :gte => '>=',
+      :lt => '<',
+      :lte => '<=',
+      :matches => '==',
+      :does_not_match => '!=',
+      :contains => '=~',
+      :does_not_contain => '!~',
+      :substring => '=@',
+      :not_substring => '!@',
+      :desc => '-'
+    }
+
+    target = Garb.to_google_analytics(@field)
+    operator = operators[@operator]
+
+    @operator == :desc ? "#{operator}#{target}" : "#{target}#{operator}"
+  end
+end
+
+class Symbol
+  [:eql, :not_eql, :gt, :gte, :lt, :lte, :desc,
+    :matches, :does_not_match, :contains, :does_not_contain,
+    :substring, :not_substring].each do |operator|
+
+    define_method(operator) do
+      SymbolOperator.new(self, operator)
+    end unless method_defined?(operator)
+  end
+end