brainzz 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5593938f8cecb4660e3c474a61dcbf908a74f0a2
-  data.tar.gz: 2db3a9a659c9241a7501870fb212a57f73accfa7
+  metadata.gz: 8b0778b1b4125407b03db2409943f825a0175ed0
+  data.tar.gz: a380360a2548603619f847f20cad660367ba70e7
 SHA512:
-  metadata.gz: 2387071a7d82e12d58798ccade04c873531aa77335fc1931c4a61f2ec688c3e30b290567ed02805e0f40ad323adeea368edc64e4eda774a3daa81d6bb7df8111
-  data.tar.gz: 5821bb60c0a98d8c8f04319450d4ac282c609800352781518d776cf4415bc6525facb147d2a6014cc57807dad56b792ea4b2992e4af84cf19dc7706f109544d1
+  metadata.gz: 65e2ecf248cbaf6c936f4e26f3fc71a6e6948776dbf4abcfa747489c46a530a776b0f570ab64fe520f4b89edf122159aee295460f3db14e1786f2a612aac8af6
+  data.tar.gz: be9d7f05e156220dfa77132b0c688c0daecef19fda6f4abf2298db63f14bed1023ee5fa89f76b34439a23b2a42c00a8c5e1a8ab78182291f56dc60fe01e18b4a

data/README.md

@@ -1,6 +1,8 @@
 Brainzz
 =======
 
