most-popular 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06e97da7a3296fe71490cde62c4b19e129b419ea
+  data.tar.gz: f3fc0cb6e37cac44b6a228167bdd25c59132be38
+SHA512:
+  metadata.gz: e2e42c530a352c1ca2f7eef249b492fb5229a6b9e8ac1138d7fdbbe59114506e42cf364ba17c6705f9202543b6e74e05858f77045b3a9239195c1de18374e469
+  data.tar.gz: 8960dc2b3bdcc1859b01b63d35e064e1a5e985e099e8ba4af1561f2ee1f9555b0eea5730fac6c38ff40922e039b757c6774f031f19efe092a5e6ee71c7bfbb50

data/.env.example

@@ -0,0 +1,6 @@
+SERVICE_ACCOUNT_EMAIL=238317317317-htv966ia96ii951mhhk6qhk6edtt2lad@developer.gserviceaccount.com
+PROFILE_ID=777777
+FILENAME=lib/most-popular/config/production/MyApplication-5eae1f52d9cf.p12
+SECRET=notasecret
+APPLICATION_NAME=MyApplication
+APPLICATION_VERSION=1.0.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.1.5
+- 2.2.2
+before_install:
+- gem update --system
+- gem --version
+- gem update bundler
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Iu+VsOaUY3SRBbDz30ROceQdhsp5VZrZ9v9Qmy1O/KVJDgODz5dJBwlbw0bUW5KL7BhyuSZfkDHA/UaZoB1/Ww/Qf+RqPIo36C0YHGktfUUs3F8iaEAkd0unTf5NcI9H+OnAFR5VqHCn5nwla+gABM7kTYy2/uIrM36XRjHF3kUhBVLELcOjr3x4P1ofJKOdLoS4IPMYc8sYT/Ai/62XVlCKjK+za4UWba2nnSWI/D6i/Hja/HUlNc1eqEaQIB9NRDhGtvv3mIfBNkdVBn+T3hk1n9Ddb07xOoPYfo8QKCMzC0vv0ayqUEEBlYYylFxXBETK3n7KB6u30/soMJNfj7ncZ8ePe1kHXS1wpd5uTI7kBFRWCwScXaEtAuMt73+3V6KHQKNXljESCAOqrIDVVHJjh8RsSVHseDpSCHEY9TsDMIUyTjIcYovRlGakWLNUmRM5yWJO19IahiGElaxG6xMywcyeRDzOVKh5XBe/pD2asa54NnyEQ62lQLm+CLv9Ma2kEAZUAjLLOXR/duaorHOeiET39QoxgVeSWqIaQFOvuHqZv9ziRRITVqOSFZD9vjdqCMm44aipgi8bbl1iLzLIQG/ceHg4C/AkLsO4xtgv/7ThARLy3Xq5XVkjp9TkMZDrE6s7K9ryB/z21XczSe4XnMRbJUWnvp2Etieyecw=
+  on:
+    tags: true

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 gambaroff
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+[![Build Status](https://travis-ci.org/gambaroff/google-analytics-most-popular.svg?branch=master)](https://travis-ci.org/gambaroff/google-analytics-most-popular)
+# most_popular
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'most-popular'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install most-popular
+
+## Usage
+You will need a service account credentials from google.
+
+## Service Account with Google for Server-to-Server Applications
+Google API uses OAuth 2.0 with service accounts. Learn more about Google APIs and OAuth 2.0 here:https://developers.google.com/accounts/docs/OAuth2
+
+Or, follow these steps.
+
+1. From the "Project Home" screen, activate access to "Google+ API”.
+2. From google developer console, APIs -> Enabled APIs - Must enable analytics API
+3. Click on "APIs&Auth" in the left column
+4. Click  Credentials in the left column
+5. Under OAuth click Create New ClientID button
+6. Give your application a name and click "Next"
+7. Select "Service Account" as the "Application type"
+8. Select "other" under "Installed application type"
+9. Click "Create client ID"
+10. Click 'Download private key' to save the generate private key file
+
+
+### Managing Credentials
+
+* ###Using Bash or Zsh Profile
+
+This is the “bare minimum” solution. You can store the environment variable key/value pairs with the operating system directly and globally, so they are going to be available to the Rails app. In your .bashrc file or .zshrc file, set environment variables with lines like:
+```
+export KEY=value
+```
+
+With this, you can fire up rails console or irb and access your environment var by doing:
+
+```
+ENV["KEY"]
+=> "value"
+```
+This is also not very ideal for creating app-specific environment variables or using different environment variables for different environments such as development and testing
+http://www.gotealeaf.com/blog/managing-environment-configuration-variables-in-rails
+
+* ###Using a gem, like Dotenv
+
+[Dotenv](https://github.com/bkeepers/dotenv) solves the problems of setting project-specific environment vars and is super easy to get started on. Start by including the ```gem 'dotenv-rails', :groups => [:development, :test]``` in the appropriate groups, in this case development and test. You can then put your sensitive information inside a .env file at the root of your project directory:
+
+ ```
+SERVICE_ACCOUNT_EMAIL=072731723843-htv966ia965hk61mii9hqr98edtt2lad@developer.gserviceaccount.com
+PROFILE_ID=77777
+FILENAME=config/environments/production/YourApp-5eee1f52d9cf.p12
+SECRET=notasecret
+```
+
+You can call these variables anywhere in your Rails application by using: ```ENV["SERVICE_ACCOUNT_EMAIL"], ENV["PROFILE_ID"], ENV["FILENAME"] and ENV["SECRET"]```
+
+Support for export (for accessing these variables in the terminal) and yaml-like configs come baked in. Make sure to git-ignore your ```.env``` files if you’re working alone or you’ll be back to square one. While working on a team, you can maintain a default ```.env.example``` file that is checked into source control with further instructions to other developers. check out  [dotenv](https://github.com/bkeepers/dotenv)
+
+More info on [Managing Environment Configuration Variables in Rails](http://www.gotealeaf.com/blog/managing-environment-configuration-variables-in-rails)
+
+
+### Example Rails App
+
+```ruby
+#app/models/concerns/most_popupar_story.rb
+
+class MostPopularStory
+  def initialize
+    builder = MostPopular::Analytics::GoogleAnalyticsBuilder.new
+    builder.service_account({
+      service_account_email: ENV["SERVICE_ACCOUNT_EMAIL"],
+      profile_id: ENV["PROFILE_ID"]
+      })
+    builder.key_file({
+      filename: ENV["FILENAME"],
+      secret: ENV["SECRET"]
+      })
+    builder.application({
+      application_name: 'Your Application',
+      application_version: '1.0.0'
+      })
+    builder.api(:api_v3)
+    builder.filter({filter: 'topics'})
+    analytics = builder.build
+    @trending = MostPopular::Trending::TrendingStory.new(analytics)
+  end
+
+  def trending
+    @trending.trending_stories
+  end
+end
+```
+
+### Optional Arguments
+
+trending_stories method can take a Hash of  any of these *date: :today*, *date: :last_day*, *date: :last_week*, *num_results: 10*, filter: 'my_filter'
+
+for example
+
+```ruby
+@trending.trending_stories(date: :last_week, num_results: 3)
+```
+
+## Testing Example,  using VCR gem
+```ruby
+require 'rails_helper'
+
+RSpec.describe MostPopularStory do
+  let(:trending) { MostPopularStory.new}
+
+  VCR.use_cassette('treding_story', :record => :new_episodes) do
+    describe '#initialize' do
+      it 'can be instantiated',:vcr do
+        expect(trending).not_to be_nil
+        expect(trending.class).to eq MostPopularStory
+      end
+    end
+
+    describe '#now_trending' do
+      it 'contains an array of trending stories', :vcr do
+        expect(trending.now_trending.class).to eq Array
+        expect(trending.now_trending.size).to eq  10
+      end
+
+      it 'contains expected Object', :vcr do
+        expect(trending.now_trending.first.class).to eq  MostPopular::Trending::ViewedStory
+      end
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+RSpec::Core::RakeTask.new

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "most-popular"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/most-popular.rb

@@ -0,0 +1,4 @@
+require "most-popular/version"
+require "most-popular/google_analytics"
+require "most-popular/viewed_story"
+require "most-popular/trending"

data/lib/most-popular/google_analytics.rb

@@ -0,0 +1,88 @@
+require 'google/api_client'
+
+module MostPopular
+  module Analytics
+    class GoogleAnalytics
+      # Don't call GoogleAnalytics.new directly.  Use GoogleAnalyticsBuilder instead.  See unit tests
+      def initialize(client, api_method, profile_id, filter)
+        @client = client
+        @api_method = api_method
+        @profile_id = profile_id
+        @filter = filter
+      end
+
+      def summarize(args={})
+        args = defaults.merge(args)
+        results = @client.execute(
+          :api_method => @api_method,
+          :parameters => query_hash(args))
+        results.data.rows
+      end
+
+      private
+
+      def defaults
+        {start_date: 'yesterday', end_date: 'today', num_results: 10 }
+      end
+
+      def query_hash(args)
+        {
+            'ids' => "ga:" + @profile_id,
+            'start-date' => args[:start_date],
+            'end-date' => args[:end_date],
+            'dimensions' => 'ga:pagePath',
+            'metrics' => 'ga:pageviews',
+            'sort' => '-ga:pageviews',
+            'filters' => 'ga:pagePath=~^/' + @filter.to_s + '/.*',
+            'max-results' => args[:num_results]
+        }
+      end
+
+    end
+
+    class GoogleAnalyticsBuilder
+      def service_account(args)
+        @service_account_email = args[:service_account_email]
+        @profile_id = args[:profile_id]
+      end
+
+      def key_file(args)
+        @key_file = args[:filename]
+        @key_secret = args[:secret]
+      end
+
+      def application(args)
+        @application_name = args[:application_name]
+        @application_version = args[:application_version]
+      end
+
+      def api(api)
+        raise 'API not yet supported' unless api == :api_v3
+        @api_name = 'analytics'
+        @api_version = 'v3'
+      end
+
+      def filter(args)
+        @filter = args[:filter]
+      end
+
+      def build
+        #TODO check if account is set up or else raise exception
+        client = Google::APIClient.new(
+          :application_name => @application_name,
+          :application_version => @application_version
+        )
+        key = Google::APIClient::KeyUtils.load_from_pkcs12(@key_file, @key_secret)
+        client.authorization =  Signet::OAuth2::Client.new(
+          :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
+          :audience => 'https://accounts.google.com/o/oauth2/token',
+          :scope => 'https://www.googleapis.com/auth/analytics.readonly',
+          :issuer => @service_account_email,
+          :signing_key => key)
+        client.authorization.fetch_access_token!
+        api_method = client.discovered_api(@api_name, @api_version).data.ga.get
+        GoogleAnalytics.new(client, api_method, @profile_id, @filter)
+      end
+    end
+  end
+end

data/lib/most-popular/trending.rb

@@ -0,0 +1,32 @@
+module MostPopular
+  module Trending
+    class TrendingStory
+
+      def initialize(analytics)
+        @analytics = analytics
+      end
+
+      def trending_stories(date: :last_day, num_results: 10)
+        start_date, end_date = dates_for(date)
+        rows = @analytics.summarize({start_date: start_date, end_date: end_date, num_results: num_results})
+        rows.collect do |r|
+          ViewedStory.new(r.first, r.last)
+        end
+      end
+
+      private
+
+      def dates_for(date)
+        #TODO consider moving logic to Analytics subclasses
+        case date
+        when :last_day
+          return 'yesterday', 'today'
+        when :last_week
+          return '7daysAgo', 'today'
+        else
+          raise "I don't know what to do with #{date}"
+        end
+      end
+    end
+  end
+end

data/lib/most-popular/version.rb

@@ -0,0 +1,3 @@
+module MostPopular
+  VERSION = "0.1.0"
+end

data/lib/most-popular/viewed_story.rb

@@ -0,0 +1,13 @@
+module MostPopular
+  module Trending
+    class ViewedStory
+      attr_reader :uri,:views
+
+      def initialize(uri,views)
+        @uri = uri
+        @views = views
+      end
+
+    end
+  end
+end

data/most-popular.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'most-popular/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "most-popular"
+  spec.version       = MostPopular::VERSION
+  spec.authors       = ["Stephania Gambaroff Thomas"]
+  spec.email         = ["sthomas@marketplace.org"]
+
+  spec.summary       = %q{Google Analytics Most popular}
+  spec.description   = %q{Authorizes server to server account and returns X number of most viewed pages by path}
+  spec.homepage      = "https://github.com/gambaroff/google-analytics-most-popular"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+
+  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 "google-api-client", "~> 0.8.6"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rspec-mocks", "~> 3.2"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.20"
+  spec.add_development_dependency "dotenv", "~> 2.0"
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: most-popular
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephania Gambaroff Thomas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Authorizes server to server account and returns X number of most viewed
+  pages by path
+email:
+- sthomas@marketplace.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/most-popular.rb
+- lib/most-popular/config/Test-5eae1f52d9cf.p12
+- lib/most-popular/config/Test2-2bdbc68098d7.p12
+- lib/most-popular/google_analytics.rb
+- lib/most-popular/trending.rb
+- lib/most-popular/version.rb
+- lib/most-popular/viewed_story.rb
+- most-popular.gemspec
+homepage: https://github.com/gambaroff/google-analytics-most-popular
+licenses:
+- MIT
+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.8
+signing_key: 
+specification_version: 4
+summary: Google Analytics Most popular
+test_files: []