funky 0.2.13 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 542904cd43b9e75e88011affb0c5a11b5c8a90c5
-  data.tar.gz: 4a473d2052b7004b63b179c59fc7ddb0ee0052a3
+  metadata.gz: 0ee32f9048854c9fb49890992ea93946e409f1ee
+  data.tar.gz: 737ab7795b544735f2d992adacdc5ca1241ab6f7
 SHA512:
-  metadata.gz: bc3738d9fc5dfdf001a039dd419fb9b70231a7d4940a9320fc9f035202c89686f313265a2826df0fd13e42db60f2a1069444ec1ab7ba1e18fb1500402350e472
-  data.tar.gz: 07d3db9a3a46123dab571a28bfa444b2425fc5451db1ab9f202901ec19d9d585fdfc49ea8c9b774b0a23fa4ea8cb47ad2380e9afd61623ec5a410e14d21b070d
+  metadata.gz: e44f6f848b9beff059e7fb522a98fd42878e6b5c18389bd827481054428e492d537ee0cc60fce4571e7a5d78a30330ef1c2de7223b7da28be7a91e4fa9ffdb88
+  data.tar.gz: 58fd2f90d6e025818ed09f39d47062ce4011e72b7a131bd787041f4ccb66fd2fccca7c5bbabaf15aaacd3e8c0561aefc99f91828ac5e8faa7c44354a2bd4bf90

data/CHANGELOG.md

@@ -6,17 +6,17 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
-## 0.2.13 - 2017/01/25
-
-* [BUGFIX] When Facebook responds with a 302 redirect, sometimes an URL
-  with a space is returned (e.g., "https://www.facebook.com/KinoToPrzygoda /videos/322742591438587/") that is not URI encoded. This causes URI#parse to raise an InvalidURIError unless the URL is URL encoded.
+## 0.2.14 - 2017/02/06
 
+* [ENHANCEMENT] Add the Funky::Page API to fetch name, username,
+  location, city, state, zip, street, country, longitude,
+  and latitude fields from the Facebook Graph API given a page ID.
 
-## 2017/01/24
+## 0.2.13 - 2017/01/25
 
+* [BUGFIX] Correctly fetch data for videos that belong to a Facebook page with a username that contains URL-unsafe characters. For instance "https://www.facebook.com/KinoToPrzygoda /" (with a space) is a valid Facebook page URL.
 * [ENHANCEMENT] Use 2.8 of Facebook Graph API (upgrade from 2.6).
