brainzz 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 013ac84a0ce1b60ef37f43240595e6065da359c1
-  data.tar.gz: 7acdc32bb6818441d647a6cbc18acfa3422d9953
+  metadata.gz: 3a7df38b3c5dbf4532513c08d8a57155167738f9
+  data.tar.gz: 425b4f946d597db63e5e5f85a28810d36e3934d7
 SHA512:
-  metadata.gz: 740e8f0583e9a2ad8dd6c1bd9e13b3004e005d6ce34e34e6758d007bda82d3c2084044fa39a4096f667f402e7572a8fd34beffd3f3ce0092af242dd981f0059d
-  data.tar.gz: df9271f109dd0d24fcd4a9a1ad9ffc8ee719e5c01154379581b751f76eddf2104122d80b8c71dbd5d4793bc178228dae1daaccf5d63092a86bb6d9521beeec08
+  metadata.gz: d06108933d0b0d71a5b09484018b999e565ce5ebfe9bfe5944c083183e7d880de8be5c27004b31d2ec9508537a9e163e0a74a7c47d281354631d00e958b35fa5
+  data.tar.gz: 1ca881f5099f8930ec5139159abae5ecdc37100a283b8cc0d01748dbb3f526456c83d7a6bfefc6c20ea899d5feb688e2184b113e6e751914eda2bfafdc6a74dc

data/README.md

@@ -25,15 +25,41 @@ Check `config/dotenv/test.env` for the required keys.
 The values in this file are required environment variables
 when consuming this gem.
 
+Environment Variables
+---------------------
+Brainzz requires the use of multiple environment variables:
+- BRAINZZ_GOOGLE_API_KEY
+- BRAINZZ_CLIENT_ID
+- BRAINZZ_CLIENT_SECRET
+- BRAINZZ_REFRESH_TOKEN
+- BRAINZZ_CONTENT_OWNER:
+ - the Google account for the CMS that owns the YouTube channel data being sought
+
+Place values in `config/dotenv/integration.env`.
+
+### Attaining BRAINZZ_GOOGLE_API_KEY
+
 Follow the instructions [here][atv-wiki-google-api-key]
 to find the required values.
 
-Place them in `config/dotenv/integration.env`.
+### Attaining BRAINZZ_REFRESH_TOKEN
+An OAUTH refresh token for the BRAINZZ_CONTENT_OWNER Google account
+uses BRAINZZ_CLIENT_SECRET and BRAINZZ_CLIENT_SECRET
 
+`BRAINZZ_CLIENT_ID` and `BRAINZZ_CLIENT_SECRET`.
+- Go to the [Google OAuth Playground][google-oauth-playground]
+- Log in with the Google account for BRAINZZ_CONTENT_OWNER
+- Click on the gear (upper-right)
+- Click check box to "Use your own OAuth credentials"
+- Fill in BRAINZZ_CLIENT_ID and BRAINZZ_CLIENT_SECRET
+- In Step 1 (Select & Authorize APIs) scroll down to YouTube Analytics API v1
+- Click the last item "yt-analytics.readonly"
+- Click blue 'Authorize APIs' button
+- Exchange code for tokens
+- Grab value for the Refresh Token and store
 
 Interface
 ---------
-
 All public endpoints are exposed in Brainzz::Core.
 
 Every response from the public API is wrapped in a `Response` object
@@ -74,20 +100,13 @@ This endpoint returns a hash with video ids as keys
 and video objects as the values.
 
 
-### views_for
+### views_by_day_for
 
 #### Parameters
 
-* channel id    (String)
 * video id      (String)
 * start date    (DateTime)
 * end date      (DateTime)
-* refresh token (String)
-
-Refresh token must be a refresh token for the channel owner
-using the same client id and client secret that are set in
-`BRAINZZ_CLIENT_ID` and `BRAINZZ_CLIENT_SECRET`.
-
 
 #### Result
 
@@ -111,6 +130,35 @@ corresponding to the following YouTube referrals:
 
 The constants are defined in `Brainzz::ViewCountEnum`
 
+### view_totals_for
+
+#### Parameters
+same as views_by_day_for
+
+#### Result
+same as views_by_day_for except date values are nil
+views for date range are aggregated per source type 
+
+### likes_by_day_for
+
+#### Parameters
+
+* video id      (String)
+* start date    (DateTime)
+* end date      (DateTime)
+
+#### Result
+
+An array of `Brainzz::LikeCount` objects ordered by date in ascending order.
+
+### like_totals_for
+
+#### Parameters
+same as likes_by_day_for
+
+#### Result
+same as likes_by_day_for except date values are nil
+likes for date range are aggregated
 
 Factories
 ---------
