fb-auth 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4091f0bb97d9c056731edce37fbd6e62c36fe29
-  data.tar.gz: 52896b096eb97caa7a4b7b6cf032a4295bd65fca
+  metadata.gz: e1c65df145f6718c64b0a56c90644ad84e9b7680
+  data.tar.gz: c74b56bfa92064a6104cfb0313a66bf4bb8ba8de
 SHA512:
-  metadata.gz: e87ad08d25287b42cd3614cf13459a47afe203ca70998efbbec7e912e7ed7bd91cefa736fb928377d41c2f099349851938694a896a030b6d56949d9bb81f98c4
-  data.tar.gz: 1a1a4f22a83d45152865844bdf84342eb4674c72bb8a841505bab192c3e18d18c6a7417661c326eac99f44613bc5dd31904f0a8c8fc8b424c8fa3930c39a90c0
+  metadata.gz: e7582dccb5248c30929e76314c3a0dd0331ab1ade55cf5245fbb6a2f4f5d610d54d3931db8d0a2f1d4e8435228e097cdfd0a3fb373ec25f90ab9695c5e93c5ee
+  data.tar.gz: '09e4778d8511b2f12ae52343fcb9d0c26f261979764f6c007d6040b3b1e3f9e55dd74be47cc559b6e8157eee8cf7826c165f8ca1548d32655346a93fa6732bb1'

data/CHANGELOG.md

@@ -6,7 +6,11 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
-## 0.1.1  - 2017/06/29
+## 0.1.2  - 2017/07/11
+
+* [ENHANCEMENT] `Fb::Page#insights` now takes a hash of options on method call.
+
+## 0.1.1  - 2017/07/06
 
 * [FEATURE] Add `Fb::Page#insights`
 

data/README.md

@@ -83,18 +83,29 @@ Fb::User.new(access_token).email
 Fb::Page#insights
 ---------------------
 
-For each page object created, you can get these pre-defined metrics: page_views_total, page_fan_adds_unique, page_engaged_users, page_video_views. The insights method will fetch the cumulative value of these metrics 7 days prior to two weeks ago (e.g. if today is July 6, 2017, the value of the metric will be for the 7 days prior to and ending on June 22, 2017). The selection of metrics and aggregate period will be options in a future patch.
+For each page object, you can fetch page insights for these [available metrics](https://developers.facebook.com/docs/graph-api/reference/v2.9/insights#availmetrics). The insights method takes a hash of three options:
+
+    [String] :since The lower bound of the time range to consider.
+    [String] :period The aggregation period (must be available to all
+      given metrics).
+    [Array] :metric A list of metrics.
+
+Insights will return a hash with the name of each metric as the key and the metric object as the value.
 
 ```ruby
-Fb::User.new('token').pages.insights
+options = {
+  metric: %i(page_fan_adds_unique page_engaged_users page_views_total),
+  period: :week,
+  since: '2017-06-09' # sample date format
+}
+page = Fb::User.new('token').pages.first
+page.insights(options)
  # => {"page_fan_adds_unique"=>#<Fb::Metric:0x123abc
- @name="page_fans", @description="Weekly: The
- number of new people who have liked your Page (Unique Users)",
- @value=123>,..}
+ # @name="page_fan_adds_unique", @description="Weekly: The
+ # number of new people who have liked your Page (Unique Users)",
+ # @value=123>,..}
 ```
 
-A full list of page/insights metrics are available at [metrics](https://developers.facebook.com/docs/graph-api/reference/v2.9/insights#availmetrics).
-
 Fb::Error
 -------------
 

data/lib/fb/auth/version.rb

@@ -2,6 +2,6 @@ module Fb
   class Auth
     # @return [String] the SemVer-compatible gem version.
     # @see http://semver.org
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/fb/page.rb

@@ -22,23 +22,24 @@ module Fb
       @user = options["user"]
     end
 
+    # @param [Hash] options to customize the insights returned from the API.
+    # @option [String] :since The lower bound of the time range to consider.
+    # @option [String] :period The aggregation period (must be available to all
+    #   given metrics).
+    # @option [Array<String, Symbol>] :metric A list of metrics.
     # @return [Hash] a collection of metrics with metric name as key
     #   and metric object as value.
     # @example
-    #   Fb::User.new('token').pages.insights
+    #   page = Fb::User.new('token').pages.first
+    #   page.insights(options)
     #   => {"page_fan_adds_unique"=>#<Fb::Metric:0x123abc
     #   @name="page_fans", @description="Weekly: The
     #   number of new people who have liked your Page (Unique Users)",
     #   @value=123>,..}
-    def insights
-      @insights ||= begin
-        response_body = Fb::Request.new(
-          path: "/v2.9/#{@id}/insights",
-          params: insights_params).run
-        response_body["data"].map do |metric_data|
-          [metric_data["name"], Fb::Metric.new(metric_data)]
-        end.to_h
-      end
+    def insights(options = {})
+      fetch_insights(options)["data"].map do |metric_data|
+        [metric_data["name"], Fb::Metric.new(metric_data)]
+      end.to_h
     end
 
     # @return [String] the representation of the page.
@@ -48,15 +49,16 @@ module Fb
 
   private
 
-    def insights_params
-      {}.tap do |params|
-        params[:since] = (Time.now - 14 * 86400).strftime("%Y-%m-%d")
-        params[:until] = Date.parse(params[:since]) + 1
-        params[:period] = :week
-        params[:metric] = 'page_views_total,page_fan_adds_unique,
-          page_engaged_users,page_video_views'
-        params[:access_token] = @user.send(:access_token)
+    def fetch_insights(options)
+      unless options[:metric]
+        raise Fb::Error, 'Missing required parameter: metric'
       end
+      insights_params = options.merge(metric: options[:metric].join(","),
+        access_token: @user.send(:access_token))
+      Fb::Request.new(
+        path: "/v2.9/#{@id}/insights",
+        params: insights_params
+      ).run
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fb-auth
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Aaron Dao
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler