fb-auth 0.1.3 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 124e9ff677bd52d912545b9e53c51e2eebd98779
-  data.tar.gz: 05c0d10e754b53b30aedd9737d9374be10823e5b
+  metadata.gz: b92a001d9a902960bdbb31dfe72cd02191901df1
+  data.tar.gz: 718e5ac23244e8789bff97d82baeefe2e81c751b
 SHA512:
-  metadata.gz: f1a95017d80749ba22f8050ccd355033c2d45d77d381731ff59cd00855ed8eac3346b961299cee8ab5f4eedd0e5054c828f5fb40ce0c2c12b520f7e2f2dc4cad
-  data.tar.gz: 359f6ff12599926e2428bc8e0ea4f65d44759b0efe53ccf15bb9fd58e6c0047bf3ecd489d731cfd01026c8b8f73a4b9f6d912cd2c72eb57155e2b17e82bbe1c0
+  metadata.gz: 39775c3dfb582f352fc9d73df5b9b93aec902439b15bba17f0dd890b279ca5794b9f213cd310cf40ed0b85e5a3262072d40f8137e0e154a3b1113753b3bffa8c
+  data.tar.gz: bdff56d25598cf2bea7d3fd2b934d924a1207c3943648601c76538aeef5bf3fe474b61f7ad16b52e61355a8c793973fcef81d593fca63d69eda8011505f2fc10

data/CHANGELOG.md

@@ -6,6 +6,16 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 1.0.0  - 2017/07/24
+
+This library was originally intended to provide methods to authenticate but
+has grown to include other methods to configure, get posts, insights etc.
+Most of those methods have been extracted into separate libraries.
+
+* [REMOVAL] Moved Fb::Page to fb-core gem (without insights)
+* [REMOVAL] Moved Fb::User to fb-core gem
+* [REMOVAL] Moved Fb::Configuration to fb-support gem
+
 ## 0.1.3  - 2017/07/20
 
 * [BUGFIX] Fixed `require` statement not loading for some classes.

data/README.md

@@ -29,7 +29,7 @@ By default, Fb::Auth will look for the environment variables called `FB_CLIENT_I
 ## Usage
 
 Fb::Auth#url
----------------------
+------------
 
 The `url` method helps you obtain a URL where to redirect users who need to
 authenticate with their Facebook account in order to use your application:
@@ -40,6 +40,9 @@ Fb::Auth.new(redirect_uri: redirect_uri).url
  # => https://www.facebook.com/dialog/oauth?client_id=...&scope=manage_pages&redirect_uri=https%3A%2F%2Fexample.com%2Fauth
 ```
 
+Note that access is always requested with permission to access email,
+manage pages and read insights.
+
 Fb::Auth#access_token
 ---------------------
 
@@ -56,69 +59,6 @@ Fb::Auth.new(redirect_uri: redirect_uri, code: code).access_token
  # => "kefjej49s82hFS@2333233222FDh66"
 ```
 
-Fb::User#pages
----------------------
-
-Once you have successfully obtain an access token, you can fetch the pages managed
-by that access token. Calling `Fb::User.new(access_token).pages` will return an
-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: id="1234", name="sample1">, #<Fb::Page: id="5678", name="sample2">]
-```
-
-Fb::User#email
----------------------
-
-Similarly, you can get the email of the user by calling `Fb::User.new(access_token).email`.
-
-```ruby
-access_token = Fb::Auth.new(redirect_uri: redirect_uri, code: code).access_token
-Fb::User.new(access_token).email
- # => "john.smith@example.com"
-```
-
-Fb::Page#insights
----------------------
-
-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
-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_fan_adds_unique", @description="Weekly: The
- # number of new people who have liked your Page (Unique Users)",
- # @value=123>,..}
-```
-
-Fb::Error
--------------
-
-`Fb::Error` will be raised when an issue occurs during the Facebook authentication process.
-The message of the error will include the details:
-
-```ruby
-redirect_uri = 'https://example.com/auth' # REPLACE WITH REAL ONE
-code = 'invalid-code'
-Fb::Auth.new(redirect_uri: redirect_uri, code: code).access_token
- # => Fb::Error: Invalid verification code format.
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/fb-auth.gemspec

@@ -1,10 +1,10 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "fb/auth/version"
+require 'fb/auth/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fb-auth"
+  spec.name          = 'fb-auth'
   spec.version       = Fb::Auth::VERSION
   spec.authors       = ['Aaron Dao', 'Claudio Baccigalupo']
   spec.email         = ['aaron.dao@fullscreen.com', 'claudio@fullscreen.net']
@@ -12,19 +12,21 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Ruby client to authenticate a Facebook user.}
   spec.description   = %q{Fb::Auth provides methods to obtain an access token to
     manage pages of a Facebook user.}
-  spec.homepage      = "https://github.com/Fullscreen/fb-auth"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/Fullscreen/fb-auth'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "yard", "~> 0.9.9"
+  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'
+  spec.add_development_dependency 'yard', '~> 0.9.9'
   spec.add_development_dependency 'coveralls'
 end

data/lib/fb/auth.rb

@@ -1,10 +1,7 @@
-require 'fb/configuration'
-require 'fb/user'
-require 'fb/page'
-require 'fb/metric'
-require 'fb/request'
-# Ruby client to authenticate a Facebook user.
-# @see http://www.rubydoc.info/gems/Fb/
+require 'fb/support'
+
+# An object-oriented Ruby client for the Facebook Graph API.
+# @see http://www.rubydoc.info/gems/fb-core/
 module Fb
   # Provides methods to authenticate a user with the Facebook OAuth flow.
   # @see https://developers.facebook.com/docs/facebook-login