@@ -130,3 +178,4 @@ will also build and push this gem to RubyGems.
 
 
 [atv-wiki-google-api-key]: https://www.github.com/awesomenesstv/wiki#google-api-key
+[google-oauth-playground]: https://developers.google.com/oauthplayground/

data/lib/brainzz.rb

@@ -10,7 +10,9 @@ require_relative 'brainzz/enums/view_source_enum'
 
 require_relative 'brainzz/models/base_model'
 require_relative 'brainzz/models/video'
+require_relative 'brainzz/models/video_stat'
 require_relative 'brainzz/models/view_count'
+require_relative 'brainzz/models/like_count'
 require_relative 'brainzz/models/playlist_item'
 require_relative 'brainzz/models/playlist_items_wrapper'
 
@@ -19,19 +21,25 @@ require_relative 'brainzz/services/access_token_service'
 require_relative 'brainzz/params/base_params'
 require_relative 'brainzz/params/analytics_params'
 require_relative 'brainzz/params/video_details_params'
-require_relative 'brainzz/params/view_count_params'
+require_relative 'brainzz/params/video_stats_params'
 require_relative 'brainzz/params/playlist_items_params'
 
 require_relative 'brainzz/responses/playlist_items_response'
 require_relative 'brainzz/responses/video_details_response'
+require_relative 'brainzz/responses/video_stats_response'
 require_relative 'brainzz/responses/view_count_response'
+require_relative 'brainzz/responses/like_count_response'
 
 require_relative 'brainzz/commands/base_command'
 require_relative 'brainzz/commands/data_command'
-require_relative 'brainzz/commands/analytics_command'
 require_relative 'brainzz/commands/playlist_items_command'
 require_relative 'brainzz/commands/video_details_command'
-require_relative 'brainzz/commands/view_count_command'
+require_relative 'brainzz/commands/analytics_command'
+require_relative 'brainzz/commands/video_stats_command'
+require_relative 'brainzz/commands/view_totals_command'
+require_relative 'brainzz/commands/view_count_by_day_command'
+require_relative 'brainzz/commands/like_totals_command'
+require_relative 'brainzz/commands/like_count_by_day_command'
 
 require_relative 'brainzz/core'
 

data/lib/brainzz/commands/analytics_command.rb

@@ -3,16 +3,20 @@ module Brainzz
     class << self
       private
 
+      def base_url
+        'https://www.googleapis.com/youtube/analytics/v1'
+      end
+
+      def endpoint
+        'reports'
+      end
+
       def headers
         super.merge({
           'Authorization' => "Bearer #{access_token}",
         })
       end
 
-      def base_url
-        'https://www.googleapis.com/youtube/analytics/v1'
-      end
-
       def access_token
         AccessTokenService.retrieve_token refresh_token
       end
@@ -20,6 +24,18 @@ module Brainzz
       def refresh_token
         ENV['BRAINZZ_REFRESH_TOKEN']
       end
+
+      def params(analytics_params)
+        super.merge({
+          'ids'        => "contentOwner==#{content_owner}",
+          'start-date' => analytics_params.start_date,
+          'end-date'   => analytics_params.end_date,
+        })
+      end
+
+      def content_owner
+        ENV['BRAINZZ_CONTENT_OWNER']
+      end
     end
   end
 end

data/lib/brainzz/commands/like_count_by_day_command.rb

@@ -0,0 +1,14 @@
+module Brainzz
+  class LikeCountByDayCommand < LikeTotalsCommand
+    class << self
+      private
+
+      def params(video_stats_params)
+        super.merge({
+          'dimensions' => 'day',
+          'sort'       => 'day',
+        })
+      end
+    end
+  end
+end

data/lib/brainzz/commands/like_totals_command.rb

@@ -0,0 +1,27 @@
+module Brainzz
+  class LikeTotalsCommand < VideoStatsCommand
+    class << self
+      def execute(video_id, start_date, end_date)
+        video_stats_params = VideoStatsParams.new ({
+          :video_id   => video_id,
+          :start_date => start_date,
+          :end_date   => end_date,
+        })
+
+        if video_stats_params.valid?
+          LikeCountResponse.new get(video_stats_params)
+        else
+          LikeCountResponse.new
+        end
+      end
+
+      private
+
+      def params(video_stats_params)
+        super.merge({
+          'metrics'    => 'likes',
+        })
+      end
+    end
+  end
+end

