fb-core 1.0.0.alpha11 → 1.0.0.alpha12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5d54f1aee3c5728c61bdbc457d9ffa9446d2d87
-  data.tar.gz: 5c11e39c01d565d582baf9b156a6ca6632a6049e
+  metadata.gz: cd59a79b809b6f4ecd3306cb4513115e5e4f25df
+  data.tar.gz: c167e50a5222e725f62b675734e7ffe3aa02424d
 SHA512:
-  metadata.gz: 0cca2085532fb3539ff29e5592de956ee83467b3d85608eb5c339264ae04a4fc0519e2c6c25372fd3d61cac168b3abdd6c096977b6e5b42d9929ba2514453c81
-  data.tar.gz: 5eb69fecae088ac81fa285963ee82b00e8ed2ea10de24b7585e2eb00be6a81853301d87303a18c9dbb09c3fd97439ceda71a3350b3b3e0382bbb873a276c88b7
+  metadata.gz: '0194add029d28a6a4c452370f6fce79b45ad81fb16f0b10ed52af5c211cc7a4865171f700c944b8a6b90287eb5a30d26ebd51e9603ebebf94ae42663fd1cdcb6'
+  data.tar.gz: 792587046f24310265871bbad3e5d6714b358361ed2a9668f8cd85a88974c1fdd8afbb1fa1a6be0de88ebbb310da18b1407631bc4318dd9c0d9c3987630e13ad

data/CHANGELOG.md

@@ -6,6 +6,12 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 1.0.0.alpha12  - 2017/12/08
+
+* [FEATURE] Add `Fb::Video` and `Fb::Page#videos`
+* [FEATURE] Add fields of "/videos" endpoint such as `comment_count`, `length` etc to `Fb::Video`
+* [FEATURE] Add metrics from "/video_insights" endpoint such as `total_views` to `Fb::Video`
+
 ## 1.0.0.alpha11  - 2017/12/01
 
 * [FEATURE] Add `share_count` to `Fb::Post` for number of shares of a post.

data/lib/fb/core.rb

@@ -4,6 +4,7 @@ require 'fb/resource'
 require 'fb/page'
 require 'fb/user'
 require 'fb/post'
+require 'fb/video'
 # An object-oriented Ruby client for the Facebook Graph API.
 # @see http://www.rubydoc.info/gems/fb-core/
 module Fb

data/lib/fb/core/version.rb

@@ -3,6 +3,6 @@ module Fb
   class Core
     # @return [String] the SemVer-compatible gem version.
     # @see http://semver.org
-    VERSION = '1.0.0.alpha11'
+    VERSION = '1.0.0.alpha12'
   end
 end

data/lib/fb/page.rb

@@ -77,6 +77,15 @@ module Fb
       end
     end
 
