google_api 1.0.0.beta

data/lib/google_api/ga/data/data_dsl.rb

@@ -0,0 +1,66 @@
+module GoogleApi
+  module Ga
+    class DataDsl
+
+      OPERATORS = ['==', '!=', '>', '<', '>=', '<=', '=~', '!~']
+      OPERATORS_METHOD =  {'%' => '=@', '**' => '!@'}
+
+      def initialize
+        @result = []
+      end
+
+      # Make operators 
+      OPERATORS.each do |operator|
+        eval <<-METHOD
+          def #{operator} (value)
+            @result << @attribute + "#{operator}" + value.to_s
+            self
+          end
+        METHOD
+      end
+      OPERATORS_METHOD.each do |key, value|
+        eval <<-METHOD
+          def #{key} (value)
+            @result << @attribute + "#{value}" + value.to_s
+            self
+          end
+        METHOD
+      end
+
+      def method_missing(name)
+        if name.to_s =~ /\A[a-zA-Z0-9]+\Z/
+          @attribute = "ga:#{name}"
+          self
+        else
+          super
+        end
+      end
+
+      def &(other)
+        @result << :and
+        self
+      end
+
+      def |(other)
+        @result << :or
+        self
+      end
+
+      def build_parameter
+        i = @result.index{ |x| x.is_a?(Symbol) }
+
+        if !i.nil?
+          result = @result[i-2] + (@result[i] == :and ? ";" : ",") + @result[i-1]
+          @result.delete_at(i)
+          @result.delete_at(i-1)
+          @result[i-2] = result
+
+          build_parameter
+        else
+          @result.join
+        end
+      end
+      
+    end
+  end
+end

data/lib/google_api/ga/data/filters_dsl.rb

@@ -0,0 +1,11 @@
+module GoogleApi
+  module Ga
+    class FiltersDsl < DataDsl
+
+      def join
+        build_parameter
+      end
+
+    end
+  end
+end

data/lib/google_api/ga/data/segment_dsl.rb

@@ -0,0 +1,11 @@
+module GoogleApi
+  module Ga
+    class SegmentDsl < DataDsl
+      
+      def join
+        "dynamic::" + build_parameter
+      end
+
+    end
+  end
+end

data/lib/google_api/ga/helper.rb

@@ -0,0 +1,41 @@
+module GoogleApi
+  module Ga
+    module Helper
+
+      # Same as get but automaticly add day, month and year to dimension
+      #
+      # Also check cache
+      #
+      def get_by_day(parameters, start_date = prev_month, end_date = now, expire = nil)
+        
+        [:dimensions, :sort].each do |param|
+          parameters[param] = [] unless parameters[param]
+
+          if parameters[param].is_a?(String) || parameters[param].is_a?(Symbol)
+            parameters[param] = [parameters[param]]
+          end
+        end
+
+        parameters[:dimensions] << :day
+
+        if more_years?(start_date, end_date)
+          parameters[:dimensions] << :month
+          parameters[:dimensions] << :year
+
+          parameters[:sort] << :year
+          parameters[:sort] << :month
+
+        elsif more_months?(start_date, end_date)
+          parameters[:dimensions] << :month
+
+          parameters[:sort] << :month
+        end
+
+        parameters[:sort] << :day
+
+        get(parameters, start_date, end_date, expire)
+      end
+
+    end
+  end
+end

data/lib/google_api/ga/management/account.rb

@@ -0,0 +1,37 @@
+module GoogleApi
+  module Ga
+    class Account < Management
+
+      def initialize(account)
+        set(account)
+      end
+
+      def self.all(account_id = '~all')
+        get({ accountId: account_id }).map { |account| Account.new(account) }
+      end
+
+      def self.find(account_id)
+        all(account_id).first
+      end
+
+      def refresh
+        @webproperties = nil
+
+        set( Account.get({ accountId: @id }).first )
+
+        return true
+      end
+
+      def webproperties
+        @webproperties ||= Webproperty.all(@id)
+      end
+
+      private
+
+        def self.get(parameters = nil)
+          super(@@session.api.management.accounts.list, parameters)
+        end
+      
+    end
+  end
+end

data/lib/google_api/ga/management/goal.rb

@@ -0,0 +1,58 @@
+module GoogleApi
+  module Ga
+    class Goal < Management
+
+      attr_reader :accountId
+      attr_reader :webPropertyId
+      attr_reader :profileId
+      attr_reader :value
+      attr_reader :active
+      attr_reader :type
+      attr_reader :goal
+
+      def initialize(goal)
+        set(goal)
+      end
+
+      def self.all(account_id = '~all', webproperty_id = '~all', profile_id = '~all', goal_id = '~all')
+        get({ accountId: account_id, webPropertyId: webproperty_id, profileId: profile_id, goalId: goal_id }).map { |goal| Goal.new(goal) }
+      end
+
+      def self.find(goal_id)
+        all('~all', '~all', '~all', goal_id).first
+      end
+
+      def refresh
+        @profile  = nil
+
+        set( Goal.get({ accountId: @accountId, webPropertyId: @id, profileId: @profileId, goalId: @id }).first )
+
+        return true
+      end
+
+      def profile
+        @profile ||= Profile.find(@profileId)
+      end
+
+      private
+
+        def self.get(parameters = nil)
+          super(@@session.api.management.goals.list, parameters)
+        end
+
+        def set(goal)
+          @accountId     = goal['accountId']
+          @webPropertyId = goal['webPropertyId']
+          @profileId     = goal['profileId']
+          @value         = goal['value']
+          @active        = goal['active']
+          @type          = goal['type']
+
+          @goal = goal[camelize(@type) + 'Details']
+
+          super(goal)
+        end
+      
+    end
+  end
+end