data/lib/brainzz/commands/video_stats_command.rb

@@ -0,0 +1,13 @@
+module Brainzz
+  class VideoStatsCommand < AnalyticsCommand
+    class << self
+      private
+
+      def params(video_stats_params)
+        super.merge({
+          'filters'    => "video==#{video_stats_params.video_id}",
+        })
+      end
+    end
+  end
+end

data/lib/brainzz/commands/view_count_by_day_command.rb

@@ -0,0 +1,14 @@
+module Brainzz
+  class ViewCountByDayCommand < ViewTotalsCommand
+    class << self
+      private
+
+      def params(video_stats_params)
+        super.merge({
+          'dimensions' => 'day,insightTrafficSourceType',
+          'sort'       => 'day',
+        })
+      end
+    end
+  end
+end

data/lib/brainzz/commands/view_totals_command.rb

@@ -0,0 +1,28 @@
+module Brainzz
+  class ViewTotalsCommand < VideoStatsCommand
+    class << self
+      def execute(video_id, start_date, end_date)
+        video_stats_params = VideoStatsParams.new ({
+          :video_id   => video_id,
+          :start_date => start_date,
+          :end_date   => end_date,
+        })
+
+        if video_stats_params.valid?
+          ViewCountResponse.new get(video_stats_params)
+        else
+          ViewCountResponse.new
+        end
+      end
+
+      private
+
+      def params(video_stats_params)
+        super.merge({
+          'metrics'    => 'views',
+          'dimensions' => 'insightTrafficSourceType',
+        })
+      end
+    end
+  end
+end

data/lib/brainzz/core.rb

@@ -10,8 +10,20 @@ module Brainzz
       VideoDetailsCommand.execute video_ids
     end
 
-    def views_for(video_id, start_date, end_date)
-      ViewCountCommand.execute video_id, start_date, end_date
+    def views_by_day_for(video_id, start_date, end_date)
+      ViewCountByDayCommand.execute video_id, start_date, end_date
+    end
+
+    def view_totals_for(video_id, start_date, end_date)
+      ViewTotalsCommand.execute video_id, start_date, end_date
+    end
+
+    def likes_by_day_for(video_id, start_date, end_date)
+      LikeCountByDayCommand.execute video_id, start_date, end_date
+    end
+
+    def like_totals_for(video_id, start_date, end_date)
+      LikeTotalsCommand.execute video_id, start_date, end_date
     end
   end
 end

data/lib/brainzz/enums/view_source_enum.rb

@@ -1,5 +1,7 @@
 module Brainzz
   module ViewSourceEnum
+    extend self
+
     ADVERTISING      =  1
     ANNOTATION       =  2
     EXT_URL          =  3
@@ -12,6 +14,10 @@ module Brainzz
     YT_CHANNEL       = 10
     YT_OTHER_PAGE    = 11
     YT_SEARCH        = 12
+    EXT_APP          = 13
+    INFO_CARD        = 14
+
+    UNKNOWN          = -1
 
     SOURCES = {
       'advertising'      => ADVERTISING,
@@ -26,6 +32,15 @@ module Brainzz
       'yt_channel'       => YT_CHANNEL,
       'yt_other_page'    => YT_OTHER_PAGE,
       'yt_search'        => YT_SEARCH,
+      'ext_app'          => EXT_APP,
+      'info_card'        => INFO_CARD,
     }
+
+    def key_for(value)
+      constants.each do |constant|
+        return constant.to_s.downcase if const_get(constant) == value
+      end
+      nil
+    end
   end
 end

data/lib/brainzz/factories.rb

@@ -3,3 +3,4 @@ require_relative 'factories/video'
 require_relative 'factories/playlist_item'
 require_relative 'factories/playlist_items_wrapper'
 require_relative 'factories/view_count'
+require_relative 'factories/like_count'

data/lib/brainzz/factories/like_count.rb

@@ -0,0 +1,14 @@
+FactoryGirl.define do
+  factory :brainzz_like_count, :class => Brainzz::LikeCount do
+    likes  { rand(1_000_000) + 1 }
+    day    { DateTime.parse((DateTime.now - rand(100)).strftime('%F')) }
+
+    factory :brainzz_aggregate_like_count do
+      day nil
+    end
+
+    initialize_with do
+      Brainzz::LikeCount.new({})
+    end
+  end
+end