@@ -19,44 +16,44 @@ module Fb
       @code = options[:code]
     end
 
-    # @return [String] a url to Facebook's account authentication.
+    # @return [String] the url to authenticate as a Facebook user.
     def url
-      Fb::Request.new(url_options).url
+      HTTPRequest.new(url_options).url
     end
 
-    # @return [String] the non-expiring access token of an authenticated Facebook account.
+    # @return [String] the non-expiring access token of a Facebook user.
     def access_token
-      response_body = Fb::Request.new(path: '/oauth/access_token',
-      params: long_term_token_params).run
-      response_body["access_token"]
+      params = {redirect_uri: @redirect_uri, code: @code}
+      temp_token = fetch_access_token_with params
+
+      params = {grant_type: :fb_exchange_token, fb_exchange_token: temp_token}
+      fetch_access_token_with params
     end
 
   private
 
-    def short_term_access_token
-      response_body = Fb::Request.new(path: '/oauth/access_token',
-      params: short_term_token_params).run
-      response_body["access_token"]
-    end
-
     def url_options
-      url_params = {scope: 'email,manage_pages', redirect_uri: @redirect_uri}
       {host: 'www.facebook.com', path: '/dialog/oauth', params: url_params}
     end
 
-    def short_term_token_params
+    def url_params
       {}.tap do |params|
-        params[:client_secret] = Fb.configuration.client_secret
+        params[:client_id] = Fb.configuration.client_id
         params[:redirect_uri] = @redirect_uri
-        params[:code] = @code
+        params[:scope] = 'email,manage_pages,read_insights'
       end
     end
 
-    def long_term_token_params
+    def fetch_access_token_with(params)
+      params = params.merge access_token_params
+      request = HTTPRequest.new path: '/oauth/access_token', params: params
+      request.run.body['access_token']
+    end
+
+    def access_token_params
       {}.tap do |params|
+        params[:client_id] = Fb.configuration.client_id
         params[:client_secret] = Fb.configuration.client_secret
-        params[:grant_type] = :fb_exchange_token
-        params[:fb_exchange_token] = short_term_access_token
       end
     end
   end

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.3"
+    VERSION = '1.0.0.alpha1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fb-auth
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0.alpha1
 platform: ruby
 authors:
 - Aaron Dao
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-20 00:00:00.000000000 Z
+date: 2017-07-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: fb-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.alpha1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.alpha1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -105,12 +119,8 @@ files:
 - fb-auth.gemspec
 - lib/fb/auth.rb
 - 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
 homepage: https://github.com/Fullscreen/fb-auth
 licenses:
 - MIT
@@ -126,9 +136,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.11

data/lib/fb/configuration.rb

@@ -1,33 +0,0 @@
-module Fb
-  # Setter for shared global objects
-  # @private
-  class Configuration
-    attr_accessor :client_id, :client_secret
-
-    def initialize
-      @client_id = ENV['FB_CLIENT_ID']
-      @client_secret = ENV['FB_CLIENT_SECRET']
-    end
-  end
-
-  # Returns the global [Configuration](Fb/Configuration) object. While
-  # you can use this method to access the configuration, the more common
-  # convention is to use [Fb.configure].
-  #
-  # @example
-  #     Fb.configuration.client_id = 1234
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  # Yields the global configuration to a block.
-  # @yield [Configuration] global configuration
-  #
-  # @example
-  #     Fb.configure do |config|
-  #       config.client_id = 1234
-  #     end
-  def self.configure
-    yield(configuration) if block_given?
-  end
-end

data/lib/fb/metric.rb

@@ -1,35 +0,0 @@
-# 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,61 +0,0 @@
-# Ruby client to authenticate a Facebook user.
-# @see http://www.rubydoc.info/gems/Fb/
-module Fb
-  # Fb::Page reprensents a Facebook page.
-  # Provides methods to get/set a page's name and id.
-  class Page
-    # @return [String] the name of the page.
-    attr_reader :name
-
-    #@return [String] the unique id of the page.
-    attr_reader :id
-
-    # @param [Hash] options the options to initialize an instance of Fb::Page.
-    # @option [String] :name The name of the page.
-    # @option [String] :id The unique id of the page.
-    def initialize(options = {})
-      @name = options["name"]
-      @id = options["id"]
-      @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
-    #   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(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.
-    def to_s
-      "#<#{self.class.name} id=#{@id}, name=#{@name}>"
-    end
-
-  private
-
-    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

data/lib/fb/user.rb

@@ -1,33 +0,0 @@
-module Fb
-  # Provides methods to get a collection of pages that an access token is
-  # allowed to manage and get page insights on those pages.
-  class User
-    # @access_token The access token returned by Facebook's OAuth flow.
-    def initialize(access_token)
-      @access_token = access_token
-    end
-
-    # @return [String] the email of the Facebook user.
-    def email
-      @email ||= begin
-        response_body = Fb::Request.new(path: '/me',
-          params: {fields: :email, access_token: @access_token}).run
-        response_body["email"]
-      end
-    end
-
-    # @return [Array] a collection of pages available to the given access token.
-    def pages
-      @pages ||= begin
-        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.merge('user' => self)
-        end
-      end
-    end
-
-  private
-    attr_reader :access_token
-  end
-end