data/lib/google_api/ga/management/management.rb

@@ -0,0 +1,36 @@
+module GoogleApi
+  module Ga
+    class Management
+
+      @@session = Session
+
+      attr_reader :id
+      attr_reader :name
+      attr_reader :created
+      attr_reader :updated
+
+      def camelize(string)
+        string = string.downcase.split('_').map!(&:capitalize).join
+        string[0] = string[0].downcase
+        string
+      end
+
+      protected
+      
+        def self.get(api_method, parameters = nil)
+          JSON.parse( 
+            @@session.client.execute(api_method: api_method,
+                                     parameters: parameters).body
+          )["items"]
+        end
+
+        def set(values)
+          @id      = values['id']
+          @name    = values['name']
+          @created = values['created']
+          @updated = values['updated']
+        end
+
+    end
+  end
+end

data/lib/google_api/ga/management/profile.rb

@@ -0,0 +1,64 @@
+module GoogleApi
+  module Ga
+    class Profile < Management
+
+      attr_reader :accountId
+      attr_reader :webPropertyId
+      attr_reader :currency
+      attr_reader :timezone
+
+      def initialize(profile)
+        set(profile)
+      end
+
+      def self.all(account_id = '~all', webproperty_id = '~all', profile_id = '~all')
+        get({ accountId: account_id, webPropertyId: webproperty_id, profileId: '~all' }).map { |profile| Profile.new(profile) }
+      end
+
+      def self.find(profile_id)
+        all('~all', '~all', profile_id).first
+      end
+
+      def refresh
+        @webproperty = nil
+        @goals       = nil
+
+        set( Profile.get({ accountId: @accountId, webPropertyId: @webPropertyId, profileId: @id }).first )
+
+        return true
+      end
+
+      def webproperty
+        @webproperty ||= Webproperty.find(@webpropertyId)
+      end
+
+      def goals
+        @goals ||= Goal.all(@accountId, @webPropertyId, @id)
+      end
+
+      # def get(parameters, start_date = prev_month, end_date = now, expire = nil)
+      #   Data.get(@id, parameters, start_date, end_date, expire)
+      # end
+
+      # def get!(parameters, start_date = prev_month, end_date = now)
+      #   Data.get!(@id, parameters, start_date, end_date)
+      # end
+
+      private
+
+        def self.get(parameters = nil)
+          super(@@session.api.management.profiles.list, parameters)
+        end
+
+        def set(profile)
+          @accountId     = profile['accountId']
+          @webPropertyId = profile['webPropertyId']
+          @currency      = profile['currency']
+          @timezone      = profile['timezone']
+
+          super(profile)
+        end
+      
+    end
+  end
+end

data/lib/google_api/ga/management/segment.rb

@@ -0,0 +1,41 @@
+module GoogleApi
+  module Ga
+    class Segment < Management
+
+      attr_accessor :segmentId
+      attr_accessor :definition
+
+      def initialize(segment)
+        set(segment)
+      end
+
+      def self.all(segment_id = '~all')
+        get({ segmentId: segment_id }).map { |segment| Segment.new(segment) }
+      end
+
+      def self.find(segment_id)
+        all(segment_id).first
+      end
+
+      def refresh
+        set( Segment.get({ segmentId: @id }).first )
+
+        return true
+      end
+
+      private
+
+        def self.get(parameters = nil)
+          super(@@session.api.management.segments.list, parameters)
+        end
+        
+        def set(segment)
+          @segmentId  = segment['segmentId']
+          @definition = segment['definition']
+
+          super(segment)
+        end
+      
+    end
+  end
+end

data/lib/google_api/ga/management/webproperty.rb

@@ -0,0 +1,52 @@
+module GoogleApi
+  module Ga
+    class Webproperty < Management
+
+      attr_reader :accountId
+      attr_reader :websiteUrl
+
+      def initialize(webproperty)
+        set(webproperty)
+      end
+
+      def self.all(account_id = '~all', webproperty_id = '~all')
+        get({ accountId: account_id, webPropertyId: webproperty_id }).map { |webproperty| Webproperty.new(webproperty) }
+      end
+
+      def self.find(webproperty_id)
+        all('~all', webproperty_id).first
+      end
+
+      def refresh
+        @account  = nil
+        @profiles = nil
+
+        set( Webproperty.get({ accountId: @accountId, webPropertyId: @id }).first )
+
+        return true
+      end
+
+      def account
+        @account ||= Account.find(@accountId)
+      end
+
+      def profiles
+        @profiles ||= Profile.all(@accountId, @id)
+      end
+
+      private
+
+        def self.get(parameters = nil)
+          super(@@session.api.management.webproperties.list, parameters)
+        end
+
+        def set(webproperty)
+          @accountId  = webproperty['accountId']
+          @websiteUrl = webproperty['websiteUrl']
+
+          super(webproperty)
+        end
+      
+    end
+  end
+end

