fb-core 1.0.0.alpha7 → 1.0.0.alpha8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb91cd80d655f7e81bf36f22a491bff96f8b2e27
-  data.tar.gz: e6b0a8a0dfa8f2142103b57f8f5f6fd9cce4a904
+  metadata.gz: b6cd31e0997675afe22e67ce5d9a413dbd1bb31f
+  data.tar.gz: 12fb33cc93515ef59c82d27b52af8c419821b23b
 SHA512:
-  metadata.gz: 4cd41e9397e2c3798ed31fcb3b870ff953e66fb55c7176077acedd0291dcdcdd2db34b6a55bb128b1c1d5f877007d2295ba8fd4a172f25f6145088ed5d819675
-  data.tar.gz: 7960deaf0f1d145bd5772d292a2033ec2071d027b9f09b044463d8f0a315110591785c206415d758138126e9ff73ff707a20e9b2344aa2fdf071d7d493b70551
+  metadata.gz: 9729cc3f46d822bf3450efddaf64af4936857895b2181647c6a34706519f8d16c24520751ce7ec32459296cac8334d11a646a99095f8d3ac554a3ef74029775e
+  data.tar.gz: 10cd071faebf75ee7bf69a8e7c9acee0d18afd88cb0b99f3efe2812377ab5957967d8842934d40aeb0d1b028bcdaa916ec361a6d3f698dd2a75f055a73e7b836

data/README.md

@@ -56,10 +56,26 @@ Pass `since` (`Time`) and `until` (`Time`) options to get posts in between the t
 
 ```ruby
 options = { since: Time.new(2015, 05, 15), until: Time.now }
-page.posts(options)
+page.posts options
 # => [#<Fb::Post: id="5678", type="video">,..]
 ```
 
+Pass `with_metrics: true` to include post insights for the following metrics...
+All post types: `post_engaged_users`
+Video posts only: `post_video_views_organic`, `post_video_views_paid`, `post_video_views`, and `post_video_view_time`
+
+```ruby
+page.posts with_metrics: true
+# => [#<Fb::Post: id="5678", type="video">,..]
+```
+
+You can also combine all three options...
+
+```ruby
+options = { since: Time.new(2015, 05, 15), until: Time.now, with_metrics: true }
+page.posts options
+```
+
 Fb::Page#like_count
 --------------
 

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.alpha7'
+    VERSION = '1.0.0.alpha8'
   end
 end

data/lib/fb/page.rb

@@ -29,7 +29,7 @@ module Fb
     # @option [Date] :since only return dates ahead to this date (lower bound).
     # @option [Date] :until only return dates previous to this day (upper bound).
     def metric_insights(metric, period, options = {})
-      insights = insights Array(metric), options.merge(period: period)
+      insights = page_insights Array(metric), options.merge(period: period)
       values = insights.find{|data| data['name'] == metric}['values']
       values.map do |v|
         [Date.strptime(v['end_time'], '%Y-%m-%dT%H:%M:%S+0000'), v.fetch('value', 0)]
@@ -42,7 +42,7 @@ module Fb
     def weekly_insights(metrics, options = {})
       since_date = options.fetch :until, Date.today - 1
       params = {period: :week, since: since_date, until: since_date + 2}
-      metrics = insights Array(metrics), params
+      metrics = page_insights Array(metrics), params
       metrics.map {|m| [m['name'].to_sym, m['values'].last.fetch('value', 0)]}.to_h
     end
 
@@ -67,13 +67,13 @@ module Fb
     # @return [Array<Fb::Post>] the posts published on the page.
     # @option [Time] :since only return posts ahead of this time.
     # @option [Time] :until only return posts previous to this time.
+    # @option [Boolean] :with_metrics whether to include insights for the posts.
     def posts(options = {})
       @posts ||= begin
         params = posts_params.merge options
         request = PaginatedRequest.new path: "/v2.9/#{@id}/posts", params: params
-        request.run.body['data'].map do |post_data|
-          Post.new symbolize_keys post_data
-        end
+        data = request.run.body['data']
+        options[:with_metrics] ? posts_with_metrics_from(data) : posts_from(data)
       end
     end
 
@@ -84,10 +84,33 @@ module Fb
 
   private
 
