google_analytics_page_view_ranking 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ee8e42ced170bad7d73cdcb7f638fa21690bcbc
+  data.tar.gz: 8225c0d614fb23af95d4527d71278cb90c16d320
+SHA512:
+  metadata.gz: 6a9e386c30289bfb2311ecb6e995d0eae5c99ef3c9c4e7268749dd3839d258d4535fec5eea7b48fed71ff3c57d326f6406d667e774479365d8bd36e6b747fd9e
+  data.tar.gz: b916ee55475fdf039997a5760266c219e742f0dcba82598fd3600c573e0246b9bebc715baf868f4fc1da766cdc4d99a7ec1284b8155d0a1b20a1bd959205d4f3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at matsumura.aki@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google_analytics_page_view_ranking.gemspec
+gemspec

data/README.md

@@ -0,0 +1,140 @@
+# GoogleAnalyticsPageViewRanking
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/google_analytics_page_view_ranking`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google_analytics_page_view_ranking'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google_analytics_page_view_ranking
+
+## Usage
+
+### Setup Google Client id and secret token
+Create google development project on this page
+https://console.developers.google.com/
+Active 'Google Analytics API'
+
+Set CALLBACK URL example https://www.example.com/oauth2callback
+
+### Get access_token and refresh_token
+
+Open this page and login analytics account
+
+````
+https://accounts.google.com/o/oauth2/auth
+?response_type=code
+&access_type=offline
+&client_id=[YOUR CLIENT ID]
+&redirect_uri=[CALLBACK URL]
+&scope=https://www.googleapis.com/auth/analytics.readonly
+````
+
+Copy redirect url and get token
+
+https://www.example.com/oauth2callback?code=[TOKEN]
+
+Get access_token and refresh_token
+
+````
+curl -d client_id=[YOUR CLIENT ID] -d client_secret=[YOUR CLIENT SECRET] -d redirect_uri=[CALLBACK URL] -d grant_type=authorization_code -d code=[TOKEN] https://accounts.google.com/o/oauth2/token
+````
+
+Response will
+
+````
+{
+  "access_token" : "ACCESS TOKEN",
+  "token_type" : "Bearer",
+  "expires_in" : 3600,
+  "refresh_token" : "REFRESH TOKEN"
+}%    
+````
+
+And set tokens on settings.yml
+
+````
+google:
+  client_id: '[GOOGLE CLIENT ID]'
+  client_secret: '[GOOGLE CLIENT SECRET]'
+  oauth2_access_token: '[ACCESS TOKEN]'
+  oauth2_refresh_token: '[REFRESH TOKEN]'
+  analytics_property_id: '[ANALYTICS PROPERTY ID]' # ex) UA-XXXXXXXX-1
+````
+
+### Setup your model
+
+````
+class Article < ActiveRecord::Base
+  include GoogleAnalyticsPageViewRanking::Ranking
+end
+````
+
+Fetch data from analytics and create record. Open rails console.
+
+````
+> Article.refresh_daily_ranking!
+> Article.refresh_weekly_ranking!
+> Article.refresh_monthly_ranking!
+````
+
+Get Record with ranking order.
+
+````
+> Article.daily_ranking
+> Article.weekly_ranking
+> Article.monthly_ranking
+````
+
+### Set daily task
+
+````
+GoogleAnalyticsPageViewRanking.refresh_all_rankings
+````
+
+### Options
+
+基本設定では、 `/articles/10` というURLを前提にAnalyticsからデータを取得する実装になっている。
+`/categories/4/articles/10` というようなURLの場合は以下のメソッドをオーバーライドする
+
+````
+class Article < ActiveRecord::Base
+  # ...
+
+  # Override for GoogleAnalyticsPageViewRanking
+  def self.google_analytics_page_path_regex
+    "^/categories/[0-9]+/articles/[0-9]+$"
+  end
+end
+````
+
+また、レコードの指定が数字のIDではない場合は、以下のメソッドをオーバーライドする
+
+````
+  def self.google_analytics_find_item(value)
+    target_id = value.page_path.split('/').last
+    find_by(slug: target_id)
+  end
+````
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/google_analytics_page_view_ranking. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google_analytics_page_view_ranking"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/google_analytics_page_view_ranking.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google_analytics_page_view_ranking/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google_analytics_page_view_ranking"
+  spec.version       = GoogleAnalyticsPageViewRanking::VERSION
+  spec.authors       = ["Akihiro MATSUMURA"]
+  spec.email         = ["matsumura.aki@gmail.com"]
+
+  spec.summary       = %q{}
+  spec.description   = %q{}
+  spec.homepage      = ""
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'oauth2'
+  spec.add_dependency 'garb'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/generators/google_analytics_page_view_ranking/migration/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Migration for GoogleAnalyticsPageViewRanking
+
+Example:
+    rails generate migration Thing
+
+    This will create:
+        db/migrate/xxx_add_page_views.rb

data/lib/generators/google_analytics_page_view_ranking/migration/migration_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module GoogleAnalyticsPageViewRanking
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_model_file
+      migration_template "create_page_views.rb", "db/migrate/create_page_views.rb"
+    end
+  end
+end

data/lib/generators/google_analytics_page_view_ranking/migration/templates/create_page_views.rb

@@ -0,0 +1,14 @@
+class CreatePageViews < ActiveRecord::Migration
+  def change
+    create_table :page_views do |t|
+      t.string :item_type
+      t.integer :item_id
+      t.string :period_type
+      t.integer :page_view
+
+      t.timestamps
+    end
+
+    add_index :page_views, [:item_type, :item_id, :period_type], unique: true
+  end
+end

data/lib/google_analytics_page_view_ranking.rb

@@ -0,0 +1,38 @@
+require 'google_analytics_page_view_ranking/version'
+require 'google_analytics_page_view_ranking/page_view'
+require 'google_analytics_page_view_ranking/ranking'
+
+module GoogleAnalyticsPageViewRanking
+  @@target_classes = []
+
+  def self.add_target_class(klass)
+    @@target_classes << klass unless @@target_classes.include?(klass)
+  end
+
+  def self.target_classes
+    @@target_classes
+  end
+
+  def self.refresh_all_rankings
+    GoogleAnalyticsPageViewRanking::PageView.transaction do
+      GoogleAnalyticsPageViewRanking::PageView.delete_all
+      self.target_classes.each do |klass|
+        log "[GoogleAnalyticsPageViewRanking] Start #{klass}"
+        log "[GoogleAnalyticsPageViewRanking] Start #{klass}: daily"
+        klass.refresh_daily_ranking!
+        log "[GoogleAnalyticsPageViewRanking] Start #{klass}: weekly"
+        klass.refresh_weekly_ranking!
+        log "[GoogleAnalyticsPageViewRanking] Start #{klass}: monthly"
+        klass.refresh_monthly_ranking!
+      end
+    end
+  end
+
+  def self.log(str)
+    if defined?(Rails)
+      Rails.logger.info str
+    else
+      puts str
+    end
+  end
+end

data/lib/google_analytics_page_view_ranking/google_analytics.rb

@@ -0,0 +1,55 @@
+require 'garb'
+require 'oauth2'
+
+module GoogleAnalyticsPageViewRanking
+  class GoogleAnalytics
+    def initialize
+      garb_login
+      set_target_property(Settings.google.analytics_property_id)
+      if @profile.nil?
+        fail('Failed get target property')
+      end
+      self
+    end
+
+    def set_target_property(property_id)
+      @profile = Garb::Management::Profile.all.detect do |p|
+        p.web_property_id == property_id
+      end
+    end
+
+    def ranking(page_path_regex, start_date, end_date, limit)
+      @profile.pageviews(
+        limit: limit,
+        sort: :pageviews.desc,
+        start_date: start_date,
+        end_datd: end_date,
+        filters: { :page_path.contains => page_path_regex }
+      )
+    end
+
+    def garb_login
+      if (args = [Settings.google.client_id, Settings.google.client_secret, Settings.google.oauth2_access_token, Settings.google.oauth2_refresh_token]).all?(&:present?)
+        garb_oauth_login(*args)
+      else
+        fail 'NO AUTH ENV is given'
+      end
+    end
+
+    def garb_oauth_login(client_id, client_secret, access_token, refresh_token)
+      client = OAuth2::Client.new(
+        client_id, client_secret,
+        site: 'https://accounts.google.com',
+        authorize_url: '/o/oauth2/auth',
+        token_url: '/o/oauth2/token'
+      )
+      Garb::Session.access_token = OAuth2::AccessToken.from_hash(client, access_token: access_token, refresh_token: refresh_token).refresh!
+    end
+
+    class Pageviews
+      extend Garb::Model
+      metrics :pageviews
+      dimensions :page_path
+    end
+  end
+end

data/lib/google_analytics_page_view_ranking/page_view.rb

@@ -0,0 +1,11 @@
+module GoogleAnalyticsPageViewRanking
+  class PageView < ActiveRecord::Base
+    extend Enumerize
+
+    belongs_to :item, polymorphic: true
+
+    enumerize :period_type, in: [:daily, :weekly, :monthly]
+
+    validates :item_type, uniqueness: { scope: [:item_id, :period_type] }
+  end
+end

data/lib/google_analytics_page_view_ranking/ranking.rb

@@ -0,0 +1,72 @@
+require 'active_support/concern'
+require 'google_analytics_page_view_ranking/google_analytics'
+
+module GoogleAnalyticsPageViewRanking
+  module Ranking
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :rankings, class_name: 'GoogleAnalyticsPageViewRanking::PageView', as: :item, dependent: :destroy
+
+      scope :ranking, -> { joins(:rankings).order('page_views.page_view desc') }
+      scope :daily_ranking, -> { ranking.where(page_views: {period_type: 'daily'}) }
+      scope :weekly_ranking, -> { ranking.where(page_views: {period_type: 'weekly'}) }
+      scope :monthly_ranking, -> { ranking.where(page_views: {period_type: 'monthly'}) }
+
+      scope :ranking_list, -> { order(page_views: :desc) }
+
+      scope :top_ranking, -> { limit(15) }
+      scope :top_ranking_widget, -> { limit(3) }
+
+      GoogleAnalyticsPageViewRanking.add_target_class(self)
+    end
+
+    module ClassMethods
+      def refresh_daily_ranking!
+        start_date = Date.yesterday
+        end_date = Date.yesterday
+        refresh_ranking!(:daily, start_date, end_date)
+      end
+
+      def refresh_weekly_ranking!
+        start_date = 1.week.ago
+        end_date = Time.current
+        refresh_ranking!(:weekly, start_date, end_date)
+      end
+
+      def refresh_monthly_ranking!
+        start_date = 1.month.ago
+        end_date = Time.current
+        refresh_ranking!(:monthly, start_date, end_date)
+      end
+
+      def refresh_ranking!(period_type, start_date, end_date)
+        analytics = GoogleAnalyticsPageViewRanking::GoogleAnalytics.new
+        analytics.ranking(google_analytics_page_path_regex, start_date, end_date, google_analytics_fetch_limit).results.each do |value|
+          if target = google_analytics_find_item(value)
+            page_view = target.rankings.build
+            page_view.period_type = period_type
+            page_view.page_view = value.pageviews
+            unless page_view.save
+              GoogleAnalyticsPageViewRanking.log "[GoogleAnalyticsPageViewRanking] failed to save #{self.class_name}: #{value}"
+            end
+          end
+        end
+      end
+
+      def google_analytics_page_path_regex
+        item_type = model_name.element.to_sym
+        "^/#{item_type.to_s.pluralize}/[0-9]+$"
+      end
+
+      def google_analytics_find_item(value)
+        target_id = value.page_path.slice(/\d+\z/)
+        find_by(id: target_id)
+      end
+
+      def google_analytics_fetch_limit
+        30
+      end
+    end
+  end
+end

data/lib/google_analytics_page_view_ranking/version.rb

@@ -0,0 +1,3 @@
+module GoogleAnalyticsPageViewRanking
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: google_analytics_page_view_ranking
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Akihiro MATSUMURA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: garb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- matsumura.aki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- google_analytics_page_view_ranking.gemspec
+- lib/generators/google_analytics_page_view_ranking/migration/USAGE
+- lib/generators/google_analytics_page_view_ranking/migration/migration_generator.rb
+- lib/generators/google_analytics_page_view_ranking/migration/templates/create_page_views.rb
+- lib/google_analytics_page_view_ranking.rb
+- lib/google_analytics_page_view_ranking/google_analytics.rb
+- lib/google_analytics_page_view_ranking/page_view.rb
+- lib/google_analytics_page_view_ranking/ranking.rb
+- lib/google_analytics_page_view_ranking/version.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []