fb-core 1.0.0.beta10 → 1.0.0.beta11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 42466ce3b3855146af568ed94374c219e8409731
-  data.tar.gz: 62a72bf0afd273c9fe122964ce92fed20649f799
+SHA256:
+  metadata.gz: 3d5d9595ad06f96e9cd804a1795e01798482dbf95a6cad93731de6074bbdee36
+  data.tar.gz: c37aab3d7991f3eb33300871007a54751b31bd2c21ba38d69a354ca03a795a56
 SHA512:
-  metadata.gz: ba53c107a9c8b3cf0089c58949c3dc84014212ae285aabd0d52df38eed4ec0123c096b025df9f01ff67a76ac6e91d8b47ebb6376c8b2451e4d966dd0879bfce9
-  data.tar.gz: 33bdb5fcc8d469d2db6d37b7d3bc264386cccbb72c37029df766d79ab43b82c95a83d8c5b5315d2e213f58bcdb3ec7f0b30c58199c616a546bd178f1ce08c524
+  metadata.gz: b5e271e36f438510e4f3fef268fb5b1c2f57359763192980fa6c39412a5e1618d799eb75275e79d9aea7f41831dec619fe166b9ea2bed8ddcd186780a7de65d0
+  data.tar.gz: e4fd05041ec08593d03e03e3d1d6e05c11702f2218a1b02efc86d94ba99f6f334076fe14dc05f60de86e108419c2e3d681e473427abdb16dbfca3c7b7ed9a088

data/CHANGELOG.md

@@ -6,6 +6,27 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+
+## 1.0.0.beta11
+
+* [IMPROVEMENT] Return UTC time for String value of `created_time`, `backdated_time`,
+`end_time`, etc from Facebook to have exact time.
+* [FEATURE] Add `Fb::Post#lifetime_insights` method to get metrics of each post.
+* [BUGFIX] Return empty hash instead of nil when a metric returns empty array.
+
+**How to upgrade**
+
+If your code calls `.consumptions` then you must replace that code with `.clicks`
+since those metrics will no longer be supported by Facebook API as of
+[August 1, 2018](https://developers.facebook.com/docs/graph-api/reference/v2.9/insights#newnames).
+If your code calls `fan_reach` from a Fb::Post then you must remove that code
+because Facebook removed that metric from [version 3.0](https://developers.facebook.com/docs/graph-api/changelog/version3.0) and they already applied the change to v2.9 the version currently
+fb-core uses.
+
+* [REMOVAL] Remove `#consumptions` method for posts
+* [REMOVAL] Remove `#fan_reach` method for posts
+* [FEATURE] Add `#clicks` method for posts
+
 ## 1.0.0.beta10  - 2018/05/01
 
 * [FEATURE] Add `:since` and `:until` option to `Page#videos` method.

data/lib/fb/core.rb

@@ -5,6 +5,7 @@ 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.beta10'
+    VERSION = '1.0.0.beta11'
   end
 end

data/lib/fb/page.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module Fb
   # Provides methods to interact with Facebook pages through the Graph API.
   # @see https://developers.facebook.com/docs/graph-api/reference/page/
@@ -11,6 +13,8 @@ module Fb
     # @option [String] the page’s category.
     attr_reader :category
 
+    attr_reader :access_token
+
     # @param [Hash] options to initialize a Page object.
     # @option [String] :id The page’s unique ID.
     # @option [String] :name The page’s name.
@@ -30,9 +34,10 @@ module Fb
     # @option [Date] :until only return dates previous to this day (upper bound).
     def metric_insights(metric, period, options = {})
       insights = page_insights Array(metric), options.merge(period: period)
-      values = insights.find{|data| data['name'] == metric}['values']
+      return {} if insights.empty?
+      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)]
+        [Date.parse(v['end_time']), v.fetch('value', 0)]
       end.to_h
     end
 
@@ -70,10 +75,11 @@ module Fb
     # @option [Boolean] :with_metrics whether to include insights for the posts.
     def posts(options = {})
       @posts ||= begin
+        with_metrics = options.delete :with_metrics
         params = posts_params.merge options
         request = PaginatedRequest.new path: "/v2.9/#{@id}/posts", params: params
         data = request.run.body['data']
-        options[:with_metrics] ? posts_with_metrics_from(data) : posts_from(data)
+        with_metrics ? posts_with_metrics_from(data) : posts_from(data)
       end
     end
 
@@ -95,10 +101,11 @@ module Fb
     # @option [Boolean] :without_lifetime_metrics whether to include insights for the videos.
     def videos(options = {})
       @videos ||= begin
+        without_lifetime_metrics = options.delete :without_lifetime_metrics
         params = video_params.merge options
         request = PaginatedRequest.new path: "/v2.9/#{@id}/videos", params: params
         data = request.run.body['data']
-        options[:without_lifetime_metrics] ? videos_from(data) : videos_with_metrics_from(data)
+        without_lifetime_metrics ? videos_from(data) : videos_with_metrics_from(data)
       end
     end
 
@@ -164,8 +171,8 @@ module Fb
       post_impressions_paid post_impressions_paid_unique post_impressions_fan
       post_impressions_fan_unique post_impressions_fan_paid post_impressions_fan_paid_unique
       post_impressions_organic post_impressions_organic_unique post_impressions_viral
