fb-auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 106ab81033317409467304dd112b0824da4ecc06
+  data.tar.gz: bc4a79e1ea273dd2ab3e19480c49933653a7957c
+SHA512:
+  metadata.gz: 2ea2bcffa704f4a249aa558586c6fe139d1eb539bca3e34b4057e366b5d5c7b8012714aa9138c408a6ba1aeb6b28c899dacd2419299d25253a5864b8fb32eacc
+  data.tar.gz: 9578d4e367eee8bf8125f11346df95daf274b1fec3618d13f25a6e7430ca98cbef72fbfceac59a3c99b622315b73677760bd53bb4760291685d1a4031dfd958c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1
+script:
+  - bundle exec rspec
+  - bundle exec yard stats | grep "100.00% documented"

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+For more information about changelogs, check
+[Keep a Changelog](http://keepachangelog.com) and
+[Vandamme](http://tech-angels.github.io/vandamme).
+
+## 0.1.0  - 2017/06/29
+
+* [FEATURE] Add `Fb::Auth#url`
+* [FEATURE] Add `Fb::Auth#access_token`
+* [FEATURE] Add `Fb::User#pages`
+* [FEATURE] Add `Fb::User#email`
+* [FEATURE] Add `Fb::Error`

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+gem 'pry-nav'
+# Specify your gem's dependencies in fb-auth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Fullscreen, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+# Fb::Auth
+
+Fb::Auth can authenticate a Facebook user and return an access token with permission to manage pages of that user.
+
+[![Build Status](http://img.shields.io/travis/Fullscreen/fb-auth/master.svg)](https://travis-ci.org/Fullscreen/fb-auth)
+[![Coverage Status](http://img.shields.io/coveralls/Fullscreen/fb-auth/master.svg)](https://coveralls.io/r/Fullscreen/fb-auth)
+[![Dependency Status](http://img.shields.io/gemnasium/Fullscreen/fb-auth.svg)](https://gemnasium.com/Fullscreen/fb-auth)
+[![Code Climate](http://img.shields.io/codeclimate/github/Fullscreen/fb-auth.svg)](https://codeclimate.com/github/Fullscreen/fb-auth)
+[![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/gems/fb-auth/frames)
+[![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:
+
+```ruby
+gem 'fb-auth'
+```
+Then run `bundle install`.
+
+Fb::Auth will require an Client ID and an Client Secret which you can obtain after registering as a developer on [Facebook for developers](https://developers.facebook.com/).
+
+By default, Fb::Auth will look for the environment variables called `FB_CLIENT_ID` and `FB_CLIENT_SECRET`. You can put those keys in your `.bash_profile` and Fb::Auth will work.
+
+    export FB_CLIENT_ID="YourAppID"
+    export FB_CLIENT_SECRET="YourAppSecret"
+
+## 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:
+
+```ruby
+redirect_uri = 'https://example.com/auth' # REPLACE WITH REAL ONE
+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
+```
+
+Fb::Auth#access_token
+---------------------
+
+After users have authenticated with their Facebook account, they will be
+redirected to the `redirect_uri` you indicated, with an extra `code` query
+parameter, e.g. `https://example.com/auth?code=1234#_=_`
+
+The `access_token` method allows you to get a non-expiring access token of the user:
+
+```ruby
+redirect_uri = 'https://example.com/auth' # REPLACE WITH REAL ONE
+code = '1234#_=_' # REPLACE WITH REAL ONE
+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: @name="sample1", @id="1234">, #<Fb::Page: @name="sample2", @id="5678">]
+```
+
+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::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.
+If you would like to run tests for Fb::Auth, please obtain a long-term access token that manages at least one page
+and has permission to read your Facebook email (set scope to include `email` and `manage_pages`). Then set the token as
+as an environment variable:
+
+    export FB_TEST_ACCESS_TOKEN="YourToken"
+
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Fullscreen/fb-auth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fb/auth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fb-auth.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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_development_dependency 'coveralls'
+end

data/lib/fb/auth/version.rb

@@ -0,0 +1,7 @@
+module Fb
+  class Auth
+    # @return [String] the SemVer-compatible gem version.
+    # @see http://semver.org
+    VERSION = "0.1.0"
+  end
+end

data/lib/fb/auth.rb

@@ -0,0 +1,60 @@
+require 'fb/request'
+require 'fb/configuration'
+# Ruby client to authenticate a Facebook user.
+# @see http://www.rubydoc.info/gems/Fb/
+module Fb
+  # Provides methods to authenticate a user with the Facebook OAuth flow.
+  # @see https://developers.facebook.com/docs/facebook-login
+  class Auth
+    # @param [Hash] options the options to initialize an instance of Fb::Auth.
+    # @option [String] :redirect_uri The URI to redirect users to
+    #   after they have completed the Facebook OAuth flow.
+    # @option [String] :code A single-use authorization code provided
+    #   by Facebook OAuth to obtain an access token.
+    def initialize(options = {})
+      @redirect_uri = options[:redirect_uri]
+      @code = options[:code]
+    end
+
+    # @return [String] a url to Facebook's account authentication.
+    def url
+      Fb::Request.new(url_options).url
+    end
+
+    # @return [String] the non-expiring access token of an authenticated Facebook account.
+    def access_token
+      response_body = Fb::Request.new(path: '/oauth/access_token',
+      params: long_term_token_params).run
+      response_body["access_token"]
+    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
+      {}.tap do |params|
+        params[:client_secret] = Fb.configuration.client_id
+        params[:redirect_uri] = @redirect_uri
+        params[:code] = @code
+      end
+    end
+
+    def long_term_token_params
+      {}.tap do |params|
+        params[:client_secret] = Fb.configuration.client_secret
+        params[:grant_type] = :fb_exchange_token
+        params[:fb_exchange_token] = short_term_access_token
+      end
+    end
+  end
+end

data/lib/fb/configuration.rb

@@ -0,0 +1,33 @@
+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.fb_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.fb_client_id = 1234
+  #     end
+  def self.configure
+    yield(configuration) if block_given?
+  end
+end

data/lib/fb/error.rb

@@ -0,0 +1,5 @@
+module Fb
+  # Provides custom errors for Fb intended to be raised on a failed API call.
+  class Error < StandardError
+  end
+end

data/lib/fb/page.rb

@@ -0,0 +1,28 @@
+require 'date'
+# 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"]
+    end
+
+    # @return [String] the representation of the page.
+    def to_s
+      "#<#{self.class.name} id=#{@id}, name=#{@name}>"
+    end
+  end
+end
+

data/lib/fb/request.rb

@@ -0,0 +1,38 @@
+require 'uri'
+require 'net/http'
+require 'json'
+require 'fb/error'
+
+module Fb
+  # @private
+  class Request
+    def initialize(options = {})
+      @host = options.fetch :host, 'graph.facebook.com'
+      @path = options[:path]
+      @params = options.fetch :params, {}
+      unless @params.include? :access_token
+        @params.merge!(client_id: Fb.configuration.client_id)
+      end
+    end
+
+    def url
+      uri.to_s
+    end
+
+    def run
+      res = Net::HTTP.get_response(uri)
+      unless res.is_a?(Net::HTTPSuccess)
+        message = JSON.parse(res.body)["error"]["message"]
+        raise Fb::Error, message
+      end
+      JSON.parse(res.body)
+    end
+
+  private
+
+    def uri
+      query = URI.encode_www_form @params
+      URI::HTTPS.build host: @host, path: @path, query: query
+    end
+  end
+end

data/lib/fb/user.rb

@@ -0,0 +1,33 @@
+require 'fb/request'
+require 'fb/page'
+
+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
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: fb-auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Dao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Fb::Auth provides methods to obtain an access token to
+      manage pages of a Facebook user.
+email:
+- aaron.dao@fullscreen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fb-auth.gemspec
+- lib/fb/auth.rb
+- lib/fb/auth/version.rb
+- lib/fb/configuration.rb
+- lib/fb/error.rb
+- lib/fb/page.rb
+- lib/fb/request.rb
+- lib/fb/user.rb
+homepage: https://github.com/Fullscreen/fb-auth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby client to authenticate a Facebook user.
+test_files: []