data/lib/brainzz/factories/sequences.rb

@@ -9,4 +9,8 @@ FactoryGirl.define do
   sequence(:brainzz_playlist_item_id) { |n| "playlist-item-id-#{n}" }
 
   sequence(:brainzz_next_page_token) { |n| "page-token-#{n}" }
+
+  sequence(:brainzz_view_count_source) do |n|
+    n % Brainzz::ViewSourceEnum::SOURCES.count + 1
+  end
 end

data/lib/brainzz/factories/view_count.rb

@@ -2,13 +2,36 @@ FactoryGirl.define do
   factory :brainzz_view_count, :class => Brainzz::ViewCount do
     views  { rand(1_000_000) + 1 }
     day    { DateTime.parse((DateTime.now - rand(100)).strftime('%F')) }
-    source { Brainzz::ViewSourceEnum::SOURCES.values.sample }
+    source { generate :brainzz_view_count_source }
+
+    factory :brainzz_aggregate_view_count do
+      day nil
+    end
 
     Brainzz::ViewSourceEnum::SOURCES.each do |key, value|
       factory "brainzz_#{key}_view_count".to_sym,
           :class => Brainzz::ViewCount do
         source value
       end
+
+      factory "brainzz_#{key}_aggregate_view_count".to_sym,
+          :class => Brainzz::ViewCount do
+        source value
+        day nil
+      end
+    end
+
+    factory :brainzz_unknown_view_count do
+      source nil
+    end
+
+    factory :brainzz_unknown_aggregate_view_count do
+      source Brainzz::ViewSourceEnum::UNKNOWN
+      day nil
+    end
+
+    initialize_with do
+      Brainzz::ViewCount.new({})
     end
   end
 end

data/lib/brainzz/models/like_count.rb

@@ -0,0 +1,19 @@
+module Brainzz
+  class LikeCount < VideoStat
+    attr_accessor :likes
+
+    def initialize(hash)
+      super
+
+      @hash = hash
+
+      @likes  = normalize_stat(likes_data)
+    end
+
+    private
+
+    def likes_data
+      data && keys['likes'] && data[keys['likes']]
+    end
+  end
+end

data/lib/brainzz/models/video_stat.rb

@@ -0,0 +1,29 @@
+module Brainzz
+  class VideoStat < BaseModel
+    attr_accessor :day
+
+    def initialize(hash)
+      @hash = hash
+
+      @day  = transform_date(day_data)
+    end
+
+    private
+
+    def data
+      @hash['data'] || @hash[:data]
+    end
+
+    def keys
+      @hash['keys'] || @hash[:keys]
+    end
+
+    def day_data
+      data && keys['day'] && data[keys['day']]
+    end
+
+    def normalize_stat(stat)
+      stat.to_i if stat
+    end
+  end
+end

data/lib/brainzz/models/view_count.rb

@@ -1,20 +1,29 @@
 module Brainzz
-  class ViewCount < BaseModel
-    attr_accessor :views, :day, :source
+  class ViewCount < VideoStat
+    attr_accessor :views, :source
 
-    def initialize(view_count_row = [])
-      @views  = normalize_views(view_count_row[2])
-      @day    = transform_date(view_count_row[0])
-      @source = source_value(view_count_row[1])
+    def initialize(hash)
+      super
+
+      @hash = hash
+
+      @views  = normalize_stat(views_data)
+      @source = source_value(source_data)
     end
 
     private
 
-    def normalize_views(views)
-      return views ? views.to_i : 0
+    def views_data
+      data && keys['views'] && data[keys['views']]
+    end
+
+    def source_data
+      data && keys['insightTrafficSourceType'] &&
+        data[keys['insightTrafficSourceType']]
     end
 
     def source_value(source)
+      return if source.nil?
       source = '' unless source.is_a?(String)
       Brainzz::ViewSourceEnum::SOURCES[source.downcase]
     end

data/lib/brainzz/params/{view_count_params.rb → video_stats_params.rb}

@@ -1,5 +1,5 @@
 module Brainzz
-  class ViewCountParams < AnalyticsParams
+  class VideoStatsParams < AnalyticsParams
     attr_reader :video_id
 
     def initialize(params)

data/lib/brainzz/responses/like_count_response.rb

@@ -0,0 +1,5 @@
+module Brainzz
+  class LikeCountResponse < VideoStatsResponse
+    make_with_model LikeCount
+  end
+end

data/lib/brainzz/responses/video_stats_response.rb

