fb-core 1.0.0.alpha2 → 1.0.0.alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a276100e70569cfea82d59f7b717fed5abd4738
-  data.tar.gz: 91bc74bf0cb37e2e35571762af7113c3a12c710d
+  metadata.gz: 95ee401be1930e9abee5c75dd16756a55d88b8c0
+  data.tar.gz: 3f8eb395c5ddb81ecbe32e5350e27d301793dc11
 SHA512:
-  metadata.gz: 3f51e0ac980b581dc401dba9e05f4bfbbe3ed2047ad4fa9fc51097993ba3c47ea9c80b4f2e688d3a45a6ac3f4668d30d44f612afd9d7b03e1a1d5af1888e05aa
-  data.tar.gz: 52f941c27635d888f3b5d4d9c12caaf5009e0bf91994768334226dae1a28398579d94b6f03607100509c69472aca6f2ca44679acec4f197baf89b684f097601e
+  metadata.gz: 78d6a2ca60bfb77814197651fb078481e07ad9cf3164d5489b2880cce292db930dcae9c9843d21b12bc7a673f31c029355f1c480b3730046fc37f33e5851af7a
+  data.tar.gz: 86a411fe281ec2210fd5617b8edbb753287baa407ac69b0e256c46d8d804cb4bdccdafef27041ea8212e815d32e1a93b471a02cce209014e8c23719370b4e6de

data/CHANGELOG.md

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

data/README.md

@@ -33,7 +33,7 @@ user.email # => 'john.smith@example.com'
 Fb::User#pages
 --------------
 
-Given an user access token with the `manage_pages` scope, you can get the list of Facebook pages managed by the user by calling:
+Given an user access token with the `pages_show_list` scope, you can get the list of Facebook pages managed by the user by calling:
 
 ```ruby
 user = Fb::User.new access_token: '--valid-access-token--'
@@ -41,6 +41,53 @@ user.pages
 # => [#<Fb::Page: id="1234", name="sample1">, #<Fb::Page: id="5678", name="sample2">]
 ```
 
+Fb::Page#posts
+--------------
+
+Given a page with posts, you can get the posts on the page since creation by calling:
+
+```ruby
+page = Fb::Page.new access_token: '--valid-access-token--', id: '--valid-id--'
+page.posts
+# => [#<Fb::Post: id="1234", type="video">, #<Fb::Post: id="5678", type="video">]
+```
+
+Fb::Page#like_count
+--------------
+
+Given a page, you can get the the number of likes for the page.
+
+```ruby
+page = Fb::Page.new access_token: '--valid-access-token--', id: '--valid-id--'
+page.like_count
+# => 15000
+```
+
+Pass an `until` option to get the count at a certain date.
+
+```ruby
+page.like_count until: Date.today - 7
+# => 10000
+```
+
+Fb::Page#view_count
+--------------
+
+You can also get the the number of views for the page.
+
+```ruby
+page = Fb::Page.new access_token: '--valid-access-token--', id: '--valid-id--'
+page.view_count
+# => 12345
+```
+
+Pass an `until` option to get the count at a certain date.
+
+```ruby
+page.view_count until: Date.today - 7
+# => 10000
+```
+
 ## Development
 
 To run tests, obtain a long-term access token for a Facebook user who manages

data/fb-core.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/Fullscreen/fb-core'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 2.4'
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -23,7 +25,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'fb-support', '~> 1.0.0.alpha1'
-
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/fb/core.rb

@@ -1,7 +1,9 @@
 require 'fb/support'
+require 'fb/paginated_request'
+require 'fb/resource'
 require 'fb/page'
 require 'fb/user'
-
+require 'fb/post'
 # 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.alpha2'
+    VERSION = '1.0.0.alpha4'
   end
 end

data/lib/fb/page.rb

@@ -1,7 +1,7 @@
 module Fb
   # Provides methods to interact with Facebook pages through the Graph API.
   # @see https://developers.facebook.com/docs/graph-api/reference/page/
-  class Page
+  class Page < Resource
     # @option [String] the page’s unique ID.
     attr_reader :id
 
@@ -15,15 +15,55 @@ module Fb
     # @option [String] :id The page’s unique ID.
     # @option [String] :name The page’s name.
     # @option [String] :category The page’s category.
+    # @option [String] :access_token an access token for the page.
     def initialize(options = {})
       @id = options[:id]
       @name = options[:name]
       @category = options[:category]