+    def page_insights(metrics, options = {})
+      insights(metrics, options.merge(ids: id))[id]['data']
+    end
+
+    def posts_from(data)
+      data.map do |post_data|
+        Post.new symbolize_keys post_data
+      end
+    end
+
+    def posts_with_metrics_from(data)
+      data.each_slice(50).flat_map do |post_slice|
+        post_ids = post_slice.map{|post| post['id']}.join ','
+        metrics = insights post_metrics, ids: post_ids, period: :lifetime
+        post_slice.map do |post_data|
+          insights_data = metrics[post_data['id']]['data'].map do |metric|
+            [metric['name'], metric['values'].last.fetch('value', 0)]
+          end.to_h
+          Post.new symbolize_keys post_data.merge(insights_data)
+        end
+      end
+    end
+
     def insights(metrics, options = {})
       params = options.merge metric: metrics.join(','), access_token: @access_token
-      request = HTTPRequest.new path: "/v2.9/#{@id}/insights", params: params
-      request.run.body['data']
+      request = HTTPRequest.new path: "/v2.9/insights", params: params
+      request.run.body
     end
 
     def posts_params
@@ -97,5 +120,9 @@ module Fb
         params[:fields]= %i(id message permalink_url created_time type properties).join ','
       end
     end
+
+    def post_metrics
+      %i(post_engaged_users post_video_views_organic post_video_views_paid post_video_views post_video_view_time)
+    end
   end
 end

data/lib/fb/post.rb

@@ -2,7 +2,8 @@
 # @see http://www.rubydoc.info/gems/Fb/
 module Fb
   # Fb::Post reprensents a Facebook post. Post provides getters for:
-  #   :id, :url, :created_at, :type, :message, and :length.
+  #   :id, :url, :created_at, :type, :message, :length, engaged_users,
+  #   video_views, video_views_organic, video_views_paid, and total_minutes_watched.
   class Post
 
     # @option [String] the post’s unique ID.
@@ -23,6 +24,21 @@ module Fb
     # @option [String] the attached video's length or n/a.
     attr_reader :length
 
+    # @option [Integer] the number of people who clicked anywhere on the post.
+    attr_reader :engaged_users
+
+    # @option [Integer] video views of 3 seconds or more.
+    attr_reader :video_views
+
+    # @option [Integer] organic video views of 3 seconds or more.
+    attr_reader :video_views_organic
+
+    # @option [Integer] paid video views of 3 seconds or more.
+    attr_reader :video_views_paid
+
+    # @option [Integer] total minutes watched by all users who viewed the video.
+    attr_reader :total_minutes_watched
+
     # @param [Hash] options the options to initialize an instance of Fb::Post.
     # @option [String] :id The post id.
     # @option [String] :message The status message in the post or post story.
@@ -30,6 +46,11 @@ module Fb
     # @option [String] :created_time The time the post was initially published.
     # @option [String] :type A string indicating the object type of this post.
     # @option [String] :properties of the post (e.g. length).
+    # @option [Integer] :post_engaged_users The number of people who clicked anywhere on the post.
+    # @option [Integer] :post_video_views Video views of 3 seconds or more.
+    # @option [Integer] :post_video_views_organic Organic video views of 3 seconds or more.
+    # @option [Integer] :post_video_views_paid Paid video views of 3 seconds or more.
+    # @option [Integer] :post_video_view_time Total video view time (miliseconds).
     def initialize(options = {})
       @id = options[:id]
       @url = options[:permalink_url]
@@ -39,6 +60,11 @@ module Fb
       @length = options.fetch(:properties, []).find(-> { {'text' => 'n/a'} }) do |property|
         property['name'] == 'Length'
       end['text']
+      @engaged_users = options[:post_engaged_users] if options[:post_engaged_users]
+      @video_views = options[:post_video_views] if options[:post_video_views]
+      @video_views_organic = options[:post_video_views_organic] if options[:post_video_views_organic]
+      @video_views_paid = options[:post_video_views_paid] if options[:post_video_views_paid]
+      @total_minutes_watched = (options[:post_video_view_time]/1000) if options[:post_video_view_time]
     end
 
     # @return [String] the representation of the post.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fb-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha7
+  version: 1.0.0.alpha8
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fb-support