data/lib/google_api/ga/session.rb

@@ -0,0 +1,165 @@
+require "google_api/core_ext/string"
+
+module GoogleApi
+  module Ga
+    
+    class Session
+
+      SCOPE       = "https://www.googleapis.com/auth/analytics.readonly"
+      NAME_API    = "analytics"
+      VERSION_API = "v3"
+
+      @@api    = nil
+      @@client = nil
+
+      # Config --------------------------------------------------------------------------------
+
+      def self._config
+        GoogleApi.config
+      end
+
+      def self.client_id
+        _config.ga.client_id ? _config.ga.client_id : _config.client_id
+      end
+
+      def self.client_secret
+        _config.ga.client_secret ? _config.ga.client_secret : _config.client_secret
+      end
+
+      def self.redirect_uri
+        _config.ga.redirect_uri ? _config.ga.redirect_uri : _config.redirect_uri
+      end
+
+      def self.client_cert_file
+        _config.ga.client_cert_file ? _config.ga.client_cert_file : _config.client_cert_file
+      end
+
+      def self.client_developer_email
+        _config.ga.client_developer_email ? _config.ga.client_developer_email : _config.client_developer_email
+      end
+
+      def self.key_secret
+        _config.ga.key_secret ? _config.ga.key_secret : _config.key_secret
+      end
+
+      # ---------------------------------------------------------------------------------------
+
+      def self.login_by_cert
+        @@client = Google::APIClient.new
+
+        key      = Google::APIClient::PKCS12.load_key(client_cert_file, key_secret)
+        asserter = Google::APIClient::JWTAsserter.new(client_developer_email, SCOPE, key)
+
+        begin
+          @@client.authorization = asserter.authorize()
+          @@api = @@client.discovered_api(NAME_API, VERSION_API)
+        rescue
+          return false
+        end
+
+        return true
+      end
+
+      def self.login_by_cert!
+        i = 0
+        while !login_by_cert
+          print "\r[#{Time.now.strftime("%H:%M:%S")}] ##{i += 1} ... \r".bold
+          sleep(1)
+        end
+
+        return true
+      end
+
+      def self.login(code = nil)
+        @@client = Google::APIClient.new
+        @@client.authorization.client_id     = client_id
+        @@client.authorization.client_secret = client_secret
+        @@client.authorization.scope         = SCOPE
+        @@client.authorization.redirect_uri  = redirect_uri
+
+        @@api = @@client.discovered_api(NAME_API, VERSION_API)
+
+        if code
+          @@client.authorization.code = code
+
+          begin
+            @@client.authorization.fetch_access_token!
+          rescue
+            return false
+          end
+
+          return true
+        else
+          @@client.authorization.authorization_uri.to_s
+        end
+      end
+
+      def self.login_by_line(server = 'http://localhost/oauth2callback', port = 0)
+        require "launchy" # open browser
+        require "socket"  # make tcp server 
+        require "uri"     # parse uri
+
+        uri = URI(server)
+
+        # Start webserver.
+        webserver = TCPServer.new(uri.host, port)
+
+        # By default port is 0. It means that TCPServer will get first free port.
+        # Port is required for redirect_uri.
+        uri.port = webserver.addr[1]
+
+        # Add redirect_uri for google oauth 2 callback.
+        GoogleApi.config.ga.redirect_uri = uri.to_s
+
+        # Open browser.
+        Launchy.open(login)
+
+        # Wait for new session.
+        session = webserver.accept
+
+        # Parse header for query.
+        request = session.gets.gsub(/GET\ \//, '').gsub(/\ HTTP.*/, '')
+        request = Hash[URI.decode_www_form(URI(request).query)]
+
+        code = request['code']
+
+        # Close session and webserver.
+        session.close
+
+        if login(code)
+          session.write("You have been successfully logged. Now you can close the browser.")
+
+          return true
+        end
+
+        session.write("You have not been logged. Please try again.")
+
+        return false
+      end
+
+      def self.check_session!
+        if @@api.nil? || @@client.nil?
+          raise GoogleApi::SessionError, "You are not log in."
+        end
+      end
+
+      def self.api
+        check_session!
+
+        @@api
+      end
+
+      def self.client
+        check_session!
+
+        if @@client.authorization.refresh_token && @@client.authorization.expired?
+          @@client.authorization.fetch_access_token!
+        end
+
+        @@client
+      end
+
+    end
+
+  end
+end