在Ruby on Rails中使用Google OAuth2 API

时间:2016-06-27 20:19:48

标签: ruby-on-rails google-api google-oauth google-analytics-api google-api-ruby-client

我的系统包含多个客户帐户,每个帐户至少有一个拥有Google Analytics帐户的网站。 我需要我的客户授权我的系统访问Google Analytics帐户,这样我就可以生成自动月度报告页面浏览量,并将这些信息与我系统的其他信息一起呈现。我希望这样做,而无需客户再次将我的应用程序授权给他们的Google Analytics帐户。

当客户授权访问Google Analytics时,它会运行大约1小时(我相信它是会话时令牌expires_in: 3600)。在此之后,我无法访问Google Analytics客户端。正如您在代码中看到的那样,我已经尝试使用access_type:: offline并使用client.update_token!更新客户端令牌,但我不知道如何执行此操作。任何人都可以告诉我,我正在尝试做什么是可能的,并告诉我如何做到这一点,所以我可以生成月度报告,而无需客户再次授权我的申请?

我在我的控制器中创建了一些方法(我知道代码不好,它只是一个测试,也许我应该在将访问令牌写入我的数据库之前对其进行加密)。

class ContractedProductsController < ApplicationController

    def analytics_connection
        client_info = {
                client_id: Rails.configuration.x.google_api['client_id'],
                client_secret: Rails.configuration.x.google_api['client_secret'],
                authorization_uri: Rails.configuration.x.google_api['authorization_uri'],
                scope: Google::Apis::AnalyticsV3::AUTH_ANALYTICS_READONLY,
                redirect_uri: url_for(action: :analytics_callback),
                state: Base64.encode64('{ "account": ' + params[:account_id] + ', "contracted_product": ' + params[:id] + ' }'),
                additional_parameters: { access_type: :offline, approval_prompt: :force }
        }
        client = Signet::OAuth2::Client.new(client_info)

        redirect_to client.authorization_uri.to_s
    end

    def analytics_callback
        client_info = {
                client_id: Rails.configuration.x.google_api['client_id'],
                client_secret: Rails.configuration.x.google_api['client_secret'],
                token_credential_uri: Rails.configuration.x.google_api['token_credential_uri'],
                redirect_uri: url_for(action: :analytics_callback),
                code: params[:code]
        }
        client = Signet::OAuth2::Client.new(client_info)
        response = client.fetch_access_token!

        session[:google_api] = response
        state = JSON.parse(Base64.decode64(params[:state]), object_class: OpenStruct)

        redirect_to account_contracted_product_analytics_list_path(state.account, state.contracted_product)
    end

    def analytics_list
        client = Signet::OAuth2::Client.new(access_token: session[:google_api]['access_token'])
        service = Google::Apis::AnalyticsV3::AnalyticsService.new
        service.authorization = client

        @account_summaries = service.list_account_summaries
    end

    def analytics_save
        api_integrations = [
                {
                        entity_type: ContractedProduct.name,
                        entity_id: @contracted_product.id,
                        key: ApiIntegration::GOOGLE_ANALYTICS_KEYS[:access_token],
                        value: session[:google_api]['access_token']
                },
                {
                        entity_type: ContractedProduct.name,
                        entity_id: @contracted_product.id,
                        key: ApiIntegration::GOOGLE_ANALYTICS_KEYS[:refresh_token],
                        value: session[:google_api]['refresh_token']
                },
                {
                        entity_type: ContractedProduct.name,
                        entity_id: @contracted_product.id,
                        key: ApiIntegration::GOOGLE_ANALYTICS_KEYS[:profile_id],
                        value: params[:profile_id]
                }
        ]
        @api_integration = ApiIntegration.create(api_integrations)

        respond_to do |format|
            if @api_integration
                format.html { redirect_to [@account, @contracted_product], notice: I18n.t('controllers.contracted_products.analytics_data_successfully_saved', default: 'Analytics data was successfully saved.') }
                format.json { render :show, status: :ok, location: [@account, @contracted_product] }
            else
                format.html { render :analytics_save, status: :ok, location: [@account, @contracted_product] }
                format.json { render json: @contracted_products_service.errors, status: :unprocessable_entity }
            end
        end
    end

    def analytics_report
        entity_conditions = { entity_type: ContractedProduct.name, entity_id: @contracted_product.id }
        api_integration_access_token = ApiIntegration.find_by entity_conditions.merge(key: ApiIntegration::GOOGLE_ANALYTICS_KEYS[:access_token])
        # api_integration_refresh_token = ApiIntegration.find_by entity_conditions.merge(key: ApiIntegration::GOOGLE_ANALYTICS_KEYS[:refresh_token])
        api_integration_profile_id = ApiIntegration.find_by entity_conditions.merge(key: ApiIntegration::GOOGLE_ANALYTICS_KEYS[:profile_id])

        client = Signet::OAuth2::Client.new(access_token: api_integration_access_token.value)
        service = Google::Apis::AnalyticsV3::AnalyticsService.new
        service.authorization = client
        profile_id = 'ga:' + api_integration_profile_id.value
        start_date = Date.today.at_beginning_of_month.last_month.to_s
        end_date = Date.today.at_beginning_of_month.last_month.to_s
        metrics = 'ga:pageviews'
        dimensions = {
                dimensions: 'ga:date'
        }

        @report = service.get_ga_data(profile_id, start_date, end_date, metrics, dimensions)
    end

end

1 个答案:

答案 0 :(得分:0)

这很简单,但我认为我在测试中没有将token_credential_uri放入API的调用中。

观察此答案&#34; How do I refresh my google_oauth2 access token using my refresh token? &#34;我找到了正确的方法。

我刚刚在API调用中添加了以下参数:client_idclient_secrettoken_credential_urirefresh_token

def analytics_report
    entity_conditions = { entity_type: ContractedProduct.name, entity_id: @contracted_product.id }
    api_integration_refresh_token = ApiIntegration.find_by entity_conditions.merge(key: ApiIntegration::GOOGLE_ANALYTICS_KEYS[:refresh_token])
    api_integration_profile_id = ApiIntegration.find_by entity_conditions.merge(key: ApiIntegration::GOOGLE_ANALYTICS_KEYS[:profile_id])

    client_info = {
            client_id: Rails.configuration.x.google_api['client_id'],
            client_secret: Rails.configuration.x.google_api['client_secret'],
            token_credential_uri: Rails.configuration.x.google_api['token_credential_uri'],
            refresh_token: api_integration_refresh_token.value
    }
    client = Signet::OAuth2::Client.new(client_info)
    service = Google::Apis::AnalyticsV3::AnalyticsService.new
    service.authorization = client
    profile_id = 'ga:' + api_integration_profile_id.value
    start_date = Date.today.at_beginning_of_month.last_month.to_s
    end_date = Date.today.at_beginning_of_month.last_month.to_s
    metrics = 'ga:pageviews'
    dimensions = {
            dimensions: 'ga:date'
    }

    @report = service.get_ga_data(profile_id, start_date, end_date, metrics, dimensions)
end