+[![Build Status](https://semaphoreci.com/api/v1/projects/6bcf66fa-7d8c-4027-93ae-13b6bb75325f/346455/badge.png)](https://semaphoreci.com/awesomenesstv/brainzz)
+
 Brainzz explains why youtoobers' brainzz are turned to mush.
 ... by extracting data from the YouTube API.
 
@@ -19,24 +21,22 @@ Run Specs
 
 ### Regenerating VCR Cassettes
 
-In order to regenerate vcr cassettes,
-the google api key is needed.
-
-Follow the instructions [here][atv-wiki-google-api-key] to retrieve it.
+Check `config/dotenv/test.env` for the required keys.
 
-Place this value in a file named `.env` in the root of the project
+Follow the instructions [here][atv-wiki-google-api-key]
+to find the required values.
 
-The `.env` contents should look something like this:
+`REFRESH_TOKEN` is only required for testing purposes.
+Consumers will not need to set this value,
+as it will be passed in via parameters to methods that require it.
 
-```
-GOOGLE_API_KEY = [API KEY]
-```
+Place them in `config/dotenv/integration.env`.
 
 
 Usage
 -----
 
-A `GOOGLE_API_KEY` environment variable is expected to be set
+A `BRAINZZ_GOOGLE_API_KEY` environment variable is expected to be set
 by any application that consumes this gem.
 
 
@@ -72,4 +72,70 @@ while response.nil? || !response.data.last_page?
 end
 ```
 
+
+### video_details_for
+
+Accepts an array of video ids.
+The maximum length of the array is determined by YouTube.
+It is currently limited to 50 videos.
+
+This endpoint returns a hash with video ids as keys
+and video objects as the values.
+
+
+### views_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
+
+An array of `Brainzz::ViewCount` objects ordered by date in ascending order.
+
+`#source` will be an integer (or nil) value
+corresponding to the following YouTube referrals:
+
+	ADVERTISING      =  1
+	ANNOTATION       =  2
+	EXT_URL          =  3
+	NO_LINK_EMBEDDED =  4
+	NO_LINK_OTHER    =  5
+	PLAYLIST         =  6
+	PROMOTED         =  7
+	RELATED_VIDEO    =  8
+	SUBSCRIBER       =  9
+	YT_CHANNEL       = 10
+	YT_OTHER_PAGE    = 11
+	YT_SEARCH        = 12
+
+The constants are defined in `Brainzz::ViewCountEnum`
+
+
+Factories
+---------
+
+Brainzz includes FactoryGirl factories for your convenience.
+Include them after requiring FactoryGirl:
+
+	require 'brainzz/factories'
+
+
+Deployment
+----------
+
+This project makes use of branches to manage deployment.
+Pushing a new commit to the `production` branch
+will also build and push this gem to RubyGems.
+
+
 [atv-wiki-google-api-key]: https://www.github.com/awesomenesstv/wiki#google-api-key

data/lib/brainzz.rb

@@ -4,23 +4,36 @@ require 'date'
 require 'faraday'
 
 require 'reverb'
+require 'toke'
 
-module Brainzz
-end
-
-require_relative 'brainzz/core'
+require_relative 'brainzz/enums/view_source_enum'
 
 require_relative 'brainzz/models/base_model'
 require_relative 'brainzz/models/video'
+require_relative 'brainzz/models/view_count'
 require_relative 'brainzz/models/playlist_item'
 require_relative 'brainzz/models/playlist_items_wrapper'
 
+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/playlist_items_params'
+
 require_relative 'brainzz/responses/playlist_items_response'
 require_relative 'brainzz/responses/video_details_response'
+require_relative 'brainzz/responses/view_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/core'
 
 module Brainzz
   extend Core

data/lib/brainzz/commands/analytics_command.rb

@@ -0,0 +1,21 @@
+module Brainzz
+  class AnalyticsCommand < BaseCommand
+    class << self
+      private
+
+      def headers(parameters)
+        super.merge({
+          'Authorization' => "Bearer #{access_token(parameters)}",
+        })
+      end
+
+      def base_url
+        'https://www.googleapis.com/youtube/analytics/v1'
+      end
+
+      def access_token(parameters)
+        AccessTokenService.retrieve_token parameters.refresh_token
+      end
+    end
+  end
+end

data/lib/brainzz/commands/base_command.rb

@@ -1,29 +1,29 @@
 module Brainzz
-  module BaseCommand
-    extend self
+  class BaseCommand
+    class << self
+      private
 
-    private
+      def get(parameters)
+        connection.get endpoint, params(parameters), headers(parameters)
+      end
 
-    def connection
-      Faraday.new(:url => base_url)
-    end
+      def connection
+        Faraday.new(:url => base_url)
+      end
 
-    def params
-      url_params.merge({
-        :key => api_key,
-      })
-    end
+      def params(parameters = nil)
+        {}
+      end
 
-    def url_params
-      {}
-    end
-
-    def api_key
-      ENV['GOOGLE_API_KEY']
-    end
+      def headers(parameters = nil)
+        {
+          'Content-Type' => 'application/json',
+        }
+      end
 
-    def base_url
-      'https://www.googleapis.com/youtube/v3'
+      def url(parameters)
+        connection.build_url endpoint, params(parameters)
+      end
     end
   end
 end

data/lib/brainzz/commands/data_command.rb

@@ -0,0 +1,19 @@
+module Brainzz
+  class DataCommand < BaseCommand
+    class << self
+      def params(parameters = nil)
+        super.merge({
+          :key => api_key,
+        })
+      end
+
+      def base_url
+        'https://www.googleapis.com/youtube/v3'
+      end
+
+      def api_key
+        ENV['BRAINZZ_GOOGLE_API_KEY']
+      end
+    end
+  end
+end

data/lib/brainzz/commands/playlist_items_command.rb

@@ -1,28 +1,37 @@
 module Brainzz
-  module PlaylistItemsCommand
-    extend BaseCommand
-    extend self
+  class PlaylistItemsCommand < DataCommand
+    class << self
+      def execute(playlist_id, response)
+        playlist_items_params = PlaylistItemsParams.new(playlist_id, response)
 
-    def execute(playlist_id, response)
-      @response = response
-      @playlist_id = playlist_id
-      response = connection.get('playlistItems', params)
-      PlaylistItemsResponse.new response
-    end
+        if playlist_items_params.valid?
+          response = get(playlist_items_params)
+          PlaylistItemsResponse.new response
+        else
+          PlaylistItemsResponse.new
+        end
+      end
+
+      private
+
+      def endpoint
+        'playlistItems'
+      end
 
-    private
+      def params(playlist_items_params)
+        args = {
+          'playlistId' => playlist_items_params.playlist_id,
+          'part'       => 'contentDetails',
+          'maxResults' => 50,
+        }
 
-    def url_params
-      params = {
-        'playlistId' => @playlist_id,
-        'part'       => 'contentDetails',
-        'maxResults' => 50,
-      }
+        if playlist_items_params.next_page_token
+          args.merge!({
+            'pageToken' => playlist_items_params.next_page_token
+          })
+        end
 
-      if @response
-        params.merge({'pageToken' => @response.data.next_page_token})
-      else
-        params
+        super.merge args
       end
     end
   end

data/lib/brainzz/commands/video_details_command.rb

@@ -1,21 +1,29 @@
 module Brainzz
-  module VideoDetailsCommand
-    extend BaseCommand
-    extend self
+  class VideoDetailsCommand < DataCommand
+    class << self
+      def execute(video_ids)
+        video_details_params = VideoDetailsParams.new(video_ids)
 
-    def execute(video_ids)
-      @video_ids = video_ids
-      response = connection.get('videos', params)
-      VideoDetailsResponse.new response
-    end
+        if video_details_params.valid?
+          response = get(video_details_params)
+          VideoDetailsResponse.new response
+        else
+          VideoDetailsResponse.new
+        end
+      end
+
+      private
 
-    private
+      def endpoint
+        'videos'
+      end
 
-    def url_params
-      {
-        'id'   => @video_ids.join(','),
-        'part' => 'snippet',
-      }
+      def params(video_details_params)
+        super.merge({
+          'id'   => video_details_params.video_ids.join(','),
+          'part' => 'snippet',
+        })
+      end
     end
   end
 end

data/lib/brainzz/commands/view_count_command.rb

@@ -0,0 +1,39 @@
+module Brainzz
+  class ViewCountCommand < AnalyticsCommand
+    class << self
+      def execute(channel_id, video_id, start_date, end_date, refresh_token)
+        view_count_params = ViewCountParams.new({
+          :channel_id    => channel_id,
+          :video_id      => video_id,
+          :start_date    => start_date,
+          :end_date      => end_date,
+          :refresh_token => refresh_token
+        })
+
+        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'        => "channel==#{view_count_params.channel_id}",
+          'filter'     => "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
+    end
+  end
+end

data/lib/brainzz/core.rb

@@ -7,7 +7,12 @@ module Brainzz
     end
 
     def video_details_for(video_ids)
-      VideoDetailsCommand.execute(video_ids)
+      VideoDetailsCommand.execute video_ids
+    end
+
+    def views_for(channel_id, video_id, start_date, end_date, refresh_token)
+      ViewCountCommand.execute(
+        channel_id, video_id, start_date, end_date, refresh_token)
     end
   end
 end

data/lib/brainzz/enums/view_source_enum.rb

@@ -0,0 +1,31 @@
+module Brainzz
+  module ViewSourceEnum
+    ADVERTISING      =  1
+    ANNOTATION       =  2
+    EXT_URL          =  3
+    NO_LINK_EMBEDDED =  4
+    NO_LINK_OTHER    =  5
+    PLAYLIST         =  6
+    PROMOTED         =  7
+    RELATED_VIDEO    =  8
+    SUBSCRIBER       =  9
+    YT_CHANNEL       = 10
+    YT_OTHER_PAGE    = 11
+    YT_SEARCH        = 12
+
+    SOURCES = {
+      'advertising'      => ADVERTISING,
+      'annotation'       => ANNOTATION,
+      'ext_url'          => EXT_URL,
+      'no_link_embedded' => NO_LINK_EMBEDDED,
+      'no_link_other'    => NO_LINK_OTHER,
+      'playlist'         => PLAYLIST,
+      'promoted'         => PROMOTED,
+      'related_video'    => RELATED_VIDEO,
+      'subscriber'       => SUBSCRIBER,
+      'yt_channel'       => YT_CHANNEL,
+      'yt_other_page'    => YT_OTHER_PAGE,
+      'yt_search'        => YT_SEARCH,
+    }
+  end
+end

data/lib/brainzz/models/base_model.rb

@@ -19,7 +19,7 @@ module Brainzz
     def transform_date(value)
       value = transform(value)
       return nil unless value.is_a?(String)
-      DateTime.parse(value)
+      DateTime.parse value
     end
   end
 end

data/lib/brainzz/models/view_count.rb

@@ -0,0 +1,22 @@
+module Brainzz
+  class ViewCount < BaseModel
+    attr_reader :views, :day, :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])
+    end
+
+    private
+
+    def normalize_views(views)
+      return views ? views.to_i : 0
+    end
+
+    def source_value(source)
+      source = '' unless source.is_a?(String)
+      Brainzz::ViewSourceEnum::SOURCES[source.downcase]
+    end
+  end
+end

