yt-core 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38fe8ee547f6c51750be3b935de33654304a92bc
-  data.tar.gz: ca5b035d73c726d4f9f4a2428b3a4cc6cb573515
+  metadata.gz: 9ecd986ee6a7ae04f3d23ae8a9bd91eb4739e059
+  data.tar.gz: a0ea45421a464e5707c0a75e712764b44b39b91e
 SHA512:
-  metadata.gz: 3201de66a86b9df6caf10792426616f01ea177153983090cb32d1bd19f83f99b947b79f9012d4e33f34411930e5f3c978664d6d9c3f7b2c536ccbb4412523a52
-  data.tar.gz: 0f1daea896d3ea422837992e8b3f1aeefb04d0576af63e51f783ae00ac5234b45ccf7ce3d77b2fc84578968fc1e69a37befb9ac9d32b3c3cfb7ef2669c0653b1
+  metadata.gz: 2115a2bf9c7517768e1bf1bfc44c21c37e6167cc5672240a6b7a5411e0bd28e9809d6a4fafadc2e8e7568d0792d44e33010ded0a24c88f5fe2c17b88464445cb
+  data.tar.gz: ff578ed38057d5873d68c97b2dedbb4223e929a9f4da1f8a5c5f83a349b4eb16edde57c22add762b77cf3e227cd7f11e53f9bdcba04ea136db66d4c552508e10

data/CHANGELOG.md

@@ -6,6 +6,15 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.1.7 - 2017-08-27
+
+* [FEATURE] Add `Channel#groups` and `Yt::Group`
+* [ENHANCEMENT] Call `Yt#Auth.access_token_was_refreshed` after refreshing a token.
+
+## 0.1.6 - 2017-08-26
+
+* [ENHANCEMENT] Compatibility with yt-auth 0.3.0.
+
 ## 0.1.5 - 2017-08-24
 
 * [FEATURE] Add `Yt::PlaylistItem.insert` and `Yt::PlaylistItem#delete`

data/docs/_layouts/default.html

@@ -38,6 +38,11 @@
               {% else %}
                 <li><a href="{{ site.baseurl }}/comments.html">Comments</a></li>
               {% endif %}
+              {% if page.url == '/groups.html' %}
+                <li><a href="{{ site.baseurl }}/groups.html" class="active">Groups</a></li>
+              {% else %}
+                <li><a href="{{ site.baseurl }}/groups.html">Groups</a></li>
+              {% endif %}
               {% if page.url == '/errors.html' %}
                 <li><a href="{{ site.baseurl }}/errors.html" class="active">Errors</a></li>
               {% else %}

data/docs/channels.html

@@ -171,3 +171,11 @@ channel = Yt::Channel.mine
 {% include example.html result='#&lt;Yt::Channel @id=UCwCnUcLcb9-eSrHa_RQGkQQ&gt;' %}</pre>
   </div></dd>
 </dl>
+
+<dl>
+  {% include dt.html title="Channel’s analytics groups" label="warning" auth="must authenticate as the channel’s account" %}
+  <dd><a class="anchor" id="groups"></a><div class="highlight"><pre>
+{% include doc.html instance="Channel#groups" %}{% include example.html object='<span class="no">Yt</span><span class="o">::</span><span class="no">Channel</span>' method='mine.groups' %}
+{% include example.html result='#&lt;Yt::Relation [#&lt;Yt::Group @id=ABVSo3DwAAA&gt;, ...]&gt;' %}</pre>
+  </div></dd>
+</dl>

data/docs/groups.html

@@ -0,0 +1,52 @@
+---
+title:  "Yt::Group"
+h2: "Groups"
+---
+
+<p>
+  <code>Yt::Group</code> represents a <a href="https://developers.google.com/youtube/analytics/v1/reference/groups">YouTube Analytics group</a>.
+  Initialize using its YouTube ID:
+</p>
+
+<dl>
+  <dd><a class="anchor" id="new"></a><div class="highlight"><pre>
+{% include doc.html instance="Group#initialize" %}{% include example.html object='group = <span class="no">Yt</span><span class="o">::</span><span class="no">Group</span>' method='new' params=' <span class="ss">id:</span> <span class="s1">"ABVSo3DwAAA"</span>' %}
+{% include example.html result='#&lt;Yt::Group @id=ABVSo3DwAAA&gt;' %}
+{% include doc.html instance="Group#canonical_url" %}{% include example.html object='group' method='title' %}
+{% include example.html result='"Video group"' %}</pre>
+  </div></dd>
+</dl>
+
+<hr />
+<h4>Authentication</h4>
+
+<p>
+  All methods of <code>Yt::Group</code> <strong>act on behalf of YouTube accounts</strong> (e.g.: to fetch a group).<br />
+  To use these methods (marked with  <span class="label label-warning">&nbsp;</span> below), you need to <a href="{{ site.baseurl }}/#api_client">get an API Client ID/Secret from Google</a>, then <a href="{{ site.baseurl }}/#tokens">obtain a refresh token</a> from the account you want to act as, and finally configure the values:
+</p>
+
+{% highlight ruby %}
+Yt.configuration.client_id = "<your ID>"           ## replace with your client ID
+Yt.configuration.client_secret = "<your secret>"   ## replace with your client secret
+Yt.configuration.refresh_token = "<token>"         ## use the account’s refresh token
+
+Yt::Group.new(id: 'ABVSo3DwAAA').title
+# => "Video group"
+{% endhighlight %}
+
+<hr />
+<h4>List of <code>Yt::Group</code> data methods</h4>
+<dl>
+  {% include dt.html title="Group’s snippet" label="warning" auth="must authenticate as the channel’s account" %}
+  <dd><a class="anchor" id="snippet"></a><div class="highlight"><pre>
+{% include doc.html instance="Group#id" %}{% include example.html object='group' method='id' result='"ABVSo3DwAAA"' %}
+{% include doc.html instance="Group#title" %}{% include example.html object='group' method='title' result='"Video Group"' %}
+{% include doc.html instance="Group#published_at" %}{% include example.html object='group' method='published_at' result='2014-05-02 20:12:57 UTC' %}</pre>
+  </div></dd>
+
+  {% include dt.html title="Group’s content details" label="warning" auth="must authenticate as the group’s account" %}
+  <dd><a class="anchor" id="content_details"></a><div class="highlight"><pre>
+{% include doc.html instance="Group#item_count" %}{% include example.html object='group' method='item_count' result='4' %}
+{% include doc.html instance="Group#item_type" %}{% include example.html object='group' method='item_type' result='"youtube#video"' %}</pre>
+  </div></dd>
+</dl>

