fb-auth 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 106ab81033317409467304dd112b0824da4ecc06
-  data.tar.gz: bc4a79e1ea273dd2ab3e19480c49933653a7957c
+  metadata.gz: a4091f0bb97d9c056731edce37fbd6e62c36fe29
+  data.tar.gz: 52896b096eb97caa7a4b7b6cf032a4295bd65fca
 SHA512:
-  metadata.gz: 2ea2bcffa704f4a249aa558586c6fe139d1eb539bca3e34b4057e366b5d5c7b8012714aa9138c408a6ba1aeb6b28c899dacd2419299d25253a5864b8fb32eacc
-  data.tar.gz: 9578d4e367eee8bf8125f11346df95daf274b1fec3618d13f25a6e7430ca98cbef72fbfceac59a3c99b622315b73677760bd53bb4760291685d1a4031dfd958c
+  metadata.gz: e87ad08d25287b42cd3614cf13459a47afe203ca70998efbbec7e912e7ed7bd91cefa736fb928377d41c2f099349851938694a896a030b6d56949d9bb81f98c4
+  data.tar.gz: 1a1a4f22a83d45152865844bdf84342eb4674c72bb8a841505bab192c3e18d18c6a7417661c326eac99f44613bc5dd31904f0a8c8fc8b424c8fa3930c39a90c0

data/.gitignore

@@ -10,3 +10,4 @@
 .DS_Store
 # rspec failure tracking
 .rspec_status
+*.gem

data/CHANGELOG.md

@@ -6,6 +6,10 @@ 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
+
+* [FEATURE] Add `Fb::Page#insights`
+
 ## 0.1.0  - 2017/06/29
 
 * [FEATURE] Add `Fb::Auth#url`

data/README.md

@@ -10,7 +10,6 @@ Fb::Auth can authenticate a Facebook user and return an access token with permis
 [![Gem Version](http://img.shields.io/gem/v/fb-auth.svg)](http://rubygems.org/gems/fb-auth)
 
 The **source code** is available on [GitHub](https://github.com/Fullscreen/fb-auth) and the **documentation** on [RubyDoc](http://www.rubydoc.info/gems/fb-auth/frames).
-
 ### Installing and Configuring Fb::Auth
 
 First, add fb-auth to your Gemfile:
@@ -67,7 +66,7 @@ array of type Fb::Page, each with an id and name.
 ```ruby
 access_token = Fb::Auth.new(redirect_uri: redirect_uri, code: code).access_token
 Fb::User.new(access_token).pages
- # => [#<Fb::Page: @name="sample1", @id="1234">, #<Fb::Page: @name="sample2", @id="5678">]
+ # => [#<Fb::Page: id="1234", name="sample1">, #<Fb::Page: id="5678", name="sample2">]
 ```
 
 Fb::User#email
@@ -81,6 +80,21 @@ Fb::User.new(access_token).email
  # => "john.smith@example.com"
 ```
 
+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.
+
+```ruby
+Fb::User.new('token').pages.insights
+ # => {"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>,..}
+```
+
+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
 -------------
 
@@ -114,4 +128,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Fullsc
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/fb-auth.gemspec

@@ -6,8 +6,8 @@ require "fb/auth/version"
 Gem::Specification.new do |spec|
   spec.name          = "fb-auth"
   spec.version       = Fb::Auth::VERSION
-  spec.authors       = ["Aaron Dao"]
-  spec.email         = ["aaron.dao@fullscreen.com"]
+  spec.authors       = ['Aaron Dao', 'Claudio Baccigalupo']
+  spec.email         = ['aaron.dao@fullscreen.com', 'claudio@fullscreen.net']
 
   spec.summary       = %q{Ruby client to authenticate a Facebook user.}
   spec.description   = %q{Fb::Auth provides methods to obtain an access token to

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.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/fb/configuration.rb

@@ -15,7 +15,7 @@ module Fb
   # convention is to use [Fb.configure].
   #
   # @example
-  #     Fb.configuration.fb_client_id = 1234
+  #     Fb.configuration.client_id = 1234
   def self.configuration
     @configuration ||= Configuration.new
   end
@@ -25,7 +25,7 @@ module Fb
   #
   # @example
   #     Fb.configure do |config|
-  #       config.fb_client_id = 1234
+  #       config.client_id = 1234
   #     end
   def self.configure
     yield(configuration) if block_given?

data/lib/fb/metric.rb

@@ -0,0 +1,35 @@
+# Ruby client to authenticate a Facebook user.
+# @see http://www.rubydoc.info/gems/Fb/
+module Fb
+  # Fb::Metric reprensents a Facebook page's metric.
+  # For a list of all available metrics, refer to:
+  # @see https://developers.facebook.com/docs/graph-api/reference/v2.9/insights
+  # Provides methods to read name, description, and value.
+  class Metric
+
+    # @return [String] the name of the metric (e.g. page_fans).
+    attr_reader :name
+
+    # @return [String] a description for the metric.
+    attr_reader :description
+
+    # @return [Integer] the value of the metric when last requested.
+    attr_reader :value
+
+    # @param [Hash] options the options to initialize an instance of Fb::Metric.
+    # @option [String] :name of the metric.
+    # @option [String] :title of the metric.
+    # @option [String] :description of the metric.
+    # @option [Integer] :value of this metric when last requested.
+    def initialize(options = {})
+      @name = options["name"]
+      @description = options["description"]
+      @value = options["values"].first["value"]
+    end
+
+    # @return [String] the representation of the metric.
+    def to_s
+      "#<#{self.class.name} name=#{@name}, description=#{@description}, value=#{@value}>"
+    end
+  end
+end

data/lib/fb/page.rb

@@ -1,4 +1,6 @@
 require 'date'
+require 'fb/request'
+require 'fb/metric'
 # Ruby client to authenticate a Facebook user.
 # @see http://www.rubydoc.info/gems/Fb/
 module Fb
@@ -17,12 +19,44 @@ module Fb
     def initialize(options = {})
       @name = options["name"]
       @id = options["id"]
+      @user = options["user"]
+    end
+
+    # @return [Hash] a collection of metrics with metric name as key
+    #   and metric object as value.
+    # @example
+    #   Fb::User.new('token').pages.insights
+    #   => {"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
     end
 
     # @return [String] the representation of the page.
     def to_s
       "#<#{self.class.name} id=#{@id}, name=#{@name}>"
     end
+
+  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)
+      end
+    end
   end
 end
-

data/lib/fb/user.rb

@@ -25,9 +25,12 @@ module Fb
         response_body = Fb::Request.new(path: '/me/accounts',
           params: {access_token: @access_token}).run
         response_body["data"].map do |page_data|
-          Fb::Page.new page_data
+          Fb::Page.new page_data.merge('user' => self)
         end
       end
     end
+
+  private
+    attr_reader :access_token
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fb-auth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aaron Dao
+- Claudio Baccigalupo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +86,7 @@ description: |-
       manage pages of a Facebook user.
 email:
 - aaron.dao@fullscreen.com
+- claudio@fullscreen.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -105,6 +107,7 @@ files:
 - lib/fb/auth/version.rb
 - lib/fb/configuration.rb
 - lib/fb/error.rb
+- lib/fb/metric.rb
 - lib/fb/page.rb
 - lib/fb/request.rb
 - lib/fb/user.rb