fb-core 1.0.0.alpha4 → 1.0.0.alpha5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95ee401be1930e9abee5c75dd16756a55d88b8c0
-  data.tar.gz: 3f8eb395c5ddb81ecbe32e5350e27d301793dc11
+  metadata.gz: a4214f25d9507a9e9f17592b3338bd21575e99a0
+  data.tar.gz: 7267a5466b17a6d546b2b8c6f9c01eeb1e928ee3
 SHA512:
-  metadata.gz: 78d6a2ca60bfb77814197651fb078481e07ad9cf3164d5489b2880cce292db930dcae9c9843d21b12bc7a673f31c029355f1c480b3730046fc37f33e5851af7a
-  data.tar.gz: 86a411fe281ec2210fd5617b8edbb753287baa407ac69b0e256c46d8d804cb4bdccdafef27041ea8212e815d32e1a93b471a02cce209014e8c23719370b4e6de
+  metadata.gz: 74cd023662d2a69c70adc0cc16e9aa414f7864f73b19be3b0681a1cba91b696294457ede3f4a86d3707f547b93baef62abd3c578b11688fe9ef6947365b12c31
+  data.tar.gz: df05d7363d617bcb843b27249d3f4db253a0abdc26772fb63856a64115943edef1b0ad3ab888c188ca9929e7a5ed81cc0902875d654ecd45dc6ccdaa0fb2ce59

data/CHANGELOG.md

@@ -13,3 +13,4 @@ For more information about changelogs, check
 * [FEATURE] Added `Fb::Page#posts`
 * [FEATURE] Added `Fb::Page#like_count`
 * [FEATURE] Added `Fb::Page#view_count`
+* [FEATURE] Added `Fb::Page#weekly_metrics`

data/README.md

@@ -63,7 +63,7 @@ page.like_count
 # => 15000
 ```
 
-Pass an `until` option to get the count at a certain date.
+Pass an `until` (`Date`) option to get the count at a certain date.
 
 ```ruby
 page.like_count until: Date.today - 7
@@ -81,13 +81,39 @@ page.view_count
 # => 12345
 ```
 
-Pass an `until` option to get the count at a certain date.
+Pass an `until` (`Date`) option to get the count at a certain date.
 
 ```ruby
 page.view_count until: Date.today - 7
 # => 10000
 ```
 
+Fb::Page#weekly_metrics
+--------------
+
+`weekly_metrics` allows you to get metrics that are available weekly such as
+`page_views_total`, `page_impressions`, `page_fan_adds`, etc. Refer to
+[metrics](https://developers.facebook.com/docs/graph-api/reference/v2.9/insights#availmetrics)
+for a list of available weekly metrics.
+
+This method takes an array metrics and returns a hash of the metrics mapped to
+their values. Each metric value is the sum of the last 7 days. If today is July 20th,
+then the values will be for July 14 - July 20.
+
+```ruby
+metrics = %i(page_impressions page_fan_adds)
+page = Fb::Page.new access_token: '--valid-access-token--', id: '--valid-id--'
+page.weekly_metrics metrics # sum for July 14 - 20
+# => {:page_impressions => 1234, :page_fan_adds => 5678}
+```
+
+Pass an `until` (`Date`) option such as `Date.today - 7` to fetch 7 days prior to July 14th.
+
+```ruby
+page.weekly_metrics metrics, until: Date.today - 7  # sum for July 8 - 14
+# => {:page_impressions => 1234, :page_fan_adds => 5678}
+```
+
 ## Development
 
 To run tests, obtain a long-term access token for a Facebook user who manages

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.alpha4'
+    VERSION = '1.0.0.alpha5'
   end
 end

data/lib/fb/page.rb

@@ -23,13 +23,25 @@ module Fb
       @access_token = options[:access_token]
     end
 
+    # @return [Hash] a hash of metrics mapped to their values.
+    # @param [Array<String, Symbol>] :metrics the metrics to fetch.
+    # @option [Date] :until only sum seven days before this date.
+    def weekly_metrics(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.map {|m| [m['name'].to_sym, m['values'].last.fetch('value', 0)]}.to_h
+    end
+
     # @return [Integer] the number of views of the page.
     # @param [Hash] options the options
     # @option [Date] :until only count the views until this day.
     def view_count(options = {})
-      views = insights 'page_video_views', period: :day, since: '1652 days ago'
-      views.select!{|v| v['end_time'] < options[:until].strftime('%Y-%m-%dT%H:%M:%S+0000')} if options[:until]
-      views.sum{|x| x.fetch('value', 0)} || 0
+      views = single_metric 'page_views_total', period: :day, since: '1652 days ago'
+      if options[:until]
+        views.select!{|v| v['end_time'] < options[:until].strftime('%Y-%m-%dT%H:%M:%S+0000')}
+      end
+      views.sum{|x| x.fetch('value', 0)}
     end
 
     # @return [Integer] the number of likes of the page.
@@ -37,8 +49,8 @@ module Fb
     # @option [Date] :until only count the likes until this day.
     def like_count(options = {})
       since_date = options.fetch :until, Date.today - 1
-      likes = insights('page_fans', since: since_date, until: since_date + 2)
-      likes.last['value'] || 0
+      likes = single_metric 'page_fans', since: since_date, until: since_date + 2
+      likes.last.fetch('value', 0)
     end
 
     # @return [Array<Fb::Post>] the posts published on the page.
@@ -60,10 +72,15 @@ module Fb
 
   private
 
-    def insights(metric, options = {})
-      params = options.merge metric: metric, access_token: @access_token
+    def single_metric(metric, options = {})
+      insights = insights Array(metric), options
+      insights.find{|data| data['name'] == metric}['values']
+    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'].find{|data| data['name'] == metric}['values']
+      request.run.body['data']
     end
   end
 end

metadata

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