data/lib/brainzz/params/analytics_params.rb

@@ -0,0 +1,19 @@
+module Brainzz
+  class AnalyticsParams < BaseParams
+    attr_reader :channel_id
+    attr_reader :start_date
+    attr_reader :end_date
+    attr_reader :refresh_token
+
+    def initialize(params)
+      @channel_id    = normalize(params[:channel_id])
+      @start_date    = normalize_date(params[:start_date])
+      @end_date      = normalize_date(params[:end_date])
+      @refresh_token = normalize(params[:refresh_token])
+    end
+
+    def valid?
+      !!(channel_id && start_date && end_date && refresh_token)
+    end
+  end
+end

data/lib/brainzz/params/base_params.rb

@@ -0,0 +1,14 @@
+module Brainzz
+  class BaseParams
+    private
+
+    def normalize(value)
+      value = nil if value && value.strip == ''
+      value
+    end
+
+    def normalize_date(date)
+      date.strftime('%F') if date.respond_to?(:strftime)
+    end
+  end
+end

data/lib/brainzz/params/playlist_items_params.rb

@@ -0,0 +1,20 @@
+module Brainzz
+  class PlaylistItemsParams < BaseParams
+    attr_reader :playlist_id, :next_page_token
+
+    def initialize(playlist_id, response)
+      @playlist_id     = normalize(playlist_id)
+      @next_page_token = page_token_for(response)
+    end
+
+    def valid?
+      !!playlist_id
+    end
+
+    private
+
+    def page_token_for(response)
+      response && response.data && response.data.next_page_token
+    end
+  end
+end

