fb-core 1.0.0.alpha5 → 1.0.0.alpha6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4214f25d9507a9e9f17592b3338bd21575e99a0
-  data.tar.gz: 7267a5466b17a6d546b2b8c6f9c01eeb1e928ee3
+  metadata.gz: eba1fc16c8b7532b533f2f9de7dab75ce28207e3
+  data.tar.gz: b1a2873d94e44bc65d4f8f1da60924c9df6a43ee
 SHA512:
-  metadata.gz: 74cd023662d2a69c70adc0cc16e9aa414f7864f73b19be3b0681a1cba91b696294457ede3f4a86d3707f547b93baef62abd3c578b11688fe9ef6947365b12c31
-  data.tar.gz: df05d7363d617bcb843b27249d3f4db253a0abdc26772fb63856a64115943edef1b0ad3ab888c188ca9929e7a5ed81cc0902875d654ecd45dc6ccdaa0fb2ce59
+  metadata.gz: 817e444187eb6b6487c78386bc10c34e087ccac19762821d8eb7274331096138e7ab1bfdc8f2889f56a61dc40027883658e0ae08e72cb0fe44435d3ddf4d0a9f
+  data.tar.gz: c2373650288e74af845087a8d28d51caa515844465f452a58accbd6ac1b9d23d58f2bfda297bdcccf310f46607a4139d0ba9105f530c2b3d4355faaed34f58c7

data/CHANGELOG.md

@@ -13,4 +13,5 @@ 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`
+* [FEATURE] Added `Fb::Page#weekly_insights`
+* [FEATURE] Added `Fb::Page#metric_insights`

data/README.md

@@ -88,10 +88,10 @@ page.view_count until: Date.today - 7
 # => 10000
 ```
 
-Fb::Page#weekly_metrics
+Fb::Page#weekly_insights
 --------------
 
-`weekly_metrics` allows you to get metrics that are available weekly such as
+`weekly_insights` 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.
@@ -103,17 +103,47 @@ 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.weekly_insights 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.weekly_insights metrics, until: Date.today - 7  # sum for July 8 - 14
 # => {:page_impressions => 1234, :page_fan_adds => 5678}
 ```
 
+Fb::Page#metric_insights
+--------------
+
+You can get an individual metric through using `metric_insights` which takes a
+metric, period, and options (since & until). Refer to
+[metrics](https://developers.facebook.com/docs/graph-api/reference/v2.9/insights#availmetrics)
+for a list of available weekly metrics and periods.
+
+**Ensure that the period that you are using is supported by the metric**.
+For example, `page_views_total` (page views) is available for `week`, `week`, and `days_28`
+whereas `page_fans` (page likes) is only available as `lifetime`.
+
+`metric_insights` returns a hash of Dates mapped to values. Passing `since` only return dates ahead
+to this date (lower bound) and passing `until` will return dates previous to this day
+(upper bound & defaults to 2 days ago). Combining both options will return the dates in between.
+
+```ruby
+page = Fb::Page.new access_token: '--valid-access-token--', id: '--valid-id--'
+metric_insights = page.metric_insights 'page_views_total', :day # let today be August 7th
+# => {#<Date: 2017-08-04> => 598, <Date: 2017-08-05> => 548}
+```
+
+With `until` (`Date`) and `since` (`Date`).
+
+```ruby
+options = {since: Date.today - 9, until: Date.today}
+metric_insights = page.metric_insights metric, :day, options
+# => {#<Date: 2017-08-01> => 639,..,#<Date: 2017-08-05 => 548}
+```
+
 ## 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.alpha5'
+    VERSION = '1.0.0.alpha6'
   end
 end

data/lib/fb/page.rb

@@ -23,10 +23,24 @@ module Fb
       @access_token = options[:access_token]
     end
 
+    # @return [Hash<Date, Integer>]  a hash of Dates mapped to their values.
+    # @param [String] :metric the metric to fetch.
+    # @param [<String, Symbol>] :period the aggregate period (day, week, days_28).
+    # @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)
+      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)]
+      end.to_h
+    end
+
+    #values.map {|v| [Date.strptime(v['end_time'], '%Y-%m-%dT%H:%M:%S+0000'), v.fetch('value', 0)]}.to_h
     # @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 = {})
+    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
@@ -37,11 +51,9 @@ module Fb
     # @param [Hash] options the options
     # @option [Date] :until only count the views until this day.
     def view_count(options = {})
-      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)}
+      views = metric_insights 'page_views_total', 'day', since: '1652 days ago'
+      views.select!{|date, _| date < options[:until]} if options[:until]
+      views.values.sum
     end
 
     # @return [Integer] the number of likes of the page.
@@ -49,8 +61,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 = single_metric 'page_fans', since: since_date, until: since_date + 2
-      likes.last.fetch('value', 0)
+      likes = metric_insights 'page_fans', 'lifetime', since: since_date, until: since_date + 2
+      likes[since_date+1]
     end
 
     # @return [Array<Fb::Post>] the posts published on the page.
@@ -72,11 +84,6 @@ module Fb
 
   private
 
-    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

metadata

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