@@ -0,0 +1,38 @@
+module Brainzz
+  class VideoStatsResponse < Reverb::Response
+    class << self
+      def model
+        @model
+      end
+
+      private
+
+      def make_with_model(model)
+        @model = model
+      end
+    end
+
+    private
+
+    def on_success
+      self.data = []
+      keys = column_headers
+      body['rows'].each do |row|
+        self.data << self.class.model.new({
+          :data => row,
+          :keys => keys,
+        })
+      end
+    end
+
+    def column_headers
+      column_headers = {}
+
+      body['columnHeaders'].each_with_index do |header, index|
+        column_headers[header['name']] = index
+      end
+
+      column_headers
+    end
+  end
+end

data/lib/brainzz/responses/view_count_response.rb

@@ -1,10 +1,5 @@
 module Brainzz
-  class ViewCountResponse < Reverb::Response
-    def on_success
-      self.data = []
-      body['rows'].each do |row|
-        self.data << ViewCount.new(row)
-      end
-    end
+  class ViewCountResponse < VideoStatsResponse
+    make_with_model ViewCount
   end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: brainzz
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Travis Herrick
 - Joshua Book
+- Haskel Ash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -180,29 +181,38 @@ files:
 - lib/brainzz/commands/analytics_command.rb
 - lib/brainzz/commands/base_command.rb
 - lib/brainzz/commands/data_command.rb
+- lib/brainzz/commands/like_count_by_day_command.rb
+- lib/brainzz/commands/like_totals_command.rb
 - lib/brainzz/commands/playlist_items_command.rb
 - lib/brainzz/commands/video_details_command.rb
-- lib/brainzz/commands/view_count_command.rb
+- lib/brainzz/commands/video_stats_command.rb
+- lib/brainzz/commands/view_count_by_day_command.rb
+- lib/brainzz/commands/view_totals_command.rb
 - lib/brainzz/core.rb
 - lib/brainzz/enums/view_source_enum.rb
 - lib/brainzz/factories.rb
+- lib/brainzz/factories/like_count.rb
 - lib/brainzz/factories/playlist_item.rb
 - lib/brainzz/factories/playlist_items_wrapper.rb
 - lib/brainzz/factories/sequences.rb
 - lib/brainzz/factories/video.rb
 - lib/brainzz/factories/view_count.rb
 - lib/brainzz/models/base_model.rb
+- lib/brainzz/models/like_count.rb
 - lib/brainzz/models/playlist_item.rb
 - lib/brainzz/models/playlist_items_wrapper.rb
 - lib/brainzz/models/video.rb
+- lib/brainzz/models/video_stat.rb
 - lib/brainzz/models/view_count.rb
 - lib/brainzz/params/analytics_params.rb
 - lib/brainzz/params/base_params.rb
 - lib/brainzz/params/playlist_items_params.rb
 - lib/brainzz/params/video_details_params.rb
-- lib/brainzz/params/view_count_params.rb
+- lib/brainzz/params/video_stats_params.rb
+- lib/brainzz/responses/like_count_response.rb
 - lib/brainzz/responses/playlist_items_response.rb
 - lib/brainzz/responses/video_details_response.rb
+- lib/brainzz/responses/video_stats_response.rb
 - lib/brainzz/responses/view_count_response.rb
 - lib/brainzz/services/access_token_service.rb
 - license/gplv3.md

data/lib/brainzz/commands/view_count_command.rb

@@ -1,41 +0,0 @@
-module Brainzz
-  class ViewCountCommand < AnalyticsCommand
-    class << self
-      def execute(video_id, start_date, end_date)
-        view_count_params = ViewCountParams.new({
-          :video_id      => video_id,
-          :start_date    => start_date,
-          :end_date      => end_date
-        })
-
-        if view_count_params.valid?
-          ViewCountResponse.new get(view_count_params)
-        else
-          ViewCountResponse.new
-        end
-      end
-
-      private
-
-      def endpoint
-        'reports'
-      end
-
-      def params(view_count_params)
-        super.merge({
-          'ids'        => "contentOwner==#{content_owner}",
-          'filters'     => "video==#{view_count_params.video_id}",
-          'metrics'    => 'views',
-          'dimensions' => 'day,insightTrafficSourceType',
-          'start-date' => view_count_params.start_date,
-          'end-date'   => view_count_params.end_date,
-          'sort'       => 'day',
-        })
-      end
-
-      def content_owner
-        ENV['BRAINZZ_CONTENT_OWNER']
-      end
-    end
-  end
-end