-- There were deprecations in v2.8 of the Facebook Graph API as well as
-additions documented in [the changelog](https://developers.facebook.com/docs/apps/changelog).
+- There were deprecations in v2.8 of the Facebook Graph API as well as additions documented in [the changelog](https://developers.facebook.com/docs/apps/changelog).
 - The current API of Funky is not affected.
 
 ## 0.2.12 - 2017/01/19

data/README.md

@@ -47,6 +47,26 @@ There are two ways to configure Funky with your App ID and App Secret:
     end
     ```
 
+##API Overview
+
+Funky consists of 2 different surface APIs - one to fetch video data
+from Facebook and one to fetch page data from Facebook.
+
+##Pages API
+
+### Use #where clause to get an array of videos
+
+```ruby
+ids = ['1487249874853741', '526533744142224']
+pages = Funky::Page.where(id: ids)
+pages.first.id            # => '1487249874853741'
+pages.first.name          # => 'Sony Pictures'
+pages.first.username      # => 'SonyPicturesGlobal'
+
+```
+
+##Videos API
+
 ### Use #where clause to get an array of videos
 
 ```ruby

data/lib/funky.rb

@@ -4,7 +4,9 @@ require 'funky/errors'
 require 'net/http'
 require 'funky/connections/api'
 require 'funky/configuration'
+require "funky/graph_root_node"
 require "funky/video"
+require "funky/page"
 
 module Funky
   def self.configuration

data/lib/funky/graph_root_node.rb

@@ -0,0 +1,47 @@
+module Funky
+  class GraphRootNode
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    # @return [String] the object ID.
+    def id
+      data[:id]
+    end
+
+  private
+
+    def self.fetch_and_parse_data(ids)
+      if ids.is_a?(Array) && ids.size > 1
+        response = Connection::API.batch_request(ids: ids, fields: fields)
+      else
+        id = ids.is_a?(Array) ? ids.first : ids
+        response = Connection::API.request(id: id, fields: fields)
+      end
+      parse response
+    rescue ContentNotFound
+      []
+    end
+
+    def self.parse(response)
+      if response.code == '200'
+        body = JSON.parse response.body, symbolize_names: true
+        if body.is_a? Array
+          body.select{|item| item[:code] == 200}.collect do |item|
+            JSON.parse(item[:body], symbolize_names: true)
+          end.compact
+        else
+          [body]
+        end
+      else
+        raise ContentNotFound, "Error #{response.code}: #{response.body}"
+      end
+    end
+
+    def self.instantiate_collection(items)
+      items.collect { |item| new item }
+    end
+  end
+end

data/lib/funky/page.rb

@@ -0,0 +1,100 @@
+module Funky
+  class Page < GraphRootNode
+
+    # @note
+    #   For example, for www.facebook.com/platform the username is 'platform'.
+    # @see https://developers.facebook.com/docs/graph-api/reference/page/
+    # @return [String] the alias of the Facebook Page.
+    def username
+      data[:username]
+    end
+
+    # @note
+    #   For example, for www.facebook.com/platform the name is
+    #   'Facebook For Developers'.
+    # @see https://developers.facebook.com/docs/graph-api/reference/page/
+    # @return [String] the name of the Facebook Page.
+    def name
+      data[:name]
+    end
+
+    # @note
+    #   location is a Hash that contains more specific properties such as city,
+    #   state, zip, etc.
+    # @see https://developers.facebook.com/docs/graph-api/reference/page/
+    # @return [Hash] the location of the Facebook Page if it is present
+    def location
+      data.fetch(:location, {})
+    end
+
+    # @see https://developers.facebook.com/docs/graph-api/reference/location/
+    # @return [String, nil] the city of the Facebook Page if it is present
+    def city
+      location[:city]
+    end
+
+    # @see https://developers.facebook.com/docs/graph-api/reference/location/
+    # @return [String, nil] the street of the Facebook Page if it is present
+    def street
+      location[:street]
+    end
+
+    # @see https://developers.facebook.com/docs/graph-api/reference/location/
+    # @return [String, nil] the state of the Facebook Page if it is present
+    def state
+      location[:state]
+    end
+
+    # @see https://developers.facebook.com/docs/graph-api/reference/location/
+    # @return [String, nil] the country of the Facebook Page if it is present
+    def country
+      location[:country]
+    end
+
+    # @see https://developers.facebook.com/docs/graph-api/reference/location/
+    # @return [String] the zip code of the Facebook Page if it is present
+    def zip
+      location[:zip]
+    end
+
+    # @see https://developers.facebook.com/docs/graph-api/reference/location/
+    # @return [Fixnum, nil] the latitude of the Facebook Page if it is present
+    def latitude
+      location[:latitude]
+    end
+
+    # @see https://developers.facebook.com/docs/graph-api/reference/location/
+    # @return [Fixnum, nil] the longitude of the Facebook Page if it is present
+    def longitude
+      location[:longitude]
+    end
+
+    # Fetches the data from Facebook's APIs and instantiates the data
+    # into an Array of Funky::Page objects. It can accept one page ID or an
+    # array of multiple page IDs.
+    #
+    # @example Getting one page
+    #   id = '10153834590672139'
+    #   Funky::Page.where(id: id) # => [#<Funky::Page>]
+    # @example Getting multiple videos
+    #   ids = ['10154439119663508', '10153834590672139']
+    #   Funky::Page.where(id: ids) # => [#<Funky::Page>, #<Funky::Page>]
+    #
+    # @return [Array<Funky::Page>] multiple instances of Funky::Page objects
+    #   containing data obtained by Facebook's APIs.
+    def self.where(id:)
+      return nil unless id
+      instantiate_collection(fetch_and_parse_data Array(id))
+    end
+
+  private
+
+    def self.fields
+      [
+        'name',
+        'username',
+        'location'
+      ]
+    end
+  end
+end

data/lib/funky/version.rb

@@ -1,3 +1,3 @@
 module Funky
-  VERSION = "0.2.13"
+  VERSION = "0.2.14"
 end

data/lib/funky/video.rb

@@ -3,22 +3,13 @@ require 'funky/html/parser'
 require 'funky/url'
 
 module Funky
-  class Video
-    attr_reader :data
+  class Video < GraphRootNode
+
     attr_accessor :counters
 
     @@html_page = HTML::Page.new
     @@html_parser = HTML::Parser.new
 
-    def initialize(data)
-      @data = data
-    end
-
-    # @return [String] the video ID.
-    def id
-      data[:id]
-    end
-
     # @return [DateTime] the created time of the video.
     def created_time
       datetime = data[:created_time]
@@ -50,6 +41,7 @@ module Funky
       data.fetch(:from)[:id]
     end
 
+    # @return [String] the url of Facebook page for the video.
     def page_url
       "https://www.facebook.com/#{page_id}"
     end
@@ -122,37 +114,6 @@ module Funky
 
   private
 
-    def self.fetch_and_parse_data(ids)
-      if ids.is_a?(Array) && ids.size > 1
-        response = Connection::API.batch_request(ids: ids, fields: fields)
-      else
-        id = ids.is_a?(Array) ? ids.first : ids
-        response = Connection::API.request(id: id, fields: fields)
-      end
-      parse response
-    rescue ContentNotFound
-      []
-    end
-
-    def self.parse(response)
-      if response.code == '200'
-        body = JSON.parse response.body, symbolize_names: true
-        if body.is_a? Array
-          body.select{|item| item[:code] == 200}.collect do |item|
-            JSON.parse(item[:body], symbolize_names: true)
-          end.compact
-        else
-          [body]
-        end
-      else
-        raise ContentNotFound, "Error #{response.code}: #{response.body}"
-      end
-    end
-
-    def self.instantiate_collection(items)
-      items.collect { |item| new item }
-    end
-
     def self.fields
       [
         'created_time',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: funky
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.14
 platform: ruby
 authors:
 - Philip Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-25 00:00:00.000000000 Z
+date: 2017-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,8 +121,10 @@ files:
 - lib/funky/connections/api.rb
 - lib/funky/connections/base.rb
 - lib/funky/errors.rb
+- lib/funky/graph_root_node.rb
 - lib/funky/html/page.rb
 - lib/funky/html/parser.rb
+- lib/funky/page.rb
 - lib/funky/url.rb
 - lib/funky/version.rb
 - lib/funky/video.rb