+      @access_token = options[:access_token]
+    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
+    end
+
+    # @return [Integer] the number of likes of the page.
+    # @param [Hash] options the options
+    # @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
+    end
+
+    # @return [Array<Fb::Post>] the posts published on the page.
+    def posts
+      @posts ||= begin
+        fields = %i(type created_time).join ','
+        params = {access_token: @access_token, limit: 100, fields: fields}
+        request = PaginatedRequest.new path: "/v2.9/#{@id}/posts", params: params
+        request.run.body['data'].map do |post_data|
+          Post.new symbolize_keys post_data
+        end
+      end
     end
 
     # @return [String] the representation of the page.
     def to_s
       %Q(#<#{self.class.name} #{@id} "#{@name}">)
     end
+
+  private
+
+    def insights(metric, options = {})
+      params = options.merge metric: metric, access_token: @access_token
+      request = HTTPRequest.new path: "/v2.9/#{@id}/insights", params: params
+      request.run.body['data'].find{|data| data['name'] == metric}['values']
+    end
   end
 end

data/lib/fb/paginated_request.rb

@@ -0,0 +1,22 @@
+module Fb
+  # Provides a wrapper for HTTPRequest when the result has pagination links.
+  # @api private
+  class PaginatedRequest < HTTPRequest
+    # Sends the request and returns the response with the body parsed from JSON.
+    # If the response body contains a link to the next page, fetches that page
+    # as well and combines the data with the previous page.
+    # @return [Net::HTTPResponse] if the request succeeds.
+    # @raise [Fb::HTTPError] if the request fails.
+    def run
+      response = super
+      while after = response.body.dig('paging', 'cursors', 'after')
+        next_params = @params.merge after: after, limit: 100
+        next_request = HTTPRequest.new path: @path, params: next_params
+        next_body = next_request.run.body
+        response.body['paging'] = next_body['paging']
+        response.body['data'].concat next_body['data']
+      end
+      response
+    end
+  end
+end

data/lib/fb/post.rb

@@ -0,0 +1,31 @@
+# Ruby client to authenticate a Facebook user.
+# @see http://www.rubydoc.info/gems/Fb/
+module Fb
+  # Fb::Post reprensents a Facebook post. Post provides getters for:
+  #   :id, :title, :url, :created_time, and :type.
+  class Post
+    # @option [String] the post’s unique ID.
+    attr_reader :id
+
+    # @option [String] the post’s type.
+    attr_reader :type
+
+    # @option [Time] the post’s creation time.
+    attr_reader :created_at
+
+    # @param [Hash] options the options to initialize an instance of Fb::Post.
+    # @option [String] :id the post id.
+    # @option [String] :type the post’s type.
+    # @option [String] :created_time the post’s creation time in iso8601 format.
+    def initialize(options = {})
+      @id = options[:id]
+      @type = options[:type]
+      @created_at = Time.parse(options[:created_time]) if options[:created_time]
+    end
+
+    # @return [String] the representation of the post.
+    def to_s
+      %Q(#<#{self.class.name} #{@id} "#{@type}">)
+    end
+  end
+end

data/lib/fb/resource.rb

@@ -0,0 +1,11 @@
+module Fb
+  # Provides a base class for Facebook resources (users, pages, ...)
+  class Resource
+  private
+    def symbolize_keys(hash)
+      {}.tap do |new_hash|
+        hash.each_key{|key| new_hash[key.to_sym] = hash[key]}
+      end
+    end
+  end
+end

data/lib/fb/user.rb

@@ -1,7 +1,7 @@
 module Fb
   # Provides methods to interact with Facebook users through the Graph API.
   # @see https://developers.facebook.com/docs/graph-api/reference/user/
-  class User
+  class User < Resource
     # @param [Hash] options to initialize a User object.
     # @option [String] :access_token an access token for the user.
     def initialize(options = {})
@@ -23,17 +23,9 @@ module Fb
         params = {access_token: @access_token}
         request = HTTPRequest.new path: '/me/accounts', params: params
         request.run.body['data'].map do |page_data|
-          Page.new symbolize_keys(page_data)
+          Page.new symbolize_keys(page_data.merge access_token: @access_token)
         end
       end
     end
-
-  private
-
-    def symbolize_keys(hash)
-      {}.tap do |new_hash|
-        hash.each_key{|key| new_hash[key.to_sym] = hash[key]}
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fb-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha2
+  version: 1.0.0.alpha4
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fb-support
@@ -118,6 +118,9 @@ files:
 - lib/fb/core.rb
 - lib/fb/core/version.rb
 - lib/fb/page.rb
+- lib/fb/paginated_request.rb
+- lib/fb/post.rb
+- lib/fb/resource.rb
 - lib/fb/user.rb
 homepage: https://github.com/Fullscreen/fb-core
 licenses:
@@ -131,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"