data/lib/brainzz/params/video_details_params.rb

@@ -0,0 +1,13 @@
+module Brainzz
+  class VideoDetailsParams
+    attr_reader :video_ids
+
+    def initialize(video_ids)
+      @video_ids = video_ids
+    end
+
+    def valid?
+      !!(@video_ids && !@video_ids.empty?)
+    end
+  end
+end

data/lib/brainzz/params/view_count_params.rb

@@ -0,0 +1,14 @@
+module Brainzz
+  class ViewCountParams < AnalyticsParams
+    attr_reader :video_id
+
+    def initialize(params)
+      super
+      @video_id = normalize(params[:video_id])
+    end
+
+    def valid?
+      !!(super && video_id)
+    end
+  end
+end

data/lib/brainzz/responses/view_count_response.rb

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

data/lib/brainzz/services/access_token_service.rb

@@ -0,0 +1,28 @@
+module Brainzz
+  module AccessTokenService
+    extend self
+
+    @@mutex = Mutex.new
+
+    def retrieve_token(refresh_token)
+      @@mutex.synchronize do
+        if !defined?(@token) or @token.expired?
+          response = Toke.retrieve_token(params(refresh_token))
+          @token = response.data if response.success?
+        end
+
+        @token.token if defined?(@token)
+      end
+    end
+
+    private
+
+    def params(refresh_token)
+      {
+        :refresh_token => refresh_token,
+        :client_id     => ENV['BRAINZZ_CLIENT_ID'],
+        :client_secret => ENV['BRAINZZ_CLIENT_SECRET'],
+      }
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: brainzz
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Travis Herrick
-- Meagan Cooney
+- Joshua Book
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: toke
+  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: gems
   requirement: !ruby/object:Gem::Requirement
@@ -163,10 +177,14 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/brainzz.rb
+- lib/brainzz/commands/analytics_command.rb
 - lib/brainzz/commands/base_command.rb
+- lib/brainzz/commands/data_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/core.rb
+- lib/brainzz/enums/view_source_enum.rb
 - lib/brainzz/factories.rb
 - lib/brainzz/factories/playlist_item.rb
 - lib/brainzz/factories/playlist_items_wrapper.rb
@@ -176,8 +194,16 @@ files:
 - lib/brainzz/models/playlist_item.rb
 - lib/brainzz/models/playlist_items_wrapper.rb
 - lib/brainzz/models/video.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/responses/playlist_items_response.rb
 - lib/brainzz/responses/video_details_response.rb
+- lib/brainzz/responses/view_count_response.rb
+- lib/brainzz/services/access_token_service.rb
 - license/gplv3.md
 - license/lgplv3.md
 - license/lgplv3.png
@@ -201,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: YouTube API interface