data/lib/yt/channel.rb

@@ -132,6 +132,14 @@ module Yt
       end
     end
 
+    # @return [Yt::Relation<Yt::Group>] the analytics groups of the channel.
+    # @see https://developers.google.com/youtube/analytics/v1/reference/groups
+    def groups
+      @groups ||= Relation.new(Group) do |options|
+        get '/youtube/analytics/v1/groups', mine: true
+      end
+    end
+
     # @return [Yt::Relation<Yt::Playlist>] the public playlists of the channel.
     def playlists
       @playlists ||= Relation.new(Playlist, channel_id: id) do |options|

data/lib/yt/core.rb

@@ -9,6 +9,7 @@ require 'yt/resource'
 require 'yt/response'
 
 require 'yt/channel'
+require 'yt/group'
 require 'yt/playlist'
 require 'yt/playlist_item'
 require 'yt/video'

data/lib/yt/core/version.rb

@@ -3,6 +3,6 @@ module Yt
   module Core
     # @return [String] the SemVer-compatible gem version.
     # @see http://semver.org
-    VERSION = '0.1.5'
+    VERSION = '0.1.7'
   end
 end

data/lib/yt/group.rb

@@ -0,0 +1,32 @@
+module Yt
+  # Provides methods to interact with YouTube Analytics groups.
+  # @see https://developers.google.com/youtube/analytics/v1/reference/groups
+  class Group < Resource
+    # @!attribute [r] title
+    # @return [String] the group’s title.
+    has_attribute :title, in: :snippet
+
+    # @!attribute [r] published_at
+    # @return [Time] the date and time that the group was created.
+    has_attribute :published_at, in: :snippet, type: Time
+
+    # @!attribute [r] item_count
+    # @return [Integer] the number of items in the group.
+    has_attribute :item_count, in: :content_details, type: Integer
+
+    # @!attribute [r] item_type
+    # @return [String] the type of items in the group.
+    has_attribute :item_type, in: :content_details
+
+    def initialize(data = {})
+      super
+      @selected_data_parts = %i(id snippet content_details)
+    end
+
+  private
+
+    def part_params
+      super.merge api: 'youtube/analytics/v1'
+    end
+  end
+end

data/lib/yt/resource.rb

@@ -61,7 +61,7 @@ module Yt
     end
 
     def get_part(required_part)
-      resources = Relation.new(self.class, ids: [id]) do |options|
+      resources = Relation.new(self.class, part_params) do |options|
         get resources_path, resource_params(options)
       end
 
@@ -74,6 +74,10 @@ module Yt
       end
     end
 
+    def part_params
+      {ids: [id]}
+    end
+
     def type_cast(value, type)
       case [type]
       when [Time]

data/lib/yt/response.rb

@@ -50,14 +50,15 @@ module Yt
 
     def refresh_access_token
       if Yt.configuration.refresh_token
-        auth = Auth.new refresh_token: Yt.configuration.refresh_token
+        auth = Auth.find_by refresh_token: Yt.configuration.refresh_token
+        auth.access_token_was_refreshed
         Yt.configuration.access_token = auth.access_token
       end
     end
 
     def resources_path
       @options[:item_class].name.split('::').last.gsub(/^(\w{1})(.*)/) do
-        "/youtube/v3/#{$1.downcase}#{$2}s"
+        "/#{@options.fetch(:api, 'youtube/v3')}/#{$1.downcase}#{$2}s"
       end
     end
 

data/yt-core.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'yt-auth', '>= 0.2.3'
+  spec.add_dependency 'yt-auth', '>= 0.3.1'
   spec.add_dependency 'yt-support', '>= 0.1.3'
 
   spec.add_development_dependency 'bundler', '~> 1.14'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt-core
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yt-auth
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: yt-support
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,7 @@ files:
 - docs/fonts/SecondaRound-Regular.ttf
 - docs/fonts/SecondaRound-Regular.woff
 - docs/fonts/SecondaRound-Regular.woff2
+- docs/groups.html
 - docs/images/console-01.png
 - docs/images/console-02.png
 - docs/images/console-03.png
@@ -198,6 +199,7 @@ files:
 - lib/yt/comment_thread.rb
 - lib/yt/core.rb
 - lib/yt/core/version.rb
+- lib/yt/group.rb
 - lib/yt/no_items_error.rb
 - lib/yt/playlist.rb
 - lib/yt/playlist_item.rb