-      post_consumptions post_engaged_users post_negative_feedback post_engaged_fan
-      post_fan_reach post_reactions_like_total post_reactions_love_total
+      post_clicks post_engaged_users post_negative_feedback post_engaged_fan
+      post_reactions_like_total post_reactions_love_total
       post_reactions_wow_total post_reactions_haha_total post_reactions_sorry_total
       post_reactions_anger_total post_video_avg_time_watched post_video_complete_views_organic
       post_video_complete_views_organic_unique post_video_complete_views_paid

data/lib/fb/post.rb

@@ -1,11 +1,11 @@
-# Ruby client to authenticate a Facebook user.
-# @see http://www.rubydoc.info/gems/Fb/
+require 'time'
+
 module Fb
   # Fb::Post reprensents a Facebook post. Post provides getters for:
   #   :id, :url, :created_at, :type, :message, :length, engaged_users,
   #   video_views, video_views_organic, video_views_paid, and so on.
   # @see https://developers.facebook.com/docs/graph-api/reference/v2.10/post
-  class Post
+  class Post < Resource
     attr_accessor :custom_labels
 
     # @option [String] the post’s unique ID.
@@ -100,7 +100,7 @@ module Fb
 
     # @option [Integer] the number of times people clicked on anywhere
     #   in your posts without generating a story.
-    attr_reader :consumptions
+    attr_reader :clicks
 
     # @option [Integer] the number of people who clicked anywhere on the post.
     attr_reader :engaged_users
@@ -111,9 +111,6 @@ module Fb
     # @option [Integer] people who have liked your page and engaged with your post.
     attr_reader :engaged_fan
 
-    # @option [Integer] post reach by people who like your page.
-    attr_reader :fan_reach
-
     # @option [Integer] total "like" reactions of a post.
     attr_reader :reactions_like_total
 
@@ -236,7 +233,7 @@ module Fb
     def initialize(options = {})
       @id = options[:id]
       @url = options[:permalink_url]
-      @created_at = Time.strptime(options[:created_time], '%Y-%m-%dT%H:%M:%S+0000')
+      @created_at = Time.parse(options[:created_time]) if options[:created_time]
       @type = options[:type]
       @message = options[:message]
       @length = options.fetch(:properties, []).find(-> { {'text' => 'n/a'} }) do |property|
@@ -263,11 +260,10 @@ module Fb
       @impressions_organic = options[:post_impressions_organic]
       @impressions_organic_unique = options[:post_impressions_organic_unique]
       @impressions_viral = options[:post_impressions_viral]
-      @consumptions = options[:post_consumptions]
+      @clicks = options[:post_clicks]
       @engaged_users = options[:post_engaged_users]
       @negative_feedback = options[:post_negative_feedback]
       @engaged_fan = options[:post_engaged_fan]
-      @fan_reach = options[:post_fan_reach]
       @reactions_like_total = options[:post_reactions_like_total]
       @reactions_love_total = options[:post_reactions_love_total]
       @reactions_wow_total = options[:post_reactions_wow_total]
@@ -300,6 +296,20 @@ module Fb
       @video_view_time_organic = options[:post_video_view_time_organic]
     end
 
+    # @return [Hash] a hash of metrics mapped to their values.
+    # @param [Array<String, Symbol>] :metrics the metrics to fetch.
+    # @param [String] :page_access_token page access token of its page.
+    def lifetime_insights(metrics, page_access_token)
+      params = { metric: Array(metrics).join(","), access_token: page_access_token, period: "lifetime", ids: id }
+      request = HTTPRequest.new path: "/v2.9/insights", params: params
+      insights = request.run.body
+
+      data = insights[id]['data'].map do |metric|
+        [metric['name'], metric['values'].last.fetch('value', 0)]
+      end.to_h
+      symbolize_keys data
+    end
+
     # @return [String] the representation of the post.
     def to_s
       %Q(#<#{self.class.name} #{@id} "#{@type}">)

data/lib/fb/video.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module Fb
   # Fb::Video represents a Facebook video. Fb::Video provides getter methods.
   # @see https://developers.facebook.com/docs/graph-api/reference/video/
@@ -97,8 +99,8 @@ module Fb
       @content_tags = options[:content_tags] ? Array(options[:content_tags]) : []
       @ad_breaks = options[:ad_breaks] ? Array(options[:ad_breaks]) : []
       @length = options[:length]
-      @created_at = Time.strptime(options[:created_time], '%Y-%m-%dT%H:%M:%S+0000') if options[:created_time]
-      @backdated_time = Time.strptime(options[:backdated_time], '%Y-%m-%dT%H:%M:%S+0000') if options[:backdated_time]
+      @created_at = Time.parse(options[:created_time]) if options[:created_time]
+      @backdated_time = Time.parse(options[:backdated_time]) if options[:backdated_time]
 
       @total_views = options[:total_video_views]
       @total_views_unique = options[:total_video_views_unique]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fb-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta10
+  version: 1.0.0.beta11
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2018-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fb-support
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby client to interact with Facebook Graph API.