+    # @return [Array<Fb::Video>] the uploaded videos for the page.
+    def videos
+      @videos ||= begin
+        request = PaginatedRequest.new path: "/v2.9/#{@id}/videos", params: video_params
+        data = request.run.body['data']
+        videos_with_metrics_from(data)
+      end
+    end
+
     # @return [String] the representation of the page.
     def to_s
       %Q(#<#{self.class.name} #{@id} "#{@name}">)
@@ -125,5 +134,35 @@ module Fb
     def post_metrics
       %i(post_engaged_users post_video_views_organic post_video_views_paid post_video_views post_video_view_time)
     end
+
+    def videos_with_metrics_from(data)
+      data.each_slice(25).flat_map do |video_slice|
+        video_ids = video_slice.map {|video| video['id']}.join(',')
+        metrics = video_insights(ids: video_ids)
+        video_slice.map do |video_data|
+          insights_data = metrics[video_data['id']]['data'].map do |metric|
+            [metric['name'], metric['values'].last.fetch('value', 0)]
+          end.to_h
+          Video.new symbolize_keys video_data.merge(insights_data)
+        end
+      end
+    end
+
+    def video_insights(options = {})
+      params = options.merge access_token: @access_token
+      request = HTTPRequest.new path: "/v2.9/video_insights", params: params
+      request.run.body
+    end
+
+    def video_params
+      {}.tap do |params|
+        params[:access_token] = @access_token
+        params[:limit] = 25
+        params[:fields] = ['id', 'permalink_url', 'custom_labels', 'title',
+          'length', 'content_tags', 'likes.limit(0).summary(true)', 'comments.limit(0).summary(true)',
+          'created_time', 'ad_breaks', 'description', 'reactions.limit(0).summary(true)'
+        ].join(',')
+      end
+    end
   end
 end

data/lib/fb/paginated_request.rb

@@ -11,7 +11,7 @@ module Fb
       response = super
       while response.body.dig 'paging', 'next'
         after = response.body.dig 'paging', 'cursors', 'after'
-        next_params = @params.merge after: after, limit: 100
+        next_params = @params.merge after: after
         next_request = HTTPRequest.new path: @path, params: next_params
         next_body = next_request.run.body
         response.body['paging'] = next_body['paging']

data/lib/fb/video.rb

@@ -0,0 +1,103 @@
+module Fb
+  # Fb::Video represents a Facebook video. Fb::Video provides getter methods.
+  # @see https://developers.facebook.com/docs/graph-api/reference/video/
+  class Video
+
+    # @option [String] the video’s unique ID.
+    attr_reader :id
+
+    # @option [String] the video’s permanent URL.
+    attr_reader :url
+
+    # @option [String] the video’s title or caption.
+    attr_reader :title
+
+    # @option [String] the video’s description or caption.
+    attr_reader :description
+
+    # @option [Array<String>] the video’s custom labels.
+    attr_reader :custom_labels
+
+    # @return [Integer] the number of comments on the video.
+    attr_reader :comment_count
+
+    # @return [Integer] the number of likes on the video.
+    attr_reader :like_count
+
+    # @return [Integer] the number of reactions on the video.
+    attr_reader :reaction_count
+
+    # @option [Array<String>] the video’s content tags.
+    attr_reader :content_tags
+
+    # @option [Array<Integer>] the video’s ad breaks in milliseconds.
+    attr_reader :ad_breaks
+
+    # @option [Float] the video’s length.
+    attr_reader :length
+
+    # @option [Time] The time the video was initially published.
+    attr_reader :created_at
+
+    # @option [Integer] Total number of times the video was viewed for 3 seconds
+    # or viewed to the end, whichever happened first. total_video_views.
+    # @see https://developers.facebook.com/docs/graph-api/reference/video/video_insights/
+    attr_reader :total_views
+
+    # @option [Integer] The total_video_views_unique of the video.
+    attr_reader :total_views_unique
+
+    # @option [Integer] The total_video_avg_time_watched of the video.
+    attr_reader :total_avg_time_watched
+
+    # @option [Integer] The total_video_views_autoplayed of the video.
+    attr_reader :total_views_autoplayed
+
+    # @option [Integer] The total_video_views_clicked_to_play of the video.
+    attr_reader :total_views_clicked_to_play
+
+    # @option [Integer] The total_video_complete_views_auto_played of the video.
+    attr_reader :total_complete_views_auto_played
+
+    # @option [Integer] The total_video_complete_views_clicked_to_play of the video.
+    attr_reader :total_complete_views_clicked_to_play
+
+    # @option [Integer] The total_video_views_sound_on of the video.
+    attr_reader :total_views_sound_on
+
+    # @option [Integer] The total_video_10s_views_auto_played of the video.
+    attr_reader :total_10s_views_sound_on
+
+    # @param [Hash] options the options to initialize an instance of Fb::Video.
+    def initialize(options = {})
+      @id = options[:id]
+      @url = options[:permalink_url]
+      @title = options[:title]
+      @description = options[:description]
+      @custom_labels = options[:custom_labels] ? Array(options[:custom_labels]) : Array.new
+
+      @comment_count = options[:comments]['summary']['total_count'] if options[:comments]
+      @like_count = options[:likes]['summary']['total_count'] if options[:likes]
+      @reaction_count = options[:reactions]['summary']['total_count'] if options[:reactions]
+      @content_tags = options[:content_tags] ? Array(options[:content_tags]) : Array.new
+      @ad_breaks = options[:ad_breaks] ? Array(options[:ad_breaks]) : Array.new
+      @length = options[:length]
+      @created_at = Time.strptime(options[:created_time], '%Y-%m-%dT%H:%M:%S+0000')
+
+      @total_views = options[:total_video_views] if options[:total_video_views]
+      @total_views_unique = options[:total_video_views_unique] if options[:total_video_views_unique]
+      @total_avg_time_watched = options[:total_video_avg_time_watched] if options[:total_video_avg_time_watched]
+      @total_views_autoplayed = options[:total_video_views_autoplayed] if options[:total_video_views_autoplayed]
+      @total_views_clicked_to_play = options[:total_video_views_clicked_to_play] if options[:total_video_views_clicked_to_play]
+      @total_complete_views_auto_played = options[:total_video_complete_views_auto_played] if options[:total_video_complete_views_auto_played]
+      @total_complete_views_clicked_to_play = options[:total_video_complete_views_clicked_to_play] if options[:total_video_complete_views_clicked_to_play]
+      @total_views_sound_on = options[:total_video_views_sound_on] if options[:total_video_views_sound_on]
+      @total_10s_views_sound_on = options[:total_video_10s_views_sound_on] if options[:total_video_10s_views_sound_on]
+    end
+
+    # @return [String] the representation of the post.
+    def to_s
+      %Q(#<#{self.class.name} #{@id} "#{@length}">)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fb-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha11
+  version: 1.0.0.alpha12
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-02 00:00:00.000000000 Z
+date: 2017-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fb-support
@@ -124,6 +124,7 @@ files:
 - lib/fb/post.rb
 - lib/fb/resource.rb
 - lib/fb/user.rb
+- lib/fb/video.rb
 homepage: https://github.com/Fullscreen/fb-core
 licenses:
 - MIT