fb-support 1.0.0.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d819d45513cce11b91b5c5db67e7832b2852ddf9
+  data.tar.gz: 4433a1864b16fd8169c663b45ec286ffae5c2a2c
+SHA512:
+  metadata.gz: 3d637aa8053ce72633d128f27ae155668987b491c050834c5a26b4048fcc87f084bebe658e19023702fb0b6f578834da9b71db3c32b9993b7599ac2d35650fc3
+  data.tar.gz: 87faa2cb9d2a25a6d94e374a5dec95bf7396f2c08bb57821d91834a6184f2c424780b74d9c502798cf7c741658e89bd356274d108580dd5014b3e45592870268

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--fail-fast

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+notifications:
+  email: false
+rvm:
+  - 2.2.2
+script:
+  - bundle exec rspec
+  - bundle exec yard stats | grep "100.00% documented"

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# 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).
+
+## 1.0.0 - 2017-03-17
+
+* [FEATURE] Added Fb::Configuration and Fb.configure
+* [FEATURE] Added Fb::HttpRequest
+* [FEATURE] Added Fb::HttpError

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-present 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,52 @@
+Common code needed by the other Fb gems
+=======================================
+
+Fb::Support provides common functionality to all Fb gems.
+It is considered suitable for internal use only at this time.
+
+The **source code** is available on [GitHub](https://github.com/fullscreen/fb-support) and the **documentation** on [RubyDoc](http://www.rubydoc.info/gems/fb-support/frames).
+
+[![Build Status](http://img.shields.io/travis/Fullscreen/fb-support/master.svg)](https://travis-ci.org/Fullscreen/fb-support)
+[![Coverage Status](http://img.shields.io/coveralls/Fullscreen/fb-support/master.svg)](https://coveralls.io/r/Fullscreen/fb-support)
+[![Dependency Status](http://img.shields.io/gemnasium/Fullscreen/fb-support.svg)](https://gemnasium.com/Fullscreen/fb-support)
+[![Code Climate](http://img.shields.io/codeclimate/github/Fullscreen/fb-support.svg)](https://codeclimate.com/github/Fullscreen/fb-support)
+[![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/gems/fb-support/frames)
+[![Gem Version](http://img.shields.io/gem/v/fb-support.svg)](http://rubygems.org/gems/fb-support)
+
+Fb::Support provides:
+
+* [Fb.configure](http://www.rubydoc.info/gems/fb-support/Fb/Config#configure-instance_method)
+* [Fb::Configuration](http://www.rubydoc.info/gems/fb-support/Fb/Configuration)
+* [Fb::HTTPRequest](http://www.rubydoc.info/gems/fb-support/Fb/HTTPRequest)
+* [Fb::HTTPError](http://www.rubydoc.info/gems/fb-support/Fb/HTTPError)
+
+How to test
+===========
+
+In order to run the tests you need to have one Facebook access token and set
+it as an environment variable:
+
+    export FB_TEST_ACCESS_TOKEN="5040|67b895"
+
+There are many [documented ways](https://developers.facebook.com/docs/facebook-login/access-tokens#apptokens) to generate a test access token.
+The easiest way is probably to:
+
+- create a Facebook app
+- copy its app Id and app Secret
+- join them as "app-id|app-secret"… that is a valid access token!
+
+
+How to contribute
+=================
+
+Contribute to the code by forking the project, adding the missing code,
+writing the appropriate tests and submitting a pull request.
+
+In order for a PR to be approved, all the tests need to pass and all the public
+methods need to be documented and listed in the guides. Remember:
+
+- to run all tests locally: `bundle exec rspec`
+- to generate the docs locally: `bundle exec yard`
+- to list undocumented methods: `bundle exec yard stats --list-undoc`
+
+Thanks :tada:

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require "rspec/core/rake_task"
+require "rspec/core/version"
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new :spec
+
+task default: [:spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fb/support"
+
+# 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-support.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fb/support/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fb-support'
+  spec.version       = Fb::Support::VERSION
+  spec.authors       = ['Claudio Baccigalupo']
+  spec.email         = ['claudio@fullscreen.net']
+
+  spec.summary       = %q{Support utilities for Fb gems}
+  spec.description   = %q{Fb::Support provides common functionality to Fb,
+    Fb::Auth. It is considered suitable for internal use only at this time.}
+  spec.homepage      = 'https://github.com/fullscreen/fb-support'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.2.2'
+
+  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.14'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8.20'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+  spec.add_development_dependency 'yard', '~> 0.9.8'
+end

data/lib/fb/config.rb

@@ -0,0 +1,49 @@
+require 'fb/configuration'
+
+# An object-oriented Ruby client for Facebook.
+# @see http://www.rubydoc.info/gems/fb-core/
+module Fb
+  # Provides methods to read and write global configuration settings.
+  #
+  # A typical usage is to set the API keys for a Facebook app.
+  #
+  # @example Set the API client id/secret for a Facebook app:
+  #   Fb.configure do |config|
+  #     config.client_id = 'ABCDEFGHIJ1234567890'
+  #     config.client_secret = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  # Note that Fb.configure has precedence over values through with
+  # environment variables (see {Fb::Models::Configuration}).
+  #
+  module Config
+    # Yields the global configuration to the given block.
+    #
+    # @example
+    #   Fb.configure do |config|
+    #     config.client_id = 'ABCDEFGHIJ1234567890'
+    #   end
+    #
+    # @yield [Fb::Models::Configuration] The global configuration.
+    def configure
+      yield configuration if block_given?
+    end
+
+    # Returns the global {Fb::Models::Configuration} object.
+    #
+    # While this method _can_ be used to read and write configuration settings,
+    # it is easier to use {Fb::Config#configure} Fb.configure}.
+    #
+    # @example
+    #     Fb.configuration.client_id = 'ABCDEFGHIJ1234567890'
+    #
+    # @return [Fb::Models::Configuration] The global configuration.
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  # @note Config is the only module auto-loaded in the Fb module,
+  #       in order to have a syntax as easy as Fb.configure
+  extend Config
+end

data/lib/fb/configuration.rb

@@ -0,0 +1,53 @@
+module Fb
+  # Provides an object to store global configuration settings.
+  #
+  # This class is typically not used directly, but by calling
+  # {Fb::Config#configure Fb.configure}, which creates and updates a single
+  # instance of {Fb::Models::Configuration}.
+  #
+  # @example Set the API client id/secret for a web-client Facebook app:
+  #   Fb.configure do |config|
+  #     config.client_id = 'ABCDEFGHIJ1234567890'
+  #     config.client_secret = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  # @see Fb::Config for more examples.
+  #
+  # An alternative way to set global configuration settings is by storing
+  # them in the following environment variables:
+  #
+  # * +FB_CLIENT_ID+ to store the Client ID for a Facebook app
+  # * +FB_CLIENT_SECRET+ to store the Client Secret for a Facebook app
+  #
+  # In case both methods are used together,
+  # {Fb::Config#configure Fb.configure} takes precedence.
+  #
+  # @example Set the API client id/secret for a Facebook app:
+  #   ENV['FB_CLIENT_ID'] = 'ABCDEFGHIJ1234567890'
+  #   ENV['FB_CLIENT_SECRET'] = 'ABCDEFGHIJ1234567890'
+  #
+  class Configuration
+    # @return [String] the Client ID for Facebook applications.
+    attr_accessor :client_id
+
+    # @return [String] the Client Secret for web/device Facebook applications.
+    attr_accessor :client_secret
+
+    # @return [String] the level of output to print for debugging purposes.
+    attr_accessor :log_level
+
+    # Initialize the global configuration settings, using the values of
+    # the specified following environment variables by default.
+    def initialize
+      @client_id = ENV['FB_CLIENT_ID']
+      @client_secret = ENV['FB_CLIENT_SECRET']
+      @log_level = ENV['FB_LOG_LEVEL']
+    end
+
+    # @return [Boolean] whether the logging output is extra-verbose.
+    #   Useful when developing (e.g., to print the curl of every request).
+    def developing?
+      %w(devel).include? log_level.to_s
+    end
+  end
+end

data/lib/fb/http_error.rb

@@ -0,0 +1,11 @@
+module Fb
+  # A wrapper around StandardError.
+  class HTTPError < StandardError
+    attr_reader :response
+
+    def initialize(msg, response:)
+      super msg
+      @response = response
+    end
+  end
+end

data/lib/fb/http_request.rb

@@ -0,0 +1,97 @@
+require 'net/http'
+require 'json'
+require 'fb/http_error'
+
+module Fb
+  # A wrapper around +Net::HTTP+ to send HTTP requests to any web API and
+  # return their result or raise an error if the result is unexpected.
+  # The basic way to use Request is by calling +run+ on an instance.
+  # @example Get information about Fullscreen’s Facebook page
+  #   path = '/v2.10/221406534569729'
+  #   params = {fields: 'id,link,about', access_token: access_token}
+  #   response = Fb::HTTPRequest.new(path: path, params: params).run
+  #   response.body
+  # @api private
+  class HTTPRequest
+    # Initializes a Request object.
+    # @param [Hash] options the options for the request.
+    # @option options [Class] :expected_response (Net::HTTPSuccess) The class
+    #   of response that the request should obtain when run.
+    # @option options [String] :host The host of the request URI.
+    # @option options [String] :path The path of the request URI.
+    # @option options [Hash] :params ({}) The params to use as the query
+    #   component of the request URI, for instance the Hash +{a: 1, b: 2}+
+    #   corresponds to the query parameters +"a=1&b=2"+.
+    # @option options [#size] :body The body of the request.
+    # @option options [Proc] :error_message The block that will be invoked
+    #   when a request fails.
+    def initialize(options = {})
+      @expected_response = options.fetch :expected_response, Net::HTTPSuccess
+      @host = options.fetch :host, 'graph.facebook.com'
+      @path = options[:path]
+      @params = options.fetch :params, {}
+    end
+
+    # Sends the request and returns the response with the body parsed from JSON.
+    # @return [Net::HTTPResponse] if the request succeeds.
+    # @raise [Fb::HTTPError] if the request fails.
+    def run
+      if response.is_a? @expected_response
+        response.tap do
+          parse_response!
+        end
+      else
+        raise HTTPError.new(error_message, response: response)
+      end
+    end
+
+    # @return [String] the request URL.
+    def url
+      uri.to_s
+    end
+
+  private
+
+    # @return [URI::HTTPS] the (memoized) URI of the request.
+    def uri
+      @uri ||= URI::HTTPS.build host: @host, path: @path, query: query
+    end
+
+    def query
+      URI.encode_www_form @params
+    end
+
+    # @return [Net::HTTPRequest] the full HTTP request object.
+    def http_request
+      @http_request ||= Net::HTTP::Get.new uri.request_uri
+    end
+
+    def as_curl
+      'curl'.tap do |curl|
+        http_request.each_header{|k, v| curl << %Q{ -H "#{k}: #{v}"}}
+        curl << %Q{ "#{url}"}
+      end
+    end
+
+    # Run the request and memoize the response or the server error received.
+    def response
+      @response ||= Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        curl_request = as_curl
+        p curl_request if Fb.configuration.developing?
+        http.request http_request
+      end
+    end
+
+    # Replaces the body of the response with the parsed version of the body,
+    # according to the format specified in the HTTPRequest.
+    def parse_response!
+      if response.body
+        response.body = JSON response.body
+      end
+    end
+
+    def error_message
+      JSON(response.body)['error']['message']
+    end
+  end
+end

data/lib/fb/support/version.rb

@@ -0,0 +1,8 @@
+module Fb
+  # Provides common functionality to all Fb gems.
+  module Support
+    # @return [String] the SemVer-compatible gem version.
+    # @see http://semver.org
+    VERSION = '1.0.0.alpha1'
+  end
+end

data/lib/fb/support.rb

@@ -0,0 +1,2 @@
+require 'fb/config'
+require 'fb/http_request'

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: fb-support
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha1
+platform: ruby
+authors:
+- Claudio Baccigalupo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.20
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+description: |-
+  Fb::Support provides common functionality to Fb,
+      Fb::Auth. It is considered suitable for internal use only at this time.
+email:
+- claudio@fullscreen.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fb-support.gemspec
+- lib/fb/config.rb
+- lib/fb/configuration.rb
+- lib/fb/http_error.rb
+- lib/fb/http_request.rb
+- lib/fb/support.rb
+- lib/fb/support/version.rb
+homepage: https://github.com/fullscreen/fb-support
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Support utilities for Fb gems
+test_files: []